LimeSurvey API - Master branch

LabelSet extends LSActiveRecord
in package

Application

implements PermissionInterface Uses PermissionTrait

Class LabelSet

Interfaces

PermissionInterface

Properties

$bEncryption : mixed
$label_name : string
$languages : string
$lid : int
$xssFilterAttributes : array<string|int, string>

Methods

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
deleteLabelSet() : bool: Recursively deletes a label set including labels and localizations
deleteLabelsForLabelSet() : mixed: Delete all childs(Label and LabelL10n) for a LabelSet
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() : string: Returns all defined buttons for the gridview.
getLanguageArray() : mixed
getMaxId() : false|int: Return the max value for a field
getMinId() : false|int: Return the min value for a field
getMinimalPermissionRead() : null|string: Get minimal permission name (for read value)
getOwnerId() : int: Get the owner id of this Survey group Used for Permission
getPermissionData() : array<string|int, mixed>: Get Permission data for Permission object
hasPermission() : bool
insertRecords() : bool|int
model() : LabelSet
permission() : self: permission scope for this model Actually only test if user have access to LabelSets (read) Usage don't need read permission
primaryKey() : mixed
relations() : mixed
rules() : mixed
sanitizeAttribute() : string: Sanitize string for any attribute, XSS and XSS in javascript function too.
search() : 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.
getPermissionCriteria() : CDbCriteria: Get criteria from Permission If currrent user didn't have global permission (read) : add Permission criteria, currentky only owner_id check
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

$label_name


    public
        string
    $label_name

Label Name (max 100 chars)

$languages


    public
        string
    $languages

$lid


    public
        int
    $lid

ID (primary key)

$xssFilterAttributes


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

Array of attributes that should be XSS filtered on mass updates

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.

deleteLabelSet()

Recursively deletes a label set including labels and localizations


    public
                    deleteLabelSet(int $id) : bool

Parameters

$id : int: The label set ID

Return values

bool

deleteLabelsForLabelSet()

Delete all childs(Label and LabelL10n) for a LabelSet


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

getbuttons()

Returns all defined buttons for the gridview.


    public
                    getbuttons() : string

Return values

string

getLanguageArray()


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

getMinimalPermissionRead()

Get minimal permission name (for read value)


    public
            static        getMinimalPermissionRead() : null|string

Return values

null|string

getOwnerId()

Get the owner id of this Survey group Used for Permission


    public
                    getOwnerId() : int

Return values

int

getPermissionData()

Get Permission data for Permission object


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

Return values

array<string|int, mixed>

hasPermission()


    public
                    hasPermission(mixed $sPermission[, mixed $sCRUD = 'read' ][, mixed $iUserID = null ]) : bool

Parameters

$sPermission : mixed
$sCRUD : mixed = 'read'
$iUserID : mixed = null

Return values

bool

insertRecords()


    public
                    insertRecords( $data) : bool|int

Parameters

$data :

Return values

bool|int

model()


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

Parameters

$className : mixed = __CLASS__

Return values

LabelSet

permission()

permission scope for this model Actually only test if user have access to LabelSets (read) Usage don't need read permission


    public
                    permission([int|null $userid = null ]) : self

Parameters

$userid : int|null = null

Return values

self

primaryKey()


    public
                    primaryKey() : mixed

relations()


    public
                    relations() : mixed

rules()


    public
                    rules() : mixed

sanitizeAttribute()

Sanitize string for any attribute, XSS and XSS in javascript function too.


    public
            static        sanitizeAttribute(string $attribute) : string

Parameters

$attribute : string: to sanitize

Return values

string —

sanitized attribute

search()


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

getPermissionCriteria()

Get criteria from Permission If currrent user didn't have global permission (read) : add Permission criteria, currentky only owner_id check


    protected
            static        getPermissionCriteria([int|null $userid = null ]) : CDbCriteria

Parameters

$userid : int|null = null: for this user id , if not set : get current one

Return values

CDbCriteria

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

LabelSet extends LSActiveRecord in package Application implements PermissionInterface Uses PermissionTrait

Table of Contents

Interfaces

Properties

Methods

Properties

$bEncryption

$label_name

$languages

$lid

$xssFilterAttributes

Methods

behaviors()

Tags

Return values

decrypt()

Parameters

decryptEncryptAttributes()

Parameters

decryptSingle()

Parameters

Return values

decryptSingleOld()

Parameters

Return values

deleteAllByAttributes()

Parameters

Tags

Return values

deleteLabelSet()

Parameters

Tags

Return values

deleteLabelsForLabelSet()

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()

Return values

getLanguageArray()

getMaxId()

Parameters

Tags

Return values

getMinId()

Parameters

Tags

Return values

getMinimalPermissionRead()

Return values

getOwnerId()

Return values

getPermissionData()

Return values

hasPermission()

Parameters

Tags

Return values

insertRecords()

Parameters

LabelSet extends LSActiveRecord
in package

Application

implements PermissionInterface Uses PermissionTrait