LimeSurvey API - Master branch
Back to top  

User

Extends\LSActiveRecord

Class User

package

Default

Methods

attributeLabels

attributeLabels()

Lists the behaviors of this model

behaviors(): array
inherited

Below is a list of all behaviors we register:

see \PluginEventBehavior\CTimestampBehavior

Response

array

Returns true if logged in user with id $loginId can edit this user

canEdit(integer $loginId): boolean

Arguments

$loginId

integer

Response

boolean

Check if password is OK for current \User

checkPassword(string $sPassword): boolean

Arguments

$sPassword

string

The clear password

Response

boolean

checkPasswordStrength

checkPasswordStrength( $password)
todo

document me

Arguments

$password

Decrypt values from database

decrypt( $value = '')
inherited

Arguments

$value

Encrypt/decrypt values

decryptEncryptAttributes( $action = 'decrypt')
inherited

Arguments

$action

Decrypt single value

decryptSingle(string $value = ''): string
inheritedstatic

Arguments

$value

string

String value which needs to be decrypted

Response

string

the decrypted string

Decrypt single value

decryptSingleOld(string $value = ''): string
inheritedstatic

Arguments

$value

string

String value which needs to be decrypted

Response

string

the decrypted string

deleteAllByAttributes

deleteAllByAttributes(array $attributes,string $condition = '',array $params = array()): integer
inherited
todo

This should also be moved to the behavior at some point. This method overrides the parent in order to raise PluginEvents for Bulk delete operations.

Filter Criteria are wrapped into a CDBCriteria instance so we have a single instance responsible for holding the filter criteria to be passed to the PluginEvent, this also enables us to pass the fully configured CDBCriteria instead of the original Parameters.

See {@link find()} for detailed explanation about $condition and $params.

Arguments

$attributes

array

list of attribute values (indexed by attribute names) that the active records should match. An attribute value can be an array which will be used to generate an IN condition.

$condition

string

query condition or criteria.

$params

array

parameters to be bound to an SQL statement.

Response

integer

number of rows affected by the execution.

dispatchPluginModelEvent

dispatchPluginModelEvent(string $sEventName,\CDbCriteria $criteria = null,array $eventParams = []): \PluginEvent
inherited

Arguments

$sEventName

string

$criteria

\CDbCriteria

$eventParams

array

Response

\PluginEvent

Encrypt values

encrypt()
inherited

Attribute values are encrypted ( if needed )to be used for searching purposes

encryptAttributeValues(array $attributes = null, $bEncryptedOnly = false, $bReplaceValues = true): array
inherited

Arguments

$attributes

array

list of attribute values (indexed by attribute names) that the active records should match. An attribute value can be an array which will be used to generate an IN condition.

$bEncryptedOnly

$bReplaceValues

Response

array

attributes array with encrypted atrribute values is returned

Encrypt values before saving to the database

encryptSave( $runValidation = false)
inherited

Arguments

$runValidation

Enrypt single value

encryptSingle(string $value = '')
inheritedstatic

Arguments

$value

string

String value which needs to be encrypted

Finds all active records satisfying the specified condition but returns them as array

findAllAsArray(mixed $condition = '',array $params = array()): array
inherited

See \find() for detailed explanation about $condition and $params.

Arguments

$condition

mixed

query condition or criteria.

$params

array

parameters to be bound to an SQL statement.

Response

array

list of active records satisfying the specified condition. An empty array is returned if none is found.

Overriding of Yii's findAllByAttributes method to provide encrypted attribute value search

findAllByAttributes(array $attributes,mixed $condition = '',array $params = array()): array<mixed,static>
inherited

Arguments

$attributes

array

list of attribute values (indexed by attribute names) that the active records should match. An attribute value can be an array which will be used to generate an IN condition.

$condition

mixed

query condition or criteria.

$params

array

parameters to be bound to an SQL statement.

Response

array<mixed,static>

the records found. An empty array is returned if none is found.

Overriding of Yii's findByAttributes method to provide encrypted attribute value search

findByAttributes(array $attributes,mixed $condition = '',array $params = array()): static|null
inherited

Arguments

$attributes

array

list of attribute values (indexed by attribute names) that the active record should match. An attribute value can be an array which will be used to generate an IN condition.

$condition

mixed

