blocks/quiz_results/block_quiz_results.php

   1 <?php //$Id$
   2
   3 define('B_QUIZRESULTS_NAME_FORMAT_FULL', 1);
   4 define('B_QUIZRESULTS_NAME_FORMAT_ID',   2);
   5 define('B_QUIZRESULTS_NAME_FORMAT_ANON', 3);
   6 define('B_QUIZRESULTS_GRADE_FORMAT_PCT', 1);
   7 define('B_QUIZRESULTS_GRADE_FORMAT_FRA', 2);
   8 define('B_QUIZRESULTS_GRADE_FORMAT_ABS', 3);
   9
  10 class block_quiz_results extends block_base {
  11     function init() {
  12         $this->title = get_string('formaltitle', 'block_quiz_results');
  13         $this->version = 2007101509;
  14     }
  15
  16     function applicable_formats() {
  17         return array('course' => true, 'mod-quiz' => true);
  18     }
  19
  20     function get_content() {
  21         global $USER, $CFG;
  22
  23         if ($this->content !== NULL) {
  24             return $this->content;
  25         }
  26
  27         $this->content = new stdClass;
  28         $this->content->text = '';
  29         $this->content->footer = '';
  30
  31         if (empty($this->instance)) {
  32             return $this->content;
  33         }
  34
  35         if($this->instance->pagetype == 'course-view') {
  36             // We need to see if we are monitoring a quiz
  37             $quizid   = empty($this->config->quizid) ? 0 : $this->config->quizid;
  38             $courseid = $this->instance->pageid;
  39         }
  40         else {
  41             // Assuming we are displayed in the quiz view page
  42             $quizid    = $this->instance->pageid;
  43
  44             // A trick to take advantage of instance config and save queries
  45             if(empty($this->config->courseid)) {
  46                 $modrecord = get_record('modules', 'name', 'quiz');
  47                 $cmrecord  = get_record('course_modules', 'module', $modrecord->id, 'instance', $quizid);
  48                 $this->config->courseid = intval($cmrecord->course);
  49                 $this->instance_config_commit();
  50             }
  51             $courseid = $this->config->courseid;
  52         }
  53
  54         $context = get_context_instance(CONTEXT_COURSE, $courseid);
  55
  56
  57         if(empty($quizid)) {
  58             $this->content->text = get_string('error_emptyquizid', 'block_quiz_results');
  59             return $this->content;
  60         }
  61
  62         // Get the quiz record
  63         $quiz = get_record('quiz', 'id', $quizid);
  64         if(empty($quiz)) {
  65             $this->content->text = get_string('error_emptyquizrecord', 'block_quiz_results');
  66             return $this->content;
  67         }
  68
  69         // Get the grades for this quiz
  70         $grades = get_records('quiz_grades', 'quiz', $quizid, 'grade, timemodified DESC');
  71
  72         if(empty($grades)) {
  73             // No grades, sorry
  74             // The block will hide itself in this case
  75             return $this->content;
  76         }
  77
  78         if(empty($this->config->showbest) && empty($this->config->showworst)) {
  79             $this->content->text = get_string('configuredtoshownothing', 'block_quiz_results');
  80             return $this->content;
  81         }
  82
  83         $groupmode = NOGROUPS;
  84         $best      = array();
  85         $worst     = array();
  86
  87         $nameformat = intval(empty($this->config->nameformat)  ? B_QUIZRESULTS_NAME_FORMAT_FULL : $this->config->nameformat);
  88
  89         // If the block is configured to operate in group mode, or if the name display format
  90         // is other than "fullname", then we need to retrieve the full course record
  91         if(!empty($this->config->usegroups) || $nameformat != B_QUIZRESULTS_NAME_FORMAT_FULL) {
  92             $course = get_record_select('course', 'id = '.$courseid, 'groupmode, groupmodeforce, student');
  93         }
  94
  95         if(!empty($this->config->usegroups)) {
  96             // The block was configured to operate in group mode
  97             if($course->groupmodeforce) {
  98                 $groupmode = $course->groupmode;
  99             }
 100             else {
 101                 $module = get_record_sql('SELECT cm.groupmode FROM '.$CFG->prefix.'modules m LEFT JOIN '.$CFG->prefix.'course_modules cm ON m.id = cm.module WHERE m.name = \'quiz\' AND cm.instance = '.$quizid);
 102                 $groupmode = $module->groupmode;
 103             }
 104             // The actual groupmode for the quiz is now known to be $groupmode
 105         }
 106
 107         if(has_capability('moodle/site:accessallgroups', $context) && $groupmode == SEPARATEGROUPS) {
 108             // We 'll make an exception in this case
 109             $groupmode = VISIBLEGROUPS;
 110         }
 111
 112         switch($groupmode) {
 113             case VISIBLEGROUPS:
 114             // Display group-mode results
 115             $groups = groups_get_all_groups($courseid);
 116
 117             if(empty($groups)) {
 118                 // No groups exist, sorry
 119                 $this->content->text = get_string('error_nogroupsexist', 'block_quiz_results');
 120                 return $this->content;
 121             }
 122
 123             // Find out all the userids which have a submitted grade
 124             $userids = array();
 125             foreach($grades as $grade) {
 126                 $userids[] = $grade->userid;
 127             }
 128
 129             // Now find which groups these users belong in
 130             $groupofuser = get_records_sql(
 131             'SELECT m.userid, m.groupid, g.name FROM '.$CFG->prefix.'groups g LEFT JOIN '.$CFG->prefix.'groups_members m ON g.id = m.groupid '.
 132             'WHERE g.courseid = '.$courseid.' AND m.userid IN ('.implode(',', $userids).')'
 133             );
 134
 135             $groupgrades = array();
 136
 137             // OK... now, iterate the grades again and sum them up for each group
 138             foreach($grades as $grade) {
 139                 if(isset($groupofuser[$grade->userid])) {
 140                     // Count this result only if the user is in a group
 141                     $groupid = $groupofuser[$grade->userid]->groupid;
 142                     if(!isset($groupgrades[$groupid])) {
 143                         $groupgrades[$groupid] = array('sum' => (float)$grade->grade, 'number' => 1, 'group' => $groupofuser[$grade->userid]->name);
 144                     }
 145                     else {
 146                         $groupgrades[$groupid]['sum'] += $grade->grade;
 147                         ++$groupgrades[$groupid]['number'];
 148                     }
 149                 }
 150             }
 151
 152             foreach($groupgrades as $groupid => $groupgrade) {
 153                 $groupgrades[$groupid]['average'] = $groupgrades[$groupid]['sum'] / $groupgrades[$groupid]['number'];
 154             }
 155
 156             // Sort groupgrades according to average grade, ascending
 157             uasort($groupgrades, create_function('$a, $b', 'if($a["average"] == $b["average"]) return 0; return ($a["average"] > $b["average"] ? 1 : -1);'));
 158
 159             // How many groups do we have with graded member submissions to show?
 160             $numbest  = empty($this->config->showbest) ? 0 : min($this->config->showbest, count($groupgrades));
 161             $numworst = empty($this->config->showworst) ? 0 : min($this->config->showworst, count($groupgrades) - $numbest);
 162
 163             // Collect all the group results we are going to use in $best and $worst
 164             $remaining = $numbest;
 165             $groupgrade = end($groupgrades);
 166             while($remaining--) {
 167                 $best[key($groupgrades)] = $groupgrade['average'];
 168                 $groupgrade = prev($groupgrades);
 169             }
 170
 171             $remaining = $numworst;
 172             $groupgrade = reset($groupgrades);
 173             while($remaining--) {
 174                 $worst[key($groupgrades)] = $groupgrade['average'];
 175                 $groupgrade = next($groupgrades);
 176             }
 177
 178             // Ready for output!
 179             $gradeformat = intval(empty($this->config->gradeformat) ? B_QUIZRESULTS_GRADE_FORMAT_PCT : $this->config->gradeformat);
 180
 181             if($this->instance->pagetype != 'mod-quiz-view') {
 182                 // Don't show header and link to the quiz if we ARE at the quiz...
 183                 $this->content->text .= '<h1><a href="'.$CFG->wwwroot.'/mod/quiz/view.php?q='.$quizid.'">'.$quiz->name.'</a></h1>';
 184             }
 185
 186             if ($nameformat = B_QUIZRESULTS_NAME_FORMAT_FULL) {
 187                 if (has_capability('moodle/course:managegroups', $context)) {
 188                     $grouplink = $CFG->wwwroot.'/group/overview.php?courseid='.$courseid.'&amp;id=';
 189                 } else if (has_capability('moodle/course:viewparticipants', $context)) {
 190                     $grouplink = $CFG->wwwroot.'/user/index.php?id='.$courseid.'&amp;group=';
 191                 } else {
 192                     $grouplink = '';
 193                 }
 194             }
 195
 196             $rank = 0;
 197             if(!empty($best)) {
 198                 $this->content->text .= '<table class="grades"><caption>';
 199                 $this->content->text .= ($numbest == 1?get_string('bestgroupgrade', 'block_quiz_results'):get_string('bestgroupgrades', 'block_quiz_results', $numbest));
 200                 $this->content->text .= '</caption><colgroup class="number" /><colgroup class="name" /><colgroup class="grade" /><tbody>';
 201                 foreach($best as $groupid => $averagegrade) {
 202                     switch($nameformat) {
 203                         case B_QUIZRESULTS_NAME_FORMAT_ANON:
 204                         case B_QUIZRESULTS_NAME_FORMAT_ID:
 205                             $thisname = get_string('group');
 206                         break;
 207                         default:
 208                         case B_QUIZRESULTS_NAME_FORMAT_FULL:
 209                             if ($grouplink) {
 210                                 $thisname = '<a href="'.$grouplink.$groupid.'">'.$groupgrades[$groupid]['group'].'</a>';
 211                             } else {
 212                                 $thisname = $groupgrades[$groupid]['group'];
 213                             }
 214                         break;
 215                     }
 216                     $this->content->text .= '<tr><td>'.(++$rank).'.</td><td>'.$thisname.'</td><td>';
 217                     switch($gradeformat) {
 218                         case B_QUIZRESULTS_GRADE_FORMAT_FRA:
 219                             $this->content->text .= (format_float($averagegrade,$quiz->decimalpoints).'/'.$quiz->grade);
 220                         break;
 221                         case B_QUIZRESULTS_GRADE_FORMAT_ABS:
 222                             $this->content->text .= format_float($averagegrade,$quiz->decimalpoints);
 223                         break;
 224                         default:
 225                         case B_QUIZRESULTS_GRADE_FORMAT_PCT:
 226                             $this->content->text .= round((float)$averagegrade / (float)$quiz->grade * 100).'%';
 227                         break;
 228                     }
 229                     $this->content->text .= '</td></tr>';
 230                 }
 231                 $this->content->text .= '</tbody></table>';
 232             }
 233
 234             $rank = 0;
 235             if(!empty($worst)) {
 236                 $worst = array_reverse($worst, true);
 237                 $this->content->text .= '<table class="grades"><caption>';
 238                 $this->content->text .= ($numworst == 1?get_string('worstgroupgrade', 'block_quiz_results'):get_string('worstgroupgrades', 'block_quiz_results', $numworst));
 239                 $this->content->text .= '</caption><colgroup class="number" /><colgroup class="name" /><colgroup class="grade" /><tbody>';
 240                 foreach($worst as $groupid => $averagegrade) {
 241                     switch($nameformat) {
 242                         case B_QUIZRESULTS_NAME_FORMAT_ANON:
 243                         case B_QUIZRESULTS_NAME_FORMAT_ID:
 244                             $thisname = get_string('group');
 245                         break;
 246                         default:
 247                         case B_QUIZRESULTS_NAME_FORMAT_FULL:
 248                             $thisname = '<a href="'.$CFG->wwwroot.'/course/group.php?group='.$groupid.'&amp;id='.$courseid.'">'.$groupgrades[$groupid]['group'].'</a>';
 249                         break;
 250                     }
 251                     $this->content->text .= '<tr><td>'.(++$rank).'.</td><td>'.$thisname.'</td><td>';
 252                     switch($gradeformat) {
 253                         case B_QUIZRESULTS_GRADE_FORMAT_FRA:
 254                             $this->content->text .= (format_float($averagegrade,$quiz->decimalpoints).'/'.$quiz->grade);
 255                         break;
 256                         case B_QUIZRESULTS_GRADE_FORMAT_ABS:
 257                             $this->content->text .= format_float($averagegrade,$quiz->decimalpoints);
 258                         break;
 259                         default:
 260                         case B_QUIZRESULTS_GRADE_FORMAT_PCT:
 261                             $this->content->text .= round((float)$averagegrade / (float)$quiz->grade * 100).'%';
 262                         break;
 263                     }
 264                     $this->content->text .= '</td></tr>';
 265                 }
 266                 $this->content->text .= '</tbody></table>';
 267             }
 268             break;
 269
 270
 271             case SEPARATEGROUPS:
 272             // This is going to be just like no-groups mode, only we 'll filter
 273             // out the grades from people not in our group.
 274             if(empty($USER) || empty($USER->id)) {
 275                 // Not logged in, so show nothing
 276                 return $this->content;
 277             }
 278
 279             $mygroups = groups_get_all_groups($courseid, $USER->id);
 280             if(empty($mygroups)) {
 281                 // Not member of a group, show nothing
 282                 return $this->content;
 283             }
 284
 285             $mygroupsusers = get_records_list('groups_members', 'groupid', implode(',', array_keys($mygroups)), '', 'userid, id');
 286             // There should be at least one user there, ourselves. So no more tests.
 287
 288             // Just filter out the grades belonging to other users, and proceed as if there were no groups
 289             $strallowedusers = implode(',', array_keys($mygroupsusers));
 290             $grades = array_filter($grades, create_function('$el', '$allowed = explode(",", "'.$strallowedusers.'"); return in_array($el->userid, $allowed);'));
 291
 292             // NO break; HERE, JUST GO AHEAD
 293             default:
 294             case NOGROUPS:
 295             // Single user mode
 296             $numbest  = empty($this->config->showbest) ? 0 : min($this->config->showbest, count($grades));
 297             $numworst = empty($this->config->showworst) ? 0 : min($this->config->showworst, count($grades) - $numbest);
 298
 299             // Collect all the usernames we are going to need
 300             $remaining = $numbest;
 301             $grade = end($grades);
 302             while($remaining--) {
 303                 $best[$grade->userid] = $grade->id;
 304                 $grade = prev($grades);
 305             }
 306
 307             $remaining = $numworst;
 308             $grade = reset($grades);
 309             while($remaining--) {
 310                 $worst[$grade->userid] = $grade->id;
 311                 $grade = next($grades);
 312             }
 313
 314             if(empty($best) && empty($worst)) {
 315                 // Nothing to show, for some reason...
 316                 return $this->content;
 317             }
 318
 319             // Now grab all the users from the database
 320             $userids = array_merge(array_keys($best), array_keys($worst));
 321             $users = get_records_list('user', 'id', implode(',',$userids), '', 'id, firstname, lastname, idnumber');
 322
 323             // Ready for output!
 324
 325             $gradeformat = intval(empty($this->config->gradeformat) ? B_QUIZRESULTS_GRADE_FORMAT_PCT : $this->config->gradeformat);
 326
 327             if($this->instance->pagetype != 'mod-quiz-view') {
 328                 // Don't show header and link to the quiz if we ARE at the quiz...
 329                 $this->content->text .= '<h1><a href="'.$CFG->wwwroot.'/mod/quiz/view.php?q='.$quizid.'">'.$quiz->name.'</a></h1>';
 330             }
 331
 332             $rank = 0;
 333             if(!empty($best)) {
 334                 $this->content->text .= '<table class="grades"><caption>';
 335                 $this->content->text .= ($numbest == 1?get_string('bestgrade', 'block_quiz_results'):get_string('bestgrades', 'block_quiz_results', $numbest));
 336                 $this->content->text .= '</caption><colgroup class="number" /><colgroup class="name" /><colgroup class="grade" /><tbody>';
 337                 foreach($best as $userid => $gradeid) {
 338                     switch($nameformat) {
 339                         case B_QUIZRESULTS_NAME_FORMAT_ID:
 340                             $thisname = $course->student.' '.intval($users[$userid]->idnumber);
 341                         break;
 342                         case B_QUIZRESULTS_NAME_FORMAT_ANON:
 343                             $thisname = $course->student;
 344                         break;
 345                         default:
 346                         case B_QUIZRESULTS_NAME_FORMAT_FULL:
 347                             $thisname = '<a href="'.$CFG->wwwroot.'/user/view.php?id='.$userid.'&amp;course='.$courseid.'">'.fullname($users[$userid]).'</a>';
 348                         break;
 349                     }
 350                     $this->content->text .= '<tr><td>'.(++$rank).'.</td><td>'.$thisname.'</td><td>';
 351                     switch($gradeformat) {
 352                         case B_QUIZRESULTS_GRADE_FORMAT_FRA:
 353                             $this->content->text .= (format_float($grades[$gradeid]->grade,$quiz->decimalpoints).'/'.$quiz->grade);
 354                         break;
 355                         case B_QUIZRESULTS_GRADE_FORMAT_ABS:
 356                             $this->content->text .= format_float($grades[$gradeid]->grade,$quiz->decimalpoints);
 357                         break;
 358                         default:
 359                         case B_QUIZRESULTS_GRADE_FORMAT_PCT:
 360                             if ($quiz->grade) {
 361                                 $this->content->text .= round((float)$grades[$gradeid]->grade / (float)$quiz->grade * 100).'%';
 362                             } else {
 363                                 $this->content->text .= '--%';
 364                             }
 365                         break;
 366                     }
 367                     $this->content->text .= '</td></tr>';
 368                 }
 369                 $this->content->text .= '</tbody></table>';
 370             }
 371
 372             $rank = 0;
 373             if(!empty($worst)) {
 374                 $worst = array_reverse($worst, true);
 375                 $this->content->text .= '<table class="grades"><caption>';
 376                 $this->content->text .= ($numworst == 1?get_string('worstgrade', 'block_quiz_results'):get_string('worstgrades', 'block_quiz_results', $numworst));
 377                 $this->content->text .= '</caption><colgroup class="number" /><colgroup class="name" /><colgroup class="grade" /><tbody>';
 378                 foreach($worst as $userid => $gradeid) {
 379                     switch($nameformat) {
 380                         case B_QUIZRESULTS_NAME_FORMAT_ID:
 381                             $thisname = $course->student.' '.intval($users[$userid]->idnumber);
 382                         break;
 383                         case B_QUIZRESULTS_NAME_FORMAT_ANON:
 384                             $thisname = $course->student;
 385                         break;
 386                         default:
 387                         case B_QUIZRESULTS_NAME_FORMAT_FULL:
 388                             $thisname = '<a href="'.$CFG->wwwroot.'/user/view.php?id='.$userid.'&amp;course='.$courseid.'">'.fullname($users[$userid]).'</a>';
 389                         break;
 390                     }
 391                     $this->content->text .= '<tr><td>'.(++$rank).'.</td><td>'.$thisname.'</td><td>';
 392                     switch($gradeformat) {
 393                         case B_QUIZRESULTS_GRADE_FORMAT_FRA:
 394                             $this->content->text .= (format_float($grades[$gradeid]->grade,$quiz->decimalpoints).'/'.$quiz->grade);
 395                         break;
 396                         case B_QUIZRESULTS_GRADE_FORMAT_ABS:
 397                             $this->content->text .= format_float($grades[$gradeid]->grade,$quiz->decimalpoints);
 398                         break;
 399                         default:
 400                         case B_QUIZRESULTS_GRADE_FORMAT_PCT:
 401                             $this->content->text .= round((float)$grades[$gradeid]->grade / (float)$quiz->grade * 100).'%';
 402                         break;
 403                     }
 404                     $this->content->text .= '</td></tr>';
 405                 }
 406                 $this->content->text .= '</tbody></table>';
 407             }
 408             break;
 409         }
 410
 411         return $this->content;
 412     }
 413
 414     function instance_allow_multiple() {
 415         return true;
 416     }
 417 }
 418
 419 ?>