LimeSurvey API - Master branch

SettingsUser extends LSActiveRecord
in package

Application

This is the model class for table "{{settings_user}}".

The following are the available columns in table '{{settings_user}}':

Constants

ENTITY_EDITOR = 70
ENTITY_PLUGIN = 50
ENTITY_SURVEY = 100
ENTITY_SURVEYGROUP = 90
ENTITY_THEME = 80

Properties

$bEncryption : mixed
$entity : string
$entity_id : string
$stg_name : string
$stg_value : string
$uid : int
$xssFilterAttributes : array<string|int, string>

Methods

applyBaseSettings() : mixed
attributeLabels() : array<string|int, mixed>
behaviors() : array<string|int, mixed>: Lists the behaviors of this model
decrypt() : mixed: Decrypt values from database
decryptEncryptAttributes() : mixed: Encrypt/decrypt values
decryptSingle() : string: Decrypt single value
decryptSingleOld() : string: Decrypt single value
deleteAllByAttributes() : int
deleteUserSetting() : bool: Deletes user setting
dispatchPluginModelEvent() : PluginEvent
encrypt() : mixed: Encrypt values
encryptAttributeValues() : array<string|int, mixed>: Attribute values are encrypted ( if needed )to be used for searching purposes
encryptSave() : mixed: Encrypt values before saving to the database
encryptSingle() : mixed: Enrypt single value
findAllAsArray() : array<string|int, mixed>: Finds all active records satisfying the specified condition but returns them as array
findAllByAttributes() : array<string|int, static>: Overriding of Yii's findAllByAttributes method to provide encrypted attribute value search
findByAttributes() : static|null: Overriding of Yii's findByAttributes method to provide encrypted attribute value search
getAllEncryptedAttributes() : array<string|int, mixed>
getMaxId() : false|int: Return the max value for a field
getMinId() : false|int: Return the min value for a field
getUserSetting() : SettingsUser: Gets a user setting depending on the given parameters
getUserSettingValue() : mixed|null: Gets a user settings value depending on the given parameters Shorthand function
model() : SettingsUser: Returns the static model of the specified AR class.
relations() : array<string|int, mixed>
rules() : array<string|int, mixed>
search() : CActiveDataProvider: Retrieves a list of models based on the current search/filter conditions.
setEncryptedAttributeLabel() : string: Function to show encryption symbol in gridview attribute header if value ois encrypted
setUserSetting() : bool: Changes or creates a user setting
tableName() : string
updateAll() : int: Updates records with the specified condition.
query() : mixed: 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

ENTITY_EDITOR


    public
        mixed
    ENTITY_EDITOR
    = 70

ENTITY_PLUGIN


    public
        mixed
    ENTITY_PLUGIN
    = 50

ENTITY_SURVEY


    public
        mixed
    ENTITY_SURVEY
    = 100

ENTITY_SURVEYGROUP


    public
        mixed
    ENTITY_SURVEYGROUP
    = 90

ENTITY_THEME


    public
        mixed
    ENTITY_THEME
    = 80

$bEncryption


    public
        mixed
    $bEncryption
     = \false

$entity


    public
        string
    $entity

Entity name

$entity_id


    public
        string
    $entity_id

Entity ID

$stg_name


    public
        string
    $stg_name

Setting name

$stg_value


    public
        string
    $stg_value

Setting Value

$uid


    public
        int
    $uid

User id

$xssFilterAttributes


    protected
        array<string|int, string>
    $xssFilterAttributes
     = []

Array of attributes that should be XSS filtered on mass updates

applyBaseSettings()


    public
            static        applyBaseSettings(mixed $iUid) : mixed

Parameters

$iUid : mixed

attributeLabels()


    public
                    attributeLabels() : array<string|int, mixed>

Return values

array<string|int, mixed> —

customized attribute labels (name=>label)

behaviors()

Lists the behaviors of this model


    public
                    behaviors() : array<string|int, mixed>

Below is a list of all behaviors we register:

Return values

array<string|int, mixed>

decrypt()

Decrypt values from database


    public
                    decrypt([mixed $value = '' ]) : mixed

Parameters

$value : mixed = ''

decryptEncryptAttributes()

Encrypt/decrypt values


    public
                    decryptEncryptAttributes([mixed $action = 'decrypt' ]) : mixed

Parameters

$action : mixed = 'decrypt'

decryptSingle()

Decrypt single value


    public
            static        decryptSingle([string $value = '' ]) : string

Parameters

$value : string = '': String value which needs to be decrypted

Return values

string —

the decrypted string

