Re-worked pagination

Author: GrahamCampbell

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Dropped support for PHP 7.1
 * Updated to latest labels API
 * Made builder class final
+* Re-worked pagination
 
 [11.0.0-RC1]: https://github.com/GitLabPHP/Client/compare/10.4.0...11.0.0-RC1
 

phpstan-baseline.neon

@@ -6,7 +6,7 @@ parameters:
 			path: src/Api/AbstractApi.php
 
 		-
-			message: "#^Variable method call on Gitlab\\\\Api\\\\ApiInterface\\.$#"
+			message: "#^Variable method call on Gitlab\\\\Api\\\\AbstractApi\\.$#"
 			count: 1
 			path: src/ResultPager.php
 

psalm-baseline.xml

@@ -8,4 +8,12 @@
       <code>\get_debug_type($data)</code>
     </UndefinedFunction>
   </file>
+  <file src="src/ResultPager.php">
+    <InaccessibleProperty occurrences="1">
+      <code>$clone-&gt;perPage</code>
+    </InaccessibleProperty>
+    <PossiblyInvalidFunctionCall occurrences="1">
+      <code>$closure($api)</code>
+    </PossiblyInvalidFunctionCall>
+  </file>
 </files>

src/Api/AbstractApi.php

@@ -22,14 +22,13 @@
 use Http\Message\MultipartStream\MultipartStreamBuilder;
 use Psr\Http\Message\StreamInterface;
 use Symfony\Component\OptionsResolver\OptionsResolver;
-use ValueError;
 
 /**
  * @author Joseph Bielawski <[email protected]>
  * @author Matt Humphrey <[email protected]>
  * @author Radu Topala <[email protected]>
  */
