Exemplos

    Exemplo #1 Valores limitados básicos

    <?php

    enum Ordem
    {
    case     Asc;
    case     Desc;
    }

    function     consulta($campos, $filtros, Ordem $ordem = Ordem::Asc)
    {
    /* ... */
    }
    ?>

    A função consulta() agora pode prosseguir segura, sabendo que a $ordem tem garantia de ser Ordem::Asc ou Ordem::Desc. Qualquer outro valor resultaria em um TypeError, então nenhuma verificação ou teste de erro é necessária.

    Exemplo #2 Valores exclusivos avançados

    <?php

    enum EstadoDeUsuario: string
    {
    case     Pendente = 'P';
    case     Ativo = 'A';
    case     Suspenso = 'S';
    case     CanceladoPeloUsuario = 'C';

    public function     rotulo(): string
    {
    return match(    $this) {
    static::    Pendente => 'Pendente',
    static::    Ativo => 'Ativo',
    static::    Suspenso => 'Suspenso',
    static::    CanceladoPeloUsuario => 'Cancelado pelo usuário',
    };
    }
    }
    ?>

    Neste exemplo, o estado de um usuário pode ser, exclusivamente, EstadoDeUsuario::Pendente, EstadoDeUsuario::Ativo, EstadoDeUsuario::Suspenso, ou EstadoDeUsuario::CanceladoPeloUsuario. Uma função pode tipar um parâmetro contra EstadoDeUsuario e aceitar então apenas aqueles quatro valores, ponto final.

    Todos os quatros valores possuem um método rotulo(), que retorna uma string legível para humanos. Essa string é independente da string equivalente escalar do "nome de máquina", que pode ser usado em, por exemplo, um campo de banco de dados um uma caixa de seleção HTML.

    <?php

    foreach (EstadoDeUsuario::cases() as $caso) {
    printf('<option value="%s">%s</option>\n', $caso->value, $caso->label());
    }
    ?>

    Improve This Page

    Learn how improve this page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 1 note

    up
    2
    php-net at mentordosnerds dot com
    7 months ago
    Additional use-case examples:
    <?php

    trait EnumNamesTrait
    {
    abstract public static function     cases(): array;

    public static function     names(): array
    {
    return     array_map(fn($enum) => $enum->name, static::cases());
    }
    }

    trait     EnumValuesTrait
    {
    abstract public static function     cases(): array;

    public static function     values(): array
    {
    return     array_map(fn($enum) => $enum->value, static::cases());
    }
    }

    trait     EnumArraySerializableTrait
    {
    use     EnumNamesTrait;
    use     EnumValuesTrait;

    public static function array(): array
    {
    return     array_combine(static::names(), static::values());
    }
    }

    trait     EnumJsonSerializableTrait
    {
    use     EnumArraySerializableTrait;

    public static function     jsonSerialize(): string
    {
    return     json_encode(static::array());
    }
    }

    enum     Suit: string
    {
    case     Clubs = '♣';
    case     Diamonds = '♦';
    case     Hearts = '♥';
    case     Spades = '♠';

    use     EnumJsonSerializableTrait;

    public const DEFAULT =     self::Hearts;

    public static function default(): static
    {
    return     self::DEFAULT;
    }
    }

    var_dump(
    Suit::cases(),
    Suit::values(),
    Suit::names(),
    Suit::array(),
    Suit::jsonSerialize(),
    Suit::default(),
    );
    ＋add a note
    To Top