decryptSingleOld()

Decrypt single value


    public
            static        decryptSingleOld([string $value = '' ]) : string

Parameters

$value : string = '': String value which needs to be decrypted

Return values

string —

the decrypted string

deleteAllByAttributes()


    public
                    deleteAllByAttributes(array<string|int, mixed> $attributes[, string $condition = '' ][, array<string|int, mixed> $params = [] ]) : int

Parameters

$attributes : array<string|int, mixed>: 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<string|int, mixed> = []: parameters to be bound to an SQL statement.

Return values

int —

number of rows affected by the execution.

deleteUserSetting()

Deletes user setting


    public
            static        deleteUserSetting(string $stg_name[, int $uid = null ][, string $entity = null ][, int $entity_id = null ]) : bool

Parameters

$stg_name : string
$uid : int = null: | Can be omitted to just take the currently logged in users id
$entity : string = null: | optional defaults to 'null'
$entity_id : int = null: | optional defaults to 'null'

Return values

bool —

Deleting success/failure

dispatchPluginModelEvent()


    public
                    dispatchPluginModelEvent(string $sEventName, CDbCriteria $criteria = null, array<string|int, mixed> $eventParams = []) : PluginEvent

Parameters

$sEventName : string
$criteria = null : CDbCriteria
$eventParams = [] : array<string|int, mixed>

Return values

PluginEvent

encrypt()

Encrypt values


    public
                    encrypt() : mixed

encryptAttributeValues()

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


    public
                    encryptAttributeValues([array<string|int, mixed> $attributes = null ][, mixed $bEncryptedOnly = false ][, mixed $bReplaceValues = true ]) : array<string|int, mixed>

Parameters

$attributes : array<string|int, mixed> = null: 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 : mixed = false
$bReplaceValues : mixed = true

Return values

array<string|int, mixed> —

attributes array with encrypted atrribute values is returned

encryptSave()

Encrypt values before saving to the database


    public
                    encryptSave([mixed $runValidation = false ]) : mixed

Parameters

$runValidation : mixed = false

encryptSingle()

Enrypt single value


    public
            static        encryptSingle([string $value = '' ]) : mixed

Parameters

$value : string = '': String value which needs to be encrypted

