Class CMS_context

Description
Description | Methods (details) Constants

Class CMS_context

Keeps track of dialog context

Located in /automne/classes/dialogs/context.php (line 27) 

CMS_grandFather
   |
   --CMS_context
Method Summary
Description | Constants Methods (details)
static boolean autoLoginSucceeded ()
static boolean checkToken ( $name,  $token, string $name,, string $token,)
static boolean expireToken ( $name, string $name,)
static string getAutoLoginCookieName ()
static string getContextHash ([ $datas = array()], array $datas,)
static string getJSLocales ()
static array getSessionInfos ()
static void getSessionVar (string $name)
static string getToken ( $name, string $name,)
static void resetSessionCookies ()
static void setCookie ( $name, [ $value = false], [ $expire = false], string $name,, string $value,, int $expire,)
static void setSessionVar (string $name, mixed $value)
static boolean tokenIsExpired ( $name, string $name,)
void __construct ([string $login = ''], [string $password = ''], [ $permanent_cookie = 0], [ $token = null], boolean $permanent_cookie,)
void __call ( $name,  $arguments)
Methods
Description | Constants Methods (details)
static autoLoginSucceeded (line 105)

Test auto login through cookie

  • return: true if autologin succeeded
  • access: public
static boolean autoLoginSucceeded ()
static checkToken (line 175)

Check a session token value for a given token name

  • return: : true if token is valid or false otherwise
  • access: public
static boolean checkToken ( $name,  $token, string $name,, string $token,)
  • string $name,: token name to check
  • string $token,: token value to check
  • $name
  • $token
static expireToken (line 186)

Force a token expiration

  • access: public
static boolean expireToken ( $name, string $name,)
  • string $name,: token name to expire
  • $name
static getAutoLoginCookieName (line 131)

Get autologin cookie name

  • return: : the autologin cookie name
  • access: public
static string getAutoLoginCookieName ()
static getContextHash (line 209)

Get current context hash (usually used for cache)

  • return: : the current context cache
  • access: public
static string getContextHash ([ $datas = array()], array $datas,)
  • array $datas,: additionnal datas to use for cache
  • $datas
static getJSLocales (line 152)

Get all JS locales for current user (in current language)

  • return: : JS locales
  • access: public
static string getJSLocales ()
static getSessionInfos (line 142)

Get current session infos

  • return: : the user session infos
  • access: public
static array getSessionInfos ()
static getSessionVar (line 94)

Gets session variable with name

  • access: public
static void getSessionVar (string $name)
  • string $name
static getToken (line 163)

Get a unique session token value for given token name

  • return: : Token value
  • access: public
static string getToken ( $name, string $name,)
  • string $name,: token name to get value
  • $name
static resetSessionCookies (line 70)

Reset current session ID and cookies

  • access: public
static void resetSessionCookies ()
static setCookie (line 120)

Sets a cookie given at least its name If value is empty, deletes cookie

  • access: public
static void setCookie ( $name, [ $value = false], [ $expire = false], string $name,, string $value,, int $expire,)
  • string $name,: cookie name
  • string $value,: the value to store
  • int $expire,: represents time in which cookie will expire if not set, expires at the end of the session
  • $name
  • $value
  • $expire
static setSessionVar (line 83)

Sets session variable

  • access: public
static void setSessionVar (string $name, mixed $value)
  • string $name
  • mixed $value
static tokenIsExpired (line 197)

Check if a session token is expired for a given token name

  • return: : true if token is expired or false otherwise
  • access: public
static boolean tokenIsExpired ( $name, string $name,)
  • string $name,: token name to check
  • $name
Constructor __construct (line 40)

Constructor.

Initializes the user with given login/pass. Raises error if not found.

  • access: public
void __construct ([string $login = ''], [string $password = ''], [ $permanent_cookie = 0], [ $token = null], boolean $permanent_cookie,)
  • string $login: The user login
  • string $password: The user password
  • boolean $permanent_cookie,: set to true if we want to allow permanent connexion for user (autologin)
  • $permanent_cookie
  • $token
__call (line 55)
void __call ( $name,  $arguments)
  • $name
  • $arguments
Redefinition of:
CMS_grandFather::__call()
Unknown method handler

Inherited Methods

Inherited From CMS_grandFather

CMS_grandFather::autoload()
CMS_grandFather::hasError()
CMS_grandFather::log()
CMS_grandFather::PHPErrorHandler()
CMS_grandFather::raiseError()
CMS_grandFather::setDebug()
CMS_grandFather::setLog()
CMS_grandFather::_raiseError()
CMS_grandFather::__call()
Class Constants
Description | Constants (details) | Methods (details)

Inherited Constants

Inherited from CMS_grandFather

CMS_grandFather::ERROR_LOG
 CMS_grandFather::SYSTEM_LABEL

Documentation generated on Wed, 15 Feb 2012 15:29:43 +0100 by phpDocumentor 1.4.3