Ordered and documented dynamic getters

Author: GrahamCampbell

lib/Gitlab/Client.php

@@ -20,25 +20,37 @@
  *
  * @author Matt Humphrey <[email protected]>
  *
+ * @property-read \Gitlab\Api\DeployKeys $deploy_keys
+ * @property-read \Gitlab\Api\Deployments $deployments
+ * @property-read \Gitlab\Api\Environments $environments
  * @property-read \Gitlab\Api\Groups $groups
+ * @property-read \Gitlab\Api\GroupsBoards $groups_boards
+ * @property-read \Gitlab\Api\GroupsMilestones $groups_milestones
+ * @property-read \Gitlab\Api\IssueBoards $board
+ * @property-read \Gitlab\Api\IssueBoards $issue_boards
+ * @property-read \Gitlab\Api\IssueLinks $issue_links
  * @property-read \Gitlab\Api\Issues $issues
+ * @property-read \Gitlab\Api\IssuesStatistics $issues_statistics
  * @property-read \Gitlab\Api\Jobs $jobs
+ * @property-read \Gitlab\Api\Keys $keys
  * @property-read \Gitlab\Api\MergeRequests $merge_requests
  * @property-read \Gitlab\Api\MergeRequests $mr
  * @property-read \Gitlab\Api\Milestones $milestones
  * @property-read \Gitlab\Api\Milestones $ms
  * @property-read \Gitlab\Api\ProjectNamespaces $namespaces
  * @property-read \Gitlab\Api\ProjectNamespaces $ns
  * @property-read \Gitlab\Api\Projects $projects
- * @property-read \Gitlab\Api\Repositories $repositories
  * @property-read \Gitlab\Api\Repositories $repo
+ * @property-read \Gitlab\Api\Repositories $repositories
+ * @property-read \Gitlab\Api\RepositoryFiles $repositoryFiles
+ * @property-read \Gitlab\Api\Schedules $schedules
  * @property-read \Gitlab\Api\Snippets $snippets
  * @property-read \Gitlab\Api\SystemHooks $hooks
  * @property-read \Gitlab\Api\SystemHooks $system_hooks
  * @property-read \Gitlab\Api\Users $users
- * @property-read \Gitlab\Api\Keys $keys
  * @property-read \Gitlab\Api\Tags $tags
  * @property-read \Gitlab\Api\Version $version
+ * @property-read \Gitlab\Api\Wiki $wiki
  */
 class Client
 {
@@ -128,6 +140,22 @@ public function deployKeys()
         return new Api\DeployKeys($this);
     }
 
+    /**
+     * @return Api\Deployments
+     */
+    public function deployments()
+    {
+        return new Api\Deployments($this);
+    }
+
+    /**
+     * @return Api\Environments
+     */
+    public function environments()
+    {
+        return new Api\Environments($this);
+    }
+
     /**
      * @return Api\Groups
      */
@@ -137,19 +165,19 @@ public function groups()
     }
 
     /**
-     * @return Api\GroupsMilestones
+     * @return Api\GroupsBoards
      */
-    public function groupsMilestones()
+    public function groupsBoards()
     {
-        return new Api\GroupsMilestones($this);
+        return new Api\GroupsBoards($this);
     }
 
     /**
-     * @return Api\Issues
+     * @return Api\GroupsMilestones
      */
-    public function issues()
+    public function groupsMilestones()
     {
-        return new Api\Issues($this);
+        return new Api\GroupsMilestones($this);
     }
 
     /**
@@ -161,20 +189,27 @@ public function issueBoards()
     }
 
     /**
-     * @return Api\GroupsBoards
+     * @return Api\IssueLinks
      */
-    public function groupsBoards()
+    public function issueLinks()
     {
-        return new Api\GroupsBoards($this);
+        return new Api\IssueLinks($this);
     }
 
+    /**
+     * @return Api\Issues
+     */
+    public function issues()
+    {
+        return new Api\Issues($this);
+    }
 
     /**
-     * @return Api\IssueLinks
+     * @return Api\IssuesStatistics
      */
