Cerbero\LazyJsonPages\Paginations\TotalItemsAwarePagination

Complexity

Total Complexity

5

Size/Duplication

Total Lines	24
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	matches()	0	5	3
A	getIterator()	0	5	2

<?php

declare(strict_types=1);

namespace Cerbero\LazyJsonPages\Paginations;

use Cerbero\LazyJsonPages\Concerns\YieldsItemsByLength;
use Traversable;

/**
 * The pagination aware of the total number of items.
 */
class TotalItemsAwarePagination extends Pagination
{
    use YieldsItemsByLength;

The trait Cerbero\LazyJsonPages\Concerns\YieldsItemsByLength requires some properties which are not provided by Cerbero\LazyJsonPages\Paginations\TotalItemsAwarePagination: $attempts, $backoff, $firstPage, $async, $rateLimits

    /**
     * Determine whether this pagination matches the configuration.
     */
    public function matches(): bool
    {
        return $this->config->totalItemsKey !== null
            && $this->config->totalPagesKey === null
            && $this->config->lastPageKey === null;
    }

    /**
     * Yield the paginated items.
     *
     * @return Traversable<int, mixed>
     */
    public function getIterator(): Traversable
    {
        /** @phpstan-ignore-next-line */
        yield from $this->yieldItemsUntilKey($this->config->totalItemsKey, function (int $totalItems) {

It seems like $this->config->totalItemsKey can also be of type null; however, parameter $key of Cerbero\LazyJsonPages\Paginations\TotalItemsAwarePagination::yieldItemsUntilKey() does only seem to accept string, maybe add an additional type check?

            return $this->itemsPerPage > 0 ? (int) ceil($totalItems / $this->itemsPerPage) : 0;
        });
    }
}