ParticipantShare

Extends \LSActiveRecord

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

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

Methods

model

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

Arguments

$class

Response

\ParticipantShare

tableName

tableName() 
inheritdoc

rules

rules() 
inheritdoc

relations

relations() 
inheritdoc

attributeLabels

attributeLabels() 
inheritdoc

getSharedByList

getSharedByList(integer $selected) : string

Arguments

$selected

integer

Response

string

html dropdown

getSharedBy

getSharedBy() : string

Response

string

getCanEditHtml

getCanEditHtml() : string

Response

string

HTML

Action buttons

getButtons() : string

Response

string

HTML

Massive action checkbox

getCheckbox() : string

Response

string

html

getColumns

getColumns() : array

Response

array

storeParticipantShare

storeParticipantShare(array $data) : void

Arguments

$data

array

updateShare

updateShare(array $data) : void

Arguments

$data

array

deleteRow

deleteRow(string $rows) : void

Arguments

$rows

string

Comma-separated list of something

Full name of the owner of the participant that is shared

getOwnerName() : string

Response

string

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

ownerName

ownerName : 

participant_id

participant_id : string

Type(s)

string

share_uid

share_uid : integer

Type(s)

integer

date_added

date_added : string

Type(s)

string

can_edit

can_edit : string

Type(s)

string

participant

participant : \Participant

Type(s)

\Participant

shared_by

shared_by : \User

Type(s)

\User

participantAttributes

participantAttributes : \ParticipantAttribute[]

Type(s)

\ParticipantAttribute[]