PaginationConfigDefinition
final class PaginationConfigDefinition extends AbstractConfigDefinition (View source)
Collects pagination defaults contributed by an application or module.
Properties
| protected mixed[] | $data | from AbstractConfigDefinition |
Methods
Replaces one configuration value at a dot-separated path.
Appends one configuration value at a dot-separated list path.
Starts an empty pagination configuration definition.
Identifies the configuration section handled by this definition.
Sets the page size used when a caller does not provide one.
Sets the largest page size accepted from a caller.
Sets the number of page links displayed by the default renderer.
Enables or disables first and last page links in the default renderer.
Sets renderer class overrides keyed by the renderer's supported elements.
Details
toArray
array
toArray()
No description
set
protected AbstractConfigDefinition
set(string $path, mixed $value)
Replaces one configuration value at a dot-separated path.
append
protected AbstractConfigDefinition
append(string $path, mixed $value)
Appends one configuration value at a dot-separated list path.
create
static PaginationConfigDefinition
create()
Starts an empty pagination configuration definition.
moduleKey
static string
moduleKey()
Identifies the configuration section handled by this definition.
defaultPerPage
PaginationConfigDefinition
defaultPerPage(int $defaultPerPage)
Sets the page size used when a caller does not provide one.
maxPerPage
PaginationConfigDefinition
maxPerPage(int $maxPerPage)
Sets the largest page size accepted from a caller.
visiblePages
PaginationConfigDefinition
visiblePages(int $visiblePages)
Sets the number of page links displayed by the default renderer.
showFirstLast
PaginationConfigDefinition
showFirstLast(bool $showFirstLast = true)
Enables or disables first and last page links in the default renderer.
classes
PaginationConfigDefinition
classes(array $classes)
Sets renderer class overrides keyed by the renderer's supported elements.