LimeSurvey API - Master branch
Back to top  

TokenDynamic

Extends\LSActiveRecord

Class TokenDynamic

package

Default

Methods

beforeSave

beforeSave()
inheritdoc

Lists the behaviors of this model

behaviors(): array
inherited

Below is a list of all behaviors we register:

see \PluginEventBehavior\CTimestampBehavior

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 survey participants table / backup survey participants table

countAllAndCompleted

countAllAndCompleted(integer $sid): mixed
static

Arguments

$sid

integer

Survey ID

Response

mixed

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

createToken(integer $iTokenID): string

Arguments

$iTokenID

integer

Response

string

token string

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

createTokens(integer $iSurveyID): array<mixed,integer>

Arguments

$iSurveyID

integer

Response

array<mixed,integer>

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

Decrypt values from database

decrypt( $value = '')
inherited

Arguments

$value

Encrypt/decrypt values

decryptEncryptAttributes( $action = 'decrypt')
inherited

Arguments

$action

Decrypt single value

decryptSingle(string $value = ''): string
inheritedstatic

Arguments

$value

string

String value which needs to be decrypted

Response

string

the decrypted string

Decrypt single value

decryptSingleOld(string $value = ''): string
inheritedstatic

Arguments

$value

string

String value which needs to be decrypted

Response

string

the decrypted string

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.

deleteRecords

deleteRecords(array<mixed,integer> $iTokenIds): integer

Arguments

$iTokenIds

array<mixed,integer>

Response

integer

the number of rows deleted

deleteToken

deleteToken(integer $tokenid): integer

Arguments

$tokenid

integer

Response

integer

the number of rows deleted

dispatchPluginModelEvent

dispatchPluginModelEvent(string $sEventName,\CDbCriteria $criteria = null,array $eventParams = []): \PluginEvent
inherited

Arguments

$sEventName

string

$criteria

\CDbCriteria

$eventParams

array

Response

\PluginEvent

Encrypt values

encrypt()
inherited

Attribute values are encrypted ( if needed )to be used for searching purposes

encryptAttributeValues(array $attributes = null, $bEncryptedOnly = false, $bReplaceValues = true): array
inherited

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.

$bEncryptedOnly

$bReplaceValues

Response

array

attributes array with encrypted atrribute values is returned

Encrypt values before saving to the database

encryptSave( $runValidation = false)
inherited

Arguments

$runValidation

Enrypt single value

encryptSingle(string $value = '')
inheritedstatic

Arguments

$value

string

String value which needs to be encrypted

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

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

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

Overriding of Yii's findAllByAttributes method to provide encrypted attribute value search

findAllByAttributes(array $attributes,mixed $condition = '',array $params = array()): array<mixed,static>
inherited

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

array<mixed,static>

the records found. An empty array is returned if none is found.

Overriding of Yii's findByAttributes method to provide encrypted attribute value search

findByAttributes(array $attributes,mixed $condition = '',array $params = array()): static|null
inherited

Arguments

$attributes

array

list of attribute values (indexed by attribute names) that the active record 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

static|null

the record found. Null if none is found.

findUninvited

findUninvited(array<mixed,integer>|boolean $aTokenIds = false,integer $iMaxEmails,boolean $bEmail = true,string $SQLemailstatuscondition = '',string $SQLremindercountcondition = '',string $SQLreminderdelaycondition = ''): array<mixed,\CActiveRecord>

Arguments

$aTokenIds

array<mixed,integer>|boolean

$iMaxEmails

integer

$bEmail

boolean

$SQLemailstatuscondition

string

$SQLremindercountcondition

string

$SQLreminderdelaycondition

string

Response

array<mixed,\CActiveRecord>

findUninvitedIDs

findUninvitedIDs(array<mixed,integer>|boolean $aTokenIds = false,integer $iMaxEmails,boolean $bEmail = true,string $SQLemailstatuscondition = '',string $SQLremindercountcondition = '',string $SQLreminderdelaycondition = ''): array|\CDbDataReader

Arguments

$aTokenIds

array<mixed,integer>|boolean

$iMaxEmails

integer

$bEmail

boolean

$SQLemailstatuscondition

string

$SQLremindercountcondition

string

$SQLreminderdelaycondition

string

Response

array|\CDbDataReader

getAllEncryptedAttributes

getAllEncryptedAttributes(integer $iSurveyId,string $sClassName): array
inherited

Arguments

$iSurveyId

integer

$sClassName

string

Response

array

TODO: Should be split into seperate functions in the appropiate model or helper class TODO: Make an interface for records that support encryption.

getAttributesForGrid

getAttributesForGrid(): array

Response

array

getbuttons

getbuttons(): string
deprecated

Response

string

getCompletedFormated

getCompletedFormated(): string

Response

string

getCustom_attributes

