Condition

Extends\LSActiveRecord

Class Condition

package

Default

Methods

Lists the behaviors of this model

behaviors(): array
inherited

Below is a list of all behaviors we register:

see \PluginEventBehavior\CTimestampBehavior

Response

array

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(boolean|mixed $condition = false): integer

Arguments

$condition

boolean|mixed

Response

integer

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.

getAllCfieldnameWithDependenciesForOneSurvey

getAllCfieldnameWithDependenciesForOneSurvey(integer $sid): mixed

Arguments

$sid

integer

Response

mixed

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.

getConditionCount

getConditionCount(integer $qid,string $language,\Condition $scenarionr): integer

Arguments

$qid

integer

$language

string

$scenarionr

\Condition

Response

integer

getConditionCountToken

getConditionCountToken(integer $qid,\Condition $scenarionr): integer
Throws
\CException

Arguments

$qid

integer

$scenarionr

\Condition

Response

integer

getConditions

getConditions(integer $qid, $language,\Condition $scenarionr): array

Arguments

$qid

integer

$language

$scenarionr

\Condition

Response

array

getConditionsQuestions

getConditionsQuestions( $distinctrow, $deqrow, $scenariorow, $surveyprintlang)

Arguments

$distinctrow

$deqrow

$scenariorow

$surveyprintlang

getConditionsToken

getConditionsToken(integer $qid,\Condition $scenarionr): \CDbDataReader

Arguments

$qid

integer

$scenarionr

\Condition

Response

\CDbDataReader

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

getScenarios

getScenarios(integer $qid): \CDbDataReader

Arguments

$qid

integer

Response

\CDbDataReader

getSomeConditions

getSomeConditions(array $fields,mixed $condition,string $order,array $group): \CDbDataReader

Arguments

$fields

array

$condition

mixed

$order

string

$group

array

Response

\CDbDataReader

insertRecords

insertRecords( $data, $update = false, $condition = false)

Arguments

$data

$update

$condition

model

model( $className = __CLASS__): \Condition
static
inheritdoc

Arguments

$className

Response

\Condition

Returns the primary key of this table

primaryKey(): string
access

public

Response

string

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

Defines the relations for this model

relations(): array
access

public

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

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

tableName(): string
access

public

Response

string

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

Updates the group ID for all conditions

updateCFieldName(integer $iSurveyID,integer $iQuestionID,integer $iOldGroupID,integer $iNewGroupID)

Arguments

$iSurveyID

integer

$iQuestionID

integer

$iOldGroupID

integer

$iNewGroupID

integer

Properties

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)

cid

cid :integer

ID (primary key)

Type(s)

integer

qid

qid :integer

Question id (subquestion)

Type(s)

integer

cqid

cqid :integer

Question id (grouping question)

Type(s)

integer

cfieldname

cfieldname :string

Condition field-name as SGQA identifier

Type(s)

string

method

method :string

Logical operator see here

Type(s)

string

value

value :string

Value to be compared against

Type(s)

string

scenario

scenario :integer

Scenario number

Type(s)

integer

questions

questions :\Question

Type(s)

\Question