Database::createUser() - Code Metrics - Inspection of "Merge pull request #13 from vbaranovskiy-plesk/mas..." - plesk/api-php-lib - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6aa3fc...c7d0c1 )

by Alexei

created 2016-11-17 06:04 UTC

Database::createUser() A

↳ Parent: Database

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	1

<?php
// Copyright 1999-2016. Parallels IP Holdings GmbH.

namespace PleskX\Api\Operator;
use PleskX\Api\Struct\Database as Struct;

class Database extends \PleskX\Api\Operator
{
    /**
     * @param array $properties
     * @return Struct\Info
     */
    public function create($properties)
    {
        return new Struct\Info($this->_create('add-db', $properties));
    }

    /**
     * @param $properties
     * @return Struct\UserInfo
     */
    public function createUser($properties)
    {
        return new Struct\UserInfo($this->_create('add-db-user', $properties));
    }

    /**
     * @param $command
     * @param array $properties
     * @return \PleskX\Api\XmlResponse
     */
    private function _create($command, array $properties)
    {
        $packet = $this->_client->getPacket();
        $info = $packet->addChild($this->_wrapperTag)->addChild($command);

        foreach ($properties as $name => $value) {
            $info->addChild($name, $value);
        }

        return $this->_client->request($packet);
    }

    /**
     * @param string $field
     * @param integer|string $value
     * @return Struct\Info
     */
    public function get($field, $value)
    {
        $items = $this->getAll($field, $value);
        return reset($items);

    }

    /**
     * @param string $field
     * @param integer|string $value
     * @return Struct\UserInfo
     */
    public function getUser($field, $value)
    {
        $items = $this->getAllUsers($field, $value);
        return reset($items);

    }

    /**
     * @param string $field
     * @param integer|string $value
     * @return Struct\Info[]
     */
    public function getAll($field, $value)

    {
        $response = $this->_get('get-db', $field, $value);
        $items = [];
        foreach ($response->xpath('//result') as $xmlResult) {
            $items[] = new Struct\Info($xmlResult);
        }
        return $items;
    }

    /**
     * @param string $field
     * @param integer|string $value
     * @return Struct\UserInfo[]
     */
    public function getAllUsers($field, $value)

    {
        $response = $this->_get('get-db-users', $field, $value);
        $items = [];
        foreach ($response->xpath('//result') as $xmlResult) {
            $items[] = new Struct\UserInfo($xmlResult);
        }
        return $items;
    }

    /**
     * @param $command
     * @param $field
     * @param $value
     * @return \PleskX\Api\XmlResponse
     */
    private function _get($command, $field, $value)
    {
        $packet = $this->_client->getPacket();
        $getTag = $packet->addChild($this->_wrapperTag)->addChild($command);

        $filterTag = $getTag->addChild('filter');
        if (!is_null($field)) {
            $filterTag->addChild($field, $value);
        }

        $response = $this->_client->request($packet, \PleskX\Api\Client::RESPONSE_FULL);
        return $response;
    }

    /**
     * @param string $field
     * @param integer|string $value
     * @return bool
     */
    public function delete($field, $value)
    {
        return $this->_delete($field, $value, 'del-db');
    }

    /**
     * @param string $field
     * @param integer|string $value
     * @return bool
     */
    public function deleteUser($field, $value)
    {
        return $this->_delete($field, $value, 'del-db-user');
    }
}