getCustom_attributes()

getEmailFormated

getEmailFormated(): string

Response

string

getEmailStatus

getEmailStatus(string $token): mixed

Arguments

$token

string

Response

mixed

getEmailstatusFormated

getEmailstatusFormated(): string

Response

string

Return the buttons columns

getGridButtons(): array
see https://www.yiiframework.com/doc/api/1.1/CButtonColumnhttps://bugs.limesurvey.org/view.php?id=14219https://bugs.limesurvey.org/view.php?id=14222:

When deleting a single response : all page is reloaded (not only grid)

Response

array

getHasResponses

getHasResponses( $sToken): mixed

Arguments

$sToken

Response

mixed

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

getRemindersentFormated

getRemindersentFormated(): string

Response

string

getSentFormated

getSentFormated(): string

Response

string

getStandardCols

getStandardCols(): array<mixed,string>

Response

array<mixed,string>

getStandardColsForGrid

getStandardColsForGrid(): array

Response

array

Get current surveyId for other model/function

getSurveyId(): integer

Response

integer

getValidfromFormated

getValidfromFormated(): string

Response

string

getValiduntilFormated

getValiduntilFormated(): string

Response

string

getYesNoDateFormated

getYesNoDateFormated(string $field): string

Arguments

$field

string

Response

string

insertParticipant

insertParticipant( $data): boolean|integer

Arguments

$data

Response

boolean|integer

insertToken

insertToken(integer $iSurveyID,array $data): integer

Arguments

$iSurveyID

integer

$data

array

Response

integer

model

model(\?string $sid = null): \TokenDynamic
static
inheritdoc
psalm-suppress

ParamNameMismatch Ignore that $sid is $className in parent class

Arguments

$sid

\?string

Response

\TokenDynamic

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

relations

relations()
inheritdoc

rules

rules()
inheritdoc
see \Token::model()->rules

search

search(): \CActiveDataProvider

Response

\CActiveDataProvider

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

selectEmptyTokens(integer $iSurveyID): array

Arguments

$iSurveyID

integer

Response

array

Function to show encryption symbol in gridview attribute header if value ois encrypted

setEncryptedAttributeLabel(integer $surveyId,string $className,string $attributeName): string
inherited
Throws
\CException

Arguments

$surveyId

integer

$className

string

$attributeName

string

Response

string

Sets the survey ID for the next model

sid(integer $sid): void
static
static
access

public

Arguments

$sid

integer

tableName

tableName()
inheritdoc

Updates records with the specified condition.

updateAll(array $attributes,mixed $condition = '',array $params = array()): integer
inherited

XSS filtering is enforced for attributes listed in model's $xssFilterAttributes property. See \find() for detailed explanation about $condition and $params. Note, the attributes are not checked for safety and no validation is done.

Arguments

$attributes

array

list of attributes (name=>$value) to be updated

$condition

mixed

query condition or criteria.

$params

array

parameters to be bound to an SQL statement.

Response

integer

the number of rows being updated

updateEmailStatus

updateEmailStatus(string $token,string $status): integer

Arguments

$token

string

$status

string

Response

integer

updateToken

updateToken(integer $tid,string $newToken): integer

Arguments

$tid

integer

$newToken

string

Response

integer

Properties

sid

sid :integer
static
var

Type(s)

integer

Default value for email status

emailstatus :string
var

Default value for email status

Type(s)

string

Array of attributes that should be XSS filtered on mass updates

xssFilterAttributes :array<mixed,string>
inherited
var

Array of attributes that should be XSS filtered on mass updates

Type(s)

array<mixed,string>

bEncryption

bEncryption :
inherited

Type(s)

tid

tid :integer

Type(s)

integer

participant_id

participant_id :string

Type(s)

string

firstname

firstname :string

Type(s)

string

lastname

lastname :string

Type(s)

string

email

email :string

Type(s)

string

emailstatus

emailstatus :string

Type(s)

string

token

token :string

Type(s)

string

language

language :string

Type(s)

string

blacklisted

blacklisted :string

Type(s)

string

sent

sent :string

Type(s)

string

remindersent

remindersent :string

Type(s)

string

remindercount

remindercount :integer

Type(s)

integer

completed

completed :string

Type(s)

string

usesleft

usesleft :integer

Type(s)

integer

validfrom

validfrom :string

Type(s)

string

validuntil

validuntil :string

Type(s)

string

mpid

mpid :integer

//TODO Describe me!

Type(s)

integer

survey

survey :\Survey

Type(s)

\Survey

responses

responses :array<mixed,\SurveyDynamic>

Type(s)

array<mixed,\SurveyDynamic>

standardCols

standardCols :array

Type(s)

array

standardColsForGrid

standardColsForGrid :array

Type(s)

array

custom_attributes

custom_attributes :array

Type(s)

array