Skip to content

Apply fixes from StyleCI #76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Apply fixes from StyleCI #76

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 48 additions & 33 deletions src/Api/Client.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
<?php

// 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
{
Expand All @@ -28,7 +30,7 @@ class Client
protected $_verifyResponseCallback;

/**
* Create client
* Create client.
*
* @param string $host
* @param int $port
Expand All @@ -42,7 +44,7 @@ public function __construct($host, $port = 8443, $protocol = 'https')
}

/**
* Setup credentials for authentication
* Setup credentials for authentication.
*
* @param string $login
* @param string $password
Expand All @@ -54,7 +56,7 @@ public function setCredentials($login, $password)
}

/**
* Define secret key for alternative authentication
* Define secret key for alternative authentication.
*
* @param string $secretKey
*/
Expand All @@ -64,7 +66,7 @@ public function setSecretKey($secretKey)
}

/**
* Set default version for requests
* Set default version for requests.
*
* @param string $version
*/
Expand All @@ -74,7 +76,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
*/
Expand All @@ -84,7 +86,7 @@ public function setVerifyResponse(callable $function = null)
}

/**
* Retrieve host used for communication
* Retrieve host used for communication.
*
* @return string
*/
Expand All @@ -94,7 +96,7 @@ public function getHost()
}

/**
* Retrieve port used for communication
* Retrieve port used for communication.
*
* @return int
*/
Expand All @@ -104,7 +106,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
*/
Expand All @@ -114,24 +116,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)
Expand All @@ -143,14 +148,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);
Expand All @@ -164,11 +169,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)
{
Expand All @@ -191,20 +198,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) {
Expand All @@ -213,7 +222,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);
}
}
Expand Down Expand Up @@ -243,16 +252,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";
Expand All @@ -265,29 +274,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)
Expand All @@ -304,11 +316,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)
Expand All @@ -327,6 +340,7 @@ protected function _arrayToXml(array $array, SimpleXMLElement $xml, $parentEl =

/**
* @param array $array
*
* @return bool
*/
protected function _isAssocArray(array $array)
Expand All @@ -336,12 +350,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);
}

Expand Down
3 changes: 2 additions & 1 deletion src/Api/Client/Exception.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
<?php

// Copyright 1999-2020. Plesk International GmbH.

namespace PleskX\Api\Client;

/**
* Transport layer exception
* Transport layer exception.
*/
class Exception extends \Exception
{
Expand Down
3 changes: 2 additions & 1 deletion src/Api/Exception.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
<?php

// Copyright 1999-2020. Plesk International GmbH.

namespace PleskX\Api;

/**
* Exceptions for XML-RPC API client
* Exceptions for XML-RPC API client.
*/
class Exception extends \Exception
{
Expand Down
5 changes: 3 additions & 2 deletions src/Api/InternalClient.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
<?php

// Copyright 1999-2020. Plesk International GmbH.

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
{
Expand All @@ -14,7 +15,7 @@ public function __construct()
}

/**
* Setup login to execute requests under certain user
* Setup login to execute requests under certain user.
*
* @param $login
*/
Expand Down
Loading