EnumCast

Casts raw values to BackedEnum instances with configurable fallback behavior.

Usage

use StdOut\SimpleDataObjects\Attributes\Cast;
use StdOut\SimpleDataObjects\Casts\EnumCast;

enum Status: string
{
    case Active   = 'active';
    case Inactive = 'inactive';
}

class UserData extends BaseData
{
    public function __construct(
        #[Cast(new EnumCast(Status::class))]
        public readonly Status $status,
    ) {}
}

Without EnumCast

For simple cases, you can omit the cast entirely — the hydrator resolves BackedEnum from its backing value automatically:

class UserData extends BaseData
{
    public function __construct(
        public readonly Status $status, // string 'active' → Status::Active
    ) {}
}

Use EnumCast explicitly when you need a fallback value.

With a Fallback

#[Cast(new EnumCast(Status::class, fallback: Status::Inactive))]
public readonly Status $status,

If the input value does not match any enum case, Status::Inactive is returned instead of throwing.

Constructor Parameters

new EnumCast(
    enumClass: Status::class,
    fallback:  null,           // ?BackedEnum, default null = throw on unknown value
)

Serialization

set() returns the enum's backing value (string or int):

$user = UserData::from(['status' => 'active']);
$user->toArray()['status']; // 'active'