8000 Normalization of method listings by pedronofuentes · Pull Request #4539 · symfony/symfony-docs · GitHub
[go: up one dir, main page]
Skip to content

Normalization of method listings #4539

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 5 commits into from
Dec 20, 2014
Merged

Normalization of method listings #4539

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1d571ca
Changed unordered list to definition list
pedronofuentes Nov 29, 2014
6b68e48
Changed paragraph to heading
pedronofuentes Nov 29, 2014
3649bdb
Fixed heading capitalization to follow the standards
pedronofuentes Nov 29, 2014
dda1905
Changed to definition lists
pedronofuentes Nov 29, 2014
3fd3963
Changed to definition lists from Book section
pedronofuentes Dec 2, 2014
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
Next Next commit
Changed unordered list to definition list
  • Loading branch information
@pedronofuentes
pedronofuentes committed Dec 17, 2014
commit 1d571ca47dcc53892afb7a4d39f42be588f02596
82 changes: 41 additions & 41 deletions components/http_foundation/sessions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,71 +67,71 @@ as follows divided into a couple of groups.

Session workflow

* :method:`Symfony\\Component\\HttpFoundation\\Session\\Session::start`:
Starts the session - do not use ``session_start()``;
:method:`Symfony\\Component\\HttpFoundation\\Session\\Session::start`
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()``.
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::migrate`
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 all session data and regenerates session ID. Do not use ``session_destroy()``;
:method:`Symfony\\Component\\HttpFoundation\\Session\\Session::invalidate`
Clears all session data and regenerates session ID. Do not use ``session_destroy()``.

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

* :method:`Symfony\\Component\\HttpFoundation\\Session\\Session::setId`: Sets the
session ID. Do not use ``session_id()``;
:method:`Symfony\\Component\\HttpFoundation\\Session\\Session::setId`
Sets the session ID. Do not use ``session_id()``.

* :method:`Symfony\\Component\\HttpFoundation\\Session\\Session::getName`: Gets the
session name. Do not use ``session_name()``;
:method:`Symfony\\Component\\HttpFoundation\\Session\\Session::getName`
Gets the session name. Do not use ``session_name()``.

* :method:`Symfony\\Component\\HttpFoundation\\Session\\Session::setName`: Sets the
session name. Do not use ``session_name()``.
:method:`Symfony\\Component\\HttpFoundation\\Session\\Session::setName`
Sets the session name. Do not use ``session_name()``.

Session attributes

* :method:`Symfony\\Component\\HttpFoundation\\Session\\Session::set`:
Sets an attribute by key;
:method:`Symfony\\Component\\HttpFoundation\\Session\\Session::set`
Sets an attribute by key.

* :method:`Symfony\\Component\\HttpFoundation\\Session\\Session::get`:
Gets an attribute by key;
:method:`Symfony\\Component\\HttpFoundation\\Session\\Session::get`
Gets an attribute by key.

* :method:`Symfony\\Component\\HttpFoundation\\Session\\Session::all`:
Gets all attributes as an array of key => value;
:method:`Symfony\\Component\\HttpFoundation\\Session\\Session::all`
Gets all attributes as an array of key => value.

* :method:`Symfony\\Component\\HttpFoundation\\Session\\Session::has`:
Returns true if the attribute exists;
:method:`Symfony\\Component\\HttpFoundation\\Session\\Session::has`
Returns true if the attribute exists.

* :method:`Symfony\\Component\\HttpFoundation\\Session\\Session::replace`:
Sets multiple attributes at once: takes a keyed array and sets each key => value pair;
:method:`Symfony\\Component\\HttpFoundation\\Session\\Session::replace`
Sets multiple attributes at once: takes a keyed array and sets each key => value pair;

* :method:`Symfony\\Component\\HttpFoundation\\Session\\Session::remove`:
Deletes an attribute by key;
:method:`Symfony\\Component\\HttpFoundation\\Session\\Session::remove`
Deletes an attribute by key;

* :method:`Symfony\\Component\\HttpFoundation\\Session\\Session::clear`:
Clear all attributes.
:method:`Symfony\\Component\\HttpFoundation\\Session\\Session::clear`
Clear all attributes.

The attributes are stored internally in a "Bag", a PHP object that acts like
an array. A few methods exist for "Bag" management:

* :method:`Symfony\\Component\\HttpFoundation\\Session\\Session::registerBag`:
Registers a :class:`Symfony\\Component\\HttpFoundation\\Session\\SessionBagInterface`;
:method:`Symfony\\Component\\HttpFoundation\\Session\\Session::registerBag`
Registers a :class:`Symfony\\Component\\HttpFoundation\\Session\\SessionBagInterface`.

* :method:`Symfony\\Component\\HttpFoundation\\Session\\Session::getBag`:
Gets a :class:`Symfony\\Component\\HttpFoundation\\Session\\SessionBagInterface` by
bag name;
:method:`Symfony\\Component\\HttpFoundation\\Session\\Session::getBag`
Gets a :class:`Symfony\\Component\\HttpFoundation\\Session\\SessionBagInterface` by
bag name;

* :method:`Symfony\\Component\\HttpFoundation\\Session\\Session::getFlashBag`:
Gets the :class:`Symfony\\Component\\HttpFoundation\\Session\\Flash\\FlashBagInterface`.
This is just a shortcut for convenience.
:method:`Symfony\\Component\\HttpFoundation\\Session\\Session::getFlashBag`
Gets the :class:`Symfony\\Component\\HttpFoundation\\Session\\Flash\\FlashBagInterface`.
This is just a shortcut for convenience.

Session metadata

* :method:`Symfony\\Component\\HttpFoundation\\Session\\Session::getMetadataBag`:
Gets the :class:`Symfony\\Component\\HttpFoundation\\Session\\Storage\\MetadataBag`
which contains information about the session.
:method:`Symfony\\Component\\HttpFoundation\\Session\\Session::getMetadataBag`
Gets the :class:`Symfony\\Component\\HttpFoundation\\Session\\Storage\\MetadataBag`
which contains information about the session.

Session Data Management
~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
0