LimeSurvey API - Master branch

ParticipantAttributeName extends LSActiveRecord
in package

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

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

Table of Contents

Properties

$attribute_id  : int
$attribute_type  : string
$AttributeTypeDropdownArray  : array<string|int, mixed>
$bEncryption  : mixed
$core_attribute  : string
$defaultname  : string
$encrypted  : string
$participant_attribute  : ParticipantAttribute
$participant_attribute_names_lang  : array<string|int, ParticipantAttributeNameLang>
$visible  : string
$xssFilterAttributes  : array<string|int, string>

Methods

attributeLabels()  : array<string|int, mixed>
behaviors()  : array<string|int, mixed>
Lists the behaviors of this model
clearAttributeValues()  : mixed
decrypt()  : mixed
Decrypt values from database
decryptEncryptAttributes()  : mixed
Encrypt/decrypt values
decryptSingle()  : string
Decrypt single value
decryptSingleOld()  : string
Decrypt single value
delAttribute()  : void
delAttributeValues()  : mixed
deleteAllByAttributes()  : int
dispatchPluginModelEvent()  : PluginEvent
editParticipantAttributeValue()  : mixed
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
getAllAttributes()  : mixed
getAllAttributesValues()  : mixed
getAllEncryptedAttributes()  : array<string|int, mixed>
getAttribute()  : mixed
getAttributeID()  : array<string|int, mixed>
getAttributeName()  : ParticipantAttributeNameLang
getAttributeNames()  : array<string|int, ParticipantAttributeName>
getAttributesValues()  : array<string|int, mixed>
getAttributeTypeDropdownArray()  : array<string|int, mixed>
getAttributeTypeNice()  : string
getAttributeValue()  : mixed
getButtons()  : string
Returns Buttons for Grid view
getColumns()  : array<string|int, mixed>
getCoreAttributeSwitch()  : string
getCPDBAttributes()  : array<string|int, mixed>
Returns an array with all participant attributes which are not core attributes.
getEncryptedSwitch()  : string
getMassiveActionCheckbox()  : string
getMaxId()  : false|int
Return the max value for a field
getMinId()  : false|int
Return the min value for a field
getNamePlusLanguageName()  : string
getNotAddedAttributes()  : array<string|int, mixed>
this is a very specific function used to get the attributes that are not present for the participant
getParticipantVisibleAttribute()  : array<string|int, mixed>
Returns a list of attributes, with name and value. Currently not working for alternate languages
getVisibleAttributes()  : array<string|int, mixed>
Get an array of CPDB attributes
getVisibleSwitch()  : string
isCoreAttribute()  : bool
Returns true if the attribute is a core attribute
isEncrypted()  : bool
Returns true if the attribute is encrypted
model()  : ParticipantAttributeName
primaryKey()  : mixed
relations()  : mixed
rules()  : mixed
saveAttribute()  : mixed
saveAttributeEncrypted()  : mixed
saveAttributeLanguages()  : mixed
saveAttributeValue()  : mixed
updates the attribute values in participant_attribute_values
saveAttributeVisible()  : mixed
saveParticipantAttributeValue()  : 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
storeAttribute()  : bool|int
Adds the data for a new attribute
storeAttributeCSV()  : int
storeAttributeValue()  : mixed
storeAttributeValues()  : mixed
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

Properties

$xssFilterAttributes

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

Array of attributes that should be XSS filtered on mass updates

Methods

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:

Tags
see
PluginEventBehavior
see
CTimestampBehavior
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

delAttributeValues()

public delAttributeValues(int $attid, int $valid) : mixed
Parameters
$attid : int
$valid : int

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.

Tags
todo

This should also be moved to the behavior at some point. This method overrides the parent in order to raise PluginEvents for Bulk delete operations.

Filter Criteria are wrapped into a CDBCriteria instance so we have a single instance responsible for holding the filter criteria to be passed to the PluginEvent, this also enables us to pass the fully configured CDBCriteria instead of the original Parameters.

See for detailed explanation about $condition and $params.

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

editParticipantAttributeValue()

public editParticipantAttributeValue(mixed $data) : mixed
Parameters
$data : 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.

getAttribute()

public getAttribute(string $attribute_id) : mixed
Parameters
$attribute_id : string
Tags
psalm-suppress

ParamNameMismatch TODO: Tonis: this is a bad name for this method - it overrides parent method doing totally different thing

getAttributeID()

public getAttributeID() : array<string|int, mixed>
Return values
array<string|int, mixed>

getAttributesValues()

public getAttributesValues([int $attribute_id = null ]) : array<string|int, mixed>
Parameters
$attribute_id : int = null
Return values
array<string|int, mixed>

getAttributeTypeDropdownArray()

public getAttributeTypeDropdownArray() : array<string|int, mixed>
Return values
array<string|int, mixed>

getAttributeValue()

public getAttributeValue(mixed $participantid, mixed $attributeid) : mixed
Parameters
$participantid : mixed
$attributeid : mixed

getCPDBAttributes()

Returns an array with all participant attributes which are not core attributes.

public getCPDBAttributes() : array<string|int, mixed>
Return values
array<string|int, mixed> —

will have the following structure result['attribute_id'] result['attribute_type'] result['attribute_display'] --> visible result['attribute_name'] result['lang']

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

Tags
throws
Exception
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

Tags
throws
Exception
Return values
false|int

getNotAddedAttributes()

this is a very specific function used to get the attributes that are not present for the participant

public getNotAddedAttributes(array<string|int, mixed> $attributeIds) : array<string|int, mixed>
Parameters
$attributeIds : array<string|int, mixed>
Return values
array<string|int, mixed>

getParticipantVisibleAttribute()

Returns a list of attributes, with name and value. Currently not working for alternate languages

public getParticipantVisibleAttribute(string $participant_id) : array<string|int, mixed>
Parameters
$participant_id : string

the id of the participant to return values/names for (if empty, returns all)

Return values
array<string|int, mixed>

getVisibleAttributes()

Get an array of CPDB attributes

public getVisibleAttributes([mixed $sLanguageFilter = null ]) : array<string|int, mixed>
Parameters
$sLanguageFilter : mixed = null
Return values
array<string|int, mixed>

isCoreAttribute()

Returns true if the attribute is a core attribute

public isCoreAttribute() : bool
Return values
bool

isEncrypted()

Returns true if the attribute is encrypted

public isEncrypted() : bool
Return values
bool

saveAttributeEncrypted()

public saveAttributeEncrypted(int $attid, string $encryptedcondition) : mixed
Parameters
$attid : int
$encryptedcondition : string

saveAttributeLanguages()

public saveAttributeLanguages(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>
Tags
todo

Doc

saveAttributeValue()

updates the attribute values in participant_attribute_values

public saveAttributeValue(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>

saveAttributeVisible()

public saveAttributeVisible(int $attid, string $visiblecondition) : mixed
Parameters
$attid : int
$visiblecondition : string

saveParticipantAttributeValue()

public saveParticipantAttributeValue(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, 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
Tags
throws
CException
Return values
string

storeAttribute()

Adds the data for a new attribute

public storeAttribute(mixed $data) : bool|int
Parameters
$data : mixed
Return values
bool|int

storeAttributeCSV()

public storeAttributeCSV(array<string|int, mixed> $data) : int
Parameters
$data : array<string|int, mixed>
Return values
int

storeAttributeValue()

public storeAttributeValue(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>

storeAttributeValues()

public storeAttributeValues(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, 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
Tags
since
1.1.7
Return values
mixed —

the AR objects populated with the query result


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results