ParticipantAttributeName

Extends \LSActiveRecord

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

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

Methods

primaryKey

primaryKey() 
inheritdoc

model

model($class = __CLASS__) : \ParticipantAttributeName
static
inheritdoc

Arguments

$class

Response

\ParticipantAttributeName

tableName

tableName() 
inheritdoc

rules

rules() 
inheritdoc

relations

relations() 
inheritdoc

attributeLabels

attributeLabels() : array

Response

array

customized attribute labels (name=>label)

getButtons

getButtons() : string

Response

string

html

getMassiveActionCheckbox

getMassiveActionCheckbox() : string

Response

string

getAttributeTypeNice

getAttributeTypeNice() : string

Response

string

??

getAttributeTypeDropdownArray

getAttributeTypeDropdownArray() : array

Response

array

getNamePlusLanguageName

getNamePlusLanguageName() : string

Response

string

getVisibleSwitch

getVisibleSwitch() : string

Response

string

getColumns

getColumns() : array

Response

array

getAllAttributes

getAllAttributes() 

getAllAttributesValues

getAllAttributesValues() 

Get an array of CPDB attributes

getVisibleAttributes(mixed $sLanguageFilter = null) : array

Arguments

$sLanguageFilter

mixed

Response

array

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

getParticipantVisibleAttribute(string $participant_id) : array

Arguments

$participant_id

string

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

Response

array

getAttributeValue

getAttributeValue($participantid, $attributeid) 

Arguments

$participantid

$attributeid

getCPDBAttributes

getCPDBAttributes() : array

Response

array

getAttributesValues

getAttributesValues(int $attribute_id = null) : array

Arguments

$attribute_id

int

Response

array

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

getNotAddedAttributes(array $attributeIds) : array

Arguments

$attributeIds

array

Response

array

Adds the data for a new attribute

storeAttribute(mixed $data) : bool|int

Arguments

$data

mixed

Response

bool|int

editParticipantAttributeValue

editParticipantAttributeValue($data) 

Arguments

$data

delAttribute

delAttribute(integer $attid) : void

Arguments

$attid

integer

delAttributeValues

delAttributeValues(int $attid, int $valid) 

Arguments

$attid

int

$valid

int

getAttributeNames

getAttributeNames(integer $attributeid) : \ParticipantAttributeName[]

Arguments

$attributeid

integer

Response

\ParticipantAttributeName[]

getAttributeName

getAttributeName(string $attributeid, string $lang = 'en') : \ParticipantAttributeNameLang

Arguments

$attributeid

string

$lang

string

Response

\ParticipantAttributeNameLang

getAttribute

getAttribute(string $attribute_id) : mixed

Arguments

$attribute_id

string

Response

mixed

saveAttribute

saveAttribute($data) 

Arguments

$data

saveAttributeLanguages

saveAttributeLanguages(array $data) 
todo

Doc

Arguments

$data

array

storeAttributeValues

storeAttributeValues(array $data) 

Arguments

$data

array

storeAttributeValue

storeAttributeValue(array $data) 

Arguments

$data

array

clearAttributeValues

clearAttributeValues() 

storeAttributeCSV

storeAttributeCSV(array $data) : int

Arguments

$data

array

Response

int

updates the attribute values in participant_attribute_values

saveAttributeValue(array $data) 

Arguments

$data

array

saveAttributeVisible

saveAttributeVisible(integer $attid, string $visiblecondition) 

Arguments

$attid

integer

$visiblecondition

string

getAttributeID

getAttributeID() : array

Response

array

saveParticipantAttributeValue

saveParticipantAttributeValue(array $data) 

Arguments

$data

array

Lists the behaviors of this model

behaviors() : array
inherited

Below is a list of all behaviors we register:

see \CTimestampBehavior \PluginEventBehavior

Response

array

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

query(\CDbCriteria $criteria, boolean $all = false, bool $asAR = true) : mixed
inherited

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

Arguments

$criteria

\CDbCriteria

the query criteria

$all

boolean

whether to return all data

$asAR

bool

Response

mixed

the AR objects populated with the query result

Finds all active records satisfying the specified condition but returns them as array

findAllAsArray(\CDbCriteria $condition = '', array $params = array()) : array
inherited

See {@link find()} for detailed explanation about $condition and $params.

Arguments

$condition

\CDbCriteria

query condition or criteria.

$params

array

parameters to be bound to an SQL statement.

Response

array

list of active records satisfying the specified condition. An empty array is returned if none is found.

Return the max value for a field

getMaxId(string $field = null, boolean $forceRefresh = false) : false|int
inherited

This is a convenience method, that uses the primary key of the model to retrieve the highest value.

throws

Arguments

$field

string

The field that contains the Id, when null primary key is used if it is a single field

$forceRefresh

boolean

Don't use value from static cache but always requery the database

Response

false|int

Return the min value for a field

getMinId(string $field = null, boolean $forceRefresh = false) : false|int
inherited

This is a convenience method, that uses the primary key of the model to retrieve the highest value.

throws

Arguments

$field

string

The field that contains the Id, when null primary key is used if it is a single field

$forceRefresh

boolean

Don't use value from static cache but always requery the database

Response

false|int

deleteAllByAttributes

deleteAllByAttributes(array $attributes, string $condition = '', array $params = array()) : integer
inherited
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.

Arguments

$attributes

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.

$condition

string

query condition or criteria.

$params

array

parameters to be bound to an SQL statement.

Response

integer

number of rows affected by the execution.

Properties

attribute_id

attribute_id : integer

Type(s)

integer

attribute_type

attribute_type : string

Type(s)

string

defaultname

defaultname : string

Type(s)

string

visible

visible : string

Type(s)

string

participant_attribute_names_lang

participant_attribute_names_lang : \ParticipantAttributeNameLang[]

Type(s)

\ParticipantAttributeNameLang[]

participant_attribute

participant_attribute : \ParticipantAttribute

Type(s)

\ParticipantAttribute

AttributeTypeDropdownArray

AttributeTypeDropdownArray : array

Type(s)

array