Merge pull request #5 from emonkak/redesign-pagination

Redesign pagination
emonkak · Jun 17, 2020 · 3dc64f0 · 3dc64f0
2 parents 426d66b + 334712b
commit 3dc64f0
Show file tree

Hide file tree

Showing 21 changed files with 591 additions and 450 deletions.
diff --git a/src/Pagination/AbstractPage.php b/src/Pagination/AbstractPage.php
@@ -0,0 +1,67 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Emonkak\Orm\Pagination;
+
+use Emonkak\Enumerable\EnumerableExtensions;
+
+/**
+ * @template T
+ * @implements \IteratorAggregate<T>
+ * @implements PageInterface<T>
+ */
+abstract class AbstractPage implements \IteratorAggregate, PageInterface
+{
+    /**
+     * @use EnumerableExtensions<T>
+     */
+    use EnumerableExtensions;
+
+    public function getOffset(): int
+    {
+        return $this->getIndex() * $this->getPerPage();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function forward(): iterable
+    {
+        $page = $this;
+
+        yield $page;
+
+        while ($page->hasNext()) {
+            $page = $page->next();
+
+            yield $page;
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function backward(): iterable
+    {
+        $page = $this;
+
+        yield $page;
+
+        while ($page->hasPrevious()) {
+            $page = $page->previous();
+
+            yield $page;
+        }
+    }
+
+    public function isFirst(): bool
+    {
+        return !$this->hasPrevious();
+    }
+
+    public function isLast(): bool
+    {
+        return !$this->hasNext();
+    }
+}
diff --git a/src/Pagination/AbstractPaginator.php b/src/Pagination/AbstractPaginator.php
@@ -38,15 +38,15 @@ public function has(int $index): bool
     /**
      * {@inheritdoc}
      */
-    public function firstPage(): PageInterface
+    public function firstPage(): PaginatablePageInterface
     {
         return $this->at(0);
     }
 
     /**
      * {@inheritdoc}
      */
-    public function lastPage(): PageInterface
+    public function lastPage(): PaginatablePageInterface
     {
         $totalPages = $this->getTotalPages();
         return $this->at($totalPages > 0 ? $totalPages - 1 : 0);

diff --git a/src/Pagination/EmptyPaginator.php b/src/Pagination/EmptyPaginator.php
@@ -33,7 +33,7 @@ public function __construct(int $perPage)
     /**
      * {@inheritdoc}
      */
-    public function at(int $index): PageInterface
+    public function at(int $index): PaginatablePageInterface
     {
         return new Page(new \EmptyIterator(), $index, $this);
     }
@@ -46,15 +46,15 @@ public function has(int $index): bool
     /**
      * {@inheritdoc}
      */
-    public function firstPage(): PageInterface
+    public function firstPage(): PaginatablePageInterface
     {
         return $this->at(0);
     }
 
     /**
      * {@inheritdoc}
      */
-    public function lastPage(): PageInterface
+    public function lastPage(): PaginatablePageInterface
     {
         return $this->at(0);
     }

diff --git a/src/Pagination/Page.php b/src/Pagination/Page.php
@@ -4,20 +4,13 @@
 
 namespace Emonkak\Orm\Pagination;
 
-use Emonkak\Enumerable\EnumerableExtensions;
-
 /**
  * @template T
- * @implements \IteratorAggregate<T>
- * @implements PageInterface<T>
+ * @extends AbstractPage<T>
+ * @implements PaginatablePageInterface<T>
  */
-class Page implements \IteratorAggregate, PageInterface
+class Page extends AbstractPage implements PaginatablePageInterface
 {
-    /**
-     * @use EnumerableExtensions<T>
-     */
-    use EnumerableExtensions;
-
     /**
      * @psalm-var \Traversable<T>
      * @var \Traversable
@@ -62,49 +55,39 @@ public function getPaginator(): PaginatorInterface
         return $this->paginator;
     }
 
-    public function getIndex(): int
+    public function getPerPage(): int
     {
-        return $this->index;
+        return $this->paginator->getPerPage();
     }
 
-    public function getOffset(): int
+    public function getIndex(): int
     {
-        return $this->index * $this->paginator->getPerPage();
+        return $this->index;
     }
 
     /**
      * {@inheritdoc}
      */
-    public function previous(): PageInterface
+    public function next(): PageInterface
     {
-        return $this->paginator->at($this->index - 1);
+        return $this->paginator->at($this->index + 1);
     }
 
     /**
      * {@inheritdoc}
      */
-    public function next(): PageInterface
-    {
-        return $this->paginator->at($this->index + 1);
-    }
-
-    public function hasPrevious(): bool
+    public function previous(): PageInterface
     {
-        return $this->paginator->has($this->index - 1);
+        return $this->paginator->at($this->index - 1);
     }
 
     public function hasNext(): bool
     {
         return $this->paginator->has($this->index + 1);
     }
 
-    public function isFirst(): bool
-    {
-        return !$this->hasPrevious();
-    }
-
-    public function isLast(): bool
+    public function hasPrevious(): bool
     {
-        return !$this->hasNext();
+        return $this->paginator->has($this->index - 1);
     }
 }
diff --git a/src/Pagination/PageInterface.php b/src/Pagination/PageInterface.php
@@ -12,24 +12,31 @@
  */
 interface PageInterface extends EnumerableInterface
 {
-    /**
-     * @psalm-return PaginatorInterface<T>
-     */
-    public function getPaginator(): PaginatorInterface;
+    public function getPerPage(): int;
 
     public function getIndex(): int;
 
     public function getOffset(): int;
 
     /**
-     * @psalm-return PageInterface<T>
+     * @psalm-return self<T>
+     */
+    public function next(): self;
+
+    /**
+     * @psalm-return self<T>
+     */
+    public function previous(): self;
+
+    /**
+     * @psalm-return iterable<self<T>>
      */
-    public function previous(): PageInterface;
+    public function forward(): iterable;
 
     /**
-     * @psalm-return PageInterface<T>
+     * @psalm-return iterable<self<T>>
      */
-    public function next(): PageInterface;
+    public function backward(): iterable;
 
     public function hasPrevious(): bool;
 

diff --git a/src/Pagination/PageIteratorInterface.php b/src/Pagination/PageIteratorInterface.php
diff --git a/src/Pagination/PaginatablePageInterface.php b/src/Pagination/PaginatablePageInterface.php
@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Emonkak\Orm\Pagination;
+
+/**
+ * @template T
+ * @extends PageInterface<T>
+ * @method self<T> next()
+ * @method self<T> previous()
+ * @method iterable<self<T>> forward()
+ * @method iterable<self<T>> backward()
+ */
+interface PaginatablePageInterface extends PageInterface
+{
+    /**
+     * @psalm-return PaginatorInterface<T>
+     */
+    public function getPaginator(): PaginatorInterface;
+}
diff --git a/src/Pagination/PaginatorInterface.php b/src/Pagination/PaginatorInterface.php
@@ -13,23 +13,23 @@
 interface PaginatorInterface extends EnumerableInterface
 {
     /**
-     * @psalm-return PageInterface<T>
+     * @psalm-return PaginatablePageInterface<T>
      */
-    public function at(int $index): PageInterface;
+    public function at(int $index): PaginatablePageInterface;
 
     public function getPerPage(): int;
 
     public function has(int $index): bool;
 
     /**
-     * @psalm-return PageInterface<T>
+     * @psalm-return PaginatablePageInterface<T>
      */
-    public function firstPage(): PageInterface;
+    public function firstPage(): PaginatablePageInterface;
 
     /**
-     * @psalm-return PageInterface<T>
+     * @psalm-return PaginatablePageInterface<T>
      */
-    public function lastPage(): PageInterface;
+    public function lastPage(): PaginatablePageInterface;
 
     public function getTotalItems(): int;
 

diff --git a/src/Pagination/PrecountPaginator.php b/src/Pagination/PrecountPaginator.php
@@ -10,12 +10,6 @@
  */
 class PrecountPaginator extends AbstractPaginator
 {
-    /**
-     * @psalm-var callable(int,int):\Traversable<T>
-     * @var callable(int,int):\Traversable
-     */
-    private $itemsFetcher;
-
     /**
      * @var int
      */
@@ -26,22 +20,26 @@ class PrecountPaginator extends AbstractPaginator
      */
     private $totalItems;
 
+    /**
+     * @psalm-var callable(int,int):\Traversable<T>
+     * @var callable(int,int):\Traversable
+     */
+    private $itemsFetcher;
+
     /**
      * @psalm-param callable(int,int):\Traversable<T> $itemsFetcher
-     * @psalm-param int $perPage
-     * @psalm-param int $totalItems
      */
-    public function __construct(callable $itemsFetcher, int $perPage, int $totalItems)
+    public function __construct(int $perPage, int $totalItems, callable $itemsFetcher)
     {
-        $this->itemsFetcher = $itemsFetcher;
         $this->perPage = $perPage;
         $this->totalItems = $totalItems;
+        $this->itemsFetcher = $itemsFetcher;
     }
 
     /**
      * {@inheritdoc}
      */
-    public function at(int $index): PageInterface
+    public function at(int $index): PaginatablePageInterface
     {
         if ($index >= 0 && $index < $this->getTotalPages()) {
             $itemsFetcher = $this->itemsFetcher;