Overriding enum labels

Enums can be given a label, you can do this by overriding the labels method. This label can be used to, for example, show a user-friendly list of available enums in a dropdown field.

/**
 * @method static self draft()
 * @method static self published()
 * @method static self archived()
 */
class StatusEnum extends Enum
{
    protected static function labels(): array
    {
        return [
            'draft' => 'my draft label',
        ];
    }
}

You don't need to override all labels, the default label will be the enum's value. You can access an enum's label like so:

$status->label;

Note that label is a read-only property, it cannot be changed.

You may also return a closure to derive the enum label from the method name.

/**
 * @method static self issue()
 * @method static self pullRequest()
 */
class EventEnum extends Enum
{
    protected static function labels(): Closure
    {
        return fn (string $name) => str_replace('_', ' ', snake_case($name));
    }
}