SurveyLink

Extends \LSActiveRecord

Class SurveyLink

package

Default

Methods

attributeLabels

attributeLabels() 
inheritdoc

Lists the behaviors of this model

behaviors() : array
inherited

Below is a list of all behaviors we register:

see \CTimestampBehavior \PluginEventBehavior

Response

array

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.

Delete all entries in the survey_link table that link to a particular survey_id This function is used when a tokens_table is being dropped, and therefore all links must be removed

deleteLinksBySurvey(integer $surveyId) : boolean|\CDbDataReader

Arguments

$surveyId

integer

the SID of the survey whose tokens table is being dropped

Response

boolean|\CDbDataReader

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

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

See \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.

getCheckbox

getCheckbox() : string

Response

string

html

getColumns

getColumns() : array

Response

array

getDateFormat

getDateFormat() : string

Response

string

getFormattedDateCreated

getFormattedDateCreated() : string

Response

string

getIsSubmitted

getIsSubmitted() : boolean|string

Response

boolean|string

false or submit date

getIsSubmittedHtml

getIsSubmittedHtml() : string

Response

string

getLastInvited

getLastInvited() : string

Response

string

getLastReminded

getLastReminded() : string

Response

string

getLinkInfo

getLinkInfo(integer $participantId) : array<mixed,\CActiveRecord>

Arguments

$participantId

integer

Response

array<mixed,\CActiveRecord>

Return the max value for a field

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

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

Throws
\Exception

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|integer

Return the min value for a field

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

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

Throws
\Exception

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|integer

getSurveyName

getSurveyName() : string

Response

string

// TODO this should be in survey model

getTokenDynamicModel

getTokenDynamicModel() : \TokenDynamic

Response

\TokenDynamic

model

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

Arguments

$class

Response

\SurveyLink

primaryKey

primaryKey() 
inheritdoc

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

boolean

Response

mixed

the AR objects populated with the query result

rebuildLinksFromTokenTable

rebuildLinksFromTokenTable(integer $iSurveyId) : \CDbDataReader

Arguments

$iSurveyId

integer

Response

\CDbDataReader

relations

relations() 
inheritdoc

tableName

tableName() 
inheritdoc

Properties

participant_id

participant_id : integer

Type(s)

integer

token_id

token_id : integer

Type(s)

integer

survey_id

survey_id : integer

Type(s)

integer

date_created

date_created : string

Type(s)

string

date_invited

date_invited : string

Type(s)

string

date_completed

date_completed : string

Type(s)

string

participant

participant : \Participant

Type(s)

\Participant

survey

survey : \Survey

Type(s)

\Survey

dateFormat

dateFormat : string

Type(s)

string

isSubmitted

isSubmitted : string|boolean

Type(s)

string|boolean

checkbox

checkbox : string

Type(s)

string

columns

columns : array

Type(s)

array

lastInvited

lastInvited : string

Type(s)

string

lastReminded

lastReminded : string

Type(s)

string