Skip to content

Commit 0783879

Browse files
committed
Merge branch '2.3' into 2.6
* 2.3: add missing reference options and descriptions Conflicts: reference/configuration/framework.rst
2 parents ea3d91f + 24c4f42 commit 0783879

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
@@ -25,10 +25,10 @@ Configuration
2525
* enabled
2626
* field_name (deprecated)
2727
* `form`_
28-
* enabled
28+
* :ref:`enabled <form-enabled>`
2929
* csrf_protection
30-
* enabled
31-
* field_name
30+
* :ref:`enabled <csrf-protection-enabled>`
31+
* `field_name`_
3232
* `session`_
3333
* `name`_
3434
* `cookie_lifetime`_
@@ -57,6 +57,7 @@ Configuration
5757
* `magic_call`_
5858
* `throw_exception_on_invalid_index`_
5959
* `validation`_
60+
* :ref:`enabled <validation-enabled>`
6061
* `cache`_
6162
* `enable_annotations`_
6263
* `translation_domain`_
@@ -217,9 +218,40 @@ see :doc:`/cookbook/request/load_balancer_reverse_proxy`.
217218
form
218219
~~~~
219220

221+
.. _form-enabled:
222+
223+
enabled
224+
.......
225+
226+
**type**: ``boolean`` **default**: ``false``
227+
228+
Whether or not to enable support for the Form component.
229+
230+
You will also have to disable form support if you want to
231+
:ref:`disable the validation support <validation-enabled>`.
232+
220233
csrf_protection
221234
~~~~~~~~~~~~~~~
222235

236+
.. _csrf-protection-enabled:
237+
238+
enabled
239+
.......
240+
241+
**type**: ``boolean`` **default**: ``true`` if form support is enabled, ``false``
242+
otherwise
243+
244+
This option can be used to disable CSRF protection of forms. You need to
245+
disable CSRF protection to be able to disable session. For example, this
246+
is useful when you only use forms in an API-only website.
247+
248+
field_name
249+
..........
250+
251+
**type**: ``string`` **default**: ``"_token"``
252+
253+
The name of the hidden field used to render the :ref:`CSRF token <forms-csrf>`.
254+
223255
session
224256
~~~~~~~
225257

@@ -586,6 +618,16 @@ try to access an invalid index of an array.
586618
validation
587619
~~~~~~~~~~
588620

621+
.. _validation-enabled:
622+
623+
enabled
624+
.......
625+
626+
**type**: ``boolean`` **default**: ``true`` if :ref:`form support is enabled <form-enabled>`,
627+
``false`` otherwise
628+
629+
Whether or not to enable validation support.
630+
589631
cache
590632
.....
591633

0 commit comments

Comments
 (0)