query condition or criteria.

$params

array

parameters to be bound to an SQL statement.

Response

static|null

the record found. Null if none is found.

Finds user by username

findByUsername(string $sUserName): \User
static

Arguments

$sUserName

string

Response

\User

getAllEncryptedAttributes

getAllEncryptedAttributes(integer $iSurveyId,string $sClassName): array
inherited

Arguments

$iSurveyId

integer

$sClassName

string

Response

array

TODO: Should be split into seperate functions in the appropiate model or helper class TODO: Make an interface for records that support encryption.

Gets the buttons for the GridView

getButtons(): string

Response

string

TODO: this seems to not be used anymore - see getManagementButtons()

getColums

getColums(): array

Response

array

Returns User ID common in Survey_Permissions and User_in_groups

getCommonUID( $surveyid, $postusergroupid): \CDbDataReader

Arguments

$surveyid

$postusergroupid

Response

\CDbDataReader

getDateFormat

getDateFormat(): string

Response

string

Get the decription to be used in list

getDisplayName(): \$string

Response

\$string

getFormattedDateCreated

getFormattedDateCreated()
todo

Not used?

getGroupList

getGroupList()
todo

document me

Returns the last login formatted for displaying.

getLastloginFormatted(): string

Response

string

Gets the buttons for the GridView

getManagementButtons(): string

Response

string

getManagementCheckbox

getManagementCheckbox()

getManagementColums

getManagementColums(): array

Response

array

Return the max value for a field

getMaxId(string $field = null,boolean $forceRefresh = false): false|integer
inherited

This is a convenience method, that uses the primary key of the model to retrieve the highest value.

Throws
\Exception

Arguments

$field

string

The field that contains the Id, when null primary key is used if it is a single field

$forceRefresh

boolean

Don't use value from static cache but always requery the database

Response

false|integer

Return the min value for a field

getMinId(string $field = null,boolean $forceRefresh = false): false|integer
inherited

This is a convenience method, that uses the primary key of the model to retrieve the highest value.

Throws
\Exception

Arguments

$field

string

The field that contains the Id, when null primary key is used if it is a single field

$forceRefresh

boolean

Don't use value from static cache but always requery the database

Response

false|integer

getParentUserName

getParentUserName()

getPasswordHelpText

getPasswordHelpText()
todo

document me

getRoleList

getRoleList()

Return all super admins in the system

getSuperAdmins(): array<mixed,\User>

Response

array<mixed,\User>

getSurveysCreated

getSurveysCreated(): string

Response

string

Adds user record

insertRecords(array $data): string
access

public
deprecated

: just don't use it

Arguments

$data

array

Response

string

Creates new user

insertUser(string $new_user,string $new_pass,string $new_full_name,integer $parent_user,string $new_email,string|null $expires = null): integer|boolean
static
access

public

Arguments

$new_user

string

$new_pass

string

$new_full_name

string

$parent_user

integer

$new_email

string

$expires

string|null

Response

integer|boolean

User ID if success

Returns true if the user has expired.

isExpired(): boolean

Response

boolean

model

model( $className = __CLASS__): \User
static
inheritdoc

Arguments

$className

Response

\User

primaryKey

primaryKey()
inheritdoc

Modified version that default to do the same as the original, but allows via a third parameter to retrieve the result as array instead of active records. This solves a joining problem. Usage via findAllAsArray method

query(\CDbCriteria $criteria,boolean $all = false,boolean $asAR = true): mixed
inherited

Performs the actual DB query and populates the AR objects with the query result. This method is mainly internally used by other AR query methods.

since 1.1.7

Arguments

$criteria

\CDbCriteria

the query criteria

$all

boolean

whether to return all data

$asAR

boolean

Response

mixed

the AR objects populated with the query result

relations

relations()
inheritdoc

rules

rules()
inheritdoc

search

search()
inheritdoc

Function to show encryption symbol in gridview attribute header if value ois encrypted

setEncryptedAttributeLabel(integer $surveyId,string $className,string $attributeName): string
inherited
Throws
\CException

Arguments

$surveyId

integer

$className

string

$attributeName

string

Response

string

Set user password with hash

setPassword(string $sPassword, $save = false): \User

Arguments

$sPassword

string

The clear text password

$save

Response

\User

