Add draft page selector

yiisoft · Nov 8, 2024 · b07995a · b07995a
1 parent 9401e7f
commit b07995a
Show file tree

Hide file tree

Showing 3 changed files with 103 additions and 17 deletions.
diff --git a/src/BaseListView.php b/src/BaseListView.php
@@ -36,6 +36,7 @@
 
 use function is_array;
 use function is_string;
+use function PHPUnit\Framework\returnArgument;
 
 /**
  * @psalm-type UrlArguments = array<string,scalar|Stringable|null>
@@ -690,20 +691,6 @@ protected function getDefaultPageSize(): int
         return $this->defaultPageSize;
     }
 
-    /**
-     * Get page size constraint.
-     *
-     * @return array|bool|int Page size constraint.
-     * - `true` - default only.
-     * - `false` - no constraint.
-     * - int - maximum page size.
-     * -  [int, int, ...] - a list of page sizes to choose from.
-     */
-    protected function getPageSizeConstraint(): array|int|bool
-    {
-        return $this->pageSizeConstraint;
-    }
-
     /**
      * Get a new instance with a page size constraint set.
      *
@@ -757,6 +744,7 @@ private function renderPagination(): string
         }
 
         return $pagination
+            ->pageSizeConstraint($this->pageSizeConstraint)
             ->defaultPageSize($this->getDefaultPageSize())
             ->urlConfig($this->urlConfig)
             ->render();

diff --git a/src/BasePagination.php b/src/BasePagination.php
@@ -5,9 +5,11 @@
 namespace Yiisoft\Yii\DataView;
 
 use InvalidArgumentException;
+use LogicException;
 use Yiisoft\Data\Paginator\PageToken;
 use Yiisoft\Data\Paginator\PaginatorInterface;
 use Yiisoft\Html\Html;
+use Yiisoft\Http\Method;
 use Yiisoft\Widget\Widget;
 
 use function call_user_func_array;
@@ -17,6 +19,15 @@
  */
 abstract class BasePagination extends Widget
 {
+    /**
+     * @var array|bool|int Page size constraint.
+     *  - `true` - default only.
+     *  - `false` - no constraint.
+     *  - int - maximum page size.
+     *  -  [int, int, ...] - a list of page sizes to choose from.
+     */
+    private bool|int|array $pageSizeConstraint = true;
+
     /**
      * @psalm-var UrlCreator|null
      */
@@ -25,6 +36,8 @@ abstract class BasePagination extends Widget
 
     private int $defaultPageSize = PaginatorInterface::DEFAULT_PAGE_SIZE;
 
+
+
     /**
      * @psalm-var non-empty-string|null
      */
@@ -172,9 +185,41 @@ final public function render(): string
             $result .= "\n" . Html::closeTag($this->containerTag);
         }
 
+        $result .= $this->renderPageSize();
+
         return $result;
     }
 
+    private function renderPageSize(): string
+    {
+        $out = Html::openTag('nav', ['class' => 'pageSize']);
+
+        $form = Html::form($this->getPageSizeItem()->url, Method::GET);
+        $out .= $form->open();
+
+        if (is_int($this->pageSizeConstraint)) {
+            $out .= Html::textInput(
+                $this->urlConfig->getPageSizeParameterName(),
+                $this->getPaginator()->getPageSize(),
+                ['class' => 'form-control']
+            );
+        } elseif (is_array($this->pageSizeConstraint)) {
+            $options = array_combine($this->pageSizeConstraint, $this->pageSizeConstraint);
+            $out .= Html::select($this->urlConfig->getPageSizeParameterName())
+                ->optionsData($options)
+                ->value($this->getPaginator()->getPageSize());
+        } else {
+            return '';
+        }
+
+        $out .= Html::submitButton();
+        $out .= $form->close();
+
+        $out .= Html::closeTag('nav');
+
+        return $out;
+    }
+
     /**
      * @psalm-param UrlCreator|null $urlCreator
      */
@@ -202,15 +247,19 @@ public function urlConfig(UrlConfig $config): static
     /**
      * Creates the URL suitable for pagination with the specified page number. This method is mainly called by pagers
      * when creating URLs used to perform pagination.
+     *
+     * @param PageToken $pageToken Token for the page.
+     * @param int|null $pageSize Page size to change to.
+     * @return string Created URL.
      */
-    protected function createUrl(PageToken $pageToken): string
+    protected function createUrl(PageToken $pageToken, ?int $pageSize = null): string
     {
         if ($this->urlCreator === null) {
             return '#' . $pageToken->value;
         }
 
         $paginator = $this->getPaginator();
-        $pageSize = $paginator->getPageSize();
+        $pageSize = $pageSize ?? $paginator->getPageSize();
         $sort = $paginator->getSort()?->getOrderAsString();
 
         return call_user_func_array(
@@ -224,6 +273,55 @@ protected function createUrl(PageToken $pageToken): string
         );
     }
 
+    private function getPageSizeItem(): PaginationItem
+    {
+        $first = null;
+        foreach ($this->getItems() as $item) {
+            if ($first === null) {
+                $first = $item;
+            }
+            if ($item->isCurrent) {
+                return $item;
+            }
+        }
+        if ($first !== null) {
+            return $first;
+        }
+
+        throw new LogicException('Page size item is missing.');
+    }
+
+    /**
+     * Get page size constraint.
+     *
+     * @return array|bool|int Page size constraint.
+     * - `true` - default only.
+     * - `false` - no constraint.
+     * - int - maximum page size.
+     * -  [int, int, ...] - a list of page sizes to choose from.
+     */
+    public function getPageSizeConstraint(): array|int|bool
+    {
+        return $this->pageSizeConstraint;
+    }
+
+    /**
+     * Get a new instance with a page size constraint set.
+     *
+     * @param array|bool|int $pageSizeConstraint Page size constraint.
+     * `true` - default only.
+     * `false` - no constraint.
+     * int - maximum page size.
+     * [int, int, ...] - a list of page sizes to choose from.
+     * @return static New instance.
+     */
+    public function pageSizeConstraint(array|int|bool $pageSizeConstraint): static
+    {
+        $new = clone $this;
+        $new->pageSizeConstraint = $pageSizeConstraint;
+        return $new;
+    }
+
     /**
      * @return PaginationItem[]
      */

diff --git a/tests/ListView/BaseTest.php b/tests/ListView/BaseTest.php
@@ -526,7 +526,7 @@ public function testClosureForItemViewAttributesWithClosure(): void
     public function testDefaultPageSizeConstraint(): void
     {
         $this->expectException(InvalidArgumentException::class);
-        $this->expectExceptionMessage('Page size can not be changed');
+        $this->expectExceptionMessage('Page size can not be changed.');
 
         $parameters = ['pagesize' => 10];