Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

Developer Network License

The Joomla! Developer Network content is © copyright 2006 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5

Class JSessionStorageDatabase

Description
Description | Methods (details)

Database session storage handler for PHP

Located in /joomla/environment/sessionstorage/database.php (line 27) 

Class JObject   (Subpackage Base)

Abstract class JSessionStorage
   
   Class JSessionStorageDatabase   (Subpackage Environment)
Method Summary
Description | Methods (details)
Method boolean close ()
Method boolean destroy (string $id)
Method boolean gc (integer $maxlifetime)
Method boolean open (string $save_path, string $session_name)
Method string read (string $id)
Method boolean write (string $id, string $session_data)
Methods
Description | Methods (details)
close (line 48)

Close the SessionHandler backend.

  • return: True on success, false otherwise.
  • access: public
boolean close ()
Redefinition of:
JSessionStorage::close()
Close the SessionHandler backend.
destroy (line 94)

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

  • return: True on success, false otherwise.
  • access: public
boolean destroy (string $id)
  • string $id: The session identifier.
Redefinition of:
JSessionStorage::destroy()
Destroy the data for a particular session identifier in the SessionHandler backend.
gc (line 108)

Garbage collect stale sessions from the SessionHandler backend.

  • return: True on success, false otherwise.
  • access: public
boolean gc (integer $maxlifetime)
  • integer $maxlifetime: The maximum age of a session.
Redefinition of:
JSessionStorage::gc()
Garbage collect stale sessions from the SessionHandler backend.
open (line 37)

Open the SessionHandler backend.

  • return: True on success, false otherwise.
  • access: public
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.
Redefinition of:
JSessionStorage::open()
Open the SessionHandler backend.
read (line 61)

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

  • return: The session data.
  • access: public
string read (string $id)
  • string $id: The session identifier.
Redefinition of:
JSessionStorage::read()
Read the data for a particular session identifier from the SessionHandler backend.
write (line 76)

Write session data to the SessionHandler backend.

  • return: True on success, false otherwise.
  • access: public
boolean write (string $id, string $session_data)
  • string $id: The session identifier.
  • string $session_data: The session data.
Redefinition of:
JSessionStorage::write()
Write session data to the SessionHandler backend.

Inherited Methods

Inherited From JSessionStorage

JSessionStorage::__construct()
JSessionStorage::close()
JSessionStorage::destroy()
JSessionStorage::gc()
JSessionStorage::getInstance()
JSessionStorage::open()
JSessionStorage::read()
JSessionStorage::register()
JSessionStorage::test()
JSessionStorage::write()

Inherited From JObject

JObject::JObject()
JObject::__construct()
JObject::get()
JObject::getPublicProperties()
JObject::set()
JObject::toString()
Documentation generated on Mon, 05 Mar 2007 20:56:10 +0000 by phpDocumentor 1.3.1