ApiPlatform\State\Pagination\ArrayPaginator

Paginator for arrays.

class ApiPlatform\State\Pagination\ArrayPaginator 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(array $results, int $firstResult, int $maxResults)
    public getCurrentPage(): float
    public getLastPage(): float
    public getItemsPerPage(): float
    public getTotalItems(): float
    public count(): int
    public getIterator(): Traversable
}

class ApiPlatform\State\Pagination\ArrayPaginator 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(array $results, int $firstResult, int $maxResults)
    public getCurrentPage(): float
    public getLastPage(): float
    public getItemsPerPage(): float
    public getTotalItems(): float
    public count(): int
    public getIterator(): Traversable
}

Methods

__construct

public __construct(array $results, int $firstResult, int $maxResults)

public __construct(array $results, int $firstResult, int $maxResults)

Parameters

results	array
firstResult	int
maxResults	int

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

count

public count(): int

public count(): int

Returns

int

getIterator

public getIterator(): Traversable

public getIterator(): Traversable

Returns

Traversable