1. interface
  2. Neos
  3. \
  4. Flow
  5. \
  6. Session
  7. \
  8. SessionManagerInterface

SessionManagerInterface

interface SessionManagerInterface (View source)

Interface for a session manager

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.

Methods

SessionInterface
getCurrentSession()

Returns the currently active session which stores session data for the current HTTP request on this local system.

SessionInterface|null
getSession(string $sessionIdentifier)

Returns the specified session. If no session with the given identifier exists, NULL is returned.

array
getActiveSessions()

Returns all active sessions, even remote ones.

array
getSessionsByTag(string $tag)

Returns all sessions which are tagged by the specified tag.

int
destroySessionsByTag(string $tag, string $reason = '')

Destroys all sessions which are tagged with the specified tag.

int|null
collectGarbage()

Remove data of all sessions which are considered to be expired.

Details

at line 32
SessionInterface getCurrentSession()

Returns the currently active session which stores session data for the current HTTP request on this local system.

Return Value

SessionInterface

at line 40
SessionInterface|null getSession(string $sessionIdentifier)

Returns the specified session. If no session with the given identifier exists, NULL is returned.

Parameters

string $sessionIdentifier

Return Value

SessionInterface|null

at line 48
array getActiveSessions()

Returns all active sessions, even remote ones.

Return Value

array

at line 57
array getSessionsByTag(string $tag)

Returns all sessions which are tagged by the specified tag.

Parameters

string $tag

A valid Cache Frontend tag

Return Value

array

A collection of Session objects or an empty array if tag did not match

at line 67
int destroySessionsByTag(string $tag, string $reason = '')

Destroys all sessions which are tagged with the specified tag.

Parameters

string $tag

A valid Cache Frontend tag
string $reason

A reason to mention in log output for why the sessions have been destroyed. For example: "The corresponding account was deleted"

Return Value

int

Number of sessions which have been destroyed

at line 74
int|null collectGarbage()

Remove data of all sessions which are considered to be expired.

Return Value

int|null

The number of outdated entries removed or NULL if no such information could be determined