Cerbero\LazyJsonPages\Paginations\CursorAwarePagination

Complexity

Total Complexity

5

Size/Duplication

Total Lines	27
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	matches()	0	6	4
A	getIterator()	0	7	1

<?php

declare(strict_types=1);

namespace Cerbero\LazyJsonPages\Paginations;

use Cerbero\LazyJsonPages\Concerns\YieldsItemsByCursor;
use Psr\Http\Message\ResponseInterface;
use Traversable;

/**
 * The pagination aware of the cursor of the next page.
 */
class CursorAwarePagination extends Pagination
{
    use YieldsItemsByCursor;

The trait Cerbero\LazyJsonPages\Concerns\YieldsItemsByCursor requires some properties which are not provided by Cerbero\LazyJsonPages\Paginations\CursorAwarePagination: $attempts, $backoff, $rateLimits

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

    /**
     * Yield the paginated items.
     *
     * @return Traversable<int, mixed>
     */
    public function getIterator(): Traversable
    {
        yield from $this->yieldItemsByCursor(function (ResponseInterface $response) {
            /** @phpstan-ignore-next-line */
            yield from $generator = $this->yieldItemsAndGetKey($response, $this->config->cursorKey);

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

            return $generator->getReturn();
        });
    }
}