[ Index ]

PHP Cross Reference of Joomla 1.5.26 DE

title

Body

[close]

/libraries/joomla/session/ -> storage.php (summary)

(no description)

Copyright: Copyright (C) 2005 - 2010 Open Source Matters. All rights reserved.
License: GNU/GPL, see LICENSE.php
Version: $Id:sessionstorage.php 6961 2007-03-15 16:06:53Z tcp $
File Size: 190 lines (4 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

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


Class: JSessionStorage  - X-Ref

Custom session storage handler for PHP

__construct( $options = array()   X-Ref
Constructor

param: array $options optional parameters

getInstance($name = 'none', $options = array()   X-Ref
Returns a reference to a session storage handler object, only creating it
if it doesn't already exist.

param: name     $name The session store to instantiate
return: database A JSessionStorage object

register( $options = array()   X-Ref
Register the functions of this class with PHP's session handler

param: array $options optional parameters

open($save_path, $session_name)   X-Ref
Open the SessionHandler backend.

param: string $save_path     The path to the session object.
param: string $session_name  The name of the session.
return: boolean  True on success, false otherwise.

close()   X-Ref
Close the SessionHandler backend.

return: boolean  True on success, false otherwise.

read($id)   X-Ref
Read the data for a particular session identifier from the
SessionHandler backend.

param: string $id  The session identifier.
return: string  The session data.

write($id, $session_data)   X-Ref
Write session data to the SessionHandler backend.

param: string $id            The session identifier.
param: string $session_data  The session data.
return: boolean  True on success, false otherwise.

destroy($id)   X-Ref
Destroy the data for a particular session identifier in the
SessionHandler backend.

param: string $id  The session identifier.
return: boolean  True on success, false otherwise.

gc($maxlifetime)   X-Ref
Garbage collect stale sessions from the SessionHandler backend.

param: integer $maxlifetime  The maximum age of a session.
return: boolean  True on success, false otherwise.

test()   X-Ref
Test to see if the SessionHandler is available.

return: boolean  True on success, false otherwise.



Generated: Wed Mar 28 15:54:07 2012 Cross-referenced by PHPXref 0.7.1