Creates the validation key expiration date and save it in db

setValidationExpiration(): boolean
Throws
\Exception

Response

boolean

true if datetime could be saved, false otherwise

Creates a validation key and saves it in table user for this user.

setValidationKey(): boolean

Response

boolean

true if validation_key could be saved in db, false otherwise

tableName

tableName()
inheritdoc

Updates records with the specified condition.

updateAll(array $attributes,mixed $condition = '',array $params = array()): integer
inherited

XSS filtering is enforced for attributes listed in model's $xssFilterAttributes property. See \find() for detailed explanation about $condition and $params. Note, the attributes are not checked for safety and no validation is done.

Arguments

$attributes

array

list of attributes (name=>$value) to be updated

$condition

mixed

query condition or criteria.

$params

array

parameters to be bound to an SQL statement.

Response

integer

the number of rows being updated

Updates user password hash

updatePassword(integer $iUserID,string $sPassword): integer
static

Arguments

$iUserID

integer

The User ID

$sPassword

string

The clear text password

Response

integer

number of rows updated

Checks if -- password strength -- oldpassword is correct -- oldpassword and newpassword are identical -- newpassword and repeatpassword are identical -- newpassword is not empty

validateNewPassword( $newPassword, $oldPassword, $repeatPassword): string

Arguments

$newPassword

$oldPassword

$repeatPassword

Response

string

empty string means everything is ok, otherwise error message is returned

Constants

MAX_EXPIRATION_TIME_IN_HOURS

MAX_EXPIRATION_TIME_IN_HOURS
var

maximum time the validation_key is valid

MAX_EXPIRATION_TIME_IN_DAYS

MAX_EXPIRATION_TIME_IN_DAYS
var

maximum days the validation key is valid

MAX_VALIDATION_KEY_LENGTH

MAX_VALIDATION_KEY_LENGTH
var

maximum length for the validation_key

Properties

Default value for user language

lang :string
var

Default value for user language

Type(s)

string

searched_value

searched_value :

Type(s)

Array of attributes that should be XSS filtered on mass updates

xssFilterAttributes :array<mixed,string>
inherited
var

Array of attributes that should be XSS filtered on mass updates

Type(s)

array<mixed,string>

bEncryption

bEncryption :
inherited

Type(s)

uid

uid :integer

User ID - primary key

Type(s)

integer

users_name

users_name :string

Users username

Type(s)

string

password

password :string

User's password hash

Type(s)

string

full_name

full_name :string

User's full name

Type(s)

string

parent_id

parent_id :integer

Type(s)

integer

lang

lang :string

User's preferred language: (auto: automatic | languagecodes eg 'en')

Type(s)

string

email

email :string

User's e-mail address

Type(s)

string

htmleditormode

htmleditormode :string

User's prefferred HTML editor mode:(default|inline|popup|none)

Type(s)

string

templateeditormode

templateeditormode :string

User's prefferred template editor mode:(default|full|none)

Type(s)

string

questionselectormode

questionselectormode :string

User's prefferred Question type selector:(default|full|none)

Type(s)

string

one_time_pw

one_time_pw :string

User's one-time-password hash

Type(s)

string

dateformat

dateformat :integer

Date format type 1-12

Type(s)

integer

created

created :string

Time created Time user was created as 'YYYY-MM-DD hh:mm:ss'

Type(s)

string

modified

modified :string

Time modified Time created Time user was modified as 'YYYY-MM-DD hh:mm:ss'

Type(s)

string

validation_key

validation_key :string

used for email link to reset or create a password for a survey participant Link is send when user is created or password has been reset

Type(s)

string

validation_key_expiration

validation_key_expiration :string

datetime when the validation key expires

Type(s)

string

last_forgot_email_password

last_forgot_email_password :string

datetime when user send email for forgot pw the last time (prevent bot)

Type(s)

string

permissions

permissions :array<mixed,\Permission>

Type(s)

array<mixed,\Permission>

parentUser

parentUser :\User

Parent user

Type(s)

\User

parentUserName

parentUserName :string

Parent user's name

Type(s)

string

roles

roles :array<mixed,\Permissiontemplates>

Type(s)

array<mixed,\Permissiontemplates>

groups

groups :array<mixed,\UserGroup>

Type(s)

array<mixed,\UserGroup>