LimeSurvey API - Master branch

Surveymenu extends LSActiveRecord
in package

Application

This is the model class for table "{{surveymenu}}".

The following are the available columns in table '{{surveymenu}}':

Properties

$active : int
$bEncryption : mixed
$changed_at : string
$changed_by : int
$created_at : string
$created_by : int
$description : string
$id : int
$level : int
$ordering : int
$parent_id : int
$survey_id : int
$surveymenuEntries : array<string|int, SurveymenuEntries>
$title : string
$user_id : int
$xssFilterAttributes : array<string|int, string>

Methods

attributeLabels() : array<string|int, mixed>
behaviors() : array<string|int, mixed>: Lists the behaviors of this model
createSurveymenuArray() : array<string|int, mixed>
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
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: Returns the buttons for gridview.
getColumns() : array<string|int, mixed>: Returns the columns for gridview.
getDefaultSurveyMenus() : mixed
getMaxId() : false|int: Return the max value for a field
getMenuesForGlobalSettings() : mixed
getMenuIdOptions() : mixed
getMinId() : false|int: Return the min value for a field
getNextOrderPosition() : mixed
getOrderOptions() : mixed
getPositionOptions() : mixed
getShortListColumns() : array<string|int, mixed>
getSurveyIdOptions() : mixed
getSurveymenuSubmenus() : mixed
getUserIdOptions() : mixed
model() : Surveymenu: Returns the static model of the specified AR class.
onAfterSave() : mixed
onBeforeSave() : mixed
relations() : array<string|int, mixed>
restoreDefaults() : bool: Method to restore the default surveymenu entries This method will fail if the surveymenus have been tempered, or wrongly set
rules() : array<string|int, mixed>
search() : CActiveDataProvider: Retrieves a list of models based on the current search/filter conditions.
setEncryptedAttributeLabel() : string: Function to show encryption symbol in gridview attribute header if value ois encrypted
staticAddMenu() : mixed
staticRemoveMenu() : mixed
tableName() : string
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
__useTranslationForSurveymenu() : mixed

$active


    public
        int
    $active

The following are the available model relations:

$bEncryption


    public
        mixed
    $bEncryption
     = \false

$changed_at


    public
        string
    $changed_at

$changed_by


    public
        int
    $changed_by

$created_at


    public
        string
    $created_at

$created_by


    public
        int
    $created_by

$description


    public
        string
    $description

$id


    public
        int
    $id

$level


    public
        int
    $level

$ordering


    public
        int
    $ordering

$parent_id


    public
        int
    $parent_id

$survey_id


    public
        int
    $survey_id

$surveymenuEntries


    public
        array<string|int, SurveymenuEntries>
    $surveymenuEntries

$title


    public
        string
    $title

$user_id


    public
        int
    $user_id

$xssFilterAttributes


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

Array of attributes that should be XSS filtered on mass updates

attributeLabels()


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

Return values

array<string|int, mixed> —

customized attribute labels (name=>label)

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>

createSurveymenuArray()


    public
                    createSurveymenuArray( $oSurveyMenuObjects[, bool $collapsed = false ][, null $oSurvey = null ]) : array<string|int, mixed>

Parameters

$oSurveyMenuObjects :
$collapsed : bool = false
$oSurvey : null = null

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

delete()


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

getButtons()

Returns the buttons for gridview.


    public
                    getButtons() : mixed

getColumns()

Returns the columns for gridview.


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

Return values

array<string|int, mixed>

getDefaultSurveyMenus()


    public
                    getDefaultSurveyMenus([mixed $position = '' ][, mixed $oSurvey = null ]) : mixed

Parameters

$position : mixed = ''
$oSurvey : mixed = 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

getMenuesForGlobalSettings()


    public
                    getMenuesForGlobalSettings() : mixed

getMenuIdOptions()


    public
                    getMenuIdOptions() : mixed

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

getNextOrderPosition()


    public
                    getNextOrderPosition() : mixed

getOrderOptions()


    public
                    getOrderOptions() : mixed

getPositionOptions()


    public
                    getPositionOptions() : mixed

getShortListColumns()


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

Return values

array<string|int, mixed>

getSurveyIdOptions()


    public
                    getSurveyIdOptions() : mixed

getSurveymenuSubmenus()


    public
                    getSurveymenuSubmenus(mixed $oParentSurveymenu[, mixed $collapsed = false ]) : mixed

Parameters

$oParentSurveymenu : mixed
$collapsed : mixed = false

getUserIdOptions()


    public
                    getUserIdOptions() : mixed

model()

Returns the static model of the specified AR class.


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

Please note that you should have this exact method in all your CActiveRecord descendants!

Parameters

$className : string = __CLASS__: active record class name.

Return values

Surveymenu —

the static model class

onAfterSave()


    public
                    onAfterSave(mixed $event) : mixed

Parameters

$event : mixed

onBeforeSave()


    public
                    onBeforeSave(mixed $event) : mixed

Parameters

$event : mixed

relations()


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

Return values

array<string|int, mixed> —

relational rules.

restoreDefaults()

Method to restore the default surveymenu entries This method will fail if the surveymenus have been tempered, or wrongly set


    public
                    restoreDefaults() : bool

Return values

bool

rules()


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

Return values

array<string|int, mixed> —

validation rules for model attributes.

search()

Retrieves a list of models based on the current search/filter conditions.


    public
                    search() : CActiveDataProvider

Typical usecase:

Initialize the model fields with values from filter form.
Execute this method to get CActiveDataProvider instance which will filter models according to data in model fields.
Pass data provider to CGridView, CListView or any similar widget.

Return values

CActiveDataProvider —

the data provider that can return the models based on the search/filter conditions.

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

staticAddMenu()


    public
            static        staticAddMenu(mixed $menuArray) : mixed

Parameters

$menuArray : mixed

staticRemoveMenu()


    public
            static        staticRemoveMenu(mixed $menuName[, mixed $recursive = false ]) : mixed

Parameters

$menuName : mixed
$recursive : mixed = false

tableName()


    public
                    tableName() : string

Return values

string —

the associated database table name

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

__useTranslationForSurveymenu()


    private
                    __useTranslationForSurveymenu(mixed &$entryData) : mixed

Parameters

$entryData : mixed

Surveymenu extends LSActiveRecord in package Application

Table of Contents

Properties

Methods

Properties

$active

$bEncryption

$changed_at

$changed_by

$created_at

$created_by

$description

$id

$level

$ordering

$parent_id

$survey_id

$surveymenuEntries

$title

$user_id

$xssFilterAttributes

Methods

attributeLabels()

Return values

behaviors()

Tags

Return values

createSurveymenuArray()

Parameters

Return values

decrypt()

Parameters

decryptEncryptAttributes()

Parameters

decryptSingle()

Parameters

Return values

decryptSingleOld()

Parameters

Return values

delete()

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

getButtons()

getColumns()

Return values

getDefaultSurveyMenus()

Parameters

getMaxId()

Parameters

Tags

Return values

getMenuesForGlobalSettings()

getMenuIdOptions()

getMinId()

Surveymenu extends LSActiveRecord
in package

Application