GenericLinks
class GenericLinks extends GroupedTagBuilder
Methods
Get the builder key.
Determine whether no 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.
Build links from a route attribute.
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 link definitions.
Build links from a named link alias.
Add or replace a link definition.
Get the ordered link definitions.
Normalize scalar and enum link attributes.
Details
at line 30
static string
key()
Get the builder key.
at line 118
TagBuilder
overlayOn(TagBuilder|null $base)
Overlay these links onto the lower layer.
at line 130
bool
isEmpty()
Determine whether no links are defined.
at line 38
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 48
static array
routeAttributeKeys()
Get the supported route attribute names.
at line 56
static TagBuilder|null
fromRouteAttribute(string $key, mixed $value)
Build links from a route attribute.
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 140
mixed
toHeadArray(ResolvedHead $head)
Get the links for the head array.
at line 150
array
toTags(ResolvedHead $head, TagRenderer $tags)
Render the link tags with stable ownership keys.
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 23
__construct(array $links = [])
Create the link definitions.
at line 78
static protected GenericLinks|null
fromAliasRouteAttribute(string $key, mixed $value)
Build links from a named link alias.
at line 98
GenericLinks
link(string $rel, string $href, array $attributes = [])
Add or replace a link definition.
at line 165
protected array
headArray()
Get the ordered link definitions.
at line 247
static protected array
attributes(array $values)
Normalize scalar and enum link attributes.