Axiom (v1.2.0)

A lightweight PHP framework
axSession Class Reference

Session Class. More...

Public Member Functions

 __construct ($name)
 __get ($key)
 Get a session reference.
 __set ($key, $value)
 Set any session reference.

Static Public Member Functions

static start ()
 Start the session.
static destroy ()
 Destroy the session.
static id ($id=false)
 Get or set the session id.
static name ($name=false)
 Get or set the session name.
static started ()
 Tell if session is started.
static renew ()
 Renew the session (equivalent to start > destroy > start)

Protected Attributes

 $_session_parameters
 axSession values

Detailed Description

Session Class.

Note:
By default any instance of this class will point to the same $_SESSION structure for practical purposes.
Author:
Delespierre
License:
http://www.gnu.org/licenses/lgpl.html Lesser General Public Licence version 3

Definition at line 18 of file axSession.class.php.


Constructor & Destructor Documentation

Construct a new session handler instance

Definition at line 29 of file axSession.class.php.


Member Function Documentation

axSession::__get ( key)

Get a session reference.

Parameters:
string$key
Returns:
mixed

Definition at line 42 of file axSession.class.php.

axSession::__set ( key,
value 
)

Set any session reference.

Parameters:
string$key
mixed$value
Returns:
void

Definition at line 52 of file axSession.class.php.

static axSession::destroy ( ) [static]

Destroy the session.

Returns:
boolean

Definition at line 72 of file axSession.class.php.

static axSession::id ( id = false) [static]

Get or set the session id.

Parameters:
string$id[optional] [default false]
Returns:
string

Definition at line 82 of file axSession.class.php.

static axSession::name ( name = false) [static]

Get or set the session name.

Parameters:
string$name[optional] [default false]
Returns:
string

Definition at line 92 of file axSession.class.php.

static axSession::renew ( ) [static]

Renew the session (equivalent to start > destroy > start)

Returns:
boolean

Definition at line 110 of file axSession.class.php.

static axSession::start ( ) [static]

Start the session.

Returns:
boolean

Definition at line 61 of file axSession.class.php.

static axSession::started ( ) [static]

Tell if session is started.

Returns:
boolean

Definition at line 101 of file axSession.class.php.


Field Documentation

array axSession::$_session_parameters [protected]

axSession values

Definition at line 24 of file axSession.class.php.


The documentation for this class was generated from the following file:
 All Data Structures Files Functions Variables