cerbero90 / lazy-json-pages

src/Paginations/LinkHeaderAwarePagination.php

<?php

declare(strict_types=1);

namespace Cerbero\LazyJsonPages\Paginations;

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

/**
 * The pagination using a Link header.
 */
class LinkHeaderAwarePagination extends Pagination
{
    use YieldsItemsByCursor;

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

    use YieldsItemsByLength;

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

    /**
     * The Link header format.
     */
    public const FORMAT = '~<\s*(?<uri>[^\s>]+)\s*>.*?"\s*(?<rel>[^\s"]+)\s*"~';

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

    /**
     * Yield the paginated items.
     *
     * @return Traversable<int, mixed>
     */
    public function getIterator(): Traversable
    {
        /** @var array{last?: int, next?: string|int} */
        $links = $this->parseLinkHeader($this->source->response()->getHeaderLine('link'));

        yield from match (true) {
            isset($links['last']) => $this->yieldItemsByLastPage($links['last']),
            isset($links['next']) => $this->yieldItemsByNextLink(),
            default => $this->yieldItemsFrom($this->source->pullResponse()),
        };
    }

    /**
     * Retrieve the parsed Link header.
     *
     * @template TRelation of string|null
     *
     * @param TRelation $relation

The type Cerbero\LazyJsonPages\Paginations\TRelation was not found. Maybe you did not declare it correctly or list all dependencies?

     * @return (TRelation is null ? array<string, int|string|null> : string|int|null)

The doc comment (TRelation at position 1 could not be parsed: Expected ')' at position 1, but found 'TRelation'.

     */
    protected function parseLinkHeader(string $linkHeader, ?string $relation = null): array|string|int|null
    {
        $links = [];

        preg_match_all(static::FORMAT, $linkHeader, $matches, PREG_SET_ORDER);

        foreach ($matches as $match) {
            $links[$match['rel']] = $this->toPage($match['uri'], $match['rel'] != 'next');
        }

        return $relation ? ($links[$relation] ?? null) : $links;
    }

    /**
     * Yield the paginated items by the given last page.
     *
     * @return Generator<int, mixed>
     */
    protected function yieldItemsByLastPage(int $lastPage): Generator
    {
        yield from $this->yieldItemsUntilPage(function (ResponseInterface $response) use ($lastPage) {
            yield from $this->yieldItemsFrom($response);

            return $this->config->firstPage === 0 ? $lastPage + 1 : $lastPage;
        });
    }

    /**
     * Yield the paginated items by the given next link.
     *
     * @return Generator<int, mixed>
     */
    protected function yieldItemsByNextLink(): Generator
    {
        yield from $this->yieldItemsByCursor(function (ResponseInterface $response) {
            yield from $this->yieldItemsFrom($response);

            return $this->parseLinkHeader($response->getHeaderLine('link'), 'next');
        });
    }
}