Merge pull request #274 from mailjet/DE-1103-mailjet-sdk-improvements-fixes

php code sniffer fixes

Author: oleksandr-mykhailenko

composer.json

@@ -20,11 +20,18 @@
     "require-dev": {
         "phpunit/phpunit": "^8|^9",
         "mockery/mockery": "^1.4",
-        "php-coveralls/php-coveralls": "^2.0"
+        "php-coveralls/php-coveralls": "^2.0",
+        "phpcompatibility/php-compatibility": "*",
+        "phpstan/phpstan": "^1.10",
+        "squizlabs/php_codesniffer": "*"
     },
     "autoload": {
         "psr-0": {
             "Mailjet": "src/"
         }
+    },
+    "scripts": {
+        "post-install-cmd": "\"vendor/bin/phpcs\" --config-set installed_paths vendor/phpcompatibility/php-compatibility",
+        "post-update-cmd" : "\"vendor/bin/phpcs\" --config-set installed_paths vendor/phpcompatibility/php-compatibility"
     }
 }

src/Mailjet/Client.php

@@ -13,26 +13,26 @@
 
 class Client
 {
-    const WRAPPER_VERSION = Config::WRAPPER_VERSION;
+    public const WRAPPER_VERSION = Config::WRAPPER_VERSION;
 
     /**
      * connect_timeout: (float, default=2) Float describing the number of
      * seconds to wait while trying to connect to a server. Use 0 to wait
      * indefinitely (the default behavior).
      */
-    const CONNECT_TIMEOUT = 'connect_timeout';
+    public const CONNECT_TIMEOUT = 'connect_timeout';
 
     /**
      * timeout: (float, default=15) Float describing the timeout of the
      * request in seconds. Use 0 to wait indefinitely (the default behavior).
      */
-    const TIMEOUT = 'timeout';
+    public const TIMEOUT = 'timeout';
 
     /**
      * proxy: (array, default=none) Array describing the proxy options used by guzzle client
      * See guzzle-http for specification.
      */
-    const PROXY = 'proxy';
+    public const PROXY = 'proxy';
 
     private $apikey;
     private $apisecret;
@@ -43,15 +43,24 @@ class Client
     private $call = true;
     private $settings = [];
     private $changed = false;
+    /**
+     * @var int[]
+     */
     private $requestOptions = [
         self::TIMEOUT => 15,
         self::CONNECT_TIMEOUT => 2,
     ];
+    /**
+     * @var string[]
+     */
     private $smsResources = [
         'send',
         'sms',
         'sms-send',
     ];
+    /**
+     * @var string[]
+     */
     private $dataAction = [
         'csverror/text:csv',
         'csvdata/text:plain',
@@ -60,10 +69,11 @@ class Client
 
     /**
      * Client constructor requires:.
-     * @param string $key Mailjet API Key
-     * @param string|null $secret Mailjet API Secret
-     * @param bool $call performs the call or not
-     * @param array $settings
+     *
+     * @param string      $key      Mailjet API Key
+     * @param string|null $secret   Mailjet API Secret
+     * @param bool        $call     performs the call or not
+     * @param array       $settings
      */
     public function __construct(string $key, string $secret = null, bool $call = true, array $settings = [])
     {
@@ -72,9 +82,10 @@ public function __construct(string $key, string $secret = null, bool $call = tru
 
     /**
      * Trigger a POST request.
-     * @param array $resource Mailjet Resource/Action pair
-     * @param array $args Request arguments
-     * @param array $options
+     *
+     * @param  array $resource Mailjet Resource/Action pair
+     * @param  array $args     Request arguments
+     * @param  array $options
      * @return Response
      */
     public function post(array $resource, array $args = [], array $options = []): Response
@@ -94,9 +105,10 @@ public function post(array $resource, array $args = [], array $options = []): Re
 
     /**
      * Trigger a GET request.
-     * @param array $resource Mailjet Resource/Action pair
-     * @param array $args Request arguments
-     * @param array $options
+     *
+     * @param  array $resource Mailjet Resource/Action pair
+     * @param  array $args     Request arguments
+     * @param  array $options
      * @return Response
      */
     public function get(array $resource, array $args = [], array $options = []): Response
@@ -116,9 +128,10 @@ public function get(array $resource, array $args = [], array $options = []): Res
 
     /**
      * Trigger a POST request.
-     * @param array $resource Mailjet Resource/Action pair
-     * @param array $args Request arguments
-     * @param array $options
+     *
+     * @param  array $resource Mailjet Resource/Action pair
+     * @param  array $args     Request arguments
+     * @param  array $options
      * @return Response
      */
     public function put(array $resource, array $args = [], array $options = []): Response
@@ -138,9 +151,10 @@ public function put(array $resource, array $args = [], array $options = []): Res
 
     /**
      * Trigger a GET request.
-     * @param array $resource Mailjet Resource/Action pair
-     * @param array $args Request arguments
-     * @param array $options
+     *
+     * @param  array $resource Mailjet Resource/Action pair
+     * @param  array $args     Request arguments
+     * @param  array $options
      * @return Response
      */
     public function delete(array $resource, array $args = [], array $options = []): Response
@@ -160,7 +174,8 @@ public function delete(array $resource, array $args = [], array $options = []):
 
     /**
      * Sets if we need to use https or http protocol while using API Url.
-     * @param bool|mixed $bIsSecured True use https / false use http
+     *
+     * @param  bool|mixed $bIsSecured True use https / false use http
      * @return bool true if we set value false otherwise
      */
     public function setSecureProtocol($bIsSecured = null): bool
@@ -176,6 +191,7 @@ public function setSecureProtocol($bIsSecured = null): bool
 
     /**
      * Set HTTP request Timeout.
+     *
      * @param int $timeout
      */
     public function setTimeout(int $timeout): void
@@ -186,6 +202,7 @@ public function setTimeout(int $timeout): void
     /**
      * Set HTTP proxy options
      * See: http://docs.guzzlephp.org/en/stable/request-options.html#proxy.
+     *
      * @param array $proxyArray
      */
     public function setHttpProxy(array $proxyArray): void
@@ -195,6 +212,7 @@ public function setHttpProxy(array $proxyArray): void
 
     /**
      * Set HTTP connection Timeout.
+     *
      * @param int $timeout
      */
     public function setConnectionTimeout(int $timeout): void
@@ -222,15 +240,16 @@ public function getConnectionTimeout(): ?int
 
     /**
      * Add a HTTP request option.
+     *
      * @param string $key
-     * @param mixed $value
+     * @param mixed  $value
      *                     [IMPORTANT]Default options will be overwritten
      *                     if such option is provided
-     * @see \GuzzleHttp\RequestOptions for a list of available request options.
+     * @see   \GuzzleHttp\RequestOptions for a list of available request options.
      */
     public function addRequestOption(string $key, $value): void
     {
-        if ((null !== $key) && (null !== $value)) {
+        if ($key && (null !== $value)) {
             $this->requestOptions[$key] = $value;
         }
     }
@@ -246,10 +265,11 @@ public function getRequestOptions(): array
 
     /**
      * Set auth.
-     * @param string $key
+     *
+     * @param string      $key
      * @param string|null $secret
-     * @param bool $call
-     * @param array $settings
+     * @param bool        $call
+     * @param array       $settings
      */
     public function setAuthentication(string $key, ?string $secret, bool $call, array $settings = []): void
     {
@@ -267,6 +287,7 @@ public function setAuthentication(string $key, ?string $secret, bool $call, arra
         $this->setSettings();
     }
 
+    // phpcs:disable
     /**
      * Magic method to call a mailjet resource.
      * @param string $method Http method
@@ -289,7 +310,7 @@ private function _call(string $method, string $resource, string $action, array $
         $contentType = 'application/json';
         if ('csvdata/text:plain' === $action) {
             $contentType = 'text/plain';
-        } else if ('csverror/text:csv' === $action) {
+        } elseif ('csverror/text:csv' === $action) {
             $contentType = 'text/csv';
         }
 
@@ -309,9 +330,11 @@ private function _call(string $method, string $resource, string $action, array $
         return $request->call($this->call);
     }
 
+    // phpcs:enable
     /**
      * Build the base API url depending on wether user need a secure connection
      * or not.
+     *
      * @return string the API url;
      */
     private function getApiUrl(): string
@@ -324,8 +347,9 @@ private function getApiUrl(): string
     /**
      * Checks that both parameters are strings, which means
      * that basic authentication will be required.
-     * @param mixed $key
-     * @param mixed $secret
+     *
+     * @param  mixed $key
+     * @param  mixed $secret
      * @return bool flag
      */
     private function isBasicAuthentication($key, $secret): bool
@@ -335,10 +359,11 @@ private function isBasicAuthentication($key, $secret): bool
 
     /**
      * Build the final call url without query strings.
-     * @param string $resource Mailjet resource
-     * @param string $action Mailjet resource action
-     * @param string $id mailjet resource id
-     * @param string $actionid mailjet resource actionid
+     *
+     * @param  string $resource Mailjet resource
+     * @param  string $action   Mailjet resource action
+     * @param  string $id       mailjet resource id
+     * @param  string $actionid mailjet resource actionid
      * @return string final call url
      */
     private function buildURL(string $resource, string $action, string $id, string $actionid): string
@@ -360,14 +385,15 @@ private function buildURL(string $resource, string $action, string $id, string $
 
     /**
      * Temporary set the variables generating the url.
-     * @param array $options contain temporary modifications for the client
+     *
+     * @param array $options  contain temporary modifications for the client
      * @param array $resource may contain the version linked to the resource
      */
     private function setOptions(array $options, array $resource): void
     {
         if (isset($options['version'])) {
             $this->version = $options['version'];
-        } else if (isset($resource[2])) {
+        } elseif (isset($resource[2])) {
             $this->version = $resource[2];
         }
 
@@ -403,7 +429,8 @@ private function setSettings(): void
 
     /**
      * Set a backup if the variables generating the url are change during a call.
-     * @param bool $call
+     *
+     * @param bool  $call
      * @param array $settings
      */
     private function initSettings(bool $call, array $settings = []): void