References Paginator
Reference
C
Class

ApiPlatform\Doctrine\Odm\Paginator

Decorates the Doctrine MongoDB ODM paginator.

class ApiPlatform\Doctrine\Odm\Paginator implements IteratorAggregate, , `<a href="/docs/main/references/State/Pagination/HasNextPagePaginatorInterface">ApiPlatform\State\Pagination\HasNextPagePaginatorInterface</a>`, Traversable, Countable, `<a href="/docs/main/references/State/Pagination/PartialPaginatorInterface">ApiPlatform\State\Pagination\PartialPaginatorInterface
{
    public __construct(Doctrine\ODM\MongoDB\Iterator\Iterator $mongoDbOdmIterator, Doctrine\ODM\MongoDB\UnitOfWork $unitOfWork, string $resourceClass, array $pipeline)
    public getCurrentPage(): float
    public getLastPage(): float
    public getItemsPerPage(): float
    public getTotalItems(): float
    public getIterator(): Traversable
    public count(): int
    public hasNextPage(): bool
}

Methods

__construct

public __construct(Doctrine\ODM\MongoDB\Iterator\Iterator $mongoDbOdmIterator, Doctrine\ODM\MongoDB\UnitOfWork $unitOfWork, string $resourceClass, array $pipeline)

Parameters

mongoDbOdmIteratorDoctrine\ODM\MongoDB\Iterator\Iterator
unitOfWorkDoctrine\ODM\MongoDB\UnitOfWork
resourceClassstring
pipelinearray

getCurrentPage

Gets the current page number.Gets the current page number.

public getCurrentPage(): float

Returns

float

getLastPage

Gets last page.

public getLastPage(): float

Returns

float

getItemsPerPage

Gets the number of items by page.Gets the number of items by page.

public getItemsPerPage(): float

Returns

float

getTotalItems

Gets the number of items in the whole collection.

public getTotalItems(): float

Returns

float

getIterator

public getIterator(): Traversable

Returns

Traversable

count

public count(): int

Returns

int

hasNextPage

Does this collection offer a next page.

public hasNextPage(): bool

Returns

bool

Made with love by

Les-Tilleuls.coop can help you design and develop your APIs and web projects, and train your teams in API Platform, Symfony, Next.js, Kubernetes and a wide range of other technologies.

Learn more

Copyright © 2023 Kévin Dunglas

Sponsored by Les-Tilleuls.coop