Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
Vote Class Reference
Inheritance diagram for Vote:
QuestionnaireQuestion QuestionType SimpleORMap

Public Member Functions

 beforeStoringQuestiondata ($questiondata)
 
 getDisplayTemplate ()
 
 createAnswer ()
 
 getUserIdsOfFilteredAnswer ($answer_option)
 
 getResultTemplate ($only_user_ids=null, $filtered=null)
 
 getResultArray ()
 
- 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)
 
 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 ()
 
- Public Member Functions inherited from QuestionType
 getResultTemplate ($only_user_ids=null)
 
 onEnding ()
 

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 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 ($name, $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 (   $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 ( )

Uses current user and Request-variables to create an answer for the question. Return this answer. It does not necessarily be stored to the database!

Returns
QuestionnaireAnswer or derived

Implements QuestionType.

getDisplayTemplate ( )

Display the question to the user. This template will be embedded into a html <form>-tag. Maybe more questions will appear in that form and maybe more questions of the same type. This is important to know, so that you prefix all the input-fields.

Wrong: <input type="checkbox" name="anser_a" value="1" <?= Request::get("anser_a") ? " checked" : "" ?>">

Right: <input type="checkbox" name="answer[<?= $this->getId() ?>][a]" value="1" <?= Request::getArray("answer")[$this->getId()]['a'] ? " checked" : "" ?>">

Try to prefix all your input variables at least with the id of the question, so that they will never conflict with other variables.

Returns
Flexi_Template

Implements QuestionType.

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.

static getIcon ( bool  $active = false)
static

Returns a specific icon for this type of question. Note this is not bound to the object but called staticly.

Returns
Icon the specific icon for this type of question

Implements QuestionType.

static getIconShape ( )
static

Returns the shape of the icon of this QuestionType

Returns
string

Implements QuestionType.

static getName ( )
static

Returns the name of the type of question like "Frage" or "Test" or "Dateiablage" This name is not showed to the participant of the questionnaire, but to the editor. It might get displayed like "add another Frage to questionnaire", where 'Frage' is the name of the type.

Returns
string : the name of this type of question.

Implements QuestionType.

getResultArray ( )

This method is called to generate a csv-export from a whole questionnaire. The returned array looks like this: array( 'Answer 1' => array('e7a0a84b161f3e8c09b4a0a2e8a58147' => "1", '7e81ec247c151c02ffd479511e24cc03' => "0"), 'Answer 2' => array('e7a0a84b161f3e8c09b4a0a2e8a58147' => "1", '7e81ec247c151c02ffd479511e24cc03' => "1") ) This is a two-dimensional array. The first array provides a set of answers. The values of this array are themselves arrays with the user_ids as indexes and the user's answers as the values. With this construction you can evaluate single-choice tests as well as multiple-choice tests.

Returns
array : indexed with user_id and valued with the value of the answer. If your QuestionType allows more than one value (i.e. multiple-choice) you might need to serialize it.

Implements QuestionType.

getResultTemplate (   $only_user_ids = null,
  $filtered = null 
)
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.


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