Skip to content

Commit 19b8f82

Browse files
committed
minor #10544 Documented the framework.session.enabled option (javiereguiluz)
This PR was merged into the 3.4 branch. Discussion ---------- Documented the framework.session.enabled option This fixes #6772. Commits ------- 370b86d Documented the framework.session.enabled option
2 parents ab614c9 + 370b86d commit 19b8f82

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

reference/configuration/framework.rst

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,7 @@ Configuration
147147
* `cookie_lifetime`_
148148
* `cookie_path`_
149149
* `cookie_secure`_
150+
* :ref:`enabled <reference-session-enabled>`
150151
* `gc_divisor`_
151152
* `gc_maxlifetime`_
152153
* `gc_probability`_
@@ -959,6 +960,49 @@ session persists.
959960
Starting in Symfony 3.4, session data is *only* written when the session data has
960961
changed. Previously, you needed to set this option to avoid that behavior.
961962

963+
.. _reference-session-enabled:
964+
965+
enabled
966+
.......
967+
968+
**type**: ``boolean`` **default**: ``true``
969+
970+
Whether to enable the session support in the framework.
971+
972+
.. configuration-block::
973+
974+
.. code-block:: yaml
975+
976+
# app/config/config.yml
977+
framework:
978+
session:
979+
enabled: true
980+
981+
.. code-block:: xml
982+
983+
<!-- app/config/config.xml -->
984+
<?xml version="1.0" encoding="UTF-8" ?>
985+
<container xmlns="http://symfony.com/schema/dic/services"
986+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
987+
xmlns:framework="http://symfony.com/schema/dic/symfony"
988+
xsi:schemaLocation="http://symfony.com/schema/dic/services
989+
http://symfony.com/schema/dic/services/services-1.0.xsd
990+
http://symfony.com/schema/dic/symfony http://symfony.com/schema/dic/symfony/symfony-1.0.xsd">
991+
992+
<framework:config>
993+
<framework:session enabled="true" />
994+
</framework:config>
995+
</container>
996+
997+
.. code-block:: php
998+
999+
// app/config/config.php
1000+
$container->loadFromExtension('framework', array(
1001+
'session' => array(
1002+
'enabled' => true,
1003+
),
1004+
));
1005+
9621006
assets
9631007
~~~~~~
9641008

0 commit comments

Comments
 (0)