LimeSurvey API - Master branch

SettingGlobal extends LSActiveRecord
in package

Application

Class SettingGlobal

Constants

DBVERSION_NUMBER = 'DBVersion'

Properties

$bEncryption : mixed
$stg_name : string
$stg_value : string
$xssFilterAttributes : array<string|int, string>
$disableByDb : array<string|int, string>

Methods

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
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
generateAssetVersionNumber() : int: with comfortUpate, we increase the asset number by one.
getAllEncryptedAttributes() : array<string|int, mixed>
getDBVersionNumber() : int: Returns db version number from table settings_global or null if dbversion does not exist.
getMaxId() : false|int: Return the max value for a field
getMinId() : false|int: Return the min value for a field
increaseAssetsversionnumber() : mixed: Increase the asset version number in version.php This will force the refresh of the assets folders content
increaseCustomAssetsversionnumber() : mixed: Increase the custom asset version number in DB This will force the refresh of the assets folders content
model() : CActiveRecord
primaryKey() : mixed
rules() : mixed
setEncryptedAttributeLabel() : string: Function to show encryption symbol in gridview attribute header if value ois encrypted
setSetting() : self: Update or set a setting in DB and update current app config if no error happen Return self : then other script can use if($oSetting->hasErrors()) { Do action with $oSetting->getErrors; }
tableName() : mixed
updateAll() : int: Updates records with the specified condition.
afterSave() : mixed
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

DBVERSION_NUMBER


    public
        mixed
    DBVERSION_NUMBER
    = 'DBVersion'

$bEncryption


    public
        mixed
    $bEncryption
     = \false

$stg_name


    public
        string
    $stg_name

Setting name

$stg_value


    public
        string
    $stg_value

Setting value

$xssFilterAttributes


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

Array of attributes that should be XSS filtered on mass updates

$disableByDb


    private
        array<string|int, string>
    $disableByDb
     = array(
    'versionnumber',
    // Come and leave it in version.php
    'dbversionnumber',
    // Must keep it out of DB
    'updatable',
    // If admin with ftp access disable updatable : leave it
    'debug',
    // Currently not accessible, seem better
    'debugsql',
    // Currently not accessible, seem better
    'forcedsuperadmin',
    // This is for security
    'defaultfixedtheme',
    // Because updating can broke instance
    'demoMode',
    // No demoMode update via model
    'ssl_emergency_override',
    // security related
    'ssl_disable_alert',
)

settings that must only come from php files

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.

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.

generateAssetVersionNumber()

with comfortUpate, we increase the asset number by one.


    public
            static        generateAssetVersionNumber(int $iAssetNumber) : int

so to be sure that the asset number from comfortUpdate will be different from the one generated here, we index it by 100000

Parameters

$iAssetNumber : int: the current asset number

Return values

int —

the new asset number

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.

getDBVersionNumber()

Returns db version number from table settings_global or null if dbversion does not exist.


    public
            static        getDBVersionNumber() : int

Return values

int —

| null

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

increaseAssetsversionnumber()

Increase the asset version number in version.php This will force the refresh of the assets folders content


    public
            static        increaseAssetsversionnumber() : mixed

increaseCustomAssetsversionnumber()

Increase the custom asset version number in DB This will force the refresh of the assets folders content


    public
            static        increaseCustomAssetsversionnumber() : mixed

model()


    public
            static        model([mixed $className = __CLASS__ ]) : CActiveRecord

Parameters

$className : mixed = __CLASS__

Return values

CActiveRecord

primaryKey()


    public
                    primaryKey() : mixed

rules()


    public
                    rules() : mixed

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

setSetting()

Update or set a setting in DB and update current app config if no error happen Return self : then other script can use if($oSetting->hasErrors()) { Do action with $oSetting->getErrors; }


    public
            static        setSetting(string $settingname, mixed $settingvalue) : self

Parameters

$settingname : string
$settingvalue : mixed

Return values

self

tableName()


    public
                    tableName() : mixed

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

afterSave()


    protected
                    afterSave() : mixed

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

SettingGlobal extends LSActiveRecord in package Application

Table of Contents

Constants

Properties

Methods

Constants

DBVERSION_NUMBER

Properties

$bEncryption

$stg_name

$stg_value

$xssFilterAttributes

$disableByDb

Methods

behaviors()

Tags

Return values

decrypt()

Parameters

decryptEncryptAttributes()

Parameters

decryptSingle()

Parameters

Return values

decryptSingleOld()

Parameters

Return values

deleteAllByAttributes()

Parameters

Tags

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

generateAssetVersionNumber()

Parameters

Return values

getAllEncryptedAttributes()

Parameters

Return values

getDBVersionNumber()

Return values

getMaxId()

Parameters

Tags

Return values

getMinId()

Parameters

Tags

Return values

increaseAssetsversionnumber()

increaseCustomAssetsversionnumber()

model()

Parameters

Tags

Return values

primaryKey()

Tags

rules()

Tags

setEncryptedAttributeLabel()

Parameters

Tags

SettingGlobal extends LSActiveRecord
in package

Application