Skip to content

[HttpFoundation] Add documentation about the session. #1154

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 3 commits into from Mar 19, 2012
Merged

[HttpFoundation] Add documentation about the session. #1154

merged 3 commits into from Mar 19, 2012

Conversation

ghost
Copy link

@ghost ghost commented Mar 14, 2012

Refs symfony/symfony#3493 and will close #1135

Native PHP Save Handlers
~~~~~~~~~~~~~~~~~~~~~~~~

So-called 'native' handlers are session handlers are either compiled into PHP or
Copy link
Member

Choose a reason for hiding this comment

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

mising that

Copy link
Author

Choose a reason for hiding this comment

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

Not necessary here since this is a direct statement of what native handlers are.

Copy link
Member

Choose a reason for hiding this comment

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

So-called 'native' handlers are session handlers are

Copy link
Author

Choose a reason for hiding this comment

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

Fixed

@ghost
Copy link
Author

ghost commented Mar 14, 2012

@stof - thanks for the great feedback. This should be good to go now.


Example of use:

use Symfony\\Component\\HttpFoundation\\Session\\Session;
Copy link
Member

Choose a reason for hiding this comment

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

missing either :: at the end of the previous paragraph or .. code-block:: php to make it a code block

Copy link
Author

Choose a reason for hiding this comment

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

Fixed.

@ghost
Copy link
Author

ghost commented Mar 14, 2012

All corrections have been made, thanks!

@ghost
Copy link
Author

ghost commented Mar 15, 2012

This is ready for merge - I may expand the documentation in a second PR later, but for now this is a start :-)

@ghost
Copy link
Author

ghost commented Mar 18, 2012

@weaverryan @fabpot is there anything pending for this PR to be merged?

@weaverryan
Copy link
Member

Hey Drak! I'll take a look at this today and merge it in.

Thanks!

weaverryan added a commit that referenced this pull request Mar 19, 2012
[HttpFoundation] Add documentation about the session.
@weaverryan weaverryan merged commit fa883b4 into symfony:master Mar 19, 2012
weaverryan added a commit that referenced this pull request Mar 19, 2012
@weaverryan
Copy link
Member

Really really nice Drak!

This is probably the most thoroughly-documented component section we have yet. I made some minor tweaks in sha: 679374b

Thanks!

@ghost
Copy link
Author

ghost commented Mar 19, 2012

We need to find someone who can document the Security component. I am not familiar enough with it.

@weaverryan
Copy link
Member

Haha, yes we do - I think that component will likely be several pieces instead of just one document. I know enough about it, just a matter of finding the time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation for the session handlers
2 participants