MockFileSessionStorage
class MockFileSessionStorage extends MockArraySessionStorage
MockFileSessionStorage is used to mock sessions for functional testing when done in a single PHP process.
No PHP session is actually started since a session can be initialized and shutdown only once per PHP execution cycle and this class does not pollute any session related globals, including session_() functions or session. PHP ini directives.
Properties
protected string | $id | from MockArraySessionStorage | |
protected string | $name | from MockArraySessionStorage | |
protected bool | $started | from MockArraySessionStorage | |
protected bool | $closed | from MockArraySessionStorage | |
protected array | $data | from MockArraySessionStorage | |
protected MetadataBag | $metadataBag | from MockArraySessionStorage | |
protected array|SessionBagInterface[] | $bags | from MockArraySessionStorage |
Methods
No description
Starts the session.
Regenerates id that represents this storage.
Force the session to be saved and closed.
Gets a SessionBagInterface by name.
Details
bool
regenerate(bool $destroy = false, int $lifetime = null)
Regenerates id that represents this storage.
This method must invoke session_regenerate_id($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 PHP's 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. Symfony's 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.
save()
Force the session to be saved and closed.
This method must invoke session_write_close() 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 should actually persist the session data if required.