10000 [FrameworkBundle] Add some doc on missing options of framework bundle configuration by Nek- · Pull Request #8061 · symfony/symfony-docs · GitHub
[go: up one dir, main page]
Skip to content

[FrameworkBundle] Add some doc on missing options of framework bundle configuration #8061

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
Jul 11, 2017
Merged

[FrameworkBundle] Add some doc on missing options of framework bundle configuration #8061

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
26 changes: 26 additions & 0 deletions reference/configuration/framework.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,9 @@ Configuration
* `gc_divisor`_
* `gc_probability`_
* `gc_maxlifetime`_
* `use_strict_mode`_
* `save_path`_
* `metadata_update_threshold`_
* `assets`_
* `base_path`_
* `base_urls`_
Expand Down Expand Up @@ -809,6 +811,17 @@ This determines the number of seconds after which data will be seen as "garbage"
and potentially cleaned up. Garbage collection may occur during session
start and depends on `gc_divisor`_ and `gc_probability`_.

use_strict_mode
...............

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

This specifies whether the session module will use the strict session id mode.
If this mode is enabled, the module does not accept uninitialized session IDs.
If an uninitialized session ID is sent from browser, a new session ID is sent
to browser. Applications are protected from session fixation via session
adoption with strict mode.

save_path
.........

Expand Down Expand Up @@ -855,6 +868,19 @@ setting the value to ``null``:
),
));

metadata_update_threshold
.........................

Copy link
Member

Choose a reason for hiding this comment

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

Here we are missing the data type and its default value.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed 👍

**type**: ``integer`` **default**: ``0``

This is how many seconds to wait between two session metadata updates. It will
also prevent the session handler to write if the session has not changed.

.. seealso::

You can see an example of the usage of this in
:doc:`/session/limit_metadata_writes`.

assets
~~~~~~

Expand Down
0