expSession
in package
This is the class expSession
Tags
Table of Contents
- clearAllSessionData() : mixed
- Clears entire user session data and truncates the sessionticket table
- clearAllUsersSessionCache() : mixed
- exdoc Clears global users session cache
- createTicket() : null
- exdoc Creates user ticket in sessionticket table and session
- deleteVar() : mixed
- exists() : mixed
- get() : mixed
- exdoc This retrieves the value of a persistent session variable. Returns null if the variable is not set in the session, or the value of the stored variable.
- getCacheValue() : mixed
- getTableCache() : mixed
- getTicketString() : mixed
- initialize() : mixed
- exdoc Runs necessary code to initialize sessions for use.
- is_set() : bool
- exdoc Checks to see if the session holds a set variable of the given name.
- issetTableCache() : mixed
- loggedIn() : bool
- exdoc Looks at the session data to see if the current session is that of a logged in user. Returns true if the viewer is logged in, and false if it is not
- login() : mixed
- exdoc Creates and stores a session ticket for the given user, so that sessions can be tracked and permissions can be refreshed as needed.
- logout() : mixed
- exdoc Clears the session of all user data, used when a user logs out.
- set() : mixed
- Sets a variable in the session data, for use on subsequent page calls.
- setCache() : mixed
- setCacheValue() : mixed
- setTableCache() : mixed
- triggerRefresh() : mixed
- exdoc This call will force all active session to reload their permission data. This is useful if permissions are assigned or revoked, and is required to see these changes.
- triggerSingleRefresh() : mixed
- exdoc This call will force all active sessions for the given user to reload their permission data. This is useful if permissions are assigned or revoked, and is required to see these changes.
- un_set() : mixed
- exdoc Removes a variable from the session.
- updateTicket() : mixed
- exdoc Creates user ticket in sessionticket table and session
- validate() : mixed
- exdoc Validates the stored session ticket against the database. This is used to force refreshes and force logouts. It also updates activity time.
Methods
clearAllSessionData()
Clears entire user session data and truncates the sessionticket table
public
static clearAllSessionData() : mixed
Return values
mixed —clearAllUsersSessionCache()
exdoc Clears global users session cache
public
static clearAllUsersSessionCache([mixed $modules = null ][, User $user = null ]) : mixed
Parameters
- $modules : mixed = null
-
If not set, applies to all modules. If set, will only clear cache for that module
- $user : User = null
-
if not set,applies to all users. If set, will only clear for that user
Tags
Return values
mixed —createTicket()
exdoc Creates user ticket in sessionticket table and session
public
static createTicket([mixed $user = null ]) : null
Parameters
- $user : mixed = null
Tags
Return values
null —deleteVar()
public
static deleteVar(mixed $var) : mixed
Parameters
- $var : mixed
Return values
mixed —exists()
public
static exists(mixed $var) : mixed
Parameters
- $var : mixed
Return values
mixed —get()
exdoc This retrieves the value of a persistent session variable. Returns null if the variable is not set in the session, or the value of the stored variable.
public
static get(string $var) : mixed
Note that some session variables (like the user object and the ticket) cannot be changed using this call (for security / sanity reason)
Parameters
- $var : string
-
The name of the variable to retrieve.
Tags
Return values
mixed —getCacheValue()
public
static getCacheValue(mixed $module) : mixed
Parameters
- $module : mixed
Return values
mixed —getTableCache()
public
static getTableCache(mixed $tablename) : mixed
Parameters
- $tablename : mixed
Return values
mixed —getTicketString()
public
static getTicketString() : mixed
Return values
mixed —initialize()
exdoc Runs necessary code to initialize sessions for use.
public
static initialize() : mixed
This sends the session cookie header (via the session_start PHP function) and sets up session variables needed by the rest of the system and this subsystem.
Tags
Return values
mixed —is_set()
exdoc Checks to see if the session holds a set variable of the given name.
public
static is_set( $var) : bool
Note that some session variables (like the user object and the ticket) cannot be changed using this call (for security / sanity reason)
Parameters
Tags
Return values
bool —issetTableCache()
public
static issetTableCache(mixed $tablename) : mixed
Parameters
- $tablename : mixed
Return values
mixed —loggedIn()
exdoc Looks at the session data to see if the current session is that of a logged in user. Returns true if the viewer is logged in, and false if it is not
public
static loggedIn() : bool
Tags
Return values
bool —login()
exdoc Creates and stores a session ticket for the given user, so that sessions can be tracked and permissions can be refreshed as needed.
public
static login(User $user) : mixed
Parameters
- $user : User
-
The user object of the newly logged-in user.
Tags
Return values
mixed —logout()
exdoc Clears the session of all user data, used when a user logs out.
public
static logout() : mixed
This gets rid of stale session tickets, and resets the session to a blank state.
Tags
Return values
mixed —set()
Sets a variable in the session data, for use on subsequent page calls.
public
static set(string $var, mixed $val) : mixed
Note that some session variables (like the user object and the ticket) cannot be changed using this call (for security / sanity reason)
Parameters
- $var : string
-
The name of the variable, for later reference
- $val : mixed
-
The value to store
Tags
Return values
mixed —setCache()
public
static setCache([mixed $params = array() ]) : mixed
Parameters
- $params : mixed = array()
Return values
mixed —setCacheValue()
public
static setCacheValue(mixed $module, mixed $val) : mixed
Parameters
- $module : mixed
- $val : mixed
Return values
mixed —setTableCache()
public
static setTableCache(mixed $tablename, mixed $desc) : mixed
Parameters
- $tablename : mixed
- $desc : mixed
Return values
mixed —triggerRefresh()
exdoc This call will force all active session to reload their permission data. This is useful if permissions are assigned or revoked, and is required to see these changes.
public
static triggerRefresh() : mixed
Tags
Return values
mixed —triggerSingleRefresh()
exdoc This call will force all active sessions for the given user to reload their permission data. This is useful if permissions are assigned or revoked, and is required to see these changes.
public
static triggerSingleRefresh(mixed $user) : mixed
Parameters
- $user : mixed
Tags
Return values
mixed —un_set()
exdoc Removes a variable from the session.
public
static un_set(string $var) : mixed
Note that some session variables (like the user object and the ticket) cannot be changed using this call (for security / sanity reason)
Parameters
- $var : string
-
The name of the variable to unset.
Tags
Return values
mixed —updateTicket()
exdoc Creates user ticket in sessionticket table and session
public
static updateTicket( $ticket, $user) : mixed
Parameters
Tags
Return values
mixed —validate()
exdoc Validates the stored session ticket against the database. This is used to force refreshes and force logouts. It also updates activity time.
public
static validate() : mixed