Api Platform conference
Register now
References ArrayPaginator
API Platform Conference
September 19-20, 2024 | Lille & online

The international conference on the API Platform Framework

API Platform Conference 2024: meet the best PHP, JavaScript and API experts

Learn more about the event, register for the conference, and get ready for two days of inspiration, ideas, and knowledge-sharing with our incredible lineup of renowned specialists and advocates.

Register now
Reference
C
Class

ApiPlatform\State\Pagination\ArrayPaginator

Paginator for arrays.

class ApiPlatform\State\Pagination\ArrayPaginator implements IteratorAggregate, , `<a href="/docs/references/State/Pagination/HasNextPagePaginatorInterface">ApiPlatform\State\Pagination\HasNextPagePaginatorInterface</a>`, Traversable, Countable, `<a href="/docs/references/State/Pagination/PartialPaginatorInterface">ApiPlatform\State\Pagination\PartialPaginatorInterface
{
    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
    public hasNextPage(): bool
}

Methods

__construct

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

Parameters

resultsarray
firstResultint
maxResultsint

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

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