Re-worked pagination

Author: GrahamCampbell

CHANGELOG.md

@@ -6,6 +6,7 @@ CHANGE LOG
 
 * Dropped support for PHP 7.1
 * Made builder class final
+* Re-worked pagination
 
 
 ## V3.3 (27/11/2020)

phpstan-baseline.neon

@@ -1,7 +1,7 @@
 parameters:
 	ignoreErrors:
 		-
-			message: "#^Variable method call on Bitbucket\\\\Api\\\\ApiInterface\\.$#"
+			message: "#^Variable method call on Bitbucket\\\\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

@@ -17,13 +17,12 @@
 use Bitbucket\HttpClient\Message\ResponseMediator;
 use Bitbucket\HttpClient\Util\JsonArray;
 use Bitbucket\HttpClient\Util\QueryStringBuilder;
-use ValueError;
 
 /**
  * @author Joseph Bielawski <[email protected]>
  * @author Graham Campbell <[email protected]>
  */
-abstract class AbstractApi implements ApiInterface
+abstract class AbstractApi
 {
     /**
      * The URI prefix.
@@ -49,19 +48,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;
     }
 
     /**
@@ -74,38 +67,6 @@ protected function getClient()
         return $this->client;
     }
 
-    /**
-     * Get the number of values to fetch per page.
-     *
-     * @return int|null
-     */
-    protected function getPerPage()
-    {
-        return $this->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 = null)
-    {
-        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;
-    }
-
     /**
      * Send a GET request with query params and return the raw response.
      *

src/Api/Addon.php

@@ -57,15 +57,15 @@ public function remove(array $params = [])
      */
     public function linkers()
     {
-        return new Linkers($this->getClient(), $this->getPerPage());
+        return new Linkers($this->getClient());
     }
 
     /**
      * @return \Bitbucket\Api\Addon\Users
      */
     public function users()
     {
-        return new UsersAddon($this->getClient(), $this->getPerPage());
+        return new UsersAddon($this->getClient());
     }
 
     /**

src/Api/Addon/Linkers.php

@@ -59,7 +59,7 @@ public function show(string $linker, array $params = [])
      */
     public function values(string $linker)
     {
-        return new Values($this->getClient(), $linker, $this->getPerPage());
+        return new Values($this->getClient(), $linker);
     }
 
     /**

src/Api/Addon/Linkers/AbstractLinkersApi.php

@@ -35,13 +35,12 @@ abstract class AbstractLinkersApi extends AbstractAddonApi
      *
      * @param Client   $client
      * @param string   $linker
-     * @param int|null $perPage
      *
      * @return void
      */
-    public function __construct(Client $client, string $linker, int $perPage = null)
+    public function __construct(Client $client, string $linker)
     {
-        parent::__construct($client, $perPage);
+        parent::__construct($client);
         $this->linker = $linker;
     }
 }

src/Api/Addon/Users.php

@@ -29,6 +29,6 @@ class Users extends AbstractAddonApi
      */
     public function events(string $username)
     {
-        return new Events($this->getClient(), $username, $this->getPerPage());
+        return new Events($this->getClient(), $username);
     }
 }

src/Api/Addon/Users/AbstractUsersApi.php

@@ -35,13 +35,12 @@ abstract class AbstractUsersApi extends AbstractAddonApi
      *
      * @param Client   $client
      * @param string   $username
-     * @param int|null $perPage
      *
      * @return void
      */
-    public function __construct(Client $client, string $username, int $perPage = null)
+    public function __construct(Client $client, string $username)
     {
-        parent::__construct($client, $perPage);
+        parent::__construct($client);
         $this->username = $username;
     }
 }