[ Index ]

PHP Cross Reference of vtigercrm-6.1.0

title

Body

[close]

/libraries/HTTP_Session/Session/ -> Container.php (summary)

Container class for storing session data PHP version 4

Author: Alexander Radivanovich <[email protected]>
Author: David Costa <[email protected]>
Author: Michael Metz <[email protected]>
Author: Stefan Neufeind <[email protected]>
Author: Torsten Roehr <[email protected]>
Copyright: 1997-2005 The PHP Group
License: http://www.php.net/license/3_0.txt PHP License 3.0
Version: CVS: $Id: Container.php,v 1.8 2007/07/14 12:11:54 troehr Exp $
File Size: 280 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

HTTP_Session_Container:: (18 methods):
  HTTP_Session_Container()
  _setDefaults()
  _parseOptions()
  open()
  close()
  read()
  write()
  destroy()
  replicate()
  gc()
  set()
  __destruct()
  HTTP_Session_Open()
  HTTP_Session_Close()
  HTTP_Session_Read()
  HTTP_Session_Write()
  HTTP_Session_Destroy()
  HTTP_Session_GC()


Class: HTTP_Session_Container  - X-Ref

Container class for storing session data

HTTP_Session_Container($options = null)   X-Ref
Constrtuctor method

param: array $options Additional options for the container object
return: object

_setDefaults()   X-Ref
Set some default options

return: void

_parseOptions($options)   X-Ref
Parse options passed to the container class

param: array $options Options
return: void

open($save_path, $session_name)   X-Ref
This function is called by the session handler to initialize things

param: string $save_path    Save path
param: string $session_name Session name
return: bool

close()   X-Ref
This function is called when the page is finished
executing and the session handler needs to close things off

Has to be overwritten by each container class

return: bool

read($id)   X-Ref
This function is called by the session handler
to read the data associated with a given session ID.
This function must retrieve and return the session data
for the session identified by $id.

Has to be overwritten by each container class

param: string $id ID of the session
return: string

write($id, $data)   X-Ref
This function is called when the session handler
has session data to save, which usually happens
at the end of your script

Has to be overwritten by each container class

param: string $id   ID of the session
param: mixed  $data The data associated with a given session ID
return: bool

destroy($id)   X-Ref
This function is called when a session is destroyed.
It is responsible for deleting the session and cleaning things up.

Has to be overwritten by each container class

param: string $id ID of the session
return: bool

replicate($targetTable, $id = null)   X-Ref
This function copies session data of specified id to specified table

Has to be overwritten by each container class

param: string $targetTable Table to replicate data to
param: string $id          ID of the session
return: bool

gc($maxlifetime)   X-Ref
This function is responsible for garbage collection.
In the case of session handling, it is responsible
for deleting old, stale sessions that are hanging around.
The session handler will call this every now and then.

Has to be overwritten by each container class

param: integer $maxlifetime Maximum lifetime
return: bool

set()   X-Ref
Set session save handler

return: void

__destruct()   X-Ref
Destructor for compatibility with PHP >= 5.0.5

return: void

HTTP_Session_Open($save_path, $session_name)   X-Ref
No description

HTTP_Session_Close()   X-Ref
No description

HTTP_Session_Read($id)   X-Ref
No description

HTTP_Session_Write($id, $data)   X-Ref
No description

HTTP_Session_Destroy($id)   X-Ref
No description

HTTP_Session_GC($maxlifetime)   X-Ref
No description



Generated: Fri Nov 28 20:08:37 2014 Cross-referenced by PHPXref 0.7.1