Skip to content

Added "data" option to the "Inherited options" table. #3333

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 26, 2013
Merged

Added "data" option to the "Inherited options" table. #3333

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

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions reference/forms/types/birthday.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ option defaults to 120 years ago to the current year.
| | - `format`_ |
| | - `model_timezone`_ |
| | - `view_timezone`_ |
| | - `data`_ |
| | - `invalid_message`_ |
| | - `invalid_message_parameters`_ |
| | - `read_only`_ |
Expand Down Expand Up @@ -76,6 +77,8 @@ These options inherit from the :doc:`date </reference/forms/types/date>` type:

These options inherit from the :doc:`form </reference/forms/types/form>` type:

.. include:: /reference/forms/types/options/data.rst.inc

.. include:: /reference/forms/types/options/invalid_message.rst.inc

.. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc
Expand Down
2 changes: 1 addition & 1 deletion reference/forms/types/checkbox.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ not affect the value that's set on your object.

.. caution::

To make a checkbox checked by default, use the `data`_ option.
To make a checkbox checked by default, set the `data`_ option to ``true``.

Inherited options
-----------------
Expand Down
3 changes: 3 additions & 0 deletions reference/forms/types/choice.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ option.
+-------------+------------------------------------------------------------------------------+
| Inherited | - `required`_ |
| options | - `label`_ |
| | - `data`_ |
| | - `read_only`_ |
| | - `disabled`_ |
| | - `error_bubbling`_ |
Expand Down Expand Up @@ -116,6 +117,8 @@ These options inherit from the :doc:`form </reference/forms/types/form>` type:

.. include:: /reference/forms/types/options/label.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
Expand Down
8 changes: 4 additions & 4 deletions reference/forms/types/collection.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,19 +341,19 @@ 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/mapped.rst.inc

.. include:: /reference/forms/types/options/error_mapping.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/empty_data.rst.inc

.. include:: /reference/forms/types/options/mapped.rst.inc
3 changes: 3 additions & 0 deletions reference/forms/types/country.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ you should just use the ``choice`` type directly.
| | - `error_mapping`_ |
| | - `required`_ |
| | - `label`_ |
| | - `data`_ |
| | - `read_only`_ |
| | - `disabled`_ |
| | - `mapped`_ |
Expand Down Expand Up @@ -76,6 +77,8 @@ These options inherit from the :doc:`form </reference/forms/types/form>` type:

.. include:: /reference/forms/types/options/label.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
Expand Down
5 changes: 4 additions & 1 deletion reference/forms/types/currency.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ should just use the ``choice`` type directly.
| | - `error_bubbling`_ |
| | - `required`_ |
| | - `label`_ |
| | - `data`_ |
| | - `read_only`_ |
| | - `disabled`_ |
| | - `mapped`_ |
Expand Down Expand Up @@ -60,12 +61,14 @@ These options inherit from the :doc:`choice</reference/forms/types/choice>` type

.. include:: /reference/forms/types/options/error_bubbling.rst.inc

These options inherit from the :doc:`date</reference/forms/types/form>` type:
These options inherit from the :doc:`form</reference/forms/types/form>` type:

.. include:: /reference/forms/types/options/required.rst.inc

.. include:: /reference/forms/types/options/label.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
Expand Down
7 changes: 5 additions & 2 deletions reference/forms/types/date.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,9 @@ day, and year) or three select boxes (see the `widget`_ option).
| Overridden Options | - `by_reference`_ |
| | - `error_bubbling`_ |
+----------------------+-----------------------------------------------------------------------------+
| Inherited | - `invalid_message`_ |
| options | - `invalid_message_parameters`_ |
| Inherited | - `data`_ |
| options | - `invalid_message`_ |
| | - `invalid_message_parameters`_ |
| | - `read_only`_ |
| | - `disabled`_ |
| | - `mapped`_ |
Expand Down Expand Up @@ -138,6 +139,8 @@ Inherited options

These options inherit from the :doc:`form </reference/forms/types/form>` type:

.. include:: /reference/forms/types/options/data.rst.inc

.. include:: /reference/forms/types/options/invalid_message.rst.inc

.. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc
Expand Down
7 changes: 5 additions & 2 deletions reference/forms/types/datetime.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,9 @@ data can be a ``DateTime`` object, a string, a timestamp or an array.
| | - `view_timezone`_ |
| | - `empty_value`_ |
+----------------------+-----------------------------------------------------------------------------+
| Inherited | - `invalid_message`_ |
| options | - `invalid_message_parameters`_ |
| Inherited | - `data`_ |
| options | - `invalid_message`_ |
| | - `invalid_message_parameters`_ |
| | - `read_only`_ |
| | - `disabled`_ |
| | - `mapped`_ |
Expand Down Expand Up @@ -121,6 +122,8 @@ Inherited options

These options inherit from the :doc:`form </reference/forms/types/form>` type:

.. include:: /reference/forms/types/options/data.rst.inc

.. include:: /reference/forms/types/options/invalid_message.rst.inc

.. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc
Expand Down
3 changes: 3 additions & 0 deletions reference/forms/types/email.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ The ``email`` field is a text field that is rendered using the HTML5
| Inherited | - `max_length`_ |
| options | - `required`_ |
| | - `label`_ |
| | - `data`_ |
| | - `trim`_ |
| | - `read_only`_ |
| | - `disabled`_ |
Expand All @@ -36,6 +37,8 @@ These options inherit from the :doc:`form </reference/forms/types/form>` type:

.. include:: /reference/forms/types/options/label.rst.inc

