cs fix

Author: kbsali

example.php

@@ -58,7 +58,7 @@
 // Project
 $client->api('project')->all();
 $client->api('project')->all(array(
-    'limit' => 10
+    'limit' => 10,
 ));
 $client->api('project')->listing();
 $client->api('project')->listing();
@@ -82,7 +82,7 @@
 $client->api('user')->getIdByUsername('kbsali');
 $client->api('user')->show($userId);
 $client->api('user')->update($userId, array(
-    'firstname' => 'Raul'
+    'firstname' => 'Raul',
 ));
 $client->api('user')->remove($userId);
 $client->api('user')->create(array(
@@ -96,7 +96,7 @@
 // Issues
 $client->api('issue')->show($issueId);
 $client->api('issue')->all(array(
-    'limit' => 100
+    'limit' => 100,
 ));
 $client->api('issue')->all(array('category_id'    => $categoryId));
 $client->api('issue')->all(array('tracker_id'     => $trackerId));
@@ -154,16 +154,16 @@
 $client->api('issue')->remove($issueId);
 
 // To upload a file + attach it to an existing issue with $issueId
-$upload = json_decode( $client->api('attachment')->upload($filecontent) );
+$upload = json_decode($client->api('attachment')->upload($filecontent));
 $client->api('issue')->attach($issueId, array(
     'token'        => $upload->upload->token,
     'filename'     => 'MyFile.pdf',
     'description'  => 'MyFile is better then YourFile...',
-    'content_type' => 'application/pdf'
+    'content_type' => 'application/pdf',
 ));
 
 // Or, create a new issue with the file attached in one step
-$upload = json_decode( $client->api('attachment')->upload($filecontent) );
+$upload = json_decode($client->api('attachment')->upload($filecontent));
 $client->api('issue')->create(array(
     'project_id'  => 'myproject',
     'subject'     => 'A test issue',
@@ -173,9 +173,9 @@
           'token'       => $upload->upload->token,
           'filename'    => 'MyFile.pdf',
           'description' => 'MyFile is better then YourFile...',
-          'content_type'=> 'application/pdf'
-        )
-    )
+          'content_type' => 'application/pdf',
+        ),
+    ),
 ));
 
 // ----------------------------
@@ -192,7 +192,7 @@
 ));
 $client->api('issue_category')->remove($categoryId);
 $client->api('issue_category')->remove($categoryId, array(
-    'reassign_to_id' => $userId
+    'reassign_to_id' => $userId,
 ));
 
 // ----------------------------
@@ -302,7 +302,6 @@
 ));
 $client->api('wiki')->remove('testProject', 'about');
 
