b2pweb / bdf-prime

src/Query/Extension/PaginableTrait.php

<?php

namespace Bdf\Prime\Query\Extension;

use Bdf\Prime\Query\Contract\Paginable;
use Bdf\Prime\Query\Pagination\PaginatorFactory;
use Bdf\Prime\Query\Pagination\PaginatorInterface;
use Bdf\Prime\Query\Pagination\Walker;

/**
 * Trait for @see Paginable queries
 *
 * @template R as array|object
 * @psalm-require-implements Paginable
 */
trait PaginableTrait
{
    /**
     * @var PaginatorFactory|null
     */
    private $paginatorFactory;

    /**
     * @param PaginatorFactory $paginatorFactory
     */
    public function setPaginatorFactory(PaginatorFactory $paginatorFactory): void
    {
        $this->paginatorFactory = $paginatorFactory;
    }

    /**
     * {@inheritdoc}
     *
     * @return Walker<R>
     */
    public function getIterator(): \Iterator
    {
        return $this->walk();

The expression return $this->walk() returns the type Bdf\Prime\Query\Pagination\PaginatorInterface which is incompatible with the type-hinted return Iterator.

    }

    /**
     * {@inheritdoc}
     *
     * @see Paginable::paginate()
     * @psalm-suppress LessSpecificImplementedReturnType
     *
     * @return PaginatorInterface<R>
     */
    public function paginate(?int $maxRows = null, ?int $page = null, string $className = 'paginator'): PaginatorInterface
    {
        $factory = $this->paginatorFactory ?? PaginatorFactory::instance();

        return $factory->create($this, $className, $maxRows, $page);

$this of type Bdf\Prime\Query\Extension\PaginableTrait is incompatible with the type Bdf\Prime\Query\ReadCommandInterface expected by parameter $query of Bdf\Prime\Query\Pagination\PaginatorFactory::create().

    }

    /**
     * {@inheritdoc}
     *
     * @see Paginable::walk()
     * @psalm-suppress LessSpecificImplementedReturnType
     *
     * @return Walker<R>
     */
    public function walk(?int $maxRows = null, ?int $page = null): PaginatorInterface
    {
        return $this->paginate($maxRows, $page, 'walker');
    }
}