aboutsummaryrefslogtreecommitdiff
path: root/lib/models/Freetext.php
blob: 0c8272b99651dbb297177aff77c0a13c037d1c2b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
<?php

require_once 'lib/classes/QuestionType.interface.php';

use eTask\Task;

class Freetext extends QuestionnaireQuestion implements QuestionType
{
    /**
     * Returns the Icon-object to this QuestionType.
     * @param bool $active: true if Icon should be clickable, false for black info-icon.
     * @param bool $add : true if the add-appendix shoudl be added to the icon.
     * @return Icon : guestbook-icon.
     */
    public static function getIcon($active = false, $add = false)
    {
        return Icon::create(
            'guestbook',
            $active ? Icon::ROLE_CLICKABLE : Icon::ROLE_INFO
        );
    }

    /**
     * Returns the name of this QuestionType "Freitextfrage".
     * @return string
     */
    public static function getName()
    {
        return _('Freitextfrage');
    }

    /**
     * Returns the template to edit this question
     * @return Flexi_Template
     * @throws Flexi_TemplateNotFoundException if there is no template.
     */
    public function getEditingTemplate()
    {
        $factory = new Flexi_TemplateFactory(realpath(__DIR__ . '/../../app/views'));
        $template = $factory->open('questionnaire/question_types/freetext/freetext_edit.php');
        $template->vote = $this;
        return $template;
    }

    /**
     * Processes the request and stores the given values into the etask-object.
     * Called when the question is saved by the user.
     */
    public function createDataFromRequest()
    {
        $questions = Request::getArray('questions');
        $data = $questions[$this->getId()];

        if (!$this->etask) {
            $this->etask = Task::create([
                'type'    => 'freetext',
                'user_id' => $GLOBALS['user']->id,
            ]);
        }

        $this->etask->description = Studip\Markup::purifyHtml($data['description']);
        $this->etask->task = [];

        // update mandatory option
        if (isset($data['options']['mandatory'])) {
            $options = $this->etask->options;
            $options['mandatory'] = (bool) $data['options']['mandatory'];
            $this->etask->options = $options;
        }

        $this->etask->store();
    }

    /**
     * Returns the template of this question to answer the question.
     * @return Flexi_Template
     * @throws Flexi_TemplateNotFoundException if there is no template.
     */
    public function getDisplayTemplate()
    {
        $factory = new Flexi_TemplateFactory(realpath(__DIR__ . '/../../app/views'));
        $template = $factory->open('questionnaire/question_types/freetext/freetext_answer.php');
        $template->vote = $this;
        return $template;
    }

    /**
     * Creates an answer by the parameters of the request. Called when a user clicked to answer
     * the questionnaire.
     * @return QuestionnaireAnswer
     */
    public function createAnswer()
    {
        $answer = $this->getMyAnswer();
        $answers = Request::getArray('answers');
        $userAnswerText = $answers[$this->getId()]['answerdata']['text'];
        $answer->setData(['answerData' => ['text' => $userAnswerText]]);
        return $answer;
    }

    /**
     * Returns the template with the answers of the question so far.
     * @param null $only_user_ids : array of user_ids
     * @return Flexi_Template
     * @throws Flexi_TemplateNotFoundException if there is no template.
     */
    public function getResultTemplate($only_user_ids = null)
    {
        $factory = new Flexi_TemplateFactory(realpath(__DIR__ . '/../../app/views'));
        $template = $factory->open('questionnaire/question_types/freetext/freetext_evaluation.php');
        $template->vote = $this;
        return $template;
    }

    /**
     * Returns an array of the answers to be put into a CSV-file.
     * @return array
     */
    public function getResultArray()
    {
        $output = [];
        $countNobodys = 0;

        $question = trim(strip_tags($this->etask->description));
        foreach ($this->answers as $answer) {
            if ($answer['user_id'] && $answer['user_id'] != 'nobody') {
                $userId = $answer['user_id'];
            } else {
                $countNobodys++;
                $userId = _('unbekannt').' '.$countNobodys;
            }

            $output[$question][$userId] = $answer['answerdata']['text'];
        }

        return $output;
    }

    /**
     * Called after the questionnaire gets closed. Does nothing for this QuestionType Freetext.
     */
    public function onEnding()
    {
        //Nothing to do here.
    }
}