Stud.IP  5.4
Freetext Class Reference
Inheritance diagram for Freetext:
QuestionnaireQuestion QuestionType SimpleORMap

Public Member Functions

 beforeStoringQuestiondata ($questiondata)
 
 getDisplayTemplate ()
 
 createAnswer ()
 
 getUserIdsOfFilteredAnswer ($answer_option)
 
 getResultTemplate ($only_user_ids=null)
 
 getResultArray ()
 
 onEnding ()
 
- Public Member Functions inherited from QuestionnaireQuestion
 getMyAnswer ($user_id=null)
 
 onBeginning ()
 
 onEnding ()
 
- Public Member Functions inherited from SimpleORMap
 __construct ($id=null)
 
 __clone ()
 
 getRelationOptions ($relation)
 
 getTableMetadata ()
 
 hasAutoIncrementColumn ()
 
 setId ($id)
 
 getId ()
 
 getNewId ()
 
 toArray ($only_these_fields=null)
 
 toRawArray ($only_these_fields=null)
 
 toArrayRecursive ($only_these_fields=null)
 
 getValue ($field)
 
 getRelationValue ($relation, $field)
 
 getDefaultValue ($field)
 
 setValue ($field, $value)
 
 __get ($field)
 
 __set ($field, $value)
 
 __isset ($field)
 
 offsetExists ($offset)
 
 offsetGet ($offset)
 
 offsetSet ($offset, $value)
 
 offsetUnset ($offset)
 
 getIterator ()
 
 count ()
 
 isField ($field)
 
 isRelation ($field)
 
 isAdditionalField ($field)
 
 isAliasField ($field)
 
 isI18nField ($field)
 
 setData ($data, $reset=false)
 
 isNew ()
 
 isDeleted ()
 
 setNew ($is_new)
 
 getWhereQuery ()
 
 restore ()
 
 store ()
 
 triggerChdate ()
 
 delete ()
 
 isDirty ()
 
 isFieldDirty ($field)
 
 revertValue ($field)
 
 getPristineValue ($field)
 
 initRelation ($relation)
 
 resetRelation ($relation)
 
 cleanup ()
 

Static Public Member Functions

static getIcon (bool $active=false)
 
static getIconShape ()
 
static getName ()
 
static getEditingComponent ()
 
- Static Public Member Functions inherited from QuestionnaireQuestion
static findByQuestionnaire_id ($questionnaire_id)
 
- Static Public Member Functions inherited from SimpleORMap
static tableScheme ($db_table)
 
static expireTableScheme ()
 
static exists ($id)
 
static countBySql ($sql='1', $params=[])
 
static create ($data)
 
static build ($data, $is_new=true)
 
static buildExisting ($data)
 
static import ($data)
 
static findBySQL ($sql, $params=[])
 
static findOneBySQL ($where, $params=[])
 
static findThru ($foreign_key_value, $options)
 
static findEachBySQL ($callable, $sql, $params=[])
 
static findMany ($pks=[], $order='', $order_params=[])
 
static findEachMany ($callable, $pks=[], $order='', $order_params=[])
 
static findAndMapBySQL ($callable, $where, $params=[])
 
static findAndMapMany ($callable, $pks=[], $order='', $order_params=[])
 
static deleteBySQL ($where, $params=[])
 
static toObject ($id_or_object)
 
static __callStatic (string $name, array $arguments)
 

Additional Inherited Members

- Data Fields inherited from SimpleORMap
const ID_SEPARATOR = '_'
 
- Static Public Attributes inherited from SimpleORMap
static $schemes = null
 
- Protected Member Functions inherited from SimpleORMap
 _getId ($field)
 
 _setId ($field, $value)
 
 _getAdditionalValueFromRelation ($field)
 
 _setAdditionalValueFromRelation ($field, $value)
 
 _getAdditionalValue ($field)
 
 _setAdditionalValue ($field, $value)
 
 parseRelationOptions ($type, $name, $options)
 
 storeRelations ($only_these=null)
 
 deleteRelations ()
 
 initializeContent ()
 
 applyCallbacks ($type)
 
 cbNotificationMapper ($cb_type)
 
 cbAfterInitialize ($cb_type)
 
 setSerializedValue ($field, $value)
 
 setI18nValue ($field, $value)
 
- Static Protected Member Functions inherited from QuestionnaireQuestion
static configure ($config=[])
 
- Static Protected Member Functions inherited from SimpleORMap
static db_table ()
 
static db_fields ()
 
static pk ()
 
static default_values ()
 
static serialized_fields ()
 
static alias_fields ()
 
static i18n_fields ()
 
static additional_fields ()
 
static has_many ()
 
static has_one ()
 
static belongs_to ()
 
static has_and_belongs_to_many ()
 
static registered_callbacks ()
 
static known_slots ()
 
static notification_map ()
 
static getter_setter_map ()
 
static configure ($config=[])
 
static config ($key)
 
static registerCallback ($types, $cb)
 
static unregisterCallback ($types, $cb)
 
- Protected Attributes inherited from SimpleORMap
 $content = []
 
 $content_db = []
 
 $is_new = true
 
 $is_deleted = false
 
 $relations = []
 
 $additional_data = []
 
- Static Protected Attributes inherited from SimpleORMap
static $config = []
 
static $reserved_slots = ['value','newid','iterator','tablemetadata', 'relationvalue','wherequery','relationoptions','data','new','id']
 
static $performs_batch_operation = false
 

Member Function Documentation

◆ beforeStoringQuestiondata()

beforeStoringQuestiondata (   $questiondata)

Usually the $questiondata is already in the correct format. But for some question types some data have to be manipulated by for example the HTML-purifier. So this takes the questiondata and changed them before they get stored.

Parameters
$questiondata
Returns
mixed

Implements QuestionType.

◆ createAnswer()

createAnswer ( )

Creates an answer by the parameters of the request. Called when a user clicked to answer the questionnaire.

Returns
QuestionnaireAnswer

Implements QuestionType.

◆ getDisplayTemplate()

getDisplayTemplate ( )

Returns the template of this question to answer the question.

Returns
Flexi_Template
Exceptions
Flexi_TemplateNotFoundExceptionif there is no template.

Implements QuestionType.

◆ getEditingComponent()

static getEditingComponent ( )
static

Returns an array with two parts: First one is the name of the component for editing the question. Second one is the import path of the component. Plugins can use this to get their component imported.

Returns
Array

Implements QuestionType.

◆ getIcon()

static getIcon ( bool  $active = false)
static

Returns the Icon-object to this QuestionType.

Parameters
bool$active,true if Icon should be clickable, false for black info-icon.
Returns
Icon : guestbook-icon.

Implements QuestionType.

◆ getIconShape()

static getIconShape ( )
static

Returns the shape of the icon of this QuestionType

Returns
string

Implements QuestionType.

◆ getName()

static getName ( )
static

Returns the name of this QuestionType "Freitextfrage".

Returns
string

Implements QuestionType.

◆ getResultArray()

getResultArray ( )

Returns an array of the answers to be put into a CSV-file.

Returns
array

Implements QuestionType.

◆ getResultTemplate()

getResultTemplate (   $only_user_ids = null)

Returns the template with the answers of the question so far.

Parameters
null$only_user_ids: array of user_ids
Returns
Flexi_Template
Exceptions
Flexi_TemplateNotFoundExceptionif there is no template.

Implements QuestionType.

◆ getUserIdsOfFilteredAnswer()

getUserIdsOfFilteredAnswer (   $answer_option)

In the evaluation of the questionnaire you can click on a certain answer and get the evaluation filtered by the the people that have given that answer. This method asks from the question, what user_ids have given the answer_option. Answer option could be anything that this question understands as an answer.

Parameters
$answer_option
Returns
mixed

Implements QuestionType.

◆ onEnding()

onEnding ( )

Called after the questionnaire gets closed. Does nothing for this QuestionType Freetext.

Implements QuestionType.


The documentation for this class was generated from the following file: