ApiPlatform\State\Pagination\PaginationOptions

class ApiPlatform\State\Pagination\PaginationOptions
{
    public __construct(bool $paginationEnabled, string $paginationPageParameterName, bool $clientItemsPerPage, string $itemsPerPageParameterName, bool $paginationClientEnabled, string $paginationClientEnabledParameterName, int $itemsPerPage, null|int $maximumItemsPerPage, bool $partialPaginationEnabled, bool $clientPartialPaginationEnabled, string $partialPaginationParameterName)
    public isPaginationEnabled(): bool
    public getPaginationPageParameterName(): string
    public getClientItemsPerPage(): bool
    public getItemsPerPageParameterName(): string
    public getPaginationClientEnabled(): bool
    public isPaginationClientEnabled(): bool
    public getPaginationClientEnabledParameterName(): string
    public getItemsPerPage(): int
    public getMaximumItemsPerPage(): int
    public isPartialPaginationEnabled(): bool
    public isClientPartialPaginationEnabled(): bool
    public getPartialPaginationParameterName(): string
}

class ApiPlatform\State\Pagination\PaginationOptions
{
    public __construct(bool $paginationEnabled, string $paginationPageParameterName, bool $clientItemsPerPage, string $itemsPerPageParameterName, bool $paginationClientEnabled, string $paginationClientEnabledParameterName, int $itemsPerPage, null|int $maximumItemsPerPage, bool $partialPaginationEnabled, bool $clientPartialPaginationEnabled, string $partialPaginationParameterName)
    public isPaginationEnabled(): bool
    public getPaginationPageParameterName(): string
    public getClientItemsPerPage(): bool
    public getItemsPerPageParameterName(): string
    public getPaginationClientEnabled(): bool
    public isPaginationClientEnabled(): bool
    public getPaginationClientEnabledParameterName(): string
    public getItemsPerPage(): int
    public getMaximumItemsPerPage(): int
    public isPartialPaginationEnabled(): bool
    public isClientPartialPaginationEnabled(): bool
    public getPartialPaginationParameterName(): string
}

Methods

__construct

public __construct(bool $paginationEnabled, string $paginationPageParameterName, bool $clientItemsPerPage, string $itemsPerPageParameterName, bool $paginationClientEnabled, string $paginationClientEnabledParameterName, int $itemsPerPage, null|int $maximumItemsPerPage, bool $partialPaginationEnabled, bool $clientPartialPaginationEnabled, string $partialPaginationParameterName)

public __construct(bool $paginationEnabled, string $paginationPageParameterName, bool $clientItemsPerPage, string $itemsPerPageParameterName, bool $paginationClientEnabled, string $paginationClientEnabledParameterName, int $itemsPerPage, null|int $maximumItemsPerPage, bool $partialPaginationEnabled, bool $clientPartialPaginationEnabled, string $partialPaginationParameterName)

Parameters

paginationEnabled	bool
paginationPageParameterName	string
clientItemsPerPage	bool
itemsPerPageParameterName	string
paginationClientEnabled	bool
paginationClientEnabledParameterName	string
itemsPerPage	int
maximumItemsPerPage	int
partialPaginationEnabled	bool
clientPartialPaginationEnabled	bool
partialPaginationParameterName	string

isPaginationEnabled

public isPaginationEnabled(): bool

public isPaginationEnabled(): bool

Returns

bool

getPaginationPageParameterName

public getPaginationPageParameterName(): string

public getPaginationPageParameterName(): string

Returns

string

getClientItemsPerPage

public getClientItemsPerPage(): bool

public getClientItemsPerPage(): bool

Returns

bool

getItemsPerPageParameterName

public getItemsPerPageParameterName(): string

public getItemsPerPageParameterName(): string

Returns

string

getPaginationClientEnabled

public getPaginationClientEnabled(): bool

public getPaginationClientEnabled(): bool

Returns

bool

isPaginationClientEnabled

public isPaginationClientEnabled(): bool

public isPaginationClientEnabled(): bool

Returns

bool

getPaginationClientEnabledParameterName

public getPaginationClientEnabledParameterName(): string

public getPaginationClientEnabledParameterName(): string

Returns

string

getItemsPerPage

public getItemsPerPage(): int

public getItemsPerPage(): int

Returns

int

getMaximumItemsPerPage

public getMaximumItemsPerPage(): int

public getMaximumItemsPerPage(): int

Returns

int

isPartialPaginationEnabled

public isPartialPaginationEnabled(): bool

public isPartialPaginationEnabled(): bool

Returns

bool

isClientPartialPaginationEnabled

public isClientPartialPaginationEnabled(): bool

public isClientPartialPaginationEnabled(): bool

Returns

bool

getPartialPaginationParameterName

public getPartialPaginationParameterName(): string

public getPartialPaginationParameterName(): string

Returns

string