LimeSurvey API - Master branch
Back to top  

QuestionTheme

Extends\LSActiveRecord

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

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

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 \PluginEventBehavior\CTimestampBehavior

Response

array

Converts LS3 Question Theme to LS5

convertLS3toLS5(string $sXMLDirectoryPath): array
static

Arguments

$sXMLDirectoryPath

string

Response

array

$success Returns an array with the conversion status

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.

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.

Returns all Question Meta Data for the question type selector

findAllQuestionMetaDataForSelector(): array<mixed,\QuestionTheme>
static

Response

array<mixed,\QuestionTheme>

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.

Returns all QuestionTheme settings

findQuestionMetaData(string $question_type,string $question_theme_name = null,string $language = ''): \QuestionTheme
static

Arguments

$question_type

string

$question_theme_name

string

$language

string

Response

\QuestionTheme

Returns all base question themes as an array indexed by question type (all entries in table question_themes extends='')

findQuestionMetaDataForAllTypes(): \array<string,
static

Response

\array

QuestionTheme>

Gets the additional attributes for an extended theme from xml file.

getAdditionalAttrFromExtendedTheme(string $sQuestionThemeName,string $type): array
static

If there are no attributes, an empty array is returned

Arguments

$sQuestionThemeName

string

the question theme name (see table question theme "name")

$type

string

the extended typ (see table question_themes "extends")

Response

array

additional attributes for an extended theme or empty array

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.

Returns an array of all question themes and their metadata, split into available_themes and broken_themes

getAllQuestionMetaData(boolean $core = true,boolean $custom = true,boolean $user = true): array
todo

Move to service class

Arguments

$core

boolean

$custom

boolean

$user

boolean

Response

array

Find all XML paths for specified Question Root folders

getAllQuestionXMLPaths(boolean $core = true,boolean $custom = true,boolean $user = true): array
static

Arguments

$core

boolean

$custom

boolean

$user

boolean

Response

array

Returns the table definition for the current Question

getAnswerColumnDefinition(string $name,string $type): string
static

Arguments

$name

string

$type

string

Response

string

mixed

Returns question themes available in the filesystem AND installed in the database

getAvailableQuestionThemes(): array
Throws
\Exception

Response

array

Returns the name of the base question theme for the question type $questionType

getBaseThemeNameForQuestionType(string $questionType): string|null

Arguments

$questionType

string

Response

string|null

question theme name or null if no question theme is found

Returns the settings attribute decoded

getDecodedSettings(): mixed

Response

mixed

Returns a dummy instance of QuestionTheme, with the question type $questionType.

getDummyInstance(string $questionType): \QuestionTheme
static

Arguments

$questionType

string

Response

\QuestionTheme

Install Button for the available questions

getManifestButtons()

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

Returns QuestionMetaData Array for use in ->save operations

getMetaDataArray(array $questionMetaData): array
static
todo

Naming is wrong, it does not "get", it "convertTo"

Possibly make a DTO for question metadata instead, and implement the ArrayAccess interface or "toArray()"

Arguments

$questionMetaData

array

Response

array

$questionMetaData

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

Read all the MetaData for given Question XML definition

getQuestionMetaData(string $pathToXmlFolder): array
static
todo

Replace assoc array with DTO
Throws
\Exception

Arguments

$pathToXmlFolder

string

Response

array

Question Meta Data

Return the question theme custom attributes values -- gets coreAttributes from xml-file -- gets additional attributes from extended theme (if theme is extended) -- gets "own" attributes via plugin

getQuestionThemeAttributeValues(string $type,string $sQuestionThemeName = null): array
static
Throws
\Exception

when question type attributes are not available

Arguments

$type

string

question type (this is the attribute 'question_type' in table question_theme)

$sQuestionThemeName

string

: question theme name

Response

array

: the attribute settings for this question type

getQuestionThemeDirectories

getQuestionThemeDirectories(): array
static

Response

array

Return the question Theme preview URL

getQuestionThemeImageName( $sType = null): string
static

Arguments

$sType

: type of question

Response

string

: question theme preview URL

Returns the Config Path for the selected Question Type base definition

getQuestionXMLPathForBaseType(string $type): string
static
Throws
\CException

Arguments

$type

string

Response

string

Path to config XML

getThemeDirectoryPath

getThemeDirectoryPath( $sQuestionConfigFilePath)
static

Arguments

$sQuestionConfigFilePath

Returns visibility button.

getVisibilityButton(): string|array

Response

string|array

Import config manifest to database.

importManifest(string $sXMLDirectoryPath,boolean $bSkipConversion = false, $bThrowConversionException = false): boolean|string
todo

Please never redirect at this level, only from controllers.
Throws
\Exception

Arguments

$sXMLDirectoryPath

string

the relative path to the Question Theme XML directory

$bSkipConversion

boolean

If converting should be skipped

$bThrowConversionException

If true, throws exception instead of redirecting

Response

boolean|string

Returns the static model of the specified AR class.

model(string $className = __CLASS__): static
static

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

Arguments

$className

string

active record class name.

Response

static

Returns this table's primary key

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

relations

relations(): array

Response

array

relational rules.

rules

rules(): array

Response

array

validation rules for model attributes.

scopes

scopes()
inheritdoc

Retrieves a list of models based on the current search/filter conditions.

search(): \CActiveDataProvider

Typical usecase:

  • Initialize the model fields with values from filter form.
  • Execute this method to get CActiveDataProvider instance which will filter models according to data in model fields.
  • Pass data provider to CGridView, CListView or any similar widget.

Response

\CActiveDataProvider

the data provider that can return the models based on the search/filter conditions.

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

Response

string

the associated database table name

uninstall

uninstall(\QuestionTheme $oQuestionTheme): array|false
static
todo

move actions to its controller and split between controller and model, related search for: 1573123789741

Move to QuestionThemeInstaller

Arguments

$oQuestionTheme

\QuestionTheme

Response

array|false

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

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)

id

id :integer

Type(s)

integer

name

name :string

Type(s)

string

visible

visible :string

Type(s)

string

xml_path

xml_path :string

Type(s)

string

image_path

image_path :string

Type(s)

string

title

title :string

Type(s)

string

creation_date

creation_date :string

Type(s)

string

author

author :string

Type(s)

string

author_email

author_email :string

Type(s)

string

author_url

author_url :string

Type(s)

string

copyright

copyright :string

Type(s)

string

license

license :string

Type(s)

string

version

version :string

Type(s)

string

api_version

api_version :string

Type(s)

string

description

description :string

Type(s)

string

last_update

last_update :string

Type(s)

string

owner_id

owner_id :integer

Type(s)

integer

theme_type

theme_type :string

Type(s)

string

question_type

question_type :string

Type(s)

string

core_theme

core_theme :integer

Type(s)

integer

extends

extends :string

Type(s)

string

group

group :string

Type(s)

string

settings

settings :string

Type(s)

string