Open Journal Systems  3.3.0
Session Class Reference
Inheritance diagram for Session:
DataObject

Public Member Functions

 getCSRFToken ()
 
 getDomain ()
 
 getIpAddress ()
 
 getRemember ()
 
 getSecondsCreated ()
 
 getSecondsLastUsed ()
 
 getSessionData ()
 
 getSessionVar ($key)
 
getUser ()
 
 getUserAgent ()
 
 getUserId ()
 
 setDomain ($data)
 
 setIpAddress ($ipAddress)
 
 setRemember ($remember)
 
 setSecondsCreated ($created)
 
 setSecondsLastUsed ($lastUsed)
 
 setSessionData ($data)
 
 setSessionVar ($key, $value)
 
 setUserAgent ($userAgent)
 
 setUserId ($userId)
 
 unsetSessionVar ($key)
 
- Public Member Functions inherited from DataObject
 __construct ()
 
 addSupportedMetadataAdapter ($metadataAdapter)
 
 extractMetadata ($metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
 getDAO ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
 getLocalizedData ($key, $preferredLocale=null)
 
 getMetadataFieldNames ($translated=true)
 
 getSetMetadataFieldNames ($translated=true)
 
 getSupportedExtractionAdapters ()
 
 getSupportedInjectionAdapters ()
 
 getSupportedMetadataSchemas ()
 
 hasData ($key, $locale=null)
 
 injectMetadata ($metadataDescription)
 
 removeSupportedMetadataAdapter ($metadataSchemaName)
 
 setAllData (&$data)
 
 setData ($key, $value, $locale=null)
 
 setHasLoadableAdapters ($hasLoadableAdapters)
 
 setId ($id)
 
 unsetData ($key, $locale=null)
 
 upcastTo ($targetObject)
 

Data Fields

 $user
 
- Data Fields inherited from DataObject
 $_data = array()
 
 $_extractionAdaptersLoaded = false
 
 $_hasLoadableAdapters = false
 
 $_injectionAdaptersLoaded = false
 
 $_metadataExtractionAdapters = array()
 
 $_metadataInjectionAdapters = array()
 

Detailed Description

Maintains user state information from one request to the next.

See also
SessionDAO

Definition at line 22 of file Session.inc.php.

Member Function Documentation

◆ getCSRFToken()

Session::getCSRFToken ( )

Get a usable CSRF token (generating if necessary).

Returns
string

Definition at line 213 of file Session.inc.php.

References getSessionVar(), Config\getVar(), and setSessionVar().

◆ getDomain()

Session::getDomain ( )

Get the domain with which the session is registered

Returns
array

Definition at line 189 of file Session.inc.php.

References DataObject\getData().

◆ getIpAddress()

Session::getIpAddress ( )

Get IP address.

Returns
string

Definition at line 93 of file Session.inc.php.

References DataObject\getData().

◆ getRemember()

Session::getRemember ( )

Check if session is to be saved across browser sessions.

Returns
boolean

Definition at line 157 of file Session.inc.php.

References DataObject\getData().

◆ getSecondsCreated()

Session::getSecondsCreated ( )

Get time (in seconds) since session was created.

Returns
int

Definition at line 125 of file Session.inc.php.

References DataObject\getData().

◆ getSecondsLastUsed()

Session::getSecondsLastUsed ( )

Get time (in seconds) since session was last used.

Returns
int

Definition at line 141 of file Session.inc.php.

References DataObject\getData().

◆ getSessionData()

Session::getSessionData ( )

Get all session parameters.

Returns
array

Definition at line 173 of file Session.inc.php.

References DataObject\getData().

◆ getSessionVar()

Session::getSessionVar (   $key)

Get a session variable's value.

Parameters
$keystring
Returns
mixed

Definition at line 33 of file Session.inc.php.

Referenced by getCSRFToken().

◆ getUser()

& Session::getUser ( )

Get user associated with this session (null if anonymous user).

Returns
User

Definition at line 205 of file Session.inc.php.

References $user.

◆ getUserAgent()

Session::getUserAgent ( )

Get user agent.

Returns
string

Definition at line 109 of file Session.inc.php.

References DataObject\getData().

◆ getUserId()

Session::getUserId ( )

Get user ID (0 if anonymous user).

Returns
int

Definition at line 66 of file Session.inc.php.

References DataObject\getData().

◆ setDomain()

Session::setDomain (   $data)

Set the domain with which the session is registered

Parameters
$dataarray

Definition at line 197 of file Session.inc.php.

References DataObject\setData().

◆ setIpAddress()

Session::setIpAddress (   $ipAddress)

Set IP address.

Parameters
$ipAddressstring

Definition at line 101 of file Session.inc.php.

References DataObject\setData().

◆ setRemember()

Session::setRemember (   $remember)

Set whether session is to be saved across browser sessions.

Parameters
$rememberboolean

Definition at line 165 of file Session.inc.php.

References DataObject\setData().

◆ setSecondsCreated()

Session::setSecondsCreated (   $created)

Set time (in seconds) since session was created.

Parameters
$createdint

Definition at line 133 of file Session.inc.php.

References DataObject\setData().

◆ setSecondsLastUsed()

Session::setSecondsLastUsed (   $lastUsed)

Set time (in seconds) since session was last used.

Parameters
$lastUsedint

Definition at line 149 of file Session.inc.php.

References DataObject\setData().

◆ setSessionData()

Session::setSessionData (   $data)

Set session parameters.

Parameters
$dataarray

Definition at line 181 of file Session.inc.php.

References DataObject\setData().

◆ setSessionVar()

Session::setSessionVar (   $key,
  $value 
)

Get a session variable's value.

Parameters
$keystring
$valuemixed
Returns
mixed

Definition at line 43 of file Session.inc.php.

Referenced by getCSRFToken().

◆ setUserAgent()

Session::setUserAgent (   $userAgent)

Set user agent.

Parameters
$userAgentstring

Definition at line 117 of file Session.inc.php.

References DataObject\setData().

◆ setUserId()

Session::setUserId (   $userId)

Set user ID.

Parameters
$userIdint

Definition at line 74 of file Session.inc.php.

References DAORegistry\getDAO(), DataObject\getData(), and DataObject\setData().

◆ unsetSessionVar()

Session::unsetSessionVar (   $key)

Unset (delete) a session variable.

Parameters
$keystring

Definition at line 52 of file Session.inc.php.

Field Documentation

◆ $user

Session::$user

The User object associated with this session

Definition at line 25 of file Session.inc.php.

Referenced by getUser().


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