-abstract class AbstractApi implements ApiInterface
+abstract class AbstractApi
 {
     /**
      * The URI prefix.
@@ -55,41 +54,13 @@ abstract class AbstractApi implements ApiInterface
     /**
      * Create a new API instance.
      *
-     * @param Client   $client
-     * @param int|null $perPage
+     * @param Client $client
      *
      * @return void
      */
-    public function __construct(Client $client, int $perPage = null)
+    public function __construct(Client $client)
     {
-        if (null !== $perPage && ($perPage < 1 || $perPage > 100)) {
-            throw new ValueError(\sprintf('%s::__construct(): Argument #2 ($perPage) must be between 1 and 100, or null', self::class));
-        }
-
         $this->client = $client;
-        $this->perPage = $perPage;
-    }
-
-    /**
-     * Create a new instance with the given page parameter.
-     *
-     * This must be an integer between 1 and 100.
-     *
-     * @param int|null $perPage
-     *
-     * @return static
-     */
-    public function perPage(?int $perPage)
-    {
-        if (null !== $perPage && ($perPage < 1 || $perPage > 100)) {
-            throw new ValueError(\sprintf('%s::perPage(): Argument #1 ($perPage) must be between 1 and 100, or null', self::class));
-        }
-
-        $copy = clone $this;
-
-        $copy->perPage = $perPage;
-
-        return $copy;
     }
 
     /**

src/Api/ApiInterface.php

@@ -14,7 +14,8 @@
 
 namespace Gitlab;
 
-use Gitlab\Api\ApiInterface;
+use Closure;
+use Gitlab\Api\AbstractApi;
 use Gitlab\Exception\RuntimeException;
 use Gitlab\HttpClient\Message\ResponseMediator;
 use ValueError;
@@ -78,17 +79,17 @@ public function __construct(Client $client, int $perPage = null)
     /**
      * Fetch a single result from an api call.
      *
-     * @param ApiInterface $api
-     * @param string       $method
-     * @param array        $parameters
+     * @param AbstractApi $api
+     * @param string      $method
+     * @param array       $parameters
      *
      * @throws \Http\Client\Exception
      *
      * @return array
      */
-    public function fetch(ApiInterface $api, string $method, array $parameters = [])
+    public function fetch(AbstractApi $api, string $method, array $parameters = [])
     {
-        $result = $api->perPage($this->perPage)->$method(...$parameters);
+        $result = self::bindPerPage($api, $this->perPage)->$method(...$parameters);
 
         if (!\is_array($result)) {
             throw new RuntimeException('Pagination of this endpoint is not supported.');
@@ -102,31 +103,31 @@ public function fetch(ApiInterface $api, string $method, array $parameters = [])
     /**
      * Fetch all results from an api call.
      *
-     * @param ApiInterface $api
-     * @param string       $method
-     * @param array        $parameters
+     * @param AbstractApi $api
+     * @param string      $method
+     * @param array       $parameters
      *
      * @throws \Http\Client\Exception
      *
      * @return array
      */
-    public function fetchAll(ApiInterface $api, string $method, array $parameters = [])
+    public function fetchAll(AbstractApi $api, string $method, array $parameters = [])
     {
         return \iterator_to_array($this->fetchAllLazy($api, $method, $parameters));
     }
 
     /**
      * Lazily fetch all results from an api call.
      *
-     * @param ApiInterface $api
-     * @param string       $method
-     * @param array        $parameters
+     * @param AbstractApi $api
+     * @param string      $method
+     * @param array       $parameters
      *
      * @throws \Http\Client\Exception
      *
      * @return \Generator
      */
-    public function fetchAllLazy(ApiInterface $api, string $method, array $parameters = [])
+    public function fetchAllLazy(AbstractApi $api, string $method, array $parameters = [])
     {
         /** @var mixed $value */
         foreach ($this->fetch($api, $method, $parameters) as $value) {
@@ -248,4 +249,24 @@ private function get(string $key)
 
         return $content;
     }
+
+    /**
+     * @param \Gitlab\Api\AbstractApi $api
+     * @param int                     $perPage
+     *
+     * @return \Gitlab\Api\AbstractApi
+     */
+    private static function bindPerPage(AbstractApi $api, int $perPage)
+    {
+        $closure = Closure::bind(static function (AbstractApi $api) use ($perPage): AbstractApi {
+            $clone = clone $api;
+
+            $clone->perPage = $perPage;
+
+            return $clone;
+        }, null, AbstractApi::class);
+
+        /** @var AbstractApi */
+        return $closure($api);
+    }
 }

src/ResultPager.php

@@ -14,7 +14,7 @@
 
 namespace Gitlab;
 
-use Gitlab\Api\ApiInterface;
+use Gitlab\Api\AbstractApi;
 
 /**
  * This is the result pager interface.
@@ -28,41 +28,41 @@ interface ResultPagerInterface
     /**
      * Fetch a single result from an api call.
      *
-     * @param ApiInterface $api
-     * @param string       $method
-     * @param array        $parameters
+     * @param AbstractApi $api
+     * @param string      $method
+     * @param array       $parameters
      *
      * @throws \Http\Client\Exception
      *
      * @return array
      */
-    public function fetch(ApiInterface $api, string $method, array $parameters = []);
+    public function fetch(AbstractApi $api, string $method, array $parameters = []);
 
     /**
      * Fetch all results from an api call.
      *
-     * @param ApiInterface $api
-     * @param string       $method
-     * @param array        $parameters
+     * @param AbstractApi $api
+     * @param string      $method
+     * @param array       $parameters
      *
      * @throws \Http\Client\Exception
      *
      * @return array
      */
-    public function fetchAll(ApiInterface $api, string $method, array $parameters = []);
+    public function fetchAll(AbstractApi $api, string $method, array $parameters = []);
 
     /**
      * Lazily fetch all results from an api call.
      *
-     * @param ApiInterface $api
-     * @param string       $method
-     * @param array        $parameters
+     * @param AbstractApi $api
+     * @param string      $method
+     * @param array       $parameters
      *
      * @throws \Http\Client\Exception
      *
      * @return \Generator
      */
-    public function fetchAllLazy(ApiInterface $api, string $method, array $parameters = []);
+    public function fetchAllLazy(AbstractApi $api, string $method, array $parameters = []);
 
     /**
      * Check to determine the availability of a next page.