Skip to content

[Reference] add missing reference options and descriptions #4732

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 9, 2015
Merged

[Reference] add missing reference options and descriptions #4732

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 45 additions & 3 deletions reference/configuration/framework.rst
View file
Open in desktop
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,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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess this description matches the succinct style of the rest of the configuration reference, but I'd like to provide more information about the consequences of settings this option. Examples: If I don't use the Form component and I disable it, will my application performance improve? If I disable the Form component, will some Symfony related feature stop working?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

see my comment below about a reason to disable the CSRF layer. And given that forms are enabling the validation layer by default too, this involves a lot more stuff in your container.


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 @@ -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 <form-enabled>`,
``false`` otherwise

Whether or not to enable validation support.

cache
.....

Expand Down