.. include:: /reference/forms/types/options/data.rst.inc

.. include:: /reference/forms/types/options/trim.rst.inc

.. include:: /reference/forms/types/options/read_only.rst.inc
Expand Down
11 changes: 7 additions & 4 deletions reference/forms/types/entity.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,13 @@ objects from the database.
| Overridden | - `choices`_ |
| Options | - `choice_list`_ |
+-------------+------------------------------------------------------------------+
| Inherited | - `required`_ |
| options | - `label`_ |
| | - `multiple`_ |
| | - `expanded`_ |
| Inherited | - `multiple`_ |
| options | - `expanded`_ |
| | - `preferred_choices`_ |
| | - `empty_value`_ |
| | - `required`_ |
| | - `label`_ |
| | - `data`_ |
| | - `read_only`_ |
| | - `disabled`_ |
| | - `error_bubbling`_ |
Expand Down Expand Up @@ -190,6 +191,8 @@ These options inherit from the :doc:`form </reference/forms/types/form>` type:

.. include:: /reference/forms/types/options/label.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
Expand Down
3 changes: 3 additions & 0 deletions reference/forms/types/integer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ integers. By default, all non-integer values (e.g. 6.78) will round down (e.g. 6
+-------------+-----------------------------------------------------------------------+
| Inherited | - `required`_ |
| options | - `label`_ |
| | - `data`_ |
| | - `read_only`_ |
| | - `disabled`_ |
| | - `error_bubbling`_ |
Expand Down Expand Up @@ -71,6 +72,8 @@ These options inherit from the :doc:`form </reference/forms/types/form>` type:

.. include:: /reference/forms/types/options/label.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
Expand Down
3 changes: 3 additions & 0 deletions reference/forms/types/language.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ you should just use the ``choice`` type directly.
| | - `error_mapping`_ |
| | - `required`_ |
| | - `label`_ |
| | - `data`_ |
| | - `read_only`_ |
| | - `disabled`_ |
| | - `mapped`_ |
Expand Down Expand Up @@ -77,6 +78,8 @@ These options inherit from the :doc:`form </reference/forms/types/form>` type:

.. include:: /reference/forms/types/options/label.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
Expand Down
3 changes: 3 additions & 0 deletions reference/forms/types/locale.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ you should just use the ``choice`` type directly.
| | - `error_mapping`_ |
| | - `required`_ |
| | - `label`_ |
| | - `data`_ |
| | - `read_only`_ |
| | - `disabled`_ |
| | - `mapped`_ |
Expand Down Expand Up @@ -79,6 +80,8 @@ These options inherit from the :doc:`form </reference/forms/types/form>` type:

.. include:: /reference/forms/types/options/label.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
Expand Down
3 changes: 3 additions & 0 deletions reference/forms/types/money.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ how the input and output of the data is handled.
+-------------+---------------------------------------------------------------------+
| Inherited | - `required`_ |
| options | - `label`_ |
| | - `data`_ |
| | - `read_only`_ |
| | - `disabled`_ |
| | - `error_bubbling`_ |
Expand Down Expand Up @@ -89,6 +90,8 @@ These options inherit from the :doc:`form </reference/forms/types/form>` type:

.. include:: /reference/forms/types/options/label.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
Expand Down
3 changes: 3 additions & 0 deletions reference/forms/types/number.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ you want to use for your number.
+-------------+----------------------------------------------------------------------+
| Inherited | - `required`_ |
| options | - `label`_ |
| | - `data`_ |
| | - `read_only`_ |
| | - `disabled`_ |
| | - `error_bubbling`_ |
Expand Down Expand Up @@ -79,6 +80,8 @@ These options inherit from the :doc:`form </reference/forms/types/form>` type:

.. include:: /reference/forms/types/options/label.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
Expand Down
4 changes: 4 additions & 0 deletions reference/forms/types/options/data.rst.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,8 @@ an individual field, you can set it in the data option::
'data' => 'abcdef',
));

.. note::

The default values for form fields are taken directly from the
underlying data structure (e.g. an entity or an array).
The ``data`` option overrides this default value.
3 changes: 3 additions & 0 deletions reference/forms/types/percent.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ This field adds a percentage sign "``%``" after the input box.
+-------------+-----------------------------------------------------------------------+
| Inherited | - `required`_ |
| options | - `label`_ |
| | - `data`_ |
| | - `read_only`_ |
| | - `disabled`_ |
| | - `error_bubbling`_ |
Expand Down Expand Up @@ -73,6 +74,8 @@ These options inherit from the :doc:`form </reference/forms/types/form>` type:

.. include:: /reference/forms/types/options/label.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
Expand Down
7 changes: 5 additions & 2 deletions reference/forms/types/repeated.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,9 @@ accuracy.
| Overridden | - `error_bubbling`_ |
| Options | |
+-------------+------------------------------------------------------------------------+
| Inherited | - `invalid_message`_ |
| options | - `invalid_message_parameters`_ |
| Inherited | - `data`_ |
| options | - `invalid_message`_ |
| | - `invalid_message_parameters`_ |
| | - `mapped`_ |
| | - `error_mapping`_ |
+-------------+------------------------------------------------------------------------+
Expand Down Expand Up @@ -182,6 +183,8 @@ Inherited options

These options inherit from the :doc:`form </reference/forms/types/form>` type:

.. include:: /reference/forms/types/options/data.rst.inc

.. include:: /reference/forms/types/options/invalid_message.rst.inc

.. include:: /reference/forms/types/options/invalid_message_parameters.rst.inc
Expand Down
Loading