LimeSurvey API - Master branch
Back to top  

SurveyLanguageSetting

Extends\LSActiveRecord

Class SurveyLanguageSetting

package

Default

Methods

Defines the customs validation rule attachmentsInfo

attachmentsInfo(mixed $attribute)

Arguments

$attribute

mixed

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

defaultScope

defaultScope()
inheritdoc

Pass this to all findAll query : indexed by surveyls_language : return only one survey id
see https://www.yiiframework.com/doc/api/1.1/CActiveRecord#defaultScope-detail

Remind to use resetScope if you need to disable this behaviour

https://www.yiiframework.com/doc/api/1.1/CActiveRecord#resetScope-detail

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 = []): \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 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

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

getAllSurveys

getAllSurveys(boolean $hasPermission = false): mixed

Arguments

$hasPermission

boolean

Response

mixed

Returns the token's captions

getAttributeCaptions(): array
access

public

Response

array

getDateFormat

getDateFormat(integer $surveyid,string $languagecode): mixed

Arguments

$surveyid

integer

$languagecode

string

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

insertNewSurvey

insertNewSurvey(array $data): boolean
todo

: rename and fix this

Arguments

$data

array

Response

boolean

insertSomeRecords

insertSomeRecords(array $data): boolean

Arguments

$data

array

Response

boolean

Defines the customs validation rule lsdefault

lsdefault(mixed $attribute)

Arguments

$attribute

mixed

model

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

Arguments

$className

Response

\SurveyLanguageSetting

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

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

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

Updates a single record identified by $condition with the key/value pairs in the $data array.

updateRecord(array $data,string|array $condition = '',boolean $xssfiltering = false): boolean

Arguments

$data

array

$condition

string|array

$xssfiltering

boolean

Response

boolean

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)

surveyls_survey_id

surveyls_survey_id :integer

Survey ID

Type(s)

integer

surveyls_language

surveyls_language :string

Language code eg "en"

Type(s)

string

surveyls_title

surveyls_title :string

Survey title in this language

Type(s)

string

surveyls_description

surveyls_description :string

Survey description in this language

Type(s)

string

surveyls_welcometext

surveyls_welcometext :string

Survey welcome-text in this language

Type(s)

string

surveyls_endtext

surveyls_endtext :string

Survey end-text in this language

Type(s)

string

surveyls_policy_notice

surveyls_policy_notice :string

The survey data-security notice

Type(s)

string

surveyls_url

surveyls_url :string

Survey end-url for this language

Type(s)

string

surveyls_urldescription

surveyls_urldescription :string

Survey end-url description for this language

Type(s)

string

surveyls_email_invite_subj

surveyls_email_invite_subj :string

Survey inivitation e-mail subject for this language

Type(s)

string

surveyls_email_invite

surveyls_email_invite :string

Survey inivitation e-mail body in this language

Type(s)

string

surveyls_email_remind_subj

surveyls_email_remind_subj :string

Survey reminder e-mail subject for this language

Type(s)

string

surveyls_email_remind

surveyls_email_remind :string

Survey reminder e-mail body in this language

Type(s)

string

surveyls_email_register_subj

surveyls_email_register_subj :string

Survey registration e-mail subject for this language

Type(s)

string

surveyls_email_register

surveyls_email_register :string

Survey registration e-mail body in this language

Type(s)

string

surveyls_email_confirm_subj

surveyls_email_confirm_subj :string

Survey confirmation e-mail subject for this language

Type(s)

string

surveyls_email_confirm

surveyls_email_confirm :string

Survey confitmation e-mail body in this language

Type(s)

string

surveyls_dateformat

surveyls_dateformat :string

Type(s)

string

surveyls_attributecaptions

surveyls_attributecaptions :string

Type(s)

string

surveyls_admin_notification_subj

surveyls_admin_notification_subj :string

Subject of basic admin notification e-mail in this language

Type(s)

string

surveyls_admin_notification

surveyls_admin_notification :string

Body of basic admin notification e-mail in this language

Type(s)

string

surveyls_admin_responses_subj

surveyls_admin_responses_subj :string

Subject of detailed admin notification e-mail in this language

Type(s)

string

surveyls_admin_responses

surveyls_admin_responses :string

Body of detailed admin notification e-mail in this language

Type(s)

string

surveyls_numberformat

surveyls_numberformat :integer

Survey decimal mark for this language (0: '.', 1: ',')

Type(s)

integer

attachments

attachments :string

Type(s)

string

survey

survey :\Survey

Type(s)

\Survey

owner

owner :\User

Type(s)

\User