session_abstract Class Reference

Inheritance diagram for session_abstract:

Public Member Functions
	getNameSpace ()
	setNameSpace ($nameSpace)
	get ($prm)
	getAll ()
	set (array $prm)
	check ($prm)
	del ($prm)
	clear ($nameSpace=true)
	__get ($name)
	__set ($name, $val)
	__isset ($name)
	__unset ($name)
	getAttr ($name)
	setAttr ($name, $value)
	getCfg ()

Protected Member Functions
	setNameSpaceInArray (array $prm)
	beforeInit ()
	afterInit ()

Protected Attributes
	$cfg

Detailed Description

Use this interface to implements a session

Definition at line 10 of file session/abstract.class.php.

Member Function Documentation

__get()

__get

(

$name

)

Get a session variable, with a convenient way $session->name

Parameters

string

$name

The variable name

Returns

mixed The variable or null if it doesn't exists

See also

get

Definition at line 102 of file session/abstract.class.php.

__isset()

__isset

(

$name

)

Check if a session variable is set, with a convenient way isset($session->name)

Parameters

string

$name

variable name to check

Returns

bool

See also

check

Definition at line 124 of file session/abstract.class.php.

__set()

__set	(		$name,
			$val
	)

Set a variable, with a convenient way $session->name = $value

Parameters

string	$name	The variable name
mixed	$val	The variable value

See also

set

Definition at line 113 of file session/abstract.class.php.

__unset()

__unset

(

$name

)

Delete a variable, with a convenient way unset($session->name)

Parameters

string

$name

Variable name to delete

See also

del

Definition at line 134 of file session/abstract.class.php.

afterInit()

afterInit ( )

protectedinherited

Call just after the configuration initialisation

Definition at line 40 of file object.class.php.

beforeInit()

beforeInit ( )

protectedinherited

Call just before the configuration initialisation

Definition at line 35 of file object.class.php.

check()

check (   $prm )

abstract

check if a variable is set

Parameters

string | array

$prm

Array parameter: string name: variable name string nameSpace: variable name space

Returns

bool

clear()

clear (   $nameSpace = true )

abstract

Clear all the session variables and start a new session

Parameters

string | true | null

$nameSpace

If string will clear only the name space, if true will clear the current name space

del()

del (   $prm )

abstract

Delete a session variable

Parameters

string | array

$prm

Array parameter: string name: variable name string nameSpace: variable name space

get()

get (   $prm )

abstract

Get a session variable

Parameters

string | array

$prm

Array parameter: string name: variable name string nameSpace: variable name space bool serialize: If true, the variable will be unserialize

Returns

mixed The variable or null if it doesn't exists

getAll()

getAll ( )

abstract

Get all session variables

Returns

array

getAttr()

getAttr (   $name )

inherited

Get an attribute

Parameters

string

$name

Attribute name

Returns

mixed|null The attribute or null if not set

Definition at line 48 of file object.class.php.

getCfg()

getCfg ( )

inherited

Get the configuration object

Returns

config

Definition at line 67 of file object.class.php.

getNameSpace()

getNameSpace

(

)

Get the current name space

Returns

string

Definition at line 17 of file session/abstract.class.php.

set()

set ( array  $prm )

abstract

Set a session variable

Parameters

array

$prm

Array parameter: string name: variable name mixed val: variable value string nameSpace: variable name space bool serialize: If true, the variable will be unserialize

setAttr()

setAttr (   $name,   $value  )

inherited

Set an attribute

Parameters

string	$name	Attribute name
mixed	$value	Attribute value

Definition at line 58 of file object.class.php.

setNameSpace()

setNameSpace

(

$nameSpace

)

Set the name space to use

Parameters

string

$nameSpace

Definition at line 26 of file session/abstract.class.php.

setNameSpaceInArray()

setNameSpaceInArray ( array  $prm )

protected

Set the name space if set in the array

Parameters

array

$prm

Definition at line 35 of file session/abstract.class.php.

Field Documentation

$cfg

$cfg	protectedinherited

Definition at line 17 of file object.class.php.

---

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

• session/abstract.class.php