This is the model class for table "{{{{participant_attribute_names}}}}".
The following are the available columns in table '{{{{participant_attribute_names}}}}':
package | Default |
---|
attributeLabels(): array
array
customized attribute labels (name=>label)
behaviors(): array
Below is a list of all behaviors we register:
see | \PluginEventBehavior\CTimestampBehavior |
---|---|
array
clearAttributeValues()
decrypt( $value = '')
decryptEncryptAttributes( $action = 'decrypt')
decryptSingle(string $value = ''): string
string
String value which needs to be decrypted
string
the decrypted string
decryptSingleOld(string $value = ''): string
string
String value which needs to be decrypted
string
the decrypted string
delAttribute(integer $attid): void
integer
delAttributeValues(integer $attid,integer $valid)
integer
integer
deleteAllByAttributes(array $attributes,string $condition = '',array $params = array()): integer
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 {@link find()} for detailed explanation about $condition and $params. |
---|
array
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.
string
query condition or criteria.
array
parameters to be bound to an SQL statement.
integer
number of rows affected by the execution.
dispatchPluginModelEvent(string $sEventName,\CDbCriteria $criteria = null,array $eventParams = []): \PluginEvent
string
\CDbCriteria
array
\PluginEvent
editParticipantAttributeValue( $data)
encrypt()
encryptAttributeValues(array $attributes = null, $bEncryptedOnly = false, $bReplaceValues = true): array
array
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.
array
attributes array with encrypted atrribute values is returned
encryptSave( $runValidation = false)
encryptSingle(string $value = '')
string
String value which needs to be encrypted
findAllAsArray(mixed $condition = '',array $params = array()): array
See \find() for detailed explanation about $condition and $params.
mixed
query condition or criteria.
array
parameters to be bound to an SQL statement.
array
list of active records satisfying the specified condition. An empty array is returned if none is found.
findAllByAttributes(array $attributes,mixed $condition = '',array $params = array()): array<mixed,static>
array
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.
mixed
query condition or criteria.
array
parameters to be bound to an SQL statement.
array<mixed,static>
the records found. An empty array is returned if none is found.
findByAttributes(array $attributes,mixed $condition = '',array $params = array()): static|null
array
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.
mixed
query condition or criteria.
array
parameters to be bound to an SQL statement.
static|null
the record found. Null if none is found.
getAllAttributes()
getAllAttributesValues()
getAllEncryptedAttributes(integer $iSurveyId,string $sClassName): array
integer
string
array
TODO: Should be split into seperate functions in the appropiate model or helper class TODO: Make an interface for records that support encryption.
getAttribute(string $attribute_id): mixed
psalm-suppress | ParamNameMismatch TODO: Tonis: this is a bad name for this method - it overrides parent method doing totally different thing |
---|
string
mixed
getAttributeID(): array
array
getAttributeName(string $attributeid,string $lang = 'en'): \ParticipantAttributeNameLang
getAttributeNames(integer $attributeid): array<mixed,\ParticipantAttributeName>
getAttributesValues(integer $attribute_id = null): array
integer
array
getAttributeTypeDropdownArray(): array
array
getAttributeTypeNice(): string
string
??
getAttributeValue( $participantid, $attributeid)
getButtons(): string
string
html
getColumns(): array
array
getCoreAttributeSwitch(): string
string
getCPDBAttributes(): array
array
will have the following structure result['attribute_id'] result['attribute_type'] result['attribute_display'] --> visible result['attribute_name'] result['lang']
getEncryptedSwitch(): string
string
getMassiveActionCheckbox(): string
string
getMaxId(string $field = null,boolean $forceRefresh = false): false|integer
This is a convenience method, that uses the primary key of the model to retrieve the highest value.
Throws |
|
---|
string
The field that contains the Id, when null primary key is used if it is a single field
boolean
Don't use value from static cache but always requery the database
false|integer
getMinId(string $field = null,boolean $forceRefresh = false): false|integer
This is a convenience method, that uses the primary key of the model to retrieve the highest value.
Throws |
|
---|
string
The field that contains the Id, when null primary key is used if it is a single field
boolean
Don't use value from static cache but always requery the database
false|integer
getNamePlusLanguageName(): string
string
getNotAddedAttributes(array $attributeIds): array
array
array
getParticipantVisibleAttribute(string $participant_id): array
string
the id of the participant to return values/names for (if empty, returns all)
array
getVisibleAttributes(mixed $sLanguageFilter = null): array
mixed
array
getVisibleSwitch(): string
string
model( $className = __CLASS__): \ParticipantAttributeName
primaryKey()
inheritdoc | |
---|---|
query(\CDbCriteria $criteria,boolean $all = false,boolean $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.
since | 1.1.7 |
---|
\CDbCriteria
the query criteria
boolean
whether to return all data
boolean
mixed
the AR objects populated with the query result
relations()
inheritdoc | |
---|---|
rules()
inheritdoc | |
---|---|
saveAttribute( $data)
saveAttributeEncrypted(integer $attid,string $encryptedcondition)
integer
string
saveAttributeLanguages(array $data)
todo | Doc |
---|---|
array
saveAttributeValue(array $data)
array
saveAttributeVisible(integer $attid,string $visiblecondition)
integer
string
saveParticipantAttributeValue(array $data)
array
search(): \CActiveDataProvider
\CActiveDataProvider
the data provider that can return the models based on the search/filter conditions.
setEncryptedAttributeLabel(integer $surveyId,string $className,string $attributeName): string
Throws |
|
---|
integer
string
string
string
storeAttribute(mixed $data): boolean|integer
mixed
boolean|integer
storeAttributeCSV(array $data): integer
array
integer
storeAttributeValue(array $data)
array
storeAttributeValues(array $data)
array
tableName()
inheritdoc | |
---|---|
updateAll(array $attributes,mixed $condition = '',array $params = array()): integer
XSS filtering is enforced for attributes listed in model's $xssFilterAttributes property. See \find() for detailed explanation about $condition and $params. Note, the attributes are not checked for safety and no validation is done.
array
list of attributes (name=>$value) to be updated
mixed
query condition or criteria.
array
parameters to be bound to an SQL statement.
integer
the number of rows being updated
xssFilterAttributes :array<mixed,string>
var | Array of attributes that should be XSS filtered on mass updates |
---|
array<mixed,string>
bEncryption :
attribute_id :integer
integer
attribute_type :string
string
defaultname :string
string
visible :string
string
encrypted :string
string
core_attribute :string
string
participant_attribute_names_lang :array<mixed,\ParticipantAttributeNameLang>
array<mixed,\ParticipantAttributeNameLang>
participant_attribute :\ParticipantAttribute
\ParticipantAttribute
AttributeTypeDropdownArray :array
array