enum

Docs for Twig version 3.x
Switch to another version: 1.x, 2.x

Questions & Feedback

Found a typo or an error?
Want to improve this document? Edit it.

Need support or have a technical question?
Ask support on Stack Overflow.

License

Twig documentation is licensed under the new BSD license.

`enum`

3.15

The enum function was added in Twig 3.15.

enum gives access to enums:

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
        {# display one specific case of a backed enum #}
{{ enum('App\\CardSuite').Clubs.value }} {# "clubs" #}

{# get all cases of an enum #}
{% for case in enum('App\\CardSuite').cases %}
    {{ case.value }}
{% endfor %}
{# "clubs", "spades", "hearts", "diamonds" #}

{# get a specific case of an enum by value #}
{% set card_suite = enum('App\\CardSuite').from('hearts') %}
{{ card_suite.name }} {# "Hearts" #}
{{ card_suite.value }} {# "hearts" #}

{# call any methods of the enum class #}
{{ enum('App\\CardSuite').someMethod() }}
    

When using a string literal for the enum argument, it will be validated during compile time to be a valid enum name.

Arguments

enum: The FQCN of the enum