References SelectablePaginator
Reference
C
Class

ApiPlatform\Doctrine\Common\SelectablePaginator

class ApiPlatform\Doctrine\Common\SelectablePaginator implements IteratorAggregate, , Traversable, Countable, `<a href="/docs/main/references/State/Pagination/PartialPaginatorInterface">ApiPlatform\State\Pagination\PartialPaginatorInterface
{
    public __construct(array<string|int, ApiPlatform\Doctrine\Common\T> $selectable, float $currentPage, float $itemsPerPage)
    public getCurrentPage(): float
    public getLastPage(): float
    public getItemsPerPage(): float
    public getTotalItems(): float
    public count(): int
    public getIterator(): Traversable[]
}

Properties

selectable

Doctrine\Common\Collections\Selectable $selectable

Methods

__construct

public __construct(array<string|int, ApiPlatform\Doctrine\Common\T> $selectable, float $currentPage, float $itemsPerPage)

Parameters

selectablearray<string int, ApiPlatform\Doctrine\Common\T>
currentPagefloat
itemsPerPagefloat

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

count

public count(): int

Returns

int

getIterator

public getIterator(): Traversable[]

Returns

Traversable[]

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