Added pagination to project events. Fixes GitLabPHP#84

Author: Matt Humphrey

lib/Gitlab/Api/Projects.php

@@ -1,7 +1,5 @@
 <?php namespace Gitlab\Api;
 
-use Gitlab\Exception\RuntimeException;
-
 class Projects extends AbstractApi
 {
     const ORDER_BY = 'created_at';
@@ -10,6 +8,8 @@ class Projects extends AbstractApi
     /**
      * @param int $page
      * @param int $per_page
+     * @param string $order_by
+     * @param string $sort
      * @return mixed
      */
     public function all($page = 1, $per_page = self::PER_PAGE, $order_by = self::ORDER_BY, $sort = self::SORT)
@@ -25,6 +25,8 @@ public function all($page = 1, $per_page = self::PER_PAGE, $order_by = self::ORD
     /**
      * @param int $page
      * @param int $per_page
+     * @param string $order_by
+     * @param string $sort
      * @return mixed
      */
     public function accessible($page = 1, $per_page = self::PER_PAGE, $order_by = self::ORDER_BY, $sort = self::SORT)
@@ -40,6 +42,8 @@ public function accessible($page = 1, $per_page = self::PER_PAGE, $order_by = se
     /**
      * @param int $page
      * @param int $per_page
+     * @param string $order_by
+     * @param string $sort
      * @return mixed
      */
     public function owned($page = 1, $per_page = self::PER_PAGE, $order_by = self::ORDER_BY, $sort = self::SORT)
@@ -56,6 +60,8 @@ public function owned($page = 1, $per_page = self::PER_PAGE, $order_by = self::O
      * @param string $query
      * @param int $page
      * @param int $per_page
+     * @param string $order_by
+     * @param string $sort
      * @return mixed
      */
     public function search($query, $page = 1, $per_page = self::PER_PAGE, $order_by = self::ORDER_BY, $sort = self::SORT)
@@ -287,11 +293,16 @@ public function removeKey($project_id, $key_id)
 
     /**
      * @param int $project_id
+     * @param int $page
+     * @param int $per_page
      * @return mixed
      */
-    public function events($project_id)
+    public function events($project_id, $page = 1, $per_page = self::PER_PAGE)
     {
-        return $this->get($this->getProjectPath($project_id, 'events'));
+        return $this->get($this->getProjectPath($project_id, 'events'), array(
+            'page' => $page,
+            'per_page' => $per_page
+        ));
     }
 
     /**

lib/Gitlab/Model/Project.php

@@ -549,11 +549,13 @@ public function deleteFile($file_path, $branch_name, $commit_message)
     }
 
     /**
+     * @param int $page
+     * @param int $per_page
      * @return Event[]
      */
-    public function events()
+    public function events($page = 1, $per_page = Api::PER_PAGE)
     {
-        $data = $this->api('projects')->events($this->id);
+        $data = $this->api('projects')->events($this->id, $page, $per_page);
 
         $events = array();
         foreach ($data as $event) {

test/Gitlab/Tests/Api/ProjectsTest.php

@@ -487,13 +487,39 @@ public function shouldGetEvents()
         $api = $this->getApiMock();
         $api->expects($this->once())
             ->method('get')
-            ->with('projects/1/events')
+            ->with('projects/1/events', array(
+                'page' => 1,
+                'per_page' => AbstractApi::PER_PAGE
+            ))
             ->will($this->returnValue($expectedArray))
         ;
 
         $this->assertEquals($expectedArray, $api->events(1));
     }
 
+    /**
+     * @test
+     */
+    public function shouldGetEventsWithPagination()
+    {
+        $expectedArray = array(
+            array('id' => 1, 'title' => 'An event'),
+            array('id' => 2, 'title' => 'Another event')
+        );
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('get')
+            ->with('projects/1/events', array(
+                'page' => 2,
+                'per_page' => 15
+            ))
+            ->will($this->returnValue($expectedArray))
+        ;
+
+        $this->assertEquals($expectedArray, $api->events(1, 2, 15));
+    }
+
     /**
      * @test
      */