LimeSurvey API - Master branch

SurveyLink extends LSActiveRecord
in package

Application

Class SurveyLink

Properties

$bEncryption : mixed
$checkbox : string
$columns : array<string|int, mixed>
$date_completed : string
$date_created : string
$date_invited : string
$dateFormat : string
$isSubmitted : string|bool
$lastInvited : string
$lastReminded : string
$participant : Participant
$participant_id : int
$survey : Survey
$survey_id : int
$surveyIdLink : string
$token_id : int
$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
deleteLinksBySurvey() : bool|CDbDataReader: Delete all entries in the survey_link table that link to a particular survey_id This function is used when a tokens_table is being dropped, and therefore all links must be removed
deleteTokenLink() : bool|CDbDataReader: Delete a single survey_link based on a survey participants table entry(by token_id and survey_id)
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>
getCheckbox() : string
getColumns() : array<string|int, mixed>
getDateFormat() : string
getFormattedDateCreated() : string
getIsSubmitted() : bool|string
getIsSubmittedHtml() : string
getLastInvited() : string
getLastReminded() : string
getLinkInfo() : array<string|int, CActiveRecord>
getMaxId() : false|int: Return the max value for a field
getMinId() : false|int: Return the min value for a field
getSurveyIdLink() : string: Link to survey
getSurveyName() : string
getTokenDynamicModel() : TokenDynamic
model() : SurveyLink
primaryKey() : mixed
rebuildLinksFromTokenTable() : CDbDataReader
relations() : mixed
search() : CActiveDataProvider
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

$bEncryption


    public
        mixed
    $bEncryption
     = \false

$checkbox


    public
        string
    $checkbox

$columns


    public
        array<string|int, mixed>
    $columns

$date_completed


    public
        string
    $date_completed

$date_created


    public
        string
    $date_created

$date_invited


    public
        string
    $date_invited

$dateFormat


    public
        string
    $dateFormat

$isSubmitted


    public
        string|bool
    $isSubmitted

$lastInvited


    public
        string
    $lastInvited

$lastReminded


    public
        string
    $lastReminded

$participant


    public
        Participant
    $participant

$participant_id


    public
        int
    $participant_id

$survey


    public
        Survey
    $survey

$survey_id


    public
        int
    $survey_id

$surveyIdLink


    public
        string
    $surveyIdLink

$token_id


    public
        int
    $token_id

$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.

deleteLinksBySurvey()

Delete all entries in the survey_link table that link to a particular survey_id This function is used when a tokens_table is being dropped, and therefore all links must be removed


    public
                    deleteLinksBySurvey(int $surveyId) : bool|CDbDataReader

Parameters

$surveyId : int: the SID of the survey whose tokens table is being dropped

Return values

bool|CDbDataReader

deleteTokenLink()

Delete a single survey_link based on a survey participants table entry(by token_id and survey_id)


    public
                    deleteTokenLink(array<string|int, int> $aTokenIds, int $surveyId) : bool|CDbDataReader

An entry in the survey_links table must be unique by the combination of Token_ID (which is unique within a tokens table) and survey_id (which limits to one single survey participants table).

Parameters

$aTokenIds : array<string|int, int>: the unique ids of the entry in the survey participants table being deleted
$surveyId : int: the id of the survey for the link being deleted

Return values

bool|CDbDataReader

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.

getCheckbox()


    public
                    getCheckbox() : string

Return values

string —

html

getColumns()


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

Return values

array<string|int, mixed>

getDateFormat()


    public
                    getDateFormat() : string

Return values

string

getFormattedDateCreated()


    public
                    getFormattedDateCreated() : string

Return values

string

getIsSubmitted()


    public
                    getIsSubmitted() : bool|string

Return values

bool|string —

false or submit date

getIsSubmittedHtml()


    public
                    getIsSubmittedHtml() : string

Return values

string

getLastInvited()


    public
                    getLastInvited() : string

Return values

string

getLastReminded()


    public
                    getLastReminded() : string

Return values

string

getLinkInfo()


    public
                    getLinkInfo(int $participantId) : array<string|int, CActiveRecord>

Parameters

$participantId : int

Return values

array<string|int, CActiveRecord>

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

getSurveyIdLink()

Link to survey


    public
                    getSurveyIdLink() : string

Return values

string —

html

getSurveyName()


    public
                    getSurveyName() : string

Return values

string —

// TODO this should be in survey model

getTokenDynamicModel()


    public
                    getTokenDynamicModel() : TokenDynamic

Return values

TokenDynamic

model()


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

Parameters

$className : mixed = __CLASS__

Return values

SurveyLink

primaryKey()


    public
                    primaryKey() : mixed

rebuildLinksFromTokenTable()


    public
                    rebuildLinksFromTokenTable(int $iSurveyId) : CDbDataReader

Parameters

$iSurveyId : int

Return values

CDbDataReader

relations()


    public
                    relations() : mixed

search()


    public
                    search() : CActiveDataProvider

Return values

CActiveDataProvider

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

SurveyLink extends LSActiveRecord in package Application

Table of Contents

Properties

Methods

Properties

$bEncryption

$checkbox

$columns

$date_completed

$date_created

$date_invited

$dateFormat

$isSubmitted

$lastInvited

$lastReminded

$participant

$participant_id

$survey

$survey_id

$surveyIdLink

$token_id

$xssFilterAttributes

Methods

attributeLabels()

Tags

behaviors()

Tags

Return values

decrypt()

Parameters

decryptEncryptAttributes()

Parameters

decryptSingle()

Parameters

Return values

decryptSingleOld()

Parameters

Return values

deleteAllByAttributes()

Parameters

Tags

Return values

deleteLinksBySurvey()

Parameters

Return values

deleteTokenLink()

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

getCheckbox()

Return values

getColumns()

Return values

getDateFormat()

Return values

getFormattedDateCreated()

Return values

getIsSubmitted()

SurveyLink extends LSActiveRecord
in package

Application