1. class
  2. Hypervel
  3. \
  4. Data
  5. \
  6. Casts
  7. \
  8. EnumCast

EnumCast

class EnumCast implements Cast, IterableItemCast

Methods

__construct(string|null $type = null)

Create a backed-enum cast.

mixed
cast(DataProperty $property, mixed $value, array $properties, CreationContext $context)

Cast a property value to its declared backed enum.

mixed
castIterableItem(DataProperty $property, mixed $value, array $properties, CreationContext $context)

Cast an iterable item to its declared backed enum.

BackedEnum|Uncastable
castValue(string|null $type, mixed $value, DataProperty $property)

Cast one value to a backed enum.

string|null
iterableEnumType(DataProperty $property)

Find the backed enum declared for iterable items.

Details

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

Create a backed-enum cast.

Parameters

string|null $type

at line 27
mixed cast(DataProperty $property, mixed $value, array $properties, CreationContext $context)

Cast a property value to its declared backed enum.

Parameters

DataProperty $property
mixed $value
array $properties

the object's declared property values, keyed by property name
CreationContext $context

Return Value

mixed

at line 43
mixed castIterableItem(DataProperty $property, mixed $value, array $properties, CreationContext $context)

Cast an iterable item to its declared backed enum.

Parameters

DataProperty $property
mixed $value
array $properties

the object's declared property values, keyed by property name
CreationContext $context

Return Value

mixed

at line 61
protected BackedEnum|Uncastable castValue(string|null $type, mixed $value, DataProperty $property)

Cast one value to a backed enum.

Parameters

string|null $type
mixed $value
DataProperty $property

Return Value

BackedEnum|Uncastable

at line 74
protected string|null iterableEnumType(DataProperty $property)

Find the backed enum declared for iterable items.

Parameters

DataProperty $property

Return Value

string|null