Refactor pagination

config/widgets-themes.php

@@ -66,7 +66,6 @@
             'itemTag()' => ['li'],
             'itemAttributes()' => [['class' => 'page-item']],
             'linkAttributes()' => [['class' => 'page-link']],
-            'currentItemClass()' => ['active'],
             'disabledItemClass()' => ['disabled'],
         ],
         InputPageSize::class => [

src/BaseListView.php

@@ -35,11 +35,13 @@
 use Yiisoft\Yii\DataView\Exception\DataReaderNotSetException;
 use Yiisoft\Yii\DataView\PageSize\InputPageSize;
 use Yiisoft\Yii\DataView\PageSize\PageSizeContext;
-use Yiisoft\Yii\DataView\PageSize\PageSizeControlInterface;
+use Yiisoft\Yii\DataView\PageSize\PageSizeWidgetInterface;
 use Yiisoft\Yii\DataView\PageSize\SelectPageSize;
 use Yiisoft\Yii\DataView\Pagination\KeysetPagination;
 use Yiisoft\Yii\DataView\Pagination\OffsetPagination;
 use Yiisoft\Yii\DataView\Pagination\PaginationContext;
+use Yiisoft\Yii\DataView\Pagination\PaginationWidgetInterface;
+use Yiisoft\Yii\DataView\Pagination\PaginatorNotSupportedException;
 
 use function array_key_exists;
 use function array_slice;
@@ -48,7 +50,6 @@
 use function in_array;
 use function is_array;
 use function is_int;
-use function is_string;
 
 /**
  * @psalm-type UrlArguments = array<string,scalar|Stringable|null>
@@ -90,8 +91,8 @@
      */
     private ?string $pageSizeTag = 'div';
     private array $pageSizeAttributes = [];
-    private ?string $pageSizeTemplate = 'Results per page {control}';
-    private PageSizeControlInterface|null $pageSizeControl = null;
+    private ?string $pageSizeTemplate = 'Results per page {widget}';
+    private PageSizeWidgetInterface|null $pageSizeWidget = null;
 
     /**
      * A name for {@see CategorySource} used with translator ({@see TranslatorInterface}) by default.
@@ -126,7 +127,7 @@
 
     private array $offsetPaginationConfig = [];
     private array $keysetPaginationConfig = [];
-    private string|OffsetPagination|KeysetPagination|null $pagination = null;
+    private PaginationWidgetInterface|null $paginationWidget = null;
     protected ?ReadableDataInterface $dataReader = null;
     private string $toolbar = '';
 
@@ -311,7 +312,7 @@
      *
      * @psalm-return list{FilterInterface[]|null,ValidationResult}
      */
     protected function makeFilters(): array
     {
         return [[], new ValidationResult()];
     }
@@ -389,7 +390,7 @@
 
         if (!$dataReader instanceof PaginatorInterface) {
             if (
                 $dataReader instanceof OffsetableDataInterface
                 && $dataReader instanceof CountableDataInterface
                 && $dataReader instanceof LimitableDataInterface
             ) {
@@ -409,7 +410,7 @@
             }
         }
 
         if ($dataReader->isPaginationRequired()) {
             $dataReader = $dataReader->withPageSize(
                 $this->preparePageSize($pageSize) ?? $this->getDefaultPageSize()
             );
@@ -421,7 +422,7 @@
             }
         }
 
         if (!empty($sort) && $dataReader->isSortable()) {
             $sortObject = $dataReader->getSort();
             if ($sortObject !== null) {
                 $order = OrderHelper::stringToArray($sort);
@@ -433,7 +434,7 @@
             }
         }
 
         if (!empty($filters) && $dataReader->isFilterable()) {
             $dataReader = $dataReader->withFilter(new All(...$filters));
         }
 
@@ -537,7 +538,7 @@
      *
      * The following tokens will be replaced with the corresponding values:
      *
