Docs For Class SessionUtil

Class: SessionUtil

Class Details

[line 20]
SessionUtil

Class Methods

method delVar [line 340]

bool delVar(
string
$name, [string
$default = false], [path
$path = '/'])

Delete a session variable

Tags:

return:

true

Parameters:

string	$name	of the session variable to delete
string	$default	the default value to return if the requested session variable is not set
path	$path	to traverse to reach the element we wish to return (optional) (default='/')

[ Top ]

method expire [line 451]

void expire(
)

Let session expire nicely

[ Top ]

method getVar [line 258]

string getVar(
sring
$name, [string
$default = false], [
$path = '/'], [autocreate
$autocreate = true], [overwriteExistingVar
$overwriteExistingVar = false])

Get a session variable

Tags:

return:

session variable requested

Parameters:

sring	$name	of the session variable to get
string	$default	the default value to return if the requested session variable is not set
autocreate	$autocreate	whether or not to autocreate the supplied path (optional) (default=true)
overwriteExistingVar	$overwriteExistingVar	whether or not to overwrite existing/set variable entries which the given path requires to be arrays (optional) (default=false)
	$path

[ Top ]

method hasExpired [line 477]

bool hasExpired(
)

Check if a session has expired or not

[ Top ]

method initialize [line 113]

bool initialize(
)

Initialise session

[ Top ]

method random_regenerate [line 533]

void random_regenerate(
)

Regenerate session according to probability set by admin

[ Top ]

method regenerate [line 495]

void regenerate(
[bool
$force = false])

regerate session id

Parameters:

bool

$force

default false force regeneration

[ Top ]

method requireSession [line 427]

void requireSession(
)

Session required Starts a session or terminates loading.

[ Top ]

method setVar [line 293]

bool setVar(
string
$name, value
$value, [path
$path = '/'], [autocreate
$autocreate = true], [overwriteExistingVar
$overwriteExistingVar = false])

Set a session variable

Tags:

return:

true upon success, false upon failure

Parameters:

string	$name	of the session variable to set
value	$value	to set the named session variable
path	$path	to traverse to reach the element we wish to return (optional) (default='/')
autocreate	$autocreate	whether or not to autocreate the supplied path (optional) (default=true)
overwriteExistingVar	$overwriteExistingVar	whether or not to overwrite existing/set variable entries which the given path requires to be arrays (optional) (default=false)

[ Top ]

method _setup [line 28]

void _setup(
)

Set up session handling Set all PHP options for Zikula session handling

[ Top ]

Documentation generated on Fri, 18 Jul 2008 21:56:51 +0200 by phpDocumentor 1.4.1

Class: SessionUtil

Class Overview

Methods

Class Details

Class Methods

method delVar [line 340]

Tags:

Parameters:

method expire [line 451]

method getVar [line 258]

Tags:

Parameters:

method hasExpired [line 477]

method initialize [line 113]

method random_regenerate [line 533]

method regenerate [line 495]

Parameters:

method requireSession [line 427]

method setVar [line 293]

Tags:

Parameters:

method _setup [line 28]