LimeSurvey API - Master branch
Back to top  

QuestionGroup

Extends\LSActiveRecord

Class QuestionGroup

package

Default

Methods

Make sure we don't save a new question group while the survey is active.

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

cleanOrder

cleanOrder( $surveyid)

Arguments

$surveyid

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.

deleteWithDependency

deleteWithDependency(integer $groupId,integer $surveyId): integer|null
static

Arguments

$groupId

integer

$surveyId

integer

Response

integer|null

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.

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.

getAllGroups

getAllGroups(mixed|array $condition,array<mixed,string>|false $order = false): \CDbDataReader

Arguments

$condition

mixed|array

$order

array<mixed,string>|false

Response

\CDbDataReader

Returns all group questions (including subquestions)

getAllQuestions(): array<mixed,\Question>

Response

array<mixed,\Question>

getbuttons

getbuttons(): string

Response

string

Returns the first question group in the survey

getFirstGroup(integer $surveyId): \QuestionGroup
static

Arguments

$surveyId

integer

Response

\QuestionGroup

Get group description

getGroupDescription(integer $iGroupId,string $sLanguage): string

Arguments

$iGroupId

integer

$sLanguage

string

Response

string

Get the internationalized group description from the L10N Table

getGroupDescriptionI10N(string $sLanguage): string

Arguments

$sLanguage

string

Response

string

Get the internationalized group name from the L10N Table

getGroupNameI10N(string $sLanguage): string

Arguments

$sLanguage

string

Response

string

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

getPrimaryDescription

getPrimaryDescription()

getPrimaryTitle

getPrimaryTitle()

getQuestionIdsInGroup

getQuestionIdsInGroup(integer $groupId): array
static

Arguments

$groupId

integer

Response

array

getTotalGroupsWithoutQuestions

getTotalGroupsWithoutQuestions( $surveyid)
static

Arguments

$surveyid

Used in frontend helper, buildsurveysession.

getTotalGroupsWithQuestions(integer $surveyid): integer
static

Arguments

$surveyid

integer

Response

integer

Insert an array into the groups table Returns false if insertion fails, otherwise the new GID

insertRecords(array $data): boolean|integer
deprecated

at 2018-02-03 use $model->attributes = $data && $model->save()

Arguments

$data

array

Response

boolean|integer

model

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

Arguments

$className

Response

\QuestionGroup

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

search

search(): \CActiveDataProvider

Response

\CActiveDataProvider

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

updateGroupOrder

updateGroupOrder(integer $iSurveyId,integer $position)

Arguments

$iSurveyId

integer

$position

integer

Properties

aQuestions

aQuestions :

Type(s)

group_name

group_name :

Type(s)

language

language :

Type(s)

description

description :

Type(s)

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)

gid

gid :integer

ID

Type(s)

integer

sid

sid :integer

Survey ID

Type(s)

integer

group_order

group_order :integer

Group order number (max 100 chars)

Type(s)

integer

randomization_group

randomization_group :string

Randomization group

Type(s)

string

grelevance

grelevance :string

Group's relevane equation

Type(s)

string

survey

survey :\Survey

Type(s)

\Survey

questions

questions :array<mixed,\Question>

Questions without subquestions

Type(s)

array<mixed,\Question>

questiongroupl10ns

questiongroupl10ns :array<mixed,\QuestionGroupL10n>

Type(s)

array<mixed,\QuestionGroupL10n>