From 911cc705432190dba4a1f9f36f9a8e51678596df Mon Sep 17 00:00:00 2001 From: Christian Flothmann Date: Wed, 26 Feb 2014 17:27:44 +0100 Subject: [PATCH 1/4] add an introductory table containing all options of the basic form type --- reference/forms/types/form.rst | 41 +++++++++++++++++++++++++++++++--- 1 file changed, 38 insertions(+), 3 deletions(-) diff --git a/reference/forms/types/form.rst b/reference/forms/types/form.rst index e327adb318d..8e1d76eb58a 100644 --- a/reference/forms/types/form.rst +++ b/reference/forms/types/form.rst @@ -4,10 +4,45 @@ form Field Type =============== -See :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\FormType`. - The ``form`` type predefines a couple of options that are then available -on all fields. +on all types for which ``form`` is the parent type. + ++---------+--------------------------------------------------------------------+ +| Options | - `compound`_ | +| | - `data`_ | +| | - `data_class`_ | +| | - `empty_data`_ | +| | - `required`_ | +| | - `label`_ | +| | - `label_attr`_ | +| | - `constraints`_ | +| | - `cascade_validation`_ | +| | - `read_only`_ | +| | - `disabled`_ | +| | - `trim`_ | +| | - `mapped`_ | +| | - `property_path`_ | +| | - `attr`_ | +| | - `translation_domain`_ | +| | - `block_name`_ | +| | - `max_length`_ | +| | - `by_reference`_ | +| | - `error_bubbling`_ | +| | - `inherit_data`_ | +| | - `error_mapping`_ | +| | - `invalid_message`_ | +| | - `invalid_message_parameters`_ | +| | - `extra_fields_message`_ | +| | - `post_max_size_message`_ | +| | - `pattern`_ | ++---------+--------------------------------------------------------------------+ +| Parent | none | ++---------+--------------------------------------------------------------------+ +| Class | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\FormType` | ++---------+--------------------------------------------------------------------+ + +Options +------- .. include:: /reference/forms/types/options/data.rst.inc From 2ca0306a96f5f0ced0551476fe78cb395d0547a4 Mon Sep 17 00:00:00 2001 From: Christian Flothmann Date: Sat, 8 Mar 2014 10:35:22 +0100 Subject: [PATCH 2/4] document the options inherited from the BaseType class --- reference/forms/types/button.rst | 14 +++-- reference/forms/types/form.rst | 100 ++++++++++++++++++------------- 2 files changed, 67 insertions(+), 47 deletions(-) diff --git a/reference/forms/types/button.rst b/reference/forms/types/button.rst index dc723fd1630..a58fb5c3333 100644 --- a/reference/forms/types/button.rst +++ b/reference/forms/types/button.rst @@ -12,8 +12,8 @@ A simple, non-responsive button. +----------------------+----------------------------------------------------------------------+ | Rendered as | ``button`` tag | +----------------------+----------------------------------------------------------------------+ -| Options | - `attr`_ | -| | - `disabled`_ | +| Inherited | - `attr`_ | +| options | - `disabled`_ | | | - `label`_ | | | - `translation_domain`_ | +----------------------+----------------------------------------------------------------------+ @@ -24,8 +24,14 @@ A simple, non-responsive button. | Class | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\ButtonType` | +----------------------+----------------------------------------------------------------------+ -Options -------- +Inherited options +----------------- + +The following options are defined in the +:class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\BaseType` class. +The ``BaseType`` class is the parent class for both the ``button`` type and +the :doc:`form 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/button_attr.rst.inc diff --git a/reference/forms/types/form.rst b/reference/forms/types/form.rst index 8e1d76eb58a..9481e752cd5 100644 --- a/reference/forms/types/form.rst +++ b/reference/forms/types/form.rst @@ -7,39 +7,40 @@ form Field Type The ``form`` type predefines a couple of options that are then available on all types for which ``form`` is the parent type. -+---------+--------------------------------------------------------------------+ -| Options | - `compound`_ | -| | - `data`_ | -| | - `data_class`_ | -| | - `empty_data`_ | -| | - `required`_ | -| | - `label`_ | -| | - `label_attr`_ | -| | - `constraints`_ | -| | - `cascade_validation`_ | -| | - `read_only`_ | -| | - `disabled`_ | -| | - `trim`_ | -| | - `mapped`_ | -| | - `property_path`_ | -| | - `attr`_ | -| | - `translation_domain`_ | -| | - `block_name`_ | -| | - `max_length`_ | -| | - `by_reference`_ | -| | - `error_bubbling`_ | -| | - `inherit_data`_ | -| | - `error_mapping`_ | -| | - `invalid_message`_ | -| | - `invalid_message_parameters`_ | -| | - `extra_fields_message`_ | -| | - `post_max_size_message`_ | -| | - `pattern`_ | -+---------+--------------------------------------------------------------------+ -| Parent | none | -+---------+--------------------------------------------------------------------+ -| Class | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\FormType` | -+---------+--------------------------------------------------------------------+ ++-----------+--------------------------------------------------------------------+ +| Options | - `compound`_ | +| | - `data`_ | +| | - `data_class`_ | +| | - `empty_data`_ | +| | - `required`_ | +| | - `label_attr`_ | +| | - `constraints`_ | +| | - `cascade_validation`_ | +| | - `read_only`_ | +| | - `trim`_ | +| | - `mapped`_ | +| | - `property_path`_ | +| | - `max_length`_ | +| | - `by_reference`_ | +| | - `error_bubbling`_ | +| | - `inherit_data`_ | +| | - `error_mapping`_ | +| | - `invalid_message`_ | +| | - `invalid_message_parameters`_ | +| | - `extra_fields_message`_ | +| | - `post_max_size_message`_ | +| | - `pattern`_ | ++-----------+--------------------------------------------------------------------+ +| Inherited | - `block_name`_ | +| options | - `disabled`_ | +| | - `label`_ | +| | - `attr`_ | +| | - `translation_domain`_ | ++-----------+--------------------------------------------------------------------+ +| Parent | none | ++-----------+--------------------------------------------------------------------+ +| Class | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\FormType` | ++-----------+--------------------------------------------------------------------+ Options ------- @@ -60,8 +61,6 @@ Options .. 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/constraints.rst.inc @@ -70,20 +69,12 @@ Options .. include:: /reference/forms/types/options/read_only.rst.inc -.. include:: /reference/forms/types/options/disabled.rst.inc - .. include:: /reference/forms/types/options/trim.rst.inc .. include:: /reference/forms/types/options/mapped.rst.inc .. include:: /reference/forms/types/options/property_path.rst.inc -.. include:: /reference/forms/types/options/attr.rst.inc - -.. include:: /reference/forms/types/options/translation_domain.rst.inc - -.. include:: /reference/forms/types/options/block_name.rst.inc - .. _reference-form-option-max_length: .. include:: /reference/forms/types/options/max_length.rst.inc @@ -107,3 +98,26 @@ Options .. _reference-form-option-pattern: .. include:: /reference/forms/types/options/pattern.rst.inc + +.. include:: /reference/forms/types/options/action.rst.inc + +.. include:: /reference/forms/types/options/method.rst.inc + +Inherited options +----------------- + +The following options are defined in the +:class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\BaseType` class. +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/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 From 58170fe71fcf76ad59047caf629357d61e41a6c3 Mon Sep 17 00:00:00 2001 From: Christian Flothmann Date: Sat, 8 Mar 2014 11:38:57 +0100 Subject: [PATCH 3/4] document the auto_initialize option for the form type, refs #3410 --- reference/forms/types/form.rst | 3 +++ reference/forms/types/options/auto_initialize.rst.inc | 8 ++++++++ 2 files changed, 11 insertions(+) create mode 100644 reference/forms/types/options/auto_initialize.rst.inc diff --git a/reference/forms/types/form.rst b/reference/forms/types/form.rst index 9481e752cd5..38416d12aa9 100644 --- a/reference/forms/types/form.rst +++ b/reference/forms/types/form.rst @@ -36,6 +36,7 @@ on all types for which ``form`` is the parent type. | | - `label`_ | | | - `attr`_ | | | - `translation_domain`_ | +| | - `auto_initialize`_ | +-----------+--------------------------------------------------------------------+ | Parent | none | +-----------+--------------------------------------------------------------------+ @@ -121,3 +122,5 @@ 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/translation_domain.rst.inc + +.. include:: /reference/forms/types/options/auto_initialize.rst.inc diff --git a/reference/forms/types/options/auto_initialize.rst.inc b/reference/forms/types/options/auto_initialize.rst.inc new file mode 100644 index 00000000000..4accfd816ba --- /dev/null +++ b/reference/forms/types/options/auto_initialize.rst.inc @@ -0,0 +1,8 @@ +auto_initialize +~~~~~~~~~~~~~~~ + +**type**: ``boolean`` **default**: ``true`` + +An internal option: sets whether the form should be initialized automatically. +For all fields, this option should only be ``true`` for root forms. You won't +need to change this option and probably won't need to worry about it. From b3ca94c7833390f7128c692992ed6ed413dd9cb2 Mon Sep 17 00:00:00 2001 From: Christian Flothmann Date: Sun, 9 Mar 2014 22:53:17 +0100 Subject: [PATCH 4/4] removed the description of the auto_initialize option from the button type reference docs --- reference/forms/types/button.rst | 7 ------- .../forms/types/options/button_auto_initialize.rst.inc | 9 --------- 2 files changed, 16 deletions(-) delete mode 100644 reference/forms/types/options/button_auto_initialize.rst.inc diff --git a/reference/forms/types/button.rst b/reference/forms/types/button.rst index a58fb5c3333..a0bf11c5480 100644 --- a/reference/forms/types/button.rst +++ b/reference/forms/types/button.rst @@ -17,8 +17,6 @@ A simple, non-responsive button. | | - `label`_ | | | - `translation_domain`_ | +----------------------+----------------------------------------------------------------------+ -| Overridden options | - `auto_initialize`_ | -+----------------------+----------------------------------------------------------------------+ | Parent type | none | +----------------------+----------------------------------------------------------------------+ | Class | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\ButtonType` | @@ -40,8 +38,3 @@ the form type tree (i.e. it can not be used as a form type on its own). .. include:: /reference/forms/types/options/button_label.rst.inc .. include:: /reference/forms/types/options/button_translation_domain.rst.inc - -Overridden Options ------------------- - -.. include:: /reference/forms/types/options/button_auto_initialize.rst.inc diff --git a/reference/forms/types/options/button_auto_initialize.rst.inc b/reference/forms/types/options/button_auto_initialize.rst.inc deleted file mode 100644 index d34de3cfc3d..00000000000 --- a/reference/forms/types/options/button_auto_initialize.rst.inc +++ /dev/null @@ -1,9 +0,0 @@ -auto_initialize -~~~~~~~~~~~~~~~ - -**type**: ``boolean`` **default**: ``false`` - -An internal option: sets whether the form should be initialized automatically. -For all fields, this option should only be ``true`` for root forms and since -a button can't be an entire form on its own, this is set to ``false``. You -won't need to change this option and probably won't need to worry about it.