Skip to content

Commit 24c4f42

Browse files
committed
feature #4732 [Reference] add missing reference options and descriptions (xabbuh)
This PR was merged into the 2.3 branch. Discussion ---------- [Reference] add missing reference options and descriptions | Q | A | ------------- | --- | Doc fix? | yes | New docs? | no | Applies to | all | Fixed tickets | Commits ------- 9e69638 add missing reference options and descriptions
2 parents 6b66f03 + 9e69638 commit 24c4f42

File tree

1 file changed

+45
-3
lines changed

1 file changed

+45
-3
lines changed

reference/configuration/framework.rst

Lines changed: 45 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ Configuration
2222
* `default_locale`_
2323
* `trusted_proxies`_
2424
* `form`_
25-
* enabled
25+
* :ref:`enabled <form-enabled>`
2626
* `csrf_protection`_
27-
* enabled
28-
* field_name
27+
* :ref:`enabled <csrf-protection-enabled>`
28+
* `field_name`_
2929
* `session`_
3030
* `name`_
3131
* `cookie_lifetime`_
@@ -50,6 +50,7 @@ Configuration
5050
* :ref:`enabled <translator.enabled>`
5151
* `fallback`_
5252
* `validation`_
53+
* :ref:`enabled <validation-enabled>`
5354
* `cache`_
5455
* `enable_annotations`_
5556
* `translation_domain`_
@@ -208,9 +209,40 @@ see :doc:`/cookbook/request/load_balancer_reverse_proxy`.
208209
form
209210
~~~~
210211

212+
.. _form-enabled:
213+
214+
enabled
215+
.......
216+
217+
**type**: ``boolean`` **default**: ``false``
218+
219+
Whether or not to enable support for the Form component.
220+
221+
You will also have to disable form support if you want to
222+
:ref:`disable the validation support <validation-enabled>`.
223+
211224
csrf_protection
212225
~~~~~~~~~~~~~~~
213226

227+
.. _csrf-protection-enabled:
228+
229+
enabled
230+
.......
231+
232+
**type**: ``boolean`` **default**: ``true`` if form support is enabled, ``false``
233+
otherwise
234+
235+
This option can be used to disable CSRF protection of forms. You need to
236+
disable CSRF protection to be able to disable session. For example, this
237+
is useful when you only use forms in an API-only website.
238+
239+
field_name
240+
..........
241+
242+
**type**: ``string`` **default**: ``"_token"``
243+
244+
The name of the hidden field used to render the :ref:`CSRF token <forms-csrf>`.
245+
214246
session
215247
~~~~~~~
216248

@@ -538,6 +570,16 @@ For more details, see :doc:`/book/translation`.
538570
validation
539571
~~~~~~~~~~
540572

573+
.. _validation-enabled:
574+
575+
enabled
576+
.......
577+
578+
**type**: ``boolean`` **default**: ``true`` if :ref:`form support is enabled <form-enabled>`,
579+
``false`` otherwise
580+
581+
Whether or not to enable validation support.
582+
541583
cache
542584
.....
543585

0 commit comments

Comments
 (0)