yiisoft / yii-dataview

src/OffsetPagination.php

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\DataView;

use InvalidArgumentException;
use Yiisoft\Data\Paginator\OffsetPaginator;
use Yiisoft\Definitions\Exception\CircularReferenceException;
use Yiisoft\Definitions\Exception\InvalidConfigException;
use Yiisoft\Definitions\Exception\NotInstantiableException;
use Yiisoft\Factory\NotFoundException;
use Yiisoft\Html\Tag\Nav;
use Yiisoft\Yii\Widgets\Menu;

use function array_filter;
use function array_key_exists;
use function array_merge;
use function max;
use function min;

final class OffsetPagination extends BasePagination
{
    private bool $disabledFirstPage = false;
    private bool $disabledLastPage = false;
    private bool $disabledPageNavLink = false;
    private string $iconFirstPage = '';
    private string $iconClassFirstPage = '';
    private string $iconClassLastPage = '';
    private string $iconLastPage = '';
    private string $labelFirstPage = '';
    private string $labelLastPage = '';
    private int $maxNavLinkCount = 10;

    /**
     * Return a new instance with disabled first page.
     */
    public function disabledFirstPage(bool $value): self
    {
        $new = clone $this;
        $new->disabledFirstPage = $value;

        return $new;
    }

    /**
     * Return a new instance with disabled last page.
     */
    public function disabledLastPage(bool $value): self
    {
        $new = clone $this;
        $new->disabledLastPage = $value;

        return $new;
    }

    /**
     * Return a new instance with disabled page nav link.
     *
     * @param bool $value Disabled page nav link.
     */
    public function disabledPageNavLink(bool $value): self
    {
        $new = clone $this;
        $new->disabledPageNavLink = $value;

        return $new;
    }

    /**
     * Returns a new instance with the icon class for icon attributes `<i>` for link first page.
     *
     * @param string $value The icon class.
     */
    public function iconClassFirstPage(string $value): self
    {
        $new = clone $this;
        $new->iconClassFirstPage = $value;
        $new->labelFirstPage = '';

        return $new;
    }

    /**
     * Returns a new instance with the icon class for icon attributes `<i>` for link last page.
     *
     * @param string $value The icon class.
     */
    public function iconClassLastPage(string $value): self
    {
        $new = clone $this;
        $new->iconClassLastPage = $value;
        $new->labelLastPage = '';

        return $new;
    }

    /**
     * Return a new instance with icon first page.
     *
     * @param string $value The icon first page.
     */
    public function iconFirstPage(string $value): self
    {
        $new = clone $this;
        $new->iconFirstPage = $value;
        $new->labelFirstPage = '';

        return $new;
    }

    /**
     * Return a new instance with icon last page.
     *
     * @param string $value The icon last page.
     */
    public function iconLastPage(string $value): self
    {
        $new = clone $this;
        $new->iconLastPage = $value;
        $new->labelLastPage = '';

        return $new;
    }

    /**
     * Return a new instance with label for first page.
     *
     * @param string $value The label for first page.
     */
    public function labelFirstPage(string $value = ''): self
    {
        $new = clone $this;
        $new->labelFirstPage = $value;

        return $new;
    }

    /**
     * Return a new instance with label for last page.
     *
     * @param string $value The label for last page.
     */
    public function labelLastPage(string $value = ''): self
    {
        $new = clone $this;
        $new->labelLastPage = $value;

        return $new;
    }

    /**
     * Return a new instance with max nav link count.
     *
     * @param int $value Max nav link count.
     */
    public function maxNavLinkCount(int $value): self
    {
        $new = clone $this;
        $new->maxNavLinkCount = $value;

        return $new;
    }

    /**
     * @psalm-return array<int, int>
     */
    protected function getPageRange(int $currentPage, int $totalPages): array
    {
        $beginPage = max(1, $currentPage - (int) ($this->maxNavLinkCount / 2));

        if (($endPage = $beginPage + $this->maxNavLinkCount - 1) >= $totalPages) {
            $endPage = $totalPages;
            $beginPage = max(1, $endPage - $this->maxNavLinkCount + 1);
        }

        if ($totalPages !== 0 && $currentPage > $totalPages) {
            throw new InvalidArgumentException('Current page must be less than or equal to total pages.');
        }

        return [$beginPage, $endPage];
    }

