ApiPlatform\Doctrine\Orm\Paginator

Decorates the Doctrine ORM paginator.

class ApiPlatform\Doctrine\Orm\Paginator extends implements IteratorAggregate, `<a href="/docs/main/references/State/Pagination/PartialPaginatorInterface">ApiPlatform\State\Pagination\PartialPaginatorInterface</a>`, Traversable, Countable, `<a href="/docs/main/references/State/Pagination/PaginatorInterface">ApiPlatform\State\Pagination\PaginatorInterface</a>`, `<a href="/docs/main/references/Doctrine/Orm/QueryAwareInterface">ApiPlatform\Doctrine\Orm\QueryAwareInterface</a>`, `<a href="/docs/main/references/State/Pagination/HasNextPagePaginatorInterface">ApiPlatform\State\Pagination\HasNextPagePaginatorInterface
{
    public getLastPage(): float
    public getTotalItems(): float
    public getQuery(): Doctrine\ORM\Query
    public hasNextPage(): bool
    public setDoctrinePaginatorFactory(null|ApiPlatform\Doctrine\Orm\Extension\DoctrinePaginatorFactory $doctrinePaginatorFactory): null
    public __construct(Doctrine\ORM\Tools\Pagination\Paginator $paginator)
    public getCurrentPage(): float
    public getItemsPerPage(): float
    public getIterator(): Traversable
    public count(): int
}

Properties

paginator

Doctrine\ORM\Tools\Pagination\Paginator $paginator

iterator

Traversable|array $iterator

firstResult

int $firstResult

maxResults

int $maxResults

Methods

getLastPage

Gets last page.

public getLastPage(): float

Returns

float

getTotalItems

Gets the number of items in the whole collection.

public getTotalItems(): float

Returns

float

getQuery

Gets the Query object that will actually be executed.This should allow configuring options which could only be set on the Query object itself.

public getQuery(): Doctrine\ORM\Query

Returns

Doctrine\ORM\Query

hasNextPage

Does this collection offer a next page.

public hasNextPage(): bool

Returns

bool

setDoctrinePaginatorFactory

public setDoctrinePaginatorFactory(null|ApiPlatform\Doctrine\Orm\Extension\DoctrinePaginatorFactory $doctrinePaginatorFactory): null

Parameters

doctrinePaginatorFactory

`ApiPlatform\Doctrine\Orm\Extension\DoctrinePaginatorFactory`

Returns

null