SurveysGroupsettings

Extends\LSActiveRecord

This is the model class for table "{{surveys_groupsettings}}".

The followings are the available columns in table '{{surveys_groupsettings}}':

package

Default

Methods

attributeLabels

attributeLabels(): array

Response

array

customized attribute labels (name=>label)

Lists the behaviors of this model

behaviors(): array
inherited

Below is a list of all behaviors we register:

see \CTimestampBehavior\PluginEventBehavior

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 = '')
inheritedstatic

Arguments

$value

string

String value which needs to be decrypted

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.

dispatchPluginModelEvent

dispatchPluginModelEvent(string $sEventName,\CDbCriteria $criteria = null,array $eventParams = array(): \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 decrypted

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

static|null

the record found. Null if none is found.

getAllEncryptedAttributes

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

Arguments

$iSurveyId

integer

$sClassName

string

Response

array

Recursive function

getInstance(integer $iSurveyGroupId,null $oSurvey = null,null $instance = null,integer $iStep = 1,boolean $bRealValues = false): \SurveysGroupsettings
static

Gets the real values for a group. A group could inherit from a group, this one could inherit from a group ... It steps up (see param $iStep) until it has found the real settings ...

Arguments

$iSurveyGroupId

integer

$oSurvey

null

$instance

null

$iStep

integer

this is inheritance step (recursive step) (parent, parentParent, parentParentParent ?)

$bRealValues

boolean

Response

\SurveysGroupsettings

instance

getIsActive

getIsActive(): boolean

Response

boolean

getIsAnonymized

getIsAnonymized(): boolean

Response

boolean

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

Returns the static model of the specified AR class.

model(string $className = __CLASS__): \SurveysGroupsettings
static

Please note that you should have this exact method in all your CActiveRecord descendants!

Arguments

$className

string

active record class name.

Response

\SurveysGroupsettings

the static model class

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(): array

Response

array

relational rules.

rules

rules(): array

Response

array

validation rules for model attributes.

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

Gets the "values" from the group that inherits to this group and .

setOptions()

..

... sets the variables (not DB attributes) of "oOptions", "oOptionLabels", "aOptions" and "showInherited" (most of them used for frontend i think)

setToDefault

setToDefault()

setToInherit

setToInherit()

tableName

tableName(): string

Response

string

the associated database table name

translateOptionLabels

translateOptionLabels( $instance, $attribute, $value): string
static

Arguments

$instance

$attribute

$value

Response

string

Properties

oOptions

oOptions :

Type(s)

oOptionLabels

oOptionLabels :

Type(s)

aOptions

aOptions :

Type(s)

optionAttributes

optionAttributes :

Type(s)

optionAttributesInteger

optionAttributesInteger :

Type(s)

optionAttributesChar

optionAttributesChar :

Type(s)

optionAttributesText

optionAttributesText :

Type(s)

showInherited

showInherited :

Type(s)

active

active :

Type(s)

additional_languages

additional_languages :

Type(s)

bEncryption

bEncryption :
inherited

Type(s)

gsid

gsid :integer

Type(s)

integer

owner_id

owner_id :integer

Type(s)

integer

admin

admin :string

Type(s)

string

expires

expires :string

Type(s)

string

startdate

startdate :string

Type(s)

string

adminemail

adminemail :string

Type(s)

string

anonymized

anonymized :string

Type(s)

string

format

format :string

Type(s)

string

savetimings

savetimings :string

Type(s)

string

template

template :string

Type(s)

string

datestamp

datestamp :string

Type(s)

string

usecookie

usecookie :string

Type(s)

string

allowregister

allowregister :string

Type(s)

string

allowsave

allowsave :string

Type(s)

string

autonumber_start

autonumber_start :integer

Type(s)

integer

autoredirect

autoredirect :string

Type(s)

string

allowprev

allowprev :string

Type(s)

string

printanswers

printanswers :string

Type(s)

string

ipaddr

ipaddr :string

Type(s)

string

refurl

refurl :string

Type(s)

string

datecreated

datecreated :string

Type(s)

string

showsurveypolicynotice

showsurveypolicynotice :integer

Type(s)

integer

publicstatistics

publicstatistics :string

Type(s)

string

publicgraphs

publicgraphs :string

Type(s)

string

listpublic

listpublic :string

Type(s)

string

htmlemail

htmlemail :string

Type(s)

string

sendconfirmation

sendconfirmation :string

Type(s)

string

tokenanswerspersistence

tokenanswerspersistence :string

Type(s)

string

assessments

assessments :string

Type(s)

string

usecaptcha

usecaptcha :string

Type(s)

string

bounce_email

bounce_email :string

Type(s)

string

attributedescriptions

attributedescriptions :string

Type(s)

string

emailresponseto

emailresponseto :string

Type(s)

string

emailnotificationto

emailnotificationto :string

Type(s)

string

tokenlength

tokenlength :integer

Type(s)

integer

showxquestions

showxquestions :string

Type(s)

string

showgroupinfo

showgroupinfo :string

Type(s)

string

shownoanswer

shownoanswer :string

Type(s)

string

showqnumcode

showqnumcode :string

Type(s)

string

showwelcome

showwelcome :string

Type(s)

string

showprogress

showprogress :string

Type(s)

string

questionindex

questionindex :integer

Type(s)

integer

navigationdelay

navigationdelay :integer

Type(s)

integer

nokeyboard

nokeyboard :string

Type(s)

string

alloweditaftercompletion

alloweditaftercompletion :string

Type(s)

string

ipanonymize

ipanonymize :string

Type(s)

string