-    public function issueLinks()
+    public function issuesStatistics()
     {
-        return new Api\IssueLinks($this);
+        return new Api\IssuesStatistics($this);
     }
 
     /**
@@ -185,6 +220,14 @@ public function jobs()
         return new Api\Jobs($this);
     }
 
+    /**
+     * @return Api\Keys
+     */
+    public function keys()
+    {
+        return new Api\Keys($this);
+    }
+
     /**
      * @return Api\MergeRequests
      */
@@ -233,6 +276,14 @@ public function repositoryFiles()
         return new Api\RepositoryFiles($this);
     }
 
+    /**
+     * @return Api\Schedules
+     */
+    public function schedules()
+    {
+        return new Api\Schedules($this);
+    }
+
     /**
      * @return Api\Snippets
      */
@@ -257,14 +308,6 @@ public function users()
         return new Api\Users($this);
     }
 
-    /**
-     * @return Api\Keys
-     */
-    public function keys()
-    {
-        return new Api\Keys($this);
-    }
-
     /**
      * @return Api\Tags
      */
@@ -281,30 +324,6 @@ public function version()
         return new Api\Version($this);
     }
 
-    /**
-     * @return Api\Deployments
-     */
-    public function deployments()
-    {
-        return new Api\Deployments($this);
-    }
-
-    /**
-     * @return Api\Environments
-     */
-    public function environments()
-    {
-        return new Api\Environments($this);
-    }
-
-    /**
-     * @return Api\Schedules
-     */
-    public function schedules()
-    {
-        return new Api\Schedules($this);
-    }
-
     /**
      * @return Api\Wiki
      */
@@ -313,14 +332,6 @@ public function wiki()
         return new Api\Wiki($this);
     }
 
-    /**
-     * @return Api\IssuesStatistics
-     */
-    public function issuesStatistics()
-    {
-        return new Api\IssuesStatistics($this);
-    }
-
     /**
      * @param string $name
      *
@@ -334,30 +345,42 @@ public function api($name)
             case 'deploy_keys':
                 return $this->deployKeys();
 
+            case 'deployments':
+                return $this->deployments();
+
+            case 'environments':
+                return $this->environments();
+
             case 'groups':
                 return $this->groups();
-                
-            case 'groupsMilestones':
-                return $this->groupsMilestones();
 
-            case 'issues':
-                return $this->issues();
+            case 'groups_boards':
+                return $this->groupsBoards();
+
+            case 'groups_milestones':
+                return $this->groupsMilestones();
 
             case 'board':
             case 'issue_boards':
                 return $this->issueBoards();
 
-            case 'group_boards':
-                return $this->groupsBoards();
-
             case 'issue_links':
                 return $this->issueLinks();
 
+            case 'issues':
+                return $this->issues();
+
+            case 'issues_statistics':
+                return $this->issuesStatistics();
+
             case 'jobs':
                 return $this->jobs();
 
-            case 'mr':
+            case 'keys':
+                return $this->keys();
+
             case 'merge_requests':
+            case 'mr':
                 return $this->mergeRequests();
 
             case 'milestones':
@@ -377,7 +400,10 @@ public function api($name)
 
             case 'repositoryFiles':
                 return $this->repositoryFiles();
-                
+
+            case 'schedules':
+                return $this->schedules();
+
             case 'snippets':
                 return $this->snippets();
 
@@ -388,30 +414,15 @@ public function api($name)
             case 'users':
                 return $this->users();
 
-            case 'keys':
-                return $this->keys();
-
             case 'tags':
                 return $this->tags();
 
             case 'version':
                 return $this->version();
 
-            case 'environments':
-                return $this->environments();
-
-            case 'deployments':
-                return $this->deployments();
-
-            case 'schedules':
-                return $this->schedules();
-
             case 'wiki':
                 return $this->wiki();
 
-            case 'issues_statistics':
-                return $this->issuesStatistics();
-
             default:
                 throw new InvalidArgumentException('Invalid endpoint: "'.$name.'"');
         }