LimeSurvey API - Master branch

LSWebUser extends CWebUser
in package

Tags
inheritdoc

Table of Contents

Properties

$sessionVariable  : mixed

Methods

__construct()  : mixed
checkAccess()  : mixed
getFlashes()  : mixed
Replace default system to return only one flash …
getId()  : mixed
getState()  : mixed
getStateKeyPrefix()  : mixed
hasFlash()  : mixed
hasState()  : mixed
isInUserGroup()  : bool
Test if a user is in a group
isScriptUpdateAllowed()  : bool
Check if user is allowed to edit script
isXssFiltered()  : bool
Check if user have xss allowed
logout()  : mixed
removeState()  : mixed
Removes a state variable.
setFlash()  : mixed
setId()  : mixed
setState()  : mixed

Properties

$sessionVariable

protected mixed $sessionVariable = 'LSWebUser'

Methods

checkAccess()

public checkAccess(mixed $operation[, mixed $params = array() ][, mixed $allowCaching = true ]) : mixed
Parameters
$operation : mixed
$params : mixed = array()
$allowCaching : mixed = true
Tags
inheritdoc

getFlashes()

Replace default system to return only one flash …

public getFlashes([mixed $delete = true ]) : mixed
Parameters
$delete : mixed = true

getId()

public getId() : mixed
Tags
inheritDoc

Replace auto getter to check if current user is valid or not

getState()

public getState(mixed $key[, mixed $defaultValue = null ]) : mixed
Parameters
$key : mixed
$defaultValue : mixed = null
Tags
inheritdoc

replace session variable

getStateKeyPrefix()

public getStateKeyPrefix() : mixed
Tags
inheritdoc

replace by a fixed string

hasFlash()

public hasFlash(mixed $key) : mixed
Parameters
$key : mixed
Tags
inheritdoc

hasState()

public hasState(mixed $key) : mixed
Parameters
$key : mixed

isInUserGroup()

Test if a user is in a group

public isInUserGroup(int $gid) : bool
Parameters
$gid : int
Return values
bool

isScriptUpdateAllowed()

Check if user is allowed to edit script

public isScriptUpdateAllowed() : bool
Return values
bool

isXssFiltered()

Check if user have xss allowed

public isXssFiltered() : bool
Return values
bool

logout()

public logout([mixed $destroySession = true ]) : mixed
Parameters
$destroySession : mixed = true
Tags
inheritDoc

Add the specific plugin event and regenerate CSRF

removeState()

Removes a state variable.

public removeState(string $key) : mixed
Parameters
$key : string

setFlash()

public setFlash(mixed $key, mixed $value[, mixed $defaultValue = null ]) : mixed
Parameters
$key : mixed
$value : mixed
$defaultValue : mixed = null
Tags
inheritdoc

setId()

public setId(mixed $id) : mixed
Parameters
$id : mixed
Tags
inheritDoc

Set id in session too

setState()

public setState(mixed $key, mixed $value[, mixed $defaultValue = null ]) : mixed
Parameters
$key : mixed
$value : mixed
$defaultValue : mixed = null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results