AnewtSession Class Reference

The session class provides several static methods for session handling. More...

List of all members.

Static Public Member Functions

Methods to start and destroy sessions
These methods will setup and teardown user sessions.

static init ($name, $timeout=null)
 Initialize the session with the given name.
static destroy ()
 Destroy the current session.
Methods for handling session data
These methods can be used to get and set session data.

static set ($name, $value)
 Store a variable in the session.
static get ($name)
 Obtain a value from the session.
static delete ($name)
 Deletes a variable from the session.
static is_set ($name)
 Checks if a variable is defined in the session.


Detailed Description

The session class provides several static methods for session handling.

Definition at line 18 of file session.lib.php.


Member Function Documentation

static AnewtSession::init ( name,
timeout = null 
) [static]

Initialize the session with the given name.

Parameters:
$name The name this session should have.
$timeout The timeout value for this session.

Definition at line 32 of file session.lib.php.

static AnewtSession::set ( name,
value 
) [static]

Store a variable in the session.

Parameters:
$name The variable name.
$value The value of the variable.

Definition at line 80 of file session.lib.php.

static AnewtSession::get ( name  )  [static]

Obtain a value from the session.

If no value was set for the provided name, an error is thrown.

Parameters:
$name The variable name.
Returns:
The value of the variable.

Definition at line 96 of file session.lib.php.

static AnewtSession::delete ( name  )  [static]

Deletes a variable from the session.

If no value was set for the provided name, an error is thrown.

Parameters:
$name The name of the variable to delete.
Returns:
The value of deleted variable.

Definition at line 115 of file session.lib.php.

static AnewtSession::is_set ( name  )  [static]

Checks if a variable is defined in the session.

Parameters:
$name The variable name to check for.
Returns:
True if the variable is available, false otherwise.

Definition at line 134 of file session.lib.php.


The documentation for this class was generated from the following file:

Generated on Sun Aug 2 22:54:38 2009 for Anewt by  doxygen 1.5.9