1. class
  2. Hypervel
  3. \
  4. View
  5. \
  6. ComponentAttributeBag

ComponentAttributeBag

class ComponentAttributeBag implements Arrayable, ArrayAccess, IteratorAggregate, JsonSerializable, Htmlable, Stringable

Traits

Conditionable
InteractsWithData
Macroable

Properties

static protected array $macros

The registered string macros.

 from  Macroable
protected array $attributes

The raw array of attributes.

Methods

mixed
when(mixed $value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) truthy.

from  Conditionable
mixed
unless(mixed $value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) falsy.

from  Conditionable
array
all(mixed $keys = null)

Get all the attribute values.

mixed
data(string|null $key = null, mixed $default = null)

Retrieve data from the instance.

bool
exists(array|string $key)

Determine if the data contains a given key.

from  InteractsWithData
bool
has(array|string $key)

Determine if the data contains a given key.

from  InteractsWithData
bool
hasAny(array|string $keys)

Determine if the instance contains any of the given keys.

from  InteractsWithData
mixed
whenHas(string $key, callable $callback, callable|null $default = null)

Apply the callback if the instance contains the given key.

from  InteractsWithData
bool
filled(array|string $key)

Determine if the instance contains a non-empty value for the given key.

from  InteractsWithData
bool
isNotFilled(array|string $key)

Determine if the instance contains an empty value for the given key.

from  InteractsWithData
bool
anyFilled(array|string $keys)

Determine if the instance contains a non-empty value for any of the given keys.

from  InteractsWithData
mixed
whenFilled(string $key, callable $callback, callable|null $default = null)

Apply the callback if the instance contains a non-empty value for the given key.

from  InteractsWithData
mixed
whenEnum(string $key, string $enumClass, callable $callback, callable|null $default = null)

Apply the callback if the instance contains a valid enum value for the given key.

from  InteractsWithData
bool
missing(array|string $key)

Determine if the instance is missing a given key.

from  InteractsWithData
mixed
whenMissing(string $key, callable $callback, callable|null $default = null)

Apply the callback if the instance is missing the given key.

from  InteractsWithData
bool
isEmptyString(string $key)

Determine if the given key is an empty string for "filled".

from  InteractsWithData
Stringable
str(string $key, mixed $default = null, bool $strict = false)

Retrieve data from the instance as a Stringable instance.

from  InteractsWithData
Stringable
string(string $key, mixed $default = null, bool $strict = false)

Retrieve data from the instance as a Stringable instance.

from  InteractsWithData
bool|null
boolean(string|null $key = null, Closure|bool|null $default = false, bool $strict = false)

Retrieve data as a boolean value.

from  InteractsWithData
int|null
integer(string $key, Closure|int|null $default = 0, bool $strict = false)

Retrieve data as an integer value.

from  InteractsWithData
float|null
float(string $key, Closure|float|null $default = 0.0, bool $strict = false)

Retrieve data as a float value.

from  InteractsWithData
int|float
clamp(string $key, int|float $min, int|float $max, int|float $default = 0)

Retrieve data clamped between min and max values.

from  InteractsWithData
CarbonInterface|null
date(string $key, string|null $format = null, UnitEnum|string|null $tz = null)

Retrieve data from the instance as a Carbon instance.

from  InteractsWithData
CarbonInterval|null
interval(string $key, Unit|string|null $unit = null)

Retrieve data from the instance as a CarbonInterval instance.

from  InteractsWithData
mixed
enum(string $key, string $enumClass, mixed $default = null)

Retrieve data from the instance as an enum.

from  InteractsWithData
array
enums(string $key, string $enumClass)

Retrieve data from the instance as an array of enums.

from  InteractsWithData
array
array(array|string|null $key = null)

Retrieve data from the instance as an array.

from  InteractsWithData
Collection
collect(array|string|null $key = null)

Retrieve data from the instance as a collection.

from  InteractsWithData
ComponentAttributeBag
only(mixed $keys)

Only include the given attribute from the attribute array.

ComponentAttributeBag
except(mixed $keys)

Exclude the given attribute from the attribute array.

static void
macro(string $name, callable|object $macro)

Register a custom macro.

from  Macroable
static void
mixin(object $mixin, bool $replace = true)

Mix another object into the class.

from  Macroable
static bool
hasMacro(string $name)

Check if macro is registered.

from  Macroable
static void
flushMacros()

Flush the existing macros.

