LimeSurvey API - Master branch

Quota extends LSActiveRecord
in package

Application

Class Quota

Constants

ACTION_CONFIRM_TERMINATE = 2
ACTION_TERMINATE = 1

Properties

$action : int
$action : mixed
$active : int
$active : mixed
$autoload_url : int
$bEncryption : mixed
$completeCount : int
$currentLanguageSetting : QuotaLanguageSetting
$id : int
$languagesettings : array<string|int, QuotaLanguageSetting>
$mainLanguagesetting : QuotaLanguageSetting
$name : string
$qlimit : int
$quotaMembers : array<string|int, QuotaMember>
$sid : int
$survey : Survey
$xssFilterAttributes : array<string|int, string>

Methods

attributeLabels() : 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
deleteQuota() : mixed
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>
getButtons() : mixed
getCompleteCount() : mixed
getCurrentLanguageSetting() : QuotaLanguageSetting: Get the QuotaLanguageSetting for current language
getMainLanguagesetting() : QuotaLanguageSetting
getMaxId() : false|int: Return the max value for a field
getMinId() : false|int: Return the min value for a field
getViewArray() : mixed
insertRecords() : bool|int
model() : CActiveRecord: Returns the static model of Settings table
primaryKey() : mixed
relations() : mixed
rules() : mixed
setEncryptedAttributeLabel() : string: Function to show encryption symbol in gridview attribute header if value ois encrypted
tableName() : mixed
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

ACTION_CONFIRM_TERMINATE

public mixed ACTION_CONFIRM_TERMINATE = 2

ACTION_TERMINATE

public mixed ACTION_TERMINATE = 1

$action

public int $action

$action

public mixed $action = self::ACTION_TERMINATE

$active

public int $active

Whether quota is active (0/1)

$active

public mixed $active = 1

$autoload_url

public int $autoload_url

Whether URL is automatically redirected if quota is triggered (0/1)

$bEncryption

public mixed $bEncryption = \false

$completeCount

public int $completeCount

Count of completed interviews for this quota

$currentLanguageSetting

public QuotaLanguageSetting $currentLanguageSetting

$id

public int $id

ID (primary key)

$languagesettings

public array<string|int, QuotaLanguageSetting> $languagesettings

Indexed by language code

$mainLanguagesetting

public QuotaLanguageSetting $mainLanguagesetting

$name

public string $name

Quota name (max 255 chars)

$qlimit

public int $qlimit

Quota limit

$quotaMembers

public array<string|int, QuotaMember> $quotaMembers

$sid

public int $sid

Survey ID

$survey

public Survey $survey

$xssFilterAttributes

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

Array of attributes that should be XSS filtered on mass updates

attributeLabels()

public attributeLabels() : mixed

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.

deleteQuota()

public deleteQuota([mixed|bool $condition = false ][, bool $recursive = true ]) : mixed

Parameters

$condition : mixed|bool = false
$recursive : bool = true

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.

getButtons()

public getButtons() : mixed

getCompleteCount()

public getCompleteCount() : mixed

getCurrentLanguageSetting()

Get the QuotaLanguageSetting for current language

public getCurrentLanguageSetting() : QuotaLanguageSetting

Return values

QuotaLanguageSetting

getMainLanguagesetting()

public getMainLanguagesetting() : QuotaLanguageSetting

Return values

QuotaLanguageSetting

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

getViewArray()

public getViewArray() : mixed

insertRecords()

public insertRecords( $data) : bool|int

Parameters

$data :

Return values

bool|int

model()

Returns the static model of Settings table

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

Parameters

$className : string = __CLASS__

Return values

CActiveRecord

primaryKey()

public primaryKey() : mixed

relations()

public relations() : 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

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

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

Quota extends LSActiveRecord in package Application

Table of Contents

Constants

Properties

Methods

Constants

ACTION_CONFIRM_TERMINATE

ACTION_TERMINATE

Properties

$action

$action

$active

$active

$autoload_url

$bEncryption

$completeCount

$currentLanguageSetting

$id

$languagesettings

$mainLanguagesetting

$name

$qlimit

$quotaMembers

$sid

$survey

$xssFilterAttributes

Methods

attributeLabels()

behaviors()

Tags

Return values

decrypt()

Parameters

decryptEncryptAttributes()

Parameters

decryptSingle()

Parameters

Return values

decryptSingleOld()

Parameters

Return values

deleteAllByAttributes()

Parameters

Tags

Return values

deleteQuota()

Parameters

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

getButtons()

getCompleteCount()

getCurrentLanguageSetting()

Return values

getMainLanguagesetting()

Return values

getMaxId()

Parameters

Tags

Return values

Quota extends LSActiveRecord
in package

Application