1		<?php
2		// Copyright 1999-2016. Parallels IP Holdings GmbH.
3
4		namespace PleskX\Api\Operator;
5		use PleskX\Api\Struct\Database as Struct;
6
7		class Database extends \PleskX\Api\Operator
8		{
9		/**
10		* @param array $properties
11		* @return Struct\Info
12		*/
13		public function create($properties)
14		{
15		return new Struct\Info($this->_create('add-db', $properties));
16		}
17
18		/**
19		* @param $properties
20		* @return Struct\UserInfo
21		*/
22		public function createUser($properties)
23		{
24		return new Struct\UserInfo($this->_create('add-db-user', $properties));
25		}
26
27		/**
28		* @param $command
29		* @param array $properties
30		* @return \PleskX\Api\XmlResponse
31		*/
32		private function _create($command, array $properties)
33		{
34		$packet = $this->_client->getPacket();
35		$info = $packet->addChild($this->_wrapperTag)->addChild($command);
36
37		foreach ($properties as $name => $value) {
38		$info->addChild($name, $value);
39		}
40
41		return $this->_client->request($packet);
42		}
43
44		/**
45		* @param string $field
46		* @param integer\|string $value
47		* @return Struct\Info
48		*/
49		public function get($field, $value)
50		{
51		$items = $this->getAll($field, $value);
52		return reset($items);
		0 ignored issues – show Comprehensibility Best Practice introduced 2016-11-17 05:47 UTC by Report Bug Copy Issue Report The expression `reset($items);` of type `PleskX\Api\Struct\Database\Info\|false` adds `false` to the return on line 52 which is incompatible with the return type documented by `PleskX\Api\Operator\Database::get` of type `PleskX\Api\Struct\Database\Info`. It seems like you forgot to handle an error condition. Loading history...
53		}
54
55		/**
56		* @param string $field
57		* @param integer\|string $value
58		* @return Struct\UserInfo
59		*/
60		public function getUser($field, $value)
61		{
62		$items = $this->getAllUsers($field, $value);
63		return reset($items);
		0 ignored issues – show Comprehensibility Best Practice introduced 2016-11-17 05:47 UTC by Report Bug Copy Issue Report The expression `reset($items);` of type `PleskX\Api\Struct\Database\UserInfo\|false` adds `false` to the return on line 63 which is incompatible with the return type documented by `PleskX\Api\Operator\Database::getUser` of type `PleskX\Api\Struct\Database\UserInfo`. It seems like you forgot to handle an error condition. Loading history...
64		}
65
66		/**
67		* @param string $field
68		* @param integer\|string $value
69		* @return Struct\Info[]
70		*/
71	View Code Duplication	public function getAll($field, $value)
		0 ignored issues – show Duplication introduced 2016-11-17 05:47 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
72		{
73		$response = $this->_get('get-db', $field, $value);
74		$items = [];
75		foreach ($response->xpath('//result') as $xmlResult) {
76		$items[] = new Struct\Info($xmlResult);
77		}
78		return $items;
79		}
80
81		/**
82		* @param string $field
83		* @param integer\|string $value
84		* @return Struct\UserInfo[]
85		*/
86	View Code Duplication	public function getAllUsers($field, $value)
		0 ignored issues – show Duplication introduced 2016-11-17 05:47 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
87		{
88		$response = $this->_get('get-db-users', $field, $value);
89		$items = [];
90		foreach ($response->xpath('//result') as $xmlResult) {
91		$items[] = new Struct\UserInfo($xmlResult);
92		}
93		return $items;
94		}
95
96		/**
97		* @param $command
98		* @param $field
99		* @param $value
100		* @return \PleskX\Api\XmlResponse
101		*/
102		private function _get($command, $field, $value)
103		{
104		$packet = $this->_client->getPacket();
105		$getTag = $packet->addChild($this->_wrapperTag)->addChild($command);
106
107		$filterTag = $getTag->addChild('filter');
108		if (!is_null($field)) {
109		$filterTag->addChild($field, $value);
110		}
111
112		$response = $this->_client->request($packet, \PleskX\Api\Client::RESPONSE_FULL);
113		return $response;
114		}
115
116		/**
117		* @param string $field
118		* @param integer\|string $value
119		* @return bool
120		*/
121		public function delete($field, $value)
122		{
123		return $this->_delete($field, $value, 'del-db');
124		}
125
126		/**
127		* @param string $field
128		* @param integer\|string $value
129		* @return bool
130		*/
131		public function deleteUser($field, $value)
132		{
133		return $this->_delete($field, $value, 'del-db-user');
134		}
135		}
136

plesk / api-php-lib

Push — master ( 6aa3fc...c7d0c1 )

Database::createUser() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like