From 2f66acb80857ac89e56557903c0309fc87cfb46a Mon Sep 17 00:00:00 2001
From: lyy <linyiyongcn@163.com>
Date: Tue, 30 Mar 2021 18:18:48 +0800
Subject: [PATCH 1/2] add  AbstractService method: getResponsePaginationLinks

---
 src/Service/AbstractService.php | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/src/Service/AbstractService.php b/src/Service/AbstractService.php
index 6efe4e5..a3bd947 100644
--- a/src/Service/AbstractService.php
+++ b/src/Service/AbstractService.php
@@ -106,4 +106,21 @@ function ($object) use ($className) {
             }, $data
         );
     }
+
+    /** [fetch links(next|previous) from Shopify Link headers]
+     *  supported only in api version 2019-07 of the API and above
+     * @return array
+     */
+    public function getResponsePaginationLinks(): array
+    {
+        $links = ['next' => '', 'previous' => ''];
+        if ($linkHeader = $this->getLastResponse()->getHeaderLine('Link')) {
+            foreach (explode(',', $linkHeader) as $item) {
+                if (preg_match('/<([\s\S]+?)>; rel=\"(next|previous)\"/', $item, $match)) {
+                    $links[$match[2]] = $match[1];
+                }
+            }
+        }
+        return $links;
+    }
 }

From 4a24e2d70f6392184362cca3c68607eb7f151d85 Mon Sep 17 00:00:00 2001
From: lyy <linyiyongcn@163.com>
Date: Tue, 30 Mar 2021 22:43:29 +0800
Subject: [PATCH 2/2] pagination link object && unit test

---
 src/Object/PaginationLink.php       | 23 ++++++++++++++++
 src/Service/AbstractService.php     | 17 ++++--------
 test/Service/PaginationLinkTest.php | 41 +++++++++++++++++++++++++++++
 test/TestCase.php                   |  4 +--
 4 files changed, 71 insertions(+), 14 deletions(-)
 create mode 100644 src/Object/PaginationLink.php
 create mode 100644 test/Service/PaginationLinkTest.php

diff --git a/src/Object/PaginationLink.php b/src/Object/PaginationLink.php
new file mode 100644
index 0000000..00c569a
--- /dev/null
+++ b/src/Object/PaginationLink.php
@@ -0,0 +1,23 @@
+<?php
+
+namespace Shopify\Object;
+
+class PaginationLink
+{
+    public $previous;
+
+    public $next;
+
+    public function __construct(string $linkHeader)
+    {
+        if (empty($linkHeader)) {
+            return;
+        }
+
+        foreach (explode(',', $linkHeader) as $item) {
+            if (preg_match('/<([\s\S]+?)>; rel=\"(next|previous)\"/', $item, $match)) {
+                $this->{$match[2]} = $match[1];
+            }
+        }
+    }
+}
diff --git a/src/Service/AbstractService.php b/src/Service/AbstractService.php
index a3bd947..2550e77 100644
--- a/src/Service/AbstractService.php
+++ b/src/Service/AbstractService.php
@@ -6,6 +6,7 @@
 use GuzzleHttp\Psr7\Request;
 use GuzzleHttp\Psr7\Response;
 use Shopify\ApiInterface;
+use Shopify\Object\PaginationLink;
 
 abstract class AbstractService
 {
@@ -107,20 +108,12 @@ function ($object) use ($className) {
         );
     }
 
-    /** [fetch links(next|previous) from Shopify Link headers]
+    /** [fetch pagination link from Shopify Link headers]
      *  supported only in api version 2019-07 of the API and above
-     * @return array
+     * @return PaginationLink
      */
-    public function getResponsePaginationLinks(): array
+    public function getPaginationLink(): PaginationLink
     {
-        $links = ['next' => '', 'previous' => ''];
-        if ($linkHeader = $this->getLastResponse()->getHeaderLine('Link')) {
-            foreach (explode(',', $linkHeader) as $item) {
-                if (preg_match('/<([\s\S]+?)>; rel=\"(next|previous)\"/', $item, $match)) {
-                    $links[$match[2]] = $match[1];
-                }
-            }
-        }
-        return $links;
+        return new PaginationLink($this->getLastResponse()->getHeaderLine('Link'));
     }
 }
diff --git a/test/Service/PaginationLinkTest.php b/test/Service/PaginationLinkTest.php
new file mode 100644
index 0000000..5c1821d
--- /dev/null
+++ b/test/Service/PaginationLinkTest.php
@@ -0,0 +1,41 @@
+<?php
+
+namespace Shopify\Test\Service;
+
+use Shopify\Object\PaginationLink;
+use Shopify\Service\CustomerService;
+use Shopify\Test\TestCase;
+
+class PaginationLinkTest extends TestCase
+{
+    public function testGetPaginationLink()
+    {
+        $previous = 'https://demo.myshopify.com/admin/api/2021-01/customers.json?limit=5&page_info=xyzprevious';
+        $next = 'https://demo.myshopify.com/admin/api/2021-01/customers.json?limit=5&page_info=xyznext';
+
+        // test previous && next
+        $api = $this->getApiMock(
+            ['customers' => ['unit test']],
+            ['Link' => '<' . $previous . '>; rel="previous", <' . $next . '>; rel="next"']
+        );
+
+        $service = new CustomerService($api);
+        $service->all();
+        $res = $service->getPaginationLink();
+        $this->assertInstanceOf(PaginationLink::class, $res);
+        $this->assertTrue($res->next == $next);
+        $this->assertTrue($res->previous == $previous);
+
+        // test only next
+        $api = $this->getApiMock(
+            ['customers' => ['unit test']],
+            ['Link' => '<' . $next . '>; rel="next"']
+        );
+
+        $service = new CustomerService($api);
+        $service->all();
+        $res = $service->getPaginationLink();
+        $this->assertInstanceOf(PaginationLink::class, $res);
+        $this->assertTrue($res->next == $next);
+    }
+}
diff --git a/test/TestCase.php b/test/TestCase.php
index 858b7be..4b6d784 100644
--- a/test/TestCase.php
+++ b/test/TestCase.php
@@ -20,7 +20,7 @@ public function getApi(array $params = array())
         return $api;
     }
 
-    public function getApiMock($file)
+    public function getApiMock($file, array $headers = ['X-Foo' => 'Bar'])
     {
         $json = null;
         if (is_array($file)) {
@@ -33,7 +33,7 @@ public function getApiMock($file)
             }
             $json = file_get_contents($path);
         }
-        $mock = new MockHandler([new Response(200, ['X-Foo' => 'Bar'], $json)]);
+        $mock = new MockHandler([new Response(200, $headers, $json)]);
 
         $handler = HandlerStack::create($mock);
         $client = new Client(['handler' => $handler]);