LimeSurvey API - Master branch

Response extends Dynamic
in package

Application

AbstractYes

Relations

Properties

$bEncryption : mixed
$survey : Survey
$token : Token
$dynamicId : int: Prefixed with _ to not collide with column names.
$xssFilterAttributes : array<string|int, string>

Methods

__construct() : mixed: Dynamic constructor.
beforeDelete() : mixed
behaviors() : array<string|int, mixed>: Lists the behaviors of this model
browse() : mixed
create() : Response
decrypt() : mixed: Decrypt values from database
decryptEncryptAttributes() : mixed: Encrypt/decrypt values
decryptSingle() : string: Decrypt single value
decryptSingleOld() : string: Decrypt single value
delete() : mixed
deleteAllByAttributes() : int
deleteFiles() : array<string|int, string>: Delete all uploaded files for this response.
deleteFilesAndFilename() : array<string|int, mixed>: Delete uploaded files for this response AND modify response data to reflect all changes.
deleteTimings() : mixed: Delete timings if savetimings is set.
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>
getDynamicId() : mixed
getEncryptedAttributes() : mixed
getFiles() : array<string|int, array<string|int, mixed>>: Get all files related to this response and (optionally) question ID.
getFilesAndSqga() : array<string|int, mixed>: Like getFiles() but returns array with key sgqa and value file data.
getMaxId() : false|int: Return the max value for a field
getMinId() : false|int: Return the min value for a field
getSurveyId() : int: Get current surveyId for other model/function
model() : Response
primaryKey() : mixed
relations() : mixed
search() : mixed
setAllAttributes() : mixed: Set all the specified attributes.
setEncryptedAttributeLabel() : string: Function to show encryption symbol in gridview attribute header if value ois encrypted
someFileExists() : bool: Returns true if any uploaded file still exists on the filesystem.
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

$bEncryption


    public
        mixed
    $bEncryption
     = \false

$survey


    public
        Survey
    $survey

$token


    public
        Token
    $token

$dynamicId

Prefixed with _ to not collide with column names.


    protected
        int
    $dynamicId

The dynamic part of the class name.

$xssFilterAttributes


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

Array of attributes that should be XSS filtered on mass updates

__construct()

Dynamic constructor.


    public
                    __construct([string $scenario = 'insert' ]) : mixed

Parameters

$scenario : string = 'insert'

beforeDelete()


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

browse()


    public
                    browse() : mixed

create()


    public
            static        create(int $id[, string $scenario = 'insert' ]) : Response

Parameters

$id : int: Survey id in this class
$scenario : string = 'insert'

Return values

Response —

Description

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

delete()


    public
                    delete([mixed $deleteFiles = false ]) : mixed

Parameters

$deleteFiles : mixed = false

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.

deleteFiles()

Delete all uploaded files for this response.


    public
                    deleteFiles() : array<string|int, string>

Return values

array<string|int, string> —

Name of files that could not be removed.

deleteFilesAndFilename()

Delete uploaded files for this response AND modify response data to reflect all changes.


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

Keep comment and title of file, but remove name/filename.

Return values

array<string|int, mixed> —

Number of successfully moved files and names of files that could not be removed/failed

deleteTimings()

Delete timings if savetimings is set.


    public
                    deleteTimings() : mixed

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.

getDynamicId()


    public
                    getDynamicId() : mixed

getEncryptedAttributes()


    public
            static        getEncryptedAttributes([mixed $surveyid = 0 ]) : mixed

Parameters

$surveyid : mixed = 0

getFiles()

Get all files related to this response and (optionally) question ID.


    public
                    getFiles([int $qid = null ]) : array<string|int, array<string|int, mixed>>

Parameters

$qid : int = null

Return values

array<string|int, array<string|int, mixed>>

getFilesAndSqga()

Like getFiles() but returns array with key sgqa and value file data.


    public
                    getFilesAndSqga([int $sQID = 0 ]) : array<string|int, mixed>

Parameters

$sQID : int = 0: The question ID - optional - Default 0

Return values

array<string|int, mixed> —

[string $sgqa, array $fileData]

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

getSurveyId()

Get current surveyId for other model/function


    public
                    getSurveyId() : int

Return values

int

model()


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

Parameters

$className : mixed = null: Either the classname or the survey ID.

Return values

Response

primaryKey()


    public
                    primaryKey() : mixed

relations()


    public
                    relations() : mixed

search()


    public
                    search() : mixed

setAllAttributes()

Set all the specified attributes.


    public
                    setAllAttributes(mixed $values) : mixed

If any attribute doesn't exist in the DB, an Exception is thrown.

Parameters

$values : 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

someFileExists()

Returns true if any uploaded file still exists on the filesystem.


    public
                    someFileExists() : bool

Return values

bool

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

Response extends Dynamic in package Application

Table of Contents

Properties

Methods

Properties

$bEncryption

$survey

$token

$dynamicId

$xssFilterAttributes

Methods

__construct()

Parameters

beforeDelete()

behaviors()

Tags

Return values

browse()

create()

Parameters

Return values

decrypt()

Parameters

decryptEncryptAttributes()

Parameters

decryptSingle()

Parameters

Return values

decryptSingleOld()

Parameters

Return values

delete()

Parameters

deleteAllByAttributes()

Parameters

Tags

Return values

deleteFiles()

Return values

deleteFilesAndFilename()

Return values

deleteTimings()

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

getDynamicId()

getEncryptedAttributes()

Parameters

getFiles()

Parameters

Return values

getFilesAndSqga()

Parameters

Return values

getMaxId()

Parameters

Tags

Return values

getMinId()

Parameters

Response extends Dynamic
in package

Application