Some PHPdoc updates.

Author: seanmcn

src/Kobas/Auth/Signer.php

@@ -12,28 +12,34 @@ class Signer
     protected $request_timestamp;
     protected $secret;
     protected $params;
-
-
     protected $company_id;
-
-    /**
-     * @var string
-     */
     protected $identifier;
-
     protected $region = 'uk-lon-1';
     protected $terminator = 'kbs_request';
     protected $auth_type = 'Bearer';
     protected $signed_headers = array();
     protected $signature;
 
+    /**
+     * Signer constructor.
+     * @param $company_id
+     * @param $identifier
+     * @param $secret
+     */
     public function __construct($company_id, $identifier, $secret)
     {
         $this->setCompanyId($company_id);
         $this->setIdentifier($identifier);
         $this->setSecret($secret);
     }
 
+    /**
+     * @param $method
+     * @param $url
+     * @param array $signed_headers
+     * @param array $data
+     * @return array
+     */
     public function signRequest($method, $url, array $signed_headers = array(), array $data = array())
     {
         $time = time();
@@ -58,6 +64,10 @@ public function signRequest($method, $url, array $signed_headers = array(), arra
         return $headers;
     }
 
+    /**
+     * @param $url
+     * @return $this
+     */
     public function setUrl($url)
     {
         $this->parsed_url = parse_url($url);
@@ -424,6 +434,11 @@ public function setHeaders($headers)
         return $this;
     }
 
+    /**
+     * @param $array
+     * @param int $sort_flags
+     * @return bool
+     */
     protected function sortArray(&$array, $sort_flags = SORT_REGULAR)
     {
         if (!is_array($array)) {

src/Kobas/Client.php

@@ -86,44 +86,52 @@ public function disableSSLVerification()
         $this->ssl_verify_peer = false;
     }
 
+
     /**
      * @param $route
      * @param array $params
      * @param array $headers
      * @return mixed
+     * @throws HttpException
      */
     public function get($route, array $params = array(), array $headers = array())
     {
         return $this->call('GET', $route, $params, $headers);
     }
 
+
     /**
      * @param $route
      * @param array $params
      * @param array $headers
      * @return mixed
+     * @throws HttpException
      */
     public function post($route, array $params = array(), array $headers = array())
     {
         return $this->call('POST', $route, $params, $headers);
     }
 
+
     /**
      * @param $route
      * @param array $params
      * @param array $headers
      * @return mixed
+     * @throws HttpException
      */
     public function put($route, array $params = array(), array $headers = array())
     {
         return $this->call('PUT', $route, $params, $headers);
     }
 
+
     /**
      * @param $route
      * @param array $params
      * @param array $headers
      * @return mixed
+     * @throws HttpException
      */
     public function delete($route, array $params = array(), array $headers = array())
     {
@@ -184,7 +192,7 @@ protected function call($http_method, $route, array $params = array(), array $he
 
         $this->request->setOption(CURLOPT_HTTPHEADER, $headers);
 
-        $result        = $this->request->execute();
+        $result = $this->request->execute();
         $last_response = $this->request->getInfo(CURLINFO_HTTP_CODE);
 
         $this->request->close();

src/Kobas/Exception/HttpException.php

@@ -3,10 +3,22 @@
 namespace Kobas\Exception;
 
 
+/**
+ * Class HttpException
+ * @package Kobas\Exception
+ */
 class HttpException extends \Exception
 {
+    /**
+     * @var
+     */
     protected $data;
 
+    /**
+     * HttpException constructor.
+     * @param $http_code
+     * @param string $message
+     */
     public function __construct($http_code, $message = '')
     {
         parent::__construct($message, $http_code);

src/Kobas/Request/Curl.php

@@ -2,10 +2,20 @@
 
 namespace Kobas\Request;
 
+/**
+ * Class Curl
+ * @package Kobas\Request
+ */
 class Curl implements HttpRequest
 {
+    /**
+     * @var null
+     */
     private $handle = null;
 
+    /**
+     * @return $this
+     */
     public function init()
     {
         if (is_null($this->handle)) {
@@ -15,27 +25,46 @@ public function init()
         return $this;
     }
 
+    /**
+     * @param $url
+     * @return $this|Curl
+     */
     public function setUrl($url)
     {
         return $this->setOption(CURLOPT_URL, $url);
     }
 
+    /**
+     * @param $name
+     * @param $value
+     * @return $this
+     */
     public function setOption($name, $value)
     {
         curl_setopt($this->handle, $name, $value);
         return $this;
     }
 
+    /**
+     * @return mixed
+     */
     public function execute()
     {
         return curl_exec($this->handle);
     }
 
+    /**
+     * @param $name
+     * @return mixed
+     */
     public function getInfo($name)
     {
         return curl_getinfo($this->handle, $name);
     }
 
+    /**
+     * @return $this
+     */
     public function close()
     {
         curl_close($this->handle);