LimeSurvey API - Master branch

Plugin extends LSActiveRecord
in package

Application

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

Properties

$active : int
$bEncryption : mixed
$id : int
$load_error : string
$load_error : string
$name : string
$plugin_type : string
$plugin_type : string
$priority : int
$version : string
$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
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
getActionButtons() : string: Action buttons in plugin list.
getActivateButton() : string
getAllEncryptedAttributes() : array<string|int, mixed>
getButtons() : string
getDeactivateButton() : string
getDescription() : string: Description as shown in plugin list.
getExtensionConfig() : ExtensionConfig
getMaxId() : false|int: Return the max value for a field
getMinId() : false|int: Return the min value for a field
getName() : string: Name as shown in plugin list.
getPossibleDescription() : string: As getDescription, but catches the exception (to be used in plugin gridview)
getStatus() : string: Plugin status as shown in plugin list.
init() : mixed
isCompatible() : bool: Returns true if this plugin is compatible with this version of LS.
model() : Plugin
setEncryptedAttributeLabel() : string: Function to show encryption symbol in gridview attribute header if value ois encrypted
setLoadError() : int: Set this plugin as load error in database, and saves the error message.
setPluginLoadError() : int
tableName() : mixed
updateAll() : int: Updates records with the specified condition.
getDir() : string: Get installation folder of this plugin.
getUninstallButton() : string
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

$active


    public
        int
    $active

default 0

$bEncryption


    public
        mixed
    $bEncryption
     = \false

$id


    public
        int
    $id

$load_error


    public
        string
    $load_error

$load_error


    public
        string
    $load_error

$name


    public
        string
    $name

$plugin_type


    public
        string
    $plugin_type

$plugin_type


    public
        string
    $plugin_type

$priority


    public
        int
    $priority

default 0

$version


    public
        string
    $version

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

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.

getActionButtons()

Action buttons in plugin list.


    public
                    getActionButtons() : string

Return values

string —

HTML

getActivateButton()


    public
                    getActivateButton() : string

Return values

string —

HTML

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


    public
                    getButtons() : string

Return values

string

getDeactivateButton()


    public
                    getDeactivateButton() : string

Return values

string —

HTML

getDescription()

Description as shown in plugin list.


    public
                    getDescription() : string

Return values

string

getExtensionConfig()


    public
                    getExtensionConfig() : ExtensionConfig

Return values

ExtensionConfig

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

getName()

Name as shown in plugin list.


    public
                    getName() : string

Return values

string

getPossibleDescription()

As getDescription, but catches the exception (to be used in plugin gridview)


    public
                    getPossibleDescription() : string

Return values

string

getStatus()

Plugin status as shown in plugin list.


    public
                    getStatus() : string

Return values

string —

HTML

init()


    public
                    init() : mixed

isCompatible()

Returns true if this plugin is compatible with this version of LS.


    public
                    isCompatible() : bool

Return values

bool

model()


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

Parameters

$className : mixed = __CLASS__

Return values

Plugin

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

setLoadError()

Set this plugin as load error in database, and saves the error message.


    public
                    setLoadError(array<string|int, mixed> $error) : int

Parameters

$error : array<string|int, mixed>: Array with 'message' and 'file' keys (as get from error_get_last).

Return values

int —

Rows affected

setPluginLoadError()


    public
            static        setPluginLoadError(Plugin|null $plugin, string $pluginName, array<string|int, mixed> $error) : int

Parameters

$plugin : Plugin|null
$pluginName : string
$error : array<string|int, mixed>: Array with 'message' and 'file' keys (as get from error_get_last).

Return values

int —

Rows affected

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

getDir()

Get installation folder of this plugin.


    protected
                    getDir() : string

Installation folder is different for core and user plugins.

Return values

string

getUninstallButton()


    protected
                    getUninstallButton() : string

Return values

string —

HTML

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

Plugin extends LSActiveRecord in package Application

Table of Contents

Properties

Methods

Properties

$active

$bEncryption

$id

$load_error

$load_error

$name

$plugin_type

$plugin_type

$priority

$version

$xssFilterAttributes

Methods

behaviors()

Tags

Return values

decrypt()

Parameters

decryptEncryptAttributes()

Parameters

decryptSingle()

Parameters

Return values

decryptSingleOld()

Parameters

Return values

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

getActionButtons()

Tags

Return values

getActivateButton()

Tags

Return values

getAllEncryptedAttributes()

Parameters

Return values

getButtons()

Return values

getDeactivateButton()

Tags

Return values

getDescription()

Tags

Return values

getExtensionConfig()

Tags

Return values

getMaxId()

Parameters

Tags

Return values

getMinId()

Parameters

Plugin extends LSActiveRecord
in package

Application