LimeSurvey API - Master branch

LSUserIdentity extends CUserIdentity
in package

For 2.06 most of the functionality in this class will be moved to the LSWebUser class.

To not delay release of 2.05 this class was kept the way it is now.

@@TODO Move to LSWebUser and change documentation / workflow for authentication plugins

Table of Contents

Constants

ERROR_IP_LOCKED_OUT  = 98
ERROR_UNKNOWN_HANDLER  = 99

Properties

$id  : int
The userid
$plugin  : string
This is the name of the plugin to handle authentication default handler is used for remote control
$user  : User
A User::model() object
$config  : mixed

Methods

authenticate()  : mixed
getConfig()  : mixed
getId()  : int
Returns the current user's ID
getUser()  : User
Returns the active user's record
setConfig()  : mixed
setPlugin()  : mixed
postLogin()  : mixed

Constants

Properties

$plugin

This is the name of the plugin to handle authentication default handler is used for remote control

public string $plugin = 'Authdb'

Methods

getId()

Returns the current user's ID

public getId() : int
Tags
access

public

Return values
int

getUser()

Returns the active user's record

public getUser() : User
Tags
access

public

Return values
User

setConfig()

public setConfig(mixed $config) : mixed
Parameters
$config : mixed

setPlugin()

public setPlugin(mixed $name) : mixed
Parameters
$name : mixed

        
On this page

Search results