SecretKey::get() - Code Metrics - plesk/api-php-lib - Measure and Improve Code Quality continuously with Scrutinizer

SecretKey::get() A
last analyzed 2021-06-04 10:48 UTC

↳ Parent: SecretKey

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	6
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?php
// Copyright 1999-2021. Plesk International GmbH.

namespace PleskX\Api\Operator;

use PleskX\Api\Struct\SecretKey as Struct;

class SecretKey extends \PleskX\Api\Operator
{
    protected $_wrapperTag = 'secret_key';

    /**
     * @param string $ipAddress
     * @param string $description
     *
     * @return string
     */
    public function create($ipAddress = '', $description = '')
    {
        $packet = $this->_client->getPacket();
        $createTag = $packet->addChild($this->_wrapperTag)->addChild('create');

        if ('' !== $ipAddress) {
            $createTag->addChild('ip_address', $ipAddress);
        }

        if ('' !== $description) {
            $createTag->addChild('description', $description);
        }

        $response = $this->_client->request($packet);

        return (string) $response->key;
    }

    /**
     * @param string $keyId
     *
     * @return bool
     */
    public function delete($keyId)
    {
        return $this->_delete('key', $keyId, 'delete');
    }

    /**
     * @param string $keyId
     *
     * @return Struct\Info
     */
    public function get($keyId)
    {
        $items = $this->_get($keyId);

        return reset($items);

    }

    /**
     * @return Struct\Info[]
     */
    public function getAll()
    {
        return $this->_get();
    }

    /**
     * @param string|null $keyId
     *
     * @return Struct\Info[]
     */
    public function _get($keyId = null)

    {
        $packet = $this->_client->getPacket();
        $getTag = $packet->addChild($this->_wrapperTag)->addChild('get_info');

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

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

        $items = [];
        foreach ($response->xpath('//result/key_info') as $keyInfo) {
            $items[] = new Struct\Info($keyInfo);
        }

        return $items;
    }
}


1		<?php
2		// Copyright 1999-2021. Plesk International GmbH.
3
4		namespace PleskX\Api\Operator;
5
6		use PleskX\Api\Struct\SecretKey as Struct;
7
8		class SecretKey extends \PleskX\Api\Operator
9		{
10		protected $_wrapperTag = 'secret_key';
11
12		/**
13		* @param string $ipAddress
14		* @param string $description
15		*
16		* @return string
17		*/
18		public function create($ipAddress = '', $description = '')
19		{
20		$packet = $this->_client->getPacket();
21		$createTag = $packet->addChild($this->_wrapperTag)->addChild('create');
22
23		if ('' !== $ipAddress) {
24		$createTag->addChild('ip_address', $ipAddress);
25		}
26
27		if ('' !== $description) {
28		$createTag->addChild('description', $description);
29		}
30
31		$response = $this->_client->request($packet);
32
33		return (string) $response->key;
34		}
35
36		/**
37		* @param string $keyId
38		*
39		* @return bool
40		*/
41		public function delete($keyId)
42		{
43		return $this->_delete('key', $keyId, 'delete');
44		}
45
46		/**
47		* @param string $keyId
48		*
49		* @return Struct\Info
50		*/
51		public function get($keyId)
52		{
53		$items = $this->_get($keyId);
54
55		return reset($items);
		0 ignored issues – show Comprehensibility Best Practice introduced 2016-11-13 08:27 UTC by Report Bug Copy Issue Report The expression `reset($items);` of type `PleskX\Api\Struct\SecretKey\Info\|false` adds `false` to the return on line 55 which is incompatible with the return type documented by `PleskX\Api\Operator\SecretKey::get` of type `PleskX\Api\Struct\SecretKey\Info`. It seems like you forgot to handle an error condition. Loading history...
56		}
57
58		/**
59		* @return Struct\Info[]
60		*/
61		public function getAll()
62		{
63		return $this->_get();
64		}
65
66		/**
67		* @param string\|null $keyId
68		*
69		* @return Struct\Info[]
70		*/
71	View Code Duplication	public function _get($keyId = null)
		0 ignored issues – show Duplication introduced 2017-10-11 17:24 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		$packet = $this->_client->getPacket();
74		$getTag = $packet->addChild($this->_wrapperTag)->addChild('get_info');
75
76		$filterTag = $getTag->addChild('filter');
77		if (!is_null($keyId)) {
78		$filterTag->addChild('key', $keyId);
79		}
80
81		$response = $this->_client->request($packet, \PleskX\Api\Client::RESPONSE_FULL);
82
83		$items = [];
84		foreach ($response->xpath('//result/key_info') as $keyInfo) {
85		$items[] = new Struct\Info($keyInfo);
86		}
87
88		return $items;
89		}
90		}
91

plesk / api-php-lib

SecretKey::get() A last analyzed 2021-06-04 10:48 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

SecretKey::get() A
last analyzed 2021-06-04 10:48 UTC