Class: SessionContext

Source Location: /SessionContext.php

Class SessionContext

Class Overview

SessionContext class is Session management class that has additional methods to save/get session variables of metadata based stateful objects through their GetSessionVars|SetSessionVars interfaces

Located in /SessionContext.php [line 34]

Author(s):

rocky swen

API Tags:

Access:

public

Information Tags:

Copyright:

Properties

Methods

[ Top ]

Property Summary

mixed	$_lastAccessTime
mixed	$_prevViewObjNames
mixed	$_sessObjArr
mixed	$_sessObjFileName
mixed	$_statefulSessObjArr
mixed	$_timeOut
mixed	$_viewHistory

[ Top ]

Method Summary

void	__construct()	Constructor of SessionContext, init session and set session file path
void	CleanObj()	Clean Obbject
void	ClearSessionObjects()	Clear session variables of all stateful objects
void	ClearVar()	Clear/Unset single session variable
void	Destroy()	Destroy/free all session data of the current session
void	GetObjVar()	Get single session variable of a stateful object
string	GetVar()	Get single session variable
array	GetViewHistory()	Get view history data of given bizform from saved in session file
boolean	IsTimeout()	SessionContext::IsTimeout - check if current session is timeout
boolean	IsUserValid()	Check if user logged in or not
void	RetrieveSessionObjects()	Retrieve/Get session variables of all stateful objects from sessionid_obj file
void	SaveJSONArray()	Save a JSON array in session
void	SaveSessionObjects()	Save session variables of all stateful objects into sessionid_obj file
void	SetObjVar()	Set single session variable of a stateful object
void	SetVar()	Set single session variable
void	SetViewHistory()	Set view history data of given bizform into session file
boolean	VarExists()	Is variable exist in the session

[ Top ]

Properties

mixed $_lastAccessTime [line 36]

API Tags:

Access:

protected

[ Top ]

mixed $_prevViewObjNames = array() [line 42]

API Tags:

Access:

protected

[ Top ]

mixed $_sessObjArr = null [line 38]

API Tags:

Access:

protected

[ Top ]

mixed $_sessObjFileName = null [line 40]

API Tags:

Access:

protected

[ Top ]

mixed $_statefulSessObjArr = null [line 39]

API Tags:

Access:

protected

[ Top ]

mixed $_timeOut = false [line 37]

API Tags:

Access:

protected

[ Top ]

mixed $_viewHistory = null [line 41]

API Tags:

Access:

protected

[ Top ]

Methods

Constructor __construct [line 49]

void __construct(
)

Constructor of SessionContext, init session and set session file path

[ Top ]

CleanObj [line 150]

void CleanObj(
string
$objName, [boolean
$stateful = false] 
)

Clean Obbject

Parameters:

string	$objName:	object name
boolean	$stateful:

API Tags:

Access:

public

[ Top ]

ClearSessionObjects [line 247]

void ClearSessionObjects(
[mixed
$keepObjects = false] 
)

Clear session variables of all stateful objects

API Tags:

Access:

public

[ Top ]

ClearVar [line 113]

void ClearVar(
string
$varName 
)

Clear/Unset single session variable

Parameters:

string

$varName:

API Tags:

Access:

public

[ Top ]

Destroy [line 327]

void Destroy(
)

Destroy/free all session data of the current session

API Tags:

Access:

public

[ Top ]

GetObjVar [line 166]

void GetObjVar(
string
$objName, string
$varName, mixed
&$value, [mixed
$stateful = false] 
)

Get single session variable of a stateful object

Parameters:

string	$objName:	- object name
string	$varName:	- vaiable name
mixed	$value:	- reference of the value (in/out)

API Tags:

Access:

public

[ Top ]

GetVar [line 100]

string GetVar(
string
$varName 
)

Get single session variable

Parameters:

string

$varName:

API Tags:

Access:

public

[ Top ]

GetViewHistory [line 296]

array GetViewHistory(
string
$formName 
)

Get view history data of given bizform from saved in session file

Parameters:

string

$formName:

- name of bizform

API Tags:

Return:	- view history data represented by an associated array
Access:	public

[ Top ]

IsTimeout [line 355]

boolean IsTimeout(
)

SessionContext::IsTimeout - check if current session is timeout

API Tags:

Access:

public

[ Top ]

IsUserValid [line 340]

boolean IsUserValid(
)

Check if user logged in or not

API Tags:

Access:

public

[ Top ]

RetrieveSessionObjects [line 224]

void RetrieveSessionObjects(
)

Retrieve/Get session variables of all stateful objects from sessionid_obj file

API Tags:

Access:

public

[ Top ]

SaveJSONArray [line 273]

void SaveJSONArray(
string
$jsonValue, [string
$jsonName = NULL] 
)

Save a JSON array in session

Parameters:

string	$jsonValue:
string	$jsonName:

API Tags:

Access:

public

[ Top ]

SaveSessionObjects [line 189]

void SaveSessionObjects(
)

Save session variables of all stateful objects into sessionid_obj file

API Tags:

Access:

public

[ Top ]

SetObjVar [line 137]

void SetObjVar(
string
$objName, string
$varName, mixed
&$value, [mixed
$stateful = false] 
)

Set single session variable of a stateful object

Parameters:

string	$objName:	- object name
string	$varName:	- vaiable name
mixed	$value:	- reference of the value (in/out)

API Tags:

Access:

public

[ Top ]

SetVar [line 89]

void SetVar(
string
$varName, mixed
$value 
)

Set single session variable

Parameters:

string	$varName:
mixed	$value:

API Tags:

Access:

public

[ Top ]

SetViewHistory [line 311]

void SetViewHistory(
string
$formName, array
$histInfo 
)

Set view history data of given bizform into session file

Parameters:

string	$formName:	- name of bizform
array	$histInfo:	- view history data represented by an associated array

API Tags:

Access:

public

[ Top ]

VarExists [line 123]

boolean VarExists(
string
$varName 
)

Is variable exist in the session

Parameters:

string

$varName:

variable name that checked

API Tags:

Return:	TRUE if the var exists in the session, otherwise FALSE
Access:	public

[ Top ]

Documentation generated on Tue, 22 Dec 2009 03:03:20 -0800 by phpDocumentor 1.3.0RC3

	openbiz.bin

[ class tree: openbiz.bin ] [ index: openbiz.bin ] [ all elements ]