OffsetPaginator::read() - Code Metrics - Inspection of "Update dependencies" - yiisoft/data - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( e9610e...a5c3f4 )

by Alexander

created 2020-08-09 18:34 UTC

OffsetPaginator::read() A

↳ Parent: OffsetPaginator

Complexity

Conditions	3
Paths	3

Size

Total Lines	12
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	3.1406

Importance

Changes

Metric	Value
cc	3
eloc	7
nc	3
nop	0
dl	0
loc	12
ccs	6
cts	8
cp	0.75
crap	3.1406
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace Yiisoft\Data\Paginator;

use Yiisoft\Data\Reader\CountableDataInterface;
use Yiisoft\Data\Reader\DataReaderInterface;
use Yiisoft\Data\Reader\OffsetableDataInterface;

final class OffsetPaginator implements PaginatorInterface
{
    /** @var OffsetableDataInterface|DataReaderInterface|CountableDataInterface */
    private DataReaderInterface $dataReader;
    private int $currentPage = 1;
    private int $pageSize = self::DEFAULT_PAGE_SIZE;
    private ?DataReaderInterface $cachedReader = null;

    public function __construct(DataReaderInterface $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 isRequired(): bool
    {
        return $this->getTotalPages() > 1;
    }

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

    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 withPageSize(int $size): self
    {
        if ($size < 1) {
            throw new PaginatorException('Page size should be at least 1');
        }
        $new = clone $this;
        $new->pageSize = $size;
        $new->cachedReader = null;
        return $new;
    }

    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 getTotalPages(): int
    {
        return (int) ceil($this->getTotalItems() / $this->pageSize);
    }

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

    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');
        }
        /** @var OffsetableDataInterface|DataReaderInterface|CountableDataInterface $reader */
        $this->cachedReader = $this->dataReader->withLimit($this->pageSize)->withOffset($this->getOffset());
        $this->cachedReader = $this->dataReader->withLimit($this->pageSize)->/** @scrutinizer ignore-call */ withOffset($this->getOffset());
        yield from $this->cachedReader->read();
        yield from $this->cachedReader->/** @scrutinizer ignore-call */ read();
    }

    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 withNextPageToken(?string $token): self
    {
        return $this->withCurrentPage((int)$token);
    }

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

    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 getTotalItems(): int
    {
        return $this->dataReader->count();
        return $this->dataReader->/** @scrutinizer ignore-call */ count();
    }

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

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


yiisoft / data

Push — master ( e9610e...a5c3f4 )

OffsetPaginator::read() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like