cerbero90 / lazy-json-pages

src/Concerns/YieldsItemsByLength.php

<?php

declare(strict_types=1);

namespace Cerbero\LazyJsonPages\Concerns;

use Cerbero\LazyJsonPages\Exceptions\InvalidKeyException;
use Closure;
use Generator;
use Psr\Http\Message\ResponseInterface;

/**
 * The trait to yield items from length-aware paginations.
 */
trait YieldsItemsByLength
{
    use SendsAsyncRequests;

    /**
     * Yield paginated items until the page resolved from the given key is reached.
     *
     * @param ?Closure(int): int $callback
     * @return Generator<int, mixed>
     */
    protected function yieldItemsUntilKey(string $key, ?Closure $callback = null): Generator
    {
        yield from $this->yieldItemsUntilPage(function (ResponseInterface $response) use ($key, $callback) {
            yield from $generator = $this->yieldItemsAndGetKey($response, $key);

The method yieldItemsAndGetKey() does not exist on Cerbero\LazyJsonPages\Concerns\YieldsItemsByLength. Did you maybe mean yieldItemsUntilKey()?

            if (!is_int($page = $this->toPage($generator->getReturn()))) {

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

                throw new InvalidKeyException($key);
            }

            return $callback ? $callback($page) : $page;
        });
    }

    /**
     * Yield paginated items until the resolved page is reached.
     *
     * @param Closure(ResponseInterface): Generator<int, mixed> $callback
     * @return Generator<int, mixed>
     */
    protected function yieldItemsUntilPage(Closure $callback): Generator
    {
        yield from $generator = $callback($this->source->pullResponse());

        /** @var int */
        $totalPages = $generator->getReturn();

        foreach ($this->fetchPagesAsynchronously($totalPages) as $response) {
            yield from $this->yieldItemsFrom($response);

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

        }
    }
}