Token

Extends \Dynamic

For code completion we add the available scenario's here Attributes

In this implementation class definitions are generated dynamically. This class and its descendants should be declared abstract!

Methods

attributeLabels

attributeLabels() 

beforeDelete

beforeDelete() 

createTable

createTable($surveyId, array $extraFields = array()) 
static

Arguments

$surveyId

$extraFields

array

findByToken

findByToken($token) 

Arguments

$token

Generates a token for this object.

generateToken() 
throws

Creates a random token string without special characters

generateRandomToken(mixed $iTokenLength) 
static

Arguments

$iTokenLength

mixed

Sanitize token show to the user (replace sanitize_helper sanitize_token)

sanitizeToken($token) : string
static

Arguments

$token

Response

string

sanitized token

Generates a token for all token objects in this survey.

generateTokens() 

Syntax: Token::model(12345)->generateTokens();

model

model(\type $className = null) : \Dynamic
inherited static

Arguments

$className

\type

Response

\Dynamic

create

create(integer $id, $scenario = 'insert') 
inherited static

Arguments

$id

integer

$scenario

relations

relations() 

save

save($runValidation = true, $attributes = null) 

Arguments

$runValidation

$attributes

rules

rules() 

scopes

scopes() 

summary

summary() 

tableName

tableName() 

__construct

__construct($scenario = 'insert') 
inherited

Arguments

$scenario

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.

incomplete

incomplete() : \Token

Select only uncompleted tokens

Response

\Token

usable

usable() : \Token

Select usable tokens: valid daterange and userleft > 0

Response

\Token

Properties

Prefixed with _ to not collide with column names.

dynamicId : int
inherited
var

The dynamic part of the class name.

Type(s)

int

tid

tid : int

Type(s)

int

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 : int

Type(s)

int

completed

completed : string

Type(s)

string

usesleft

usesleft : int

Type(s)

int

validfrom

validfrom : \DateTime

Type(s)

\DateTime

validuntil

validuntil : \DateTime

Relations

Type(s)

\DateTime

survey

survey : \Survey

The survey this token belongs to. Scopes

Type(s)

\Survey