LimeSurvey API - Master branch

Answer extends LSActiveRecord
in package

Application

Class Answer

Properties

$aid : int
$answerl10ns : array<string|int, AnswerL10n>
$assessment_value : int
$bEncryption : mixed
$code : string
$group : Question
$qid : int
$question : Question
$scale_id : int
$sortorder : int
$xssFilterAttributes : array<string|int, string>
$oldCode : mixed
$oldQid : mixed
$oldScaleId : mixed

Methods

behaviors() : array<string|int, mixed>: Lists the behaviors of this model
checkUniqueness() : mixed
decrypt() : mixed: Decrypt values from database
decryptEncryptAttributes() : mixed: Encrypt/decrypt values
decryptSingle() : string: Decrypt single value
decryptSingleOld() : string: Decrypt single value
defaultScope() : mixed
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
getAllEncryptedAttributes() : array<string|int, mixed>
getAnswerFromCode() : string|null: Return the key=>value answer for a given $qid
getAnswers() : CDbDataReader
getAnswersForStatistics() : array<string|int, mixed>
getMaxId() : false|int: Return the max value for a field
getMinId() : false|int: Return the min value for a field
getQuestionsForStatistics() : array<string|int, mixed>
insertRecords() : bool|null
model() : static
oldNewInsertansTags() : array<string|int, static>
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.
updateRecord() : int
updateSortOrder() : void: Updates sort order of answers inside a question
afterFind() : 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

$aid


    public
        int
    $aid

$answerl10ns


    public
        array<string|int, AnswerL10n>
    $answerl10ns

$assessment_value


    public
        int
    $assessment_value

$bEncryption


    public
        mixed
    $bEncryption
     = \false

$code


    public
        string
    $code

Answer code

$group


    public
        Question
    $group

$qid


    public
        int
    $qid

Question id

$question


    public
        Question
    $question

$scale_id


    public
        int
    $scale_id

$sortorder


    public
        int
    $sortorder

Answer sort order

$xssFilterAttributes


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

Array of attributes that should be XSS filtered on mass updates

$oldCode


    private
        mixed
    $oldCode

$oldQid


    private
        mixed
    $oldQid

$oldScaleId


    private
        mixed
    $oldScaleId

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>

checkUniqueness()


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

defaultScope()


    public
                    defaultScope() : mixed

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.

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.

getAnswerFromCode()

Return the key=>value answer for a given $qid


    public
                    getAnswerFromCode(int $qid, string $code, string $sLanguage[, int $iScaleID = 0 ]) : string|null

Parameters

$qid : int
$code : string
$sLanguage : string
$iScaleID : int = 0

Return values

string|null —

The answer text

getAnswers()


    public
                    getAnswers(int $qid) : CDbDataReader

Parameters

$qid : int

Return values

CDbDataReader

getAnswersForStatistics()


    public
                    getAnswersForStatistics(string $fields, mixed $condition, string $orderby) : array<string|int, mixed>

Parameters

$fields : string
$condition : mixed
$orderby : string

Return values

array<string|int, mixed>

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

getQuestionsForStatistics()


    public
                    getQuestionsForStatistics(string $fields, mixed $condition, string $orderby) : array<string|int, mixed>

Parameters

$fields : string
$condition : mixed
$orderby : string

Return values

array<string|int, mixed>

insertRecords()


    public
                    insertRecords(array<string|int, mixed> $data) : bool|null

Parameters

$data : array<string|int, mixed>

Return values

bool|null

model()


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

Parameters

$className : mixed = __CLASS__

Return values

static

oldNewInsertansTags()


    public
                    oldNewInsertansTags(int $newsid, int $oldsid) : array<string|int, static>

Parameters

$newsid : int
$oldsid : int

Return values

array<string|int, static>

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

updateRecord()


    public
                    updateRecord(array<string|int, mixed> $data[, bool|mixed $condition = false ]) : int

Parameters

$data : array<string|int, mixed>
$condition : bool|mixed = false

Return values

int

updateSortOrder()

Updates sort order of answers inside a question


    public
            static        updateSortOrder(int $qid) : void

Parameters

$qid : int

afterFind()


    protected
                    afterFind() : 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

Answer extends LSActiveRecord in package Application

Table of Contents

Properties

Methods

Properties

$aid

$answerl10ns

$assessment_value

$bEncryption

$code

$group

$qid

$question

$scale_id

$sortorder

$xssFilterAttributes

$oldCode

$oldQid

$oldScaleId

Methods

behaviors()

Tags

Return values

checkUniqueness()

decrypt()

Parameters

decryptEncryptAttributes()

Parameters

decryptSingle()

Parameters

Return values

decryptSingleOld()

Parameters

Return values

defaultScope()

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

getAllEncryptedAttributes()

Parameters

Return values

getAnswerFromCode()

Parameters

Tags

Return values

getAnswers()

Parameters

Return values

getAnswersForStatistics()

Parameters

Return values

getMaxId()

Parameters

Tags

Return values

getMinId()

Parameters

Tags

Return values

Answer extends LSActiveRecord
in package

Application