OffsetPaginator::isOnLastPage() - Code Metrics - Inspection of "Replace result type of `PaginatorInterface::with*`..." - yiisoft/data - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 98fbdf...d7acb5 )

by Alexander

created 2022-12-17 17:26 UTC

OffsetPaginator::isOnLastPage() A

↳ Parent: OffsetPaginator

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2

Importance

Changes

Metric	Value
cc	2
eloc	3
c	0
b	0
f	0
nc	2
nop	0
dl	0
loc	7
ccs	4
cts	4
cp	1
crap	2
rs	10

<?php

declare(strict_types=1);

namespace Yiisoft\Data\Paginator;

use Generator;
use InvalidArgumentException;
use Yiisoft\Data\Reader\CountableDataInterface;
use Yiisoft\Data\Reader\OffsetableDataInterface;
use Yiisoft\Data\Reader\ReadableDataInterface;
use Yiisoft\Data\Reader\Sort;
use Yiisoft\Data\Reader\SortableDataInterface;

use function ceil;
use function max;
use function sprintf;

/**
 * @psalm-template DataReaderType = ReadableDataInterface<TKey, TValue>&OffsetableDataInterface&CountableDataInterface
 *
 * @template TKey as array-key
 * @template TValue
 *
 * @implements PaginatorInterface<TKey, TValue>
 */
final class OffsetPaginator implements PaginatorInterface
{
    private int $currentPage = 1;
    private int $pageSize = self::DEFAULT_PAGE_SIZE;

    /**
     * @psalm-var DataReaderType
     */
    private ReadableDataInterface $dataReader;

    /**
     * @psalm-var DataReaderType|null
     */
    private ?ReadableDataInterface $cachedReader = null;

    /**
     * @psalm-param DataReaderType $dataReader
     */
    public function __construct(ReadableDataInterface $dataReader)
    {
        if (!$dataReader instanceof OffsetableDataInterface) {
            throw new InvalidArgumentException(sprintf(
                'Data reader should implement "%s" in order to be used with offset paginator.',
                OffsetableDataInterface::class,
            ));
        }

        if (!$dataReader instanceof CountableDataInterface) {
            throw new InvalidArgumentException(sprintf(
                'Data reader should implement "%s" in order to be used with offset paginator.',
                CountableDataInterface::class,
            ));
        }

        $this->dataReader = $dataReader;
    }

    public function withNextPageToken(?string $token): static
    {
        return $this->withCurrentPage((int) $token);
    }

    public function withPreviousPageToken(?string $token): static
    {
        return $this->withCurrentPage((int) $token);
    }

    public function withPageSize(int $pageSize): static
    {
        if ($pageSize < 1) {
            throw new PaginatorException('Page size should be at least 1.');
        }

        $new = clone $this;
        $new->pageSize = $pageSize;
        $new->cachedReader = null;
        return $new;
    }

    public function withCurrentPage(int $page): self
    {
        if ($page < 1) {
            throw new PaginatorException('Current page should be at least 1.');
        }

        $new = clone $this;
        $new->currentPage = $page;
        $new->cachedReader = null;
        return $new;
    }

    public function getNextPageToken(): ?string
    {
        return $this->isOnLastPage() ? null : (string) ($this->currentPage + 1);
    }

    public function getPreviousPageToken(): ?string
    {
        return $this->isOnFirstPage() ? null : (string) ($this->currentPage - 1);
    }

    public function getPageSize(): int
    {
        return $this->pageSize;
    }

    public function getCurrentPage(): int
    {
        return $this->currentPage;
    }

    public function getCurrentPageSize(): int
    {
        $pages = $this->getInternalTotalPages();

        if ($pages === 1) {
            return $this->getTotalItems();
        }

        if ($this->currentPage === $pages) {
            return $this->getTotalItems() - $this->getOffset();
        }

        if ($this->currentPage > $pages) {
            throw new PaginatorException('Page not found.');
        }

        return $this->pageSize;
    }

    public function getOffset(): int
    {
        return $this->pageSize * ($this->currentPage - 1);
    }

    public function getTotalItems(): int
    {
        /** @psalm-var CountableDataInterface $this->dataReader */
        return $this->dataReader->count();
        return $this->dataReader->/** @scrutinizer ignore-call */ count();
    }

    public function getTotalPages(): int
    {
        return (int) ceil($this->getTotalItems() / $this->pageSize);
    }

    public function getSort(): ?Sort
    {
        return $this->dataReader instanceof SortableDataInterface ? $this->dataReader->getSort() : null;
        return $this->dataReader instanceof SortableDataInterface ? $this->dataReader->/** @scrutinizer ignore-call */ getSort() : null;
    }

    /**
     * @psalm-return Generator<TKey, TValue, mixed, void>
     * @psalm-suppress MixedAssignment, MixedMethodCall, MixedReturnTypeCoercion
     */
    public function read(): iterable
    {
        if ($this->cachedReader !== null) {
            yield from $this->cachedReader->read();
            return;
        }

        if ($this->currentPage > $this->getInternalTotalPages()) {
            throw new PaginatorException('Page not found.');
        }

        $this->cachedReader = $this->dataReader
            ->withLimit($this->pageSize)
            ->withOffset($this->getOffset());
            ->/** @scrutinizer ignore-call */ withOffset($this->getOffset());
        yield from $this->cachedReader->read();
        yield from $this->cachedReader->/** @scrutinizer ignore-call */ read();
    }

    public function isOnFirstPage(): bool
    {
        return $this->currentPage === 1;
    }

    public function isOnLastPage(): bool
    {
        if ($this->currentPage > $this->getInternalTotalPages()) {
            throw new PaginatorException('Page not found.');
        }

        return $this->currentPage === $this->getInternalTotalPages();
    }

    public function isRequired(): bool
    {
        return $this->getTotalPages() > 1;
    }

    private function getInternalTotalPages(): int
    {
        return max(1, $this->getTotalPages());
    }
}


yiisoft / data

Push — master ( 98fbdf...d7acb5 )

OffsetPaginator::isOnLastPage() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like