Skip to content

[HttpFoundation] Remove misleading documentation. #1703

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 Sep 14, 2012
Merged

[HttpFoundation] Remove misleading documentation. #1703

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
5 changes: 2 additions & 3 deletions components/http_foundation/sessions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,13 +69,12 @@ Session workflow
Starts the session - do not use ``session_start()``.

* :method:`Symfony\\Component\\HttpFoundation\\Session\\Session::migrate`:
Regenerates the session id - do not use ``session_regenerate_id()``.
Regenerates the session ID - do not use ``session_regenerate_id()``.
This method can optionally change the lifetime of the new cookie that will
be emitted by calling this method.

* :method:`Symfony\\Component\\HttpFoundation\\Session\\Session::invalidate`:
Clears the session data and regenerates the session id do not use ``session_destroy()``.
This is a shortcut for ``clear()`` and ``migrate()``.
Clears the all session data and regenerates session ID do not use ``session_destroy()``.
Copy link
Contributor

Choose a reason for hiding this comment

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

Clears all session data
regenerates the session ID
punktuation missing: ... session ID. Do not ...


* :method:`Symfony\\Component\\HttpFoundation\\Session\\Session::getId`: Gets the
session ID. Do not use ``session_id()``.
Expand Down