Robots
class Robots extends StringTagBuilder
Methods
Get the builder key.
Get the dot-notated key this builder occupies in the Head::toArray() result.
Get the value used in Head::toArray() when this builder has no data.
Get the route attribute keys this builder accepts values for.
Build robots directives 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 a tag with an optional string value.
Create a robots tag from directives.
Normalize robots directives into a comma-separated value.
Details
at line 16
static string
key()
Get the builder key.
in
StringTagBuilder at line 44
TagBuilder
overlayOn(TagBuilder|null $base)
Overlay this value onto the lower layer.
in
StringTagBuilder at line 56
bool
isEmpty()
Determine whether no string value is defined.
in
TagBuilder at line 32
static string
headArrayKey()
Get the dot-notated key this builder occupies in the Head::toArray() result.
in
TagBuilder at line 40
static mixed
headArrayDefault()
Get the value used in Head::toArray() when this builder has no data.
in
TagBuilder at line 50
static array
routeAttributeKeys()
Get the route attribute keys this builder accepts values for.
at line 34
static TagBuilder|null
fromRouteAttribute(string $key, mixed $value)
Build robots directives 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.
in
StringTagBuilder at line 72
mixed
toHeadArray(ResolvedHead $head)
Get the value for the head array.
at line 58
array
toTags(ResolvedHead $head, TagRenderer $tags)
Render the robots meta tag.
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.
in
StringTagBuilder at line 19
__construct(string|null $value = null)
Create a tag with an optional string value.
at line 26
static StringTagBuilder
make(string|RobotsRule|array $directives)
Create a robots tag from directives.
in
StringTagBuilder at line 64
string|null
render()
Get the tag value.
at line 68
static protected string
renderDirectives(string|RobotsRule|array $directives)
Normalize robots directives into a comma-separated value.