mod/survey/report.php

   1 <?php
   2
   3 // This file is part of Moodle - http://moodle.org/
   4 //
   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.
   9 //
  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.
  14 //
  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/>.
  17
  18 /**
  19  * This file is responsible for producing the survey reports
  20  *
  21  * @package   mod-survey
  22  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
  23  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24  */
  25
  26     require_once("../../config.php");
  27     require_once("lib.php");
  28
  29 // Check that all the parameters have been provided.
  30
  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
  36
  37     $qids = explode(',', $qid);
  38     $qids = clean_param_array($qids, PARAM_INT);
  39     $qid = implode (',', $qids);
  40
  41     if (! $cm = get_coursemodule_from_id('survey', $id)) {
  42         print_error('invalidcoursemodule');
  43     }
  44
  45     if (! $course = $DB->get_record("course", array("id"=>$cm->course))) {
  46         print_error('coursemisconf');
  47     }
  48
  49     $url = new moodle_url('/mod/survey/report.php', array('id'=>$id));
  50     if ($action !== '') {
  51         $url->param('action', $action);
  52     }
  53     if ($qid !== 0) {
  54         $url->param('qid', $qid);
  55     }
  56     if ($student !== 0) {
  57         $url->param('student', $student);
  58     }
  59     if ($notes !== '') {
  60         $url->param('notes', $notes);
  61     }
  62     $PAGE->set_url($url);
  63
  64     require_login($course, false, $cm);
  65
  66     $context = context_module::instance($cm->id);
  67
  68     require_capability('mod/survey:readresponses', $context);
  69
  70     if (! $survey = $DB->get_record("survey", array("id"=>$cm->instance))) {
  71         print_error('invalidsurveyid', 'survey');
  72     }
  73
  74     if (! $template = $DB->get_record("survey", array("id"=>$survey->template))) {
  75         print_error('invalidtmptid', 'survey');
  76     }
  77
  78     $showscales = ($template->name != 'ciqname');
  79
  80
  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");
  94
  95     add_to_log($course->id, "survey", "view report", "report.php?id=$cm->id", "$survey->id", $cm->id);
  96
  97     switch ($action) {
  98         case 'download':
  99             $PAGE->navbar->add(get_string('downloadresults', 'survey'));
 100             break;
 101         case 'summary':
 102         case 'scales':
 103         case 'questions':
 104             $PAGE->navbar->add($strreport);
 105             $PAGE->navbar->add(${'str'.$action});
 106             break;
 107         case 'students':
 108             $PAGE->navbar->add($strreport);
 109             $PAGE->navbar->add(get_string('participants'));
 110             break;
 111         case '':
 112             $PAGE->navbar->add($strreport);
 113             $PAGE->navbar->add($strsummary);
 114             break;
 115         default:
 116             $PAGE->navbar->add($strreport);
 117             break;
 118     }
 119
 120     $PAGE->set_title("$course->shortname: ".format_string($survey->name));
 121     $PAGE->set_heading($course->fullname);
 122     echo $OUTPUT->header();
 123
 124 /// Check to see if groups are being used in this survey
 125     if ($groupmode = groups_get_activity_groupmode($cm)) {   // Groups are being used
 126         $menuaction = $action == "student" ? "students" : $action;
 127         $currentgroup = groups_get_activity_group($cm, true);
 128         groups_print_activity_menu($cm, $CFG->wwwroot . "/mod/survey/report.php?id=$cm->id&amp;action=$menuaction&amp;qid=$qid");
 129     } else {
 130         $currentgroup = 0;
 131     }
 132
 133     if ($currentgroup) {
 134         $users = get_users_by_capability($context, 'mod/survey:participate', '', '', '', '', $currentgroup, null, false);
 135     } else if (!empty($cm->groupingid)) {
 136         $groups = groups_get_all_groups($courseid, 0, $cm->groupingid);
 137         $groups = array_keys($groups);
 138         $users = get_users_by_capability($context, 'mod/survey:participate', '', '', '', '', $groups, null, false);
 139     } else {
 140         $users = get_users_by_capability($context, 'mod/survey:participate', '', '', '', '', '', null, false);
 141         $group = false;
 142     }
 143
 144     $groupingid = $cm->groupingid;
 145
 146     echo $OUTPUT->box_start("generalbox boxaligncenter");
 147     if ($showscales) {
 148         echo "<a href=\"report.php?action=summary&amp;id=$id\">$strsummary</a>";
 149         echo "&nbsp;&nbsp;&nbsp;&nbsp;<a href=\"report.php?action=scales&amp;id=$id\">$strscales</a>";
 150         echo "&nbsp;&nbsp;&nbsp;&nbsp;<a href=\"report.php?action=questions&amp;id=$id\">$strquestions</a>";
 151         echo "&nbsp;&nbsp;&nbsp;&nbsp;<a href=\"report.php?action=students&amp;id=$id\">".get_string('participants')."</a>";
 152         if (has_capability('mod/survey:download', $context)) {
 153             echo "&nbsp;&nbsp;&nbsp;&nbsp;<a href=\"report.php?action=download&amp;id=$id\">$strdownload</a>";
 154         }
 155         if (empty($action)) {
 156             $action = "summary";
 157         }
 158     } else {
 159         echo "<a href=\"report.php?action=questions&amp;id=$id\">$strquestions</a>";
 160         echo "&nbsp;&nbsp;&nbsp;&nbsp;<a href=\"report.php?action=students&amp;id=$id\">".get_string('participants')."</a>";
 161         if (has_capability('mod/survey:download', $context)) {
 162             echo "&nbsp;&nbsp;&nbsp;&nbsp;<a href=\"report.php?action=download&amp;id=$id\">$strdownload</a>";
 163         }
 164         if (empty($action)) {
 165             $action = "questions";
 166         }
 167     }
 168     echo $OUTPUT->box_end();
 169
 170     echo $OUTPUT->spacer(array('height'=>30, 'width'=>30, 'br'=>true)); // should be done with CSS instead
 171
 172
 173 /// Print the menu across the top
 174
 175     $virtualscales = false;
 176
 177     switch ($action) {
 178
 179       case "summary":
 180         echo $OUTPUT->heading($strsummary);
 181
 182         if (survey_count_responses($survey->id, $currentgroup, $groupingid)) {
 183             echo "<div class='reportsummary'><a href=\"report.php?action=scales&amp;id=$id\">";
 184             survey_print_graph("id=$id&amp;group=$currentgroup&amp;type=overall.png");
 185             echo "</a></div>";
 186         } else {
 187             echo $OUTPUT->notification(get_string("nobodyyet","survey"));
 188         }
 189         break;
 190
 191       case "scales":
 192         echo $OUTPUT->heading($strscales);
 193
 194         if (! $results = survey_get_responses($survey->id, $currentgroup, $groupingid) ) {
 195             echo $OUTPUT->notification(get_string("nobodyyet","survey"));
 196
 197         } else {
 198
 199             $questions = $DB->get_records_list("survey_questions", "id", explode(',', $survey->questions));
 200             $questionorder = explode(",", $survey->questions);
 201
 202             foreach ($questionorder as $key => $val) {
 203                 $question = $questions[$val];
 204                 if ($question->type < 0) {  // We have some virtual scales.  Just show them.
 205                     $virtualscales = true;
 206                     break;
 207                 }
 208             }
 209
 210             foreach ($questionorder as $key => $val) {
 211                 $question = $questions[$val];
 212                 if ($question->multi) {
 213                     if (!empty($virtualscales) && $question->type > 0) {  // Don't show non-virtual scales if virtual
 214                         continue;
 215                     }
 216                     echo "<p class=\"centerpara\"><a title=\"$strseemoredetail\" href=\"report.php?action=questions&amp;id=$id&amp;qid=$question->multi\">";
 217                     survey_print_graph("id=$id&amp;qid=$question->id&amp;group=$currentgroup&amp;type=multiquestion.png");
 218                     echo "</a></p><br />";
 219                 }
 220             }
 221         }
 222
 223         break;
 224
 225       case "questions":
 226
 227         if ($qid) {     // just get one multi-question
 228             $questions = $DB->get_records_select("survey_questions", "id in ($qid)");
 229             $questionorder = explode(",", $qid);
 230
 231             if ($scale = $DB->get_records("survey_questions", array("multi"=>$qid))) {
 232                 $scale = array_pop($scale);
 233                 echo $OUTPUT->heading("$scale->text - $strselectedquestions");
 234             } else {
 235                 echo $OUTPUT->heading($strselectedquestions);
 236             }
 237
 238         } else {        // get all top-level questions
 239             $questions = $DB->get_records_list("survey_questions", "id", explode(',',$survey->questions));
 240             $questionorder = explode(",", $survey->questions);
 241
 242             echo $OUTPUT->heading($strallquestions);
 243         }
 244
 245         if (! $results = survey_get_responses($survey->id, $currentgroup, $groupingid) ) {
 246             echo $OUTPUT->notification(get_string("nobodyyet","survey"));
 247
 248         } else {
 249
 250             foreach ($questionorder as $key => $val) {
 251                 $question = $questions[$val];
 252                 if ($question->type < 0) {  // We have some virtual scales.  DON'T show them.
 253                     $virtualscales = true;
 254                     break;
 255                 }
 256             }
 257
 258             foreach ($questionorder as $key => $val) {
 259                 $question = $questions[$val];
 260
 261                 if ($question->type < 0) {  // We have some virtual scales.  DON'T show them.
 262                     continue;
 263                 }
 264                 $question->text = get_string($question->text, "survey");
 265
 266                 if ($question->multi) {
 267                     echo "<h3>$question->text:</h3>";
 268
 269                     $subquestions = $DB->get_records_list("survey_questions", "id", explode(',', $question->multi));
 270                     $subquestionorder = explode(",", $question->multi);
 271                     foreach ($subquestionorder as $key => $val) {
 272                         $subquestion = $subquestions[$val];
 273                         if ($subquestion->type > 0) {
 274                             echo "<p class=\"centerpara\">";
 275                             echo "<a title=\"$strseemoredetail\" href=\"report.php?action=question&amp;id=$id&amp;qid=$subquestion->id\">";
 276                             survey_print_graph("id=$id&amp;qid=$subquestion->id&amp;group=$currentgroup&amp;type=question.png");
 277                             echo "</a></p>";
 278                         }
 279                     }
 280                 } else if ($question->type > 0 ) {
 281                     echo "<p class=\"centerpara\">";
 282                     echo "<a title=\"$strseemoredetail\" href=\"report.php?action=question&amp;id=$id&amp;qid=$question->id\">";
 283                     survey_print_graph("id=$id&amp;qid=$question->id&amp;group=$currentgroup&amp;type=question.png");
 284                     echo "</a></p>";
 285
 286                 } else {
 287                     $table = new html_table();
 288                     $table->head = array($question->text);
 289                     $table->align = array ("left");
 290
 291                     $contents = '<table cellpadding="15" width="100%">';
 292
 293                     if ($aaa = survey_get_user_answers($survey->id, $question->id, $currentgroup, "sa.time ASC")) {
 294                         foreach ($aaa as $a) {
 295                             $contents .= "<tr>";
 296                             $contents .= '<td class="fullnamecell">'.fullname($a).'</td>';
 297                             $contents .= '<td valign="top">'.$a->answer1.'</td>';
 298                             $contents .= "</tr>";
 299                         }
 300                     }
 301                     $contents .= "</table>";
 302
 303                     $table->data[] = array($contents);
 304
 305                     echo html_writer::table($table);
 306
 307                     echo $OUTPUT->spacer(array('height'=>30)); // should be done with CSS instead
 308                 }
 309             }
 310         }
 311
 312         break;
 313
 314       case "question":
 315         if (!$question = $DB->get_record("survey_questions", array("id"=>$qid))) {
 316             print_error('cannotfindquestion', 'survey');
 317         }
 318         $question->text = get_string($question->text, "survey");
 319
 320         $answers =  explode(",", get_string($question->options, "survey"));
 321
 322         echo $OUTPUT->heading("$strquestion: $question->text");
 323
 324
 325         $strname = get_string("name", "survey");
 326         $strtime = get_string("time", "survey");
 327         $stractual = get_string("actual", "survey");
 328         $strpreferred = get_string("preferred", "survey");
 329         $strdateformat = get_string("strftimedatetime");
 330
 331         $table = new html_table();
 332         $table->head = array("", $strname, $strtime, $stractual, $strpreferred);
 333         $table->align = array ("left", "left", "left", "left", "right");
 334         $table->size = array (35, "", "", "", "");
 335
 336         if ($aaa = survey_get_user_answers($survey->id, $question->id, $currentgroup)) {
 337             foreach ($aaa as $a) {
 338                 if ($a->answer1) {
 339                     $answer1 =  "$a->answer1 - ".$answers[$a->answer1 - 1];
 340                 } else {
 341                     $answer1 =  "&nbsp;";
 342                 }
 343                 if ($a->answer2) {
 344                     $answer2 = "$a->answer2 - ".$answers[$a->answer2 - 1];
 345                 } else {
 346                     $answer2 = "&nbsp;";
 347                 }
 348                 $table->data[] = array(
 349                        $OUTPUT->user_picture($a, array('courseid'=>$course->id)),
 350                        "<a href=\"report.php?id=$id&amp;action=student&amp;student=$a->userid\">".fullname($a)."</a>",
 351                        userdate($a->time),
 352                        $answer1, $answer2);
 353
 354             }
 355         }
 356
 357         echo html_writer::table($table);
 358
 359         break;
 360
 361       case "students":
 362
 363          echo $OUTPUT->heading(get_string("analysisof", "survey", get_string('participants')));
 364
 365          if (! $results = survey_get_responses($survey->id, $currentgroup, $groupingid) ) {
 366              echo $OUTPUT->notification(get_string("nobodyyet","survey"));
 367          } else {
 368              survey_print_all_responses($cm->id, $results, $course->id);
 369          }
 370
 371         break;
 372
 373       case "student":
 374          if (!$user = $DB->get_record("user", array("id"=>$student))) {
 375              print_error('invaliduserid');
 376          }
 377
 378          echo $OUTPUT->heading(get_string("analysisof", "survey", fullname($user)));
 379
 380          if ($notes != '' and confirm_sesskey()) {
 381              if (survey_get_analysis($survey->id, $user->id)) {
 382                  if (! survey_update_analysis($survey->id, $user->id, $notes)) {
 383                      echo $OUTPUT->notification("An error occurred while saving your notes.  Sorry.");
 384                  } else {
 385                      echo $OUTPUT->notification(get_string("savednotes", "survey"));
 386                  }
 387              } else {
 388                  if (! survey_add_analysis($survey->id, $user->id, $notes)) {
 389                      echo $OUTPUT->notification("An error occurred while saving your notes.  Sorry.");
 390                  } else {
 391                      echo $OUTPUT->notification(get_string("savednotes", "survey"));
 392                  }
 393              }
 394          }
 395
 396          echo "<p <p class=\"centerpara\">";
 397          echo $OUTPUT->user_picture($user, array('courseid'=>$course->id));
 398          echo "</p>";
 399
 400          $questions = $DB->get_records_list("survey_questions", "id", explode(',', $survey->questions));
 401          $questionorder = explode(",", $survey->questions);
 402
 403          if ($showscales) {
 404              // Print overall summary
 405              echo "<p <p class=\"centerpara\">>";
 406              survey_print_graph("id=$id&amp;sid=$student&amp;type=student.png");
 407              echo "</p>";
 408
 409              // Print scales
 410
 411              foreach ($questionorder as $key => $val) {
 412                  $question = $questions[$val];
 413                  if ($question->type < 0) {  // We have some virtual scales.  Just show them.
 414                      $virtualscales = true;
 415                      break;
 416                  }
 417              }
 418
 419              foreach ($questionorder as $key => $val) {
 420                  $question = $questions[$val];
 421                  if ($question->multi) {
 422                      if ($virtualscales && $question->type > 0) {  // Don't show non-virtual scales if virtual
 423                          continue;
 424                      }
 425                      echo "<p class=\"centerpara\">";
 426                      echo "<a title=\"$strseemoredetail\" href=\"report.php?action=questions&amp;id=$id&amp;qid=$question->multi\">";
 427                      survey_print_graph("id=$id&amp;qid=$question->id&amp;sid=$student&amp;type=studentmultiquestion.png");
 428                      echo "</a></p><br />";
 429                  }
 430              }
 431          }
 432
 433          // Print non-scale questions
 434
 435          foreach ($questionorder as $key => $val) {
 436              $question = $questions[$val];
 437              if ($question->type == 0 or $question->type == 1) {
 438                  if ($answer = survey_get_user_answer($survey->id, $question->id, $user->id)) {
 439                     $table = new html_table();
 440                      $table->head = array(get_string($question->text, "survey"));
 441                      $table->align = array ("left");
 442                      $table->data[] = array(s($answer->answer1)); // no html here, just plain text
 443                      echo html_writer::table($table);
 444                      echo $OUTPUT->spacer(array('height'=>30));
 445                  }
 446              }
 447          }
 448
 449          if ($rs = survey_get_analysis($survey->id, $user->id)) {
 450             $notes = $rs->notes;
 451          } else {
 452             $notes = "";
 453          }
 454          echo "<hr noshade=\"noshade\" size=\"1\" />";
 455          echo "<div class='studentreport'>";
 456          echo "<form action=\"report.php\" method=\"post\">";
 457          echo "<h3>$strnotes:</h3>";
 458          echo "<blockquote>";
 459          echo "<textarea name=\"notes\" rows=\"10\" cols=\"60\">";
 460          p($notes);
 461          echo "</textarea><br />";
 462          echo "<input type=\"hidden\" name=\"action\" value=\"student\" />";
 463          echo "<input type=\"hidden\" name=\"sesskey\" value=\"".sesskey()."\" />";
 464          echo "<input type=\"hidden\" name=\"student\" value=\"$student\" />";
 465          echo "<input type=\"hidden\" name=\"id\" value=\"$cm->id\" />";
 466          echo "<input type=\"submit\" value=\"".get_string("savechanges")."\" />";
 467          echo "</blockquote>";
 468          echo "</form>";
 469          echo "</div>";
 470
 471
 472          break;
 473
 474       case "download":
 475         echo $OUTPUT->heading($strdownload);
 476
 477         require_capability('mod/survey:download', $context);
 478
 479         echo '<p class="centerpara">'.get_string("downloadinfo", "survey").'</p>';
 480
 481         echo $OUTPUT->container_start('reportbuttons');
 482         $options = array();
 483         $options["id"] = "$cm->id";
 484         $options["group"] = $currentgroup;
 485
 486         $options["type"] = "ods";
 487         echo $OUTPUT->single_button(new moodle_url("download.php", $options), get_string("downloadods"));
 488
 489         $options["type"] = "xls";
 490         echo $OUTPUT->single_button(new moodle_url("download.php", $options), get_string("downloadexcel"));
 491
 492         $options["type"] = "txt";
 493         echo $OUTPUT->single_button(new moodle_url("download.php", $options), get_string("downloadtext"));
 494         echo $OUTPUT->container_end();
 495
 496         break;
 497
 498     }
 499     echo $OUTPUT->footer();
 500