cerbero90 / lazy-json-pages

src/Concerns/YieldsItemsByCursor.php

<?php

declare(strict_types=1);

namespace Cerbero\LazyJsonPages\Concerns;

use Closure;
use Generator;
use Psr\Http\Message\ResponseInterface;

/**
 * The trait to yield items from cursor-aware paginations.
 */
trait YieldsItemsByCursor
{
    use RespectsRateLimits;
    use RetriesHttpRequests;

    /**
     * Yield the paginated items by following the cursor of each page.
     *
     * @param Closure(ResponseInterface): Generator<int, mixed> $callback
     * @return Generator<int, mixed>
     */
    protected function yieldItemsByCursor(Closure $callback): Generator
    {
        $request = clone $this->source->request();

        yield from $generator = $callback($this->source->pullResponse());

        yield from $this->retry(function () use ($callback, $request, $generator) {
            while ($cursor = $this->toPage($generator->getReturn(), onlyNumerics: false)) {

It seems like toPage() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                $this->respectRateLimits();

                $uri = $this->uriForPage($request->getUri(), (string) $cursor);

It seems like uriForPage() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                $response = $this->client->send($request->withUri($uri));

                yield from $generator = $callback($response);
            }
        });
    }
}