Description
The form type reference is not yet fully updated. It should be updated in the 2.3 branch.
Documenting new options
Most of the missing options are already documented. You should check in the reference/forms/types/options/
directory to find if the option is already documented and if the description is correct for this type. If it is, you should add an include statement in the type reference article:
.. include:: /reference/forms/types/options/read_only.rst.inc
If the description is not correct for this type, you need to document it in the type reference article, not in the .rst.inc
file, since it's used in multiple places where the current description is correct.
error_bubbling
~~~~~~~~~~~~~~
**type**: ``boolean`` **default**: ``false``
Some description and usage of the type.
If there is no documentation about the option and it is used in other types, you should create a new file in the reference/forms/types/options/
directory and include it in the relevant types.
If you are documenting an option that's new in a specific version, you should add a versionadded directive above it. This should only be done for types introduced in 2.2 or newer, not for 2.1:
.. versionadded:: 2.2
The ``with_minutes`` option was introduced in Symfony 2.2.
with_minutes
~~~~~~~~~~~~
**type**: ``boolean`` **default**: ``true``
...
Removing/renaming an option
When an option should be removed or renamed, you should remove/rename the file from
/reference/forms/types/options
and check all form types to remove/rename the
include statements, references and other occurences of that option.
The missing options in 2.3
- [x]
format
(new in 2.1)
-
empty_data
(new in 2.1) -
max_length
-
pattern
-
by_reference
-
error_bubbling
-
auto_initialize
(new in 2.3) -
inherit_data
(new in 2.3) -
method
(new in 2.3) -
action
(new in 2.3) -
error_mapping
-
invalid_message
-
invalid_message_parameters
-
extra_fields_message
-
post_max_size_message
- Parent type changed from
field
toform
in 2.1. -
value
option should be removed from this type
-
with_minutes
(new in 2.2)