cerbero90 / lazy-json-pages

src/Paginations/AnyPagination.php

<?php

declare(strict_types=1);

namespace Cerbero\LazyJsonPages\Paginations;

use Cerbero\LazyJsonPages\Exceptions\UnsupportedPaginationException;
use Traversable;

/**
 * The aggregator of supported paginations.
 */
class AnyPagination extends Pagination
{
    /**
     * The supported paginations.
     *
     * @var class-string<Pagination>[]

The doc comment class-string<Pagination>[] at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string<Pagination>[].

     */
    protected array $supportedPaginations = [
        CursorAwarePagination::class,
        CustomPagination::class,

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

        LastPageAwarePagination::class,
        LinkHeaderAwarePagination::class,
        TotalItemsAwarePagination::class,
        TotalPagesAwarePagination::class,
    ];

    /**
     * Yield the paginated items.
     *
     * @return Traversable<int, mixed>
     * @throws UnsupportedPaginationException
     */
    public function getIterator(): Traversable
    {
        // yield only items and not indexes to ensure incremental indexes
        // otherwise the actual indexes always start from 0 on every page
        foreach ($this->matchingPagination() as $item) {
            yield $item;
        }
    }

    /**
     * Retrieve the pagination matching with the configuration.
     */
    protected function matchingPagination(): Pagination
    {
        foreach ($this->supportedPaginations as $class) {
            $pagination = new $class($this->source, $this->client, $this->config);

            if ($pagination->matches()) {
                return $pagination;
            }
        }

        throw new UnsupportedPaginationException($this->config);
    }
}