Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 9e69638

Browse filesBrowse files
committed
add missing reference options and descriptions
1 parent 6763052 commit 9e69638
Copy full SHA for 9e69638

File tree

Expand file treeCollapse file tree

1 file changed

+45
-3
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+45
-3
lines changed

‎reference/configuration/framework.rst

Copy file name to clipboardExpand all lines: reference/configuration/framework.rst
+45-3Lines changed: 45 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ Configuration
2121
* `test`_
2222
* `trusted_proxies`_
2323
* `form`_
24-
* enabled
24+
* :ref:`enabled <form-enabled>`
2525
* `csrf_protection`_
26-
* enabled
27-
* field_name
26+
* :ref:`enabled <csrf-protection-enabled>`
27+
* `field_name`_
2828
* `session`_
2929
* `name`_
3030
* `cookie_lifetime`_
@@ -49,6 +49,7 @@ Configuration
4949
* :ref:`enabled <translator.enabled>`
5050
* `fallback`_
5151
* `validation`_
52+
* :ref:`enabled <validation-enabled>`
5253
* `cache`_
5354
* `enable_annotations`_
5455
* `translation_domain`_
@@ -196,9 +197,40 @@ see :doc:`/cookbook/request/load_balancer_reverse_proxy`.
196197
form
197198
~~~~
198199

200+
.. _form-enabled:
201+
202+
enabled
203+
.......
204+
205+
**type**: ``boolean`` **default**: ``false``
206+
207+
Whether or not to enable support for the Form component.
208+
209+
You will also have to disable form support if you want to
210+
:ref:`disable the validation support <validation-enabled>`.
211+
199212
csrf_protection
200213
~~~~~~~~~~~~~~~
201214

215+
.. _csrf-protection-enabled:
216+
217+
enabled
218+
.......
219+
220+
**type**: ``boolean`` **default**: ``true`` if form support is enabled, ``false``
221+
otherwise
222+
223+
This option can be used to disable CSRF protection of forms. You need to
224+
disable CSRF protection to be able to disable session. For example, this
225+
is useful when you only use forms in an API-only website.
226+
227+
field_name
228+
..........
229+
230+
**type**: ``string`` **default**: ``"_token"``
231+
232+
The name of the hidden field used to render the :ref:`CSRF token <forms-csrf>`.
233+
202234
session
203235
~~~~~~~
204236

@@ -524,6 +556,16 @@ For more details, see :doc:`/book/translation`.
524556
validation
525557
~~~~~~~~~~
526558

559+
.. _validation-enabled:
560+
561+
enabled
562+
.......
563+
564+
**type**: ``boolean`` **default**: ``true`` if :ref:`form support is enabled <form-enabled>`,
565+
``false`` otherwise
566+
567+
Whether or not to enable validation support.
568+
527569
cache
528570
.....
529571

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.