Skip to content

Added docs for enum nodes #2706

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 30, 2013
Merged

Added docs for enum nodes #2706

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions components/config/definition.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,25 @@ node definition. Node type are available for:
and are created with ``node($name, $type)`` or their associated shortcut
``xxxxNode($name)`` method.

Enum nodes
~~~~~~~~~~

.. versionadded:: 2.1
The enum node is new in 2.1

Enum nodes provide a constraint to match the given input against a set of
values::

$rootNode
->children()
->enumNode('gender')
->values(array('male', 'female'))
->end()
->end()
;

This will restrict the ``gender`` option to be either ``male`` or ``female``.

Array nodes
~~~~~~~~~~~

Expand Down