Class Horde_SessionHandler_Storage

This is the abstract class that all storage drivers inherit from.

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Direct known subclasses

Horde_SessionHandler_Storage_Builtin, Horde_SessionHandler_Storage_External, Horde_SessionHandler_Storage_File, Horde_SessionHandler_Storage_Memcache, Horde_SessionHandler_Storage_Sql, Horde_SessionHandler_Storage_Stack

Abstract
Package: SessionHandler
Category: Horde
License: LGPL 2.1
Author: Michael Slusarz slusarz@horde.org
Located at Horde/SessionHandler/Storage.php

Methods summary
`public`	# `__construct( array $params = array() )` Constructor. Constructor. Parameters `$params` Configuration parameters.
`public`	# `setLogger( Horde_Log_Logger $log )` Set the logger object. Set the logger object. Parameters `$log` The logger instance.
`abstract public`	# `open( string $save_path = null, string $session_name = null )` Open the backend. Open the backend. Parameters `$save_path` The path to the session object. `$session_name` The name of the session. Throws `Horde_SessionHandler_Exception`
`abstract public`	# `close( )` Close the backend. Close the backend. Throws `Horde_SessionHandler_Exception`
`abstract public string`	# `read( string $id )` Read the data for a particular session identifier from the backend. Read the data for a particular session identifier from the backend. Parameters `$id` The session identifier. Returns `string` The session data.
`abstract public boolean`	# `write( string $id, string $session_data )` Write session data to the backend. Write session data to the backend. Parameters `$id` The session identifier. `$session_data` The session data. Returns `boolean` True on success, false otherwise.
`abstract public boolean`	# `destroy( string $id )` Destroy the data for a particular session identifier in the backend. This method should only be called internally by PHP via session_set_save_handler(). Destroy the data for a particular session identifier in the backend. This method should only be called internally by PHP via session_set_save_handler(). Parameters `$id` The session identifier. Returns `boolean` True on success, false otherwise.
`abstract public boolean`	# `gc( integer $maxlifetime = 300 )` Garbage collect stale sessions from the backend. This method should only be called internally by PHP via session_set_save_handler(). Garbage collect stale sessions from the backend. This method should only be called internally by PHP via session_set_save_handler(). Parameters `$maxlifetime` The maximum age of a session. Returns `boolean` True on success, false otherwise.
`abstract public array`	# `getSessionIDs( )` Get a list of the valid session identifiers. Get a list of the valid session identifiers. Returns `array` A list of valid session identifiers. Throws `Horde_SessionHandler_Exception`

Properties summary
`public boolean`	`$readonly` Access session read-only? Access session read-only?	# `false`

Packages

Classes

Class Horde_SessionHandler_Storage

Direct known subclasses

Parameters

Parameters

Parameters

Throws

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Throws