GroupedTagBuilder
abstract class GroupedTagBuilder extends TagBuilder
Methods
Merge this builder over the given base builder, preferring this builder's values.
Get the dot-notated key this builder occupies in the Head::toArray() result.
Grouped tag builders are represented as an empty array when absent from the Head::toArray() result.
Get the route attribute keys this builder accepts values for.
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.
Convert this builder into the HTML tags rendered by @head.
Resolve a string or string-backed enum value.
Normalize a route attribute value into a list of items.
Details
in
TagBuilder at line 17
abstract static string
key()
Get the unique name identifying this builder within the head.
in
TagBuilder at line 22
abstract TagBuilder
overlayOn(TagBuilder|null $base)
Merge this builder over the given base builder, preferring this builder's values.
in
TagBuilder at line 27
abstract bool
isEmpty()
Determine whether the builder has no data.
in
TagBuilder at line 32
static string
headArrayKey()
Get the dot-notated key this builder occupies in the Head::toArray() result.
at line 13
static mixed
headArrayDefault()
Grouped tag builders are represented as an empty array when absent from the Head::toArray() result.
in
TagBuilder at line 50
static array
routeAttributeKeys()
Get the route attribute keys this builder accepts values for.
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.
in
TagBuilder at line 82
mixed
toHeadArray(ResolvedHead $head)
Convert this builder into its Head::toArray() value.
in
TagBuilder at line 92
array
toTags(ResolvedHead $head, TagRenderer $tags)
Convert this builder into the HTML tags rendered by @head.
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.