Class Core_LiveSession

Description
  • abstract:

Located in /packages/core/lib/livesession.inc.php (line 2)


	
			
Variable Summary
integer $Expires
string $Hash
integer $ID
integer $Persistent
string $RemoteHost
User $User
integer $UserID
Method Summary
ArchonLiveSession __construct ()
boolean destroy ()
timestamp getExpiration ()
void getLanguageID ()
string getRemoteHost ()
mixed getRemoteVariable (string $Name)
integer getUserID ()
boolean setRemoteVariable (string $Name, string $Value, [ $SetCookie = false])
boolean unsetAllRemoteVariables ([ $UnsetCookie = false], string $Name)
boolean unsetRemoteVariable (string $Name, [ $UnsetCookie = false])
boolean verify ()
Variables
integer $Expires = 0 (line 319)

Expiration time (timestamp)

  • access: public
string $Hash = NULL (line 298)

Hash

  • access: public
integer $ID = 0 (line 291)

Session ID

  • access: public
integer $Persistent = 0 (line 326)

Persistent Session

  • access: public
string $RemoteHost = NULL (line 312)

Remote Host for session

  • access: public
User $User = NULL (line 331)
  • access: public
integer $UserID = 0 (line 305)

User ID

  • access: public
Methods
Constructor __construct (line 9)

ArchonLiveSession Constructor

  • access: public
ArchonLiveSession __construct ()
destroy (line 121)

Destorys live session

  • access: public
boolean destroy ()
getExpiration (line 41)

Return time of expiration of live session

  • access: public
timestamp getExpiration ()
getLanguageID (line 53)

Returns language id according to preference of current Archon user and the default language in the configuration.

  • access: public
void getLanguageID ()
getRemoteHost (line 94)

Returns Remote Host location

  • access: public
string getRemoteHost ()
getRemoteVariable (line 81)

Returns a remote variable according to Name

  • access: public
mixed getRemoteVariable (string $Name)
  • string $Name
getUserID (line 107)

Returns User ID

  • access: public
integer getUserID ()
setRemoteVariable (line 152)

Sets a remote variable to Value

  • access: public
boolean setRemoteVariable (string $Name, string $Value, [ $SetCookie = false])
  • string $Name
  • string $Value
  • $SetCookie
unsetAllRemoteVariables (line 207)

Unsets all remote variables used to customize user interface

  • access: public
boolean unsetAllRemoteVariables ([ $UnsetCookie = false], string $Name)
  • string $Name
  • $UnsetCookie
unsetRemoteVariable (line 180)

Unsets a remote variable

  • access: public
boolean unsetRemoteVariable (string $Name, [ $UnsetCookie = false])
  • string $Name
  • $UnsetCookie
verify (line 227)

Verifies live session

  • access: public
boolean verify ()

Documentation generated on Wed, 05 Mar 2008 16:46:46 -0600 by phpDocumentor 1.3.1