3 // This file is part of Moodle - http://moodle.org/
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 // GNU General Public License for more details.
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
19 * This file is responsible for producing the survey reports
22 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26 require_once("../../config.php");
27 require_once("lib.php");
29 // Check that all the parameters have been provided.
31 $id = required_param('id', PARAM_INT
); // Course Module ID
32 $action = optional_param('action', '', PARAM_ALPHA
); // What to look at
33 $qid = optional_param('qid', 0, PARAM_RAW
); // Question IDs comma-separated list
34 $student = optional_param('student', 0, PARAM_INT
); // Student ID
35 $notes = optional_param('notes', '', PARAM_RAW
); // Save teachers notes
37 $qids = explode(',', $qid);
38 $qids = clean_param_array($qids, PARAM_INT
);
39 $qid = implode (',', $qids);
41 if (! $cm = get_coursemodule_from_id('survey', $id)) {
42 print_error('invalidcoursemodule');
45 if (! $course = $DB->get_record("course", array("id"=>$cm->course
))) {
46 print_error('coursemisconf');
49 $url = new moodle_url('/mod/survey/report.php', array('id'=>$id));
51 $url->param('action', $action);
54 $url->param('qid', $qid);
57 $url->param('student', $student);
60 $url->param('notes', $notes);
64 require_login($course, false, $cm);
66 $context = context_module
::instance($cm->id
);
68 require_capability('mod/survey:readresponses', $context);
70 if (! $survey = $DB->get_record("survey", array("id"=>$cm->instance
))) {
71 print_error('invalidsurveyid', 'survey');
74 if (! $template = $DB->get_record("survey", array("id"=>$survey->template
))) {
75 print_error('invalidtmptid', 'survey');
78 $showscales = ($template->name
!= 'ciqname');
81 $strreport = get_string("report", "survey");
82 $strsurvey = get_string("modulename", "survey");
83 $strsurveys = get_string("modulenameplural", "survey");
84 $strsummary = get_string("summary", "survey");
85 $strscales = get_string("scales", "survey");
86 $strquestion = get_string("question", "survey");
87 $strquestions = get_string("questions", "survey");
88 $strdownload = get_string("download", "survey");
89 $strallscales = get_string("allscales", "survey");
90 $strallquestions = get_string("allquestions", "survey");
91 $strselectedquestions = get_string("selectedquestions", "survey");
92 $strseemoredetail = get_string("seemoredetail", "survey");
93 $strnotes = get_string("notes", "survey");
97 $PAGE->navbar
->add(get_string('downloadresults', 'survey'));
102 $PAGE->navbar
->add($strreport);
103 $PAGE->navbar
->add($
{'str'.$action});
106 $PAGE->navbar
->add($strreport);
107 $PAGE->navbar
->add(get_string('participants'));
110 $PAGE->navbar
->add($strreport);
111 $PAGE->navbar
->add($strsummary);
114 $PAGE->navbar
->add($strreport);
118 $PAGE->set_title("$course->shortname: ".format_string($survey->name
));
119 $PAGE->set_heading($course->fullname
);
120 echo $OUTPUT->header();
121 echo $OUTPUT->heading($survey->name
);
123 /// Check to see if groups are being used in this survey
124 if ($groupmode = groups_get_activity_groupmode($cm)) { // Groups are being used
125 $menuaction = $action == "student" ?
"students" : $action;
126 $currentgroup = groups_get_activity_group($cm, true);
127 groups_print_activity_menu($cm, $CFG->wwwroot
. "/mod/survey/report.php?id=$cm->id&action=$menuaction&qid=$qid");
133 'objectid' => $survey->id
,
134 'context' => $context,
135 'courseid' => $course->id
,
136 'relateduserid' => $student,
137 'other' => array('action' => $action, 'groupid' => $currentgroup)
139 $event = \mod_survey\event\report_viewed
::create($params);
143 $users = get_users_by_capability($context, 'mod/survey:participate', '', '', '', '', $currentgroup, null, false);
144 } else if (!empty($cm->groupingid
)) {
145 $groups = groups_get_all_groups($courseid, 0, $cm->groupingid
);
146 $groups = array_keys($groups);
147 $users = get_users_by_capability($context, 'mod/survey:participate', '', '', '', '', $groups, null, false);
149 $users = get_users_by_capability($context, 'mod/survey:participate', '', '', '', '', '', null, false);
153 $groupingid = $cm->groupingid
;
155 echo $OUTPUT->box_start("generalbox boxaligncenter");
157 echo "<a href=\"report.php?action=summary&id=$id\">$strsummary</a>";
158 echo " <a href=\"report.php?action=scales&id=$id\">$strscales</a>";
159 echo " <a href=\"report.php?action=questions&id=$id\">$strquestions</a>";
160 echo " <a href=\"report.php?action=students&id=$id\">".get_string('participants')."</a>";
161 if (has_capability('mod/survey:download', $context)) {
162 echo " <a href=\"report.php?action=download&id=$id\">$strdownload</a>";
164 if (empty($action)) {
168 echo "<a href=\"report.php?action=questions&id=$id\">$strquestions</a>";
169 echo " <a href=\"report.php?action=students&id=$id\">".get_string('participants')."</a>";
170 if (has_capability('mod/survey:download', $context)) {
171 echo " <a href=\"report.php?action=download&id=$id\">$strdownload</a>";
173 if (empty($action)) {
174 $action = "questions";
177 echo $OUTPUT->box_end();
179 echo $OUTPUT->spacer(array('height'=>30, 'width'=>30, 'br'=>true)); // should be done with CSS instead
182 /// Print the menu across the top
184 $virtualscales = false;
189 echo $OUTPUT->heading($strsummary, 3);
191 if (survey_count_responses($survey->id
, $currentgroup, $groupingid)) {
192 echo "<div class='reportsummary'><a href=\"report.php?action=scales&id=$id\">";
193 survey_print_graph("id=$id&group=$currentgroup&type=overall.png");
196 echo $OUTPUT->notification(get_string("nobodyyet","survey"));
201 echo $OUTPUT->heading($strscales, 3);
203 if (! $results = survey_get_responses($survey->id
, $currentgroup, $groupingid) ) {
204 echo $OUTPUT->notification(get_string("nobodyyet","survey"));
208 $questions = $DB->get_records_list("survey_questions", "id", explode(',', $survey->questions
));
209 $questionorder = explode(",", $survey->questions
);
211 foreach ($questionorder as $key => $val) {
212 $question = $questions[$val];
213 if ($question->type
< 0) { // We have some virtual scales. Just show them.
214 $virtualscales = true;
219 foreach ($questionorder as $key => $val) {
220 $question = $questions[$val];
221 if ($question->multi
) {
222 if (!empty($virtualscales) && $question->type
> 0) { // Don't show non-virtual scales if virtual
225 echo "<p class=\"centerpara\"><a title=\"$strseemoredetail\" href=\"report.php?action=questions&id=$id&qid=$question->multi\">";
226 survey_print_graph("id=$id&qid=$question->id&group=$currentgroup&type=multiquestion.png");
227 echo "</a></p><br />";
236 if ($qid) { // just get one multi-question
237 $questions = $DB->get_records_select("survey_questions", "id in ($qid)");
238 $questionorder = explode(",", $qid);
240 if ($scale = $DB->get_records("survey_questions", array("multi"=>$qid))) {
241 $scale = array_pop($scale);
242 echo $OUTPUT->heading("$scale->text - $strselectedquestions", 3);
244 echo $OUTPUT->heading($strselectedquestions, 3);
247 } else { // get all top-level questions
248 $questions = $DB->get_records_list("survey_questions", "id", explode(',',$survey->questions
));
249 $questionorder = explode(",", $survey->questions
);
251 echo $OUTPUT->heading($strallquestions, 3);
254 if (! $results = survey_get_responses($survey->id
, $currentgroup, $groupingid) ) {
255 echo $OUTPUT->notification(get_string("nobodyyet","survey"));
259 foreach ($questionorder as $key => $val) {
260 $question = $questions[$val];
261 if ($question->type
< 0) { // We have some virtual scales. DON'T show them.
262 $virtualscales = true;
267 foreach ($questionorder as $key => $val) {
268 $question = $questions[$val];
270 if ($question->type
< 0) { // We have some virtual scales. DON'T show them.
273 $question->text
= get_string($question->text
, "survey");
275 if ($question->multi
) {
276 echo $OUTPUT->heading($question->text
. ':', 4);
278 $subquestions = survey_get_subquestions($question);
279 foreach ($subquestions as $subquestion) {
280 if ($subquestion->type
> 0) {
281 echo "<p class=\"centerpara\">";
282 echo "<a title=\"$strseemoredetail\" href=\"report.php?action=question&id=$id&qid=$subquestion->id\">";
283 survey_print_graph("id=$id&qid=$subquestion->id&group=$currentgroup&type=question.png");
287 } else if ($question->type
> 0 ) {
288 echo "<p class=\"centerpara\">";
289 echo "<a title=\"$strseemoredetail\" href=\"report.php?action=question&id=$id&qid=$question->id\">";
290 survey_print_graph("id=$id&qid=$question->id&group=$currentgroup&type=question.png");
294 $table = new html_table();
295 $table->head
= array($question->text
);
296 $table->align
= array ("left");
298 $contents = '<table cellpadding="15" width="100%">';
300 if ($aaa = survey_get_user_answers($survey->id
, $question->id
, $currentgroup, "sa.time ASC")) {
301 foreach ($aaa as $a) {
303 $contents .= '<td class="fullnamecell">'.fullname($a).'</td>';
304 $contents .= '<td valign="top">'.s($a->answer1
).'</td>';
305 $contents .= "</tr>";
308 $contents .= "</table>";
310 $table->data
[] = array($contents);
312 echo html_writer
::table($table);
314 echo $OUTPUT->spacer(array('height'=>30)); // should be done with CSS instead
322 if (!$question = $DB->get_record("survey_questions", array("id"=>$qid))) {
323 print_error('cannotfindquestion', 'survey');
325 $question->text
= get_string($question->text
, "survey");
327 $answers = explode(",", get_string($question->options
, "survey"));
329 echo $OUTPUT->heading("$strquestion: $question->text", 3);
332 $strname = get_string("name", "survey");
333 $strtime = get_string("time", "survey");
334 $stractual = get_string("actual", "survey");
335 $strpreferred = get_string("preferred", "survey");
336 $strdateformat = get_string("strftimedatetime");
338 $table = new html_table();
339 $table->head
= array("", $strname, $strtime, $stractual, $strpreferred);
340 $table->align
= array ("left", "left", "left", "left", "right");
341 $table->size
= array (35, "", "", "", "");
343 if ($aaa = survey_get_user_answers($survey->id
, $question->id
, $currentgroup)) {
344 foreach ($aaa as $a) {
346 $answer1 = "$a->answer1 - ".$answers[$a->answer1
- 1];
351 $answer2 = "$a->answer2 - ".$answers[$a->answer2
- 1];
355 $table->data
[] = array(
356 $OUTPUT->user_picture($a, array('courseid'=>$course->id
)),
357 "<a href=\"report.php?id=$id&action=student&student=$a->userid\">".fullname($a)."</a>",
359 s($answer1), s($answer2));
364 echo html_writer
::table($table);
370 echo $OUTPUT->heading(get_string("analysisof", "survey", get_string('participants')), 3);
372 if (! $results = survey_get_responses($survey->id
, $currentgroup, $groupingid) ) {
373 echo $OUTPUT->notification(get_string("nobodyyet","survey"));
375 survey_print_all_responses($cm->id
, $results, $course->id
);
381 if (!$user = $DB->get_record("user", array("id"=>$student))) {
382 print_error('invaliduserid');
385 echo $OUTPUT->heading(get_string("analysisof", "survey", fullname($user)), 3);
387 if ($notes != '' and confirm_sesskey()) {
388 if (survey_get_analysis($survey->id
, $user->id
)) {
389 if (! survey_update_analysis($survey->id
, $user->id
, $notes)) {
390 echo $OUTPUT->notification(get_string("errorunabletosavenotes", "survey"), "notifyproblem");
392 echo $OUTPUT->notification(get_string("savednotes", "survey"), "notifysuccess");
395 if (! survey_add_analysis($survey->id
, $user->id
, $notes)) {
396 echo $OUTPUT->notification(get_string("errorunabletosavenotes", "survey"), "notifyproblem");
398 echo $OUTPUT->notification(get_string("savednotes", "survey"), "notifysuccess");
403 echo "<p class=\"centerpara\">";
404 echo $OUTPUT->user_picture($user, array('courseid'=>$course->id
));
407 $questions = $DB->get_records_list("survey_questions", "id", explode(',', $survey->questions
));
408 $questionorder = explode(",", $survey->questions
);
411 // Print overall summary
412 echo "<p class=\"centerpara\">";
413 survey_print_graph("id=$id&sid=$student&type=student.png");
418 foreach ($questionorder as $key => $val) {
419 $question = $questions[$val];
420 if ($question->type
< 0) { // We have some virtual scales. Just show them.
421 $virtualscales = true;
426 foreach ($questionorder as $key => $val) {
427 $question = $questions[$val];
428 if ($question->multi
) {
429 if ($virtualscales && $question->type
> 0) { // Don't show non-virtual scales if virtual
432 echo "<p class=\"centerpara\">";
433 echo "<a title=\"$strseemoredetail\" href=\"report.php?action=questions&id=$id&qid=$question->multi\">";
434 survey_print_graph("id=$id&qid=$question->id&sid=$student&type=studentmultiquestion.png");
435 echo "</a></p><br />";
440 // Print non-scale questions
442 foreach ($questionorder as $key => $val) {
443 $question = $questions[$val];
444 if ($question->type
== 0 or $question->type
== 1) {
445 if ($answer = survey_get_user_answer($survey->id
, $question->id
, $user->id
)) {
446 $table = new html_table();
447 $table->head
= array(get_string($question->text
, "survey"));
448 $table->align
= array ("left");
449 if (!empty($question->options
) && $answer->answer1
> 0) {
450 $answers = explode(',', get_string($question->options
, 'survey'));
451 if ($answer->answer1
<= count($answers)) {
452 $table->data
[] = array(s($answers[$answer->answer1
- 1])); // No html here, just plain text.
454 $table->data
[] = array(s($answer->answer1
)); // No html here, just plain text.
457 $table->data
[] = array(s($answer->answer1
)); // No html here, just plain text.
459 echo html_writer
::table($table);
460 echo $OUTPUT->spacer(array('height'=>30));
465 if ($rs = survey_get_analysis($survey->id
, $user->id
)) {
470 echo "<hr noshade=\"noshade\" size=\"1\" />";
471 echo "<div class='studentreport'>";
472 echo "<form action=\"report.php\" method=\"post\">";
473 echo "<h3>$strnotes:</h3>";
475 echo "<textarea class=\"form-control\" name=\"notes\" rows=\"10\" cols=\"60\">";
477 echo "</textarea><br />";
478 echo "<input type=\"hidden\" name=\"action\" value=\"student\" />";
479 echo "<input type=\"hidden\" name=\"sesskey\" value=\"".sesskey()."\" />";
480 echo "<input type=\"hidden\" name=\"student\" value=\"$student\" />";
481 echo "<input type=\"hidden\" name=\"id\" value=\"$cm->id\" />";
482 echo "<input type=\"submit\" class=\"btn btn-primary\" value=\"".get_string("savechanges")."\" />";
483 echo "</blockquote>";
491 echo $OUTPUT->heading($strdownload, 3);
493 require_capability('mod/survey:download', $context);
495 $numusers = survey_count_responses($survey->id
, $currentgroup, $groupingid);
497 echo html_writer
::tag('p', get_string("downloadinfo", "survey"), array('class' => 'centerpara'));
499 echo $OUTPUT->container_start('reportbuttons');
501 $options["id"] = "$cm->id";
502 $options["group"] = $currentgroup;
504 $options["type"] = "ods";
505 echo $OUTPUT->single_button(new moodle_url("download.php", $options), get_string("downloadods"));
507 $options["type"] = "xls";
508 echo $OUTPUT->single_button(new moodle_url("download.php", $options), get_string("downloadexcel"));
510 $options["type"] = "txt";
511 echo $OUTPUT->single_button(new moodle_url("download.php", $options), get_string("downloadtext"));
512 echo $OUTPUT->container_end();
515 echo html_writer
::tag('p', get_string("nobodyyet", "survey"), array('class' => 'centerpara'));
521 echo $OUTPUT->footer();