Реформат кода. Добавлен доп параметры для запросов.

NodaSoft · Apr 5, 2018 · 8f89c5e · 8f89c5e
1 parent 15fdd27
commit 8f89c5e
Show file tree

Hide file tree

Showing 25 changed files with 103 additions and 17 deletions.
diff --git a/src/Common/AnnotationHelper.php b/src/Common/AnnotationHelper.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace NS\ABCPApi\Common;
 
 use ReflectionClass;
@@ -15,38 +16,40 @@ class AnnotationHelper
      *
      * @var string[]
      */
-    private static $availableTypes = array(
+    private static $availableTypes = [
         'int',
         'string',
         '\DateTime',
         'boolean',
         'integer',
-    );
+    ];
 
     /**
      * Возвращает список свойств по имени класса.
      *
      * @param $className
      * @return array [string 'name', string 'type']
+     * @throws \ReflectionException
      */
     public static function getPropertiesTypes($className)
     {
         if (!class_exists($className)) {
-            return array();
+            return [];
         }
         $reflection = new ReflectionClass($className);
-        $outputPropertiesNames = array();
+        $outputPropertiesNames = [];
         foreach ($reflection->getProperties() as $onePropertyReflection) {
             $propertyType = self::DEFAULT_PROPERTY_TYPE;
             preg_match('/@var\s+([\\\\]?\w+)/', $onePropertyReflection->getDocComment(), $matches);
             if (isset($matches[1]) && in_array($matches[1], self::$availableTypes, true)) {
                 $propertyType = $matches[1];
             }
-            $outputPropertiesNames[] = array(
+            $outputPropertiesNames[] = [
                 'name' => $onePropertyReflection->getName(),
                 'type' => $propertyType
-            );
+            ];
         }
+
         return $outputPropertiesNames;
     }
 }
diff --git a/src/Common/CarType.php b/src/Common/CarType.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace NS\ABCPApi\Common;
 
 /**

diff --git a/src/Common/ServiceErrors.php b/src/Common/ServiceErrors.php
@@ -1,9 +1,10 @@
 <?php
+
 namespace NS\ABCPApi\Common;
 
 class ServiceErrors
 {
-    private static $errors = array(
+    private static $errors = [
         0 => 'Неизвестная ошибка',
         1 => 'Некорректный запрос',
         2 => 'Недостаточно параметров',
@@ -18,7 +19,7 @@ class ServiceErrors
         301 => 'Объект не найден',
         302 => 'Ошибка инициализации кэша',
         303 => 'Ресурс заблокирован'
-    );
+    ];
 
     /**
      * Вовзращает сообщение об ошибке по её коду.

diff --git a/src/RestApiClients/TecDoc.php b/src/RestApiClients/TecDoc.php
@@ -50,6 +50,45 @@ class TecDoc extends RestClient
      * @var string
      */
     private $host = '';
