Class MockArraySessionStorage

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.

Symfony\Component\HttpFoundation\Session\Storage\MockArraySessionStorage implements Symfony\Component\HttpFoundation\Session\Storage\SessionStorageInterface

Direct known subclasses

Symfony\Component\HttpFoundation\Session\Storage\MockFileSessionStorage

Namespace: Symfony\Component\HttpFoundation\Session\Storage
Author: Fabien Potencier fabien@symfony.com
Author: Bulat Shakirzyanov mallluhuct@gmail.com
Author: Drak drak@zikula.org
Located at Session/Storage/MockArraySessionStorage.php

Methods summary
`public`	# `__construct( string $name = 'MOCKSESSID', Symfony\Component\HttpFoundation\Session\Storage\MetadataBag $metaBag = null )` Constructor. Constructor. Parameters `$name` Session name `$metaBag` MetadataBag instance.
`public`	# `setSessionData( array $array )` Sets the session data. Sets the session data. Parameters `$array`
`public boolean`	# `start( )` Starts the session. Starts the session. Returns boolean True if started. Throws `RuntimeException` If something goes wrong starting the session. Implementation of `Symfony\Component\HttpFoundation\Session\Storage\SessionStorageInterface::start()`
`public boolean`	# `regenerate( boolean $destroy = false, integer $lifetime = null )` Regenerates id that represents this storage. Regenerates id that represents this storage. Parameters `$destroy` Destroy session when regenerating? `$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. Returns boolean True if session regenerated, false if error Throws `RuntimeException` If an error occurs while regenerating this storage Implementation of `Symfony\Component\HttpFoundation\Session\Storage\SessionStorageInterface::regenerate()`
`public string`	# `getId( )` Returns the session ID. Returns the session ID. Returns string The session ID or empty. Implementation of `Symfony\Component\HttpFoundation\Session\Storage\SessionStorageInterface::getId()`
`public`	# `setId( string $id )` Sets the session ID. Sets the session ID. Parameters `$id` Implementation of `Symfony\Component\HttpFoundation\Session\Storage\SessionStorageInterface::setId()`
`public mixed`	# `getName( )` Returns the session name. Returns the session name. Returns mixed The session name. Implementation of `Symfony\Component\HttpFoundation\Session\Storage\SessionStorageInterface::getName()`
`public`	# `setName( string $name )` Sets the session name. Sets the session name. Parameters `$name` Implementation of `Symfony\Component\HttpFoundation\Session\Storage\SessionStorageInterface::setName()`
`public`	# `save( )` Force the session to be saved and closed. Force the session to be saved and closed. Throws `RuntimeException` If the session is saved without being started, or if the session is already closed. Implementation of `Symfony\Component\HttpFoundation\Session\Storage\SessionStorageInterface::save()`
`public`	# `clear( )` Clear all session data in memory. Clear all session data in memory. Implementation of `Symfony\Component\HttpFoundation\Session\Storage\SessionStorageInterface::clear()`
`public`	# `registerBag( Symfony\Component\HttpFoundation\Session\SessionBagInterface $bag )` Registers a SessionBagInterface for use. Registers a SessionBagInterface for use. Parameters `$bag` Implementation of `Symfony\Component\HttpFoundation\Session\Storage\SessionStorageInterface::registerBag()`
`public Symfony\Component\HttpFoundation\Session\SessionBagInterface`	# `getBag( string $name )` Gets a SessionBagInterface by name. Gets a SessionBagInterface by name. Parameters `$name` Returns `Symfony\Component\HttpFoundation\Session\SessionBagInterface` Throws `InvalidArgumentException` If the bag does not exist Implementation of `Symfony\Component\HttpFoundation\Session\Storage\SessionStorageInterface::getBag()`
`public boolean`	# `isStarted( )` Checks if the session is started. Checks if the session is started. Returns boolean True if started, false otherwise. Implementation of `Symfony\Component\HttpFoundation\Session\Storage\SessionStorageInterface::isStarted()`
`public`	# `setMetadataBag( Symfony\Component\HttpFoundation\Session\Storage\MetadataBag $bag = null )` Sets the MetadataBag. Sets the MetadataBag. Parameters `$bag`
`public Symfony\Component\HttpFoundation\Session\Storage\MetadataBag`	# `getMetadataBag( )` Gets the MetadataBag. Gets the MetadataBag. Returns `Symfony\Component\HttpFoundation\Session\Storage\MetadataBag` Implementation of `Symfony\Component\HttpFoundation\Session\Storage\SessionStorageInterface::getMetadataBag()`
`protected string`	# `generateId( )` Generates a session ID. Generates a session ID. This doesn't need to be particularly cryptographically secure since this is just a mock. Returns string
`protected`	# `loadSession( )`

Properties summary
`protected string`	`$id`	# `''`
`protected string`	`$name`	#
`protected boolean`	`$started`	# `false`
`protected boolean`	`$closed`	# `false`
`protected array`	`$data`	# `array()`
`protected Symfony\Component\HttpFoundation\Session\Storage\MetadataBag`	`$metadataBag`	#
`protected array`	`$bags`	#

Namespaces

Classes

Interfaces

Class MockArraySessionStorage

Direct known subclasses

Parameters

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Throws

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Throws

Implementation of

Implementation of

Parameters

Implementation of

Parameters

Returns

Throws

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns