QuestionAttribute

todo	Should probably change question_attributes table to question_attribute_values
see	and participant_attribute_values
package	Default

Methods

Read question attributes from XML file and convert it to array

getGeneralAttibutesFromXml(string $sXmlFilePath): \?array

static

todo	What's the opposite of a "general" attribute? How many types of attributes are there?

Arguments

$sXmlFilePath

string

Path to XML

Response

\?array

The general attribute settings for this question type

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

New event to allow plugin to add own question attribute (settings)

getOwnQuestionAttributesViaPlugin(): array

static

Using $event->append('questionAttributes', $questionAttributes);

$questionAttributes=[ attributeName=>[ 'types' : Apply to this question type 'category' : Where to put it 'sortorder' : Qort order in this category 'inputtype' : type of input 'expression' : 2 to force Expression Manager when see the survey logic file (add { } and validate, 1 : allow it : validate in survey logic file 'options' : optional options if input type need it 'default' : the default value 'caption' : the label 'help' : an help ]

Response

array

the event attributes as array or an empty array

getQuestion

getQuestion(): \Question

Response

\Question

Returns Question attribute array name=>value --> returns result from emCache if it is set OR --> build the returned array and set the emCache to it

getQuestionAttributes(integer $iQuestionID,string $sLanguage = null): array|false

--get attributes from XML-Files --get additional attributes from extended theme --prepare an easier/smaller array to return

access	public
Throws	\CException throws exception if questiontype is null

Arguments

$iQuestionID

integer

$sLanguage

string

restrict to this language (if null $oQuestion->survey->allLanguages will be used)

Response

array|false

Return the question attribute settings for the passed type (parameter)

getQuestionAttributesSettings(string $sType,boolean $advancedOnly = false): array

static

Throws	\CException

Arguments

$sType

string

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

$advancedOnly

boolean

If true, only fetch advanced attributes

Response

array

: the attribute settings for this question type returns values from getGeneralAttributesFromXml and getAdvancedAttributesFromXml if this fails getAttributesDefinition and getDefaultSettings are returned

getQuestionsForStatistics

getQuestionsForStatistics(string $fields,mixed $condition,string|false $orderby = false): array

Arguments

$fields

string

$condition

mixed

$orderby

string|false

Response

array

Returns the value for attribute 'question_template'.

getQuestionTemplateValue( $questionID): string

static

Fetches the question_template from a question model.

Be carefull this attribute is not present in all questions. Even more, standard question types where question theme are not used (or custom question theme are not used), the attribute is missing. In those cases, the deault "core" is used.

deprecated	use $question->question_theme_name instead (Question model)

Arguments

$questionID

Response

string

question_template or 'core' if it not exists

getSurvey

getSurvey(): \Survey

Response

\Survey

model

model( $className = __CLASS__): static

static

Arguments

$className

Response

static

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
todo	Remove?

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

Set attributes for multiple questions

setMultiple( $iSid, $aQids, $aAttributesToUpdate, $aValidQuestionTypes)

NOTE: We can't use self::setQuestionAttribute() because it doesn't check for question types first. TODO: the question type check should be done via rules, or via a call to a question method

var	the sid to update (only to check permission) an array containing the list of primary keys for questions array containing the list of attributes to update the question types we can update for those attributes
todo	Missign noun in function name - set multiple what?

Arguments

$iSid

$aQids

$aAttributesToUpdate

$aValidQuestionTypes

setQuestionAttribute

setQuestionAttribute(integer $iQuestionID,string $sAttributeName,string $sValue): \CDbDataReader|boolean

todo	A function should not both set and get something; split into two functions

Arguments

$iQuestionID

integer

$sAttributeName

string

$sValue

string

Response

\CDbDataReader|boolean

setQuestionAttributeWithLanguage

setQuestionAttributeWithLanguage(integer $iQuestionID,string $sAttributeName,string $sValue,string $sLanguage): \CDbDataReader

todo	A function should not both set and get something; split into two functions

Arguments

$iQuestionID

integer

$sAttributeName

string

$sValue

string

$sLanguage

string

Response

\CDbDataReader

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

Properties

questionAttributesSettings

questionAttributesSettings :

static

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)

qaid

qaid :integer

ID Primary key

Type(s)

integer

qid

qid :integer

Question ID

Type(s)

integer

attribute

attribute :string

attribute name (max 50 chars)

Type(s)

string

value

value :string

Attribute value

Type(s)

string

language

language :string

Language code eg:'en'

Type(s)

string

question

question :\Question

Type(s)

\Question

survey

survey :\Survey

Type(s)

\Survey