mod/survey/lib.php

   1 <?php // $Id$
   2
   3 // Graph size
   4 $SURVEY_GHEIGHT = 500;
   5 $SURVEY_GWIDTH  = 900;
   6
   7 $SURVEY_QTYPE = array (
   8         "-3" => "Virtual Actual and Preferred",
   9         "-2" => "Virtual Preferred",
  10         "-1" => "Virtual Actual",
  11          "0" => "Text",
  12          "1" => "Actual",
  13          "2" => "Preferred",
  14          "3" => "Actual and Preferred",
  15         );
  16
  17
  18 define("SURVEY_COLLES_ACTUAL",           "1");
  19 define("SURVEY_COLLES_PREFERRED",        "2");
  20 define("SURVEY_COLLES_PREFERRED_ACTUAL", "3");
  21 define("SURVEY_ATTLS",                   "4");
  22 define("SURVEY_CIQ",                     "5");
  23
  24
  25 // STANDARD FUNCTIONS ////////////////////////////////////////////////////////
  26
  27 function survey_add_instance($survey) {
  28 // Given an object containing all the necessary data,
  29 // (defined by the form in mod.html) this function
  30 // will create a new instance and return the id number
  31 // of the new instance.
  32
  33     if (!$template = get_record("survey", "id", $survey->template)) {
  34         return 0;
  35     }
  36
  37     $survey->questions    = $template->questions;
  38     $survey->timecreated  = time();
  39     $survey->timemodified = $survey->timecreated;
  40
  41     return insert_record("survey", $survey);
  42
  43 }
  44
  45
  46 function survey_update_instance($survey) {
  47 // Given an object containing all the necessary data,
  48 // (defined by the form in mod.html) this function
  49 // will update an existing instance with new data.
  50
  51     if (!$template = get_record("survey", "id", $survey->template)) {
  52         return 0;
  53     }
  54
  55     $survey->id           = $survey->instance;
  56     $survey->questions    = $template->questions;
  57     $survey->timemodified = time();
  58
  59     return update_record("survey", $survey);
  60 }
  61
  62 function survey_delete_instance($id) {
  63 // Given an ID of an instance of this module,
  64 // this function will permanently delete the instance
  65 // and any data that depends on it.
  66
  67     if (! $survey = get_record("survey", "id", "$id")) {
  68         return false;
  69     }
  70
  71     $result = true;
  72
  73     if (! delete_records("survey_analysis", "survey", "$survey->id")) {
  74         $result = false;
  75     }
  76
  77     if (! delete_records("survey_answers", "survey", "$survey->id")) {
  78         $result = false;
  79     }
  80
  81     if (! delete_records("survey", "id", "$survey->id")) {
  82         $result = false;
  83     }
  84
  85     return $result;
  86 }
  87
  88 function survey_user_outline($course, $user, $mod, $survey) {
  89     if ($answers = get_records_select("survey_answers", "survey='$survey->id' AND userid='$user->id'")) {
  90
  91         $lastanswer = array_pop($answers);
  92
  93         $result->info = get_string("done", "survey");
  94         $result->time = $lastanswer->time;
  95         return $result;
  96     }
  97     return NULL;
  98 }
  99
 100
 101 function survey_user_complete($course, $user, $mod, $survey) {
 102     global $CFG;
 103
 104     if (survey_already_done($survey->id, $user->id)) {
 105         if ($survey->template == SURVEY_CIQ) { // print out answers for critical incidents
 106             $table = NULL;
 107             $table->align = array("left", "left");
 108
 109             $questions = get_records_list("survey_questions", "id", $survey->questions);
 110             $questionorder = explode(",", $survey->questions);
 111
 112             foreach ($questionorder as $key=>$val) {
 113                 $question = $questions[$val];
 114                 $questiontext = get_string($question->shorttext, "survey");
 115
 116                 if ($answer = survey_get_user_answer($survey->id, $question->id, $user->id)) {
 117                     $answertext = "$answer->answer1";
 118                 } else {
 119                     $answertext = "No answer";
 120                 }
 121                 $table->data[] = array("<b>$questiontext</b>", $answertext);
 122             }
 123             print_table($table);
 124
 125         } else {
 126
 127             survey_print_graph("id=$mod->id&amp;sid=$user->id&amp;type=student.png");
 128         }
 129
 130     } else {
 131         print_string("notdone", "survey");
 132     }
 133 }
 134
 135 function survey_print_recent_activity($course, $isteacher, $timestart) {
 136     global $CFG;
 137
 138     $content = false;
 139     $surveys = NULL;
 140
 141     if (!$logs = get_records_select('log', 'time > \''.$timestart.'\' AND '.
 142                                            'course = \''.$course->id.'\' AND '.
 143                                            'module = \'survey\' AND '.
 144                                            'action = \'submit\' ', 'time ASC')) {
 145         return false;
 146     }
 147
 148     foreach ($logs as $log) {
 149         //Create a temp valid module structure (course,id)
 150         $tempmod->course = $log->course;
 151         $tempmod->id = $log->info;
 152         //Obtain the visible property from the instance
 153         $modvisible = instance_is_visible($log->module,$tempmod);
 154
 155         //Only if the mod is visible
 156         if ($modvisible) {
 157             $surveys[$log->id] = survey_log_info($log);
 158             $surveys[$log->id]->time = $log->time;
 159             $surveys[$log->id]->url = str_replace('&', '&amp;', $log->url);
 160         }
 161     }
 162
 163     if ($surveys) {
 164         $content = true;
 165         print_headline(get_string('newsurveyresponses', 'survey').':');
 166         foreach ($surveys as $survey) {
 167             print_recent_activity_note($survey->time, $survey, $survey->name,
 168                                        $CFG->wwwroot.'/mod/survey/'.$survey->url);
 169         }
 170     }
 171
 172     return $content;
 173 }
 174
 175 function survey_get_participants($surveyid) {
 176 //Returns the users with data in one survey
 177 //(users with records in survey_analysis and survey_answers, students)
 178
 179     global $CFG;
 180
 181     //Get students from survey_analysis
 182     $st_analysis = get_records_sql("SELECT DISTINCT u.id, u.id
 183                                     FROM {$CFG->prefix}user u,
 184                                          {$CFG->prefix}survey_analysis a
 185                                     WHERE a.survey = '$surveyid' and
 186                                           u.id = a.userid");
 187     //Get students from survey_answers
 188     $st_answers = get_records_sql("SELECT DISTINCT u.id, u.id
 189                                    FROM {$CFG->prefix}user u,
 190                                         {$CFG->prefix}survey_answers a
 191                                    WHERE a.survey = '$surveyid' and
 192                                          u.id = a.userid");
 193
 194     //Add st_answers to st_analysis
 195     if ($st_answers) {
 196         foreach ($st_answers as $st_answer) {
 197             $st_analysis[$st_answer->id] = $st_answer;
 198         }
 199     }
 200     //Return st_analysis array (it contains an array of unique users)
 201     return ($st_analysis);
 202 }
 203
 204 // SQL FUNCTIONS ////////////////////////////////////////////////////////
 205
 206
 207 function survey_log_info($log) {
 208     global $CFG;
 209     return get_record_sql("SELECT s.name, u.firstname, u.lastname, u.picture
 210                              FROM {$CFG->prefix}survey s,
 211                                   {$CFG->prefix}user u
 212                             WHERE s.id = '$log->info'
 213                               AND u.id = '$log->userid'");
 214 }
 215
 216 function survey_get_responses($surveyid, $groupid, $groupingid) {
 217     global $CFG;
 218
 219     if ($groupid) {
 220         $groupsjoin = "INNER JOIN {$CFG->prefix}groups_members gm ON u.id = gm.userid AND gm.groupid = '$groupid' ";
 221
 222     } else if ($groupingid) {
 223         $groupsjoin = "INNER JOIN {$CFG->prefix}groups_members gm ON u.id = gm.userid
 224                        INNER JOIN {$CFG->prefix}groupings_groups gg ON gm.groupid = gg.groupid AND gg.groupingid = $groupingid ";
 225     } else {
 226         $groupsjoin = "";
 227     }
 228
 229     return get_records_sql("SELECT u.id, u.firstname, u.lastname, u.picture, MAX(a.time) as time
 230                             FROM {$CFG->prefix}survey_answers a
 231                                 INNER JOIN {$CFG->prefix}user u ON a.userid = u.id
 232                                 $groupsjoin
 233                             WHERE a.survey = $surveyid
 234                             GROUP BY u.id, u.firstname, u.lastname, u.picture
 235                             ORDER BY time ASC");
 236 }
 237
 238 function survey_get_analysis($survey, $user) {
 239     global $CFG;
 240
 241     return get_record_sql("SELECT notes
 242                              FROM {$CFG->prefix}survey_analysis
 243                             WHERE survey='$survey'
 244                               AND userid='$user'");
 245 }
 246
 247 function survey_update_analysis($survey, $user, $notes) {
 248     global $CFG;
 249
 250     return execute_sql("UPDATE {$CFG->prefix}survey_analysis
 251                             SET notes='$notes'
 252                           WHERE survey='$survey'
 253                             AND userid='$user'");
 254 }
 255
 256
 257 function survey_get_user_answers($surveyid, $questionid, $groupid, $sort="sa.answer1,sa.answer2 ASC") {
 258     global $CFG;
 259
 260     if ($groupid) {
 261         $groupsql = "AND gm.groupid = $groupid AND u.id = gm.userid";
 262     } else {
 263         $groupsql = "";
 264     }
 265
 266     return get_records_sql("SELECT sa.*,u.firstname,u.lastname,u.picture
 267                               FROM {$CFG->prefix}survey_answers sa,
 268                                    {$CFG->prefix}user u,
 269                                    {$CFG->prefix}groups_members gm
 270                              WHERE sa.survey = '$surveyid'
 271                                AND sa.question = $questionid
 272                                AND u.id = sa.userid $groupsql
 273                           ORDER BY $sort");
 274 }
 275
 276 function survey_get_user_answer($surveyid, $questionid, $userid) {
 277     global $CFG;
 278
 279     return get_record_sql("SELECT sa.*
 280                               FROM {$CFG->prefix}survey_answers sa
 281                              WHERE sa.survey = '$surveyid'
 282                                AND sa.question = '$questionid'
 283                                AND sa.userid = '$userid'");
 284 }
 285
 286 // MODULE FUNCTIONS ////////////////////////////////////////////////////////
 287
 288 function survey_add_analysis($survey, $user, $notes) {
 289     global $CFG;
 290
 291     $record->survey = $survey;
 292     $record->userid = $user;
 293     $record->notes = $notes;
 294
 295     return insert_record("survey_analysis", $record, false);
 296 }
 297
 298 function survey_already_done($survey, $user) {
 299    return record_exists("survey_answers", "survey", $survey, "userid", $user);
 300 }
 301
 302 function survey_count_responses($surveyid, $groupid, $groupingid) {
 303     if ($responses = survey_get_responses($surveyid, $groupid, $groupingid)) {
 304         return count($responses);
 305     } else {
 306         return 0;
 307     }
 308 }
 309
 310
 311 function survey_print_all_responses($cmid, $results, $courseid) {
 312
 313     $table->head  = array ("", get_string("name"),  get_string("time"));
 314     $table->align = array ("", "left", "left");
 315     $table->size = array (35, "", "" );
 316
 317     foreach ($results as $a) {
 318         $table->data[] = array(print_user_picture($a->id, $courseid, $a->picture, false, true, false),
 319                "<a href=\"report.php?action=student&amp;student=$a->id&amp;id=$cmid\">".fullname($a)."</a>",
 320                userdate($a->time));
 321     }
 322
 323     print_table($table);
 324 }
 325
 326
 327 function survey_get_template_name($templateid) {
 328     global $db;
 329
 330     if ($templateid) {
 331         if ($ss = get_record("surveys", "id", $templateid)) {
 332             return $ss->name;
 333         }
 334     } else {
 335         return "";
 336     }
 337 }
 338
 339
 340
 341 function survey_shorten_name ($name, $numwords) {
 342     $words = explode(" ", $name);
 343     for ($i=0; $i < $numwords; $i++) {
 344         $output .= $words[$i]." ";
 345     }
 346     return $output;
 347 }
 348
 349
 350
 351 function survey_print_multi($question) {
 352     GLOBAL $USER, $db, $qnum, $checklist;
 353
 354     $stripreferthat = get_string("ipreferthat", "survey");
 355     $strifoundthat = get_string("ifoundthat", "survey");
 356     echo "<br />\n";
 357     echo "<span class='questiontext'><b>$question->text</b></span><br />";
 358     echo "<div style=\"text-align:center\">";
 359     echo "<table width=\"90%\" cellpadding=\"4\" cellspacing=\"1\" border=\"0\">";
 360
 361     $options = explode( ",", $question->options);
 362     $numoptions = count($options);
 363
 364     $oneanswer = ($question->type == 1 || $question->type == 2) ? true : false;
 365     if ($question->type == 2) {
 366         $P = "P";
 367     } else {
 368         $P = "";
 369     }
 370
 371     if ($oneanswer) {
 372         echo "<tr><td colspan=\"2\">$question->intro</td>";
 373     } else {
 374         echo "<tr><td colspan=\"3\">$question->intro</td>";
 375     }
 376
 377     while (list ($key, $val) = each ($options)) {
 378         echo "<td class=\"smalltextcell\"><span class='smalltext'>$val</span></td>\n";
 379     }
 380     echo "<td align=\"center\">&nbsp;</td></tr>\n";
 381
 382     $subquestions = get_records_list("survey_questions", "id", $question->multi);
 383
 384     foreach ($subquestions as $q) {
 385         $qnum++;
 386         $rowclass = survey_question_rowclass($qnum);
 387         if ($q->text) {
 388             $q->text = get_string($q->text, "survey");
 389         }
 390
 391         echo "<tr class=\"$rowclass\">";
 392         if ($oneanswer) {
 393
 394             echo "<td class=\"qnumtopcell\"><b>$qnum</b></td>";
 395             echo "<td valign=\"top\">$q->text</td>";
 396             for ($i=1;$i<=$numoptions;$i++) {
 397                 $screenreader = !empty($USER->screenreader)?"<label for=\"q$P" . $q->id . "_$i\">".$options[$i-1]."</label><br/>":'';
 398                 echo "<td class=\"screenreadertext\">".$screenreader."<input type=\"radio\" name=\"q$P$q->id\" id=\"q$P" . $q->id . "_$i\" value=\"$i\" alt=\"$i\" /></td>";
 399             }
 400             echo "<td class=\"whitecell\"><input type=\"radio\" name=\"q$P$q->id\" value=\"0\" checked=\"checked\" alt=\"0\" /></td>";
 401             $checklist["q$P$q->id"] = $numoptions;
 402
 403         } else {
 404             // yu : fix for MDL-7501, possibly need to use user flag as this is quite ugly.
 405             echo "<td class=\"qnummiddlecell\"><b>$qnum</b></td>";
 406             $qnum++;
 407             echo "<td class=\"preferthat\"><span class='smalltext'>$stripreferthat&nbsp;</span></td>";
 408             echo "<td class=\"optioncell\">$q->text</td>";
 409             for ($i=1;$i<=$numoptions;$i++) {
 410                 $screenreader = !empty($USER->screenreader)?"<label for=\"qP" . $q->id . "_$i\">".$options[$i-1]."</label><br/>":'';
 411                 echo "<td class=\"screenreadertext\">".$screenreader."<input type=\"radio\" name=\"qP$q->id\" id=\"qP" . $q->id . "_$i\" value=\"$i\" alt=\"$i\"/></td>";
 412             }
 413             echo "<td><input type=\"radio\" name=\"qP$q->id\" value=\"0\" checked=\"checked\" alt=\"0\" /></td>";
 414             echo "</tr>";
 415
 416             echo "<tr class=\"$rowclass\">";
 417             echo "<td class=\"qnumtopcell\"><b>$qnum</b></td>";
 418             echo "<td class=\"foundthat\"><span class='smalltext'>$strifoundthat&nbsp;</span></td>";
 419             echo "<td class=\"optioncell\">$q->text</td>";
 420             for ($i=1;$i<=$numoptions;$i++) {
 421                 $screenreader = !empty($USER->screenreader)?"<label for=\"q" . $q->id . "_$i\">".$options[$i-1]."</label><br/>":'';
 422                 echo "<td class=\"screenreadertext\">".$screenreader."<input type=\"radio\" name=\"q$q->id\" id=\"q" . $q->id . "_$i\" value=\"$i\" alt=\"$i\" /></td>";
 423             }
 424             echo "<td class=\"buttoncell\"><input type=\"radio\" name=\"q$q->id\" value=\"0\" checked=\"checked\" alt=\"0\" /></td>";
 425             $checklist["qP$q->id"] = $numoptions;
 426             $checklist["q$q->id"] = $numoptions;
 427         }
 428         echo "</tr>\n";
 429
 430     }
 431     echo "</table>";
 432     echo "</div>";
 433 }
 434
 435
 436
 437 function survey_print_single($question) {
 438     GLOBAL $db, $qnum;
 439
 440     $rowclass = survey_question_rowclass(0);
 441
 442     $qnum++;
 443
 444     echo "<br />\n";
 445     echo "<table width=\"90%\" cellpadding=\"4\" cellspacing=\"0\">\n";
 446     echo "<tr class=\"$rowclass\">";
 447     echo "<td valign=\"top\"><b>$qnum</b></td>";
 448     echo "<td class=\"questioncell\">$question->text</td>\n";
 449     echo "<td class=\"questioncell\"><span class='smalltext'>\n";
 450
 451
 452     if ($question->type == 0) {           // Plain text field
 453         echo "<textarea rows=\"3\" cols=\"30\" name=\"q$question->id\">$question->options</textarea>";
 454
 455     } else if ($question->type > 0) {     // Choose one of a number
 456         $strchoose = get_string("choose");
 457         echo "<select name=\"q$question->id\">";
 458         echo "<option value=\"0\" selected=\"selected\">$strchoose...</option>";
 459         $options = explode( ",", $question->options);
 460         foreach ($options as $key => $val) {
 461             $key++;
 462             echo "<option value=\"$key\">$val</option>";
 463         }
 464         echo "</select>";
 465
 466     } else if ($question->type < 0) {     // Choose several of a number
 467         $options = explode( ",", $question->options);
 468         notify("This question type not supported yet");
 469     }
 470
 471     echo "</span></td></tr></table>";
 472
 473 }
 474
 475 function survey_question_rowclass($qnum) {
 476
 477     if ($qnum) {
 478         return $qnum % 2 ? 'r0' : 'r1';
 479     } else {
 480         return 'r0';
 481     }
 482 }
 483
 484 function survey_print_graph($url) {
 485     global $CFG, $SURVEY_GHEIGHT, $SURVEY_GWIDTH;
 486
 487     if (empty($CFG->gdversion)) {
 488         echo "(".get_string("gdneed").")";
 489
 490     } else {
 491         echo "<img class='resultgraph' height=\"$SURVEY_GHEIGHT\" width=\"$SURVEY_GWIDTH\"".
 492              " src=\"$CFG->wwwroot/mod/survey/graph.php?$url\" alt=\"".get_string("surveygraph", "survey")."\" />";
 493     }
 494 }
 495
 496 function survey_get_view_actions() {
 497     return array('download','view all','view form','view graph','view report');
 498 }
 499
 500 function survey_get_post_actions() {
 501     return array('submit');
 502 }
 503
 504 ?>