From 99ca7bf1025db82136e3e1b6bebed85cf258dd24 Mon Sep 17 00:00:00 2001 From: Christian Flothmann Date: Fri, 1 Aug 2014 21:38:14 +0200 Subject: [PATCH] [Reference] order form type options alphabetically --- reference/forms/types/birthday.rst | 45 ++++++----- reference/forms/types/checkbox.rst | 34 ++++---- reference/forms/types/choice.rst | 62 +++++++-------- reference/forms/types/collection.rst | 114 +++++++++++++-------------- reference/forms/types/country.rst | 43 +++++----- reference/forms/types/currency.rst | 39 +++++---- reference/forms/types/date.rst | 56 ++++++------- reference/forms/types/datetime.rst | 112 +++++++++++++------------- reference/forms/types/email.rst | 38 ++++----- reference/forms/types/entity.rst | 107 +++++++++++++------------ reference/forms/types/file.rst | 28 +++---- reference/forms/types/form.rst | 102 ++++++++++++------------ reference/forms/types/hidden.rst | 26 +++--- reference/forms/types/integer.rst | 46 +++++------ reference/forms/types/language.rst | 43 +++++----- reference/forms/types/locale.rst | 43 +++++----- reference/forms/types/money.rst | 44 +++++------ reference/forms/types/number.rst | 46 +++++------ reference/forms/types/password.rst | 32 ++++---- reference/forms/types/percent.rst | 57 +++++++------- reference/forms/types/radio.rst | 35 ++++---- reference/forms/types/repeated.rst | 78 +++++++++--------- reference/forms/types/search.rst | 32 ++++---- reference/forms/types/text.rst | 38 ++++----- reference/forms/types/textarea.rst | 38 ++++----- reference/forms/types/time.rst | 98 +++++++++++------------ reference/forms/types/timezone.rst | 45 ++++++----- reference/forms/types/url.rst | 38 ++++----- 28 files changed, 779 insertions(+), 740 deletions(-) diff --git a/reference/forms/types/birthday.rst b/reference/forms/types/birthday.rst index 38c773ed3ac..d77551c3b29 100644 --- a/reference/forms/types/birthday.rst +++ b/reference/forms/types/birthday.rst @@ -20,23 +20,28 @@ option defaults to 120 years ago to the current year. +----------------------+-------------------------------------------------------------------------------+ | Rendered as | can be three select boxes or 1 or 3 text boxes, based on the `widget`_ option | +----------------------+-------------------------------------------------------------------------------+ -| Overridden Options | - `years`_ | +| Overridden options | - `years`_ | +----------------------+-------------------------------------------------------------------------------+ -| Inherited Options | - `widget`_ | -| | - `input`_ | -| | - `empty_value`_ | -| | - `months`_ | +| Inherited options | from the :doc:`date ` type: | +| | | | | - `days`_ | +| | - `empty_value`_ | | | - `format`_ | +| | - `input`_ | | | - `model_timezone`_ | +| | - `months`_ | | | - `view_timezone`_ | +| | - `widget`_ | +| | | +| | from the :doc:`form ` type: | +| | | | | - `data`_ | +| | - `disabled`_ | +| | - `inherit_data`_ | | | - `invalid_message`_ | | | - `invalid_message_parameters`_ | -| | - `read_only`_ | -| | - `disabled`_ | | | - `mapped`_ | -| | - `inherit_data`_ | +| | - `read_only`_ | +----------------------+-------------------------------------------------------------------------------+ | Parent type | :doc:`date ` | +----------------------+-------------------------------------------------------------------------------+ @@ -59,34 +64,34 @@ Inherited Options These options inherit from the :doc:`date ` type: -.. include:: /reference/forms/types/options/date_widget.rst.inc - -.. include:: /reference/forms/types/options/date_input.rst.inc +.. include:: /reference/forms/types/options/days.rst.inc .. include:: /reference/forms/types/options/empty_value.rst.inc -.. include:: /reference/forms/types/options/months.rst.inc - -.. include:: /reference/forms/types/options/days.rst.inc - .. include:: /reference/forms/types/options/date_format.rst.inc +.. include:: /reference/forms/types/options/date_input.rst.inc + .. include:: /reference/forms/types/options/model_timezone.rst.inc +.. include:: /reference/forms/types/options/months.rst.inc + .. include:: /reference/forms/types/options/view_timezone.rst.inc +.. include:: /reference/forms/types/options/date_widget.rst.inc + These options inherit from the :doc:`form ` type: .. include:: /reference/forms/types/options/data.rst.inc -.. include:: /reference/forms/types/options/invalid_message.rst.inc +.. include:: /reference/forms/types/options/disabled.rst.inc -.. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc +.. include:: /reference/forms/types/options/inherit_data.rst.inc -.. include:: /reference/forms/types/options/read_only.rst.inc +.. include:: /reference/forms/types/options/invalid_message.rst.inc -.. include:: /reference/forms/types/options/disabled.rst.inc +.. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc .. include:: /reference/forms/types/options/mapped.rst.inc -.. include:: /reference/forms/types/options/inherit_data.rst.inc +.. include:: /reference/forms/types/options/read_only.rst.inc diff --git a/reference/forms/types/checkbox.rst b/reference/forms/types/checkbox.rst index 69c4fee5199..eeddb8031de 100644 --- a/reference/forms/types/checkbox.rst +++ b/reference/forms/types/checkbox.rst @@ -13,18 +13,18 @@ if the box is unchecked, the value will be set to false. +-------------+------------------------------------------------------------------------+ | Options | - `value`_ | +-------------+------------------------------------------------------------------------+ -| Overridden | - `empty_data`_ | -| options | - `compound`_ | +| Overridden | - `compound`_ | +| options | - `empty_data`_ | +-------------+------------------------------------------------------------------------+ | Inherited | - `data`_ | -| options | - `required`_ | -| | - `label`_ | -| | - `label_attr`_ | -| | - `read_only`_ | -| | - `disabled`_ | +| options | - `disabled`_ | | | - `error_bubbling`_ | | | - `error_mapping`_ | +| | - `label`_ | +| | - `label_attr`_ | | | - `mapped`_ | +| | - `read_only`_ | +| | - `required`_ | +-------------+------------------------------------------------------------------------+ | Parent type | :doc:`form ` | +-------------+------------------------------------------------------------------------+ @@ -49,10 +49,10 @@ Field Options Overridden Options ------------------ -.. include:: /reference/forms/types/options/checkbox_empty_data.rst.inc - .. include:: /reference/forms/types/options/checkbox_compound.rst.inc +.. include:: /reference/forms/types/options/checkbox_empty_data.rst.inc + Inherited Options ----------------- @@ -60,22 +60,22 @@ These options inherit from the :doc:`form ` type: .. include:: /reference/forms/types/options/data.rst.inc -.. include:: /reference/forms/types/options/required.rst.inc - -.. include:: /reference/forms/types/options/label.rst.inc - -.. include:: /reference/forms/types/options/label_attr.rst.inc - -.. include:: /reference/forms/types/options/read_only.rst.inc - .. include:: /reference/forms/types/options/disabled.rst.inc .. include:: /reference/forms/types/options/error_bubbling.rst.inc .. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/label.rst.inc + +.. include:: /reference/forms/types/options/label_attr.rst.inc + .. include:: /reference/forms/types/options/mapped.rst.inc +.. include:: /reference/forms/types/options/read_only.rst.inc + +.. include:: /reference/forms/types/options/required.rst.inc + Form Variables -------------- diff --git a/reference/forms/types/choice.rst b/reference/forms/types/choice.rst index d55e1ffb771..abc5edc553c 100644 --- a/reference/forms/types/choice.rst +++ b/reference/forms/types/choice.rst @@ -15,25 +15,25 @@ option. +-------------+------------------------------------------------------------------------------+ | Options | - `choices`_ | | | - `choice_list`_ | -| | - `multiple`_ | +| | - `empty_value`_ | | | - `expanded`_ | +| | - `multiple`_ | | | - `preferred_choices`_ | -| | - `empty_value`_ | +-------------+------------------------------------------------------------------------------+ -| Overridden | - `empty_data`_ | -| options | - `compound`_ | +| Overridden | - `compound`_ | +| options | - `empty_data`_ | | | - `error_bubbling`_ | +-------------+------------------------------------------------------------------------------+ -| Inherited | - `required`_ | -| options | - `label`_ | -| | - `label_attr`_ | -| | - `data`_ | -| | - `read_only`_ | +| Inherited | - `by_reference`_ | +| options | - `data`_ | | | - `disabled`_ | | | - `error_mapping`_ | -| | - `mapped`_ | | | - `inherit_data`_ | -| | - `by_reference`_ | +| | - `label`_ | +| | - `label_attr`_ | +| | - `mapped`_ | +| | - `read_only`_ | +| | - `required`_ | +-------------+------------------------------------------------------------------------------+ | Parent type | :doc:`form ` | +-------------+------------------------------------------------------------------------------+ @@ -103,17 +103,25 @@ The ``choice_list`` option must be an instance of the ``ChoiceListInterface``. For more advanced cases, a custom class that implements the interface can be created to supply the choices. -.. include:: /reference/forms/types/options/multiple.rst.inc +.. include:: /reference/forms/types/options/empty_value.rst.inc .. include:: /reference/forms/types/options/expanded.rst.inc -.. include:: /reference/forms/types/options/preferred_choices.rst.inc +.. include:: /reference/forms/types/options/multiple.rst.inc -.. include:: /reference/forms/types/options/empty_value.rst.inc +.. include:: /reference/forms/types/options/preferred_choices.rst.inc Overridden Options ------------------ +compound +~~~~~~~~ + +**type**: ``boolean`` **default**: same value as ``expanded`` option + +This option specifies if a form is compound. The value is by default +overridden by the value of the ``expanded`` option. + .. include:: /reference/forms/types/options/empty_data.rst.inc :end-before: DEFAULT_PLACEHOLDER @@ -126,14 +134,6 @@ The actual default value of this option depends on other field options: .. include:: /reference/forms/types/options/empty_data.rst.inc :start-after: DEFAULT_PLACEHOLDER -compound -~~~~~~~~ - -**type**: ``boolean`` **default**: same value as ``expanded`` option - -This option specifies if a form is compound. The value is by default -overridden by the value of the ``expanded`` option. - error_bubbling ~~~~~~~~~~~~~~ @@ -147,25 +147,25 @@ Inherited Options These options inherit from the :doc:`form ` type: -.. include:: /reference/forms/types/options/required.rst.inc - -.. include:: /reference/forms/types/options/label.rst.inc - -.. include:: /reference/forms/types/options/label_attr.rst.inc +.. include:: /reference/forms/types/options/by_reference.rst.inc .. include:: /reference/forms/types/options/data.rst.inc -.. include:: /reference/forms/types/options/read_only.rst.inc - .. include:: /reference/forms/types/options/disabled.rst.inc .. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/inherit_data.rst.inc + +.. include:: /reference/forms/types/options/label.rst.inc + +.. include:: /reference/forms/types/options/label_attr.rst.inc + .. include:: /reference/forms/types/options/mapped.rst.inc -.. include:: /reference/forms/types/options/inherit_data.rst.inc +.. include:: /reference/forms/types/options/read_only.rst.inc -.. include:: /reference/forms/types/options/by_reference.rst.inc +.. include:: /reference/forms/types/options/required.rst.inc Field Variables --------------- diff --git a/reference/forms/types/collection.rst b/reference/forms/types/collection.rst index 4402f015dbd..0c86877850d 100644 --- a/reference/forms/types/collection.rst +++ b/reference/forms/types/collection.rst @@ -13,22 +13,22 @@ forms, which is useful when creating forms that expose one-to-many relationships +-------------+-----------------------------------------------------------------------------+ | Rendered as | depends on the `type`_ option | +-------------+-----------------------------------------------------------------------------+ -| Options | - `type`_ | -| | - `options`_ | -| | - `allow_add`_ | +| Options | - `allow_add`_ | | | - `allow_delete`_ | +| | - `options`_ | | | - `prototype`_ | | | - `prototype_name`_ | +| | - `type`_ | +-------------+-----------------------------------------------------------------------------+ -| Inherited | - `label`_ | -| options | - `label_attr`_ | +| Inherited | - `by_reference`_ | +| options | - `cascade_validation`_ | +| | - `empty_data`_ | | | - `error_bubbling`_ | | | - `error_mapping`_ | -| | - `by_reference`_ | -| | - `empty_data`_ | -| | - `required`_ | +| | - `label`_ | +| | - `label_attr`_ | | | - `mapped`_ | -| | - `cascade_validation`_ | +| | - `required`_ | +-------------+-----------------------------------------------------------------------------+ | Parent type | :doc:`form ` | +-------------+-----------------------------------------------------------------------------+ @@ -211,39 +211,6 @@ you need is the JavaScript: Field Options ------------- -type -~~~~ - -**type**: ``string`` or :class:`Symfony\\Component\\Form\\FormTypeInterface` **required** - -This is the field type for each item in this collection (e.g. ``text``, ``choice``, -etc). For example, if you have an array of email addresses, you'd use the -:doc:`email ` type. If you want to embed -a collection of some other form, create a new instance of your form type -and pass it as this option. - -options -~~~~~~~ - -**type**: ``array`` **default**: ``array()`` - -This is the array that's passed to the form type specified in the `type`_ -option. For example, if you used the :doc:`choice ` -type as your `type`_ option (e.g. for a collection of drop-down menus), then -you'd need to at least pass the ``choices`` option to the underlying type:: - - $builder->add('favorite_cities', 'collection', array( - 'type' => 'choice', - 'options' => array( - 'choices' => array( - 'nashville' => 'Nashville', - 'paris' => 'Paris', - 'berlin' => 'Berlin', - 'london' => 'London', - ), - ), - )); - allow_add ~~~~~~~~~ @@ -288,6 +255,28 @@ For more information, see :ref:`cookbook-form-collections-remove`. None of this is handled automatically. For more information, see :ref:`cookbook-form-collections-remove`. +options +~~~~~~~ + +**type**: ``array`` **default**: ``array()`` + +This is the array that's passed to the form type specified in the `type`_ +option. For example, if you used the :doc:`choice ` +type as your `type`_ option (e.g. for a collection of drop-down menus), then +you'd need to at least pass the ``choices`` option to the underlying type:: + + $builder->add('favorite_cities', 'collection', array( + 'type' => 'choice', + 'options' => array( + 'choices' => array( + 'nashville' => 'Nashville', + 'paris' => 'Paris', + 'berlin' => 'Berlin', + 'london' => 'London', + ), + ), + )); + prototype ~~~~~~~~~ @@ -336,29 +325,29 @@ If you have several collections in your form, or worse, nested collections you may want to change the placeholder so that unrelated placeholders are not replaced with the same value. +type +~~~~ + +**type**: ``string`` or :class:`Symfony\\Component\\Form\\FormTypeInterface` **required** + +This is the field type for each item in this collection (e.g. ``text``, ``choice``, +etc). For example, if you have an array of email addresses, you'd use the +:doc:`email ` type. If you want to embed +a collection of some other form, create a new instance of your form type +and pass it as this option. + Inherited Options ----------------- These options inherit from the :doc:`form ` type. Not all options are listed here - only the most applicable to this type: -.. include:: /reference/forms/types/options/label.rst.inc - -.. include:: /reference/forms/types/options/label_attr.rst.inc - -error_bubbling -~~~~~~~~~~~~~~ - -**type**: ``Boolean`` **default**: ``true`` - -.. include:: /reference/forms/types/options/_error_bubbling_body.rst.inc - -.. include:: /reference/forms/types/options/error_mapping.rst.inc - .. _reference-form-types-by-reference: .. include:: /reference/forms/types/options/by_reference.rst.inc +.. include:: /reference/forms/types/options/cascade_validation.rst.inc + .. include:: /reference/forms/types/options/empty_data.rst.inc :end-before: DEFAULT_PLACEHOLDER @@ -367,11 +356,22 @@ The default value is ``array()`` (empty array). .. include:: /reference/forms/types/options/empty_data.rst.inc :start-after: DEFAULT_PLACEHOLDER -.. include:: /reference/forms/types/options/required.rst.inc +error_bubbling +~~~~~~~~~~~~~~ + +**type**: ``Boolean`` **default**: ``true`` + +.. include:: /reference/forms/types/options/_error_bubbling_body.rst.inc + +.. include:: /reference/forms/types/options/error_mapping.rst.inc + +.. include:: /reference/forms/types/options/label.rst.inc + +.. include:: /reference/forms/types/options/label_attr.rst.inc .. include:: /reference/forms/types/options/mapped.rst.inc -.. include:: /reference/forms/types/options/cascade_validation.rst.inc +.. include:: /reference/forms/types/options/required.rst.inc Field Variables --------------- diff --git a/reference/forms/types/country.rst b/reference/forms/types/country.rst index f077b1fc34a..c50ac519a48 100644 --- a/reference/forms/types/country.rst +++ b/reference/forms/types/country.rst @@ -25,20 +25,25 @@ you should just use the ``choice`` type directly. | Overridden | - `choices`_ | | Options | | +-------------+-----------------------------------------------------------------------+ -| Inherited | - `multiple`_ | -| options | - `expanded`_ | -| | - `preferred_choices`_ | +| Inherited | from the :doc:`choice ` type | +| options | | | | - `empty_value`_ | | | - `error_bubbling`_ | | | - `error_mapping`_ | +| | - `expanded`_ | +| | - `multiple`_ | +| | - `preferred_choices`_ | +| | | +| | from the :doc:`form ` type | +| | | +| | - `data`_ | +| | - `disabled`_ | | | - `empty_data`_ | -| | - `required`_ | | | - `label`_ | | | - `label_attr`_ | -| | - `data`_ | -| | - `read_only`_ | -| | - `disabled`_ | | | - `mapped`_ | +| | - `read_only`_ | +| | - `required`_ | +-------------+-----------------------------------------------------------------------+ | Parent type | :doc:`choice ` | +-------------+-----------------------------------------------------------------------+ @@ -61,20 +66,24 @@ Inherited Options These options inherit from the :doc:`choice ` type: -.. include:: /reference/forms/types/options/multiple.rst.inc - -.. include:: /reference/forms/types/options/expanded.rst.inc - -.. include:: /reference/forms/types/options/preferred_choices.rst.inc - .. include:: /reference/forms/types/options/empty_value.rst.inc .. include:: /reference/forms/types/options/error_bubbling.rst.inc .. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/expanded.rst.inc + +.. include:: /reference/forms/types/options/multiple.rst.inc + +.. include:: /reference/forms/types/options/preferred_choices.rst.inc + These options inherit from the :doc:`form ` type: +.. include:: /reference/forms/types/options/data.rst.inc + +.. include:: /reference/forms/types/options/disabled.rst.inc + .. include:: /reference/forms/types/options/empty_data.rst.inc :end-before: DEFAULT_PLACEHOLDER @@ -87,16 +96,12 @@ The actual default value of this option depends on other field options: .. include:: /reference/forms/types/options/empty_data.rst.inc :start-after: DEFAULT_PLACEHOLDER -.. include:: /reference/forms/types/options/required.rst.inc - .. include:: /reference/forms/types/options/label.rst.inc .. include:: /reference/forms/types/options/label_attr.rst.inc -.. include:: /reference/forms/types/options/data.rst.inc +.. include:: /reference/forms/types/options/mapped.rst.inc .. include:: /reference/forms/types/options/read_only.rst.inc -.. include:: /reference/forms/types/options/disabled.rst.inc - -.. include:: /reference/forms/types/options/mapped.rst.inc +.. include:: /reference/forms/types/options/required.rst.inc diff --git a/reference/forms/types/currency.rst b/reference/forms/types/currency.rst index 053ffa09101..f009d726993 100644 --- a/reference/forms/types/currency.rst +++ b/reference/forms/types/currency.rst @@ -19,19 +19,24 @@ should just use the ``choice`` type directly. | Overridden | - `choices`_ | | Options | | +-------------+------------------------------------------------------------------------+ -| Inherited | - `multiple`_ | -| options | - `expanded`_ | -| | - `preferred_choices`_ | +| Inherited | from the :doc:`choice ` type | +| options | | | | - `empty_value`_ | | | - `error_bubbling`_ | +| | - `expanded`_ | +| | - `multiple`_ | +| | - `preferred_choices`_ | +| | | +| | from the :doc:`form ` type | +| | | +| | - `data`_ | +| | - `disabled`_ | | | - `empty_data`_ | -| | - `required`_ | | | - `label`_ | | | - `label_attr`_ | -| | - `data`_ | -| | - `read_only`_ | -| | - `disabled`_ | | | - `mapped`_ | +| | - `read_only`_ | +| | - `required`_ | +-------------+------------------------------------------------------------------------+ | Parent type | :doc:`choice ` | +-------------+------------------------------------------------------------------------+ @@ -53,17 +58,21 @@ Inherited Options These options inherit from the :doc:`choice` type: -.. include:: /reference/forms/types/options/multiple.rst.inc +.. include:: /reference/forms/types/options/empty_value.rst.inc + +.. include:: /reference/forms/types/options/error_bubbling.rst.inc .. include:: /reference/forms/types/options/expanded.rst.inc +.. include:: /reference/forms/types/options/multiple.rst.inc + .. include:: /reference/forms/types/options/preferred_choices.rst.inc -.. include:: /reference/forms/types/options/empty_value.rst.inc +These options inherit from the :doc:`form` type: -.. include:: /reference/forms/types/options/error_bubbling.rst.inc +.. include:: /reference/forms/types/options/data.rst.inc -These options inherit from the :doc:`form` type: +.. include:: /reference/forms/types/options/disabled.rst.inc .. include:: /reference/forms/types/options/empty_data.rst.inc :end-before: DEFAULT_PLACEHOLDER @@ -77,18 +86,14 @@ The actual default value of this option depends on other field options: .. include:: /reference/forms/types/options/empty_data.rst.inc :start-after: DEFAULT_PLACEHOLDER -.. include:: /reference/forms/types/options/required.rst.inc - .. include:: /reference/forms/types/options/label.rst.inc .. include:: /reference/forms/types/options/label_attr.rst.inc -.. include:: /reference/forms/types/options/data.rst.inc +.. include:: /reference/forms/types/options/mapped.rst.inc .. include:: /reference/forms/types/options/read_only.rst.inc -.. include:: /reference/forms/types/options/disabled.rst.inc - -.. include:: /reference/forms/types/options/mapped.rst.inc +.. include:: /reference/forms/types/options/required.rst.inc .. _`3-letter ISO 4217`: http://en.wikipedia.org/wiki/ISO_4217 diff --git a/reference/forms/types/date.rst b/reference/forms/types/date.rst index d7b60bf9230..994ff6156b3 100644 --- a/reference/forms/types/date.rst +++ b/reference/forms/types/date.rst @@ -19,27 +19,27 @@ day, and year) or three select boxes (see the `widget`_ option). +----------------------+-----------------------------------------------------------------------------+ | Rendered as | single text box or three select fields | +----------------------+-----------------------------------------------------------------------------+ -| Options | - `widget`_ | -| | - `input`_ | +| Options | - `days`_ | | | - `empty_value`_ | -| | - `years`_ | -| | - `months`_ | -| | - `days`_ | | | - `format`_ | +| | - `input`_ | | | - `model_timezone`_ | +| | - `months`_ | | | - `view_timezone`_ | +| | - `widget`_ | +| | - `years`_ | +----------------------+-----------------------------------------------------------------------------+ | Overridden Options | - `by_reference`_ | | | - `error_bubbling`_ | +----------------------+-----------------------------------------------------------------------------+ | Inherited | - `data`_ | -| options | - `invalid_message`_ | +| options | - `disabled`_ | +| | - `error_mapping`_ | +| | - `inherit_data`_ | +| | - `invalid_message`_ | | | - `invalid_message_parameters`_ | -| | - `read_only`_ | -| | - `disabled`_ | | | - `mapped`_ | -| | - `inherit_data`_ | -| | - `error_mapping`_ | +| | - `read_only`_ | +----------------------+-----------------------------------------------------------------------------+ | Parent type | :doc:`form ` | +----------------------+-----------------------------------------------------------------------------+ @@ -80,11 +80,7 @@ values. Field Options ------------- -.. include:: /reference/forms/types/options/date_widget.rst.inc - -.. _form-reference-date-input: - -.. include:: /reference/forms/types/options/date_input.rst.inc +.. include:: /reference/forms/types/options/days.rst.inc empty_value ~~~~~~~~~~~ @@ -105,20 +101,24 @@ Alternatively, you can specify a string to be displayed for the "blank" value:: 'empty_value' => array('year' => 'Year', 'month' => 'Month', 'day' => 'Day') )); -.. include:: /reference/forms/types/options/years.rst.inc - -.. include:: /reference/forms/types/options/months.rst.inc - -.. include:: /reference/forms/types/options/days.rst.inc - .. _reference-forms-type-date-format: .. include:: /reference/forms/types/options/date_format.rst.inc +.. _form-reference-date-input: + +.. include:: /reference/forms/types/options/date_input.rst.inc + .. include:: /reference/forms/types/options/model_timezone.rst.inc +.. include:: /reference/forms/types/options/months.rst.inc + .. include:: /reference/forms/types/options/view_timezone.rst.inc +.. include:: /reference/forms/types/options/date_widget.rst.inc + +.. include:: /reference/forms/types/options/years.rst.inc + Overridden Options ------------------ @@ -141,19 +141,19 @@ These options inherit from the :doc:`form ` type: .. include:: /reference/forms/types/options/data.rst.inc -.. include:: /reference/forms/types/options/invalid_message.rst.inc +.. include:: /reference/forms/types/options/disabled.rst.inc -.. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc +.. include:: /reference/forms/types/options/error_mapping.rst.inc -.. include:: /reference/forms/types/options/read_only.rst.inc +.. include:: /reference/forms/types/options/inherit_data.rst.inc -.. include:: /reference/forms/types/options/disabled.rst.inc +.. include:: /reference/forms/types/options/invalid_message.rst.inc -.. include:: /reference/forms/types/options/mapped.rst.inc +.. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc -.. include:: /reference/forms/types/options/inherit_data.rst.inc +.. include:: /reference/forms/types/options/mapped.rst.inc -.. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/read_only.rst.inc Field Variables --------------- diff --git a/reference/forms/types/datetime.rst b/reference/forms/types/datetime.rst index 111bf1220d3..7b0d0e089f5 100644 --- a/reference/forms/types/datetime.rst +++ b/reference/forms/types/datetime.rst @@ -15,31 +15,31 @@ data can be a ``DateTime`` object, a string, a timestamp or an array. +----------------------+-----------------------------------------------------------------------------+ | Rendered as | single text box or three select fields | +----------------------+-----------------------------------------------------------------------------+ -| Options | - `date_widget`_ | -| | - `time_widget`_ | -| | - `widget`_ | -| | - `input`_ | -| | - `date_format`_ | +| Options | - `date_format`_ | +| | - `date_widget`_ | +| | - `days`_ | +| | - `empty_value`_ | | | - `format`_ | | | - `hours`_ | +| | - `input`_ | | | - `minutes`_ | -| | - `seconds`_ | -| | - `years`_ | +| | - `model_timezone`_ | | | - `months`_ | -| | - `days`_ | +| | - `seconds`_ | +| | - `time_widget`_ | +| | - `view_timezone`_ | +| | - `widget`_ | | | - `with_minutes`_ | | | - `with_seconds`_ | -| | - `model_timezone`_ | -| | - `view_timezone`_ | -| | - `empty_value`_ | +| | - `years`_ | +----------------------+-----------------------------------------------------------------------------+ | Inherited | - `data`_ | -| options | - `invalid_message`_ | +| options | - `disabled`_ | +| | - `inherit_data`_ | +| | - `invalid_message`_ | | | - `invalid_message_parameters`_ | -| | - `read_only`_ | -| | - `disabled`_ | | | - `mapped`_ | -| | - `inherit_data`_ | +| | - `read_only`_ | +----------------------+-----------------------------------------------------------------------------+ | Parent type | :doc:`form ` | +----------------------+-----------------------------------------------------------------------------+ @@ -49,28 +49,38 @@ data can be a ``DateTime`` object, a string, a timestamp or an array. Field Options ------------- -date_widget +date_format ~~~~~~~~~~~ -**type**: ``string`` **default**: ``choice`` +**type**: ``integer`` or ``string`` **default**: ``IntlDateFormatter::MEDIUM`` -Defines the ``widget`` option for the :doc:`date ` type +Defines the ``format`` option that will be passed down to the date field. +See the :ref:`date type's format option ` +for more details. -time_widget +date_widget ~~~~~~~~~~~ **type**: ``string`` **default**: ``choice`` -Defines the ``widget`` option for the :doc:`time ` type +Defines the ``widget`` option for the :doc:`date ` type -widget +.. include:: /reference/forms/types/options/days.rst.inc + +.. include:: /reference/forms/types/options/empty_value.rst.inc + +format ~~~~~~ -**type**: ``string`` **default**: ``null`` +**type**: ``string`` **default**: ``Symfony\Component\Form\Extension\Core\Type\DateTimeType::HTML5_FORMAT`` -Defines the ``widget`` option for both the :doc:`date ` -type and :doc:`time ` type. This can be overridden with -the `date_widget`_ and `time_widget`_ options. +If the ``widget`` option is set to ``single_text``, this option specifies the +the format of the input, i.e. how Symfony will interpret the given input +as a datetime string. It defaults to the `RFC 3339`_ format which is used +by the HTML5 ``datetime`` field. Keeping the default value will cause the +field to be rendered as an ``input`` field with ``type="datetime"``. + +.. include:: /reference/forms/types/options/hours.rst.inc input ~~~~~ @@ -90,47 +100,37 @@ this format. .. include:: /reference/forms/types/options/_date_limitation.rst.inc -date_format -~~~~~~~~~~~ - -**type**: ``integer`` or ``string`` **default**: ``IntlDateFormatter::MEDIUM`` +.. include:: /reference/forms/types/options/minutes.rst.inc -Defines the ``format`` option that will be passed down to the date field. -See the :ref:`date type's format option ` -for more details. +.. include:: /reference/forms/types/options/model_timezone.rst.inc -format -~~~~~~ +.. include:: /reference/forms/types/options/months.rst.inc -**type**: ``string`` **default**: ``Symfony\Component\Form\Extension\Core\Type\DateTimeType::HTML5_FORMAT`` +.. include:: /reference/forms/types/options/seconds.rst.inc -If the ``widget`` option is set to ``single_text``, this option specifies the -the format of the input, i.e. how Symfony will interpret the given input -as a datetime string. It defaults to the `RFC 3339`_ format which is used -by the HTML5 ``datetime`` field. Keeping the default value will cause the -field to be rendered as an ``input`` field with ``type="datetime"``. +time_widget +~~~~~~~~~~~ -.. include:: /reference/forms/types/options/hours.rst.inc +**type**: ``string`` **default**: ``choice`` -.. include:: /reference/forms/types/options/minutes.rst.inc +Defines the ``widget`` option for the :doc:`time ` type -.. include:: /reference/forms/types/options/seconds.rst.inc +.. include:: /reference/forms/types/options/view_timezone.rst.inc -.. include:: /reference/forms/types/options/years.rst.inc +widget +~~~~~~ -.. include:: /reference/forms/types/options/months.rst.inc +**type**: ``string`` **default**: ``null`` -.. include:: /reference/forms/types/options/days.rst.inc +Defines the ``widget`` option for both the :doc:`date ` +type and :doc:`time ` type. This can be overridden with +the `date_widget`_ and `time_widget`_ options. .. include:: /reference/forms/types/options/with_minutes.rst.inc .. include:: /reference/forms/types/options/with_seconds.rst.inc -.. include:: /reference/forms/types/options/model_timezone.rst.inc - -.. include:: /reference/forms/types/options/view_timezone.rst.inc - -.. include:: /reference/forms/types/options/empty_value.rst.inc +.. include:: /reference/forms/types/options/years.rst.inc Inherited Options ----------------- @@ -139,17 +139,17 @@ These options inherit from the :doc:`form ` type: .. include:: /reference/forms/types/options/data.rst.inc -.. include:: /reference/forms/types/options/invalid_message.rst.inc +.. include:: /reference/forms/types/options/disabled.rst.inc -.. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc +.. include:: /reference/forms/types/options/inherit_data.rst.inc -.. include:: /reference/forms/types/options/read_only.rst.inc +.. include:: /reference/forms/types/options/invalid_message.rst.inc -.. include:: /reference/forms/types/options/disabled.rst.inc +.. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc .. include:: /reference/forms/types/options/mapped.rst.inc -.. include:: /reference/forms/types/options/inherit_data.rst.inc +.. include:: /reference/forms/types/options/read_only.rst.inc Field Variables --------------- diff --git a/reference/forms/types/email.rst b/reference/forms/types/email.rst index 53a01e25080..9a60ae4f32c 100644 --- a/reference/forms/types/email.rst +++ b/reference/forms/types/email.rst @@ -10,18 +10,18 @@ The ``email`` field is a text field that is rendered using the HTML5 +-------------+---------------------------------------------------------------------+ | Rendered as | ``input`` ``email`` field (a text box) | +-------------+---------------------------------------------------------------------+ -| Inherited | - `max_length`_ | -| options | - `empty_data`_ | -| | - `required`_ | -| | - `label`_ | -| | - `label_attr`_ | -| | - `data`_ | -| | - `trim`_ | -| | - `read_only`_ | -| | - `disabled`_ | +| Inherited | - `data`_ | +| options | - `disabled`_ | +| | - `empty_data`_ | | | - `error_bubbling`_ | | | - `error_mapping`_ | +| | - `label`_ | +| | - `label_attr`_ | | | - `mapped`_ | +| | - `max_length`_ | +| | - `read_only`_ | +| | - `required`_ | +| | - `trim`_ | +-------------+---------------------------------------------------------------------+ | Parent type | :doc:`text ` | +-------------+---------------------------------------------------------------------+ @@ -33,7 +33,9 @@ Inherited Options These options inherit from the :doc:`form ` type: -.. include:: /reference/forms/types/options/max_length.rst.inc +.. include:: /reference/forms/types/options/data.rst.inc + +.. include:: /reference/forms/types/options/disabled.rst.inc .. include:: /reference/forms/types/options/empty_data.rst.inc :end-before: DEFAULT_PLACEHOLDER @@ -43,22 +45,20 @@ The default value is ``''`` (the empty string). .. include:: /reference/forms/types/options/empty_data.rst.inc :start-after: DEFAULT_PLACEHOLDER -.. include:: /reference/forms/types/options/required.rst.inc +.. include:: /reference/forms/types/options/error_bubbling.rst.inc + +.. include:: /reference/forms/types/options/error_mapping.rst.inc .. include:: /reference/forms/types/options/label.rst.inc .. include:: /reference/forms/types/options/label_attr.rst.inc -.. include:: /reference/forms/types/options/data.rst.inc +.. include:: /reference/forms/types/options/mapped.rst.inc -.. include:: /reference/forms/types/options/trim.rst.inc +.. include:: /reference/forms/types/options/max_length.rst.inc .. include:: /reference/forms/types/options/read_only.rst.inc -.. include:: /reference/forms/types/options/disabled.rst.inc - -.. include:: /reference/forms/types/options/error_bubbling.rst.inc - -.. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/required.rst.inc -.. include:: /reference/forms/types/options/mapped.rst.inc +.. include:: /reference/forms/types/options/trim.rst.inc diff --git a/reference/forms/types/entity.rst b/reference/forms/types/entity.rst index b11e5971492..dcada6d96eb 100644 --- a/reference/forms/types/entity.rst +++ b/reference/forms/types/entity.rst @@ -14,28 +14,33 @@ objects from the database. +-------------+------------------------------------------------------------------+ | Options | - `class`_ | | | - `data_class`_ | -| | - `property`_ | +| | - `em`_ | | | - `group_by`_ | +| | - `property`_ | | | - `query_builder`_ | -| | - `em`_ | +-------------+------------------------------------------------------------------+ | Overridden | - `choices`_ | | Options | - `choice_list`_ | +-------------+------------------------------------------------------------------+ -| Inherited | - `multiple`_ | -| options | - `expanded`_ | -| | - `preferred_choices`_ | +| Inherited | from the :doc:`choice ` type: | +| options | | | | - `empty_value`_ | -| | - `empty_data`_ | -| | - `required`_ | -| | - `label`_ | -| | - `label_attr`_ | +| | - `expanded`_ | +| | - `multiple`_ | +| | - `preferred_choices`_ | +| | | +| | from the :doc:`form ` type: | +| | | | | - `data`_ | -| | - `read_only`_ | | | - `disabled`_ | +| | - `empty_data`_ | | | - `error_bubbling`_ | | | - `error_mapping`_ | +| | - `label`_ | +| | - `label_attr`_ | | | - `mapped`_ | +| | - `read_only`_ | +| | - `required`_ | +-------------+------------------------------------------------------------------+ | Parent type | :doc:`choice ` | +-------------+------------------------------------------------------------------+ @@ -109,6 +114,25 @@ or the short alias name (as shown prior). .. include:: /reference/forms/types/options/data_class.rst.inc +em +~~ + +**type**: ``string`` **default**: the default entity manager + +If specified, the specified entity manager will be used to load the choices +instead of the default entity manager. + +group_by +~~~~~~~~ + +**type**: ``string`` + +This is a property path (e.g. ``author.name``) used to organize the +available choices in groups. It only works when rendered as a select tag +and does so by adding ``optgroup`` elements around options. Choices that do not +return a value for this property path are rendered directly under the +select tag, without a surrounding optgroup. + property ~~~~~~~~ @@ -132,17 +156,6 @@ cast into a string and so must have a ``__toString()`` method. 'property' => 'translations[en].name', )); -group_by -~~~~~~~~ - -**type**: ``string`` - -This is a property path (e.g. ``author.name``) used to organize the -available choices in groups. It only works when rendered as a select tag -and does so by adding ``optgroup`` elements around options. Choices that do not -return a value for this property path are rendered directly under the -select tag, without a surrounding optgroup. - query_builder ~~~~~~~~~~~~~ @@ -154,26 +167,9 @@ either be a ``QueryBuilder`` object or a Closure. If using a Closure, it should take a single argument, which is the ``EntityRepository`` of the entity. -em -~~ - -**type**: ``string`` **default**: the default entity manager - -If specified, the specified entity manager will be used to load the choices -instead of the default entity manager. - Overridden Options ------------------ -choices -~~~~~~~ - -**type**: array || ``\Traversable`` **default**: ``null`` - -Instead of allowing the `class`_ and `query_builder`_ options to fetch the -entities to include for you, you can pass the ``choices`` option directly. -See :ref:`reference-forms-entity-choices`. - choice_list ~~~~~~~~~~~ @@ -184,11 +180,24 @@ for you, by using all of the above options. If you need to override this option, you may just consider using the :doc:`/reference/forms/types/choice` directly. +choices +~~~~~~~ + +**type**: array || ``\Traversable`` **default**: ``null`` + +Instead of allowing the `class`_ and `query_builder`_ options to fetch the +entities to include for you, you can pass the ``choices`` option directly. +See :ref:`reference-forms-entity-choices`. + Inherited Options ----------------- These options inherit from the :doc:`choice ` type: +.. include:: /reference/forms/types/options/empty_value.rst.inc + +.. include:: /reference/forms/types/options/expanded.rst.inc + .. include:: /reference/forms/types/options/multiple.rst.inc .. note:: @@ -198,8 +207,6 @@ These options inherit from the :doc:`choice ` typ as well. In addition, there is a complete example in the cookbook article :doc:`/cookbook/form/form_collections`. -.. include:: /reference/forms/types/options/expanded.rst.inc - .. include:: /reference/forms/types/options/preferred_choices.rst.inc .. note:: @@ -207,10 +214,12 @@ These options inherit from the :doc:`choice ` typ This option expects an array of entity objects, unlike the ``choice`` field that requires an array of keys. -.. include:: /reference/forms/types/options/empty_value.rst.inc - These options inherit from the :doc:`form ` type: +.. include:: /reference/forms/types/options/data.rst.inc + +.. include:: /reference/forms/types/options/disabled.rst.inc + .. include:: /reference/forms/types/options/empty_data.rst.inc :end-before: DEFAULT_PLACEHOLDER @@ -223,20 +232,16 @@ The actual default value of this option depends on other field options: .. include:: /reference/forms/types/options/empty_data.rst.inc :start-after: DEFAULT_PLACEHOLDER -.. include:: /reference/forms/types/options/required.rst.inc +.. include:: /reference/forms/types/options/error_bubbling.rst.inc + +.. include:: /reference/forms/types/options/error_mapping.rst.inc .. include:: /reference/forms/types/options/label.rst.inc .. include:: /reference/forms/types/options/label_attr.rst.inc -.. include:: /reference/forms/types/options/data.rst.inc +.. include:: /reference/forms/types/options/mapped.rst.inc .. include:: /reference/forms/types/options/read_only.rst.inc -.. include:: /reference/forms/types/options/disabled.rst.inc - -.. include:: /reference/forms/types/options/error_bubbling.rst.inc - -.. include:: /reference/forms/types/options/error_mapping.rst.inc - -.. include:: /reference/forms/types/options/mapped.rst.inc +.. include:: /reference/forms/types/options/required.rst.inc diff --git a/reference/forms/types/file.rst b/reference/forms/types/file.rst index 044d88874d9..3751bdff8b1 100644 --- a/reference/forms/types/file.rst +++ b/reference/forms/types/file.rst @@ -9,15 +9,15 @@ The ``file`` type represents a file input in your form. +-------------+---------------------------------------------------------------------+ | Rendered as | ``input`` ``file`` field | +-------------+---------------------------------------------------------------------+ -| Inherited | - `empty_data`_ | -| options | - `required`_ | -| | - `label`_ | -| | - `label_attr`_ | -| | - `read_only`_ | -| | - `disabled`_ | +| Inherited | - `disabled`_ | +| options | - `empty_data`_ | | | - `error_bubbling`_ | | | - `error_mapping`_ | +| | - `label`_ | +| | - `label_attr`_ | | | - `mapped`_ | +| | - `read_only`_ | +| | - `required`_ | +-------------+---------------------------------------------------------------------+ | Parent type | :doc:`form ` | +-------------+---------------------------------------------------------------------+ @@ -83,6 +83,8 @@ Inherited Options These options inherit from the :doc:`form ` type: +.. include:: /reference/forms/types/options/disabled.rst.inc + .. include:: /reference/forms/types/options/empty_data.rst.inc :end-before: DEFAULT_PLACEHOLDER @@ -91,21 +93,19 @@ The default value is ``null``. .. include:: /reference/forms/types/options/empty_data.rst.inc :start-after: DEFAULT_PLACEHOLDER -.. include:: /reference/forms/types/options/required.rst.inc +.. include:: /reference/forms/types/options/error_bubbling.rst.inc + +.. include:: /reference/forms/types/options/error_mapping.rst.inc .. include:: /reference/forms/types/options/label.rst.inc .. include:: /reference/forms/types/options/label_attr.rst.inc -.. include:: /reference/forms/types/options/read_only.rst.inc - -.. include:: /reference/forms/types/options/disabled.rst.inc - -.. include:: /reference/forms/types/options/error_bubbling.rst.inc +.. include:: /reference/forms/types/options/mapped.rst.inc -.. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/read_only.rst.inc -.. include:: /reference/forms/types/options/mapped.rst.inc +.. include:: /reference/forms/types/options/required.rst.inc Form Variables -------------- diff --git a/reference/forms/types/form.rst b/reference/forms/types/form.rst index d3b281ad6ae..976f3c3e5d1 100644 --- a/reference/forms/types/form.rst +++ b/reference/forms/types/form.rst @@ -8,37 +8,37 @@ The ``form`` type predefines a couple of options that are then available on all types for which ``form`` is the parent type. +-----------+--------------------------------------------------------------------+ -| Options | - `data`_ | -| | - `data_class`_ | -| | - `empty_data`_ | +| Options | - `action`_ | +| | - `by_reference`_ | +| | - `cascade_validation`_ | | | - `compound`_ | -| | - `required`_ | -| | - `label_attr`_ | | | - `constraints`_ | -| | - `cascade_validation`_ | -| | - `read_only`_ | -| | - `trim`_ | -| | - `mapped`_ | -| | - `property_path`_ | -| | - `max_length`_ | -| | - `by_reference`_ | +| | - `data`_ | +| | - `data_class`_ | +| | - `empty_data`_ | | | - `error_bubbling`_ | -| | - `inherit_data`_ | | | - `error_mapping`_ | +| | - `extra_fields_message`_ | +| | - `inherit_data`_ | | | - `invalid_message`_ | | | - `invalid_message_parameters`_ | -| | - `extra_fields_message`_ | -| | - `post_max_size_message`_ | -| | - `pattern`_ | -| | - `action`_ | +| | - `label_attr`_ | +| | - `mapped`_ | +| | - `max_length`_ | | | - `method`_ | +| | - `pattern`_ | +| | - `post_max_size_message`_ | +| | - `property_path`_ | +| | - `read_only`_ | +| | - `required`_ | +| | - `trim`_ | +-----------+--------------------------------------------------------------------+ -| Inherited | - `block_name`_ | -| options | - `disabled`_ | +| Inherited | - `attr`_ | +| options | - `auto_initialize`_ | +| | - `block_name`_ | +| | - `disabled`_ | | | - `label`_ | -| | - `attr`_ | | | - `translation_domain`_ | -| | - `auto_initialize`_ | +-----------+--------------------------------------------------------------------+ | Parent | none | +-----------+--------------------------------------------------------------------+ @@ -48,6 +48,16 @@ on all types for which ``form`` is the parent type. Field Options ------------- +.. include:: /reference/forms/types/options/action.rst.inc + +.. include:: /reference/forms/types/options/by_reference.rst.inc + +.. include:: /reference/forms/types/options/cascade_validation.rst.inc + +.. include:: /reference/forms/types/options/compound.rst.inc + +.. include:: /reference/forms/types/options/constraints.rst.inc + .. include:: /reference/forms/types/options/data.rst.inc .. include:: /reference/forms/types/options/data_class.rst.inc @@ -66,53 +76,43 @@ The actual default value of this option depends on other field options: .. include:: /reference/forms/types/options/empty_data.rst.inc :start-after: DEFAULT_PLACEHOLDER -.. include:: /reference/forms/types/options/compound.rst.inc - -.. _reference-form-option-required: +.. include:: /reference/forms/types/options/error_bubbling.rst.inc -.. include:: /reference/forms/types/options/required.rst.inc +.. include:: /reference/forms/types/options/error_mapping.rst.inc -.. include:: /reference/forms/types/options/label_attr.rst.inc +.. include:: /reference/forms/types/options/extra_fields_message.rst.inc -.. include:: /reference/forms/types/options/constraints.rst.inc +.. include:: /reference/forms/types/options/inherit_data.rst.inc -.. include:: /reference/forms/types/options/cascade_validation.rst.inc +.. include:: /reference/forms/types/options/invalid_message.rst.inc -.. include:: /reference/forms/types/options/read_only.rst.inc +.. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc -.. include:: /reference/forms/types/options/trim.rst.inc +.. include:: /reference/forms/types/options/label_attr.rst.inc .. include:: /reference/forms/types/options/mapped.rst.inc -.. include:: /reference/forms/types/options/property_path.rst.inc - .. _reference-form-option-max_length: .. include:: /reference/forms/types/options/max_length.rst.inc -.. include:: /reference/forms/types/options/by_reference.rst.inc - -.. include:: /reference/forms/types/options/error_bubbling.rst.inc - -.. include:: /reference/forms/types/options/inherit_data.rst.inc - -.. include:: /reference/forms/types/options/error_mapping.rst.inc - -.. include:: /reference/forms/types/options/invalid_message.rst.inc +.. include:: /reference/forms/types/options/method.rst.inc -.. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc +.. _reference-form-option-pattern: -.. include:: /reference/forms/types/options/extra_fields_message.rst.inc +.. include:: /reference/forms/types/options/pattern.rst.inc .. include:: /reference/forms/types/options/post_max_size_message.rst.inc -.. _reference-form-option-pattern: +.. include:: /reference/forms/types/options/property_path.rst.inc -.. include:: /reference/forms/types/options/pattern.rst.inc +.. include:: /reference/forms/types/options/read_only.rst.inc -.. include:: /reference/forms/types/options/action.rst.inc +.. _reference-form-option-required: -.. include:: /reference/forms/types/options/method.rst.inc +.. include:: /reference/forms/types/options/required.rst.inc + +.. include:: /reference/forms/types/options/trim.rst.inc Inherited Options ----------------- @@ -123,14 +123,14 @@ The ``BaseType`` class is the parent class for both the ``form`` type and the :doc:`button type `, but it is not part of the form type tree (i.e. it can not be used as a form type on its own). +.. include:: /reference/forms/types/options/attr.rst.inc + +.. include:: /reference/forms/types/options/auto_initialize.rst.inc + .. include:: /reference/forms/types/options/block_name.rst.inc .. include:: /reference/forms/types/options/disabled.rst.inc .. include:: /reference/forms/types/options/label.rst.inc -.. include:: /reference/forms/types/options/attr.rst.inc - .. include:: /reference/forms/types/options/translation_domain.rst.inc - -.. include:: /reference/forms/types/options/auto_initialize.rst.inc diff --git a/reference/forms/types/hidden.rst b/reference/forms/types/hidden.rst index 8d3edc13e3d..18a293015b2 100644 --- a/reference/forms/types/hidden.rst +++ b/reference/forms/types/hidden.rst @@ -9,13 +9,13 @@ The hidden type represents a hidden input field. +-------------+----------------------------------------------------------------------+ | Rendered as | ``input`` ``hidden`` field | +-------------+----------------------------------------------------------------------+ -| Overridden | - `required`_ | -| Options | - `error_bubbling`_ | +| Overriden | - `error_bubbling`_ | +| options | - `required`_ | +-------------+----------------------------------------------------------------------+ | Inherited | - `data`_ | -| options | - `property_path`_ | +| options | - `error_mapping`_ | | | - `mapped`_ | -| | - `error_mapping`_ | +| | - `property_path`_ | +-------------+----------------------------------------------------------------------+ | Parent type | :doc:`form ` | +-------------+----------------------------------------------------------------------+ @@ -25,13 +25,6 @@ The hidden type represents a hidden input field. Overridden Options ------------------ -required -~~~~~~~~ - -**default**: ``false`` - -Hidden fields cannot have a required attribute. - error_bubbling ~~~~~~~~~~~~~~ @@ -39,6 +32,13 @@ error_bubbling Pass errors to the root form, otherwise they will not be visible. +required +~~~~~~~~ + +**default**: ``false`` + +Hidden fields cannot have a required attribute. + Inherited Options ----------------- @@ -46,8 +46,8 @@ These options inherit from the :doc:`form ` type: .. include:: /reference/forms/types/options/data.rst.inc -.. include:: /reference/forms/types/options/property_path.rst.inc +.. include:: /reference/forms/types/options/error_mapping.rst.inc .. include:: /reference/forms/types/options/mapped.rst.inc -.. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/property_path.rst.inc diff --git a/reference/forms/types/integer.rst b/reference/forms/types/integer.rst index 78e564ebf49..1a28a935f79 100644 --- a/reference/forms/types/integer.rst +++ b/reference/forms/types/integer.rst @@ -15,22 +15,22 @@ integers. By default, all non-integer values (e.g. 6.78) will round down (e.g. 6 +-------------+-----------------------------------------------------------------------+ | Rendered as | ``input`` ``number`` field | +-------------+-----------------------------------------------------------------------+ -| Options | - `rounding_mode`_ | +| Options | - `grouping`_ | | | - `precision`_ | -| | - `grouping`_ | +| | - `rounding_mode`_ | +-------------+-----------------------------------------------------------------------+ -| Inherited | - `empty_data`_ | -| options | - `required`_ | -| | - `label`_ | -| | - `label_attr`_ | -| | - `data`_ | -| | - `read_only`_ | -| | - `disabled`_ | +| Inherited | - `data`_ | +| options | - `disabled`_ | +| | - `empty_data`_ | | | - `error_bubbling`_ | | | - `error_mapping`_ | | | - `invalid_message`_ | | | - `invalid_message_parameters`_ | +| | - `label`_ | +| | - `label_attr`_ | | | - `mapped`_ | +| | - `read_only`_ | +| | - `required`_ | +-------------+-----------------------------------------------------------------------+ | Parent type | :doc:`form ` | +-------------+-----------------------------------------------------------------------+ @@ -40,6 +40,8 @@ integers. By default, all non-integer values (e.g. 6.78) will round down (e.g. 6 Field Options ------------- +.. include:: /reference/forms/types/options/grouping.rst.inc + .. include:: /reference/forms/types/options/precision.rst.inc rounding_mode @@ -63,13 +65,15 @@ on the :class:`Symfony\\Component\\Form\\Extension\\Core\\DataTransformer\\Integ * ``IntegerToLocalizedStringTransformer::ROUND_CEILING`` Rounding mode to round towards positive infinity. -.. include:: /reference/forms/types/options/grouping.rst.inc - Inherited Options ----------------- These options inherit from the :doc:`form ` type: +.. include:: /reference/forms/types/options/data.rst.inc + +.. include:: /reference/forms/types/options/disabled.rst.inc + .. include:: /reference/forms/types/options/empty_data.rst.inc :end-before: DEFAULT_PLACEHOLDER @@ -78,18 +82,6 @@ The default value is ``''`` (the empty string). .. include:: /reference/forms/types/options/empty_data.rst.inc :start-after: DEFAULT_PLACEHOLDER -.. include:: /reference/forms/types/options/required.rst.inc - -.. include:: /reference/forms/types/options/label.rst.inc - -.. include:: /reference/forms/types/options/label_attr.rst.inc - -.. include:: /reference/forms/types/options/data.rst.inc - -.. include:: /reference/forms/types/options/read_only.rst.inc - -.. include:: /reference/forms/types/options/disabled.rst.inc - .. include:: /reference/forms/types/options/error_bubbling.rst.inc .. include:: /reference/forms/types/options/error_mapping.rst.inc @@ -98,4 +90,12 @@ The default value is ``''`` (the empty string). .. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc +.. include:: /reference/forms/types/options/label.rst.inc + +.. include:: /reference/forms/types/options/label_attr.rst.inc + .. include:: /reference/forms/types/options/mapped.rst.inc + +.. include:: /reference/forms/types/options/read_only.rst.inc + +.. include:: /reference/forms/types/options/required.rst.inc diff --git a/reference/forms/types/language.rst b/reference/forms/types/language.rst index fc24b91e36e..7e18fcbcf39 100644 --- a/reference/forms/types/language.rst +++ b/reference/forms/types/language.rst @@ -26,20 +26,25 @@ you should just use the ``choice`` type directly. | Overridden | - `choices`_ | | Options | | +-------------+------------------------------------------------------------------------+ -| Inherited | - `multiple`_ | -| options | - `expanded`_ | -| | - `preferred_choices`_ | +| Inherited | from the :doc:`choice ` type | +| options | | | | - `empty_value`_ | | | - `error_bubbling`_ | | | - `error_mapping`_ | +| | - `expanded`_ | +| | - `multiple`_ | +| | - `preferred_choices`_ | +| | | +| | from the :doc:`form ` type | +| | | +| | - `data`_ | +| | - `disabled`_ | | | - `empty_data`_ | -| | - `required`_ | | | - `label`_ | | | - `label_attr`_ | -| | - `data`_ | -| | - `read_only`_ | -| | - `disabled`_ | | | - `mapped`_ | +| | - `read_only`_ | +| | - `required`_ | +-------------+------------------------------------------------------------------------+ | Parent type | :doc:`choice ` | +-------------+------------------------------------------------------------------------+ @@ -62,20 +67,24 @@ Inherited Options These options inherit from the :doc:`choice ` type: -.. include:: /reference/forms/types/options/multiple.rst.inc - -.. include:: /reference/forms/types/options/expanded.rst.inc - -.. include:: /reference/forms/types/options/preferred_choices.rst.inc - .. include:: /reference/forms/types/options/empty_value.rst.inc .. include:: /reference/forms/types/options/error_bubbling.rst.inc .. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/expanded.rst.inc + +.. include:: /reference/forms/types/options/multiple.rst.inc + +.. include:: /reference/forms/types/options/preferred_choices.rst.inc + These options inherit from the :doc:`form ` type: +.. include:: /reference/forms/types/options/data.rst.inc + +.. include:: /reference/forms/types/options/disabled.rst.inc + .. include:: /reference/forms/types/options/empty_data.rst.inc :end-before: DEFAULT_PLACEHOLDER @@ -88,16 +97,12 @@ The actual default value of this option depends on other field options: .. include:: /reference/forms/types/options/empty_data.rst.inc :start-after: DEFAULT_PLACEHOLDER -.. include:: /reference/forms/types/options/required.rst.inc - .. include:: /reference/forms/types/options/label.rst.inc .. include:: /reference/forms/types/options/label_attr.rst.inc -.. include:: /reference/forms/types/options/data.rst.inc +.. include:: /reference/forms/types/options/mapped.rst.inc .. include:: /reference/forms/types/options/read_only.rst.inc -.. include:: /reference/forms/types/options/disabled.rst.inc - -.. include:: /reference/forms/types/options/mapped.rst.inc +.. include:: /reference/forms/types/options/required.rst.inc diff --git a/reference/forms/types/locale.rst b/reference/forms/types/locale.rst index 4a33d06f600..e8610495901 100644 --- a/reference/forms/types/locale.rst +++ b/reference/forms/types/locale.rst @@ -28,20 +28,25 @@ you should just use the ``choice`` type directly. | Overridden | - `choices`_ | | Options | | +-------------+------------------------------------------------------------------------+ -| Inherited | - `multiple`_ | -| options | - `expanded`_ | -| | - `preferred_choices`_ | +| Inherited | from the :doc:`choice ` type | +| options | | | | - `empty_value`_ | | | - `error_bubbling`_ | | | - `error_mapping`_ | +| | - `expanded`_ | +| | - `multiple`_ | +| | - `preferred_choices`_ | +| | | +| | from the :doc:`form ` type | +| | | +| | - `data`_ | +| | - `disabled`_ | | | - `empty_data`_ | -| | - `required`_ | | | - `label`_ | | | - `label_attr`_ | -| | - `data`_ | -| | - `read_only`_ | -| | - `disabled`_ | | | - `mapped`_ | +| | - `read_only`_ | +| | - `required`_ | +-------------+------------------------------------------------------------------------+ | Parent type | :doc:`choice ` | +-------------+------------------------------------------------------------------------+ @@ -64,20 +69,24 @@ Inherited Options These options inherit from the :doc:`choice ` type: -.. include:: /reference/forms/types/options/multiple.rst.inc - -.. include:: /reference/forms/types/options/expanded.rst.inc - -.. include:: /reference/forms/types/options/preferred_choices.rst.inc - .. include:: /reference/forms/types/options/empty_value.rst.inc .. include:: /reference/forms/types/options/error_bubbling.rst.inc .. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/expanded.rst.inc + +.. include:: /reference/forms/types/options/multiple.rst.inc + +.. include:: /reference/forms/types/options/preferred_choices.rst.inc + These options inherit from the :doc:`form ` type: +.. include:: /reference/forms/types/options/data.rst.inc + +.. include:: /reference/forms/types/options/disabled.rst.inc + .. include:: /reference/forms/types/options/empty_data.rst.inc :end-before: DEFAULT_PLACEHOLDER @@ -90,19 +99,15 @@ The actual default value of this option depends on other field options: .. include:: /reference/forms/types/options/empty_data.rst.inc :start-after: DEFAULT_PLACEHOLDER -.. include:: /reference/forms/types/options/required.rst.inc - .. include:: /reference/forms/types/options/label.rst.inc .. include:: /reference/forms/types/options/label_attr.rst.inc -.. include:: /reference/forms/types/options/data.rst.inc +.. include:: /reference/forms/types/options/mapped.rst.inc .. include:: /reference/forms/types/options/read_only.rst.inc -.. include:: /reference/forms/types/options/disabled.rst.inc - -.. include:: /reference/forms/types/options/mapped.rst.inc +.. include:: /reference/forms/types/options/required.rst.inc .. _`ISO 639-1`: http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes .. _`ISO 3166-1 alpha-2`: http://en.wikipedia.org/wiki/ISO_3166-1#Current_codes diff --git a/reference/forms/types/money.rst b/reference/forms/types/money.rst index 60fbc9feeca..dd466595c3b 100644 --- a/reference/forms/types/money.rst +++ b/reference/forms/types/money.rst @@ -16,21 +16,21 @@ how the input and output of the data is handled. +-------------+---------------------------------------------------------------------+ | Options | - `currency`_ | | | - `divisor`_ | -| | - `precision`_ | | | - `grouping`_ | +| | - `precision`_ | +-------------+---------------------------------------------------------------------+ -| Inherited | - `empty_data`_ | -| options | - `required`_ | -| | - `label`_ | -| | - `label_attr`_ | -| | - `data`_ | -| | - `read_only`_ | -| | - `disabled`_ | +| Inherited | - `data`_ | +| options | - `disabled`_ | +| | - `empty_data`_ | | | - `error_bubbling`_ | | | - `error_mapping`_ | | | - `invalid_message`_ | | | - `invalid_message_parameters`_ | +| | - `label`_ | +| | - `label_attr`_ | | | - `mapped`_ | +| | - `read_only`_ | +| | - `required`_ | +-------------+---------------------------------------------------------------------+ | Parent type | :doc:`form ` | +-------------+---------------------------------------------------------------------+ @@ -71,6 +71,8 @@ In this case, if the ``price`` field is set to ``9900``, then the value value ``99``, it will be multiplied by ``100`` and ``9900`` will ultimately be set back on your object. +.. include:: /reference/forms/types/options/grouping.rst.inc + precision ~~~~~~~~~ @@ -81,13 +83,15 @@ you can modify this value. You probably won't need to do this unless, for example, you want to round to the nearest dollar (set the precision to ``0``). -.. include:: /reference/forms/types/options/grouping.rst.inc - Inherited Options ----------------- These options inherit from the :doc:`form ` type: +.. include:: /reference/forms/types/options/data.rst.inc + +.. include:: /reference/forms/types/options/disabled.rst.inc + .. include:: /reference/forms/types/options/empty_data.rst.inc :end-before: DEFAULT_PLACEHOLDER @@ -96,18 +100,6 @@ The default value is ``''`` (the empty string). .. include:: /reference/forms/types/options/empty_data.rst.inc :start-after: DEFAULT_PLACEHOLDER -.. include:: /reference/forms/types/options/required.rst.inc - -.. include:: /reference/forms/types/options/label.rst.inc - -.. include:: /reference/forms/types/options/label_attr.rst.inc - -.. include:: /reference/forms/types/options/data.rst.inc - -.. include:: /reference/forms/types/options/read_only.rst.inc - -.. include:: /reference/forms/types/options/disabled.rst.inc - .. include:: /reference/forms/types/options/error_bubbling.rst.inc .. include:: /reference/forms/types/options/error_mapping.rst.inc @@ -116,8 +108,16 @@ The default value is ``''`` (the empty string). .. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc +.. include:: /reference/forms/types/options/label.rst.inc + +.. include:: /reference/forms/types/options/label_attr.rst.inc + .. include:: /reference/forms/types/options/mapped.rst.inc +.. include:: /reference/forms/types/options/read_only.rst.inc + +.. include:: /reference/forms/types/options/required.rst.inc + Form Variables -------------- diff --git a/reference/forms/types/number.rst b/reference/forms/types/number.rst index 196880502f8..e476d6bf052 100644 --- a/reference/forms/types/number.rst +++ b/reference/forms/types/number.rst @@ -11,22 +11,22 @@ you want to use for your number. +-------------+----------------------------------------------------------------------+ | Rendered as | ``input`` ``text`` field | +-------------+----------------------------------------------------------------------+ -| Options | - `rounding_mode`_ | +| Options | - `grouping`_ | | | - `precision`_ | -| | - `grouping`_ | +| | - `rounding_mode`_ | +-------------+----------------------------------------------------------------------+ -| Inherited | - `empty_data`_ | -| options | - `required`_ | -| | - `label`_ | -| | - `label_attr`_ | -| | - `data`_ | -| | - `read_only`_ | -| | - `disabled`_ | +| Inherited | - `data`_ | +| options | - `disabled`_ | +| | - `empty_data`_ | | | - `error_bubbling`_ | | | - `error_mapping`_ | | | - `invalid_message`_ | | | - `invalid_message_parameters`_ | +| | - `label`_ | +| | - `label_attr`_ | | | - `mapped`_ | +| | - `read_only`_ | +| | - `required`_ | +-------------+----------------------------------------------------------------------+ | Parent type | :doc:`form ` | +-------------+----------------------------------------------------------------------+ @@ -36,6 +36,8 @@ you want to use for your number. Field Options ------------- +.. include:: /reference/forms/types/options/grouping.rst.inc + .. include:: /reference/forms/types/options/precision.rst.inc rounding_mode @@ -71,13 +73,15 @@ option is a constant on the :class:`Symfony\\Component\\Form\\Extension\\Core\\D round towards "nearest neighbor" unless both neighbors are equidistant, in which case round up. -.. include:: /reference/forms/types/options/grouping.rst.inc - Inherited Options ----------------- These options inherit from the :doc:`form ` type: +.. include:: /reference/forms/types/options/data.rst.inc + +.. include:: /reference/forms/types/options/disabled.rst.inc + .. include:: /reference/forms/types/options/empty_data.rst.inc :end-before: DEFAULT_PLACEHOLDER @@ -86,18 +90,6 @@ The default value is ``''`` (the empty string). .. include:: /reference/forms/types/options/empty_data.rst.inc :start-after: DEFAULT_PLACEHOLDER -.. include:: /reference/forms/types/options/required.rst.inc - -.. include:: /reference/forms/types/options/label.rst.inc - -.. include:: /reference/forms/types/options/label_attr.rst.inc - -.. include:: /reference/forms/types/options/data.rst.inc - -.. include:: /reference/forms/types/options/read_only.rst.inc - -.. include:: /reference/forms/types/options/disabled.rst.inc - .. include:: /reference/forms/types/options/error_bubbling.rst.inc .. include:: /reference/forms/types/options/error_mapping.rst.inc @@ -106,4 +98,12 @@ The default value is ``''`` (the empty string). .. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc +.. include:: /reference/forms/types/options/label.rst.inc + +.. include:: /reference/forms/types/options/label_attr.rst.inc + .. include:: /reference/forms/types/options/mapped.rst.inc + +.. include:: /reference/forms/types/options/read_only.rst.inc + +.. include:: /reference/forms/types/options/required.rst.inc diff --git a/reference/forms/types/password.rst b/reference/forms/types/password.rst index 248b1e9595e..eefe8eb7c31 100644 --- a/reference/forms/types/password.rst +++ b/reference/forms/types/password.rst @@ -11,17 +11,17 @@ The ``password`` field renders an input password text box. +-------------+------------------------------------------------------------------------+ | Options | - `always_empty`_ | +-------------+------------------------------------------------------------------------+ -| Inherited | - `max_length`_ | +| Inherited | - `disabled`_ | | options | - `empty_data`_ | -| | - `required`_ | -| | - `label`_ | -| | - `label_attr`_ | -| | - `trim`_ | -| | - `read_only`_ | -| | - `disabled`_ | | | - `error_bubbling`_ | | | - `error_mapping`_ | +| | - `label`_ | +| | - `label_attr`_ | | | - `mapped`_ | +| | - `max_length`_ | +| | - `read_only`_ | +| | - `required`_ | +| | - `trim`_ | +-------------+------------------------------------------------------------------------+ | Parent type | :doc:`text ` | +-------------+------------------------------------------------------------------------+ @@ -50,7 +50,7 @@ Inherited Options These options inherit from the :doc:`form ` type: -.. include:: /reference/forms/types/options/max_length.rst.inc +.. include:: /reference/forms/types/options/disabled.rst.inc .. include:: /reference/forms/types/options/empty_data.rst.inc :end-before: DEFAULT_PLACEHOLDER @@ -60,20 +60,20 @@ The default value is ``''`` (the empty string). .. include:: /reference/forms/types/options/empty_data.rst.inc :start-after: DEFAULT_PLACEHOLDER -.. include:: /reference/forms/types/options/required.rst.inc +.. include:: /reference/forms/types/options/error_bubbling.rst.inc + +.. include:: /reference/forms/types/options/error_mapping.rst.inc .. include:: /reference/forms/types/options/label.rst.inc .. include:: /reference/forms/types/options/label_attr.rst.inc -.. include:: /reference/forms/types/options/trim.rst.inc - -.. include:: /reference/forms/types/options/read_only.rst.inc +.. include:: /reference/forms/types/options/mapped.rst.inc -.. include:: /reference/forms/types/options/disabled.rst.inc +.. include:: /reference/forms/types/options/max_length.rst.inc -.. include:: /reference/forms/types/options/error_bubbling.rst.inc +.. include:: /reference/forms/types/options/read_only.rst.inc -.. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/required.rst.inc -.. include:: /reference/forms/types/options/mapped.rst.inc +.. include:: /reference/forms/types/options/trim.rst.inc diff --git a/reference/forms/types/percent.rst b/reference/forms/types/percent.rst index bc0c9bda317..253a43c69b5 100644 --- a/reference/forms/types/percent.rst +++ b/reference/forms/types/percent.rst @@ -15,21 +15,21 @@ This field adds a percentage sign "``%``" after the input box. +-------------+-----------------------------------------------------------------------+ | Rendered as | ``input`` ``text`` field | +-------------+-----------------------------------------------------------------------+ -| Options | - `type`_ | -| | - `precision`_ | +| Options | - `precision`_ | +| | - `type`_ | +-------------+-----------------------------------------------------------------------+ -| Inherited | - `empty_data`_ | -| options | - `required`_ | -| | - `label`_ | -| | - `label_attr`_ | -| | - `data`_ | -| | - `read_only`_ | -| | - `disabled`_ | +| Inherited | - `data`_ | +| options | - `disabled`_ | +| | - `empty_data`_ | | | - `error_bubbling`_ | | | - `error_mapping`_ | | | - `invalid_message`_ | | | - `invalid_message_parameters`_ | +| | - `label`_ | +| | - `label_attr`_ | | | - `mapped`_ | +| | - `read_only`_ | +| | - `required`_ | +-------------+-----------------------------------------------------------------------+ | Parent type | :doc:`form ` | +-------------+-----------------------------------------------------------------------+ @@ -39,6 +39,14 @@ This field adds a percentage sign "``%``" after the input box. Field Options ------------- +precision +~~~~~~~~~ + +**type**: ``integer`` **default**: ``0`` + +By default, the input numbers are rounded. To allow for more decimal +places, use this option. + type ~~~~ @@ -59,19 +67,14 @@ object. The two "types" handle these two cases: The raw value (``55``) is shown to the user and stored on your object. Note that this only works for integer values. -precision -~~~~~~~~~ - -**type**: ``integer`` **default**: ``0`` - -By default, the input numbers are rounded. To allow for more decimal -places, use this option. - Inherited Options ----------------- These options inherit from the :doc:`form ` type: +.. include:: /reference/forms/types/options/data.rst.inc + +.. include:: /reference/forms/types/options/disabled.rst.inc .. include:: /reference/forms/types/options/empty_data.rst.inc :end-before: DEFAULT_PLACEHOLDER @@ -80,18 +83,6 @@ The default value is ``''`` (the empty string). .. include:: /reference/forms/types/options/empty_data.rst.inc :start-after: DEFAULT_PLACEHOLDER -.. include:: /reference/forms/types/options/required.rst.inc - -.. include:: /reference/forms/types/options/label.rst.inc - -.. include:: /reference/forms/types/options/label_attr.rst.inc - -.. include:: /reference/forms/types/options/data.rst.inc - -.. include:: /reference/forms/types/options/read_only.rst.inc - -.. include:: /reference/forms/types/options/disabled.rst.inc - .. include:: /reference/forms/types/options/error_bubbling.rst.inc .. include:: /reference/forms/types/options/error_mapping.rst.inc @@ -100,4 +91,12 @@ The default value is ``''`` (the empty string). .. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc +.. include:: /reference/forms/types/options/label.rst.inc + +.. include:: /reference/forms/types/options/label_attr.rst.inc + .. include:: /reference/forms/types/options/mapped.rst.inc + +.. include:: /reference/forms/types/options/read_only.rst.inc + +.. include:: /reference/forms/types/options/required.rst.inc diff --git a/reference/forms/types/radio.rst b/reference/forms/types/radio.rst index 5bc292b7d05..2bf650dc027 100644 --- a/reference/forms/types/radio.rst +++ b/reference/forms/types/radio.rst @@ -15,17 +15,22 @@ If you want to have a Boolean field, use :doc:`checkbox ` type: | +| options | | +| | - `value`_ | +| | | +| | from the :doc:`form ` type: | +| | | +| | - `data`_ | | | - `disabled`_ | +| | - `empty_data`_ | | | - `error_bubbling`_ | | | - `error_mapping`_ | +| | - `label`_ | +| | - `label_attr`_ | | | - `mapped`_ | +| | - `read_only`_ | +| | - `required`_ | +-------------+---------------------------------------------------------------------+ | Parent type | :doc:`checkbox ` | +-------------+---------------------------------------------------------------------+ @@ -44,23 +49,23 @@ These options inherit from the :doc:`form ` type: .. include:: /reference/forms/types/options/data.rst.inc +.. include:: /reference/forms/types/options/disabled.rst.inc + .. include:: /reference/forms/types/options/checkbox_empty_data.rst.inc -.. include:: /reference/forms/types/options/required.rst.inc +.. include:: /reference/forms/types/options/error_bubbling.rst.inc + +.. include:: /reference/forms/types/options/error_mapping.rst.inc .. include:: /reference/forms/types/options/label.rst.inc .. include:: /reference/forms/types/options/label_attr.rst.inc -.. include:: /reference/forms/types/options/read_only.rst.inc - -.. include:: /reference/forms/types/options/disabled.rst.inc - -.. include:: /reference/forms/types/options/error_bubbling.rst.inc +.. include:: /reference/forms/types/options/mapped.rst.inc -.. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/read_only.rst.inc -.. include:: /reference/forms/types/options/mapped.rst.inc +.. include:: /reference/forms/types/options/required.rst.inc Form Variables -------------- diff --git a/reference/forms/types/repeated.rst b/reference/forms/types/repeated.rst index 12262eaae17..91b85bd4d3b 100644 --- a/reference/forms/types/repeated.rst +++ b/reference/forms/types/repeated.rst @@ -12,21 +12,21 @@ accuracy. +-------------+------------------------------------------------------------------------+ | Rendered as | input ``text`` field by default, but see `type`_ option | +-------------+------------------------------------------------------------------------+ -| Options | - `type`_ | -| | - `options`_ | +| Options | - `first_name`_ | | | - `first_options`_ | -| | - `second_options`_ | -| | - `first_name`_ | +| | - `options`_ | | | - `second_name`_ | +| | - `second_options`_ | +| | - `type`_ | +-------------+------------------------------------------------------------------------+ | Overridden | - `error_bubbling`_ | | Options | | +-------------+------------------------------------------------------------------------+ | Inherited | - `data`_ | -| options | - `invalid_message`_ | +| options | - `error_mapping`_ | +| | - `invalid_message`_ | | | - `invalid_message_parameters`_ | | | - `mapped`_ | -| | - `error_mapping`_ | +-------------+------------------------------------------------------------------------+ | Parent type | :doc:`form ` | +-------------+------------------------------------------------------------------------+ @@ -110,24 +110,16 @@ be displayed when the two fields do not match each other. Field Options ------------- -type -~~~~ - -**type**: ``string`` **default**: ``text`` - -The two underlying fields will be of this field type. For example, passing -a type of ``password`` will render two password fields. - -options -~~~~~~~ +first_name +~~~~~~~~~~ -**type**: ``array`` **default**: ``array()`` +**type**: ``string`` **default**: ``first`` -This options array will be passed to each of the two underlying fields. In -other words, these are the options that customize the individual field types. -For example, if the ``type`` option is set to ``password``, this array might -contain the options ``always_empty`` or ``required`` - both options that are -supported by the ``password`` field type. +This is the actual field name to be used for the first field. This is mostly +meaningless, however, as the actual data entered into both of the fields will +be available under the key assigned to the ``repeated`` field itself (e.g. +``password``). However, if you don't specify a label, this field name is used +to "guess" the label for you. first_options ~~~~~~~~~~~~~ @@ -143,6 +135,24 @@ label:: 'second_options' => array('label' => 'Repeat Password'), )); +options +~~~~~~~ + +**type**: ``array`` **default**: ``array()`` + +This options array will be passed to each of the two underlying fields. In +other words, these are the options that customize the individual field types. +For example, if the ``type`` option is set to ``password``, this array might +contain the options ``always_empty`` or ``required`` - both options that are +supported by the ``password`` field type. + +second_name +~~~~~~~~~~~ + +**type**: ``string`` **default**: ``second`` + +The same as ``first_name``, but for the second field. + second_options ~~~~~~~~~~~~~~ @@ -152,23 +162,13 @@ Additional options (will be merged into `options` above) that should be passed *only* to the second field. This is especially useful for customizing the label (see `first_options`_). -first_name -~~~~~~~~~~ - -**type**: ``string`` **default**: ``first`` - -This is the actual field name to be used for the first field. This is mostly -meaningless, however, as the actual data entered into both of the fields will -be available under the key assigned to the ``repeated`` field itself (e.g. -``password``). However, if you don't specify a label, this field name is used -to "guess" the label for you. - -second_name -~~~~~~~~~~~ +type +~~~~ -**type**: ``string`` **default**: ``second`` +**type**: ``string`` **default**: ``text`` -The same as ``first_name``, but for the second field. +The two underlying fields will be of this field type. For example, passing +a type of ``password`` will render two password fields. Overridden Options ------------------ @@ -185,10 +185,10 @@ These options inherit from the :doc:`form ` type: .. include:: /reference/forms/types/options/data.rst.inc +.. include:: /reference/forms/types/options/error_mapping.rst.inc + .. include:: /reference/forms/types/options/invalid_message.rst.inc .. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc .. include:: /reference/forms/types/options/mapped.rst.inc - -.. include:: /reference/forms/types/options/error_mapping.rst.inc diff --git a/reference/forms/types/search.rst b/reference/forms/types/search.rst index 5fd671e981f..955c52cadaf 100644 --- a/reference/forms/types/search.rst +++ b/reference/forms/types/search.rst @@ -12,17 +12,17 @@ Read about the input search field at `DiveIntoHTML5.info`_ +-------------+----------------------------------------------------------------------+ | Rendered as | ``input search`` field | +-------------+----------------------------------------------------------------------+ -| Inherited | - `max_length`_ | +| Inherited | - `disabled`_ | | options | - `empty_data`_ | -| | - `required`_ | -| | - `label`_ | -| | - `label_attr`_ | -| | - `trim`_ | -| | - `read_only`_ | -| | - `disabled`_ | | | - `error_bubbling`_ | | | - `error_mapping`_ | +| | - `label`_ | +| | - `label_attr`_ | | | - `mapped`_ | +| | - `max_length`_ | +| | - `read_only`_ | +| | - `required`_ | +| | - `trim`_ | +-------------+----------------------------------------------------------------------+ | Parent type | :doc:`text ` | +-------------+----------------------------------------------------------------------+ @@ -34,7 +34,7 @@ Inherited Options These options inherit from the :doc:`form ` type: -.. include:: /reference/forms/types/options/max_length.rst.inc +.. include:: /reference/forms/types/options/disabled.rst.inc .. include:: /reference/forms/types/options/empty_data.rst.inc :end-before: DEFAULT_PLACEHOLDER @@ -44,22 +44,22 @@ The default value is ``''`` (the empty string). .. include:: /reference/forms/types/options/empty_data.rst.inc :start-after: DEFAULT_PLACEHOLDER -.. include:: /reference/forms/types/options/required.rst.inc +.. include:: /reference/forms/types/options/error_bubbling.rst.inc + +.. include:: /reference/forms/types/options/error_mapping.rst.inc .. include:: /reference/forms/types/options/label.rst.inc .. include:: /reference/forms/types/options/label_attr.rst.inc -.. include:: /reference/forms/types/options/trim.rst.inc - -.. include:: /reference/forms/types/options/read_only.rst.inc +.. include:: /reference/forms/types/options/mapped.rst.inc -.. include:: /reference/forms/types/options/disabled.rst.inc +.. include:: /reference/forms/types/options/max_length.rst.inc -.. include:: /reference/forms/types/options/error_bubbling.rst.inc +.. include:: /reference/forms/types/options/read_only.rst.inc -.. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/required.rst.inc -.. include:: /reference/forms/types/options/mapped.rst.inc +.. include:: /reference/forms/types/options/trim.rst.inc .. _`DiveIntoHTML5.info`: http://diveintohtml5.info/forms.html#type-search diff --git a/reference/forms/types/text.rst b/reference/forms/types/text.rst index 5fbe7759688..f9fbb152c22 100644 --- a/reference/forms/types/text.rst +++ b/reference/forms/types/text.rst @@ -9,18 +9,18 @@ The text field represents the most basic input text field. +-------------+--------------------------------------------------------------------+ | Rendered as | ``input`` ``text`` field | +-------------+--------------------------------------------------------------------+ -| Inherited | - `max_length`_ | -| options | - `empty_data`_ | -| | - `required`_ | -| | - `label`_ | -| | - `label_attr`_ | -| | - `data`_ | -| | - `trim`_ | -| | - `read_only`_ | -| | - `disabled`_ | +| Inherited | - `data`_ | +| options | - `disabled`_ | +| | - `empty_data`_ | | | - `error_bubbling`_ | | | - `error_mapping`_ | +| | - `label`_ | +| | - `label_attr`_ | | | - `mapped`_ | +| | - `max_length`_ | +| | - `read_only`_ | +| | - `required`_ | +| | - `trim`_ | +-------------+--------------------------------------------------------------------+ | Parent type | :doc:`form ` | +-------------+--------------------------------------------------------------------+ @@ -33,7 +33,9 @@ Inherited Options These options inherit from the :doc:`form ` type: -.. include:: /reference/forms/types/options/max_length.rst.inc +.. include:: /reference/forms/types/options/data.rst.inc + +.. include:: /reference/forms/types/options/disabled.rst.inc .. include:: /reference/forms/types/options/empty_data.rst.inc :end-before: DEFAULT_PLACEHOLDER @@ -43,22 +45,20 @@ The default value is ``''`` (the empty string). .. include:: /reference/forms/types/options/empty_data.rst.inc :start-after: DEFAULT_PLACEHOLDER -.. include:: /reference/forms/types/options/required.rst.inc +.. include:: /reference/forms/types/options/error_bubbling.rst.inc + +.. include:: /reference/forms/types/options/error_mapping.rst.inc .. include:: /reference/forms/types/options/label.rst.inc .. include:: /reference/forms/types/options/label_attr.rst.inc -.. include:: /reference/forms/types/options/data.rst.inc +.. include:: /reference/forms/types/options/mapped.rst.inc -.. include:: /reference/forms/types/options/trim.rst.inc +.. include:: /reference/forms/types/options/max_length.rst.inc .. include:: /reference/forms/types/options/read_only.rst.inc -.. include:: /reference/forms/types/options/disabled.rst.inc - -.. include:: /reference/forms/types/options/error_bubbling.rst.inc - -.. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/required.rst.inc -.. include:: /reference/forms/types/options/mapped.rst.inc +.. include:: /reference/forms/types/options/trim.rst.inc diff --git a/reference/forms/types/textarea.rst b/reference/forms/types/textarea.rst index a584fdc90c1..c3bca0a8c60 100644 --- a/reference/forms/types/textarea.rst +++ b/reference/forms/types/textarea.rst @@ -9,18 +9,18 @@ Renders a ``textarea`` HTML element. +-------------+------------------------------------------------------------------------+ | Rendered as | ``textarea`` tag | +-------------+------------------------------------------------------------------------+ -| Inherited | - `max_length`_ | -| options | - `empty_data`_ | -| | - `required`_ | -| | - `label`_ | -| | - `label_attr`_ | -| | - `trim`_ | -| | - `data`_ | -| | - `read_only`_ | -| | - `disabled`_ | +| Inherited | - `data`_ | +| options | - `disabled`_ | +| | - `empty_data`_ | | | - `error_bubbling`_ | | | - `error_mapping`_ | +| | - `label`_ | +| | - `label_attr`_ | | | - `mapped`_ | +| | - `max_length`_ | +| | - `read_only`_ | +| | - `required`_ | +| | - `trim`_ | +-------------+------------------------------------------------------------------------+ | Parent type | :doc:`text ` | +-------------+------------------------------------------------------------------------+ @@ -32,7 +32,9 @@ Inherited Options These options inherit from the :doc:`form ` type: -.. include:: /reference/forms/types/options/max_length.rst.inc +.. include:: /reference/forms/types/options/data.rst.inc + +.. include:: /reference/forms/types/options/disabled.rst.inc .. include:: /reference/forms/types/options/empty_data.rst.inc :end-before: DEFAULT_PLACEHOLDER @@ -42,22 +44,20 @@ The default value is ``''`` (the empty string). .. include:: /reference/forms/types/options/empty_data.rst.inc :start-after: DEFAULT_PLACEHOLDER -.. include:: /reference/forms/types/options/required.rst.inc +.. include:: /reference/forms/types/options/error_bubbling.rst.inc + +.. include:: /reference/forms/types/options/error_mapping.rst.inc .. include:: /reference/forms/types/options/label.rst.inc .. include:: /reference/forms/types/options/label_attr.rst.inc -.. include:: /reference/forms/types/options/trim.rst.inc +.. include:: /reference/forms/types/options/mapped.rst.inc -.. include:: /reference/forms/types/options/data.rst.inc +.. include:: /reference/forms/types/options/max_length.rst.inc .. include:: /reference/forms/types/options/read_only.rst.inc -.. include:: /reference/forms/types/options/disabled.rst.inc - -.. include:: /reference/forms/types/options/error_bubbling.rst.inc - -.. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/required.rst.inc -.. include:: /reference/forms/types/options/mapped.rst.inc +.. include:: /reference/forms/types/options/trim.rst.inc diff --git a/reference/forms/types/time.rst b/reference/forms/types/time.rst index 318c7777fc7..71b3af1cdb5 100644 --- a/reference/forms/types/time.rst +++ b/reference/forms/types/time.rst @@ -15,28 +15,28 @@ as a ``DateTime`` object, a string, a timestamp or an array. +----------------------+-----------------------------------------------------------------------------+ | Rendered as | can be various tags (see below) | +----------------------+-----------------------------------------------------------------------------+ -| Options | - `widget`_ | -| | - `input`_ | -| | - `with_minutes`_ | -| | - `with_seconds`_ | +| Options | - `empty_value`_ | | | - `hours`_ | +| | - `input`_ | | | - `minutes`_ | -| | - `seconds`_ | | | - `model_timezone`_ | +| | - `seconds`_ | | | - `view_timezone`_ | -| | - `empty_value`_ | +| | - `widget`_ | +| | - `with_minutes`_ | +| | - `with_seconds`_ | +----------------------+-----------------------------------------------------------------------------+ | Overridden Options | - `by_reference`_ | | | - `error_bubbling`_ | +----------------------+-----------------------------------------------------------------------------+ -| Inherited | - `invalid_message`_ | -| options | - `invalid_message_parameters`_ | -| | - `data`_ | -| | - `read_only`_ | -| | - `disabled`_ | -| | - `mapped`_ | -| | - `inherit_data`_ | +| Inherited | - `data`_ | +| Options | - `disabled`_ | | | - `error_mapping`_ | +| | - `inherit_data`_ | +| | - `invalid_message`_ | +| | - `invalid_message_parameters`_ | +| | - `mapped`_ | +| | - `read_only`_ | +----------------------+-----------------------------------------------------------------------------+ | Parent type | form | +----------------------+-----------------------------------------------------------------------------+ @@ -77,27 +77,9 @@ values. Field Options ------------- -widget -~~~~~~ - -**type**: ``string`` **default**: ``choice`` - -The basic way in which this field should be rendered. Can be one of the following: - -* ``choice``: renders one, two (default) or three select inputs (hour, minute, - second), depending on the `with_minutes`_ and `with_seconds`_ options. - -* ``text``: renders one, two (default) or three text inputs (hour, minute, - second), depending on the `with_minutes`_ and `with_seconds`_ options. - -* ``single_text``: renders a single input of type ``time``. User's input will - be validated against the form ``hh:mm`` (or ``hh:mm:ss`` if using seconds). - -.. caution:: +.. include:: /reference/forms/types/options/empty_value.rst.inc - Combining the widget type ``single_text`` and the `with_minutes`_ option - set to ``false`` can cause unexpected behavior in the client as the input - type ``time`` might not support selecting an hour only. +.. include:: /reference/forms/types/options/hours.rst.inc input ~~~~~ @@ -115,21 +97,39 @@ your underlying object. Valid values are: The value that comes back from the form will also be normalized back into this format. -.. include:: /reference/forms/types/options/with_minutes.rst.inc +.. include:: /reference/forms/types/options/minutes.rst.inc -.. include:: /reference/forms/types/options/with_seconds.rst.inc +.. include:: /reference/forms/types/options/model_timezone.rst.inc -.. include:: /reference/forms/types/options/hours.rst.inc +.. include:: /reference/forms/types/options/seconds.rst.inc -.. include:: /reference/forms/types/options/minutes.rst.inc +.. include:: /reference/forms/types/options/view_timezone.rst.inc -.. include:: /reference/forms/types/options/seconds.rst.inc +widget +~~~~~~ -.. include:: /reference/forms/types/options/model_timezone.rst.inc +**type**: ``string`` **default**: ``choice`` -.. include:: /reference/forms/types/options/view_timezone.rst.inc +The basic way in which this field should be rendered. Can be one of the following: -.. include:: /reference/forms/types/options/empty_value.rst.inc +* ``choice``: renders one, two (default) or three select inputs (hour, minute, + second), depending on the `with_minutes`_ and `with_seconds`_ options. + +* ``text``: renders one, two (default) or three text inputs (hour, minute, + second), depending on the `with_minutes`_ and `with_seconds`_ options. + +* ``single_text``: renders a single input of type ``time``. User's input will + be validated against the form ``hh:mm`` (or ``hh:mm:ss`` if using seconds). + +.. caution:: + + Combining the widget type ``single_text`` and the `with_minutes`_ option + set to ``false`` can cause unexpected behavior in the client as the input + type ``time`` might not support selecting an hour only. + +.. include:: /reference/forms/types/options/with_minutes.rst.inc + +.. include:: /reference/forms/types/options/with_seconds.rst.inc Overridden Options ------------------ @@ -151,21 +151,21 @@ Inherited Options These options inherit from the :doc:`form ` type: -.. include:: /reference/forms/types/options/invalid_message.rst.inc - -.. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc - .. include:: /reference/forms/types/options/data.rst.inc -.. include:: /reference/forms/types/options/read_only.rst.inc - .. include:: /reference/forms/types/options/disabled.rst.inc -.. include:: /reference/forms/types/options/mapped.rst.inc +.. include:: /reference/forms/types/options/error_mapping.rst.inc .. include:: /reference/forms/types/options/inherit_data.rst.inc -.. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/invalid_message.rst.inc + +.. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc + +.. include:: /reference/forms/types/options/mapped.rst.inc + +.. include:: /reference/forms/types/options/read_only.rst.inc Form Variables -------------- diff --git a/reference/forms/types/timezone.rst b/reference/forms/types/timezone.rst index 3902184d0b6..175345b0330 100644 --- a/reference/forms/types/timezone.rst +++ b/reference/forms/types/timezone.rst @@ -21,20 +21,25 @@ you should just use the ``choice`` type directly. | Overridden | - `choice_list`_ | | Options | | +-------------+------------------------------------------------------------------------+ -| Inherited | - `multiple`_ | -| options | - `expanded`_ | -| | - `preferred_choices`_ | +| Inherited | from the :doc:`choice ` type | +| options | | | | - `empty_value`_ | -| | - `empty_data`_ | -| | - `required`_ | -| | - `label`_ | -| | - `label_attr`_ | +| | - `expanded`_ | +| | - `multiple`_ | +| | - `preferred_choices`_ | +| | | +| | from the :doc:`form ` type | +| | | | | - `data`_ | -| | - `read_only`_ | | | - `disabled`_ | +| | - `empty_data`_ | | | - `error_bubbling`_ | | | - `error_mapping`_ | +| | - `label`_ | +| | - `label_attr`_ | | | - `mapped`_ | +| | - `read_only`_ | +| | - `required`_ | +-------------+------------------------------------------------------------------------+ | Parent type | :doc:`choice ` | +-------------+------------------------------------------------------------------------+ @@ -57,16 +62,20 @@ Inherited Options These options inherit from the :doc:`choice ` type: -.. include:: /reference/forms/types/options/multiple.rst.inc +.. include:: /reference/forms/types/options/empty_value.rst.inc .. include:: /reference/forms/types/options/expanded.rst.inc -.. include:: /reference/forms/types/options/preferred_choices.rst.inc +.. include:: /reference/forms/types/options/multiple.rst.inc -.. include:: /reference/forms/types/options/empty_value.rst.inc +.. include:: /reference/forms/types/options/preferred_choices.rst.inc These options inherit from the :doc:`form ` type: +.. include:: /reference/forms/types/options/data.rst.inc + +.. include:: /reference/forms/types/options/disabled.rst.inc + .. include:: /reference/forms/types/options/empty_data.rst.inc :end-before: DEFAULT_PLACEHOLDER @@ -79,20 +88,16 @@ The actual default value of this option depends on other field options: .. include:: /reference/forms/types/options/empty_data.rst.inc :start-after: DEFAULT_PLACEHOLDER -.. include:: /reference/forms/types/options/required.rst.inc +.. include:: /reference/forms/types/options/error_bubbling.rst.inc + +.. include:: /reference/forms/types/options/error_mapping.rst.inc .. include:: /reference/forms/types/options/label.rst.inc .. include:: /reference/forms/types/options/label_attr.rst.inc -.. include:: /reference/forms/types/options/data.rst.inc +.. include:: /reference/forms/types/options/mapped.rst.inc .. include:: /reference/forms/types/options/read_only.rst.inc -.. include:: /reference/forms/types/options/disabled.rst.inc - -.. include:: /reference/forms/types/options/error_bubbling.rst.inc - -.. include:: /reference/forms/types/options/error_mapping.rst.inc - -.. include:: /reference/forms/types/options/mapped.rst.inc +.. include:: /reference/forms/types/options/required.rst.inc diff --git a/reference/forms/types/url.rst b/reference/forms/types/url.rst index ceacbc4deeb..1df99a06d30 100644 --- a/reference/forms/types/url.rst +++ b/reference/forms/types/url.rst @@ -13,18 +13,18 @@ have a protocol. +-------------+-------------------------------------------------------------------+ | Options | - `default_protocol`_ | +-------------+-------------------------------------------------------------------+ -| Inherited | - `max_length`_ | -| options | - `empty_data`_ | -| | - `required`_ | -| | - `label`_ | -| | - `label_attr`_ | -| | - `data`_ | -| | - `trim`_ | -| | - `read_only`_ | -| | - `disabled`_ | +| Inherited | - `data`_ | +| options | - `disabled`_ | +| | - `empty_data`_ | | | - `error_bubbling`_ | | | - `error_mapping`_ | +| | - `label`_ | +| | - `label_attr`_ | | | - `mapped`_ | +| | - `max_length`_ | +| | - `read_only`_ | +| | - `required`_ | +| | - `trim`_ | +-------------+-------------------------------------------------------------------+ | Parent type | :doc:`text ` | +-------------+-------------------------------------------------------------------+ @@ -48,7 +48,9 @@ Inherited Options These options inherit from the :doc:`form ` type: -.. include:: /reference/forms/types/options/max_length.rst.inc +.. include:: /reference/forms/types/options/data.rst.inc + +.. include:: /reference/forms/types/options/disabled.rst.inc .. include:: /reference/forms/types/options/empty_data.rst.inc :end-before: DEFAULT_PLACEHOLDER @@ -58,22 +60,20 @@ The default value is ``''`` (the empty string). .. include:: /reference/forms/types/options/empty_data.rst.inc :start-after: DEFAULT_PLACEHOLDER -.. include:: /reference/forms/types/options/required.rst.inc +.. include:: /reference/forms/types/options/error_bubbling.rst.inc + +.. include:: /reference/forms/types/options/error_mapping.rst.inc .. include:: /reference/forms/types/options/label.rst.inc .. include:: /reference/forms/types/options/label_attr.rst.inc -.. include:: /reference/forms/types/options/data.rst.inc +.. include:: /reference/forms/types/options/mapped.rst.inc -.. include:: /reference/forms/types/options/trim.rst.inc +.. include:: /reference/forms/types/options/max_length.rst.inc .. include:: /reference/forms/types/options/read_only.rst.inc -.. include:: /reference/forms/types/options/disabled.rst.inc - -.. include:: /reference/forms/types/options/error_bubbling.rst.inc - -.. include:: /reference/forms/types/options/error_mapping.rst.inc +.. include:: /reference/forms/types/options/required.rst.inc -.. include:: /reference/forms/types/options/mapped.rst.inc +.. include:: /reference/forms/types/options/trim.rst.inc