add support for new custom fields api (introduced in redmine 2.4)

Author: kbsali

README.markdown

@@ -10,6 +10,7 @@ Uses [Redmine API](http://www.redmine.org/projects/redmine/wiki/Rest_api/).
 * API entry points implementation state :
  * OK Attachments
  * *NOK Groups - only partially implemented*
+ * OK Custom Fields
  * OK Issues
  * OK Issue Categories
  * OK Issue Priorities

example.php

@@ -277,3 +277,34 @@
     'version'  => null,
 ));
 $client->api('wiki')->remove('testProject', 'about');
+
+
+// ----------------------------
+// Issues' stats (see https://github.com/kbsali/php-redmine-api/issues/44)
+$issues['all'] = $client->api('issue')->all([
+    'limit'      => 1,
+    'tracker_id' => 1,
+    'status_id'  => '*',
+])['total_count'];
+
+$issues['opened'] = $client->api('issue')->all([
+    'limit'      => 1,
+    'tracker_id' => 1,
+    'status_id'  => 'open',
+])['total_count'];
+
+$issues['closed'] = $client->api('issue')->all([
+    'limit'      => 1,
+    'tracker_id' => 1,
+    'status_id'  => 'closed',
+])['total_count'];
+
+print_r($issues);
+/*
+Array
+(
+    [all] => 8
+    [opened] => 7
+    [closed] => 1
+)
+*/

lib/Redmine/Api/CustomField.php

@@ -0,0 +1,63 @@
+<?php
+
+namespace Redmine\Api;
+
+/**
+ * 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
+     * @link http://www.redmine.org/projects/redmine/wiki/Rest_CustomFields#GET
+     *
+     * @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())
+    {
+        $this->customFields = $this->retrieveAll('/custom_fields.json', $params);
+
+        return $this->customFields;
+    }
+
+    /**
+     * 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)
+     */
+    public function listing($forceUpdate = false)
+    {
+        if (empty($this->customFields)) {
+            $this->all();
+        }
+        $ret = array();
+        foreach ($this->customFields['custom_fields'] as $e) {
+            $ret[$e['name']] = (int) $e['id'];
+        }
+
+        return $ret;
+    }
+
+    /**
+     * Get a tracket id given its name
+     *
+     * @param  string|int $name customer field name
+     * @return int|false
+     */
+    public function getIdByName($name)
+    {
+        $arr = $this->listing();
+        if (!isset($arr[$name])) {
+            return false;
+        }
+
+        return $arr[(string) $name];
+    }
+}

lib/Redmine/Client.php

@@ -93,6 +93,9 @@ public function api($name)
                 case 'group':
                     $api = new Api\Group($this);
                     break;
+                case 'custom_fields':
+                    $api = new Api\CustomField($this);
+                    break;
                 case 'issue':
                     $api = new Api\Issue($this);
                     break;