questionnaire. */ interface QuestionElements { /** * Returns a specific icon for this type of question. Note this is not bound to the * object but called staticly. * @return Icon the specific icon for this type of question */ static public function getIcon(bool $active = false) : Icon; /** * Returns the shape of the icon that is used in vue. * @return string */ static public function getIconShape(); /** * 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. * @return string : the name of this type of question. */ static public function getName(); /** * 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. * @return Array */ static public function getEditingComponent(); /** * 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. * @param $questiondata * @return mixed */ public function beforeStoringQuestiondata($questiondata); /** * Display the question to the user. This template will be embedded into a * html

-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: "> * * Right: 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. * * @return Flexi\Template */ public function getDisplayTemplate(); /** * 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! * @return QuestionnaireAnswer or derived */ public function createAnswer(); /** * 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. * @param $answer_option * @return mixed */ public function getUserIdsOfFilteredAnswer($answer_option); /** * Returns a template with the results of this question. * * @param $only_user_ids : array\null array of user_ids that the results should be restricted to. * this is used to show only a subset of results to the user for * visible evaluation of the results. If the questionnaire is anonymous * just do nothing. * * @return Flexi\Template */ public function getResultTemplate($only_user_ids = null); /** * 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. * @return 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. */ public function getResultArray(); /** * A method to be called after the questionnaire has ended. * @return void */ public function onEnding(); }