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

Returns the primary key of this table

primaryKey() : string
access

public

Response

string

Returns the static model of ParticipantAttributeName table

model(string $class = __CLASS__) : \ParticipantAttributeName
static
static
access

public

Arguments

$class

string

Response

\ParticipantAttributeName

tableName

tableName() : string

Response

string

the associated database table name

rules

rules() : array

Response

array

validation rules for model attributes.

relations

relations() : array

Response

array

relational rules.

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) 

Arguments

$sLanguageFilter

mixed

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

getParticipantVisibleAttribute(string $participant_id) 

Arguments

$participant_id

string

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

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

getnotaddedAttributes

getnotaddedAttributes($attributeid) 

Arguments

$attributeid

Adds the data for a new attribute

storeAttribute(mixed $data) 

Arguments

$data

mixed

editParticipantAttributeValue

editParticipantAttributeValue($data) 

Arguments

$data

delAttribute

delAttribute($attid) : void

Arguments

$attid

delAttributeValues

delAttributeValues($attid, $valid) 

Arguments

$attid

$valid

getAttributeNames

getAttributeNames($attributeid) 

Arguments

$attributeid

getAttributeName

getAttributeName(string $attributeid, $lang = 'en') 

Arguments

$attributeid

string

$lang

getAttribute

getAttribute($attribute_id) 

Arguments

$attribute_id

saveAttribute

saveAttribute($data) 

Arguments

$data

saveAttributeLanguages

saveAttributeLanguages($data) 
todo

Doc

Arguments

$data

storeAttributeValues

storeAttributeValues($data) 

Arguments

$data

storeAttributeValue

storeAttributeValue($data) 

Arguments

$data

clearAttributeValues

clearAttributeValues() 

storeAttributeCSV

storeAttributeCSV($data) 

Arguments

$data

saveAttributeValue

saveAttributeValue($data) 

Arguments

$data

saveAttributeVisible

saveAttributeVisible($attid, $visiblecondition) 

Arguments

$attid

$visiblecondition

getAttributeID

getAttributeID() 

saveParticipantAttributeValue

saveParticipantAttributeValue($data) 

Arguments

$data

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

Response

mixed

the AR objects populated with the query result

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

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

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

Arguments

$condition

mixed

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.

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.

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

mixed

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

visible

visible : string

Type(s)

string