mirror of
https://github.com/twigphp/Twig.git
synced 2026-09-13 02:46:29 +00:00
Improve documentation examples for enum and enum_cases
It may be obvious, but I first thought initializing an BackendEnum with a certain value could be possible with `enum(FQCN, value)`, but it does not, it always returns the first case instance (if exists). Instead, `enum(FQCN).from(value)` must be used, I think it's worth to improve `enum()` examples.
This commit is contained in:
@@ -10,15 +10,21 @@
|
|||||||
.. code-block:: twig
|
.. code-block:: twig
|
||||||
|
|
||||||
{# display one specific case of a backed enum #}
|
{# display one specific case of a backed enum #}
|
||||||
{{ enum('App\\MyEnum').SomeCase.value }}
|
{{ enum('App\\CardSuite').Clubs.value }} {# "clubs" #}
|
||||||
|
|
||||||
{# get all cases of an enum #}
|
{# get all cases of an enum #}
|
||||||
{% for case in enum('App\\MyEnum').cases %}
|
{% for case in enum('App\\CardSuite').cases %}
|
||||||
{{ case.value }}
|
{{ case.value }}
|
||||||
{% endfor %}
|
{% 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 #}
|
{# call any methods of the enum class #}
|
||||||
{{ enum('App\\MyEnum').someMethod() }}
|
{{ 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.
|
When using a string literal for the ``enum`` argument, it will be validated during compile time to be a valid enum name.
|
||||||
|
|
||||||
|
|||||||
@@ -9,9 +9,10 @@
|
|||||||
|
|
||||||
.. code-block:: twig
|
.. code-block:: twig
|
||||||
|
|
||||||
{% for case in enum_cases('App\\MyEnum') %}
|
{% for case in enum_cases('App\\CardSuite') %}
|
||||||
{{ case.value }}
|
{{ case.value }}
|
||||||
{% endfor %}
|
{% endfor %}
|
||||||
|
{# "clubs", "spades", "hearts", "diamonds" #}
|
||||||
|
|
||||||
When using a string literal for the ``enum`` argument, it will be validated during compile time to be a valid enum name.
|
When using a string literal for the ``enum`` argument, it will be validated during compile time to be a valid enum name.
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user