Fix #218: Add ability to set page size

src/BaseListView.php

@@ -36,25 +36,52 @@
 
 use function array_slice;
 use function extension_loaded;
+use function in_array;
 use function is_array;
+use function is_int;
 use function is_string;
 
 /**
  * @psalm-type UrlArguments = array<string,scalar|Stringable|null>
  * @psalm-type UrlCreator = callable(UrlArguments,array):string
  * @psalm-type PageNotFoundExceptionCallback = callable(PageNotFoundException):void
+ * @psalm-type PageSizeConstraint = list<positive-int>|positive-int|bool
  * @psalm-import-type TOrder from Sort
  */
 abstract class BaseListView extends Widget
 {
+    /**
+     * Page size is fixed to default value.
+     */
+    public const PAGE_SIZE_FIXED = true;
+
+    /**
+     * Page size could be any value.
+     */
+    public const PAGE_SIZE_ANY = false;
+
     /**
      * @psalm-var UrlCreator|null
      */
     protected $urlCreator = null;
     protected UrlConfig $urlConfig;
 
+    /**
+     * @var int Page size that is used in case it is not set explicitly.
+     * @psalm-var positive-int
+     */
     protected int $defaultPageSize = PaginatorInterface::DEFAULT_PAGE_SIZE;
 
+    /**
+     * @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.
+     * @psalm-var PageSizeConstraint
+     */
+    protected bool|int|array $pageSizeConstraint = true;
+
     /**
      * A name for {@see CategorySource} used with translator ({@see TranslatorInterface}) by default.
      * @psalm-suppress MissingClassConstType
@@ -273,7 +300,7 @@
      *
      * @psalm-return list{FilterInterface[]|null,ValidationResult}
      */
     protected function makeFilters(): array
     {
         return [[], new ValidationResult()];
     }
@@ -351,7 +378,7 @@
 
         if (!$dataReader instanceof PaginatorInterface) {
             if (
                 $dataReader instanceof OffsetableDataInterface
                 && $dataReader instanceof CountableDataInterface
                 && $dataReader instanceof LimitableDataInterface
             ) {
@@ -371,10 +398,10 @@
             }
         }
 
         if ($dataReader->isPaginationRequired()) {
-            if ($pageSize !== null) {
-                $dataReader = $dataReader->withPageSize((int) $pageSize);
-            }
+            $dataReader = $dataReader->withPageSize(
+                $this->preparePageSize($pageSize) ?? $this->getDefaultPageSize()
+            );
 
             if ($page !== null) {
                 $dataReader = $dataReader->withToken(PageToken::next($page));
@@ -383,7 +410,7 @@
             }
         }
 
         if (!empty($sort) && $dataReader->isSortable()) {
             $sortObject = $dataReader->getSort();
             if ($sortObject !== null) {
                 $order = OrderHelper::stringToArray($sort);
@@ -395,7 +422,7 @@
             }
         }
 
         if (!empty($filters) && $dataReader->isFilterable()) {
             $dataReader = $dataReader->withFilter(new All(...$filters));
         }
 
@@ -483,7 +510,7 @@
      */
     public function offsetPaginationConfig(array $config): static
     {
         $new = clone $this;
         $new->offsetPaginationConfig = $config;
         return $new;
     }
@@ -496,7 +523,7 @@
      */
     public function keysetPaginationConfig(array $config): static
     {
         $new = clone $this;
         $new->keysetPaginationConfig = $config;
         return $new;
     }
@@ -638,14 +665,48 @@
                 ->render();
     }
 
+    /**
+     * @psalm-return positive-int
+     */
     protected function getDefaultPageSize(): int
     {
         $dataReader = $this->getDataReader();
-        if ($dataReader instanceof PaginatorInterface) {
-            return $dataReader->getPageSize();
+        $pageSize = $dataReader instanceof PaginatorInterface
+            ? $dataReader->getPageSize()
+            : $this->defaultPageSize;
+
+        if (is_int($this->pageSizeConstraint)) {
+            return $pageSize <= $this->pageSizeConstraint
+                ? $pageSize
+                : $this->pageSizeConstraint;
+        }
+
+        if (is_array($this->pageSizeConstraint)) {
+            return in_array($pageSize, $this->pageSizeConstraint, true)
+                ? $pageSize
+                : $this->pageSizeConstraint[0];
         }
 
-        return $this->defaultPageSize;
+        return $pageSize;
+    }
+
+    /**
+     * 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.
+     *
+     * @psalm-param PageSizeConstraint $pageSizeConstraint
+     */
+    public function pageSizeConstraint(array|int|bool $pageSizeConstraint): static
+    {
+        $new = clone $this;
+        $new->pageSizeConstraint = $pageSizeConstraint;
+        return $new;
     }
 
     /**
@@ -654,7 +715,7 @@
      *
      * @psalm-return array<string, string>
      */
     protected function getOverrideOrderFields(): array
     {
         return [];
     }
@@ -767,6 +828,39 @@
         };
     }
 
+    /**
+     * @psalm-return positive-int|null
+     */
+    private function preparePageSize(?string $rawPageSize): ?int
+    {
+        if ($this->pageSizeConstraint === true) {
+            return null;
+        }
+
+        if ($rawPageSize === null) {
+            return null;
+        }
+
+        $pageSize = (int) $rawPageSize;
+        if ($pageSize < 1) {
+            return null;
+        }
+
+        if ($this->pageSizeConstraint === false) {
+            return $pageSize;
+        }
+
+        if (is_int($this->pageSizeConstraint) && $pageSize <= $this->pageSizeConstraint) {
+            return $pageSize;
+        }
+
+        if (is_array($this->pageSizeConstraint) && in_array($pageSize, $this->pageSizeConstraint, true)) {
+            return $pageSize;
+        }
+
+        return null;
+    }
+
     /**
      * Creates default translator to use if {@see $translator} wasn't set explicitly in the constructor. Depending on
      * "intl" extension availability, either {@see IntlMessageFormatter} or {@see SimpleMessageFormatter} is used as

src/BasePagination.php

@@ -213,6 +213,9 @@ 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.
+     * @return string Created URL.
      */
     protected function createUrl(PageToken $pageToken): string
     {

tests/Support/SimpleUrlParameterProvider.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Yii\DataView\Tests\Support;
+
+use Yiisoft\Yii\DataView\UrlParameterProviderInterface;
+
+final class SimpleUrlParameterProvider implements UrlParameterProviderInterface
+{
+    /**
+     * @param string[] $parameters
+     */
+    public function __construct(
+        private readonly array $parameters = [],
+    ) {
+    }
+
+    public function get(string $name, int $type): ?string
+    {
+        return $this->parameters[$name] ?? null;
+    }
+}