8000 [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.

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

Conversation

Nek-
Copy link
Contributor
@Nek- Nek- commented Jun 19, 2017

This is the missing documentation following this commit : symfony/symfony@ac9a527

It also adds a part for the missing metadata_update_threshold option.

@Nek- Nek- changed the title Add some doc on missing options of framework bundle configuration [FrameworkBundle] Add some doc on missing options of framework bundle configuration Jun 19, 2017
@xabbuh xabbuh added this to the 2.7 milestone Jun 19, 2017
use_strict_mode
...............

**type**: ``boolean`` **default**: ``0``
Copy link
Member

Choose a reason for hiding this comment

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

the default value should be false

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I took the PHP default value. More accurate IMO. But I can change if you want.

Copy link
Member

Choose a reason for hiding this comment

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

since this is a boolean node having 0 will cause more troubles so I would indeed change it :)


**type**: ``boolean`` **default**: ``0``

This specifies whether the module will use strict session id mode. If this mode
Copy link
Member

Choose a reason for hiding this comment

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

[...] use the strict [...]

**type**: ``boolean`` **default**: ``0``

This specifies whether the module will use strict session id mode. If this mode
is enabled, the module does not accept uninitialized session ID. If
Copy link
Member

Choose a reason for hiding this comment

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

IDs


This specifies whether the module will use strict session id mode. If this mode
is enabled, the module does not accept uninitialized session ID. If
uninitialized session ID is sent from browser, new session ID is sent to
Copy link
Member

Choose a reason for hiding this comment

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

[...] an uninitialized [...]

Copy link
Member

Choose a reason for hiding this comment

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

[...] from the browser, a new session ID is generated.

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

This is how many seconds to wait between 2 session metadata updates, it will
Copy link
Member

Choose a reason for hiding this comment

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

two

Copy link
Member

Choose a reason for hiding this comment

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

And I would split this into two sentences: "[...] updates. It will [...]"

@Nek- Nek- force-pushed the fix/framework-bundle-session-conf branch from 1fd2823 to 0230482 Compare June 19, 2017 14:24
@Nek-
Copy link
Contributor Author
Nek- commented Jun 19, 2017

@xabbuh fixed :). Thanks.


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

This specifies whether the module will use the strict session id mode. If this
Copy link
Member

Choose a reason for hiding this comment

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

I don't know the meaning of "the module" in this context.

@@ -855,6 +868,18 @@ 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 👍

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.


Copy link
Member

Choose a reason for hiding this comment

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

This extra blank line can be removed.

@Nek- Nek- force-pushed the fix/framework-bundle-session-conf branch from 0230482 to 246fea2 Compare July 4, 2017 10:16
@Nek- Nek- changed the base branch from master to 2.7 July 4, 2017 10:16
@Nek-
Copy link
Contributor Author
Nek- commented Jul 4, 2017

@javiereguiluz everything fixed, I also changed the base branch to 2.7.

@Nek-
Copy link
Contributor Author
Nek- commented Jul 4, 2017

Status: Needs Review

@xabbuh
Copy link
Member
xabbuh commented Jul 11, 2017

Thank you @Nek-.

@xabbuh xabbuh merged commit 246fea2 into symfony:2.7 Jul 11, 2017
xabbuh added a commit that referenced this pull request Jul 11, 2017
…ework bundle configuration (Nek-)

This PR was merged into the 2.7 branch.

Discussion
----------

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

This is the missing documentation following this commit : symfony/symfony@ac9a527

It also adds a part for the missing `metadata_update_threshold` option.

Commits
-------

246fea2 Add some doc on missing options of framework bundle configuration
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants
0