Skip to content

Commit

Permalink
add missing reference options and descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
xabbuh committed Mar 8, 2015
1 parent 6763052 commit bc60fa2
Showing 1 changed file with 42 additions and 3 deletions.
45 changes: 42 additions & 3 deletions reference/configuration/framework.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ Configuration
* `test`_
* `trusted_proxies`_
* `form`_
* enabled
* :ref:`enabled <form-enabled>`
* `csrf_protection`_
* enabled
* field_name
* :ref:`enabled <csrf-protection-enabled>`
* `field_name`_
* `session`_
* `name`_
* `cookie_lifetime`_
Expand All @@ -49,6 +49,7 @@ Configuration
* :ref:`enabled <translator.enabled>`
* `fallback`_
* `validation`_
* :ref:`enabled <validation-enabled>`
* `cache`_
* `enable_annotations`_
* `translation_domain`_
Expand Down Expand Up @@ -196,9 +197,37 @@ see :doc:`/cookbook/request/load_balancer_reverse_proxy`.
form
~~~~

.. _form-enabled:

enabled
.......

**type**: ``boolean`` **default**: ``false``

Whether or not to enable support for the Form component.

csrf_protection
~~~~~~~~~~~~~~~

.. _csrf-protection-enabled:

enabled
.......

**type**: ``boolean`` **default**: ``true`` if form support is enabled, ``false``
otherwise

This option can be used to disable CSRF protection of forms. You need to
disable CSRF protection to be able to disable session. For example, this
is useful when you only use forms in an API-only website.

field_name
..........

**type**: ``string`` **default**: ``"_token"``

The name of the hidden field used to render the :ref:`CSRF token <forms-csrf>`.

session
~~~~~~~

Expand Down Expand Up @@ -524,6 +553,16 @@ For more details, see :doc:`/book/translation`.
validation
~~~~~~~~~~

.. _validation-enabled:

enabled
.......

**type**: ``boolean`` **default**: ``true`` if :ref:`form support is enabled <form-enabled>`,
``false`` otherwise

Whether or not to enable validation support.

cache
.....

Expand Down

0 comments on commit bc60fa2

Please sign in to comment.