Merge pull request #77 from plesk/analysis-BMMv97

Apply fixes from StyleCI

Author: sibprogrammer

src/Api/Client.php

@@ -2,10 +2,11 @@
 // Copyright 1999-2020. Plesk International GmbH.
 
 namespace PleskX\Api;
+
 use SimpleXMLElement;
 
 /**
- * Client for Plesk XML-RPC API
+ * Client for Plesk XML-RPC API.
  */
 class Client
 {
@@ -28,7 +29,7 @@ class Client
     protected $_verifyResponseCallback;
 
     /**
-     * Create client
+     * Create client.
      *
      * @param string $host
      * @param int $port
@@ -42,7 +43,7 @@ public function __construct($host, $port = 8443, $protocol = 'https')
     }
 
     /**
-     * Setup credentials for authentication
+     * Setup credentials for authentication.
      *
      * @param string $login
      * @param string $password
@@ -54,7 +55,7 @@ public function setCredentials($login, $password)
     }
 
     /**
-     * Define secret key for alternative authentication
+     * Define secret key for alternative authentication.
      *
      * @param string $secretKey
      */
@@ -64,7 +65,7 @@ public function setSecretKey($secretKey)
     }
 
     /**
-     * Set default version for requests
+     * Set default version for requests.
      *
      * @param string $version
      */
@@ -74,7 +75,7 @@ public function setVersion($version)
     }
 
     /**
-     * Set custom function to verify response of API call according your own needs. Default verifying will be used if it is not specified
+     * Set custom function to verify response of API call according your own needs. Default verifying will be used if it is not specified.
      *
      * @param callable|null $function
      */
@@ -84,7 +85,7 @@ public function setVerifyResponse(callable $function = null)
     }
 
     /**
-     * Retrieve host used for communication
+     * Retrieve host used for communication.
      *
      * @return string
      */
@@ -94,7 +95,7 @@ public function getHost()
     }
 
     /**
-     * Retrieve port used for communication
+     * Retrieve port used for communication.
      *
      * @return int
      */
@@ -104,7 +105,7 @@ public function getPort()
     }
 
     /**
-     * Retrieve name of the protocol (http or https) used for communication
+     * Retrieve name of the protocol (http or https) used for communication.
      *
      * @return string
      */
@@ -114,24 +115,27 @@ public function getProtocol()
     }
 
     /**
-     * Retrieve XML template for packet
+     * Retrieve XML template for packet.
      *
      * @param string|null $version
+     *
      * @return SimpleXMLElement
      */
     public function getPacket($version = null)
     {
         $protocolVersion = !is_null($version) ? $version : $this->_version;
         $content = "<?xml version='1.0' encoding='UTF-8' ?>";
-        $content .= "<packet" . ("" === $protocolVersion ? "" : " version='$protocolVersion'") . "/>";
+        $content .= '<packet'.('' === $protocolVersion ? '' : " version='$protocolVersion'").'/>';
+
         return new SimpleXMLElement($content);
     }
 
     /**
-     * Perform API request
+     * Perform API request.
      *
      * @param string|array|SimpleXMLElement $request
      * @param int $mode
+     *
      * @return XmlResponse
      */
     public function request($request, $mode = self::RESPONSE_SHORT)
