Interface SessionHandlerInterface

SessionHandlerInterface for PHP < 5.4.

The order in which these methods are invoked by PHP are: 1. open [session_start] 2. read 3. gc [optional depending on probability settings: gc_probability / gc_divisor] 4. destroy [optional when session_regenerate_id(true) is used] 5. write [session_write_close] or destroy [session_destroy] 6. close

Extensive documentation can be found at php.net, see links:

Direct known implementers

Author: Drak drak@zikula.org
Author: Tobias Schultze http://tobion.de
See: http://php.net/sessionhandlerinterface
See: http://php.net/session.customhandler
See: http://php.net/session-set-save-handler
Located at Resources/stubs/SessionHandlerInterface.php

Methods summary
`public boolean`	# `open( string $savePath, string $sessionName )` Re-initializes existing session, or creates a new one. Re-initializes existing session, or creates a new one. Parameters `$savePath` Save path `$sessionName` Session name, see http://php.net/function.session-name.php Returns boolean true on success, false on failure See http://php.net/sessionhandlerinterface.open
`public boolean`	# `close( )` Closes the current session. Closes the current session. Returns boolean true on success, false on failure See http://php.net/sessionhandlerinterface.close
`public string`	# `read( string $sessionId )` Reads the session data. Reads the session data. Parameters `$sessionId` Session ID, see http://php.net/function.session-id Returns string Same session data as passed in write() or empty string when non-existent or on failure See http://php.net/sessionhandlerinterface.read
`public boolean`	# `write( string $sessionId, string $data )` Writes the session data to the storage. Writes the session data to the storage. Care, the session ID passed to write() can be different from the one previously received in read() when the session ID changed due to session_regenerate_id(). Parameters `$sessionId` Session ID , see http://php.net/function.session-id `$data` Serialized session data to save Returns boolean true on success, false on failure See http://php.net/sessionhandlerinterface.write
`public boolean`	# `destroy( string $sessionId )` Destroys a session. Destroys a session. Parameters `$sessionId` Session ID, see http://php.net/function.session-id Returns boolean true on success, false on failure See http://php.net/sessionhandlerinterface.destroy
`public boolean`	# `gc( string\|integer $maxlifetime )` Cleans up expired sessions (garbage collection). Cleans up expired sessions (garbage collection). Parameters `$maxlifetime` Sessions that have not updated for the last maxlifetime seconds will be removed Returns boolean true on success, false on failure See http://php.net/sessionhandlerinterface.gc

Namespaces

Classes

Interfaces

Functions

Interface SessionHandlerInterface

Direct known implementers

Parameters

Returns

See

Returns

See

Parameters

Returns

See

Parameters

Returns

See

Parameters

Returns

See

Parameters

Returns

See