-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
Document start on demand feature. #2475
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.
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -26,6 +26,10 @@ Configuration | |
* enabled | ||
* field_name | ||
* `session`_ | ||
* `name`_ | ||
* `mock_name`_ | ||
* `auto_start`_ | ||
* `on_demand`_ | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. what about mock_name ? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. these should link to headings explaining these options. If you don't add a section about these options, it should be: * `session`_
* auto_start
* on_demand There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fixed. |
||
* `cookie_lifetime`_ | ||
* `cookie_path`_ | ||
* `cookie_domain`_ | ||
|
@@ -148,6 +152,43 @@ csrf_protection | |
session | ||
~~~~~~~ | ||
|
||
on_demand | ||
......... | ||
|
||
**type**: ``string`` **default**: ``on`` | ||
|
||
Can be values | ||
|
||
- ``on`` - start automatically if not started upon session read/write | ||
- ``off`` - do not start session automatically on data read/write, if an attempt is | ||
make to do so, throw a ``\RuntimeException`` | ||
- ``off_lax`` - do not start session automatically on data read/write, but if an attempt | ||
is made to read or write to the session, allow access to the relevent bag. | ||
If data is written to the bags and a session is subsequently started, it will be | ||
overwritten. | ||
|
||
auto_start | ||
.......... | ||
|
||
**type**: ``Boolean`` **default**: ``false`` | ||
|
||
This controls the ``SessionListener`` which will automatically start the session | ||
during the Request cycle. | ||
|
||
name | ||
.... | ||
|
||
**type**: ``string`` | ||
|
||
Sets the session cookie name | ||
|
||
mock_name | ||
......... | ||
|
||
**type**: ``string`` | ||
|
||
Sets the mock session cookie name | ||
|
||
cookie_lifetime | ||
............... | ||
|
||
|
@@ -462,6 +503,8 @@ Full Default Configuration | |
session: | ||
storage_id: session.storage.native | ||
handler_id: session.handler.native_file | ||
auto_start: false | ||
on_demand: on #on, off or off_lax | ||
name: ~ | ||
cookie_lifetime: ~ | ||
cookie_path: ~ | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe you should mention that this setting reflects what 2.1-2.2 used as default
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.