Docs for class JSessionStorage

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

License

Content on this site is copyright © 2005 - 2008 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5. Some parts of this website may be subject to other licenses.

JSessionStorage

Description

Custom session storage handler for PHP

see: http://www.php.net/manual/en/function.session-set-save-handler.php
since: 1.5
author: Johan Janssens <johan.janssens@joomla.org>
abstract:

Located in /joomla/session/storage.php (line 28)

 JObject   (Subpackage Base)

 JSessionStorage   (Subpackage Session)

Direct descendents

Class	Description
JSessionStorageApc	APC session storage handler for PHP
JSessionStorageDatabase	Database session storage handler for PHP
JSessionStorageEaccelerator	eAccelerator session storage handler for PHP
JSessionStorageMemcache	Memcache session storage handler for PHP
JSessionStorageNone	File session handler for PHP
JSessionStorageXcache	XCache session storage handler

Method Summary

static boolean test ()

JSessionStorage __construct ([array $options = array()])

boolean close ()

boolean destroy (string $id)

boolean gc (integer $maxlifetime)

database &getInstance ([name $name = 'none'], [ $options = array()])

boolean open (string $save_path, string $session_name)

string read (string $id)

void register ([array $options = array()])

boolean write (string $id, string $session_data)

Variables

Inherited Variables

Inherited from JObject

JObject::$_errors

Methods

Constructor __construct (line 36)

Constructor

access: protected

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
JSessionStorageMemcache::__construct() : Constructor
JSessionStorageXcache::__construct() : Constructor

close (line 119)

Close the SessionHandler backend.

return: True on success, false otherwise.
access: public
abstract:

boolean close ()

Redefined in descendants as:

JSessionStorageApc::close() : Close the SessionHandler backend.
JSessionStorageDatabase::close() : Close the SessionHandler backend.
JSessionStorageEaccelerator::close() : Close the SessionHandler backend.
JSessionStorageMemcache::close() : Close the SessionHandler backend.
JSessionStorageXcache::close() : Close the SessionHandler backend.

destroy (line 161)

Destroy the data for a particular session identifier in the SessionHandler backend.

return: True on success, false otherwise.
access: public
abstract:

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.
JSessionStorageDatabase::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.
JSessionStorageMemcache::destroy() : Destroy the data for a particular session identifier in the SessionHandler backend.
JSessionStorageXcache::destroy() : Destroy the data for a particular session identifier in the SessionHandler backend.

gc (line 174)

Garbage collect stale sessions from the SessionHandler backend.

return: True on success, false otherwise.
access: public
abstract:

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.
JSessionStorageDatabase::gc() : Garbage collect stale sessions from the SessionHandler backend.
JSessionStorageEaccelerator::gc() : Garbage collect stale sessions from the SessionHandler backend.
JSessionStorageMemcache::gc() : Garbage collect stale sessions from the SessionHandler backend.
JSessionStorageXcache::gc() : Garbage collect stale sessions from the SessionHandler backend.

getInstance (line 50)

Returns a reference to a session storage handler object, only creating it if it doesn't already exist.

return: A JSessionStorage object
since: 1.5
access: public

database &getInstance ([name $name = 'none'], [ $options = array()])

name $name: The session store to instantiate
$options

open (line 107)

Open the SessionHandler backend.

return: True on success, false otherwise.
access: public
abstract:

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.
JSessionStorageDatabase::open() : Open the SessionHandler backend.
JSessionStorageEaccelerator::open() : Open the SessionHandler backend.
JSessionStorageMemcache::open() : Open the SessionHandler backend.
JSessionStorageXcache::open() : Open the SessionHandler backend.

read (line 133)

Read the data for a particular session identifier from the SessionHandler backend.

return: The session data.
access: public
abstract:

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.
JSessionStorageDatabase::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.
JSessionStorageMemcache::read() : Read the data for a particular session identifier from the SessionHandler backend.
JSessionStorageXcache::read() : Read the data for a particular session identifier from the SessionHandler backend.

access: public

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 (line 187)

Test to see if the SessionHandler is available.

return: True on success, false otherwise.
access: public
abstract:

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.
JSessionStorageMemcache::test() : Test to see if the SessionHandler is available.
JSessionStorageXcache::test() : Test to see if the SessionHandler is available.

write (line 147)

Write session data to the SessionHandler backend.

return: True on success, false otherwise.
access: public
abstract:

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.
JSessionStorageDatabase::write() : Write session data to the SessionHandler backend.
JSessionStorageEaccelerator::write() : Write session data to the SessionHandler backend.
JSessionStorageMemcache::write() : Write session data to the SessionHandler backend.
JSessionStorageXcache::write() : Write session data to the SessionHandler backend.

Inherited Methods

Inherited From JObject

JObject::JObject()
JObject::__construct()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::getPublicProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::toString()

Documentation generated on Tue, 29 Jan 2008 18:51:35 +0000 by phpDocumentor 1.3.1

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

Other documents

License

JSessionStorage

Inherited Variables

Inherited Methods