Public Member Functions | Protected Attributes

SessionContext Class Reference

Public Member Functions

 __construct ()
 setVar ($varName, $value)
 mergeVar ($varName, $value)
 getVar ($varName)
 clearVar ($varName)
 varExists ($varName)
 getNamespace ()
 setObjVar ($objName, $varName, &$value, $stateful=false)
 cleanObj ($objName, $stateful=false)
 getObjVar ($objName, $varName, &$value, $stateful=false)
 saveSessionObjects ()
 retrieveSessionObjects ()
 clearSessionObjects ($keepObjects=false)
 saveJSONArray ($jsonValue, $jsonName=NULL)
 getViewHistory ($formName)
 setViewHistory ($formName, $historyInfo)
 destroy ()
 isUserValid ()
 isTimeout ()

Protected Attributes

 $_lastAccessTime
 $_timeOut = false
 $_sessObjArr = null
 $_statefulSessObjArr = null
 $_viewHistory = null
 $_prevViewObjNames = array()

Detailed Description

Definition at line 34 of file SessionContext.php.


Constructor & Destructor Documentation

__construct (  )

Constructor of SessionContext, init session and set session file path

Returns:
void

Definition at line 48 of file SessionContext.php.


Member Function Documentation

cleanObj ( objName,
stateful = false 
)

Clean Object

Parameters:
string$objNameobject name
boolean$stateful
Returns:
void

Definition at line 193 of file SessionContext.php.

clearSessionObjects ( keepObjects = false )

Clear session variables of all stateful objects

Parameters:
boolean$keepObjects
Returns:
void

Definition at line 294 of file SessionContext.php.

clearVar ( varName )

Clear/Unset single session variable NOTE: NYU - not yet used

Parameters:
string$varName
Returns:
void

Definition at line 139 of file SessionContext.php.

destroy (  )

Destroy/free all session data of the current session

Returns:
void

Definition at line 373 of file SessionContext.php.

getObjVar ( objName,
varName,
&$  value,
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)
boolean$stateful- is stateful?
Returns:
void

Definition at line 213 of file SessionContext.php.

getVar ( varName )

Get single session variable

Parameters:
string$varNamename of session variable
Returns:
string

Definition at line 125 of file SessionContext.php.

Here is the caller graph for this function:

getViewHistory ( formName )

Get view history data of given BizForm/EasyForm from saved in session file

Parameters:
string$formName- name of BizForm/EasyForm
Returns:
array - view history data represented by an associated array

Definition at line 344 of file SessionContext.php.

Here is the call graph for this function:

isTimeout (  )

Check if current session is timeout

Returns:
boolean

Definition at line 403 of file SessionContext.php.

isUserValid (  )

Check if user logged in or not NOTE: NYU - not yet used

Returns:
boolean

Definition at line 388 of file SessionContext.php.

Here is the call graph for this function:

retrieveSessionObjects (  )

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

Returns:
void

Definition at line 272 of file SessionContext.php.

Here is the call graph for this function:

saveJSONArray ( jsonValue,
jsonName = NULL 
)

Save a JSON array in session

Parameters:
string$jsonValue
string$jsonName
Returns:
void

Definition at line 321 of file SessionContext.php.

Here is the call graph for this function:

saveSessionObjects (  )

Save session variables of all stateful objects into sessionid_obj file

Returns:
void

Definition at line 239 of file SessionContext.php.

Here is the call graph for this function:

setObjVar ( objName,
varName,
&$  value,
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)
boolean$stateful- is stateful?
Returns:
void

Definition at line 175 of file SessionContext.php.

setVar ( varName,
value 
)

Set single session variable

Parameters:
string$varName
mixed$value
Returns:
void

Definition at line 102 of file SessionContext.php.

Here is the caller graph for this function:

setViewHistory ( formName,
historyInfo 
)

Set view history data of given bizform into session file

Parameters:
string$formName- name of bizform
array$historyInfo- view history data represented by an associated array
Returns:
void

Definition at line 358 of file SessionContext.php.

Here is the call graph for this function:

varExists ( varName )

Is variable exist in the session

Parameters:
string$varNamevariable name that checked
Returns:
boolean TRUE if the var exists in the session, otherwise FALSE

Definition at line 150 of file SessionContext.php.


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