diff --git a/mod/survey/report.php b/mod/survey/report.php index 0c43c3623e5..ba01f744d8d 100644 --- a/mod/survey/report.php +++ b/mod/survey/report.php @@ -23,130 +23,129 @@ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ - require_once("../../config.php"); - require_once("lib.php"); +require_once("../../config.php"); +require_once("lib.php"); // Check that all the parameters have been provided. - $id = required_param('id', PARAM_INT); // Course Module ID - $action = optional_param('action', '', PARAM_ALPHA); // What to look at - $qid = optional_param('qid', 0, PARAM_RAW); // Question IDs comma-separated list - $student = optional_param('student', 0, PARAM_INT); // Student ID - $notes = optional_param('notes', '', PARAM_RAW); // Save teachers notes +$id = required_param('id', PARAM_INT); // Course Module ID. +$action = optional_param('action', '', PARAM_ALPHA); // What to look at. +$qid = optional_param('qid', 0, PARAM_RAW); // Question IDs comma-separated list. +$student = optional_param('student', 0, PARAM_INT); // Student ID. +$notes = optional_param('notes', '', PARAM_RAW); // Save teachers notes. - $qids = explode(',', $qid); - $qids = clean_param_array($qids, PARAM_INT); - $qid = implode (',', $qids); +$qids = explode(',', $qid); +$qids = clean_param_array($qids, PARAM_INT); +$qid = implode(',', $qids); - if (! $cm = get_coursemodule_from_id('survey', $id)) { - print_error('invalidcoursemodule'); - } +if (!$cm = get_coursemodule_from_id('survey', $id)) { + throw new moodle_exception('invalidcoursemodule'); +} - if (! $course = $DB->get_record("course", array("id"=>$cm->course))) { - print_error('coursemisconf'); - } +if (!$course = $DB->get_record("course", array("id" => $cm->course))) { + throw new moodle_exception('coursemisconf'); +} - $url = new moodle_url('/mod/survey/report.php', array('id'=>$id)); - if ($action !== '') { - $url->param('action', $action); - } - if ($qid !== 0) { - $url->param('qid', $qid); - } - if ($student !== 0) { - $url->param('student', $student); - } - if ($notes !== '') { - $url->param('notes', $notes); - } - $PAGE->set_url($url); +$url = new moodle_url('/mod/survey/report.php', array('id' => $id)); +if ($action !== '') { + $url->param('action', $action); +} +if ($qid !== 0) { + $url->param('qid', $qid); +} +if ($student !== 0) { + $url->param('student', $student); +} +if ($notes !== '') { + $url->param('notes', $notes); +} +$PAGE->set_url($url); - require_login($course, false, $cm); +require_login($course, false, $cm); - $context = context_module::instance($cm->id); +$context = context_module::instance($cm->id); - require_capability('mod/survey:readresponses', $context); +require_capability('mod/survey:readresponses', $context); - if (! $survey = $DB->get_record("survey", array("id"=>$cm->instance))) { - print_error('invalidsurveyid', 'survey'); - } +if (!$survey = $DB->get_record("survey", array("id" => $cm->instance))) { + throw new moodle_exception('invalidsurveyid', 'survey'); +} - if (! $template = $DB->get_record("survey", array("id"=>$survey->template))) { - print_error('invalidtmptid', 'survey'); - } +if (!$template = $DB->get_record("survey", array("id" => $survey->template))) { + throw new moodle_exception('invalidtmptid', 'survey'); +} - $showscales = ($template->name != 'ciqname'); +$showscales = ($template->name != 'ciqname'); +$strreport = get_string("report", "survey"); +$strsurvey = get_string("modulename", "survey"); +$strsurveys = get_string("modulenameplural", "survey"); +$strsummary = get_string("summary", "survey"); +$strscales = get_string("scales", "survey"); +$strquestion = get_string("question", "survey"); +$strquestions = get_string("questions", "survey"); +$strdownload = get_string("download", "survey"); +$strallscales = get_string("allscales", "survey"); +$strselectedquestions = get_string("selectedquestions", "survey"); +$strseemoredetail = get_string("seemoredetail", "survey"); +$strnotes = get_string("notes", "survey"); - $strreport = get_string("report", "survey"); - $strsurvey = get_string("modulename", "survey"); - $strsurveys = get_string("modulenameplural", "survey"); - $strsummary = get_string("summary", "survey"); - $strscales = get_string("scales", "survey"); - $strquestion = get_string("question", "survey"); - $strquestions = get_string("questions", "survey"); - $strdownload = get_string("download", "survey"); - $strallscales = get_string("allscales", "survey"); - $strselectedquestions = get_string("selectedquestions", "survey"); - $strseemoredetail = get_string("seemoredetail", "survey"); - $strnotes = get_string("notes", "survey"); - - $PAGE->set_title("$course->shortname: ".format_string($survey->name)); - $PAGE->set_heading($course->fullname); - $PAGE->activityheader->set_attrs([ +$PAGE->set_title("$course->shortname: " . format_string($survey->name)); +$PAGE->set_heading($course->fullname); +$PAGE->activityheader->set_attrs([ 'hidecompletion' => true, 'description' => '' - ]); +]); - // Activate the secondary nav tab. - navigation_node::override_active_url(new moodle_url('/mod/survey/report.php', ['id' => $id, 'action' => 'summary'])); +// Activate the secondary nav tab. +navigation_node::override_active_url(new moodle_url('/mod/survey/report.php', ['id' => $id, 'action' => 'summary'])); - $actionbar = new \mod_survey\output\actionbar($id, $action, $url); - echo $OUTPUT->header(); - $renderer = $PAGE->get_renderer('mod_survey'); - echo $renderer->response_actionbar($actionbar); +$actionbar = new \mod_survey\output\actionbar($id, $action, $url); +echo $OUTPUT->header(); +$renderer = $PAGE->get_renderer('mod_survey'); +echo $renderer->response_actionbar($actionbar); -/// Check to see if groups are being used in this survey - if ($groupmode = groups_get_activity_groupmode($cm)) { // Groups are being used - $menuaction = $action == "student" ? "students" : $action; - $currentgroup = groups_get_activity_group($cm, true); - $groupsactivitymenu = groups_print_activity_menu($cm, new moodle_url('/mod/survey/report.php', +// Check to see if groups are being used in this survey. +if ($groupmode = groups_get_activity_groupmode($cm)) { // Groups are being used. + $menuaction = $action == "student" ? "students" : $action; + $currentgroup = groups_get_activity_group($cm, true); + $groupsactivitymenu = groups_print_activity_menu($cm, new moodle_url('/mod/survey/report.php', ['id' => $cm->id, 'action' => $menuaction, 'qid' => $qid]), true); - } else { - $currentgroup = 0; - $groupsactivitymenu = null; - } +} else { + $currentgroup = 0; + $groupsactivitymenu = null; +} - $params = array( +$params = array( 'objectid' => $survey->id, 'context' => $context, 'courseid' => $course->id, 'relateduserid' => $student, 'other' => array('action' => $action, 'groupid' => $currentgroup) - ); - $event = \mod_survey\event\report_viewed::create($params); - $event->trigger(); +); +$event = \mod_survey\event\report_viewed::create($params); +$event->trigger(); - if ($currentgroup) { - $users = get_users_by_capability($context, 'mod/survey:participate', '', '', '', '', $currentgroup, null, false); - } else if (!empty($cm->groupingid)) { - $groups = groups_get_all_groups($courseid, 0, $cm->groupingid); - $groups = array_keys($groups); - $users = get_users_by_capability($context, 'mod/survey:participate', '', '', '', '', $groups, null, false); - } else { - $users = get_users_by_capability($context, 'mod/survey:participate', '', '', '', '', '', null, false); - $group = false; - } +if ($currentgroup) { + $users = get_users_by_capability($context, 'mod/survey:participate', '', '', '', '', $currentgroup, null, false); +} else if (!empty($cm->groupingid)) { + $groups = groups_get_all_groups($courseid, 0, $cm->groupingid); + $groups = array_keys($groups); + $users = get_users_by_capability($context, 'mod/survey:participate', '', '', '', '', $groups, null, false); +} else { + $users = get_users_by_capability($context, 'mod/survey:participate', '', '', '', '', '', null, false); + $group = false; +} - $groupingid = $cm->groupingid; +$groupingid = $cm->groupingid; -/// Print the menu across the top +// Print the menu across the top. - $virtualscales = false; +$virtualscales = false; - switch ($action) { +switch ($action) { - case "summary": + case "summary": // If survey type is Critical incidents then we don't show summary report. if ($survey->template == SURVEY_CIQ) { throw new moodle_exception('cannotviewreport'); @@ -166,10 +165,10 @@ } break; - case "scales": + case "scales": // If survey type is Critical incidents then we don't show scales report. if ($survey->template == SURVEY_CIQ) { - throw new moodle_exception('cannotviewreport'); + throw new moodle_exception('cannotviewreport'); } echo $OUTPUT->heading($strscales, 3); @@ -177,7 +176,7 @@ echo html_writer::div($groupsactivitymenu, 'mb-2'); } - if (! $results = survey_get_responses($survey->id, $currentgroup, $groupingid) ) { + if (!$results = survey_get_responses($survey->id, $currentgroup, $groupingid)) { echo $OUTPUT->notification(get_string("nobodyyet", "survey"), 'info', false); } else { @@ -196,7 +195,7 @@ foreach ($questionorder as $key => $val) { $question = $questions[$val]; if ($question->multi) { - if (!empty($virtualscales) && $question->type > 0) { // Don't show non-virtual scales if virtual + if (!empty($virtualscales) && $question->type > 0) { // Don't show non-virtual scales if virtual. continue; } echo "

