Skip to content
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

Nykopol overriden options #3506

Merged
merged 6 commits into from
Feb 3, 2014
+54 −9
Merged

Nykopol overriden options #3506

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ab4aafe
correct overriden option of button and add checkbox overriden option
nykopol Jan 4, 2014
c62cd13
correct overriden option of button and add checkbox overriden option
nykopol Jan 4, 2014
70feefd
document overriden options of checkbox
nykopol Jan 12, 2014
362c8b4
document overriden options of choice field
nykopol Jan 12, 2014
4f6cb9d
Some additional tweaks and probably some merge conflict fixes
weaverryan Jan 22, 2014
e574e97
Removing an extra line thanks to @xabbuh
weaverryan Feb 3, 2014
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
2 changes: 1 addition & 1 deletion reference/forms/types/button.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ A simple, non-responsive button.
| | - `label_attr`_ |
| | - `translation_domain`_ |
+----------------------+----------------------------------------------------------------------+
| Overridden Options | - `auto_initialize` |
| Overridden options | - `auto_initialize`_ |
+----------------------+----------------------------------------------------------------------+
| Parent type | none |
+----------------------+----------------------------------------------------------------------+
Expand Down
13 changes: 11 additions & 2 deletions reference/forms/types/checkbox.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@ if the box is unchecked, the value will be set to false.
+-------------+------------------------------------------------------------------------+
| Options | - `value`_ |
+-------------+------------------------------------------------------------------------+
| Overridden | - `empty_data`_ |
| options | - `compound`_ |
+-------------+------------------------------------------------------------------------+
| Inherited | - `data`_ |
| options | - `empty_data`_ |
| | - `required`_ |
| options | - `required`_ |
| | - `label`_ |
| | - `label_attr`_ |
| | - `read_only`_ |
Expand Down Expand Up @@ -44,6 +46,13 @@ Field Options

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

Overridden options
------------------

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

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

Inherited options
-----------------

Expand Down
31 changes: 25 additions & 6 deletions reference/forms/types/choice.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,18 +20,20 @@ option.
| | - `preferred_choices`_ |
| | - `empty_value`_ |
+-------------+------------------------------------------------------------------------------+
| Overridden | - `empty_data`_ |
| options | - `compound`_ |
| | - `error_bubbling`_ |
+-------------+------------------------------------------------------------------------------+
| Inherited | - `required`_ |
| options | - `label`_ |
| | - `label_attr`_ |
| | - `data`_ |
| | - `read_only`_ |
| | - `disabled`_ |
| | - `error_bubbling`_ |
| | - `error_mapping`_ |
| | - `mapped`_ |
| | - `inherit_data`_ |
| | - `by_reference`_ |
| | - `empty_data`_ |
+-------------+------------------------------------------------------------------------------+
| Parent type | :doc:`form </reference/forms/types/form>` |
+-------------+------------------------------------------------------------------------------+
Expand Down Expand Up @@ -109,6 +111,27 @@ can be created to supply the choices.

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

Overridden options
------------------

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

compound
~~~~~~~~

**type**: ``boolean`` **default**: same value as ``expanded`` option

This option specifies if a form is compound. The value is by default
overriden by the value of the ``expanded`` option.

error_bubbling
~~~~~~~~~~~~~~

**type**: ``boolean`` **default**: ``false``

Set that error on this field must be attached to the field instead of
the parent field (the form in most cases).

Inherited options
-----------------

Expand All @@ -126,14 +149,10 @@ These options inherit from the :doc:`form </reference/forms/types/form>` type:

.. 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/inherit_data.rst.inc

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

.. include:: /reference/forms/types/options/empty_data.rst.inc
8 changes: 8 additions & 0 deletions reference/forms/types/options/checkbox_compound.rst.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
compound
~~~~~~~~

**type**: ``boolean`` **default**: ``false``

This option specifies if a form is compound. As it's not the
case for checkbox, by fefault the value is overriden with
``false`` value.
10 changes: 10 additions & 0 deletions reference/forms/types/options/checkbox_empty_data.rst.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
empty_data
~~~~~~~~~~

**type**: ``string`` **default**: ``mixed``

This option determines what value the field will return when the ``empty_value``
choice is selected.
In checkbox, the value of ``empty_data`` is overriden by the value returned by
the data transformer (see :doc:`/cookbook/form/data_transformers.rst`).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line is unnecessary, isn't it?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you're totally right - removed :)