Exponent v2.4.3
Back to top  

expSession

This is the class expSession

package

Subsystems
subpackage

Subsystems

Methods

Clears entire user session data and truncates the sessionticket table

clearAllSessionData()
static

exdoc Clears global users session cache

clearAllUsersSessionCache(mixed $modules = null, \User $user = null)
static
node

Subsystems:Sessions

Arguments

$modules

mixed

If not set, applies to all modules. If set, will only clear cache for that module

$user

\User

if not set,applies to all users. If set, will only clear for that user

exdoc Creates user ticket in sessionticket table and session

createTicket(\user/object $user = null) : null
static
node

Subsystems:Sessions

Arguments

$user

\user/object

The user object of the newly logged-in user. Uses id of 0 if not supplied.

Response

null

deleteVar

deleteVar( $var)
static

Arguments

$var

exists

exists( $var)
static

Arguments

$var

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.

get(string $var) : mixed
static

Note that some session variables (like the user object and the ticket) cannot be changed using this call (for security / sanity reason)

node

Subsystems:Sessions

Arguments

$var

string

The name of the variable to retrieve.

Response

mixed

getCacheValue

getCacheValue( $module)
static

Arguments

$module

getTableCache

getTableCache( $tablename)
static

Arguments

$tablename

getTicketString

getTicketString()
static

exdoc Runs necessary code to initialize sessions for use.

initialize()
static

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.

node

Subsystems:Sessions

exdoc Checks to see if the session holds a set variable of the given name.

is_set( $var) : boolean
static

Note that some session variables (like the user object and the ticket) cannot be changed using this call (for security / sanity reason)

node

Subsystems:Sessions

Arguments

$var

Response

boolean

issetTableCache

issetTableCache( $tablename)
static

Arguments

$tablename

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

loggedIn() : boolean
static
node

Subsystems:Sessions

Response

boolean

exdoc Clears the session of all user data, used when a user logs out.

logout()
static

This gets rid of stale session tickets, and resets the session to a blank state.

node

Subsystems:Sessions

Sets a variable in the session data, for use on subsequent page calls.

set(string $var, mixed $val)
static

Note that some session variables (like the user object and the ticket) cannot be changed using this call (for security / sanity reason)

node

Subsystems:Sessions

Arguments

$var

string

The name of the variable, for later reference

$val

mixed

The value to store

setCache

setCache( $params = array())
static

Arguments

$params

setCacheValue

setCacheValue( $module,  $val)
static

Arguments

$module

$val

setTableCache

setTableCache( $tablename,  $desc)
static

Arguments

$tablename

$desc

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.

triggerRefresh()
static
node

Subsystems:expPermissions

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.

triggerSingleRefresh(\user/object $user)
static
node

Subsystems:expPermissions

Arguments

$user

\user/object

exdoc Removes a variable from the session.

un_set(string $var)
static

Note that some session variables (like the user object and the ticket) cannot be changed using this call (for security / sanity reason)

node

Subsystems:Sessions

Arguments

$var

string

The name of the variable to unset.

exdoc Creates user ticket in sessionticket table and session

updateTicket( $ticket,  $user) : mixed
static
node

Subsystems:Sessions

Arguments

$ticket

$user

Response

mixed

exdoc Validates the stored session ticket against the database. This is used to force refreshes and force logouts. It also updates activity time.

validate()
static
node

Subsystems:Sessions