Merge pull request kbsali#102 from JanMalte/fix-scrutinizer-issues

Fix scrutinizer issues

Author: kbsali

lib/Redmine/Api/AbstractApi.php

@@ -38,31 +38,49 @@ public function lastCallFailed()
     }
 
     /**
-     * {@inheritDoc}
+     * Perform the client get() method.
+     *
+     * @param string $path
+     *
+     * @return array
      */
     protected function get($path)
     {
         return $this->client->get($path);
     }
 
     /**
-     * {@inheritDoc}
+     * Perform the client post() method.
+     *
+     * @param string $path
+     * @param string $data
+     *
+     * @return string|false
      */
     protected function post($path, $data)
     {
         return $this->client->post($path, $data);
     }
 
     /**
-     * {@inheritDoc}
+     * Perform the client put() method.
+     *
+     * @param string $path
+     * @param string $data
+     *
+     * @return string|false
      */
     protected function put($path, $data)
     {
         return $this->client->put($path, $data);
     }
 
     /**
-     * {@inheritDoc}
+     * Perform the client delete() method.
+     *
+     * @param string $path
+     *
+     * @return array
      */
     protected function delete($path)
     {
@@ -141,7 +159,7 @@ protected function retrieveAll($endpoint, array $params = array())
      *
      * @param  SimpleXMLElement $xml    XML Element the custom fields are attached to
      * @param  array            $fields array of fields to attach, each field needs name, id and value set
-     * @return $xml             Element
+     * @return SimpleXMLElement $xml
      * @see http://www.redmine.org/projects/redmine/wiki/Rest_api#Working-with-custom-fields
      */
     protected function attachCustomFieldXML(SimpleXMLElement $xml, array $fields)

lib/Redmine/Api/Issue.php

@@ -196,7 +196,7 @@ public function removeWatcher($id, $watcher_user_id)
     /**
      * @param  int    $id
      * @param  string $status
-     * @return void
+     * @return SimpleXMLElement
      */
     public function setIssueStatus($id, $status)
     {
@@ -210,7 +210,7 @@ public function setIssueStatus($id, $status)
     /**
      * @param  int    $id
      * @param  string $note
-     * @return void
+     * @return SimpleXMLElement
      */
     public function addNoteToIssue($id, $note)
     {
@@ -265,6 +265,7 @@ private function cleanParams(array $params = array())
      */
     public function attach($id, array $attachment)
     {
+        $request = array();
         $request['issue'] = array(
             'id' => $id,
             'uploads' => array(

lib/Redmine/Api/Project.php

@@ -49,7 +49,7 @@ public function listing($forceUpdate = false, $reverse = true)
     /**
      * Get a project id given its name
      * @param  string $name
-     * @return int
+     * @return integer|boolean
      */
     public function getIdByName($name)
     {

lib/Redmine/Api/User.php

@@ -60,7 +60,7 @@ public function getCurrentUser()
     /**
      * Get a user id given its username
      * @param  string $username
-     * @return int
+     * @return integer|boolean
      */
     public function getIdByUsername($username)
     {

lib/Redmine/Client.php

@@ -90,7 +90,7 @@ class Client
     public function __construct($url, $apikeyOrUsername, $pass = null)
     {
         $this->url = $url;
-        $this->getPort($url);
+        $this->getPort();
         $this->apikeyOrUsername = $apikeyOrUsername;
         $this->pass = $pass;
     }
@@ -159,9 +159,13 @@ public function get($path)
     }
 
     /**
-     * Decodes json response
+     * Decodes json response.
+     * 
+     * Returns $json if no error occured during decoding but decoded value is
+     * null.
+     * 
      * @param  string $json
-     * @return array
+     * @return array|string
      */
     public function decode($json)
     {
@@ -293,7 +297,7 @@ public function getPort()
     /**
      * Sets to an existing username so api calls can be
      * impersonated to this user
-     * @param  string $username
+     * @param  string|null $username
      * @return Client
      */
     public function setImpersonateUser($username = null)
@@ -304,19 +308,23 @@ public function setImpersonateUser($username = null)
     }
 
     /**
-     * @return mixed
+     * Get the impersonate user.
+     *
+     * @return string|null
      */
     public function getImpersonateUser()
     {
         return $this->impersonateUser;
     }
 
     /**
-     * @param  string                        $path
-     * @param  string                        $method
-     * @param  string                        $data
-     * @return false|SimpleXMLElement|string
-     * @throws \Exception                    If anything goes wrong on curl request
+     * @param  string $path
+     * @param  string $method
+     * @param  string $data
+     *
+     * @return boolean|SimpleXMLElement|string
+     *
+     * @throws \Exception If anything goes wrong on curl request
      */
     protected function runRequest($path, $method = 'GET', $data = '')
     {
@@ -386,6 +394,7 @@ protected function runRequest($path, $method = 'GET', $data = '')
             default: // GET
                 break;
         }
+        /* @var $response boolean|string */
         $response = curl_exec($curl);
         $this->responseCode = curl_getinfo($curl, CURLINFO_HTTP_CODE);
         $contentType = curl_getinfo($curl, CURLINFO_CONTENT_TYPE);