Reference
C
Class

ApiPlatform\Doctrine\Odm\Paginator

Decorates the Doctrine MongoDB ODM paginator.

class ApiPlatform\Doctrine\Odm\Paginator implements IteratorAggregate, `<a href="/docs/reference/State/Pagination/PaginatorInterface">ApiPlatform\State\Pagination\PaginatorInterface</a>`, Traversable, Countable, `<a href="/docs/reference/State/Pagination/PartialPaginatorInterface">ApiPlatform\State\Pagination\PartialPaginatorInterface</a>`
{
    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
}
class ApiPlatform\Doctrine\Odm\Paginator implements IteratorAggregate, `<a href="/docs/reference/State/Pagination/PaginatorInterface">ApiPlatform\State\Pagination\PaginatorInterface</a>`, Traversable, Countable, `<a href="/docs/reference/State/Pagination/PartialPaginatorInterface">ApiPlatform\State\Pagination\PartialPaginatorInterface</a>`
{
    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
}

Methods

__construct

public __construct(Doctrine\ODM\MongoDB\Iterator\Iterator $mongoDbOdmIterator, Doctrine\ODM\MongoDB\UnitOfWork $unitOfWork, string $resourceClass, array $pipeline)
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
public getCurrentPage(): float

Returns

float

getLastPage

Gets last page.

public getLastPage(): float
public getLastPage(): float

Returns

float

getItemsPerPage

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

public getItemsPerPage(): float
public getItemsPerPage(): float

Returns

float

getTotalItems

Gets the number of items in the whole collection.

public getTotalItems(): float
public getTotalItems(): float

Returns

float

getIterator

public getIterator(): Traversable
public getIterator(): Traversable

Returns

Traversable

count

public count(): int
public count(): int

Returns

int

Copyright © 2023 Kévin Dunglas

Sponsored by Les-Tilleuls.coop