Lampager\Cake\PaginationResult

Complexity

Total Complexity

14

Size/Duplication

Total Lines	121
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	1

12 Methods

Rating	Name	Duplication	Size	Complexity
A	pagingParam()	0	3	1
A	jsonSerialize()	0	8	1
A	totalCount()	0	3	1
A	hasPrevPage()	0	3	1
A	currentPage()	0	3	1
A	__debugInfo()	0	5	1
A	perPage()	0	3	1
A	hasNextPage()	0	3	1
A	pageCount()	0	3	1
A	items()	0	7	2
A	count()	0	4	2
A	pagingParams()	0	10	1

<?php

declare(strict_types=1);

namespace Lampager\Cake;

use Cake\Datasource\Paging\PaginatedInterface;
use Countable;
use JsonSerializable;
use Lampager\PaginationResult as LampagerPaginationResult;

/**
 * Class PaginationResult
 */
class PaginationResult extends LampagerPaginationResult implements JsonSerializable, PaginatedInterface
{
    protected ?iterable $iterator = null;

    protected int $limit;

    /**
     * {@inheritdoc}
     */
    public function currentPage(): int
    {
        return 0;
    }

    /**
     * {@inheritdoc}
     */
    public function perPage(): int
    {
        return $this->limit;
    }

    /**
     * {@inheritdoc}
     */
    public function totalCount(): ?int
    {
        return null;
    }

    /**
     * {@inheritdoc}
     */
    public function pageCount(): ?int
    {
        return null;
    }

    /**
     * {@inheritdoc}
     */
    public function hasPrevPage(): bool
    {
        return (bool)$this->hasPrevious;
    }

    /**
     * {@inheritdoc}
     */
    public function hasNextPage(): bool
    {
        return (bool)$this->hasNext;
    }

    /**
     * {@inheritdoc}
     */
    public function items(): iterable
    {
        if (!$this->iterator) {
            $this->iterator = $this->getIterator();
        }

        return $this->iterator;
    }

    /**
     * {@inheritdoc}
     */
    public function pagingParam(string $name): mixed
    {
        return $this->pagingParams()[$name] ?? null;
    }

    /**
     * {@inheritdoc}
     */
    public function pagingParams(): array
    {
        return [
            'count' => $this->count(),
            'totalCount' => $this->totalCount(),

Are you sure the usage of $this->totalCount() targeting Lampager\Cake\PaginationResult::totalCount() seems to always return null.

            'perPage' => $this->perPage(),
            'pageCount' => $this->pageCount(),

Are you sure the usage of $this->pageCount() targeting Lampager\Cake\PaginationResult::pageCount() seems to always return null.

            'currentPage' => $this->currentPage(),
            'hasPrevPage' => $this->hasPrevPage(),
            'hasNextPage' => $this->hasNextPage(),
        ];
    }

    /**
     * {@inheritdoc}
     */
    public function jsonSerialize(): array
    {
        $array = get_object_vars($this);
        $array['records'] = iterator_to_array($this->items());
        unset($array['iterator']);
        unset($array['limit']);

        return $array;
    }

    /**
     * {@inheritdoc}
     */
    public function count(): int
    {
        $items = $this->items();
        return $items instanceof Countable ? count($items) : iterator_count($items);
    }

    /**
     * Returns an array that can be used to describe the internal state of this
     * object.
     */
    public function __debugInfo(): array
    {
        return [
            '(help)' => 'This is a Lampager Pagination Result object.',
        ] + $this->jsonSerialize();
    }
}