Docs For Class JSessionStorageDatabase

Description

Database session storage handler for PHP

see: http://www.php.net/manual/en/function.session-set-save-handler.php
since: 11.1

Located in /libraries/joomla/session/storage/database.php (line 20)

JSessionStorage
   |
   --JSessionStorageDatabase

Method Summary

boolean destroy (string $id)

boolean gc ([integer $lifetime = 1440])

string read (string $id)

boolean write (string $id, string $data)

Variables

Inherited Variables

Inherited from JSessionStorage

JSessionStorage::$instances

Methods

destroy (line 110)

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

return: True on success, false otherwise.
since: 11.1
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 141)

Garbage collect stale sessions from the SessionHandler backend.

return: True on success, false otherwise.
since: 11.1
access: public

boolean gc ([integer $lifetime = 1440])

integer $lifetime: The maximum age of a session.

Redefinition of:

JSessionStorage::gc(): Garbage collect stale sessions from the SessionHandler backend.

read (line 31)

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

return: The session data.
since: 11.1
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 68)

Write session data to the SessionHandler backend.

return: True on success, false otherwise.
since: 11.1
access: public

boolean write (string $id, string $data)

string $id: The session identifier.
string $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::isSupported()
JSessionStorage::open()
JSessionStorage::read()
JSessionStorage::register()
JSessionStorage::test()
JSessionStorage::write()