LimeSurvey API - Master branch

ParticipantShare extends LSActiveRecord
in package

Application

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

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

Properties

$bEncryption : mixed
$can_edit : string
$date_added : string
$ownerName : mixed
$participant : Participant
$participant_id : string
$participantAttributes : array<string|int, ParticipantAttribute>
$share_uid : int
$shared_by : User
$survey_links : SurveyLink
$xssFilterAttributes : array<string|int, string>

Methods

attributeLabels() : mixed
behaviors() : array<string|int, mixed>: Lists the behaviors of this model
canEditSharedParticipant() : bool: Returns true if the user is allowed to edit the participant
decrypt() : mixed: Decrypt values from database
decryptEncryptAttributes() : mixed: Encrypt/decrypt values
decryptSingle() : string: Decrypt single value
decryptSingleOld() : string: Decrypt single value
deleteAllByAttributes() : int
deleteRow() : void
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: Action buttons
getCanEditHtml() : string
getCheckbox() : string: Massive action checkbox
getColumns() : array<string|int, mixed>
getMaxId() : false|int: Return the max value for a field
getMinId() : false|int: Return the min value for a field
getOwnerName() : string: Full name of the owner of the participant that is shared
getSharedBy() : string
getSharedByList() : string
model() : ParticipantShare
relations() : mixed
rules() : 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
storeParticipantShare() : void
tableName() : mixed
updateAll() : int: Updates records with the specified condition.
updateShare() : void
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

$can_edit


    public
        string
    $can_edit

$date_added


    public
        string
    $date_added

$ownerName


    public
        mixed
    $ownerName

$participant


    public
        Participant
    $participant

$participant_id


    public
        string
    $participant_id

$participantAttributes


    public
        array<string|int, ParticipantAttribute>
    $participantAttributes

$share_uid


    public
        int
    $share_uid

$shared_by


    public
        User
    $shared_by

$survey_links


    public
        SurveyLink
    $survey_links

//TODO should be singular

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

canEditSharedParticipant()

Returns true if the user is allowed to edit the participant


    public
                    canEditSharedParticipant( $participent_id) : bool

Parameters

$participent_id :

Return values

bool

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.

deleteRow()


    public
                    deleteRow(string $rows) : void

Parameters

$rows : string: Comma-separated list of something

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

Action buttons


    public
                    getButtons() : string

Return values

string —

HTML

getCanEditHtml()


    public
                    getCanEditHtml() : string

Return values

string —

HTML

getCheckbox()

Massive action checkbox


    public
                    getCheckbox() : string

Return values

string —

html

getColumns()


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

Return values

array<string|int, 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

getOwnerName()

Full name of the owner of the participant that is shared


    public
                    getOwnerName() : string

Return values

string

getSharedBy()


    public
                    getSharedBy() : string

Return values

string

getSharedByList()


    public
                    getSharedByList(int $selected) : string

Parameters

$selected : int

Return values

string —

html dropdown

model()


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

Parameters

$className : mixed = __CLASS__

Return values

ParticipantShare

relations()


    public
                    relations() : mixed

rules()


    public
                    rules() : mixed

search()

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


    public
                    search() : CActiveDataProvider

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

storeParticipantShare()


    public
                    storeParticipantShare(array<string|int, mixed> $data, array<string|int, mixed> $permission) : void

Parameters

$data : array<string|int, mixed>
$permission : array<string|int, mixed>

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

updateShare()


    public
                    updateShare(array<string|int, mixed> $data) : void

Parameters

$data : array<string|int, mixed>

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

ParticipantShare extends LSActiveRecord in package Application

Table of Contents

Properties

Methods

Properties

$bEncryption

$can_edit

$date_added

$ownerName

$participant

$participant_id

$participantAttributes

$share_uid

$shared_by

$survey_links

$xssFilterAttributes

Methods

attributeLabels()

Tags

behaviors()

Tags

Return values

canEditSharedParticipant()

Parameters

Return values

decrypt()

Parameters

decryptEncryptAttributes()

Parameters

decryptSingle()

Parameters

Return values

decryptSingleOld()

Parameters

Return values

deleteAllByAttributes()

Parameters

Tags

Return values

deleteRow()

Parameters

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

getCanEditHtml()

Return values

getCheckbox()

Return values

getColumns()

Return values

getMaxId()

Parameters

Tags

Return values

getMinId()

Parameters

Tags

Return values

ParticipantShare extends LSActiveRecord
in package

Application