-     * - `{control}` — page size control.
+     * - `{widget}` — page size widget.
      */
     final public function pageSizeTemplate(?string $template): static
     {
@@ -546,17 +547,17 @@
         return $new;
     }
 
-    final public function pageSizeControl(?PageSizeControlInterface $widget): static
+    final public function pageSizeWidget(?PageSizeWidgetInterface $widget): static
     {
         $new = clone $this;
-        $new->pageSizeControl = $widget;
+        $new->pageSizeWidget = $widget;
         return $new;
     }
 
-    public function pagination(string|KeysetPagination|OffsetPagination|null $pagination): static
+    public function paginationWidget(PaginationWidgetInterface|null $widget): static
     {
         $new = clone $this;
-        $new->pagination = $pagination;
+        $new->paginationWidget = $widget;
         return $new;
     }
 
@@ -568,7 +569,7 @@
      */
     public function offsetPaginationConfig(array $config): static
     {
         $new = clone $this;
         $new->offsetPaginationConfig = $config;
         return $new;
     }
@@ -581,7 +582,7 @@
      */
     public function keysetPaginationConfig(array $config): static
     {
         $new = clone $this;
         $new->keysetPaginationConfig = $config;
         return $new;
     }
@@ -774,55 +775,74 @@
      *
      * @psalm-return array<string, string>
      */
     protected function getOverrideOrderFields(): array
     {
         return [];
     }
 
     private function renderPagination(): string
     {
-        $preparedDataReader = $this->preparedDataReader;
-        if (!$preparedDataReader instanceof PaginatorInterface || !$preparedDataReader->isPaginationRequired()) {
+        $dataReader = $this->preparedDataReader;
+        if (!$dataReader instanceof PaginatorInterface || !$dataReader->isPaginationRequired()) {
             return '';
         }
 
-        if (is_string($this->pagination)) {
-            return $this->pagination;
-        }
-
-        if ($this->pagination === null) {
-            if ($preparedDataReader instanceof OffsetPaginator) {
-                $pagination = OffsetPagination::widget(config: $this->offsetPaginationConfig);
-            } elseif ($preparedDataReader instanceof KeysetPaginator) {
-                $pagination = KeysetPagination::widget(config: $this->keysetPaginationConfig);
+        if ($this->paginationWidget === null) {
+            if ($dataReader instanceof OffsetPaginator) {
+                $widget = OffsetPagination::widget(config: $this->offsetPaginationConfig);
+            } elseif ($dataReader instanceof KeysetPaginator) {
+                $widget = KeysetPagination::widget(config: $this->keysetPaginationConfig);
             } else {
                 return '';
             }
+            try {
+                $widget = $widget->withPaginator($dataReader);
+            } catch (PaginatorNotSupportedException) {
+                return '';
+            }
         } else {
-            $pagination = $this->pagination;
+            $widget = $this->paginationWidget->withPaginator($dataReader);
         }
 
-        if ($pagination instanceof OffsetPagination && $preparedDataReader instanceof OffsetPaginator) {
-            $pagination = $pagination->paginator($preparedDataReader);
-        } elseif ($pagination instanceof KeysetPagination && $preparedDataReader instanceof KeysetPaginator) {
-            $pagination = $pagination->paginator($preparedDataReader);
+        if ($this->urlCreator === null) {
+            $nextUrlPattern = '#page=' . PaginationContext::URL_PLACEHOLDER;
+            $previousUrlPattern = '#previous-page=' . PaginationContext::URL_PLACEHOLDER;
+            $defaultUrl = '#';
         } else {
-            return '';
-        }
-
-        if ($this->urlCreator !== null) {
-            $pagination = $pagination->urlCreator($this->urlCreator);
+            $pageSize = $this->getPageSizeValueForUrl($dataReader);
+            $sort = $this->getSortValueForUrl($dataReader);
+            $nextUrlPattern = call_user_func_array(
+                $this->urlCreator,
+                UrlParametersFactory::create(
+                    PageToken::next(PaginationContext::URL_PLACEHOLDER),
+                    $pageSize,
+                    $sort,
+                    $this->urlConfig
+                ),
+            );
+            $previousUrlPattern = call_user_func_array(
+                $this->urlCreator,
+                UrlParametersFactory::create(
+                    PageToken::previous(PaginationContext::URL_PLACEHOLDER),
+                    $pageSize,
+                    $sort,
+                    $this->urlConfig
+                ),
+            );
+            $defaultUrl = call_user_func_array(
+                $this->urlCreator,
+                UrlParametersFactory::create(null, $pageSize, $sort, $this->urlConfig),
+            );
         }
 
         $context = new PaginationContext(
             $this->getOverrideOrderFields(),
+            $nextUrlPattern,
+            $previousUrlPattern,
+            $defaultUrl,
         );
 
-        return $pagination
-            ->context($context)
-            ->defaultPageSize($this->getDefaultPageSize())
-            ->urlConfig($this->urlConfig)
-            ->render();
+        return $widget->withContext($context)->render();
     }
 
     private function renderPageSize(): string
@@ -836,7 +856,7 @@
             return '';
         }
 
-        if ($this->pageSizeControl === null) {
+        if ($this->pageSizeWidget === null) {
             if ($this->pageSizeConstraint === false || is_int($this->pageSizeConstraint)) {
                 $widget = InputPageSize::widget();
             } elseif (is_array($this->pageSizeConstraint)) {
@@ -845,7 +865,7 @@
                 return '';
             }
         } else {
-            $widget = $this->pageSizeControl;
+            $widget = $this->pageSizeWidget;
         }
 
         if ($this->urlCreator === null) {
@@ -875,11 +895,11 @@
             $urlPattern,
             $defaultUrl,
         );
-        $control = $widget->withContext($context)->render();
+        $renderedWidget = $widget->withContext($context)->render();
 
         $content = $this->translator->translate(
             $this->pageSizeTemplate,
-            ['control' => $control],
+            ['widget' => $renderedWidget],
             $this->translationCategory,
         );
 
@@ -1003,6 +1023,14 @@
         return $translator;
     }
 
+    private function getPageSizeValueForUrl(PaginatorInterface $paginator): ?string
+    {
+        $pageSize = $paginator->getPageSize();
+        return $pageSize === $this->getDefaultPageSize()
+            ? null
+            : (string) $pageSize;
+    }
+
     private function getSortValueForUrl(PaginatorInterface $paginator): ?string
     {
         $sort = $this->getSort($paginator);

src/PageSize/InputPageSize.php

@@ -7,7 +7,7 @@
 use Yiisoft\Html\Html;
 use Yiisoft\Widget\Widget;
 
-final class InputPageSize extends Widget implements PageSizeControlInterface
+final class InputPageSize extends Widget implements PageSizeWidgetInterface
 {
     use PageSizeContextTrait;
 

src/PageSize/PageSizeContextTrait.php

@@ -7,7 +7,7 @@
 use LogicException;
 
 /**
- * @psalm-require-implements PageSizeControlInterface
+ * @psalm-require-implements PageSizeWidgetInterface
  */
 trait PageSizeContextTrait
 {

src/PageSize/PageSizeControlInterface.php → src/PageSize/PageSizeWidgetInterface.php

@@ -6,7 +6,7 @@
 
 use Stringable;
 
-interface PageSizeControlInterface extends Stringable
+interface PageSizeWidgetInterface extends Stringable
 {
     public function withContext(PageSizeContext $context): static;
 

src/PageSize/SelectPageSize.php

@@ -10,7 +10,7 @@
 use function count;
 use function is_array;
 
-final class SelectPageSize extends Widget implements PageSizeControlInterface
+final class SelectPageSize extends Widget implements PageSizeWidgetInterface
 {
     use PageSizeContextTrait;