final class PaginationConfigDefinition extends AbstractConfigDefinition (View source)

Collects pagination defaults contributed by an application or module.

Properties

protected mixed[] $data from  AbstractConfigDefinition

Methods

set(string $path, mixed $value)

Replaces one configuration value at a dot-separated path.

append(string $path, mixed $value)

Appends one configuration value at a dot-separated list path.

create()

Starts an empty pagination configuration definition.

static string

Identifies the configuration section handled by this definition.

string
defaultPerPage(int $defaultPerPage)

Sets the page size used when a caller does not provide one.

maxPerPage(int $maxPerPage)

Sets the largest page size accepted from a caller.

visiblePages(int $visiblePages)

Sets the number of page links displayed by the default renderer.

showFirstLast(bool $showFirstLast = true)

Enables or disables first and last page links in the default renderer.

classes(array $classes)

Sets renderer class overrides keyed by the renderer's supported elements.

Details

toArray

No description

Return Value

array

fromArrayData

final static AbstractConfigDefinition fromArrayData(array $data)

No description

Parameters

array $data

Return Value

AbstractConfigDefinition

set

protected AbstractConfigDefinition set(string $path, mixed $value)

Replaces one configuration value at a dot-separated path.

Parameters

string $path
mixed $value

Return Value

AbstractConfigDefinition

append

protected AbstractConfigDefinition append(string $path, mixed $value)

Appends one configuration value at a dot-separated list path.

Parameters

string $path
mixed $value

Return Value

AbstractConfigDefinition

create

Starts an empty pagination configuration definition.

moduleKey

static string moduleKey()

Identifies the configuration section handled by this definition.

Return Value

string

defaultPerPage

PaginationConfigDefinition defaultPerPage(int $defaultPerPage)

Sets the page size used when a caller does not provide one.

Parameters

int $defaultPerPage

Return Value

PaginationConfigDefinition

maxPerPage

PaginationConfigDefinition maxPerPage(int $maxPerPage)

Sets the largest page size accepted from a caller.

Parameters

int $maxPerPage

Return Value

PaginationConfigDefinition

visiblePages

PaginationConfigDefinition visiblePages(int $visiblePages)

Sets the number of page links displayed by the default renderer.

Parameters

int $visiblePages

Return Value

PaginationConfigDefinition

showFirstLast

PaginationConfigDefinition showFirstLast(bool $showFirstLast = true)

Enables or disables first and last page links in the default renderer.

Parameters

bool $showFirstLast

Return Value

PaginationConfigDefinition

classes

PaginationConfigDefinition classes(array $classes)

Sets renderer class overrides keyed by the renderer's supported elements.

Parameters

array $classes

Return Value

PaginationConfigDefinition