Symfony\Component\HttpFoundation\Session\Storage\PhpBridgeSessionStorage

class PhpBridgeSessionStorage extends NativeSessionStorage

Methods

	__construct(AbstractProxy|NativeSessionHandler|SessionHandlerInterface|null $handler = null, MetadataBag $metaBag = null) Constructor.
AbstractProxy	getSaveHandler() Gets the save handler instance.	from NativeSessionStorage
boolean	start() Starts the session.
string	getId() Returns the session ID	from NativeSessionStorage
	setId(string $id) Sets the session ID	from NativeSessionStorage
mixed	getName() Returns the session name	from NativeSessionStorage
	setName(string $name) Sets the session name	from NativeSessionStorage
Boolean	regenerate(Boolean $destroy = false, integer $lifetime = null) Regenerates id that represents this storage.	from NativeSessionStorage
	save() Force the session to be saved and closed.	from NativeSessionStorage
	clear() Clear all session data in memory.
	registerBag(SessionBagInterface $bag) Registers a SessionBagInterface for use.	from NativeSessionStorage
SessionBagInterface	getBag(string $name) Gets a SessionBagInterface by name.	from NativeSessionStorage
	setMetadataBag(MetadataBag $metaBag = null) Sets the MetadataBag.	from NativeSessionStorage
MetadataBag	getMetadataBag() Gets the MetadataBag.	from NativeSessionStorage
boolean	isStarted() Checks if the session is started.	from NativeSessionStorage
	setOptions(array $options) Sets session.* ini variables.	from NativeSessionStorage
	setSaveHandler(AbstractProxy|NativeSessionHandler|SessionHandlerInterface|null $saveHandler = null) Registers session save handler as a PHP session handler.	from NativeSessionStorage

Details

public __construct(AbstractProxy|NativeSessionHandler|SessionHandlerInterface|null $handler = null, MetadataBag $metaBag = null)

Constructor.

public AbstractProxy getSaveHandler()

Gets the save handler instance.

public boolean start()

Starts the session.

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 Boolean regenerate(Boolean $destroy = false, integer $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.

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 registerBag(SessionBagInterface $bag)

Registers a SessionBagInterface for use.

public SessionBagInterface getBag(string $name)

Gets a SessionBagInterface by name.

public setMetadataBag(MetadataBag $metaBag = null)

Sets the MetadataBag.

public MetadataBag getMetadataBag()

Gets the MetadataBag.

public boolean isStarted()

Checks if the session is started.

public setOptions(array $options)

Sets session.* ini variables.

For convenience we omit 'session.' from the beginning of the keys. Explicitly ignores other ini keys.

public setSaveHandler(AbstractProxy|NativeSessionHandler|SessionHandlerInterface|null $saveHandler = null)

Registers session save handler as a PHP session handler.

To use internal PHP session save handlers, override this method using iniset with session.savehandler and session.save_path e.g.

ini_set('session.save_handler', 'files');
ini_set('session.save_path', /tmp');

or pass in a NativeSessionHandler instance which configures session.save_handler in the constructor, for a template see NativeFileSessionHandler or use handlers in composer package drak/native-session