Storage\SessionStorageInterface (Component\HttpFoundation\Session)
Symfony\Component\HttpFoundation\Session\Storage\SessionStorageInterface
interface SessionStorageInterface
StorageInterface.
Methods
bool | start() Starts the session. | |
bool | isStarted() Checks if the session is started. | |
string | getId() Returns the session ID. | |
setId(string $id) Sets the session ID. | ||
mixed | getName() Returns the session name. | |
setName(string $name) Sets the session name. | ||
bool | regenerate(bool $destroy = false, int $lifetime = null) Regenerates id that represents this storage. | |
save() Force the session to be saved and closed. | ||
clear() Clear all session data in memory. | ||
SessionBagInterface | getBag(string $name) Gets a SessionBagInterface by name. | |
registerBag(SessionBagInterface $bag) Registers a SessionBagInterface for use. | ||
MetadataBag | getMetadataBag() |
Details
public bool start()
Starts the session.
public bool isStarted()
Checks if the session is started.
public string getId()
Returns the session ID.
public setId(string $id)
Sets the session ID.
public mixed getName()
Returns the session name.
public setName(string $name)
Sets the session name.
public bool regenerate(bool $destroy = false, int $lifetime = null)
Regenerates id that represents this storage.
This method must invoke sessionregenerateid($destroy) unless this interface is used for a storage object designed for unit or functional testing where a real PHP session would interfere with testing.
Note regenerate+destroy should not clear the session data in memory only delete the session data from persistent storage.
Care: When regenerating the session ID no locking is involved in PHPs session design. See https://bugs.php.net/bug.php?id=61470 for a discussion. So you must make sure the regenerated session is saved BEFORE sending the headers with the new ID. Symfonys HttpKernel offers a listener for this. See Symfony\Component\HttpKernel\EventListener\SaveSessionListener. Otherwise session data could get lost again for concurrent requests with the new ID. One result could be that you get logged out after just logging in.
public save()
Force the session to be saved and closed.
This method must invoke sessionwriteclose() unless this interface is used for a storage object design for unit or functional testing where a real PHP session would interfere with testing, in which case it it should actually persist the session data if required.
public clear()
Clear all session data in memory.
public SessionBagInterface getBag(string $name)
Gets a SessionBagInterface by name.
public registerBag(SessionBagInterface $bag)
Registers a SessionBagInterface for use.
public MetadataBag getMetadataBag()
© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/HttpFoundation/Session/Storage/SessionStorageInterface.html