mod/survey/lib.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  * @package   mod-survey
  20  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
  21  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  22  */
  23
  24 /**
  25  * Graph size
  26  * @global int $SURVEY_GHEIGHT
  27  */
  28 global $SURVEY_GHEIGHT;
  29 $SURVEY_GHEIGHT = 500;
  30 /**
  31  * Graph size
  32  * @global int $SURVEY_GWIDTH
  33  */
  34 global $SURVEY_GWIDTH;
  35 $SURVEY_GWIDTH  = 900;
  36 /**
  37  * Question Type
  38  * @global array $SURVEY_QTYPE
  39  */
  40 global $SURVEY_QTYPE;
  41 $SURVEY_QTYPE = array (
  42         "-3" => "Virtual Actual and Preferred",
  43         "-2" => "Virtual Preferred",
  44         "-1" => "Virtual Actual",
  45          "0" => "Text",
  46          "1" => "Actual",
  47          "2" => "Preferred",
  48          "3" => "Actual and Preferred",
  49         );
  50
  51
  52 define("SURVEY_COLLES_ACTUAL",           "1");
  53 define("SURVEY_COLLES_PREFERRED",        "2");
  54 define("SURVEY_COLLES_PREFERRED_ACTUAL", "3");
  55 define("SURVEY_ATTLS",                   "4");
  56 define("SURVEY_CIQ",                     "5");
  57
  58
  59 // STANDARD FUNCTIONS ////////////////////////////////////////////////////////
  60 /**
  61  * Given an object containing all the necessary data,
  62  * (defined by the form in mod_form.php) this function
  63  * will create a new instance and return the id number
  64  * of the new instance.
  65  *
  66  * @global object
  67  * @param object $survey
  68  * @return int|bool
  69  */
  70 function survey_add_instance($survey) {
  71     global $DB;
  72
  73     if (!$template = $DB->get_record("survey", array("id"=>$survey->template))) {
  74         return 0;
  75     }
  76
  77     $survey->questions    = $template->questions;
  78     $survey->timecreated  = time();
  79     $survey->timemodified = $survey->timecreated;
  80
  81     return $DB->insert_record("survey", $survey);
  82
  83 }
  84
  85 /**
  86  * Given an object containing all the necessary data,
  87  * (defined by the form in mod_form.php) this function
  88  * will update an existing instance with new data.
  89  *
  90  * @global object
  91  * @param object $survey
  92  * @return bool
  93  */
  94 function survey_update_instance($survey) {
  95     global $DB;
  96
  97     if (!$template = $DB->get_record("survey", array("id"=>$survey->template))) {
  98         return 0;
  99     }
 100
 101     $survey->id           = $survey->instance;
 102     $survey->questions    = $template->questions;
 103     $survey->timemodified = time();
 104
 105     return $DB->update_record("survey", $survey);
 106 }
 107
 108 /**
 109  * Given an ID of an instance of this module,
 110  * this function will permanently delete the instance
 111  * and any data that depends on it.
 112  *
 113  * @global object
 114  * @param int $id
 115  * @return bool
 116  */
 117 function survey_delete_instance($id) {
 118     global $DB;
 119
 120     if (! $survey = $DB->get_record("survey", array("id"=>$id))) {
 121         return false;
 122     }
 123
 124     $result = true;
 125
 126     if (! $DB->delete_records("survey_analysis", array("survey"=>$survey->id))) {
 127         $result = false;
 128     }
 129
 130     if (! $DB->delete_records("survey_answers", array("survey"=>$survey->id))) {
 131         $result = false;
 132     }
 133
 134     if (! $DB->delete_records("survey", array("id"=>$survey->id))) {
 135         $result = false;
 136     }
 137
 138     return $result;
 139 }
 140
 141 /**
 142  * @global object
 143  * @param object $course
 144  * @param object $user
 145  * @param object $mod
 146  * @param object $survey
 147  * @return $result
 148  */
 149 function survey_user_outline($course, $user, $mod, $survey) {
 150     global $DB;
 151
 152     if ($answers = $DB->get_records("survey_answers", array('survey'=>$survey->id, 'userid'=>$user->id))) {
 153         $lastanswer = array_pop($answers);
 154
 155         $result = new stdClass();
 156         $result->info = get_string("done", "survey");
 157         $result->time = $lastanswer->time;
 158         return $result;
 159     }
 160     return NULL;
 161 }
 162
 163 /**
 164  * @global stdObject
 165  * @global object
 166  * @uses SURVEY_CIQ
 167  * @param object $course
 168  * @param object $user
 169  * @param object $mod
 170  * @param object $survey
 171  */
 172 function survey_user_complete($course, $user, $mod, $survey) {
 173     global $CFG, $DB, $OUTPUT;
 174
 175     if (survey_already_done($survey->id, $user->id)) {
 176         if ($survey->template == SURVEY_CIQ) { // print out answers for critical incidents
 177             $table = new html_table();
 178             $table->align = array("left", "left");
 179
 180             $questions = $DB->get_records_list("survey_questions", "id", explode(',', $survey->questions));
 181             $questionorder = explode(",", $survey->questions);
 182
 183             foreach ($questionorder as $key=>$val) {
 184                 $question = $questions[$val];
 185                 $questiontext = get_string($question->shorttext, "survey");
 186
 187                 if ($answer = survey_get_user_answer($survey->id, $question->id, $user->id)) {
 188                     $answertext = "$answer->answer1";
 189                 } else {
 190                     $answertext = "No answer";
 191                 }
 192                 $table->data[] = array("<b>$questiontext</b>", $answertext);
 193             }
 194             echo html_writer::table($table);
 195
 196         } else {
 197
 198             survey_print_graph("id=$mod->id&amp;sid=$user->id&amp;type=student.png");
 199         }
 200
 201     } else {
 202         print_string("notdone", "survey");
 203     }
 204 }
 205
 206 /**
 207  * @global stdClass
 208  * @global object
 209  * @param object $course
 210  * @param mixed $viewfullnames
 211  * @param int $timestamp
 212  * @return bool
 213  */
 214 function survey_print_recent_activity($course, $viewfullnames, $timestart) {
 215     global $CFG, $DB, $OUTPUT;
 216
 217     $modinfo = get_fast_modinfo($course);
 218     $ids = array();
 219     foreach ($modinfo->cms as $cm) {
 220         if ($cm->modname != 'survey') {
 221             continue;
 222         }
 223         if (!$cm->uservisible) {
 224             continue;
 225         }
 226         $ids[$cm->instance] = $cm->instance;
 227     }
 228
 229     if (!$ids) {
 230         return false;
 231     }
 232
 233     $slist = implode(',', $ids); // there should not be hundreds of glossaries in one course, right?
 234
 235     $rs = $DB->get_recordset_sql("SELECT sa.userid, sa.survey, MAX(sa.time) AS time,
 236                                          u.firstname, u.lastname, u.email, u.picture
 237                                     FROM {survey_answers} sa
 238                                     JOIN {user} u ON u.id = sa.userid
 239                                    WHERE sa.survey IN ($slist) AND sa.time > ?
 240                                 GROUP BY sa.userid, sa.survey, u.firstname, u.lastname, u.email, u.picture
 241                                 ORDER BY time ASC", array($timestart));
 242     if (!$rs->valid()) {
 243         $rs->close(); // Not going to iterate (but exit), close rs
 244         return false;
 245     }
 246
 247     $surveys = array();
 248
 249     foreach ($rs as $survey) {
 250         $cm = $modinfo->instances['survey'][$survey->survey];
 251         $survey->name = $cm->name;
 252         $survey->cmid = $cm->id;
 253         $surveys[] = $survey;
 254     }
 255     $rs->close();
 256
 257     if (!$surveys) {
 258         return false;
 259     }
 260
 261     echo $OUTPUT->heading(get_string('newsurveyresponses', 'survey').':');
 262     foreach ($surveys as $survey) {
 263         $url = $CFG->wwwroot.'/mod/survey/view.php?id='.$survey->cmid;
 264         print_recent_activity_note($survey->time, $survey, $survey->name, $url, false, $viewfullnames);
 265     }
 266
 267     return true;
 268 }
 269
 270 // SQL FUNCTIONS ////////////////////////////////////////////////////////
 271
 272 /**
 273  * @global object
 274  * @param sting $log
 275  * @return array
 276  */
 277 function survey_log_info($log) {
 278     global $DB;
 279     return $DB->get_record_sql("SELECT s.name, u.firstname, u.lastname, u.picture
 280                                   FROM {survey} s, {user} u
 281                                  WHERE s.id = ?  AND u.id = ?", array($log->info, $log->userid));
 282 }
 283
 284 /**
 285  * @global object
 286  * @param int $surveyid
 287  * @param int $groupid
 288  * @param int $groupingid
 289  * @return array
 290  */
 291 function survey_get_responses($surveyid, $groupid, $groupingid) {
 292     global $DB;
 293
 294     $params = array('surveyid'=>$surveyid, 'groupid'=>$groupid, 'groupingid'=>$groupingid);
 295
 296     if ($groupid) {
 297         $groupsjoin = "JOIN {groups_members} gm ON u.id = gm.userid AND gm.groupid = :groupid ";
 298
 299     } else if ($groupingid) {
 300         $groupsjoin = "JOIN {groups_members} gm ON u.id = gm.userid
 301                        JOIN {groupings_groups} gg ON gm.groupid = gg.groupid AND gg.groupingid = :groupingid ";
 302     } else {
 303         $groupsjoin = "";
 304     }
 305
 306     $userfields = user_picture::fields('u');
 307     return $DB->get_records_sql("SELECT $userfields, MAX(a.time) as time
 308                                    FROM {survey_answers} a
 309                                    JOIN {user} u ON a.userid = u.id
 310                             $groupsjoin
 311                                   WHERE a.survey = :surveyid
 312                                GROUP BY $userfields
 313                                ORDER BY time ASC", $params);
 314 }
 315
 316 /**
 317  * @global object
 318  * @param int $survey
 319  * @param int $user
 320  * @return array
 321  */
 322 function survey_get_analysis($survey, $user) {
 323     global $DB;
 324
 325     return $DB->get_record_sql("SELECT notes
 326                                   FROM {survey_analysis}
 327                                  WHERE survey=? AND userid=?", array($survey, $user));
 328 }
 329
 330 /**
 331  * @global object
 332  * @param int $survey
 333  * @param int $user
 334  * @param string $notes
 335  */
 336 function survey_update_analysis($survey, $user, $notes) {
 337     global $DB;
 338
 339     return $DB->execute("UPDATE {survey_analysis}
 340                             SET notes=?
 341                           WHERE survey=?
 342                             AND userid=?", array($notes, $survey, $user));
 343 }
 344
 345 /**
 346  * @global object
 347  * @param int $surveyid
 348  * @param int $groupid
 349  * @param string $sort
 350  * @return array
 351  */
 352 function survey_get_user_answers($surveyid, $questionid, $groupid, $sort="sa.answer1,sa.answer2 ASC") {
 353     global $DB;
 354
 355     $params = array('surveyid'=>$surveyid, 'questionid'=>$questionid);
 356
 357     if ($groupid) {
 358         $groupfrom = ', {groups_members} gm';
 359         $groupsql  = 'AND gm.groupid = :groupid AND u.id = gm.userid';
 360         $params['groupid'] = $groupid;
 361     } else {
 362         $groupfrom = '';
 363         $groupsql  = '';
 364     }
 365
 366     $userfields = user_picture::fields('u');
 367     return $DB->get_records_sql("SELECT sa.*, $userfields
 368                                    FROM {survey_answers} sa,  {user} u $groupfrom
 369                                   WHERE sa.survey = :surveyid
 370                                         AND sa.question = :questionid
 371                                         AND u.id = sa.userid $groupsql
 372                                ORDER BY $sort", $params);
 373 }
 374
 375 /**
 376  * @global object
 377  * @param int $surveyid
 378  * @param int $questionid
 379  * @param int $userid
 380  * @return array
 381  */
 382 function survey_get_user_answer($surveyid, $questionid, $userid) {
 383     global $DB;
 384
 385     return $DB->get_record_sql("SELECT sa.*
 386                                   FROM {survey_answers} sa
 387                                  WHERE sa.survey = ?
 388                                        AND sa.question = ?
 389                                        AND sa.userid = ?", array($surveyid, $questionid, $userid));
 390 }
 391
 392 // MODULE FUNCTIONS ////////////////////////////////////////////////////////
 393 /**
 394  * @global object
 395  * @param int $survey
 396  * @param int $user
 397  * @param string $notes
 398  * @return bool|int
 399  */
 400 function survey_add_analysis($survey, $user, $notes) {
 401     global $DB;
 402
 403     $record = new stdClass();
 404     $record->survey = $survey;
 405     $record->userid = $user;
 406     $record->notes = $notes;
 407
 408     return $DB->insert_record("survey_analysis", $record, false);
 409 }
 410 /**
 411  * @global object
 412  * @param int $survey
 413  * @param int $user
 414  * @return bool
 415  */
 416 function survey_already_done($survey, $user) {
 417     global $DB;
 418
 419     return $DB->record_exists("survey_answers", array("survey"=>$survey, "userid"=>$user));
 420 }
 421 /**
 422  * @param int $surveyid
 423  * @param int $groupid
 424  * @param int $groupingid
 425  * @return int
 426  */
 427 function survey_count_responses($surveyid, $groupid, $groupingid) {
 428     if ($responses = survey_get_responses($surveyid, $groupid, $groupingid)) {
 429         return count($responses);
 430     } else {
 431         return 0;
 432     }
 433 }
 434
 435 /**
 436  * @param int $cmid
 437  * @param array $results
 438  * @param int $courseid
 439  */
 440 function survey_print_all_responses($cmid, $results, $courseid) {
 441     global $OUTPUT;
 442     $table = new html_table();
 443     $table->head  = array ("", get_string("name"),  get_string("time"));
 444     $table->align = array ("", "left", "left");
 445     $table->size = array (35, "", "" );
 446
 447     foreach ($results as $a) {
 448         $table->data[] = array($OUTPUT->user_picture($a, array('courseid'=>$courseid)),
 449                html_writer::link("report.php?action=student&student=$a->id&id=$cmid", fullname($a)),
 450                userdate($a->time));
 451     }
 452
 453     echo html_writer::table($table);
 454 }
 455
 456 /**
 457  * @global object
 458  * @param int $templateid
 459  * @return string
 460  */
 461 function survey_get_template_name($templateid) {
 462     global $DB;
 463
 464     if ($templateid) {
 465         if ($ss = $DB->get_record("surveys", array("id"=>$templateid))) {
 466             return $ss->name;
 467         }
 468     } else {
 469         return "";
 470     }
 471 }
 472
 473
 474 /**
 475  * @param string $name
 476  * @param array $numwords
 477  * @return string
 478  */
 479 function survey_shorten_name ($name, $numwords) {
 480     $words = explode(" ", $name);
 481     $output = '';
 482     for ($i=0; $i < $numwords; $i++) {
 483         $output .= $words[$i]." ";
 484     }
 485     return $output;
 486 }
 487
 488 /**
 489  * @todo Check this function
 490  *
 491  * @global object
 492  * @global object
 493  * @global int
 494  * @global void This is never defined
 495  * @global object This is defined twice?
 496  * @param object $question
 497  */
 498 function survey_print_multi($question) {
 499     global $USER, $DB, $qnum, $checklist, $DB, $OUTPUT; //TODO: this is sloppy globals abuse
 500
 501     $stripreferthat = get_string("ipreferthat", "survey");
 502     $strifoundthat = get_string("ifoundthat", "survey");
 503     $strdefault    = get_string('notyetanswered', 'survey');
 504     $strresponses  = get_string('responses', 'survey');
 505
 506     echo $OUTPUT->heading($question->text, 3, 'questiontext');
 507     echo "\n<table width=\"90%\" cellpadding=\"4\" cellspacing=\"1\" border=\"0\" class=\"surveytable\">";
 508
 509     $options = explode( ",", $question->options);
 510     $numoptions = count($options);
 511
 512     // COLLES Actual (which is having questions of type 1) and COLLES Preferred (type 2)
 513     // expect just one answer per question. COLLES Actual and Preferred (type 3) expects
 514     // two answers per question. ATTLS (having a single question of type 1) expects one
 515     // answer per question. CIQ is not using multiquestions (i.e. a question with subquestions).
 516     // Note that the type of subquestions does not really matter, it's the type of the
 517     // question itself that determines everything.
 518     $oneanswer = ($question->type == 1 || $question->type == 2) ? true : false;
 519
 520     // COLLES Preferred (having questions of type 2) will use the radio elements with the name
 521     // like qP1, qP2 etc. COLLES Actual and ATTLS have radios like q1, q2 etc.
 522     if ($question->type == 2) {
 523         $P = "P";
 524     } else {
 525         $P = "";
 526     }
 527
 528     echo "<tr class=\"smalltext\"><th scope=\"row\">$strresponses</th>";
 529     echo "<th scope=\"col\" class=\"hresponse\">". get_string('notyetanswered', 'survey'). "</th>";
 530     while (list ($key, $val) = each ($options)) {
 531         echo "<th scope=\"col\" class=\"hresponse\">$val</th>\n";
 532     }
 533     echo "</tr>\n";
 534
 535     if ($oneanswer) {
 536         echo "<tr><th scope=\"col\" colspan=\"7\">$question->intro</th></tr>\n";
 537     } else {
 538         echo "<tr><th scope=\"col\" colspan=\"7\">$question->intro</th></tr>\n";
 539     }
 540
 541     $subquestions = $DB->get_records_list("survey_questions", "id", explode(',', $question->multi));
 542
 543     foreach ($subquestions as $q) {
 544         $qnum++;
 545         if ($oneanswer) {
 546             $rowclass = survey_question_rowclass($qnum);
 547         } else {
 548             $rowclass = survey_question_rowclass(round($qnum / 2));
 549         }
 550         if ($q->text) {
 551             $q->text = get_string($q->text, "survey");
 552         }
 553
 554         echo "<tr class=\"$rowclass rblock\">";
 555         if ($oneanswer) {
 556             echo "<th scope=\"row\" class=\"optioncell\">";
 557             echo "<b class=\"qnumtopcell\">$qnum</b> &nbsp; ";
 558             echo $q->text ."</th>\n";
 559
 560             $default = get_accesshide($strdefault);
 561             echo "<td class=\"whitecell\"><label for=\"q$P$q->id\"><input type=\"radio\" name=\"q$P$q->id\" id=\"q$P" . $q->id . "_D\" value=\"0\" checked=\"checked\" />$default</label></td>";
 562
 563             for ($i=1;$i<=$numoptions;$i++) {
 564                 $hiddentext = get_accesshide($options[$i-1]);
 565                 $id = "q$P" . $q->id . "_$i";
 566                 echo "<td><label for=\"$id\"><input type=\"radio\" name=\"q$P$q->id\" id=\"$id\" value=\"$i\" />$hiddentext</label></td>";
 567             }
 568             $checklist["q$P$q->id"] = 0;
 569
 570         } else {
 571             echo "<th scope=\"row\" class=\"optioncell\">";
 572             echo "<b class=\"qnumtopcell\">$qnum</b> &nbsp; ";
 573             $qnum++;
 574             echo "<span class=\"preferthat\">$stripreferthat</span> &nbsp; ";
 575             echo "<span class=\"option\">$q->text</span></th>\n";
 576
 577             $default = get_accesshide($strdefault);
 578             echo '<td class="whitecell"><label for="qP'. $P.$q->id .'"><input type="radio" name="qP'.$P.$q->id. '" id="qP'. $q->id .'" value="0" checked="checked" />'.$default.'</label></td>';
 579
 580
 581             for ($i=1;$i<=$numoptions;$i++) {
 582                 $hiddentext = get_accesshide($options[$i-1]);
 583                 $id = "qP" . $q->id . "_$i";
 584                 echo "<td><label for=\"$id\"><input type=\"radio\" name=\"qP$q->id\" id=\"$id\" value=\"$i\" />$hiddentext</label></td>";
 585             }
 586             echo "</tr>";
 587
 588             echo "<tr class=\"$rowclass rblock\">";
 589             echo "<th scope=\"row\" class=\"optioncell\">";
 590             echo "<b class=\"qnumtopcell\">$qnum</b> &nbsp; ";
 591             echo "<span class=\"foundthat\">$strifoundthat</span> &nbsp; ";
 592             echo "<span class=\"option\">$q->text</span></th>\n";
 593
 594             $default = get_accesshide($strdefault);
 595             echo '<td class="whitecell"><label for="q'. $q->id .'"><input type="radio" name="q'.$q->id. '" id="q'. $q->id .'" value="0" checked="checked" />'.$default.'</label></td>';
 596
 597             for ($i=1;$i<=$numoptions;$i++) {
 598                 $hiddentext = get_accesshide($options[$i-1]);
 599                 $id = "q" . $q->id . "_$i";
 600                 echo "<td><label for=\"$id\"><input type=\"radio\" name=\"q$q->id\" id=\"$id\" value=\"$i\" />$hiddentext</label></td>";
 601             }
 602
 603             $checklist["qP$q->id"] = 0;
 604             $checklist["q$q->id"] = 0;
 605         }
 606         echo "</tr>\n";
 607     }
 608     echo "</table>";
 609 }
 610
 611
 612 /**
 613  * @global object
 614  * @global int
 615  * @param object $question
 616  */
 617 function survey_print_single($question) {
 618     global $DB, $qnum, $OUTPUT;
 619
 620     $rowclass = survey_question_rowclass(0);
 621
 622     $qnum++;
 623
 624     echo "<br />\n";
 625     echo "<table width=\"90%\" cellpadding=\"4\" cellspacing=\"0\">\n";
 626     echo "<tr class=\"$rowclass\">";
 627     echo "<th scope=\"row\" class=\"optioncell\"><label for=\"q$question->id\"><b class=\"qnumtopcell\">$qnum</b> &nbsp; ";
 628     echo "<span class=\"questioncell\">$question->text</span></label></th>\n";
 629     echo "<td class=\"questioncell smalltext\">\n";
 630
 631
 632     if ($question->type == 0) {           // Plain text field
 633         echo "<textarea rows=\"3\" cols=\"30\" name=\"q$question->id\" id=\"q$question->id\">$question->options</textarea>";
 634
 635     } else if ($question->type > 0) {     // Choose one of a number
 636         $strchoose = get_string("choose");
 637         echo "<select name=\"q$question->id\" id=\"q$question->id\">";
 638         echo "<option value=\"0\" selected=\"selected\">$strchoose...</option>";
 639         $options = explode( ",", $question->options);
 640         foreach ($options as $key => $val) {
 641             $key++;
 642             echo "<option value=\"$key\">$val</option>";
 643         }
 644         echo "</select>";
 645
 646     } else if ($question->type < 0) {     // Choose several of a number
 647         $options = explode( ",", $question->options);
 648         echo $OUTPUT->notification("This question type not supported yet");
 649     }
 650
 651     echo "</td></tr></table>";
 652
 653 }
 654
 655 /**
 656  *
 657  * @param int $qnum
 658  * @return string
 659  */
 660 function survey_question_rowclass($qnum) {
 661
 662     if ($qnum) {
 663         return $qnum % 2 ? 'r0' : 'r1';
 664     } else {
 665         return 'r0';
 666     }
 667 }
 668
 669 /**
 670  * @global object
 671  * @global int
 672  * @global int
 673  * @param string $url
 674  */
 675 function survey_print_graph($url) {
 676     global $CFG, $SURVEY_GHEIGHT, $SURVEY_GWIDTH;
 677
 678     echo "<img class='resultgraph' height=\"$SURVEY_GHEIGHT\" width=\"$SURVEY_GWIDTH\"".
 679          " src=\"$CFG->wwwroot/mod/survey/graph.php?$url\" alt=\"".get_string("surveygraph", "survey")."\" />";
 680 }
 681
 682 /**
 683  * @return array
 684  */
 685 function survey_get_view_actions() {
 686     return array('download','view all','view form','view graph','view report');
 687 }
 688
 689 /**
 690  * @return array
 691  */
 692 function survey_get_post_actions() {
 693     return array('submit');
 694 }
 695
 696
 697 /**
 698  * Implementation of the function for printing the form elements that control
 699  * whether the course reset functionality affects the survey.
 700  *
 701  * @param object $mform form passed by reference
 702  */
 703 function survey_reset_course_form_definition(&$mform) {
 704     $mform->addElement('header', 'surveyheader', get_string('modulenameplural', 'survey'));
 705     $mform->addElement('checkbox', 'reset_survey_answers', get_string('deleteallanswers','survey'));
 706     $mform->addElement('checkbox', 'reset_survey_analysis', get_string('deleteanalysis','survey'));
 707     $mform->disabledIf('reset_survey_analysis', 'reset_survey_answers', 'checked');
 708 }
 709
 710 /**
 711  * Course reset form defaults.
 712  * @return array
 713  */
 714 function survey_reset_course_form_defaults($course) {
 715     return array('reset_survey_answers'=>1, 'reset_survey_analysis'=>1);
 716 }
 717
 718 /**
 719  * Actual implementation of the reset course functionality, delete all the
 720  * survey responses for course $data->courseid.
 721  *
 722  * @global object
 723  * @param $data the data submitted from the reset course.
 724  * @return array status array
 725  */
 726 function survey_reset_userdata($data) {
 727     global $DB;
 728
 729     $componentstr = get_string('modulenameplural', 'survey');
 730     $status = array();
 731
 732     $surveyssql = "SELECT ch.id
 733                      FROM {survey} ch
 734                     WHERE ch.course=?";
 735     $params = array($data->courseid);
 736
 737     if (!empty($data->reset_survey_answers)) {
 738         $DB->delete_records_select('survey_answers', "survey IN ($surveyssql)", $params);
 739         $DB->delete_records_select('survey_analysis', "survey IN ($surveyssql)", $params);
 740         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallanswers', 'survey'), 'error'=>false);
 741     }
 742
 743     if (!empty($data->reset_survey_analysis)) {
 744         $DB->delete_records_select('survey_analysis', "survey IN ($surveyssql)", $params);
 745         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallanswers', 'survey'), 'error'=>false);
 746     }
 747
 748     // no date shifting
 749     return $status;
 750 }
 751
 752 /**
 753  * Returns all other caps used in module
 754  *
 755  * @return array
 756  */
 757 function survey_get_extra_capabilities() {
 758     return array('moodle/site:accessallgroups');
 759 }
 760
 761 /**
 762  * @uses FEATURE_GROUPS
 763  * @uses FEATURE_GROUPINGS
 764  * @uses FEATURE_GROUPMEMBERSONLY
 765  * @uses FEATURE_MOD_INTRO
 766  * @uses FEATURE_COMPLETION_TRACKS_VIEWS
 767  * @uses FEATURE_GRADE_HAS_GRADE
 768  * @uses FEATURE_GRADE_OUTCOMES
 769  * @param string $feature FEATURE_xx constant for requested feature
 770  * @return mixed True if module supports feature, false if not, null if doesn't know
 771  */
 772 function survey_supports($feature) {
 773     switch($feature) {
 774         case FEATURE_GROUPS:                  return true;
 775         case FEATURE_GROUPINGS:               return true;
 776         case FEATURE_GROUPMEMBERSONLY:        return true;
 777         case FEATURE_MOD_INTRO:               return true;
 778         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
 779         case FEATURE_GRADE_HAS_GRADE:         return false;
 780         case FEATURE_GRADE_OUTCOMES:          return false;
 781         case FEATURE_BACKUP_MOODLE2:          return true;
 782         case FEATURE_SHOW_DESCRIPTION:        return true;
 783
 784         default: return null;
 785     }
 786 }
 787
 788 /**
 789  * This function extends the settings navigation block for the site.
 790  *
 791  * It is safe to rely on PAGE here as we will only ever be within the module
 792  * context when this is called
 793  *
 794  * @param navigation_node $settings
 795  * @param navigation_node $surveynode
 796  */
 797 function survey_extend_settings_navigation($settings, $surveynode) {
 798     global $PAGE;
 799
 800     if (has_capability('mod/survey:readresponses', $PAGE->cm->context)) {
 801         $responsesnode = $surveynode->add(get_string("responsereports", "survey"));
 802
 803         $url = new moodle_url('/mod/survey/report.php', array('id' => $PAGE->cm->id, 'action'=>'summary'));
 804         $responsesnode->add(get_string("summary", "survey"), $url);
 805
 806         $url = new moodle_url('/mod/survey/report.php', array('id' => $PAGE->cm->id, 'action'=>'scales'));
 807         $responsesnode->add(get_string("scales", "survey"), $url);
 808
 809         $url = new moodle_url('/mod/survey/report.php', array('id' => $PAGE->cm->id, 'action'=>'questions'));
 810         $responsesnode->add(get_string("question", "survey"), $url);
 811
 812         $url = new moodle_url('/mod/survey/report.php', array('id' => $PAGE->cm->id, 'action'=>'students'));
 813         $responsesnode->add(get_string('participants'), $url);
 814
 815         if (has_capability('mod/survey:download', $PAGE->cm->context)) {
 816             $url = new moodle_url('/mod/survey/report.php', array('id' => $PAGE->cm->id, 'action'=>'download'));
 817             $surveynode->add(get_string('downloadresults', 'survey'), $url);
 818         }
 819     }
 820 }
 821
 822 /**
 823  * Return a list of page types
 824  * @param string $pagetype current page type
 825  * @param stdClass $parentcontext Block's parent context
 826  * @param stdClass $currentcontext Current context of block
 827  */
 828 function survey_page_type_list($pagetype, $parentcontext, $currentcontext) {
 829     $module_pagetype = array('mod-survey-*'=>get_string('page-mod-survey-x', 'survey'));
 830     return $module_pagetype;
 831 }