PHP Interface Neos\Flow\Session\SessionManagerInterface

In order to stay compatible with future features and create more portable apps, make sure to inject this interface instead of the concrete SessionManager implementation.
Datei anzeigen Open project: neos/flow-development-collection Interface Usage Examples

Public Methods

Method Description
destroySessionsByTag ( string $tag, string $reason = '' ) : integer Destroys all sessions which are tagged with the specified tag.
getActiveSessions ( ) : array Returns all active sessions, even remote ones.
getCurrentSession ( ) : Neos\Flow\Session\SessionInterface Returns the currently active session which stores session data for the current HTTP request on this local system.
getSession ( string $sessionIdentifier ) : Neos\Flow\Session\SessionInterface Returns the specified session. If no session with the given identifier exists, NULL is returned.
getSessionsByTag ( string $tag ) : array Returns all sessions which are tagged by the specified tag.

Method Details

destroySessionsByTag() public method

Destroys all sessions which are tagged with the specified tag.
public destroySessionsByTag ( string $tag, string $reason = '' ) : integer
$tag string A valid Cache Frontend tag
$reason string A reason to mention in log output for why the sessions have been destroyed. For example: "The corresponding account was deleted"
return integer Number of sessions which have been destroyed

getActiveSessions() public method

Returns all active sessions, even remote ones.
public getActiveSessions ( ) : array
return array

getCurrentSession() public method

Returns the currently active session which stores session data for the current HTTP request on this local system.
public getCurrentSession ( ) : Neos\Flow\Session\SessionInterface
return Neos\Flow\Session\SessionInterface

getSession() public method

Returns the specified session. If no session with the given identifier exists, NULL is returned.
public getSession ( string $sessionIdentifier ) : Neos\Flow\Session\SessionInterface
$sessionIdentifier string The session identifier
return Neos\Flow\Session\SessionInterface

getSessionsByTag() public method

Returns all sessions which are tagged by the specified tag.
public getSessionsByTag ( string $tag ) : array
$tag string A valid Cache Frontend tag
return array A collection of Session objects or an empty array if tag did not match