@@ -143,14 +147,14 @@ public function request($request, $mode = self::RESPONSE_SHORT)
 
             if (is_array($request)) {
                 $request = $this->_arrayToXml($request, $xml)->asXML();
-            } else if (preg_match('/^[a-z]/', $request)) {
+            } elseif (preg_match('/^[a-z]/', $request)) {
                 $request = $this->_expandRequestShortSyntax($request, $xml);
             }
         }
 
         if ('sdk' == $this->_protocol) {
             $version = ('' == $this->_version) ? null : $this->_version;
-            $requestXml = new SimpleXMLElement((string)$request);
+            $requestXml = new SimpleXMLElement((string) $request);
             $xml = \pm_ApiRpc::getService($version)->call($requestXml->children()[0]->asXml(), $this->_login);
         } else {
             $xml = $this->_performHttpRequest($request);
@@ -164,11 +168,13 @@ public function request($request, $mode = self::RESPONSE_SHORT)
     }
 
     /**
-     * Perform HTTP request to end-point
+     * Perform HTTP request to end-point.
      *
      * @param string $request
-     * @return XmlResponse
+     *
      * @throws Client\Exception
+     *
+     * @return XmlResponse
      */
     private function _performHttpRequest($request)
     {
@@ -191,20 +197,22 @@ private function _performHttpRequest($request)
         curl_close($curl);
 
         $xml = new XmlResponse($result);
+
         return $xml;
     }
 
     /**
-     * Perform multiple API requests using single HTTP request
+     * Perform multiple API requests using single HTTP request.
      *
      * @param $requests
      * @param int $mode
-     * @return array
+     *
      * @throws Client\Exception
+     *
+     * @return array
      */
     public function multiRequest($requests, $mode = self::RESPONSE_SHORT)
     {
-
         $requestXml = $this->getPacket();
 
         foreach ($requests as $request) {
@@ -213,7 +221,7 @@ public function multiRequest($requests, $mode = self::RESPONSE_SHORT)
             } else {
                 if (is_array($request)) {
                     $request = $this->_arrayToXml($request, $requestXml)->asXML();
-                } else if (preg_match('/^[a-z]/', $request)) {
+                } elseif (preg_match('/^[a-z]/', $request)) {
                     $this->_expandRequestShortSyntax($request, $requestXml);
                 }
             }
@@ -243,16 +251,16 @@ public function multiRequest($requests, $mode = self::RESPONSE_SHORT)
     }
 
     /**
-     * Retrieve list of headers needed for request
+     * Retrieve list of headers needed for request.
      *
      * @return array
      */
     protected function _getHeaders()
     {
-        $headers = array(
-            "Content-Type: text/xml",
-            "HTTP_PRETTY_PRINT: TRUE",
-        );
+        $headers = [
+            'Content-Type: text/xml',
+            'HTTP_PRETTY_PRINT: TRUE',
+        ];
 
         if ($this->_secretKey) {
             $headers[] = "KEY: $this->_secretKey";
@@ -265,29 +273,32 @@ protected function _getHeaders()
     }
 
     /**
-     * Verify that response does not contain errors
+     * Verify that response does not contain errors.
      *
      * @param XmlResponse $xml
+     *
      * @throws Exception
      */
     protected function _verifyResponse($xml)
     {
-        if ($xml->system && $xml->system->status && 'error' == (string)$xml->system->status) {
-            throw new Exception((string)$xml->system->errtext, (int)$xml->system->errcode);
+        if ($xml->system && $xml->system->status && 'error' == (string) $xml->system->status) {
+            throw new Exception((string) $xml->system->errtext, (int) $xml->system->errcode);
         }
 
         if ($xml->xpath('//status[text()="error"]') && $xml->xpath('//errcode') && $xml->xpath('//errtext')) {
-            $errorCode = (int)$xml->xpath('//errcode')[0];
-            $errorMessage = (string)$xml->xpath('//errtext')[0];
+            $errorCode = (int) $xml->xpath('//errcode')[0];
+            $errorMessage = (string) $xml->xpath('//errtext')[0];
+
             throw new Exception($errorMessage, $errorCode);
         }
     }
 
     /**
-     * Expand short syntax (some.method.call) into full XML representation
+     * Expand short syntax (some.method.call) into full XML representation.
      *
      * @param string $request
      * @param SimpleXMLElement $xml
+     *
      * @return string
      */
     protected function _expandRequestShortSyntax($request, SimpleXMLElement $xml)
@@ -304,11 +315,12 @@ protected function _expandRequestShortSyntax($request, SimpleXMLElement $xml)
     }
 
     /**
-     * Convert array to XML representation
+     * Convert array to XML representation.
      *
      * @param array $array
      * @param SimpleXMLElement $xml
      * @param string $parentEl
+     *
      * @return SimpleXMLElement
      */
     protected function _arrayToXml(array $array, SimpleXMLElement $xml, $parentEl = null)
@@ -327,6 +339,7 @@ protected function _arrayToXml(array $array, SimpleXMLElement $xml, $parentEl =
 
     /**
      * @param array $array
+     *
      * @return bool
      */
     protected function _isAssocArray(array $array)
@@ -336,12 +349,13 @@ protected function _isAssocArray(array $array)
 
     /**
      * @param string $name
+     *
      * @return \PleskX\Api\Operator
      */
     protected function _getOperator($name)
     {
         if (!isset($this->_operatorsCache[$name])) {
-            $className = '\\PleskX\\Api\\Operator\\' . $name;
+            $className = '\\PleskX\\Api\\Operator\\'.$name;
             $this->_operatorsCache[$name] = new $className($this);
         }
 

src/Api/Client/Exception.php

@@ -4,7 +4,7 @@
 namespace PleskX\Api\Client;
 
 /**
- * Transport layer exception
+ * Transport layer exception.
  */
 class Exception extends \Exception
 {

src/Api/Exception.php

@@ -4,7 +4,7 @@
 namespace PleskX\Api;
 
 /**
- * Exceptions for XML-RPC API client
+ * Exceptions for XML-RPC API client.
  */
 class Exception extends \Exception
 {

src/Api/InternalClient.php

@@ -4,7 +4,7 @@
 namespace PleskX\Api;
 
 /**
- * Internal client for Plesk XML-RPC API (via SDK)
+ * Internal client for Plesk XML-RPC API (via SDK).
  */
 class InternalClient extends Client
 {
@@ -14,7 +14,7 @@ public function __construct()
     }
 
     /**
-     * Setup login to execute requests under certain user
+     * Setup login to execute requests under certain user.
      *
      * @param $login
      */

src/Api/Operator.php

@@ -5,7 +5,6 @@
 
 class Operator
 {
-
     /** @var string|null */
     protected $_wrapperTag = null;
 
@@ -24,10 +23,11 @@ public function __construct($client)
     }
 
     /**
-     * Perform plain API request
+     * Perform plain API request.
      *
      * @param string|array $request
      * @param int $mode
+     *
      * @return XmlResponse
      */
     public function request($request, $mode = Client::RESPONSE_SHORT)
@@ -36,7 +36,7 @@ public function request($request, $mode = Client::RESPONSE_SHORT)
 
         if (is_array($request)) {
             $request = [$wrapperTag => $request];
-        } else if (preg_match('/^[a-z]/', $request)) {
+        } elseif (preg_match('/^[a-z]/', $request)) {
             $request = "$wrapperTag.$request";
         } else {
             $request = "<$wrapperTag>$request</$wrapperTag>";
@@ -47,22 +47,25 @@ public function request($request, $mode = Client::RESPONSE_SHORT)
 
     /**
      * @param string $field
-     * @param integer|string $value
+     * @param int|string $value
      * @param string $deleteMethodName
+     *
      * @return bool
      */
     protected function _delete($field, $value, $deleteMethodName = 'del')
     {
         $response = $this->request("$deleteMethodName.filter.$field=$value");
-        return 'ok' === (string)$response->status;
+
+        return 'ok' === (string) $response->status;
     }
 
     /**
      * @param string $structClass
      * @param string $infoTag
      * @param string|null $field
-     * @param integer|string|null $value
+     * @param int|string|null $value
      * @param callable|null $filter
+     *
      * @return mixed
      */
     protected function _getItems($structClass, $infoTag, $field = null, $value = null, callable $filter = null)
@@ -89,5 +92,4 @@ protected function _getItems($structClass, $infoTag, $field = null, $value = nul
 
         return $items;
     }
-
 }

src/Api/Operator/Aps.php

@@ -5,5 +5,4 @@
 
 class Aps extends \PleskX\Api\Operator
 {
-
 }