TokenDynamic

Extends \LSActiveRecord

Methods

Returns the static model of Settings table

model($sid = NULL) : \TokenDynamic
static
static
access

public

Arguments

$sid

Response

\TokenDynamic

Sets the survey ID for the next model

sid(int $sid) : void
static
static
access

public

Arguments

$sid

int

Returns the setting's table name to be used by the model

tableName() : string
access

public

Response

string

Returns the primary key of this table

primaryKey() : string
access

public

Response

string

Returns this model's validation rules

rules() 

Returns this model's relations

relations() : array
access

public

Response

array

Checks to make sure that all required columns exist in this tokens table (some older tokens tables dont' get udated properly)

checkColumns() 

This method should be moved to db update for 2.05 version so it runs only once per token table / backup token table

findUninvited

findUninvited($aTokenIds = false, $iMaxEmails, $bEmail = true, $SQLemailstatuscondition = '', $SQLremindercountcondition = '', $SQLreminderdelaycondition = '') 

Arguments

$aTokenIds

$iMaxEmails

$bEmail

$SQLemailstatuscondition

$SQLremindercountcondition

$SQLreminderdelaycondition

findUninvitedIDs

findUninvitedIDs($aTokenIds = false, $iMaxEmails, $bEmail = true, $SQLemailstatuscondition = '', $SQLremindercountcondition = '', $SQLreminderdelaycondition = '') 

Arguments

$aTokenIds

$iMaxEmails

$bEmail

$SQLemailstatuscondition

$SQLremindercountcondition

$SQLreminderdelaycondition

insertParticipant

insertParticipant($data) 

Arguments

$data

insertToken

insertToken($iSurveyID, $data) 

Arguments

$iSurveyID

$data

updateToken

updateToken($tid, string $newtoken) 

Arguments

$tid

$newtoken

string

Retrieve an array of records with an empty token, in the result is just the id (tid)

selectEmptyTokens(int $iSurveyID) : array

Arguments

$iSurveyID

int

Response

array

countAllAndCompleted

countAllAndCompleted($sid) 
static

Arguments

$sid

Creates and inserts token for a specific token record and returns the token string created

createToken(int $iTokenID) : string

Arguments

$iTokenID

int

Response

string

token string

Creates tokens for all token records that have empty token fields and returns the number of tokens created

createTokens(int $iSurveyID) : integer[]

Arguments

$iSurveyID

int

Response

integer[]

( int number of created tokens, int number to be created tokens)

This method is invoked before saving a record (after validation, if any).

beforeSave() : boolean

The default implementation raises the {@link onBeforeSave} event. You may override this method to do any preparation work for record saving. Use {@link isNewRecord} to determine whether the saving is for inserting or updating record. Make sure you call the parent implementation so that the event is raised properly.

Response

boolean

whether the saving should be executed. Defaults to true.

deleteToken

deleteToken($tokenid) 

Arguments

$tokenid

deleteRecords

deleteRecords($iTokenIds) 

Arguments

$iTokenIds

getEmailStatus

getEmailStatus($token) 

Arguments

$token

updateEmailStatus

updateEmailStatus($token, $status) 

Arguments

$token

$status

getStandardCols

getStandardCols() 

getCustom_attributes

getCustom_attributes() 

getSentFormated

getSentFormated() 

getRemindersentFormated

getRemindersentFormated() 

getCompletedFormated

getCompletedFormated() 

getValidfromFormated

getValidfromFormated() 

getValiduntilFormated

getValiduntilFormated() 

getYesNoDateFormated

getYesNoDateFormated($field) 

Arguments

$field

getEmailFormated

getEmailFormated() 

getEmailstatusFormated

getEmailstatusFormated() 

getStandardColsForGrid

getStandardColsForGrid() 

getAttributesForGrid

getAttributesForGrid() 

getbuttons

getbuttons() 

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

sid

sid : 
static

emailstatus

emailstatus :