TYPO3\CMS\Core\Session\Backend\RedisSessionBackend Class Reference

Inheritance diagram for TYPO3\CMS\Core\Session\Backend\RedisSessionBackend:

Public Member Functions
	initialize (string $identifier, array $configuration)
	validateConfiguration ()
	hash (string $sessionId)
array	get (string $sessionId)
	remove (string $sessionId)
array	set (string $sessionId, array $sessionData)
array	update (string $sessionId, array $sessionData)
	collectGarbage (int $maximumLifetime, int $maximumAnonymousLifetime=0)
array	getAll ()

Protected Member Functions
	initializeConnection ()
	getSessionKeyName (string $sessionId)
	getSessionTimeout ()

Protected Attributes
array	$configuration = array( )
bool	$connected = false
string	$applicationIdentifier = ''
Redis	$redis
string	$identifier

Detailed Description

Class RedisSessionBackend

This session backend takes these optional configuration options: 'hostname' (default '127.0.0.1'), 'database' (default 0), 'port' (default 3679) and 'password' (no default value).

Definition at line 32 of file RedisSessionBackend.php.

Member Function Documentation

collectGarbage()

TYPO3\CMS\Core\Session\Backend\RedisSessionBackend::collectGarbage	(	int	$maximumLifetime,
		int	$maximumAnonymousLifetime = 0
	)

Garbage Collection

Parameters

int	$maximumLifetime	‪maximum lifetime of authenticated user sessions, in seconds.
int	$maximumAnonymousLifetime	‪maximum lifetime of non-authenticated user sessions, in seconds. If set to 0, nothing is collected.

Implements TYPO3\CMS\Core\Session\Backend\SessionBackendInterface.

Definition at line 224 of file RedisSessionBackend.php.

References $GLOBALS, TYPO3\CMS\Core\Session\Backend\RedisSessionBackend\getAll(), and TYPO3\CMS\Core\Session\Backend\RedisSessionBackend\getSessionKeyName().

get()

array TYPO3\CMS\Core\Session\Backend\RedisSessionBackend::get

(

string

$sessionId

)

Read session data

Returns

‪array Returns the session data

Exceptions

SessionNotFoundException

Implements TYPO3\CMS\Core\Session\Backend\SessionBackendInterface.

Definition at line 126 of file RedisSessionBackend.php.

References TYPO3\CMS\Core\Session\Backend\RedisSessionBackend\getSessionKeyName(), TYPO3\CMS\Core\Session\Backend\RedisSessionBackend\hash(), and TYPO3\CMS\Core\Session\Backend\RedisSessionBackend\initializeConnection().

getAll()

array TYPO3\CMS\Core\Session\Backend\RedisSessionBackend::getAll

(

)

List all sessions

Returns

‪array Return a list of all user sessions. The list may be empty.

Implements TYPO3\CMS\Core\Session\Backend\SessionBackendInterface.

Definition at line 294 of file RedisSessionBackend.php.

References TYPO3\CMS\Core\Session\Backend\RedisSessionBackend\getSessionKeyName(), and TYPO3\CMS\Core\Session\Backend\RedisSessionBackend\initializeConnection().

Referenced by TYPO3\CMS\Core\Session\Backend\RedisSessionBackend\collectGarbage().

getSessionKeyName()

TYPO3\CMS\Core\Session\Backend\RedisSessionBackend::getSessionKeyName ( string  $sessionId )

protected

Definition at line 328 of file RedisSessionBackend.php.

Referenced by TYPO3\CMS\Core\Session\Backend\RedisSessionBackend\collectGarbage(), TYPO3\CMS\Core\Session\Backend\RedisSessionBackend\get(), TYPO3\CMS\Core\Session\Backend\RedisSessionBackend\getAll(), TYPO3\CMS\Core\Session\Backend\RedisSessionBackend\remove(), TYPO3\CMS\Core\Session\Backend\RedisSessionBackend\set(), and TYPO3\CMS\Core\Session\Backend\RedisSessionBackend\update().

getSessionTimeout()

TYPO3\CMS\Core\Session\Backend\RedisSessionBackend::getSessionTimeout ( )

protected

Definition at line 333 of file RedisSessionBackend.php.

References $GLOBALS, and TYPO3\CMS\Core\Session\Backend\RedisSessionBackend\$identifier.

hash()

TYPO3\CMS\Core\Session\Backend\RedisSessionBackend::hash

(

string

$sessionId

)

Implements TYPO3\CMS\Core\Session\Backend\HashableSessionBackendInterface.

Definition at line 113 of file RedisSessionBackend.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Core\Session\Backend\RedisSessionBackend\get(), TYPO3\CMS\Core\Session\Backend\RedisSessionBackend\remove(), TYPO3\CMS\Core\Session\Backend\RedisSessionBackend\set(), and TYPO3\CMS\Core\Session\Backend\RedisSessionBackend\update().

initialize()

TYPO3\CMS\Core\Session\Backend\RedisSessionBackend::initialize	(	string	$identifier,
		array	$configuration
	)