-
 // ----------------------------
 // Issues' stats (see https://github.com/kbsali/php-redmine-api/issues/44)
 $issues['all'] = $client->api('issue')->all([

lib/Redmine/Api/AbstractApi.php

@@ -5,14 +5,14 @@
 use Redmine\Client;
 
 /**
- * Abstract class for Api classes
+ * Abstract class for Api classes.
  *
  * @author Kevin Saliou <kevin at saliou dot name>
  */
 abstract class AbstractApi
 {
     /**
-     * The client
+     * The client.
      *
      * @var Client
      */
@@ -28,6 +28,7 @@ public function __construct(Client $client)
 
     /**
      * Returns whether or not the last api call failed.
+     *
      * @return bool
      */
     public function lastCallFailed()
@@ -88,7 +89,7 @@ protected function delete($path)
     }
 
     /**
-     * Checks if the variable passed is not null
+     * Checks if the variable passed is not null.
      *
      * @param mixed $var Variable to be checked
      *
@@ -100,12 +101,12 @@ protected function isNotNull($var)
             false !== $var &&
             null !== $var &&
             '' !== $var &&
-            !( (is_array($var) || is_object($var)) && empty($var) );
+            !((is_array($var) || is_object($var)) && empty($var));
     }
 
     /**
-     * @param  array $defaults
-     * @param  array $params
+     * @param array $defaults
+     * @param array $params
      *
      * @return array
      */
@@ -118,11 +119,12 @@ protected function sanitizeParams(array $defaults, array $params)
     }
     /**
      * Retrieves all the elements of a given endpoint (even if the
-     * total number of elements is greater than 100)
+     * total number of elements is greater than 100).
+     *
+     * @param string $endpoint API end point
+     * @param array  $params   optional parameters to be passed to the api (offset, limit, ...)
      *
-     * @param  string $endpoint API end point
-     * @param  array  $params   optional parameters to be passed to the api (offset, limit, ...)
-     * @return array  elements found
+     * @return array elements found
      */
     protected function retrieveAll($endpoint, array $params = array())
     {
@@ -169,11 +171,13 @@ protected function retrieveAll($endpoint, array $params = array())
     }
 
     /**
-     * Attaches Custom Fields to a create/update query
+     * Attaches Custom Fields to a create/update query.
+     *
+     * @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
      *
-     * @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 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/Attachment.php

@@ -3,29 +3,33 @@
 namespace Redmine\Api;
 
 /**
- * Attachment details
+ * Attachment details.
  *
  * @link   http://www.redmine.org/projects/redmine/wiki/Rest_Attachments
+ *
  * @author Kevin Saliou <kevin at saliou dot name>
  */
 class Attachment extends AbstractApi
 {
     /**
-     * Get extended information about an attachment
+     * Get extended information about an attachment.
+     *
      * @link http://www.redmine.org/projects/redmine/wiki/Rest_Attachments
      *
-     * @param  string $id the attachment number
-     * @return array  information about the attachment
+     * @param string $id the attachment number
+     *
+     * @return array information about the attachment
      */
     public function show($id)
     {
         return $this->get('/attachments/'.urlencode($id).'.json');
     }
 
     /**
-     * Get attachment content as a binary file
+     * Get attachment content as a binary file.
+     *
+     * @param string $id the attachment number
      *
-     * @param  string $id the attachment number
      * @return string the attachment content
      */
     public function download($id)
@@ -34,11 +38,13 @@ public function download($id)
     }
 
     /**
-     * Upload a file to redmine
+     * Upload a file to redmine.
+     *
      * @link http://www.redmine.org/projects/redmine/wiki/Rest_api#Attaching-files
      *
-     * @param  string $attachment the attachment content
-     * @return array  information about the attachment
+     * @param string $attachment the attachment content
+     *
+     * @return array information about the attachment
      */
     public function upload($attachment)
     {

lib/Redmine/Api/CustomField.php

@@ -3,20 +3,23 @@
 namespace Redmine\Api;
 
 /**
- * Listing custom fields
+ * Listing custom fields.
  *
  * @link   http://www.redmine.org/projects/redmine/wiki/Rest_CustomFields
+ *
  * @author Kevin Saliou <kevin at saliou dot name>
  */
 class CustomField extends AbstractApi
 {
     private $customFields = array();
 
     /**
-     * List custom fields
+     * List custom fields.
+     *
      * @link http://www.redmine.org/projects/redmine/wiki/Rest_CustomFields#GET
      *
-     * @param  array $params optional parameters to be passed to the api (offset, limit, ...)
+     * @param array $params optional parameters to be passed to the api (offset, limit, ...)
+     *
      * @return array list of custom fields found
      */
     public function all(array $params = array())
@@ -27,10 +30,11 @@ public function all(array $params = array())
     }
 
     /**
-     * Returns an array of custom fields with name/id pairs
+     * Returns an array of custom fields with name/id pairs.
      *
-     * @param  boolean $forceUpdate to force the update of the custom fields var
-     * @return array   list of custom fields (id => name)
+     * @param boolean $forceUpdate to force the update of the custom fields var
+     *
+     * @return array list of custom fields (id => name)
      */
     public function listing($forceUpdate = false)
     {
@@ -46,9 +50,10 @@ public function listing($forceUpdate = false)
     }
 
     /**
-     * Get a tracket id given its name
+     * Get a tracket id given its name.
+     *
+     * @param string|int $name customer field name
      *
-     * @param  string|int $name customer field name
      * @return int|false
      */
     public function getIdByName($name)

lib/Redmine/Api/Group.php

@@ -3,20 +3,23 @@
 namespace Redmine\Api;
 
 /**
- * Handling of groups
+ * Handling of groups.
  *
  * @link   http://www.redmine.org/projects/redmine/wiki/Rest_Groups
+ *
  * @author Kevin Saliou <kevin at saliou dot name>
  */
 class Group extends AbstractApi
 {
     private $groups = array();
 
     /**
-     * List groups
+     * List groups.
+     *
      * @link http://www.redmine.org/projects/redmine/wiki/Rest_Groups#GET
      *
-     * @param  array $params optional parameters to be passed to the api (offset, limit, ...)
+     * @param array $params optional parameters to be passed to the api (offset, limit, ...)
+     *
      * @return array list of groups found
      */
     public function all(array $params = array())
@@ -27,10 +30,11 @@ public function all(array $params = array())
     }
 
     /**
-     * Returns an array of groups with name/id pairs
+     * Returns an array of groups with name/id pairs.
+     *
+     * @param boolean $forceUpdate to force the update of the groups var
      *
-     * @param  boolean $forceUpdate to force the update of the groups var
-     * @return array   list of groups (id => name)
+     * @return array list of groups (id => name)
      */
     public function listing($forceUpdate = false)
     {
@@ -46,10 +50,12 @@ public function listing($forceUpdate = false)
     }
 
     /**
-     * Create a new group with a group of users assigned
+     * Create a new group with a group of users assigned.
+     *
      * @link http://www.redmine.org/projects/redmine/wiki/Rest_Groups#POST
      *
-     * @param  array            $params the new group data
+     * @param array $params the new group data
+     *
      * @return SimpleXMLElement
      */
     public function create(array $params = array())
@@ -78,11 +84,13 @@ public function create(array $params = array())
 
     /**
      * Returns details of a group.
+     *
      * @link http://www.redmine.org/projects/redmine/wiki/Rest_Groups#GET-2
      * available $params :
      * - include: a coma separated list of associations to include in the response: users,memberships
      *
-     * @param  int   $id the group id
+     * @param int $id the group id
+     *
      * @return array
      */
     public function show($id, array $params = array())
@@ -91,10 +99,12 @@ public function show($id, array $params = array())
     }
 
     /**
-     * Delete a group
+     * Delete a group.
+     *
      * @link http://www.redmine.org/projects/redmine/wiki/Rest_Groups#DELETE
      *
-     * @param  int    $id id of the group
+     * @param int $id id of the group
+     *
      * @return string
      */
     public function remove($id)
@@ -103,11 +113,13 @@ public function remove($id)
     }
 
     /**
-     * Adds an existing user to a group
+     * Adds an existing user to a group.
+     *
      * @link http://www.redmine.org/projects/redmine/wiki/Rest_Groups#POST-2
      *
-     * @param  int    $id     id of the group
-     * @param  int    $userId id of the user
+     * @param int $id     id of the group
+     * @param int $userId id of the user
+     *
      * @return string
      */
     public function addUser($id, $userId)
@@ -118,11 +130,13 @@ public function addUser($id, $userId)
     }
 
     /**
-     * Removes a user from a group
+     * Removes a user from a group.
+     *
      * @link http://www.redmine.org/projects/redmine/wiki/Rest_Groups#DELETE-2
      *
-     * @param  int    $id     id of the group
-     * @param  int    $userId id of the user
+     * @param int $id     id of the group
+     * @param int $userId id of the user
+     *
      * @return string
      */
     public function removeUser($id, $userId)