from  Macroable
static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
mixed
__call(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
__construct(array $attributes = [])

Create a new component attribute bag instance.

mixed
first(mixed $default = null)

Get the first attribute's value.

mixed
get(string $key, mixed $default = null)

Get a given attribute from the attribute array.

ComponentAttributeBag
filter(callable $callback)

Filter the attributes, returning a bag of attributes that pass the filter.

ComponentAttributeBag
whereStartsWith(string|array $needles)

Return a bag of attributes that have keys starting with the given value / pattern.

ComponentAttributeBag
whereDoesntStartWith(string|array $needles)

Return a bag of attributes with keys that do not start with the given value / pattern.

ComponentAttributeBag
thatStartWith(string|array $needles)

Return a bag of attributes that have keys starting with the given value / pattern.

ComponentAttributeBag
onlyProps(mixed $keys)

Only include the given attribute from the attribute array.

ComponentAttributeBag
exceptProps(mixed $keys)

Exclude the given attribute from the attribute array.

ComponentAttributeBag
class(mixed $classList)

Conditionally merge classes into the attribute bag.

ComponentAttributeBag
style(mixed $styleList)

Conditionally merge styles into the attribute bag.

ComponentAttributeBag
merge(array $attributeDefaults = [], bool $escape = true)

Merge additional attributes / values into the attribute bag.

bool
shouldEscapeAttributeValue(bool $escape, mixed $value)

Determine if the specific attribute value should be escaped.

AppendableAttributeValue
prepends(mixed $value)

Create a new appendable attribute value.

mixed
resolveAppendableAttributeDefault(array $attributeDefaults, string $key, bool $escape)

Resolve an appendable attribute value default value.

bool
isEmpty()

Determine if the attribute bag is empty.

bool
isNotEmpty()

Determine if the attribute bag is not empty.

array
getAttributes()

Get all of the raw attributes.

void
setAttributes(array $attributes)

Set the underlying attributes.

static array
extractPropNames(array $keys)

Extract "prop" names from given keys.

string
toHtml()

Get content as a string of HTML.

HtmlString
__invoke(array $attributeDefaults = [])

Merge additional attributes / values into the attribute bag.

bool
offsetExists(mixed $offset)

Determine if the given offset exists.

mixed
offsetGet(mixed $offset)

Get the value at the given offset.

void
offsetSet(mixed $offset, mixed $value)

Set the value at a given offset.

void
offsetUnset(mixed $offset)

Remove the value at the given offset.

ArrayIterator
getIterator()

Get an iterator for the items.

mixed
jsonSerialize()

Convert the object into a JSON serializable form.

array
toArray()

Get all the attribute values.

string
__toString()

Implode the attributes into a single HTML ready string.

static void
flushState()

Flush all static state.

Details

in Conditionable at line 23
mixed when(mixed $value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) truthy.

Parameters

mixed $value
callable|null $callback
callable|null $default

Return Value

mixed

in Conditionable at line 56
mixed unless(mixed $value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) falsy.

Parameters

mixed $value
callable|null $callback
callable|null $default

Return Value

mixed

at line 44
array all(mixed $keys = null)

Get all the attribute values.

Parameters

mixed $keys

Return Value

array

at line 74
protected mixed data(string|null $key = null, mixed $default = null)

Retrieve data from the instance.

Parameters

string|null $key
mixed $default

Return Value

mixed

in InteractsWithData at line 40
bool exists(array|string $key)

Determine if the data contains a given key.

Parameters

array|string $key

Return Value

bool

in InteractsWithData at line 48
bool has(array|string $key)

Determine if the data contains a given key.

Parameters

array|string $key

Return Value

bool

in InteractsWithData at line 67
bool hasAny(array|string $keys)

Determine if the instance contains any of the given keys.

Parameters

array|string $keys

Return Value

bool

in InteractsWithData at line 86
mixed whenHas(string $key, callable $callback, callable|null $default = null)

Apply the callback if the instance contains the given key.

Parameters

string $key
callable $callback
callable|null $default

Return Value

mixed

in InteractsWithData at line 102
bool filled(array|string $key)

Determine if the instance contains a non-empty value for the given key.

Parameters

array|string $key

Return Value

bool

in InteractsWithData at line 119
bool isNotFilled(array|string $key)

Determine if the instance contains an empty value for the given key.

Parameters

array|string $key

Return Value

bool

in InteractsWithData at line 136
bool anyFilled(array|string $keys)

Determine if the instance contains a non-empty value for any of the given keys.

Parameters

array|string $keys

Return Value

bool

in InteractsWithData at line 160
mixed whenFilled(string $key, callable $callback, callable|null $default = null)

Apply the callback if the instance contains a non-empty value for the given key.

Parameters

string $key
callable $callback
callable|null $default

Return Value

mixed

in InteractsWithData at line 185
mixed whenEnum(string $key, string $enumClass, callable $callback, callable|null $default = null)

Apply the callback if the instance contains a valid enum value for the given key.

Parameters

string $key
string $enumClass
callable $callback
callable|null $default

Return Value

mixed

in InteractsWithData at line 201
bool missing(array|string $key)

Determine if the instance is missing a given key.

Parameters

array|string $key

Return Value

bool

in InteractsWithData at line 218
mixed whenMissing(string $key, callable $callback, callable|null $default = null)

Apply the callback if the instance is missing the given key.

Parameters

string $key
callable $callback
callable|null $default

Return Value

mixed

in InteractsWithData at line 234
protected bool isEmptyString(string $key)

Determine if the given key is an empty string for "filled".

Parameters

string $key

Return Value

bool

in InteractsWithData at line 246
Stringable str(string $key, mixed $default = null, bool $strict = false)

Retrieve data from the instance as a Stringable instance.

Parameters

string $key
mixed $default
bool $strict

Return Value

Stringable

in InteractsWithData at line 256
Stringable string(string $key, mixed $default = null, bool $strict = false)

Retrieve data from the instance as a Stringable instance.

When strict, values that are not strings, numbers, or Stringable objects return the default.

Parameters

string $key
mixed $default
bool $strict

Return Value

Stringable

in InteractsWithData at line 279
bool|null boolean(string|null $key = null, Closure|bool|null $default = false, bool $strict = false)

Retrieve data as a boolean value.

Returns true when value is "1", "true", "on", and "yes". Otherwise, returns false. When strict, unrecognized or empty values return the default.

Parameters

string|null $key
Closure|bool|null $default
bool $strict

Return Value

bool|null

in InteractsWithData at line 301
int|null integer(string $key, Closure|int|null $default = 0, bool $strict = false)

Retrieve data as an integer value.

When strict, values that are not valid integers return the default.

Parameters

string $key
Closure|int|null $default
bool $strict

Return Value

int|null

in InteractsWithData at line 328
float|null float(string $key, Closure|float|null $default = 0.0, bool $strict = false)

Retrieve data as a float value.

When strict, values that are not valid numbers return the default.

Parameters

string $key
Closure|float|null $default
bool $strict

Return Value

float|null

in InteractsWithData at line 347
int|float clamp(string $key, int|float $min, int|float $max, int|float $default = 0)

Retrieve data clamped between min and max values.

Parameters

string $key
int|float $min
int|float $max
int|float $default

Return Value

int|float

in InteractsWithData at line 365
CarbonInterface|null date(string $key, string|null $format = null, UnitEnum|string|null $tz = null)

Retrieve data from the instance as a Carbon instance.

Parameters

string $key
string|null $format
UnitEnum|string|null $tz

Return Value

CarbonInterface|null

Exceptions

InvalidFormatException

in InteractsWithData at line 383
CarbonInterval|null interval(string $key, Unit|string|null $unit = null)

Retrieve data from the instance as a CarbonInterval instance.

Parameters

string $key
Unit|string|null $unit

Return Value

CarbonInterval|null

in InteractsWithData at line 410
mixed enum(string $key, string $enumClass, mixed $default = null)

Retrieve data from the instance as an enum.

Parameters

string $key
string $enumClass
mixed $default

Return Value

mixed

in InteractsWithData at line 427
array enums(string $key, string $enumClass)

Retrieve data from the instance as an array of enums.

Parameters

string $key
string $enumClass

Return Value

array

in InteractsWithData at line 442
array array(array|string|null $key = null)

Retrieve data from the instance as an array.

Parameters

array|string|null $key

Return Value

array

in InteractsWithData at line 452
Collection collect(array|string|null $key = null)

Retrieve data from the instance as a collection.

Parameters

array|string|null $key

Return Value

Collection

at line 86
ComponentAttributeBag only(mixed $keys)

Only include the given attribute from the attribute array.

Parameters

mixed $keys

Return Value

ComponentAttributeBag

at line 102
ComponentAttributeBag except(mixed $keys)

Exclude the given attribute from the attribute array.

Parameters

mixed $keys

Return Value

ComponentAttributeBag

in Macroable at line 30
static void macro(string $name, callable|object $macro)

Register a custom macro.

Macros persist in a static property for the worker lifetime and apply to every subsequent call on the macroable class.

Parameters

string $name
callable|object $macro

Return Value

void

in Macroable at line 44
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Delegates to macro() for each method; registered macros persist in a static property for the worker lifetime.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

in Macroable at line 61
static bool hasMacro(string $name)

Check if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 72
static void flushMacros()

Flush the existing macros.

Clears worker-wide macros; concurrent coroutines may resolve different methods depending on timing.

Return Value

void

in Macroable at line 83
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line 108
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line 36
__construct(array $attributes = [])

Create a new component attribute bag instance.

Parameters

array $attributes

at line 56
mixed first(mixed $default = null)

Get the first attribute's value.

Parameters

mixed $default

Return Value

mixed

at line 64
mixed get(string $key, mixed $default = null)

Get a given attribute from the attribute array.

Parameters

string $key
mixed $default

Return Value

mixed

at line 118
ComponentAttributeBag filter(callable $callback)

Filter the attributes, returning a bag of attributes that pass the filter.

Parameters

callable $callback

Return Value

ComponentAttributeBag

at line 128
ComponentAttributeBag whereStartsWith(string|array $needles)

Return a bag of attributes that have keys starting with the given value / pattern.

Parameters

string|array $needles

Return Value

ComponentAttributeBag

at line 140
ComponentAttributeBag whereDoesntStartWith(string|array $needles)

Return a bag of attributes with keys that do not start with the given value / pattern.

Parameters

string|array $needles

Return Value

ComponentAttributeBag

at line 152
ComponentAttributeBag thatStartWith(string|array $needles)

Return a bag of attributes that have keys starting with the given value / pattern.

Parameters

string|array $needles

Return Value

ComponentAttributeBag

at line 160
ComponentAttributeBag onlyProps(mixed $keys)

Only include the given attribute from the attribute array.

Parameters

mixed $keys

Return Value

ComponentAttributeBag

at line 168
ComponentAttributeBag exceptProps(mixed $keys)

Exclude the given attribute from the attribute array.

Parameters

mixed $keys

Return Value

ComponentAttributeBag

at line 176
ComponentAttributeBag class(mixed $classList)

Conditionally merge classes into the attribute bag.

Parameters

mixed $classList

Return Value

ComponentAttributeBag

at line 186
ComponentAttributeBag style(mixed $styleList)

Conditionally merge styles into the attribute bag.

Parameters

mixed $styleList

Return Value

ComponentAttributeBag

at line 196
ComponentAttributeBag merge(array $attributeDefaults = [], bool $escape = true)

Merge additional attributes / values into the attribute bag.

Parameters

array $attributeDefaults
bool $escape

Return Value

ComponentAttributeBag

at line 234
protected bool shouldEscapeAttributeValue(bool $escape, mixed $value)

Determine if the specific attribute value should be escaped.

Parameters

bool $escape
mixed $value

Return Value

bool

at line 248
AppendableAttributeValue prepends(mixed $value)

Create a new appendable attribute value.

Parameters

mixed $value

Return Value

AppendableAttributeValue

at line 256
protected mixed resolveAppendableAttributeDefault(array $attributeDefaults, string $key, bool $escape)

Resolve an appendable attribute value default value.

Parameters

array $attributeDefaults
string $key
bool $escape

Return Value

mixed

at line 268
bool isEmpty()

Determine if the attribute bag is empty.

Return Value

bool

at line 276
bool isNotEmpty()

Determine if the attribute bag is not empty.

Return Value

bool

at line 284
array getAttributes()

Get all of the raw attributes.

Return Value

array

at line 292
void setAttributes(array $attributes)

Set the underlying attributes.

Parameters

array $attributes

Return Value

void

at line 309
static array extractPropNames(array $keys)

Extract "prop" names from given keys.

Parameters

array $keys

Return Value

array

at line 326
string toHtml()

Get content as a string of HTML.

Return Value

string

at line 334
HtmlString __invoke(array $attributeDefaults = [])

Merge additional attributes / values into the attribute bag.

Parameters

array $attributeDefaults

Return Value

HtmlString

at line 342
bool offsetExists(mixed $offset)

Determine if the given offset exists.

Parameters

mixed $offset

Return Value

bool

at line 350
mixed offsetGet(mixed $offset)

Get the value at the given offset.

Parameters

mixed $offset

Return Value

mixed

at line 358
void offsetSet(mixed $offset, mixed $value)

Set the value at a given offset.

Parameters

mixed $offset
mixed $value

Return Value

void

at line 366
void offsetUnset(mixed $offset)

Remove the value at the given offset.

Parameters

mixed $offset

Return Value

void

at line 374
ArrayIterator getIterator()

Get an iterator for the items.

Return Value

ArrayIterator

at line 382
mixed jsonSerialize()

Convert the object into a JSON serializable form.

Return Value

mixed

at line 390
array toArray()

Get all the attribute values.

Return Value

array

at line 398
string __toString()

Implode the attributes into a single HTML ready string.

Return Value

string

at line 420
static void flushState()

Flush all static state.

Return Value

void