Initializes the session backend

Parameters

string

$identifier

‪Name of the session type, e.g. FE or BE

To be used only by SessionManager

Implements TYPO3\CMS\Core\Session\Backend\SessionBackendInterface.

Definition at line 69 of file RedisSessionBackend.php.

References TYPO3\CMS\Core\Session\Backend\RedisSessionBackend\$configuration, $GLOBALS, and TYPO3\CMS\Core\Session\Backend\RedisSessionBackend\$identifier.

initializeConnection()

TYPO3\CMS\Core\Session\Backend\RedisSessionBackend::initializeConnection ( )

protected

Initializes the redis backend

Exceptions

Definition at line 244 of file RedisSessionBackend.php.

Referenced by TYPO3\CMS\Core\Session\Backend\RedisSessionBackend\get(), TYPO3\CMS\Core\Session\Backend\RedisSessionBackend\getAll(), TYPO3\CMS\Core\Session\Backend\RedisSessionBackend\remove(), and TYPO3\CMS\Core\Session\Backend\RedisSessionBackend\set().

remove()

TYPO3\CMS\Core\Session\Backend\RedisSessionBackend::remove

(

string

$sessionId

)

Delete a session record

Implements TYPO3\CMS\Core\Session\Backend\SessionBackendInterface.

Definition at line 144 of file RedisSessionBackend.php.

References TYPO3\CMS\Core\Session\Backend\RedisSessionBackend\getSessionKeyName(), TYPO3\CMS\Core\Session\Backend\RedisSessionBackend\hash(), and TYPO3\CMS\Core\Session\Backend\RedisSessionBackend\initializeConnection().

set()

array TYPO3\CMS\Core\Session\Backend\RedisSessionBackend::set	(	string	$sessionId,
		array	$sessionData
	)

Write session data. This method prevents overriding existing session data. ses_id will always be set to $sessionId and overwritten if existing in $sessionData This method updates ses_tstamp automatically

Returns

‪array The newly created session record.

Exceptions

SessionNotCreatedException

Implements TYPO3\CMS\Core\Session\Backend\SessionBackendInterface.

Definition at line 164 of file RedisSessionBackend.php.

References $GLOBALS, TYPO3\CMS\Core\Session\Backend\RedisSessionBackend\getSessionKeyName(), TYPO3\CMS\Core\Session\Backend\RedisSessionBackend\hash(), and TYPO3\CMS\Core\Session\Backend\RedisSessionBackend\initializeConnection().

update()

array TYPO3\CMS\Core\Session\Backend\RedisSessionBackend::update	(	string	$sessionId,
		array	$sessionData
	)

Updates the session data. ses_id will always be set to $sessionId and overwritten if existing in $sessionData This method updates ses_tstamp automatically

Parameters

array

$sessionData

‪The session data to update. Data may be partial.

Returns

‪array $sessionData The newly updated session record.

Exceptions

SessionNotUpdatedException

Implements TYPO3\CMS\Core\Session\Backend\SessionBackendInterface.

Definition at line 196 of file RedisSessionBackend.php.

References $GLOBALS, TYPO3\CMS\Core\Session\Backend\RedisSessionBackend\getSessionKeyName(), and TYPO3\CMS\Core\Session\Backend\RedisSessionBackend\hash().

validateConfiguration()

TYPO3\CMS\Core\Session\Backend\RedisSessionBackend::validateConfiguration

(

)

Checks if the configuration is valid

Exceptions

Implements TYPO3\CMS\Core\Session\Backend\SessionBackendInterface.

Definition at line 86 of file RedisSessionBackend.php.

Member Data Documentation

$applicationIdentifier

string TYPO3\CMS\Core\Session\Backend\RedisSessionBackend::$applicationIdentifier = ''

protected

Used as instance independent identifier (e.g. if multiple installations write into the same database)

Definition at line 51 of file RedisSessionBackend.php.

$configuration

array TYPO3\CMS\Core\Session\Backend\RedisSessionBackend::$configuration = array( )

protected

Definition at line 38 of file RedisSessionBackend.php.

Referenced by TYPO3\CMS\Core\Session\Backend\RedisSessionBackend\initialize().

$connected

bool TYPO3\CMS\Core\Session\Backend\RedisSessionBackend::$connected = false

protected

Indicates whether the server is connected

Definition at line 44 of file RedisSessionBackend.php.

$identifier

string TYPO3\CMS\Core\Session\Backend\RedisSessionBackend::$identifier

protected

Definition at line 61 of file RedisSessionBackend.php.

Referenced by TYPO3\CMS\Core\Session\Backend\RedisSessionBackend\getSessionTimeout(), and TYPO3\CMS\Core\Session\Backend\RedisSessionBackend\initialize().

$redis

Redis TYPO3\CMS\Core\Session\Backend\RedisSessionBackend::$redis

protected

Instance of the PHP redis class

Definition at line 57 of file RedisSessionBackend.php.