• About
• License
• Philosophy

• How It Works
• How To Add A Simple Page
• How To Add A Guestbook

• Object Loading Mechanism
• File and Directory Structure
• Constants, Variables, Functions
• Standard Module Interfaces

• Mapper
• Site
• DB
• Session
• Security
• Tpl

Session module interface

Description

The purpose of this module is to provide session handling support.

If you write portable and interacting modules you should use this interface, because it is common that DB session mechanisms are used in websites and libraries and so on.

Configuration

These are elements of the $config['Session'] array:

• object - a loadable object name.

Interface

Standard methods:

• start() - Starts session (should be used by the object loader, so you should not worry about it).
• close() - Closes session (should be used by the object unloader, so you should not worry about it)
• setVar($name, $value = NULL) - Sets session variable value.
• getVar($name) - Returns session variable value.
• registerVar($name, &$var) - Creates a session variable that references a given variable.
• unsetVar($name) - Destroys variable in session.
• unsetAllVars() - Destroys all session variables.
• clearVars() - An alias of clearVars() DEPRECATED.
• getAndUnsetVar($name) - Returns session variable value and destroys it afterwards.

$Revision: 1.1 $, $Date: 2005/11/22 07:09:49 $