PaginationLinks
class PaginationLinks extends GroupedTagBuilder
Methods
Get the builder key.
Determine whether no pagination links are defined.
Get the key used in the head array.
Grouped tag builders are represented as an empty array when absent from the Head::toArray() result.
Get the supported route attribute names.
Create a builder from a route attribute value, or null when the value is invalid.
Determine if the builder should render even when no data was set.
Resolve a string or string-backed enum value.
Normalize a route attribute value into a list of items.
Create the pagination links.
Create previous and next links from a paginator.
Set a pagination link by relation.
Details
at line 29
static string
key()
Get the builder key.
at line 85
TagBuilder
overlayOn(TagBuilder|null $base)
Replace the lower layer's pagination links.
at line 94
bool
isEmpty()
Determine whether no pagination links are defined.
at line 37
static string
headArrayKey()
Get the key used in the head array.
in
GroupedTagBuilder at line 13
static mixed
headArrayDefault()
Grouped tag builders are represented as an empty array when absent from the Head::toArray() result.
at line 47
static array
routeAttributeKeys()
Get the supported route attribute names.
in
TagBuilder at line 58
static TagBuilder|null
fromRouteAttribute(string $key, mixed $value)
Create a builder from a route attribute value, or null when the value is invalid.
in
TagBuilder at line 66
static bool
rendersWhenEmpty(ResolvedHead $head)
Determine if the builder should render even when no data was set.
in
TagBuilder at line 74
TagBuilder
asDefaults()
Mark the builder's data as belonging to the defaults layer.
at line 104
mixed
toHeadArray(ResolvedHead $head)
Get the pagination links for the head array.
at line 114
array
toTags(ResolvedHead $head, TagRenderer $tags)
Render the pagination link tags.
in
TagBuilder at line 100
static protected string|null
string(mixed $value)
Return the value when it is a string.
in
TagBuilder at line 108
static protected string|null
stringOrBackedEnum(mixed $value)
Resolve a string or string-backed enum value.
in
TagBuilder at line 124
static protected bool|null
bool(mixed $value)
Return the value when it is a boolean.
in
TagBuilder at line 132
static protected int|null
int(mixed $value)
Return the value when it is an integer.
in
TagBuilder at line 142
static protected array
items(mixed $value)
Normalize a route attribute value into a list of items.
in
TagBuilder at line 153
static protected array
named(array $values)
Filter an array down to its string-keyed values.
at line 22
__construct(array $links = [])
Create the pagination links.
at line 57
static PaginationLinks
fromPaginator(Paginator|CursorPaginator $paginator)
Create previous and next links from a paginator.
at line 75
PaginationLinks
link(string $rel, string $href)
Set a pagination link by relation.