1. class
  2. Symfony
  3. \
  4. Component
  5. \
  6. HttpFoundation
  7. \
  8. Session
  9. \
  10. Storage
  11. \
  12. MockArraySessionStorage

MockArraySessionStorage

class MockArraySessionStorage implements SessionStorageInterface

MockArraySessionStorage mocks the session for unit tests.

No PHP session is actually started since a session can be initialized and shutdown only once per PHP execution cycle.

When doing functional testing, you should use MockFileSessionStorage instead.

Properties

protected string $id
protected string $name
protected bool $started
protected bool $closed
protected array $data
protected MetadataBag $metadataBag
protected array|SessionBagInterface[] $bags

Methods

__construct(string $name = 'MOCKSESSID', MetadataBag $metaBag = null)

No description

setSessionData(array $array)

No description

bool
start()

Starts the session.

bool
regenerate(bool $destroy = false, int $lifetime = null)

Regenerates id that represents this storage.

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.

save()

Force the session to be saved and closed.

clear()

Clear all session data in memory.

registerBag(SessionBagInterface $bag)

Registers a SessionBagInterface for use.

SessionBagInterface
getBag(string $name)

Gets a SessionBagInterface by name.

bool
isStarted()

Checks if the session is started.

setMetadataBag(MetadataBag $bag = null)

No description

MetadataBag
getMetadataBag()

Gets the MetadataBag.

string
generateId()

Generates a session ID.

loadSession()

No description

Details

__construct(string $name = 'MOCKSESSID', MetadataBag $metaBag = null)

Parameters

string $name
MetadataBag $metaBag

setSessionData(array $array)

Parameters

array $array

bool start()

Starts the session.

Return Value

bool True if started

Exceptions

RuntimeException if something goes wrong starting the session

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.

Parameters

bool $destroy Destroy session when regenerating?
int $lifetime Sets the cookie lifetime for the session cookie. A null value will leave the system settings unchanged, 0 sets the cookie to expire with browser session. Time is in seconds, and is not a Unix timestamp.

Return Value

bool True if session regenerated, false if error

Exceptions

RuntimeException If an error occurs while regenerating this storage

string getId()

Returns the session ID.

Return Value

string The session ID or empty

setId(string $id)

Sets the session ID.

Parameters

string $id

mixed getName()

Returns the session name.

Return Value

mixed The session name

setName(string $name)

Sets the session name.

Parameters

string $name

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.

Exceptions

RuntimeException if the session is saved without being started, or if the session is already closed

clear()

Clear all session data in memory.

registerBag(SessionBagInterface $bag)

Registers a SessionBagInterface for use.

Parameters

SessionBagInterface $bag

SessionBagInterface getBag(string $name)

Gets a SessionBagInterface by name.

Parameters

string $name

Return Value

SessionBagInterface

Exceptions

InvalidArgumentException If the bag does not exist

bool isStarted()

Checks if the session is started.

Return Value

bool True if started, false otherwise

setMetadataBag(MetadataBag $bag = null)

Parameters

MetadataBag $bag

MetadataBag getMetadataBag()

Gets the MetadataBag.

Return Value

MetadataBag

protected string generateId()

Generates a session ID.

This doesn't need to be particularly cryptographically secure since this is just a mock.

Return Value

string

protected loadSession()