Skip to content

Commit

Permalink
feature #4732 [Reference] add missing reference options and descripti…
Browse files Browse the repository at this point in the history
…ons (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
  • Loading branch information
weaverryan committed Mar 9, 2015
2 parents 6b66f03 + 9e69638 commit 24c4f42
Showing 1 changed file with 45 additions and 3 deletions.
48 changes: 45 additions & 3 deletions reference/configuration/framework.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ Configuration
* `default_locale`_
* `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 @@ -50,6 +50,7 @@ Configuration
* :ref:`enabled <translator.enabled>`
* `fallback`_
* `validation`_
* :ref:`enabled <validation-enabled>`
* `cache`_
* `enable_annotations`_
* `translation_domain`_
Expand Down Expand Up @@ -208,9 +209,40 @@ 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.

You will also have to disable form support if you want to
:ref:`disable the validation support <validation-enabled>`.

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 @@ -538,6 +570,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 24c4f42

Please sign in to comment.