multi\">"; @@ -208,21 +207,21 @@ break; - case "questions": + case "questions": - if ($qid) { // just get one multi-question + if ($qid) { // Just get one multi-question. $questions = $DB->get_records_select("survey_questions", "id in ($qid)"); $questionorder = explode(",", $qid); - if ($scale = $DB->get_records("survey_questions", array("multi"=>$qid))) { + if ($scale = $DB->get_records("survey_questions", array("multi" => $qid))) { $scale = array_pop($scale); echo $OUTPUT->heading("$scale->text - $strselectedquestions", 3); } else { echo $OUTPUT->heading($strselectedquestions, 3); } - } else { // get all top-level questions - $questions = $DB->get_records_list("survey_questions", "id", explode(',',$survey->questions)); + } else { // Get all top-level questions. + $questions = $DB->get_records_list("survey_questions", "id", explode(',', $survey->questions)); $questionorder = explode(",", $survey->questions); echo $OUTPUT->heading($strquestions, 3); @@ -232,7 +231,7 @@ echo html_writer::div($groupsactivitymenu, 'mb-2'); } - if (! $results = survey_get_responses($survey->id, $currentgroup, $groupingid) ) { + if (!$results = survey_get_responses($survey->id, $currentgroup, $groupingid)) { echo $OUTPUT->notification(get_string("nobodyyet", "survey"), 'info', false); } else { @@ -265,7 +264,7 @@ echo "

"; } } - } else if ($question->type > 0 ) { + } else if ($question->type > 0) { echo "

"; echo "id\">"; survey_print_graph("id=$id&qid=$question->id&group=$currentgroup&type=question.png"); @@ -274,15 +273,15 @@ } else { $table = new html_table(); $table->head = array($question->text); - $table->align = array ("left"); + $table->align = array("left"); $contents = ''; if ($aaa = survey_get_user_answers($survey->id, $question->id, $currentgroup, "sa.time ASC")) { foreach ($aaa as $a) { $contents .= ""; - $contents .= ''; - $contents .= ''; + $contents .= ''; + $contents .= ''; $contents .= ""; } } @@ -292,20 +291,20 @@ echo html_writer::table($table); - echo $OUTPUT->spacer(array('height'=>30)); // should be done with CSS instead + echo $OUTPUT->spacer(array('height' => 30)); // Should be done with CSS instead. } } } break; - case "question": - if (!$question = $DB->get_record("survey_questions", array("id"=>$qid))) { + case "question": + if (!$question = $DB->get_record("survey_questions", array("id" => $qid))) { print_error('cannotfindquestion', 'survey'); } $question->text = get_string($question->text, "survey"); - $answers = explode(",", get_string($question->options, "survey")); + $answers = explode(",", get_string($question->options, "survey")); echo $OUTPUT->heading("$strquestion: $question->text", 3); @@ -321,26 +320,26 @@ $table = new html_table(); $table->head = array("", $strname, $strtime, $stractual, $strpreferred); - $table->align = array ("left", "left", "left", "left", "right"); - $table->size = array (35, "", "", "", ""); + $table->align = array("left", "left", "left", "left", "right"); + $table->size = array(35, "", "", "", ""); if ($aaa = survey_get_user_answers($survey->id, $question->id, $currentgroup)) { foreach ($aaa as $a) { if ($a->answer1) { - $answer1 = "$a->answer1 - ".$answers[$a->answer1 - 1]; + $answer1 = "$a->answer1 - " . $answers[$a->answer1 - 1]; } else { - $answer1 = " "; + $answer1 = " "; } if ($a->answer2) { - $answer2 = "$a->answer2 - ".$answers[$a->answer2 - 1]; + $answer2 = "$a->answer2 - " . $answers[$a->answer2 - 1]; } else { $answer2 = " "; } $table->data[] = array( - $OUTPUT->user_picture($a, array('courseid'=>$course->id)), - "userid\">".fullname($a)."", - userdate($a->time), - s($answer1), s($answer2)); + $OUTPUT->user_picture($a, array('courseid' => $course->id)), + "userid\">" . fullname($a) . "", + userdate($a->time), + s($answer1), s($answer2)); } } @@ -349,95 +348,95 @@ break; - case "students": + case "students": - echo $OUTPUT->heading(get_string("analysisof", "survey", get_string('participants')), 3); + echo $OUTPUT->heading(get_string("analysisof", "survey", get_string('participants')), 3); if ($groupsactivitymenu) { echo html_writer::div($groupsactivitymenu, 'mb-2'); } - if (! $results = survey_get_responses($survey->id, $currentgroup, $groupingid) ) { - echo $OUTPUT->notification(get_string("nobodyyet", "survey"), 'info', false); - } else { - survey_print_all_responses($cm->id, $results, $course->id); - } + if (!$results = survey_get_responses($survey->id, $currentgroup, $groupingid)) { + echo $OUTPUT->notification(get_string("nobodyyet", "survey"), 'info', false); + } else { + survey_print_all_responses($cm->id, $results, $course->id); + } break; - case "student": - if (!$user = $DB->get_record("user", array("id"=>$student))) { - print_error('invaliduserid'); - } + case "student": + if (!$user = $DB->get_record("user", array("id" => $student))) { + throw new moodle_exception('invaliduserid'); + } - echo $OUTPUT->heading(get_string("analysisof", "survey", fullname($user)), 3); + echo $OUTPUT->heading(get_string("analysisof", "survey", fullname($user)), 3); if ($groupsactivitymenu) { echo html_writer::div($groupsactivitymenu, 'mb-2'); } - if ($notes != '' and confirm_sesskey()) { - if (survey_get_analysis($survey->id, $user->id)) { - if (! survey_update_analysis($survey->id, $user->id, $notes)) { - echo $OUTPUT->notification(get_string("errorunabletosavenotes", "survey"), "notifyproblem"); - } else { - echo $OUTPUT->notification(get_string("savednotes", "survey"), "notifysuccess"); - } - } else { - if (! survey_add_analysis($survey->id, $user->id, $notes)) { - echo $OUTPUT->notification(get_string("errorunabletosavenotes", "survey"), "notifyproblem"); - } else { - echo $OUTPUT->notification(get_string("savednotes", "survey"), "notifysuccess"); - } - } - } + if ($notes != '' and confirm_sesskey()) { + if (survey_get_analysis($survey->id, $user->id)) { + if (!survey_update_analysis($survey->id, $user->id, $notes)) { + echo $OUTPUT->notification(get_string("errorunabletosavenotes", "survey"), "notifyproblem"); + } else { + echo $OUTPUT->notification(get_string("savednotes", "survey"), "notifysuccess"); + } + } else { + if (!survey_add_analysis($survey->id, $user->id, $notes)) { + echo $OUTPUT->notification(get_string("errorunabletosavenotes", "survey"), "notifyproblem"); + } else { + echo $OUTPUT->notification(get_string("savednotes", "survey"), "notifysuccess"); + } + } + } - echo "

"; - echo $OUTPUT->user_picture($user, array('courseid'=>$course->id)); - echo "

"; + echo "

"; + echo $OUTPUT->user_picture($user, array('courseid' => $course->id)); + echo "

"; - $questions = $DB->get_records_list("survey_questions", "id", explode(',', $survey->questions)); - $questionorder = explode(",", $survey->questions); + $questions = $DB->get_records_list("survey_questions", "id", explode(',', $survey->questions)); + $questionorder = explode(",", $survey->questions); - if ($showscales) { - // Print overall summary + if ($showscales) { + // Print overall summary. echo "

"; - survey_print_graph("id=$id&sid=$student&type=student.png"); - echo "

"; + survey_print_graph("id=$id&sid=$student&type=student.png"); + echo "

"; - // Print scales + // Print scales. - foreach ($questionorder as $key => $val) { - $question = $questions[$val]; - if ($question->type < 0) { // We have some virtual scales. Just show them. - $virtualscales = true; - break; - } - } + foreach ($questionorder as $key => $val) { + $question = $questions[$val]; + if ($question->type < 0) { // We have some virtual scales. Just show them. + $virtualscales = true; + break; + } + } - foreach ($questionorder as $key => $val) { - $question = $questions[$val]; - if ($question->multi) { - if ($virtualscales && $question->type > 0) { // Don't show non-virtual scales if virtual - continue; - } - echo "

"; - echo "multi\">"; - survey_print_graph("id=$id&qid=$question->id&sid=$student&type=studentmultiquestion.png"); - echo "


"; - } - } - } + foreach ($questionorder as $key => $val) { + $question = $questions[$val]; + if ($question->multi) { + if ($virtualscales && $question->type > 0) { // Don't show non-virtual scales if virtual. + continue; + } + echo "

"; + echo "multi\">"; + survey_print_graph("id=$id&qid=$question->id&sid=$student&type=studentmultiquestion.png"); + echo "


"; + } + } + } - // Print non-scale questions + // Print non-scale questions. - foreach ($questionorder as $key => $val) { - $question = $questions[$val]; - if ($question->type == 0 or $question->type == 1) { - if ($answer = survey_get_user_answer($survey->id, $question->id, $user->id)) { + foreach ($questionorder as $key => $val) { + $question = $questions[$val]; + if ($question->type == 0 or $question->type == 1) { + if ($answer = survey_get_user_answer($survey->id, $question->id, $user->id)) { $table = new html_table(); - $table->head = array(get_string($question->text, "survey")); - $table->align = array ("left"); + $table->head = array(get_string($question->text, "survey")); + $table->align = array("left"); if (!empty($question->options) && $answer->answer1 > 0) { $answers = explode(',', get_string($question->options, 'survey')); if ($answer->answer1 <= count($answers)) { @@ -446,40 +445,39 @@ $table->data[] = array(s($answer->answer1)); // No html here, just plain text. } } else { - $table->data[] = array(s($answer->answer1)); // No html here, just plain text. + $table->data[] = array(s($answer->answer1)); // No html here, just plain text. } - echo html_writer::table($table); - echo $OUTPUT->spacer(array('height'=>30)); - } - } - } + echo html_writer::table($table); + echo $OUTPUT->spacer(array('height' => 30)); + } + } + } - if ($rs = survey_get_analysis($survey->id, $user->id)) { + if ($rs = survey_get_analysis($survey->id, $user->id)) { $notes = $rs->notes; - } else { + } else { $notes = ""; - } - echo "
"; - echo "
"; - echo "
"; - echo "

$strnotes:

"; - echo "
"; - echo "
"; - echo ""; - echo ""; - echo ""; - echo "id\" />"; - echo ""; - echo "
"; - echo ""; - echo "
"; + } + echo "
"; + echo "
"; + echo "
"; + echo "

$strnotes:

"; + echo "
"; + echo "
"; + echo ""; + echo ""; + echo ""; + echo "id\" />"; + echo ""; + echo "
"; + echo ""; + echo "
"; + break; - break; - - case "download": + case "download": echo $OUTPUT->heading($strdownload, 3); if ($groupsactivitymenu) { @@ -513,8 +511,8 @@ break; - default: + default: throw new moodle_exception('cannotviewreport'); - } - echo $OUTPUT->footer(); +} +echo $OUTPUT->footer();
'.fullname($a).''.s($a->answer1).'' . fullname($a) . '' . s($a->answer1) . '