abstract class TagBuilder implements Transient

Methods

static string
key()

Get the unique name identifying this builder within the head.

overlayOn(TagBuilder|null $base)

Merge this builder over the given base builder, preferring this builder's values.

bool
isEmpty()

Determine whether the builder has no data.

static string
headArrayKey()

Get the dot-notated key this builder occupies in the Head::toArray() result.

static mixed
headArrayDefault()

Get the value used in Head::toArray() when this builder has no data.

static array
routeAttributeKeys()

Get the route attribute keys this builder accepts values for.

static TagBuilder|null
fromRouteAttribute(string $key, mixed $value)

Create a builder from a route attribute value, or null when the value is invalid.

static bool
rendersWhenEmpty(ResolvedHead $head)

Determine if the builder should render even when no data was set.

asDefaults()

Mark the builder's data as belonging to the defaults layer.

mixed
toHeadArray(ResolvedHead $head)

Convert this builder into its Head::toArray() value.

array
toTags(ResolvedHead $head, TagRenderer $tags)

Convert this builder into the HTML tags rendered by @head.

static string|null
string(mixed $value)

Return the value when it is a string.

static string|null
stringOrBackedEnum(mixed $value)

Resolve a string or string-backed enum value.

static bool|null
bool(mixed $value)

Return the value when it is a boolean.

static int|null
int(mixed $value)

Return the value when it is an integer.

static array
items(mixed $value)

Normalize a route attribute value into a list of items.

static array
named(array $values)

Filter an array down to its string-keyed values.

Details

at line 17
abstract static string key()

Get the unique name identifying this builder within the head.

Return Value

string

at line 22
abstract TagBuilder overlayOn(TagBuilder|null $base)

Merge this builder over the given base builder, preferring this builder's values.

Parameters

TagBuilder|null $base

Return Value

TagBuilder

at line 27
abstract bool isEmpty()

Determine whether the builder has no data.

Return Value

bool

at line 32
static string headArrayKey()

Get the dot-notated key this builder occupies in the Head::toArray() result.

Return Value

string

at line 40
static mixed headArrayDefault()

Get the value used in Head::toArray() when this builder has no data.

Return Value

mixed

at line 50
static array routeAttributeKeys()

Get the route attribute keys this builder accepts values for.

Return Value

array

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.

Parameters

string $key
mixed $value

Return Value

TagBuilder|null

at line 66
static bool rendersWhenEmpty(ResolvedHead $head)

Determine if the builder should render even when no data was set.

Parameters

ResolvedHead $head

Return Value

bool

at line 74
TagBuilder asDefaults()

Mark the builder's data as belonging to the defaults layer.

Return Value

TagBuilder

at line 82
mixed toHeadArray(ResolvedHead $head)

Convert this builder into its Head::toArray() value.

Parameters

ResolvedHead $head

Return Value

mixed

at line 92
array toTags(ResolvedHead $head, TagRenderer $tags)

Convert this builder into the HTML tags rendered by @head.

Parameters

ResolvedHead $head
TagRenderer $tags

Return Value

array

at line 100
static protected string|null string(mixed $value)

Return the value when it is a string.

Parameters

mixed $value

Return Value

string|null

at line 108
static protected string|null stringOrBackedEnum(mixed $value)

Resolve a string or string-backed enum value.

Parameters

mixed $value

Return Value

string|null

at line 124
static protected bool|null bool(mixed $value)

Return the value when it is a boolean.

Parameters

mixed $value

Return Value

bool|null

at line 132
static protected int|null int(mixed $value)

Return the value when it is an integer.

Parameters

mixed $value

Return Value

int|null

at line 142
static protected array items(mixed $value)

Normalize a route attribute value into a list of items.

Parameters

mixed $value

Return Value

array

at line 153
static protected array named(array $values)

Filter an array down to its string-keyed values.

Parameters

array $values

Return Value

array