+    /**
+     * Дополнительные параметры для запроса
+     *
+     * @var array
+     */
+    private $additionalParams = [];
+
+    /**
+     * Возвращает список дополнительных параметров запроса
+     *
+     * @return array
+     */
+    public function getAdditionalParams()
+    {
+        return $this->additionalParams;
+    }
+
+    /**
+     * Устанавливает дополнительные параметры
+     *
+     * @param array $additionalParams
+     * @return $this
+     */
+    public function setAdditionalParams($additionalParams = [])
+    {
+        $this->additionalParams = $additionalParams;
+
+        return $this;
+    }
+
+    /**
+     * Добавляет дополнительные параметры
+     *
+     * @param array $additionalParams
+     */
+    public function addAdditionalParams($additionalParams)
+    {
+        $this->additionalParams[] = $additionalParams;
+    }
 
     /**
      * Возвращает хост для сервиса TecDoc API, либо если хост не задан дефолтный.
@@ -163,6 +202,7 @@ public function __construct($userKey = '', $userLogin = '', $userPsw = '')
      * @param int $carType
      * @param int $motorcyclesFilter
      * @return Manufacturer[]
+     * @throws \Exception
      */
     public function getManufacturers($carType = CarType::ALL, $motorcyclesFilter = Motorcycle::ALL)
     {
@@ -233,11 +273,13 @@ public function getBrandsAsArray()
      */
     private function getAuthenticationData()
     {
-        return array(
+        $authData = [
             'userlogin' => $this->getUserLogin(),
             'userpsw' => $this->getUserPsw(),
             'userkey' => $this->getUserKey()
-        );
+        ];
+
+        return array_merge($authData, $this->additionalParams);
     }
 
     /**
@@ -426,7 +468,7 @@ public function getArticlesAsArray($modificationId, $categoryId, $brandName, $ca
         $requestVars['categoryId'] = $categoryId;
         $requestVars['carType'] = $carType;
         if (!empty($brandName)) {
-            $requestVars['brandNames'] = array($brandName);
+            $requestVars['brandNames'] = [$brandName];
         }
         $request = new Request(TecDoc::getTecdocHost());
         $request->setParameters($requestVars)
@@ -660,6 +702,7 @@ public function getRealNumberArticlesAsArray($articleId)
      * @param int $modelId
      * @param int $modificationId
      * @return AssignedArticleAttributes[]
+     * @throws \Exception
      */
     public function getAssignedArticleAttributes($articleIdLinkIdPairs, $manufacturerId, $modelId, $modificationId)
     {

diff --git a/src/RestClient/Request.php b/src/RestClient/Request.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace NS\ABCPApi\RestClient;
 
 /**
@@ -32,7 +33,7 @@ class Request
      *
      * @var array
      */
-    protected $parameters = array();
+    protected $parameters = [];
 
     /**
      * Имя операци.
@@ -65,6 +66,7 @@ public function getServiceUrl()
     public function setServiceUrl($serviceUrl)
     {
         $this->serviceUrl = $serviceUrl;
+
         return $this;
     }
 
@@ -87,6 +89,7 @@ public function getHttpAccept()
     public function setHttpAccept($httpAccept)
     {
         $this->httpAccept = $httpAccept;
+
         return $this;
     }
 
@@ -109,6 +112,7 @@ public function getMethod()
     public function setMethod($method)
     {
         $this->method = $method;
+
         return $this;
     }
 
@@ -131,6 +135,7 @@ public function getParameters()
     public function setParameters(array $parameters)
     {
         $this->parameters = $parameters;
+
         return $this;
     }
 
@@ -144,6 +149,7 @@ public function setParameters(array $parameters)
     public function addParameter($name, $value)
     {
         $this->parameters[$name] = $value;
+
         return $this;
     }
 
@@ -156,6 +162,7 @@ public function addParameter($name, $value)
     public function removeParameter($name)
     {
         unset($this->parameters[$name]);
+
         return $this;
     }
 
@@ -178,6 +185,7 @@ public function getOperation()
     public function setOperation($operation)
     {
         $this->operation = $operation;
+
         return $this;
     }
 }
diff --git a/src/RestClient/Response.php b/src/RestClient/Response.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace NS\ABCPApi\RestClient;
 
 /**
@@ -47,6 +48,7 @@ public function getStatus()
     public function setStatus($status)
     {
         $this->status = (int)$status;
+
         return $this;
     }
 
@@ -69,6 +71,7 @@ public function getHeaders()
     public function setHeaders($headers)
     {
         $this->headers = $headers;
+
         return $this;
     }
 
@@ -81,7 +84,8 @@ public function setHeaders($headers)
     public function getAsArray()
     {
         $jsonData = json_decode($this->getBody(), true);
-        return $jsonData ? $jsonData : array();
+
+        return $jsonData ? $jsonData : [];
     }
 
     /**
@@ -103,6 +107,7 @@ public function getBody()
     public function setBody($body)
     {
         $this->body = $body;
+
         return $this;
     }
 }
diff --git a/src/RestClient/RestClient.php b/src/RestClient/RestClient.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace NS\ABCPApi\RestClient;
 
 /**
@@ -97,7 +98,7 @@ private function doExecute($curlHandle, Request $request)
         curl_setopt($curlHandle, CURLOPT_TIMEOUT, 120);
         curl_setopt($curlHandle, CURLOPT_RETURNTRANSFER, true);
         curl_setopt($curlHandle, CURLOPT_HEADER, true);
-        curl_setopt($curlHandle, CURLOPT_HTTPHEADER, array('Accept: ' . $request->getHttpAccept()));
+        curl_setopt($curlHandle, CURLOPT_HTTPHEADER, ['Accept: ' . $request->getHttpAccept()]);
         $res = curl_exec($curlHandle);
         $this->requestInfo = $info = curl_getinfo($curlHandle);
         $response = new Response();
@@ -140,7 +141,7 @@ private function executePost($curlHandle, Request $request)
      */
     private static function convertArray($data, $path = '')
     {
-        $out = array();
+        $out = [];
         if (is_array($data)) {
             foreach ($data as $k => $value) {
                 $path1 = $path ? $path . "[$k]" : $k;

diff --git a/src/TecDocEntities/AnalogArticle.php b/src/TecDocEntities/AnalogArticle.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace NS\ABCPApi\TecDocEntities;
 
 /**

diff --git a/src/TecDocEntities/AnalogTypes.php b/src/TecDocEntities/AnalogTypes.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace NS\ABCPApi\TecDocEntities;
 
 /**

diff --git a/src/TecDocEntities/Article.php b/src/TecDocEntities/Article.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace NS\ABCPApi\TecDocEntities;
 
 /**

diff --git a/src/TecDocEntities/ArticleAttribute.php b/src/TecDocEntities/ArticleAttribute.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace NS\ABCPApi\TecDocEntities;
 
 /**

diff --git a/src/TecDocEntities/ArticleDocument.php b/src/TecDocEntities/ArticleDocument.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace NS\ABCPApi\TecDocEntities;
 
 /**

diff --git a/src/TecDocEntities/ArticleInfo.php b/src/TecDocEntities/ArticleInfo.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace NS\ABCPApi\TecDocEntities;
 
 /**

diff --git a/src/TecDocEntities/ArticlePart.php b/src/TecDocEntities/ArticlePart.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace NS\ABCPApi\TecDocEntities;
 
 /**

diff --git a/src/TecDocEntities/ArticleSimplified.php b/src/TecDocEntities/ArticleSimplified.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace NS\ABCPApi\TecDocEntities;
 
 /**

diff --git a/src/TecDocEntities/AssignedArticleAttributes.php b/src/TecDocEntities/AssignedArticleAttributes.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace NS\ABCPApi\TecDocEntities;
 
 /**