From 9e696381649eee1955b961d0a6e7b64b91aa5f0e Mon Sep 17 00:00:00 2001 From: Christian Flothmann Date: Fri, 2 Jan 2015 14:27:12 +0100 Subject: [PATCH] add missing reference options and descriptions --- reference/configuration/framework.rst | 48 +++++++++++++++++++++++++-- 1 file changed, 45 insertions(+), 3 deletions(-) diff --git a/reference/configuration/framework.rst b/reference/configuration/framework.rst index 1eff10507f3..588a6133e04 100644 --- a/reference/configuration/framework.rst +++ b/reference/configuration/framework.rst @@ -21,10 +21,10 @@ Configuration * `test`_ * `trusted_proxies`_ * `form`_ - * enabled + * :ref:`enabled ` * `csrf_protection`_ - * enabled - * field_name + * :ref:`enabled ` + * `field_name`_ * `session`_ * `name`_ * `cookie_lifetime`_ @@ -49,6 +49,7 @@ Configuration * :ref:`enabled ` * `fallback`_ * `validation`_ + * :ref:`enabled ` * `cache`_ * `enable_annotations`_ * `translation_domain`_ @@ -196,9 +197,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 `. + 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 `. + session ~~~~~~~ @@ -524,6 +556,16 @@ For more details, see :doc:`/book/translation`. validation ~~~~~~~~~~ +.. _validation-enabled: + +enabled +....... + +**type**: ``boolean`` **default**: ``true`` if :ref:`form support is enabled `, +``false`` otherwise + +Whether or not to enable validation support. + cache .....