findAllAsArray()

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


    public
                    findAllAsArray([mixed $condition = '' ][, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>

See for detailed explanation about $condition and $params.

Parameters

$condition : mixed = '': query condition or criteria.
$params : array<string|int, mixed> = []: parameters to be bound to an SQL statement.

Return values

array<string|int, mixed> —

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

findAllByAttributes()

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


    public
                    findAllByAttributes(array<string|int, mixed> $attributes[, mixed $condition = '' ][, array<string|int, mixed> $params = [] ]) : array<string|int, static>

Parameters

$attributes : array<string|int, mixed>: 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<string|int, mixed> = []: parameters to be bound to an SQL statement.

Return values

array<string|int, static> —

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

findByAttributes()

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


    public
                    findByAttributes(array<string|int, mixed> $attributes[, mixed $condition = '' ][, array<string|int, mixed> $params = [] ]) : static|null

Parameters

$attributes : array<string|int, mixed>: 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<string|int, mixed> = []: parameters to be bound to an SQL statement.

Return values

static|null —

the record found. Null if none is found.

getAllEncryptedAttributes()


    public
                    getAllEncryptedAttributes(int $iSurveyId, string $sClassName) : array<string|int, mixed>

Parameters

$iSurveyId : int
$sClassName : string

Return values

array<string|int, mixed> —

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

getMaxId()

Return the max value for a field


    public
                    getMaxId([string $field = null ][, bool $forceRefresh = false ]) : false|int

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

Parameters

$field : string = null: The field that contains the Id, when null primary key is used if it is a single field
$forceRefresh : bool = false: Don't use value from static cache but always requery the database

Return values

false|int

getMinId()

Return the min value for a field


    public
                    getMinId([string $field = null ][, bool $forceRefresh = false ]) : false|int

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

Parameters

$field : string = null: The field that contains the Id, when null primary key is used if it is a single field
$forceRefresh : bool = false: Don't use value from static cache but always requery the database

Return values

false|int

getUserSetting()

Gets a user setting depending on the given parameters


    public
            static        getUserSetting(string $stg_name[, int $uid = null ][, string $entity = null ][, int $entity_id = null ]) : SettingsUser

Parameters

$stg_name : string
$uid : int = null: | Can be omitted to just take the currently logged in users id
$entity : string = null: | optional defaults to 'null'
$entity_id : int = null: | optional defaults to 'null'

Return values

SettingsUser —

The current settings Object

getUserSettingValue()

Gets a user settings value depending on the given parameters Shorthand function


    public
            static        getUserSettingValue(string $stg_name[, int|null $uid = null ][, int|null $entity = null ][, int|null $entity_id = null ][, mixed $default = null ]) : mixed|null

Parameters

$stg_name : string
$uid : int|null = null: | Can be omitted to just take the currently logged in users id
$entity : int|null = null: | optional defaults to 'null'
$entity_id : int|null = null: | optional defaults to 'null'
$default : mixed = null: | optional defaults to 'null'

Return values

mixed|null —

The current settings value or null id there is no setting

model()

Returns the static model of the specified AR class.


    public
            static        model([string $className = __CLASS__ ]) : SettingsUser

Please note that you should have this exact method in all your CActiveRecord descendants!

Parameters

$className : string = __CLASS__: active record class name.

Return values

SettingsUser —

the static model class

relations()


    public
                    relations() : array<string|int, mixed>

Return values

array<string|int, mixed> —

relational rules.

rules()


    public
                    rules() : array<string|int, mixed>

Return values

array<string|int, mixed> —

validation rules for model attributes.

search()

Retrieves a list of models based on the current search/filter conditions.


    public
                    search() : CActiveDataProvider

Typical usecase:

Initialize the model fields with values from filter form.
Execute this method to get CActiveDataProvider instance which will filter models according to data in model fields.
Pass data provider to CGridView, CListView or any similar widget.

Return values

CActiveDataProvider —

the data provider that can return the models based on the search/filter conditions.

setEncryptedAttributeLabel()

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


    public
                    setEncryptedAttributeLabel(int $surveyId, string $className, string $attributeName) : string

Parameters

$surveyId : int
$className : string
$attributeName : string

Return values

string

setUserSetting()

Changes or creates a user setting


    public
            static        setUserSetting(string $stg_name, int $stg_value[, int $uid = null ][, string $entity = null ][, int $entity_id = null ]) : bool

Parameters

$stg_name : string
$stg_value : int
$uid : int = null: | Can be omitted to just take the currently logged in users id
$entity : string = null: | optional defaults to 'null'
$entity_id : int = null: | optional defaults to 'null'

Return values

bool —

Saving success/failure

tableName()


    public
                    tableName() : string

Return values

string —

the associated database table name

updateAll()

Updates records with the specified condition.


    public
                    updateAll(array<string|int, mixed> $attributes[, mixed $condition = '' ][, array<string|int, mixed> $params = array() ]) : int

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

Parameters

$attributes : array<string|int, mixed>: list of attributes (name=>$value) to be updated
$condition : mixed = '': query condition or criteria.
$params : array<string|int, mixed> = array(): parameters to be bound to an SQL statement.

Return values

int —

the number of rows being updated

query()

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


    protected
                    query(CDbCriteria $criteria[, bool $all = false ][, bool $asAR = true ]) : mixed

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.

Parameters

$criteria : CDbCriteria: the query criteria
$all : bool = false: whether to return all data
$asAR : bool = true

Return values

mixed —

the AR objects populated with the query result

SettingsUser extends LSActiveRecord in package Application

Table of Contents

Constants

Properties

Methods

Constants

ENTITY_EDITOR

ENTITY_PLUGIN

ENTITY_SURVEY

ENTITY_SURVEYGROUP

ENTITY_THEME

Properties

$bEncryption

$entity

$entity_id

$stg_name

$stg_value

$uid

$xssFilterAttributes

Methods

applyBaseSettings()

Parameters

attributeLabels()

Return values

behaviors()

Tags

Return values

decrypt()

Parameters

decryptEncryptAttributes()

Parameters

decryptSingle()

Parameters

Return values

decryptSingleOld()

Parameters

Return values

deleteAllByAttributes()

Parameters

Tags

Return values

deleteUserSetting()

Parameters

Return values

dispatchPluginModelEvent()

Parameters

Return values

encrypt()

encryptAttributeValues()

Parameters

Return values

encryptSave()

Parameters

encryptSingle()

Parameters

findAllAsArray()

Parameters

Return values

findAllByAttributes()

Parameters

Return values

findByAttributes()

Parameters

Return values

getAllEncryptedAttributes()

Parameters

Return values

getMaxId()

Parameters

Tags

Return values

getMinId()

Parameters

Tags

Return values

getUserSetting()

Parameters

Return values

getUserSettingValue()

Parameters

SettingsUser extends LSActiveRecord
in package

Application