JSessionStorage
Description
Custom session storage handler for PHP
Located in /joomla/environment/sessionstorage.php (line 28)
JObject (Subpackage Base)
JSessionStorage (Subpackage Environment)
Direct descendents
| Class | Description |
|---|---|
|
JSessionStorageNone
|
File session handler for PHP |
|
JSessionStorageApc
|
APC session storage handler for PHP |
|
JSessionStorageEaccelerator
|
eAccelerator session storage handler for PHP |
|
JSessionStorageDatabase
|
Database session storage handler for PHP |
Method Summary
static 
Methods
Constructor
JSessionStorage
__construct
([array $options = array()])
- array $options: optional parameters
Redefinition of:
- JObject::__construct()
- Class constructor, overridden in descendant classes.
Redefined in descendants as:
- JSessionStorageApc::__construct() : Constructor
- JSessionStorageEaccelerator::__construct() : Constructor
Close the SessionHandler backend.
boolean
close
()
Redefined in descendants as:
- JSessionStorageApc::close() : Close the SessionHandler backend.
- JSessionStorageEaccelerator::close() : Close the SessionHandler backend.
- JSessionStorageDatabase::close() : Close the SessionHandler backend.
Destroy the data for a particular session identifier in the SessionHandler backend.
boolean
destroy
(string $id)
- string $id: The session identifier.
Redefined in descendants as:
- JSessionStorageApc::destroy() : Destroy the data for a particular session identifier in the SessionHandler backend.
- JSessionStorageEaccelerator::destroy() : Destroy the data for a particular session identifier in the SessionHandler backend.
- JSessionStorageDatabase::destroy() : Destroy the data for a particular session identifier in the SessionHandler backend.
Garbage collect stale sessions from the SessionHandler backend.
boolean
gc
(integer $maxlifetime)
- integer $maxlifetime: The maximum age of a session.
Redefined in descendants as:
- JSessionStorageApc::gc() : Garbage collect stale sessions from the SessionHandler backend.
- JSessionStorageEaccelerator::gc() : Garbage collect stale sessions from the SessionHandler backend.
- JSessionStorageDatabase::gc() : Garbage collect stale sessions from the SessionHandler backend.
Returns a reference to a session storage handler object, only creating it if it doesn't already exist.
database
&getInstance
([name $name = 'none'], [ $options = array()])
- name $name: The session store to instantiate
- $options
Open the SessionHandler backend.
boolean
open
(string $save_path, string $session_name)
- string $save_path: The path to the session object.
- string $session_name: The name of the session.
Redefined in descendants as:
- JSessionStorageApc::open() : Open the SessionHandler backend.
- JSessionStorageEaccelerator::open() : Open the SessionHandler backend.
- JSessionStorageDatabase::open() : Open the SessionHandler backend.
Read the data for a particular session identifier from the SessionHandler backend.
string
read
(string $id)
- string $id: The session identifier.
Redefined in descendants as:
- JSessionStorageApc::read() : Read the data for a particular session identifier from the SessionHandler backend.
- JSessionStorageEaccelerator::read() : Read the data for a particular session identifier from the SessionHandler backend.
- JSessionStorageDatabase::read() : Read the data for a particular session identifier from the SessionHandler backend.
Register the functions of this class with PHP's session handler
void
register
([array $options = array()])
- array $options: optional parameters
Redefined in descendants as:
- JSessionStorageNone::register() : Register the functions of this class with PHP's session handler
Test to see if the SessionHandler is available.
boolean
test
()
Redefined in descendants as:
- JSessionStorageApc::test() : Test to see if the SessionHandler is available.
- JSessionStorageEaccelerator::test() : Test to see if the SessionHandler is available.
Write session data to the SessionHandler backend.
boolean
write
(string $id, string $session_data)
- string $id: The session identifier.
- string $session_data: The session data.
Redefined in descendants as:
- JSessionStorageApc::write() : Write session data to the SessionHandler backend.
- JSessionStorageEaccelerator::write() : Write session data to the SessionHandler backend.
- JSessionStorageDatabase::write() : Write session data to the SessionHandler backend.
Inherited Methods
Inherited From JObject
JObject::JObject()
JObject::get()
Documentation generated on Mon, 05 Mar 2007 21:21:42 +0000 by phpDocumentor 1.3.1