Add cursor pagination

Author: Moln

src/Basic/CursorPaginationNormalizer.php

@@ -0,0 +1,56 @@
+<?php
+
+
+namespace Zfegg\ApiSerializerExt\Basic;
+
+
+use UnexpectedValueException;
+use Zfegg\ApiSerializerExt\Paginator\CursorPaginatorInterface;
+use Zfegg\ApiSerializerExt\Serializer\AbstractCollectionNormalizer;
+
+class CursorPaginationNormalizer extends AbstractCollectionNormalizer
+{
+    public const FORMAT = 'json';
+
+    public function supportsNormalization($data, $format = null, array $context = [])
+    {
+        return $data instanceof CursorPaginatorInterface && parent::supportsNormalization($data, $format, $context);
+    }
+
+    protected function getPaginationData($object, array $context = []): array
+    {
+        if (!$object instanceof CursorPaginatorInterface) {
+            return [];
+        }
+
+        $data = [];
+        $data['page_size'] = $object->getItemsPerPage();
+        $data['cursor'] = $object->getCursor();
+        $data['prev_cursor'] = $object->getPrevCursor();
+        $data['next_cursor'] = $object->getNextCursor();
+
+        if ($object instanceof \Countable) {
+            $data['total'] = \count($object);
+        }
+
+        return $data;
+    }
+
+    protected function getItemsData($object, string $format = null, array $context = []): array
+    {
+        $data = [
+            'data' => [],
+        ];
+
+        foreach ($object as $obj) {
+            $item = $this->normalizer->normalize($obj, $format, $context);
+            if (!\is_array($item)) {
+                throw new UnexpectedValueException('Expected item to be an array');
+            }
+
+            $data['data'][] = $item;
+        }
+
+        return $data;
+    }
+}

src/Paginator/CursorPaginatorInterface.php

@@ -6,5 +6,11 @@
 
 interface CursorPaginatorInterface extends PaginatorInterface
 {
+    public function getCursor(): ?int;
 
-}
+    public function getItemsPerPage(): int;
+
+    public function getPrevCursor(): ?int;
+
+    public function getNextCursor(): ?int;
+}

src/Paginator/CursorPropertyTrait.php

@@ -0,0 +1,36 @@
+<?php
+
+
+namespace Zfegg\ApiSerializerExt\Paginator;
+
+
+trait CursorPropertyTrait
+{
+    use ItemsPerPageTrait;
+
+    private ?int $cursor = null;
+
+    private ?int $prevCursor = null;
+
+    private ?int $nextCursor = null;
+
+    public function getCursor(): ?int
+    {
+        return $this->cursor;
+    }
+
+    public function setCursor(?int $cursor)
+    {
+        $this->cursor = $cursor;
+    }
+
+    public function getPrevCursor(): ?int
+    {
+        return $this->prevCursor;
+    }
+
+    public function getNextCursor(): ?int
+    {
+        return $this->nextCursor;
+    }
+}

src/Paginator/ItemsPerPageTrait.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Zfegg\ApiSerializerExt\Paginator;
+
+
+trait ItemsPerPageTrait
+{
+    private int $itemsPerPage = 30;
+
+    public function getItemsPerPage(): int
+    {
+        return $this->itemsPerPage;
+    }
+
+    public function setItemsPerPage(int $itemsPerPage): void
+    {
+        $this->itemsPerPage = max($itemsPerPage, 1);
+    }
+}

src/Paginator/PaginatorPropertyTrait.php

@@ -1,15 +1,13 @@
 <?php
 
-
 namespace Zfegg\ApiSerializerExt\Paginator;
 
 
 trait PaginatorPropertyTrait
 {
-    private int $currentPage = 1;
-
-    private int $itemsPerPage = 30;
+    use ItemsPerPageTrait;
 
+    private int $currentPage = 1;
 
     public function getCurrentPage(): int
     {
@@ -21,13 +19,4 @@ public function setCurrentPage(int $currentPage): void
         $this->currentPage = $currentPage;
     }
 
-    public function getItemsPerPage(): int
-    {
-        return $this->itemsPerPage;
-    }
-
-    public function setItemsPerPage(int $itemsPerPage): void
-    {
-        $this->itemsPerPage = $itemsPerPage;
-    }
 }