Form Tests Reference

Tests can be executed by using the ``is`` operator in Twig to create a

condition. Read `the Twig documentation`_ for more information.

.. _form-twig-selectedchoice:

selectedchoice(selected_value)

This test will check if the current choice is equal to the ``selected_value``

or if the current choice is in the array (when ``selected_value`` is an array).

.. code-block:: jinja

.. versionadded:: 2.3

The ``method`` and ``action`` variables were introduced in Symfony 2.3.

| Variable | Usage |

| ``form`` | The current ``FormView`` instance. |

| ``id`` | The ``id`` HTML attribute to be rendered. |

| ``name`` | The name of the field (e.g. ``title``) - but not the ``name`` |

| | HTML attribute, which is ``full_name``. |

| ``full_name`` | The ``name`` HTML attribute to be rendered. |

| ``errors`` | An array of any errors attached to *this* specific field |

| | (e.g. ``form.title.errors``). |

| | Note that you can't use ``form.errors`` to determine if a form is valid, |

| | since this only returns "global" errors: some individual fields may have errors. |

| | Instead, use the ``valid`` option. |

| ``valid`` | Returns ``true`` or ``false`` depending on whether the whole form is valid. |

| ``value`` | The value that will be used when rendering (commonly the ``value`` HTML attribute). |

| ``read_only`` | If ``true``, ``readonly="readonly"`` is added to the field. |

| ``disabled`` | If ``true``, ``disabled="disabled"`` is added to the field. |

| ``required`` | If ``true``, a ``required`` attribute is added to the field to activate HTML5 |

| | validation. Additionally, a ``required`` class is added to the label. |

| ``max_length`` | Adds a ``maxlength`` HTML attribute to the element. |

| ``pattern`` | Adds a ``pattern`` HTML attribute to the element. |

| ``label`` | The string label that will be rendered. |

| ``multipart`` | If ``true``, ``form_enctype`` will render ``enctype="multipart/form-data"``. |

| | This only applies to the root form element. |

| ``attr`` | A key-value array that will be rendered as HTML attributes on the field. |

| ``label_attr`` | A key-value array that will be rendered as HTML attributes on the label. |

| ``compound`` | Whether or not a field is actually a holder for a group of children fields |

| | (for example, a ``choice`` field, which is actually a group of checkboxes. |

| ``block_prefixes`` | An array of all the names of the parent types. |

| ``translation_domain`` | The domain of the translations for this form. |

| ``cache_key`` | A unique key which is used for caching. |

| ``data`` | The normalized data of the type. |

| ``method`` | The method of the current form (POST, GET, etc.). |

| ``action`` | The action of the current form. |

.. _`the Twig documentation`: http://twig.sensiolabs.org/doc/templates.html#test-operator

| Variables | - `checked`_ |

Form Variables

.. include:: /reference/forms/types/variables/check_or_radio_table.rst.inc

Field Variables

| Variable | Type | Usage |

| multiple | ``Boolean`` | The value of the `multiple`_ option. |

| expanded | ``Boolean`` | The value of the `expanded`_ option. |

| preferred_choices | ``array`` | A nested array containing the ``ChoiceView`` objects of |

| | | choices which should be presented to the user with priority. |

| choices | ``array`` | A nested array containing the ``ChoiceView`` objects of |

| | | the remaining choices. |

| separator | ``string`` | The seperator to use between choice groups. |

| empty_value | ``mixed`` | The empty value if not already in the list, otherwise |

| | | ``null``. |

| is_selected | ``callable`` | A callable which takes a ``ChoiceView`` and the selected value(s) |

| | | and returns whether the choice is in the selected value(s). |

| empty_value_in_choices | ``Boolean`` | Whether the empty value is in the choice list. |

.. tip::

It's significantly faster to use the :ref:`form-twig-selectedchoice` test

instead when using Twig.

Field Variables

Variable Type Usage

allow_add ``Boolean`` The value of the `allow_add`_ option.

allow_delete ``Boolean`` The value of the `allow_delete`_ option.

Field Variables

| Variable | Type | Usage |

| widget | ``mixed`` | The value of the `widget`_ option. |

| type | ``string`` | Only present when widget is ``single_text`` and HTML5 is activated, |

| | | contains the input type to use (``datetime``, ``date`` or ``time``). |

| date_pattern | ``string`` | A string with the date format to use. |

Field Variables

| Variable | Type | Usage |

| widget | ``mixed`` | The value of the `widget`_ option. |

| type | ``string`` | Only present when widget is ``single_text`` and HTML5 is activated, |

| | | contains the input type to use (``datetime``, ``date`` or ``time``). |

Form Variables

Variable Type Usage

type ``string`` The type variable is set to ``file``, in order to render as a file input field.