    /**
     * @throws InvalidConfigException
     * @throws NotFoundException
     * @throws NotInstantiableException
     * @throws CircularReferenceException
     */
    public function render(): string
    {
        $attributes = $this->getAttributes();

        /** @var OffsetPaginator */
        $paginator = $this->getPaginator();
        $currentPage = $paginator->getCurrentPage();

The method getCurrentPage() does not exist on Yiisoft\Data\Paginator\PaginatorInterface. Did you maybe mean getCurrentPageSize()?

        $totalPages = $paginator->getTotalPages();

The method getTotalPages() does not exist on Yiisoft\Data\Paginator\PaginatorInterface. It seems like you code against a sub-type of Yiisoft\Data\Paginator\PaginatorInterface such as Yiisoft\Data\Paginator\OffsetPaginator.

        [$beginPage, $endPage] = $this->getPageRange($currentPage, $totalPages);

        $items = [];

        if ($this->getHideOnSinglePage() && $endPage < 2) {
            return '';
        }

        $items[] = $this->renderFirstsPageNavLink($currentPage);
        $items[] = $this->renderPreviousPageNavLink($currentPage);
        $items = array_merge($items, $this->renderPageNavLinks($currentPage, $beginPage, $endPage));
        $items[] = $this->renderNextPageNavLink($currentPage, $endPage);
        $items[] = $this->renderLastPageNavLink($currentPage, $endPage);

        if (!array_key_exists('aria-label', $attributes)) {
            $attributes['aria-label'] = 'Pagination';
        }

        return
            Nav::tag()
                ->attributes($attributes)
                ->content(
                    PHP_EOL .
                    Menu::widget()
                        ->class($this->getMenuClass())

The method class() does not exist on Yiisoft\Widget\Widget. It seems like you code against a sub-type of Yiisoft\Widget\Widget such as Yiisoft\Yii\Widgets\Alert or Yiisoft\Yii\Widgets\Menu.

                        ->items(array_filter($items))
                        ->itemsContainerClass($this->getMenuItemContainerClass())
                        ->linkClass($this->getMenuItemLinkClass()) .
                    PHP_EOL
                )
                ->encode(false)
                ->render();
    }

    private function renderFirstsPageNavLink(int $currentPage): array
    {
        $iconContainerAttributes = $this->getIconContainerAttributes();
        $items = [];

        if (!array_key_exists('aria-hidden', $iconContainerAttributes)) {
            $iconContainerAttributes['aria-hidden'] = 'true';
        }

        if ($this->labelFirstPage !== '' || $this->iconFirstPage !== '' || $this->iconClassFirstPage !== '') {
            $items = [
                'disabled' => $currentPage === 1 || $this->disabledFirstPage,
                'icon' => $this->iconFirstPage,
                'iconAttributes' => $this->getIconAttributes(),
                'iconClass' => $this->iconClassFirstPage,
                'iconContainerAttributes' => $iconContainerAttributes,
                'label' => $this->labelFirstPage,
                'link' => $this->createUrl(1),
            ];
        }

        return $items;
    }

    private function renderPreviousPageNavLink(int $currentPage): array
    {
        $iconContainerAttributes = $this->getIconContainerAttributes();
        $items = [];

        if (!array_key_exists('aria-hidden', $iconContainerAttributes)) {
            $iconContainerAttributes['aria-hidden'] = 'true';
        }

        if (
            $this->getLabelPreviousPage() !== '' ||
            $this->getIconPreviousPage() !== '' ||
            $this->getIconClassPreviousPage() !== ''
        ) {
            $items = [
                'disabled' => $currentPage === 1 || $this->getDisabledPreviousPage(),
                'icon' => $this->getIconPreviousPage(),
                'iconAttributes' => $this->getIconAttributes(),
                'iconClass' => $this->getIconClassPreviousPage(),
                'iconContainerAttributes' => $iconContainerAttributes,
                'label' => $this->getLabelPreviousPage(),
                'link' => $this->createUrl(max($currentPage - 1, 1)),
            ];
        }

        return $items;
    }

    private function renderPageNavLinks(int $currentPage, int $beginPage, int $endPage): array
    {
        $items = [];

        do {
            $items[] = [
                'active' => $beginPage === $currentPage,
                'disabled' => $this->disabledPageNavLink && $beginPage === $currentPage,
                'label' => (string) $beginPage,
                'link' => $this->createUrl($beginPage),
            ];
        } while (++$beginPage <= $endPage);

        return $items;
    }

    private function renderNextPageNavLink(int $currentPage, int $pageCount): array
    {
        $iconContainerAttributes = $this->getIconContainerAttributes();
        $items = [];

        if (!array_key_exists('aria-hidden', $iconContainerAttributes)) {
            $iconContainerAttributes['aria-hidden'] = 'true';
        }

        if (
            $this->getLabelNextPage() !== '' ||
            $this->getIconNextPage() !== '' ||
            $this->getIconClassNextPage() !== ''
        ) {
            $items = [
                'disabled' => $currentPage === $pageCount || $this->getDisabledNextPage(),
                'icon' => $this->getIconNextPage(),
                'iconAttributes' => $this->getIconAttributes(),
                'iconClass' => $this->getIconClassNextPage(),
                'iconContainerAttributes' => $iconContainerAttributes,
                'label' => $this->getLabelNextPage(),
                'link' => $this->createUrl(min($currentPage + 1, $pageCount)),
            ];
        }

        return $items;
    }

    private function renderLastPageNavLink(int $currentPage, int $pageCount): array
    {
        $iconContainerAttributes = $this->getIconContainerAttributes();
        $items = [];

        if (!array_key_exists('aria-hidden', $iconContainerAttributes)) {
            $iconContainerAttributes['aria-hidden'] = 'true';
        }

        if ($this->labelLastPage !== '' || $this->iconLastPage !== '' || $this->iconClassLastPage !== '') {
            $items = [
                'disabled' => $currentPage === $pageCount || $this->disabledLastPage,
                'icon' => $this->iconLastPage,
                'iconAttributes' => $this->getIconAttributes(),
                'iconClass' => $this->iconClassLastPage,
                'iconContainerAttributes' => $iconContainerAttributes,
                'label' => $this->labelLastPage,
                'link' => $this->createUrl($pageCount),
            ];
        }

        return $items;
    }
}