LimeSurvey API - Master branch

Authdb extends AuthPluginBase
in package

Table of Contents

Constants

ERROR_ALREADY_EXISTING_USER  = 120
ERROR_AUTH_METHOD_INVALID  = 30
ERROR_INVALID_EMAIL  = 110
ERROR_IP_LOCKED_OUT  = 98
ERROR_LDAP_CONNECTION  = 130
ERROR_LDAP_MODE  = 135
ERROR_LDAP_NO_BIND  = 160
ERROR_LDAP_NO_EMAIL  = 140
ERROR_LDAP_NO_FULLNAME  = 150
ERROR_LDAP_NO_SEARCH_RESULT  = 170
ERROR_NONE  = 0
These constants reflect the error codes to be used by the identity, they are copied from LSUserIdentity and CBaseUserIdentity for easier access.
ERROR_NOT_ADDED  = 5
ERROR_PASSWORD_INVALID  = 20
ERROR_UNKNOWN_HANDLER  = 99
ERROR_UNKNOWN_IDENTITY  = 100
ERROR_USERNAME_INVALID  = 10
LDAP_INVALID_PASSWORD_TEXT  = "INVALID_PASSWORD-LDAP_USER"

Properties

$allowedPublicMethods  : mixed
$_onepass  : mixed
$_password  : mixed
$_username  : mixed
$description  : mixed
$name  : mixed
$storage  : mixed

Methods

afterLoginFormSubmit()  : null
Set username and password by post request
beforeDeactivate()  : mixed
beforeLogin()  : mixed
createNewUser()  : void
Create a DB user
getAuthMethodName()  : mixed
init()  : mixed
listExportOptions()  : mixed
listExportPlugins()  : mixed
Registers this export type
newExport()  : mixed
Returns the required IWriter
newLoginForm()  : mixed
newUserSession()  : mixed
remoteControlLogin()  : null
Set username and password by event
setAuthFailure()  : AuthPluginBase
Set authentication result to failure.
setAuthPlugin()  : AuthPluginBase
Set this plugin to handle the authentication
setAuthSuccess()  : AuthPluginBase
Set authentication result to success for the given user object.
getOnePass()  : string|null
Get the onetime password (if set)
getPassword()  : string|null
Get the password (if set)
getUserName()  : string|null
Get the username (if set)
setOnePass()  : Authdb
Set the onetime password
setPassword()  : AuthPluginBase
Set the password to use for authentication
setUsername()  : AuthPluginBase
Set the username to use for authentication

Constants

ERROR_ALREADY_EXISTING_USER

public mixed ERROR_ALREADY_EXISTING_USER = 120

ERROR_AUTH_METHOD_INVALID

public mixed ERROR_AUTH_METHOD_INVALID = 30

ERROR_LDAP_NO_FULLNAME

public mixed ERROR_LDAP_NO_FULLNAME = 150

ERROR_LDAP_NO_SEARCH_RESULT

public mixed ERROR_LDAP_NO_SEARCH_RESULT = 170

ERROR_NONE

These constants reflect the error codes to be used by the identity, they are copied from LSUserIdentity and CBaseUserIdentity for easier access.

public mixed ERROR_NONE = 0

ERROR_UNKNOWN_IDENTITY

public mixed ERROR_UNKNOWN_IDENTITY = 100

LDAP_INVALID_PASSWORD_TEXT

public mixed LDAP_INVALID_PASSWORD_TEXT = "INVALID_PASSWORD-LDAP_USER"

Properties

$allowedPublicMethods

public mixed $allowedPublicMethods = array()
Tags
inheritdoc

This plugin doesn't have any public methods

$_onepass

protected mixed $_onepass = \null

$description

protected static mixed $description = 'Core: Database authentication + exports'

$name

protected static mixed $name = 'LimeSurvey internal database'

$storage

protected mixed $storage = 'DbStorage'

Methods

afterLoginFormSubmit()

Set username and password by post request

public afterLoginFormSubmit() : null
Return values
null

beforeDeactivate()

public beforeDeactivate() : mixed

beforeLogin()

public beforeLogin() : mixed

createNewUser()

Create a DB user

public createNewUser() : void

getAuthMethodName()

public static getAuthMethodName() : mixed
Tags
inheritdoc

listExportOptions()

public listExportOptions() : mixed

listExportPlugins()

Registers this export type

public listExportPlugins() : mixed

newExport()

Returns the required IWriter

public newExport() : mixed

newLoginForm()

public newLoginForm() : mixed

newUserSession()

public newUserSession() : mixed

remoteControlLogin()

Set username and password by event

public remoteControlLogin() : null
Return values
null

setAuthFailure()

Set authentication result to failure.

public setAuthFailure([int $code = self::ERROR_UNKNOWN_IDENTITY ][, string $message = '' ][, PluginEvent $event = null ]) : AuthPluginBase
Parameters
$code : int = self::ERROR_UNKNOWN_IDENTITY

Any of the constants defined in this class

$message : string = ''

An optional message to return about the failure

$event : PluginEvent = null
Return values
AuthPluginBase

getOnePass()

Get the onetime password (if set)

protected getOnePass() : string|null
Return values
string|null

getPassword()

Get the password (if set)

protected getPassword() : string|null
Return values
string|null

getUserName()

Get the username (if set)

protected getUserName() : string|null
Return values
string|null

setOnePass()

Set the onetime password

protected setOnePass(string $onepass) : Authdb
Parameters
$onepass : string
Return values
Authdb

        
On this page

Search results