1. class
  2. Hypervel
  3. \
  4. Head
  5. \
  6. Tags
  7. \
  8. StringTagBuilder

StringTagBuilder

abstract class StringTagBuilder extends TagBuilder

A tag builder holding a single string value.

Methods

static string
key()

Get the unique name identifying this builder within the head.

from  TagBuilder
TagBuilder
overlayOn(TagBuilder|null $base)

Overlay this value onto the lower layer.

bool
isEmpty()

Determine whether no string value is defined.

static string
headArrayKey()

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

from  TagBuilder
static mixed
headArrayDefault()

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

from  TagBuilder
static array
routeAttributeKeys()

Get the route attribute keys this builder accepts values for.

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

Build a string tag from a route attribute.

static bool
rendersWhenEmpty(ResolvedHead $head)

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

from  TagBuilder
TagBuilder
asDefaults()

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

from  TagBuilder
mixed
toHeadArray(ResolvedHead $head)

Get the value for the head array.

array
toTags(ResolvedHead $head, TagRenderer $tags)

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

from  TagBuilder
static string|null
string(mixed $value)

Return the value when it is a string.

from  TagBuilder
static string|null
stringOrBackedEnum(mixed $value)

Resolve a string or string-backed enum value.

from  TagBuilder
static bool|null
bool(mixed $value)

Return the value when it is a boolean.

from  TagBuilder
static int|null
int(mixed $value)

Return the value when it is an integer.

from  TagBuilder
static array
items(mixed $value)

Normalize a route attribute value into a list of items.

from  TagBuilder
static array
named(array $values)

Filter an array down to its string-keyed values.

from  TagBuilder
__construct(string|null $value = null)

Create a tag with an optional string value.

static StringTagBuilder
make(string $value)

Create a tag from a string value.

string|null
render()

Get the tag value.

Details

in TagBuilder at line 17
abstract static string key()

Get the unique name identifying this builder within the head.

Return Value

string

at line 44
TagBuilder overlayOn(TagBuilder|null $base)

Overlay this value onto the lower layer.

Parameters

TagBuilder|null $base

Return Value

TagBuilder

at line 56
bool isEmpty()

Determine whether no string value is defined.

Return Value

bool

in TagBuilder at line 32
static string headArrayKey()

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

Return Value

string

in TagBuilder at line 40
static mixed headArrayDefault()

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

Return Value

mixed

in TagBuilder at line 50
static array routeAttributeKeys()

Get the route attribute keys this builder accepts values for.

Return Value

array

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

Build a string tag from a route attribute.

Parameters

string $key
mixed $value

Return Value

TagBuilder|null

in TagBuilder 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

in TagBuilder at line 74
TagBuilder asDefaults()

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

Return Value

TagBuilder

at line 72
mixed toHeadArray(ResolvedHead $head)

Get the value for the head array.

Parameters

ResolvedHead $head

Return Value

mixed

in TagBuilder 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

in TagBuilder 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

in TagBuilder 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

in TagBuilder 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

in TagBuilder 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

in TagBuilder 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

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

Filter an array down to its string-keyed values.

Parameters

array $values

Return Value

array

at line 19
__construct(string|null $value = null)

Create a tag with an optional string value.

Parameters

string|null $value

at line 26
static StringTagBuilder make(string $value)

Create a tag from a string value.

Parameters

string $value

Return Value

StringTagBuilder

at line 64
string|null render()

Get the tag value.

Return Value

string|null