Merge pull request #702 from mollie/feature/add-auto-pagination-helpe…

…r-methods Feature/add auto pagination helper methods
mollie · Nov 6, 2023 · 642f1b8 · 642f1b8
2 parents b2934d7 + 657fbad
commit 642f1b8
Show file tree

Hide file tree

Showing 28 changed files with 622 additions and 103 deletions.
diff --git a/src/Endpoints/BalanceEndpoint.php b/src/Endpoints/BalanceEndpoint.php
@@ -2,11 +2,11 @@
 
 namespace Mollie\Api\Endpoints;
 
-use Generator;
 use Mollie\Api\Exceptions\ApiException;
 use Mollie\Api\Resources\Balance;
 use Mollie\Api\Resources\BalanceCollection;
 use Mollie\Api\Resources\BaseCollection;
+use Mollie\Api\Resources\LazyCollection;
 
 class BalanceEndpoint extends CollectionEndpointAbstract
 {
@@ -89,9 +89,9 @@ public function page(?string $from = null, ?int $limit = null, array $parameters
      * @param array $parameters
      * @param bool $iterateBackwards Set to true for reverse order iteration (default is false).
      *
-     * @return Generator
+     * @return LazyCollection
      */
-    public function iterator(?string $from = null, ?int $limit = null, array $parameters = [], bool $iterateBackwards = false): Generator
+    public function iterator(?string $from = null, ?int $limit = null, array $parameters = [], bool $iterateBackwards = false): LazyCollection
     {
         return $this->rest_iterator($from, $limit, $parameters, $iterateBackwards);
     }

diff --git a/src/Endpoints/BalanceTransactionEndpoint.php b/src/Endpoints/BalanceTransactionEndpoint.php
@@ -4,10 +4,10 @@
 
 namespace Mollie\Api\Endpoints;
 
-use Generator;
 use Mollie\Api\Resources\Balance;
 use Mollie\Api\Resources\BalanceTransaction;
 use Mollie\Api\Resources\BalanceTransactionCollection;
+use Mollie\Api\Resources\LazyCollection;
 
 class BalanceTransactionEndpoint extends CollectionEndpointAbstract
 {
@@ -58,9 +58,9 @@ public function listFor(Balance $balance, array $parameters = [])
      * @param array $parameters
      * @param bool $iterateBackwards Set to true for reverse order iteration (default is false).
      *
-     * @return Generator
+     * @return LazyCollection
      */
-    public function iteratorFor(Balance $balance, array $parameters = [], bool $iterateBackwards = false): Generator
+    public function iteratorFor(Balance $balance, array $parameters = [], bool $iterateBackwards = false): LazyCollection
     {
         return $this->iteratorForId($balance->id, $parameters, $iterateBackwards);
     }
@@ -88,9 +88,9 @@ public function listForId(string $balanceId, array $parameters = [])
      * @param array $parameters
      * @param bool $iterateBackwards Set to true for reverse order iteration (default is false).
      *
-     * @return Generator
+     * @return LazyCollection
      */
-    public function iteratorForId(string $balanceId, array $parameters = [], bool $iterateBackwards = false): Generator
+    public function iteratorForId(string $balanceId, array $parameters = [], bool $iterateBackwards = false): LazyCollection
     {
         $this->parentId = $balanceId;
 
@@ -118,9 +118,9 @@ public function listForPrimary(array $parameters = [])
      * @param array $parameters
      * @param bool $iterateBackwards Set to true for reverse order iteration (default is false).
      *
-     * @return Generator
+     * @return LazyCollection
      */
-    public function iteratorForPrimary(array $parameters = [], bool $iterateBackwards = false): Generator
+    public function iteratorForPrimary(array $parameters = [], bool $iterateBackwards = false): LazyCollection
     {
         $this->parentId = "primary";
 

diff --git a/src/Endpoints/ChargebackEndpoint.php b/src/Endpoints/ChargebackEndpoint.php
@@ -2,10 +2,10 @@
 
 namespace Mollie\Api\Endpoints;
 
-use Generator;
 use Mollie\Api\Exceptions\ApiException;
 use Mollie\Api\Resources\Chargeback;
 use Mollie\Api\Resources\ChargebackCollection;
+use Mollie\Api\Resources\LazyCollection;
 
 class ChargebackEndpoint extends CollectionEndpointAbstract
 {
@@ -57,9 +57,9 @@ public function page(?string $from = null, ?int $limit = null, array $parameters
      * @param array $parameters
      * @param bool $iterateBackwards Set to true for reverse order iteration (default is false).
      *
-     * @return Generator
+     * @return LazyCollection
      */
-    public function iterator(?string $from = null, ?int $limit = null, array $parameters = [], bool $iterateBackwards = false): Generator
+    public function iterator(?string $from = null, ?int $limit = null, array $parameters = [], bool $iterateBackwards = false): LazyCollection
     {
         return $this->rest_iterator($from, $limit, $parameters, $iterateBackwards);
     }

diff --git a/src/Endpoints/ClientEndpoint.php b/src/Endpoints/ClientEndpoint.php
@@ -2,10 +2,10 @@
 
 namespace Mollie\Api\Endpoints;
 
-use Generator;
 use Mollie\Api\Exceptions\ApiException;
 use Mollie\Api\Resources\Client;
 use Mollie\Api\Resources\ClientCollection;
+use Mollie\Api\Resources\LazyCollection;
 
 class ClientEndpoint extends CollectionEndpointAbstract
 {
@@ -76,9 +76,9 @@ public function page(?string $from = null, ?int $limit = null, array $parameters
      * @param array $parameters
      * @param bool $iterateBackwards Set to true for reverse order iteration (default is false).
      *
-     * @return Generator
+     * @return LazyCollection
      */
-    public function iterator(?string $from = null, ?int $limit = null, array $parameters = [], bool $iterateBackwards = false): Generator
+    public function iterator(?string $from = null, ?int $limit = null, array $parameters = [], bool $iterateBackwards = false): LazyCollection
     {
         return $this->rest_iterator($from, $limit, $parameters, $iterateBackwards);
     }

diff --git a/src/Endpoints/CollectionEndpointAbstract.php b/src/Endpoints/CollectionEndpointAbstract.php
@@ -2,10 +2,10 @@
 
 namespace Mollie\Api\Endpoints;
 
-use Generator;
 use Mollie\Api\Exceptions\ApiException;
 use Mollie\Api\Resources\BaseCollection;
 use Mollie\Api\Resources\CursorCollection;
+use Mollie\Api\Resources\LazyCollection;
 use Mollie\Api\Resources\ResourceFactory;
 
 abstract class CollectionEndpointAbstract extends EndpointAbstract
@@ -49,9 +49,9 @@ protected function rest_list(?string $from = null, ?int $limit = null, array $fi
      * @param int $limit
      * @param array $filters
      * @param bool $iterateBackwards Set to true for reverse order iteration (default is false).
-     * @return Generator
+     * @return LazyCollection
      */
-    protected function rest_iterator(?string $from = null, ?int $limit = null, array $filters = [], bool $iterateBackwards = false): Generator
+    protected function rest_iterator(?string $from = null, ?int $limit = null, array $filters = [], bool $iterateBackwards = false): LazyCollection
     {
         /** @var CursorCollection $page */
         $page = $this->rest_list($from, $limit, $filters);

diff --git a/src/Endpoints/CustomerEndpoint.php b/src/Endpoints/CustomerEndpoint.php
@@ -2,10 +2,10 @@
 
 namespace Mollie\Api\Endpoints;
 
-use Generator;
 use Mollie\Api\Exceptions\ApiException;
 use Mollie\Api\Resources\Customer;
 use Mollie\Api\Resources\CustomerCollection;
+use Mollie\Api\Resources\LazyCollection;
 
 class CustomerEndpoint extends CollectionEndpointAbstract
 {
@@ -128,9 +128,9 @@ public function page(?string $from = null, ?int $limit = null, array $parameters
      * @param array $parameters
      * @param bool $iterateBackwards Set to true for reverse order iteration (default is false).
      *
-     * @return Generator
+     * @return LazyCollection
      */
-    public function iterator(?string $from = null, ?int $limit = null, array $parameters = [], bool $iterateBackwards = false): Generator
+    public function iterator(?string $from = null, ?int $limit = null, array $parameters = [], bool $iterateBackwards = false): LazyCollection
     {
         return $this->rest_iterator($from, $limit, $parameters, $iterateBackwards);
     }

diff --git a/src/Endpoints/CustomerPaymentsEndpoint.php b/src/Endpoints/CustomerPaymentsEndpoint.php
@@ -2,8 +2,8 @@
 
 namespace Mollie\Api\Endpoints;
 
-use Generator;
 use Mollie\Api\Resources\Customer;
+use Mollie\Api\Resources\LazyCollection;
 use Mollie\Api\Resources\Payment;
 use Mollie\Api\Resources\PaymentCollection;
 
@@ -89,9 +89,9 @@ public function listFor(Customer $customer, ?string $from = null, ?int $limit =
      * @param array $parameters
      * @param bool $iterateBackwards Set to true for reverse order iteration (default is false).
      *
-     * @return Generator
+     * @return LazyCollection
      */
-    public function iteratorFor(Customer $customer, ?string $from = null, ?int $limit = null, array $parameters = [], bool $iterateBackwards = false): Generator
+    public function iteratorFor(Customer $customer, ?string $from = null, ?int $limit = null, array $parameters = [], bool $iterateBackwards = false): LazyCollection
     {
         return $this->iteratorForId($customer->id, $from, $limit, $parameters, $iterateBackwards);
     }
@@ -121,9 +121,9 @@ public function listForId($customerId, ?string $from = null, ?int $limit = null,
      * @param array $parameters
      * @param bool $iterateBackwards Set to true for reverse order iteration (default is false).
      *
-     * @return Generator
+     * @return LazyCollection
      */
-    public function iteratorForId(string $customerId, ?string $from = null, ?int $limit = null, array $parameters = [], bool $iterateBackwards = false): Generator
+    public function iteratorForId(string $customerId, ?string $from = null, ?int $limit = null, array $parameters = [], bool $iterateBackwards = false): LazyCollection
     {
         $this->parentId = $customerId;
 

diff --git a/src/Endpoints/InvoiceEndpoint.php b/src/Endpoints/InvoiceEndpoint.php
@@ -2,10 +2,10 @@
 
 namespace Mollie\Api\Endpoints;
 
-use Generator;
 use Mollie\Api\Exceptions\ApiException;
 use Mollie\Api\Resources\Invoice;
 use Mollie\Api\Resources\InvoiceCollection;
+use Mollie\Api\Resources\LazyCollection;
 
 class InvoiceEndpoint extends CollectionEndpointAbstract
 {
@@ -86,9 +86,9 @@ public function all(array $parameters = [])
      * @param array $parameters
      * @param bool $iterateBackwards Set to true for reverse order iteration (default is false).
      *
-     * @return Generator
+     * @return LazyCollection
      */
-    public function iterator(?string $from = null, ?int $limit = null, array $parameters = [], bool $iterateBackwards = false): Generator
+    public function iterator(?string $from = null, ?int $limit = null, array $parameters = [], bool $iterateBackwards = false): LazyCollection
     {
         return $this->rest_iterator($from, $limit, $parameters, $iterateBackwards);
     }

diff --git a/src/Endpoints/MandateEndpoint.php b/src/Endpoints/MandateEndpoint.php
@@ -2,8 +2,8 @@
 
 namespace Mollie\Api\Endpoints;
 
-use Generator;
 use Mollie\Api\Resources\Customer;
+use Mollie\Api\Resources\LazyCollection;
 use Mollie\Api\Resources\Mandate;
 use Mollie\Api\Resources\MandateCollection;
 
@@ -113,9 +113,9 @@ public function listFor(Customer $customer, $from = null, $limit = null, array $
      * @param array $parameters
      * @param bool $iterateBackwards Set to true for reverse order iteration (default is false).
      *
-     * @return Generator
+     * @return LazyCollection
      */
-    public function iteratorFor(Customer $customer, ?string $from = null, ?int $limit = null, array $parameters = [], bool $iterateBackwards = false): Generator
+    public function iteratorFor(Customer $customer, ?string $from = null, ?int $limit = null, array $parameters = [], bool $iterateBackwards = false): LazyCollection
     {
         return $this->iteratorForId($customer->id, $from, $limit, $parameters, $iterateBackwards);
     }
@@ -145,9 +145,9 @@ public function listForId($customerId, $from = null, $limit = null, array $param
      * @param array $parameters
      * @param bool $iterateBackwards Set to true for reverse order iteration (default is false).
      *
-     * @return Generator
+     * @return LazyCollection
      */
-    public function iteratorForId(string $customerId, ?string $from = null, ?int $limit = null, array $parameters = [], bool $iterateBackwards = false): Generator
+    public function iteratorForId(string $customerId, ?string $from = null, ?int $limit = null, array $parameters = [], bool $iterateBackwards = false): LazyCollection
     {
         $this->parentId = $customerId;
 

diff --git a/src/Endpoints/OrderEndpoint.php b/src/Endpoints/OrderEndpoint.php
@@ -2,8 +2,8 @@
 
 namespace Mollie\Api\Endpoints;
 
-use Generator;
 use Mollie\Api\Exceptions\ApiException;
+use Mollie\Api\Resources\LazyCollection;
 use Mollie\Api\Resources\Order;
 use Mollie\Api\Resources\OrderCollection;
 
@@ -137,9 +137,9 @@ public function page(?string $from = null, ?int $limit = null, array $parameters
      * @param array $parameters
      * @param bool $iterateBackwards Set to true for reverse order iteration (default is false).
      *
-     * @return Generator
+     * @return LazyCollection
      */
-    public function iterator(?string $from = null, ?int $limit = null, array $parameters = [], bool $iterateBackwards = false): Generator
+    public function iterator(?string $from = null, ?int $limit = null, array $parameters = [], bool $iterateBackwards = false): LazyCollection
     {
         return $this->rest_iterator($from, $limit, $parameters, $iterateBackwards);
     }

diff --git a/src/Endpoints/PaymentCaptureEndpoint.php b/src/Endpoints/PaymentCaptureEndpoint.php
@@ -2,9 +2,9 @@
 
 namespace Mollie\Api\Endpoints;
 
-use Generator;
 use Mollie\Api\Resources\Capture;
 use Mollie\Api\Resources\CaptureCollection;
+use Mollie\Api\Resources\LazyCollection;
 use Mollie\Api\Resources\Payment;
 
 class PaymentCaptureEndpoint extends CollectionEndpointAbstract
@@ -115,9 +115,9 @@ public function listFor(Payment $payment, array $parameters = [])
      * @param array $parameters
      * @param bool $iterateBackwards Set to true for reverse order iteration (default is false).
      *
-     * @return Generator
+     * @return LazyCollection
      */
-    public function iteratorFor(Payment $payment, ?string $from = null, ?int $limit = null, array $parameters = [], bool $iterateBackwards = false): Generator
+    public function iteratorFor(Payment $payment, ?string $from = null, ?int $limit = null, array $parameters = [], bool $iterateBackwards = false): LazyCollection
     {
         return $this->iteratorForId($payment->id, $from, $limit, $parameters, $iterateBackwards);
     }
@@ -145,9 +145,9 @@ public function listForId($paymentId, array $parameters = [])
      * @param array $parameters
      * @param bool $iterateBackwards Set to true for reverse order iteration (default is false).
      *
-     * @return Generator
+     * @return LazyCollection
      */
-    public function iteratorForId(string $paymentId, ?string $from = null, ?int $limit = null, array $parameters = [], bool $iterateBackwards = false): Generator
+    public function iteratorForId(string $paymentId, ?string $from = null, ?int $limit = null, array $parameters = [], bool $iterateBackwards = false): LazyCollection
     {
         $this->parentId = $paymentId;
 

diff --git a/src/Endpoints/PaymentChargebackEndpoint.php b/src/Endpoints/PaymentChargebackEndpoint.php
@@ -2,9 +2,9 @@
 
 namespace Mollie\Api\Endpoints;
 
-use Generator;
 use Mollie\Api\Resources\Chargeback;
 use Mollie\Api\Resources\ChargebackCollection;
+use Mollie\Api\Resources\LazyCollection;
 use Mollie\Api\Resources\Payment;
 
 class PaymentChargebackEndpoint extends CollectionEndpointAbstract
@@ -83,9 +83,9 @@ public function listFor(Payment $payment, array $parameters = [])
      * @param array $parameters
      * @param bool $iterateBackwards Set to true for reverse order iteration (default is false).
      *
-     * @return Generator
+     * @return LazyCollection
      */
-    public function iteratorFor(Payment $payment, ?string $from = null, ?int $limit = null, array $parameters = [], bool $iterateBackwards = false): Generator
+    public function iteratorFor(Payment $payment, ?string $from = null, ?int $limit = null, array $parameters = [], bool $iterateBackwards = false): LazyCollection
     {
         return $this->iteratorForId($payment->id, $from, $limit, $parameters, $iterateBackwards);
     }
@@ -113,9 +113,9 @@ public function listForId($paymentId, array $parameters = [])
      * @param array $parameters
      * @param bool $iterateBackwards Set to true for reverse order iteration (default is false).
      *
-     * @return Generator
+     * @return LazyCollection
      */
-    public function iteratorForId(string $paymentId, ?string $from = null, ?int $limit = null, array $parameters = [], bool $iterateBackwards = false): Generator
+    public function iteratorForId(string $paymentId, ?string $from = null, ?int $limit = null, array $parameters = [], bool $iterateBackwards = false): LazyCollection
     {
         $this->parentId = $paymentId;
 

diff --git a/src/Endpoints/PaymentEndpoint.php b/src/Endpoints/PaymentEndpoint.php
@@ -2,8 +2,8 @@
 
 namespace Mollie\Api\Endpoints;
 
-use Generator;
 use Mollie\Api\Exceptions\ApiException;
+use Mollie\Api\Resources\LazyCollection;
 use Mollie\Api\Resources\Payment;
 use Mollie\Api\Resources\PaymentCollection;
 use Mollie\Api\Resources\Refund;
@@ -149,9 +149,9 @@ public function page($from = null, $limit = null, array $parameters = [])
      * @param array $parameters
      * @param bool $iterateBackwards Set to true for reverse order iteration (default is false).
      *
-     * @return Generator
+     * @return LazyCollection
      */
-    public function iterator(?string $from = null, ?int $limit = null, array $parameters = [], bool $iterateBackwards = false): Generator
+    public function iterator(?string $from = null, ?int $limit = null, array $parameters = [], bool $iterateBackwards = false): LazyCollection
     {
         return $this->rest_iterator($from, $limit, $parameters, $iterateBackwards);
     }

diff --git a/src/Endpoints/PaymentLinkEndpoint.php b/src/Endpoints/PaymentLinkEndpoint.php
@@ -2,8 +2,8 @@
 
 namespace Mollie\Api\Endpoints;
 
-use Generator;
 use Mollie\Api\Exceptions\ApiException;
+use Mollie\Api\Resources\LazyCollection;
 use Mollie\Api\Resources\Payment;
 use Mollie\Api\Resources\PaymentLink;
 use Mollie\Api\Resources\PaymentLinkCollection;
@@ -94,9 +94,9 @@ public function page($from = null, $limit = null, array $parameters = [])
      * @param array $parameters
      * @param bool $iterateBackwards Set to true for reverse order iteration (default is false).
      *
-     * @return Generator
+     * @return LazyCollection
      */
-    public function iterator(?string $from = null, ?int $limit = null, array $parameters = [], bool $iterateBackwards = false): Generator
+    public function iterator(?string $from = null, ?int $limit = null, array $parameters = [], bool $iterateBackwards = false): LazyCollection
     {
         return $this->rest_iterator($from, $limit, $parameters, $iterateBackwards);
     }