| [ Index ] |
PHP Cross Reference of moodle-2.8 |
[Summary view] [Print] [Text view]
1 <?php 2 // This file is part of Moodle - http://moodle.org/ 3 // 4 // Moodle is free software: you can redistribute it and/or modify 5 // it under the terms of the GNU General Public License as published by 6 // the Free Software Foundation, either version 3 of the License, or 7 // (at your option) any later version. 8 // 9 // Moodle is distributed in the hope that it will be useful, 10 // but WITHOUT ANY WARRANTY; without even the implied warranty of 11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 // GNU General Public License for more details. 13 // 14 // You should have received a copy of the GNU General Public License 15 // along with Moodle. If not, see <http://www.gnu.org/licenses/>. 16 17 /** 18 * Definition of the grader report class 19 * 20 * @package gradereport_grader 21 * @copyright 2007 Nicolas Connault 22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 23 */ 24 25 require_once($CFG->dirroot . '/grade/report/lib.php'); 26 require_once($CFG->libdir.'/tablelib.php'); 27 28 /** 29 * Class providing an API for the grader report building and displaying. 30 * @uses grade_report 31 * @copyright 2007 Nicolas Connault 32 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 33 */ 34 class grade_report_grader extends grade_report { 35 /** 36 * The final grades. 37 * @var array $grades 38 */ 39 public $grades; 40 41 /** 42 * Array of errors for bulk grades updating. 43 * @var array $gradeserror 44 */ 45 public $gradeserror = array(); 46 47 // SQL-RELATED 48 49 /** 50 * The id of the grade_item by which this report will be sorted. 51 * @var int $sortitemid 52 */ 53 public $sortitemid; 54 55 /** 56 * Sortorder used in the SQL selections. 57 * @var int $sortorder 58 */ 59 public $sortorder; 60 61 /** 62 * An SQL fragment affecting the search for users. 63 * @var string $userselect 64 */ 65 public $userselect; 66 67 /** 68 * The bound params for $userselect 69 * @var array $userselectparams 70 */ 71 public $userselectparams = array(); 72 73 /** 74 * List of collapsed categories from user preference 75 * @var array $collapsed 76 */ 77 public $collapsed; 78 79 /** 80 * A count of the rows, used for css classes. 81 * @var int $rowcount 82 */ 83 public $rowcount = 0; 84 85 /** 86 * Capability check caching 87 * @var boolean $canviewhidden 88 */ 89 public $canviewhidden; 90 91 /** 92 * Length at which feedback will be truncated (to the nearest word) and an ellipsis be added. 93 * TODO replace this by a report preference 94 * @var int $feedback_trunc_length 95 */ 96 protected $feedback_trunc_length = 50; 97 98 /** 99 * Allow category grade overriding 100 * @var bool $overridecat 101 */ 102 protected $overridecat; 103 104 /** 105 * Constructor. Sets local copies of user preferences and initialises grade_tree. 106 * @param int $courseid 107 * @param object $gpr grade plugin return tracking object 108 * @param string $context 109 * @param int $page The current page being viewed (when report is paged) 110 * @param int $sortitemid The id of the grade_item by which to sort the table 111 */ 112 public function __construct($courseid, $gpr, $context, $page=null, $sortitemid=null) { 113 global $CFG; 114 parent::__construct($courseid, $gpr, $context, $page); 115 116 $this->canviewhidden = has_capability('moodle/grade:viewhidden', context_course::instance($this->course->id)); 117 118 // load collapsed settings for this report 119 $this->collapsed = static::get_collapsed_preferences($this->course->id); 120 121 if (empty($CFG->enableoutcomes)) { 122 $nooutcomes = false; 123 } else { 124 $nooutcomes = get_user_preferences('grade_report_shownooutcomes'); 125 } 126 127 // if user report preference set or site report setting set use it, otherwise use course or site setting 128 $switch = $this->get_pref('aggregationposition'); 129 if ($switch == '') { 130 $switch = grade_get_setting($this->courseid, 'aggregationposition', $CFG->grade_aggregationposition); 131 } 132 133 // Grab the grade_tree for this course 134 $this->gtree = new grade_tree($this->courseid, true, $switch, $this->collapsed, $nooutcomes); 135 136 $this->sortitemid = $sortitemid; 137 138 // base url for sorting by first/last name 139 140 $this->baseurl = new moodle_url('index.php', array('id' => $this->courseid)); 141 142 $studentsperpage = $this->get_students_per_page(); 143 if (!empty($this->page) && !empty($studentsperpage)) { 144 $this->baseurl->params(array('perpage' => $studentsperpage, 'page' => $this->page)); 145 } 146 147 $this->pbarurl = new moodle_url('/grade/report/grader/index.php', array('id' => $this->courseid)); 148 149 $this->setup_groups(); 150 $this->setup_users(); 151 $this->setup_sortitemid(); 152 153 $this->overridecat = (bool)get_config('moodle', 'grade_overridecat'); 154 } 155 156 /** 157 * Processes the data sent by the form (grades and feedbacks). 158 * Caller is responsible for all access control checks 159 * @param array $data form submission (with magic quotes) 160 * @return array empty array if success, array of warnings if something fails. 161 */ 162 public function process_data($data) { 163 global $DB; 164 $warnings = array(); 165 166 $separategroups = false; 167 $mygroups = array(); 168 if ($this->groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $this->context)) { 169 $separategroups = true; 170 $mygroups = groups_get_user_groups($this->course->id); 171 $mygroups = $mygroups[0]; // ignore groupings 172 // reorder the groups fro better perf below 173 $current = array_search($this->currentgroup, $mygroups); 174 if ($current !== false) { 175 unset($mygroups[$current]); 176 array_unshift($mygroups, $this->currentgroup); 177 } 178 } 179 180 // always initialize all arrays 181 $queue = array(); 182 183 $this->load_users(); 184 $this->load_final_grades(); 185 186 // Were any changes made? 187 $changedgrades = false; 188 $timepageload = clean_param($data->timepageload, PARAM_INT); 189 190 foreach ($data as $varname => $students) { 191 192 $needsupdate = false; 193 194 // skip, not a grade nor feedback 195 if (strpos($varname, 'grade') === 0) { 196 $datatype = 'grade'; 197 } else if (strpos($varname, 'feedback') === 0) { 198 $datatype = 'feedback'; 199 } else { 200 continue; 201 } 202 203 foreach ($students as $userid => $items) { 204 $userid = clean_param($userid, PARAM_INT); 205 foreach ($items as $itemid => $postedvalue) { 206 $itemid = clean_param($itemid, PARAM_INT); 207 208 // Was change requested? 209 $oldvalue = $this->grades[$userid][$itemid]; 210 if ($datatype === 'grade') { 211 // If there was no grade and there still isn't 212 if (is_null($oldvalue->finalgrade) && $postedvalue == -1) { 213 // -1 means no grade 214 continue; 215 } 216 217 // If the grade item uses a custom scale 218 if (!empty($oldvalue->grade_item->scaleid)) { 219 220 if ((int)$oldvalue->finalgrade === (int)$postedvalue) { 221 continue; 222 } 223 } else { 224 // The grade item uses a numeric scale 225 226 // Format the finalgrade from the DB so that it matches the grade from the client 227 if ($postedvalue === format_float($oldvalue->finalgrade, $oldvalue->grade_item->get_decimals())) { 228 continue; 229 } 230 } 231 232 $changedgrades = true; 233 234 } else if ($datatype === 'feedback') { 235 // If quick grading is on, feedback needs to be compared without line breaks. 236 if ($this->get_pref('quickgrading')) { 237 $oldvalue->feedback = preg_replace("/\r\n|\r|\n/", "", $oldvalue->feedback); 238 } 239 if (($oldvalue->feedback === $postedvalue) or ($oldvalue->feedback === null and empty($postedvalue))) { 240 continue; 241 } 242 } 243 244 if (!$gradeitem = grade_item::fetch(array('id'=>$itemid, 'courseid'=>$this->courseid))) { 245 print_error('invalidgradeitemid'); 246 } 247 248 // Pre-process grade 249 if ($datatype == 'grade') { 250 $feedback = false; 251 $feedbackformat = false; 252 if ($gradeitem->gradetype == GRADE_TYPE_SCALE) { 253 if ($postedvalue == -1) { // -1 means no grade 254 $finalgrade = null; 255 } else { 256 $finalgrade = $postedvalue; 257 } 258 } else { 259 $finalgrade = unformat_float($postedvalue); 260 } 261 262 $errorstr = ''; 263 $skip = false; 264 265 $dategraded = $oldvalue->get_dategraded(); 266 if (!empty($dategraded) && $timepageload < $dategraded) { 267 // Warn if the grade was updated while we were editing this form. 268 $errorstr = 'gradewasmodifiedduringediting'; 269 $skip = true; 270 } else if (!is_null($finalgrade)) { 271 // Warn if the grade is out of bounds. 272 $bounded = $gradeitem->bounded_grade($finalgrade); 273 if ($bounded > $finalgrade) { 274 $errorstr = 'lessthanmin'; 275 } else if ($bounded < $finalgrade) { 276 $errorstr = 'morethanmax'; 277 } 278 } 279 280 if ($errorstr) { 281 $userfields = 'id, ' . get_all_user_name_fields(true); 282 $user = $DB->get_record('user', array('id' => $userid), $userfields); 283 $gradestr = new stdClass(); 284 $gradestr->username = fullname($user); 285 $gradestr->itemname = $gradeitem->get_name(); 286 $warnings[] = get_string($errorstr, 'grades', $gradestr); 287 if ($skip) { 288 // Skipping the update of this grade it failed the tests above. 289 continue; 290 } 291 } 292 293 } else if ($datatype == 'feedback') { 294 $finalgrade = false; 295 $trimmed = trim($postedvalue); 296 if (empty($trimmed)) { 297 $feedback = null; 298 } else { 299 $feedback = $postedvalue; 300 } 301 } 302 303 // group access control 304 if ($separategroups) { 305 // note: we can not use $this->currentgroup because it would fail badly 306 // when having two browser windows each with different group 307 $sharinggroup = false; 308 foreach ($mygroups as $groupid) { 309 if (groups_is_member($groupid, $userid)) { 310 $sharinggroup = true; 311 break; 312 } 313 } 314 if (!$sharinggroup) { 315 // either group membership changed or somebody is hacking grades of other group 316 $warnings[] = get_string('errorsavegrade', 'grades'); 317 continue; 318 } 319 } 320 321 $gradeitem->update_final_grade($userid, $finalgrade, 'gradebook', $feedback, FORMAT_MOODLE); 322 323 // We can update feedback without reloading the grade item as it doesn't affect grade calculations 324 if ($datatype === 'feedback') { 325 $this->grades[$userid][$itemid]->feedback = $feedback; 326 } 327 } 328 } 329 } 330 331 if ($changedgrades) { 332 // If a final grade was overriden reload grades so dependent grades like course total will be correct 333 $this->grades = null; 334 } 335 336 return $warnings; 337 } 338 339 340 /** 341 * Setting the sort order, this depends on last state 342 * all this should be in the new table class that we might need to use 343 * for displaying grades. 344 */ 345 private function setup_sortitemid() { 346 347 global $SESSION; 348 349 if (!isset($SESSION->gradeuserreport)) { 350 $SESSION->gradeuserreport = new stdClass(); 351 } 352 353 if ($this->sortitemid) { 354 if (!isset($SESSION->gradeuserreport->sort)) { 355 if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') { 356 $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC'; 357 } else { 358 $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC'; 359 } 360 } else { 361 // this is the first sort, i.e. by last name 362 if (!isset($SESSION->gradeuserreport->sortitemid)) { 363 if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') { 364 $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC'; 365 } else { 366 $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC'; 367 } 368 } else if ($SESSION->gradeuserreport->sortitemid == $this->sortitemid) { 369 // same as last sort 370 if ($SESSION->gradeuserreport->sort == 'ASC') { 371 $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC'; 372 } else { 373 $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC'; 374 } 375 } else { 376 if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') { 377 $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC'; 378 } else { 379 $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC'; 380 } 381 } 382 } 383 $SESSION->gradeuserreport->sortitemid = $this->sortitemid; 384 } else { 385 // not requesting sort, use last setting (for paging) 386 387 if (isset($SESSION->gradeuserreport->sortitemid)) { 388 $this->sortitemid = $SESSION->gradeuserreport->sortitemid; 389 } else { 390 $this->sortitemid = 'lastname'; 391 } 392 393 if (isset($SESSION->gradeuserreport->sort)) { 394 $this->sortorder = $SESSION->gradeuserreport->sort; 395 } else { 396 $this->sortorder = 'ASC'; 397 } 398 } 399 } 400 401 /** 402 * pulls out the userids of the users to be display, and sorts them 403 */ 404 public function load_users() { 405 global $CFG, $DB; 406 407 if (!empty($this->users)) { 408 return; 409 } 410 $this->setup_users(); 411 412 // Limit to users with a gradeable role. 413 list($gradebookrolessql, $gradebookrolesparams) = $DB->get_in_or_equal(explode(',', $this->gradebookroles), SQL_PARAMS_NAMED, 'grbr0'); 414 415 // Limit to users with an active enrollment. 416 list($enrolledsql, $enrolledparams) = get_enrolled_sql($this->context); 417 418 // Fields we need from the user table. 419 $userfields = user_picture::fields('u', get_extra_user_fields($this->context)); 420 421 // We want to query both the current context and parent contexts. 422 list($relatedctxsql, $relatedctxparams) = $DB->get_in_or_equal($this->context->get_parent_context_ids(true), SQL_PARAMS_NAMED, 'relatedctx'); 423 424 // If the user has clicked one of the sort asc/desc arrows. 425 if (is_numeric($this->sortitemid)) { 426 $params = array_merge(array('gitemid' => $this->sortitemid), $gradebookrolesparams, $this->userwheresql_params, 427 $this->groupwheresql_params, $enrolledparams, $relatedctxparams); 428 429 $sortjoin = "LEFT JOIN {grade_grades} g ON g.userid = u.id AND g.itemid = $this->sortitemid"; 430 $sort = "g.finalgrade $this->sortorder"; 431 } else { 432 $sortjoin = ''; 433 switch($this->sortitemid) { 434 case 'lastname': 435 $sort = "u.lastname $this->sortorder, u.firstname $this->sortorder"; 436 break; 437 case 'firstname': 438 $sort = "u.firstname $this->sortorder, u.lastname $this->sortorder"; 439 break; 440 case 'email': 441 $sort = "u.email $this->sortorder"; 442 break; 443 case 'idnumber': 444 default: 445 $sort = "u.idnumber $this->sortorder"; 446 break; 447 } 448 449 $params = array_merge($gradebookrolesparams, $this->userwheresql_params, $this->groupwheresql_params, $enrolledparams, $relatedctxparams); 450 } 451 452 $sql = "SELECT $userfields 453 FROM {user} u 454 JOIN ($enrolledsql) je ON je.id = u.id 455 $this->groupsql 456 $sortjoin 457 JOIN ( 458 SELECT DISTINCT ra.userid 459 FROM {role_assignments} ra 460 WHERE ra.roleid IN ($this->gradebookroles) 461 AND ra.contextid $relatedctxsql 462 ) rainner ON rainner.userid = u.id 463 AND u.deleted = 0 464 $this->userwheresql 465 $this->groupwheresql 466 ORDER BY $sort"; 467 $studentsperpage = $this->get_students_per_page(); 468 $this->users = $DB->get_records_sql($sql, $params, $studentsperpage * $this->page, $studentsperpage); 469 470 if (empty($this->users)) { 471 $this->userselect = ''; 472 $this->users = array(); 473 $this->userselect_params = array(); 474 } else { 475 list($usql, $uparams) = $DB->get_in_or_equal(array_keys($this->users), SQL_PARAMS_NAMED, 'usid0'); 476 $this->userselect = "AND g.userid $usql"; 477 $this->userselect_params = $uparams; 478 479 // Add a flag to each user indicating whether their enrolment is active. 480 $sql = "SELECT ue.userid 481 FROM {user_enrolments} ue 482 JOIN {enrol} e ON e.id = ue.enrolid 483 WHERE ue.userid $usql 484 AND ue.status = :uestatus 485 AND e.status = :estatus 486 AND e.courseid = :courseid 487 AND ue.timestart < :now1 AND (ue.timeend = 0 OR ue.timeend > :now2) 488 GROUP BY ue.userid"; 489 $coursecontext = $this->context->get_course_context(true); 490 $time = time(); 491 $params = array_merge($uparams, array('estatus' => ENROL_INSTANCE_ENABLED, 'uestatus' => ENROL_USER_ACTIVE, 492 'courseid' => $coursecontext->instanceid, 'now1' => $time, 'now2' => $time)); 493 $useractiveenrolments = $DB->get_records_sql($sql, $params); 494 495 $defaultgradeshowactiveenrol = !empty($CFG->grade_report_showonlyactiveenrol); 496 $showonlyactiveenrol = get_user_preferences('grade_report_showonlyactiveenrol', $defaultgradeshowactiveenrol); 497 $showonlyactiveenrol = $showonlyactiveenrol || !has_capability('moodle/course:viewsuspendedusers', $coursecontext); 498 foreach ($this->users as $user) { 499 // If we are showing only active enrolments, then remove suspended users from list. 500 if ($showonlyactiveenrol && !array_key_exists($user->id, $useractiveenrolments)) { 501 unset($this->users[$user->id]); 502 } else { 503 $this->users[$user->id]->suspendedenrolment = !array_key_exists($user->id, $useractiveenrolments); 504 } 505 } 506 } 507 return $this->users; 508 } 509 510 /** 511 * we supply the userids in this query, and get all the grades 512 * pulls out all the grades, this does not need to worry about paging 513 */ 514 public function load_final_grades() { 515 global $CFG, $DB; 516 517 if (!empty($this->grades)) { 518 return; 519 } 520 521 if (empty($this->users)) { 522 return; 523 } 524 525 // please note that we must fetch all grade_grades fields if we want to construct grade_grade object from it! 526 $params = array_merge(array('courseid'=>$this->courseid), $this->userselect_params); 527 $sql = "SELECT g.* 528 FROM {grade_items} gi, 529 {grade_grades} g 530 WHERE g.itemid = gi.id AND gi.courseid = :courseid {$this->userselect}"; 531 532 $userids = array_keys($this->users); 533 534 if ($grades = $DB->get_records_sql($sql, $params)) { 535 foreach ($grades as $graderec) { 536 if (in_array($graderec->userid, $userids) and array_key_exists($graderec->itemid, $this->gtree->get_items())) { // some items may not be present!! 537 $this->grades[$graderec->userid][$graderec->itemid] = new grade_grade($graderec, false); 538 $this->grades[$graderec->userid][$graderec->itemid]->grade_item = $this->gtree->get_item($graderec->itemid); // db caching 539 } 540 } 541 } 542 543 // prefil grades that do not exist yet 544 foreach ($userids as $userid) { 545 foreach ($this->gtree->get_items() as $itemid => $unused) { 546 if (!isset($this->grades[$userid][$itemid])) { 547 $this->grades[$userid][$itemid] = new grade_grade(); 548 $this->grades[$userid][$itemid]->itemid = $itemid; 549 $this->grades[$userid][$itemid]->userid = $userid; 550 $this->grades[$userid][$itemid]->grade_item = $this->gtree->get_item($itemid); // db caching 551 } 552 } 553 } 554 } 555 556 /** 557 * Gets html toggle 558 * @deprecated since Moodle 2.4 as it appears not to be used any more. 559 */ 560 public function get_toggles_html() { 561 throw new coding_exception('get_toggles_html() can not be used any more'); 562 } 563 564 /** 565 * Prints html toggle 566 * @deprecated since 2.4 as it appears not to be used any more. 567 * @param unknown $type 568 */ 569 public function print_toggle($type) { 570 throw new coding_exception('print_toggle() can not be used any more'); 571 } 572 573 /** 574 * Builds and returns the rows that will make up the left part of the grader report 575 * This consists of student names and icons, links to user reports and id numbers, as well 576 * as header cells for these columns. It also includes the fillers required for the 577 * categories displayed on the right side of the report. 578 * @param boolean $displayaverages whether to display average rows in the table 579 * @return array Array of html_table_row objects 580 */ 581 public function get_left_rows($displayaverages) { 582 global $CFG, $USER, $OUTPUT; 583 584 $rows = array(); 585 586 $showuserimage = $this->get_pref('showuserimage'); 587 588 $strfeedback = $this->get_lang_string("feedback"); 589 $strgrade = $this->get_lang_string('grade'); 590 591 $extrafields = get_extra_user_fields($this->context); 592 593 $arrows = $this->get_sort_arrows($extrafields); 594 595 $colspan = 1; 596 if (has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context)) { 597 $colspan++; 598 } 599 $colspan += count($extrafields); 600 601 $levels = count($this->gtree->levels) - 1; 602 603 for ($i = 0; $i < $levels; $i++) { 604 $fillercell = new html_table_cell(); 605 $fillercell->attributes['class'] = 'fixedcolumn cell topleft'; 606 $fillercell->text = ' '; 607 $fillercell->colspan = $colspan; 608 $row = new html_table_row(array($fillercell)); 609 $rows[] = $row; 610 } 611 612 $headerrow = new html_table_row(); 613 $headerrow->attributes['class'] = 'heading'; 614 615 $studentheader = new html_table_cell(); 616 $studentheader->attributes['class'] = 'header'; 617 $studentheader->scope = 'col'; 618 $studentheader->header = true; 619 $studentheader->id = 'studentheader'; 620 if (has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context)) { 621 $studentheader->colspan = 2; 622 } 623 $studentheader->text = $arrows['studentname']; 624 625 $headerrow->cells[] = $studentheader; 626 627 foreach ($extrafields as $field) { 628 $fieldheader = new html_table_cell(); 629 $fieldheader->attributes['class'] = 'header userfield user' . $field; 630 $fieldheader->scope = 'col'; 631 $fieldheader->header = true; 632 $fieldheader->text = $arrows[$field]; 633 634 $headerrow->cells[] = $fieldheader; 635 } 636 637 $rows[] = $headerrow; 638 639 $rows = $this->get_left_icons_row($rows, $colspan); 640 641 $suspendedstring = null; 642 foreach ($this->users as $userid => $user) { 643 $userrow = new html_table_row(); 644 $userrow->id = 'fixed_user_'.$userid; 645 646 $usercell = new html_table_cell(); 647 $usercell->attributes['class'] = 'user'; 648 649 $usercell->header = true; 650 $usercell->scope = 'row'; 651 652 if ($showuserimage) { 653 $usercell->text = $OUTPUT->user_picture($user); 654 } 655 656 $fullname = fullname($user); 657 $usercell->text .= html_writer::link(new moodle_url('/user/view.php', array('id' => $user->id, 'course' => $this->course->id)), $fullname, array( 658 'class' => 'username', 659 )); 660 661 if (!empty($user->suspendedenrolment)) { 662 $usercell->attributes['class'] .= ' usersuspended'; 663 664 //may be lots of suspended users so only get the string once 665 if (empty($suspendedstring)) { 666 $suspendedstring = get_string('userenrolmentsuspended', 'grades'); 667 } 668 $usercell->text .= html_writer::empty_tag('img', array('src'=>$OUTPUT->pix_url('i/enrolmentsuspended'), 'title'=>$suspendedstring, 669 'alt'=>$suspendedstring, 'class'=>'usersuspendedicon')); 670 } 671 672 $userrow->cells[] = $usercell; 673 674 $userreportcell = new html_table_cell(); 675 $userreportcell->attributes['class'] = 'userreport'; 676 $userreportcell->header = true; 677 if (has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context)) { 678 $a = new stdClass(); 679 $a->user = $fullname; 680 $strgradesforuser = get_string('gradesforuser', 'grades', $a); 681 $url = new moodle_url('/grade/report/'.$CFG->grade_profilereport.'/index.php', array('userid' => $user->id, 'id' => $this->course->id)); 682 $userreportcell->text .= $OUTPUT->action_icon($url, new pix_icon('t/grades', $strgradesforuser)); 683 } 684 685 if (has_capability('gradereport/singleview:view', $this->context)) { 686 $url = new moodle_url('/grade/report/singleview/index.php', array('id' => $this->course->id, 'itemid' => $user->id, 'item' => 'user')); 687 $singleview = $OUTPUT->action_icon($url, new pix_icon('t/editstring', get_string('singleview', 'grades', $fullname))); 688 $userreportcell->text .= $singleview; 689 } 690 691 if ($userreportcell->text) { 692 $userrow->cells[] = $userreportcell; 693 } 694 695 foreach ($extrafields as $field) { 696 $fieldcell = new html_table_cell(); 697 $fieldcell->attributes['class'] = 'header userfield user' . $field; 698 $fieldcell->header = true; 699 $fieldcell->scope = 'row'; 700 $fieldcell->text = $user->{$field}; 701 $userrow->cells[] = $fieldcell; 702 } 703 704 $userrow->attributes['data-uid'] = $userid; 705 $rows[] = $userrow; 706 } 707 708 $rows = $this->get_left_range_row($rows, $colspan); 709 if ($displayaverages) { 710 $rows = $this->get_left_avg_row($rows, $colspan, true); 711 $rows = $this->get_left_avg_row($rows, $colspan); 712 } 713 714 return $rows; 715 } 716 717 /** 718 * Builds and returns the rows that will make up the right part of the grader report 719 * @param boolean $displayaverages whether to display average rows in the table 720 * @return array Array of html_table_row objects 721 */ 722 public function get_right_rows($displayaverages) { 723 global $CFG, $USER, $OUTPUT, $DB, $PAGE; 724 725 $rows = array(); 726 $this->rowcount = 0; 727 $numrows = count($this->gtree->get_levels()); 728 $numusers = count($this->users); 729 $gradetabindex = 1; 730 $columnstounset = array(); 731 $strgrade = $this->get_lang_string('grade'); 732 $strfeedback = $this->get_lang_string("feedback"); 733 $arrows = $this->get_sort_arrows(); 734 735 $jsarguments = array( 736 'cfg' => array('ajaxenabled'=>false), 737 'items' => array(), 738 'users' => array(), 739 'feedback' => array() 740 ); 741 $jsscales = array(); 742 743 // Get preferences once. 744 $showactivityicons = $this->get_pref('showactivityicons'); 745 $quickgrading = $this->get_pref('quickgrading'); 746 $showquickfeedback = $this->get_pref('showquickfeedback'); 747 $enableajax = $this->get_pref('enableajax'); 748 $showanalysisicon = $this->get_pref('showanalysisicon'); 749 750 // Get strings which are re-used inside the loop. 751 $strftimedatetimeshort = get_string('strftimedatetimeshort'); 752 $strexcludedgrades = get_string('excluded', 'grades'); 753 $strerror = get_string('error'); 754 755 foreach ($this->gtree->get_levels() as $key => $row) { 756 $headingrow = new html_table_row(); 757 $headingrow->attributes['class'] = 'heading_name_row'; 758 759 foreach ($row as $columnkey => $element) { 760 $sortlink = clone($this->baseurl); 761 if (isset($element['object']->id)) { 762 $sortlink->param('sortitemid', $element['object']->id); 763 } 764 765 $eid = $element['eid']; 766 $object = $element['object']; 767 $type = $element['type']; 768 $categorystate = @$element['categorystate']; 769 770 if (!empty($element['colspan'])) { 771 $colspan = $element['colspan']; 772 } else { 773 $colspan = 1; 774 } 775 776 if (!empty($element['depth'])) { 777 $catlevel = 'catlevel'.$element['depth']; 778 } else { 779 $catlevel = ''; 780 } 781 782 // Element is a filler 783 if ($type == 'filler' or $type == 'fillerfirst' or $type == 'fillerlast') { 784 $fillercell = new html_table_cell(); 785 $fillercell->attributes['class'] = $type . ' ' . $catlevel; 786 $fillercell->colspan = $colspan; 787 $fillercell->text = ' '; 788 $fillercell->header = true; 789 $fillercell->scope = 'col'; 790 $headingrow->cells[] = $fillercell; 791 } else if ($type == 'category') { 792 // Element is a category 793 $categorycell = new html_table_cell(); 794 $categorycell->attributes['class'] = 'category ' . $catlevel; 795 $categorycell->colspan = $colspan; 796 $categorycell->text = shorten_text($element['object']->get_name()); 797 $categorycell->text .= $this->get_collapsing_icon($element); 798 $categorycell->header = true; 799 $categorycell->scope = 'col'; 800 801 // Print icons 802 if ($USER->gradeediting[$this->courseid]) { 803 $categorycell->text .= $this->get_icons($element); 804 } 805 806 $headingrow->cells[] = $categorycell; 807 } else { 808 // Element is a grade_item 809 if ($element['object']->id == $this->sortitemid) { 810 if ($this->sortorder == 'ASC') { 811 $arrow = $this->get_sort_arrow('up', $sortlink); 812 } else { 813 $arrow = $this->get_sort_arrow('down', $sortlink); 814 } 815 } else { 816 $arrow = $this->get_sort_arrow('move', $sortlink); 817 } 818 819 $headerlink = $this->gtree->get_element_header($element, true, $showactivityicons, false, false, true); 820 821 $itemcell = new html_table_cell(); 822 $itemcell->attributes['class'] = $type . ' ' . $catlevel . ' highlightable'. ' i'. $element['object']->id; 823 $itemcell->attributes['data-itemid'] = $element['object']->id; 824 825 if ($element['object']->is_hidden()) { 826 $itemcell->attributes['class'] .= ' dimmed_text'; 827 } 828 829 $singleview = ''; 830 if (has_capability('gradereport/singleview:view', $this->context)) { 831 $url = new moodle_url('/grade/report/singleview/index.php', array( 832 'id' => $this->course->id, 833 'item' => 'grade', 834 'itemid' => $element['object']->id)); 835 $singleview = $OUTPUT->action_icon($url, new pix_icon('t/editstring', get_string('singleview', 'grades', 836 $element['object']->get_name()))); 837 } 838 839 $itemcell->colspan = $colspan; 840 $itemcell->text = shorten_text($headerlink) . $arrow . $singleview; 841 $itemcell->header = true; 842 $itemcell->scope = 'col'; 843 844 $headingrow->cells[] = $itemcell; 845 } 846 } 847 $rows[] = $headingrow; 848 } 849 850 $rows = $this->get_right_icons_row($rows); 851 852 // Preload scale objects for items with a scaleid and initialize tab indices 853 $scaleslist = array(); 854 $tabindices = array(); 855 856 foreach ($this->gtree->get_items() as $itemid => $item) { 857 $scale = null; 858 if (!empty($item->scaleid)) { 859 $scaleslist[] = $item->scaleid; 860 $jsarguments['items'][$itemid] = array('id'=>$itemid, 'name'=>$item->get_name(true), 'type'=>'scale', 'scale'=>$item->scaleid, 'decimals'=>$item->get_decimals()); 861 } else { 862 $jsarguments['items'][$itemid] = array('id'=>$itemid, 'name'=>$item->get_name(true), 'type'=>'value', 'scale'=>false, 'decimals'=>$item->get_decimals()); 863 } 864 $tabindices[$item->id]['grade'] = $gradetabindex; 865 $tabindices[$item->id]['feedback'] = $gradetabindex + $numusers; 866 $gradetabindex += $numusers * 2; 867 } 868 $scalesarray = array(); 869 870 if (!empty($scaleslist)) { 871 $scalesarray = $DB->get_records_list('scale', 'id', $scaleslist); 872 } 873 $jsscales = $scalesarray; 874 875 foreach ($this->users as $userid => $user) { 876 877 if ($this->canviewhidden) { 878 $altered = array(); 879 $unknown = array(); 880 } else { 881 $hidingaffected = grade_grade::get_hiding_affected($this->grades[$userid], $this->gtree->get_items()); 882 $altered = $hidingaffected['altered']; 883 $unknown = $hidingaffected['unknown']; 884 unset($hidingaffected); 885 } 886 887 $itemrow = new html_table_row(); 888 $itemrow->id = 'user_'.$userid; 889 890 $fullname = fullname($user); 891 $jsarguments['users'][$userid] = $fullname; 892 893 foreach ($this->gtree->items as $itemid => $unused) { 894 $item =& $this->gtree->items[$itemid]; 895 $grade = $this->grades[$userid][$item->id]; 896 897 $itemcell = new html_table_cell(); 898 899 $itemcell->id = 'u'.$userid.'i'.$itemid; 900 $itemcell->attributes['data-itemid'] = $itemid; 901 902 // Get the decimal points preference for this item 903 $decimalpoints = $item->get_decimals(); 904 905 if (in_array($itemid, $unknown)) { 906 $gradeval = null; 907 } else if (array_key_exists($itemid, $altered)) { 908 $gradeval = $altered[$itemid]; 909 } else { 910 $gradeval = $grade->finalgrade; 911 } 912 if (!empty($grade->finalgrade)) { 913 $gradevalforjs = null; 914 if ($item->scaleid && !empty($scalesarray[$item->scaleid])) { 915 $gradevalforjs = (int)$gradeval; 916 } else { 917 $gradevalforjs = format_float($gradeval, $decimalpoints); 918 } 919 $jsarguments['grades'][] = array('user'=>$userid, 'item'=>$itemid, 'grade'=>$gradevalforjs); 920 } 921 922 // MDL-11274 923 // Hide grades in the grader report if the current grader doesn't have 'moodle/grade:viewhidden' 924 if (!$this->canviewhidden and $grade->is_hidden()) { 925 if (!empty($CFG->grade_hiddenasdate) and $grade->get_datesubmitted() and !$item->is_category_item() and !$item->is_course_item()) { 926 // the problem here is that we do not have the time when grade value was modified, 'timemodified' is general modification date for grade_grades records 927 $itemcell->text = "<span class='datesubmitted'>" . 928 userdate($grade->get_datesubmitted(), $strftimedatetimeshort) . "</span>"; 929 } else { 930 $itemcell->text = '-'; 931 } 932 $itemrow->cells[] = $itemcell; 933 continue; 934 } 935 936 // emulate grade element 937 $eid = $this->gtree->get_grade_eid($grade); 938 $element = array('eid'=>$eid, 'object'=>$grade, 'type'=>'grade'); 939 940 $itemcell->attributes['class'] .= ' grade i'.$itemid; 941 if ($item->is_category_item()) { 942 $itemcell->attributes['class'] .= ' cat'; 943 } 944 if ($item->is_course_item()) { 945 $itemcell->attributes['class'] .= ' course'; 946 } 947 if ($grade->is_overridden()) { 948 $itemcell->attributes['class'] .= ' overridden'; 949 $itemcell->attributes['aria-label'] = get_string('overriddengrade', 'gradereport_grader'); 950 } 951 952 if (!empty($grade->feedback)) { 953 $feedback = wordwrap(trim(format_string($grade->feedback, $grade->feedbackformat)), 34, '<br>'); 954 $itemcell->attributes['data-feedback'] = $feedback; 955 $jsarguments['feedback'][] = array('user'=>$userid, 'item'=>$itemid, 'content' => $feedback); 956 } 957 958 if ($grade->is_excluded()) { 959 // Adding white spaces before and after to prevent a screenreader from 960 // thinking that the words are attached to the next/previous <span> or text. 961 $itemcell->text .= " <span class='excludedfloater'>" . $strexcludedgrades . "</span> "; 962 } 963 964 // Do not show any icons if no grade (no record in DB to match) 965 if (!$item->needsupdate and $USER->gradeediting[$this->courseid]) { 966 $itemcell->text .= $this->get_icons($element); 967 } 968 969 $hidden = ''; 970 if ($grade->is_hidden()) { 971 $hidden = ' dimmed_text '; 972 } 973 974 $gradepass = ' gradefail '; 975 if ($grade->is_passed($item)) { 976 $gradepass = ' gradepass '; 977 } else if (is_null($grade->is_passed($item))) { 978 $gradepass = ''; 979 } 980 981 // if in editing mode, we need to print either a text box 982 // or a drop down (for scales) 983 // grades in item of type grade category or course are not directly editable 984 if ($item->needsupdate) { 985 $itemcell->text .= "<span class='gradingerror{$hidden}'>" . $strerror . "</span>"; 986 987 } else if ($USER->gradeediting[$this->courseid]) { 988 989 if ($item->scaleid && !empty($scalesarray[$item->scaleid])) { 990 $scale = $scalesarray[$item->scaleid]; 991 $gradeval = (int)$gradeval; // scales use only integers 992 $scales = explode(",", $scale->scale); 993 // reindex because scale is off 1 994 995 // MDL-12104 some previous scales might have taken up part of the array 996 // so this needs to be reset 997 $scaleopt = array(); 998 $i = 0; 999 foreach ($scales as $scaleoption) { 1000 $i++; 1001 $scaleopt[$i] = $scaleoption; 1002 } 1003 1004 if ($quickgrading and $grade->is_editable()) { 1005 $oldval = empty($gradeval) ? -1 : $gradeval; 1006 if (empty($item->outcomeid)) { 1007 $nogradestr = $this->get_lang_string('nograde'); 1008 } else { 1009 $nogradestr = $this->get_lang_string('nooutcome', 'grades'); 1010 } 1011 $attributes = array('tabindex' => $tabindices[$item->id]['grade'], 'id'=>'grade_'.$userid.'_'.$item->id); 1012 $gradelabel = $fullname . ' ' . $item->itemname; 1013 $itemcell->text .= html_writer::label( 1014 get_string('useractivitygrade', 'gradereport_grader', $gradelabel), $attributes['id'], false, 1015 array('class' => 'accesshide')); 1016 $itemcell->text .= html_writer::select($scaleopt, 'grade['.$userid.']['.$item->id.']', $gradeval, array(-1=>$nogradestr), $attributes); 1017 } else if (!empty($scale)) { 1018 $scales = explode(",", $scale->scale); 1019 1020 // invalid grade if gradeval < 1 1021 if ($gradeval < 1) { 1022 $itemcell->text .= "<span class='gradevalue{$hidden}{$gradepass}'>-</span>"; 1023 } else { 1024 $gradeval = $grade->grade_item->bounded_grade($gradeval); //just in case somebody changes scale 1025 $itemcell->text .= "<span class='gradevalue{$hidden}{$gradepass}'>{$scales[$gradeval - 1]}</span>"; 1026 } 1027 } 1028 1029 } else if ($item->gradetype != GRADE_TYPE_TEXT) { // Value type 1030 if ($quickgrading and $grade->is_editable()) { 1031 $value = format_float($gradeval, $decimalpoints); 1032 $gradelabel = $fullname . ' ' . $item->itemname; 1033 $itemcell->text .= '<label class="accesshide" for="grade_'.$userid.'_'.$item->id.'">' 1034 .get_string('useractivitygrade', 'gradereport_grader', $gradelabel).'</label>'; 1035 $itemcell->text .= '<input size="6" tabindex="' . $tabindices[$item->id]['grade'] 1036 . '" type="text" class="text" title="'. $strgrade .'" name="grade[' 1037 .$userid.'][' .$item->id.']" id="grade_'.$userid.'_'.$item->id.'" value="'.$value.'" />'; 1038 } else { 1039 $itemcell->text .= "<span class='gradevalue{$hidden}{$gradepass}'>" . 1040 format_float($gradeval, $decimalpoints) . "</span>"; 1041 } 1042 } 1043 1044 // If quickfeedback is on, print an input element 1045 if ($showquickfeedback and $grade->is_editable()) { 1046 $feedbacklabel = $fullname . ' ' . $item->itemname; 1047 $itemcell->text .= '<label class="accesshide" for="feedback_'.$userid.'_'.$item->id.'">' 1048 .get_string('useractivityfeedback', 'gradereport_grader', $feedbacklabel).'</label>'; 1049 $itemcell->text .= '<input class="quickfeedback" tabindex="' . $tabindices[$item->id]['feedback'].'" id="feedback_'.$userid.'_'.$item->id 1050 . '" size="6" title="' . $strfeedback . '" type="text" name="feedback['.$userid.']['.$item->id.']" value="' . s($grade->feedback) . '" />'; 1051 } 1052 1053 } else { // Not editing 1054 $gradedisplaytype = $item->get_displaytype(); 1055 1056 if ($item->scaleid && !empty($scalesarray[$item->scaleid])) { 1057 $itemcell->attributes['class'] .= ' grade_type_scale'; 1058 } else if ($item->gradetype != GRADE_TYPE_TEXT) { 1059 $itemcell->attributes['class'] .= ' grade_type_text'; 1060 } 1061 1062 if ($enableajax) { 1063 $canoverride = true; 1064 if ($item->is_category_item() || $item->is_course_item()) { 1065 $canoverride = (bool) get_config('moodle', 'grade_overridecat'); 1066 } 1067 if ($canoverride) { 1068 $itemcell->attributes['class'] .= ' clickable'; 1069 } 1070 } 1071 1072 if ($item->needsupdate) { 1073 $itemcell->text .= "<span class='gradingerror{$hidden}{$gradepass}'>" . $error . "</span>"; 1074 } else { 1075 // The max and min for an aggregation may be different to the grade_item. 1076 if (!is_null($gradeval)) { 1077 $item->grademax = $grade->rawgrademax; 1078 $item->grademin = $grade->rawgrademin; 1079 } 1080 1081 $itemcell->text .= "<span class='gradevalue{$hidden}{$gradepass}'>" . 1082 grade_format_gradevalue($gradeval, $item, true, $gradedisplaytype, null) . "</span>"; 1083 if ($showanalysisicon) { 1084 $itemcell->text .= $this->gtree->get_grade_analysis_icon($grade); 1085 } 1086 } 1087 } 1088 1089 if (!empty($this->gradeserror[$item->id][$userid])) { 1090 $itemcell->text .= $this->gradeserror[$item->id][$userid]; 1091 } 1092 1093 $itemrow->cells[] = $itemcell; 1094 } 1095 $rows[] = $itemrow; 1096 } 1097 1098 if ($enableajax) { 1099 $jsarguments['cfg']['ajaxenabled'] = true; 1100 $jsarguments['cfg']['scales'] = array(); 1101 foreach ($jsscales as $scale) { 1102 $jsarguments['cfg']['scales'][$scale->id] = explode(',', $scale->scale); 1103 } 1104 $jsarguments['cfg']['feedbacktrunclength'] = $this->feedback_trunc_length; 1105 1106 // Student grades and feedback are already at $jsarguments['feedback'] and $jsarguments['grades'] 1107 } 1108 $jsarguments['cfg']['isediting'] = (bool)$USER->gradeediting[$this->courseid]; 1109 $jsarguments['cfg']['courseid'] = $this->courseid; 1110 $jsarguments['cfg']['studentsperpage'] = $this->get_students_per_page(); 1111 $jsarguments['cfg']['showquickfeedback'] = (bool) $showquickfeedback; 1112 1113 $module = array( 1114 'name' => 'gradereport_grader', 1115 'fullpath' => '/grade/report/grader/module.js', 1116 'requires' => array('base', 'dom', 'event', 'event-mouseenter', 'event-key', 'io-queue', 'json-parse', 'overlay') 1117 ); 1118 $PAGE->requires->js_init_call('M.gradereport_grader.init_report', $jsarguments, false, $module); 1119 $PAGE->requires->strings_for_js(array('addfeedback', 'feedback', 'grade'), 'grades'); 1120 $PAGE->requires->strings_for_js(array('ajaxchoosescale', 'ajaxclicktoclose', 'ajaxerror', 'ajaxfailedupdate', 'ajaxfieldchanged'), 'gradereport_grader'); 1121 if (!$enableajax && $USER->gradeediting[$this->courseid]) { 1122 $PAGE->requires->yui_module('moodle-core-formchangechecker', 1123 'M.core_formchangechecker.init', 1124 array(array( 1125 'formid' => 'gradereport_grader' 1126 )) 1127 ); 1128 $PAGE->requires->string_for_js('changesmadereallygoaway', 'moodle'); 1129 } 1130 1131 $rows = $this->get_right_range_row($rows); 1132 if ($displayaverages) { 1133 $rows = $this->get_right_avg_row($rows, true); 1134 $rows = $this->get_right_avg_row($rows); 1135 } 1136 1137 return $rows; 1138 } 1139 1140 /** 1141 * Depending on the style of report (fixedstudents vs traditional one-table), 1142 * arranges the rows of data in one or two tables, and returns the output of 1143 * these tables in HTML 1144 * @param boolean $displayaverages whether to display average rows in the table 1145 * @return string HTML 1146 */ 1147 public function get_grade_table($displayaverages = false) { 1148 global $OUTPUT; 1149 $leftrows = $this->get_left_rows($displayaverages); 1150 $rightrows = $this->get_right_rows($displayaverages); 1151 1152 $html = ''; 1153 1154 $fulltable = new html_table(); 1155 $fulltable->attributes['class'] = 'gradereport-grader-table'; 1156 $fulltable->id = 'user-grades'; 1157 1158 // Extract rows from each side (left and right) and collate them into one row each 1159 foreach ($leftrows as $key => $row) { 1160 $row->cells = array_merge($row->cells, $rightrows[$key]->cells); 1161 $fulltable->data[] = $row; 1162 } 1163 $html .= html_writer::table($fulltable); 1164 return $OUTPUT->container($html, 'gradeparent'); 1165 } 1166 1167 /** 1168 * Builds and return the row of icons for the left side of the report. 1169 * It only has one cell that says "Controls" 1170 * @param array $rows The Array of rows for the left part of the report 1171 * @param int $colspan The number of columns this cell has to span 1172 * @return array Array of rows for the left part of the report 1173 */ 1174 public function get_left_icons_row($rows=array(), $colspan=1) { 1175 global $USER; 1176 1177 if ($USER->gradeediting[$this->courseid]) { 1178 $controlsrow = new html_table_row(); 1179 $controlsrow->attributes['class'] = 'controls'; 1180 $controlscell = new html_table_cell(); 1181 $controlscell->attributes['class'] = 'header controls'; 1182 $controlscell->colspan = $colspan; 1183 $controlscell->text = $this->get_lang_string('controls', 'grades'); 1184 1185 $controlsrow->cells[] = $controlscell; 1186 $rows[] = $controlsrow; 1187 } 1188 return $rows; 1189 } 1190 1191 /** 1192 * Builds and return the header for the row of ranges, for the left part of the grader report. 1193 * @param array $rows The Array of rows for the left part of the report 1194 * @param int $colspan The number of columns this cell has to span 1195 * @return array Array of rows for the left part of the report 1196 */ 1197 public function get_left_range_row($rows=array(), $colspan=1) { 1198 global $CFG, $USER; 1199 1200 if ($this->get_pref('showranges')) { 1201 $rangerow = new html_table_row(); 1202 $rangerow->attributes['class'] = 'range r'.$this->rowcount++; 1203 $rangecell = new html_table_cell(); 1204 $rangecell->attributes['class'] = 'header range'; 1205 $rangecell->colspan = $colspan; 1206 $rangecell->header = true; 1207 $rangecell->scope = 'row'; 1208 $rangecell->text = $this->get_lang_string('range', 'grades'); 1209 $rangerow->cells[] = $rangecell; 1210 $rows[] = $rangerow; 1211 } 1212 1213 return $rows; 1214 } 1215 1216 /** 1217 * Builds and return the headers for the rows of averages, for the left part of the grader report. 1218 * @param array $rows The Array of rows for the left part of the report 1219 * @param int $colspan The number of columns this cell has to span 1220 * @param bool $groupavg If true, returns the row for group averages, otherwise for overall averages 1221 * @return array Array of rows for the left part of the report 1222 */ 1223 public function get_left_avg_row($rows=array(), $colspan=1, $groupavg=false) { 1224 if (!$this->canviewhidden) { 1225 // totals might be affected by hiding, if user can not see hidden grades the aggregations might be altered 1226 // better not show them at all if user can not see all hideen grades 1227 return $rows; 1228 } 1229 1230 $showaverages = $this->get_pref('showaverages'); 1231 $showaveragesgroup = $this->currentgroup && $showaverages; 1232 $straveragegroup = get_string('groupavg', 'grades'); 1233 1234 if ($groupavg) { 1235 if ($showaveragesgroup) { 1236 $groupavgrow = new html_table_row(); 1237 $groupavgrow->attributes['class'] = 'groupavg r'.$this->rowcount++; 1238 $groupavgcell = new html_table_cell(); 1239 $groupavgcell->attributes['class'] = 'header range'; 1240 $groupavgcell->colspan = $colspan; 1241 $groupavgcell->header = true; 1242 $groupavgcell->scope = 'row'; 1243 $groupavgcell->text = $straveragegroup; 1244 $groupavgrow->cells[] = $groupavgcell; 1245 $rows[] = $groupavgrow; 1246 } 1247 } else { 1248 $straverage = get_string('overallaverage', 'grades'); 1249 1250 if ($showaverages) { 1251 $avgrow = new html_table_row(); 1252 $avgrow->attributes['class'] = 'avg r'.$this->rowcount++; 1253 $avgcell = new html_table_cell(); 1254 $avgcell->attributes['class'] = 'header range'; 1255 $avgcell->colspan = $colspan; 1256 $avgcell->header = true; 1257 $avgcell->scope = 'row'; 1258 $avgcell->text = $straverage; 1259 $avgrow->cells[] = $avgcell; 1260 $rows[] = $avgrow; 1261 } 1262 } 1263 1264 return $rows; 1265 } 1266 1267 /** 1268 * Builds and return the row of icons when editing is on, for the right part of the grader report. 1269 * @param array $rows The Array of rows for the right part of the report 1270 * @return array Array of rows for the right part of the report 1271 */ 1272 public function get_right_icons_row($rows=array()) { 1273 global $USER; 1274 if ($USER->gradeediting[$this->courseid]) { 1275 $iconsrow = new html_table_row(); 1276 $iconsrow->attributes['class'] = 'controls'; 1277 1278 foreach ($this->gtree->items as $itemid => $unused) { 1279 // emulate grade element 1280 $item = $this->gtree->get_item($itemid); 1281 1282 $eid = $this->gtree->get_item_eid($item); 1283 $element = $this->gtree->locate_element($eid); 1284 $itemcell = new html_table_cell(); 1285 $itemcell->attributes['class'] = 'controls icons i'.$itemid; 1286 $itemcell->text = $this->get_icons($element); 1287 $iconsrow->cells[] = $itemcell; 1288 } 1289 $rows[] = $iconsrow; 1290 } 1291 return $rows; 1292 } 1293 1294 /** 1295 * Builds and return the row of ranges for the right part of the grader report. 1296 * @param array $rows The Array of rows for the right part of the report 1297 * @return array Array of rows for the right part of the report 1298 */ 1299 public function get_right_range_row($rows=array()) { 1300 global $OUTPUT; 1301 1302 if ($this->get_pref('showranges')) { 1303 $rangesdisplaytype = $this->get_pref('rangesdisplaytype'); 1304 $rangesdecimalpoints = $this->get_pref('rangesdecimalpoints'); 1305 $rangerow = new html_table_row(); 1306 $rangerow->attributes['class'] = 'heading range'; 1307 1308 foreach ($this->gtree->items as $itemid => $unused) { 1309 $item =& $this->gtree->items[$itemid]; 1310 $itemcell = new html_table_cell(); 1311 $itemcell->attributes['class'] .= ' range i'. $itemid; 1312 1313 $hidden = ''; 1314 if ($item->is_hidden()) { 1315 $hidden = ' dimmed_text '; 1316 } 1317 1318 $formattedrange = $item->get_formatted_range($rangesdisplaytype, $rangesdecimalpoints); 1319 1320 $itemcell->text = $OUTPUT->container($formattedrange, 'rangevalues'.$hidden); 1321 $rangerow->cells[] = $itemcell; 1322 } 1323 $rows[] = $rangerow; 1324 } 1325 return $rows; 1326 } 1327 1328 /** 1329 * Builds and return the row of averages for the right part of the grader report. 1330 * @param array $rows Whether to return only group averages or all averages. 1331 * @param bool $grouponly Whether to return only group averages or all averages. 1332 * @return array Array of rows for the right part of the report 1333 */ 1334 public function get_right_avg_row($rows=array(), $grouponly=false) { 1335 global $USER, $DB, $OUTPUT; 1336 1337 if (!$this->canviewhidden) { 1338 // Totals might be affected by hiding, if user can not see hidden grades the aggregations might be altered 1339 // better not show them at all if user can not see all hidden grades. 1340 return $rows; 1341 } 1342 1343 $averagesdisplaytype = $this->get_pref('averagesdisplaytype'); 1344 $averagesdecimalpoints = $this->get_pref('averagesdecimalpoints'); 1345 $meanselection = $this->get_pref('meanselection'); 1346 $shownumberofgrades = $this->get_pref('shownumberofgrades'); 1347 1348 if ($grouponly) { 1349 $showaverages = $this->currentgroup && $this->get_pref('showaverages'); 1350 $groupsql = $this->groupsql; 1351 $groupwheresql = $this->groupwheresql; 1352 $groupwheresqlparams = $this->groupwheresql_params; 1353 } else { 1354 $showaverages = $this->get_pref('showaverages'); 1355 $groupsql = ""; 1356 $groupwheresql = ""; 1357 $groupwheresqlparams = array(); 1358 } 1359 1360 if ($showaverages) { 1361 $totalcount = $this->get_numusers($grouponly); 1362 1363 // Limit to users with a gradeable role. 1364 list($gradebookrolessql, $gradebookrolesparams) = $DB->get_in_or_equal(explode(',', $this->gradebookroles), SQL_PARAMS_NAMED, 'grbr0'); 1365 1366 // Limit to users with an active enrollment. 1367 list($enrolledsql, $enrolledparams) = get_enrolled_sql($this->context); 1368 1369 // We want to query both the current context and parent contexts. 1370 list($relatedctxsql, $relatedctxparams) = $DB->get_in_or_equal($this->context->get_parent_context_ids(true), SQL_PARAMS_NAMED, 'relatedctx'); 1371 1372 $params = array_merge(array('courseid' => $this->courseid), $gradebookrolesparams, $enrolledparams, $groupwheresqlparams, $relatedctxparams); 1373 1374 // Find sums of all grade items in course. 1375 $sql = "SELECT g.itemid, SUM(g.finalgrade) AS sum 1376 FROM {grade_items} gi 1377 JOIN {grade_grades} g ON g.itemid = gi.id 1378 JOIN {user} u ON u.id = g.userid 1379 JOIN ($enrolledsql) je ON je.id = u.id 1380 JOIN ( 1381 SELECT DISTINCT ra.userid 1382 FROM {role_assignments} ra 1383 WHERE ra.roleid $gradebookrolessql 1384 AND ra.contextid $relatedctxsql 1385 ) rainner ON rainner.userid = u.id 1386 $groupsql 1387 WHERE gi.courseid = :courseid 1388 AND u.deleted = 0 1389 AND g.finalgrade IS NOT NULL 1390 $groupwheresql 1391 GROUP BY g.itemid"; 1392 $sumarray = array(); 1393 if ($sums = $DB->get_records_sql($sql, $params)) { 1394 foreach ($sums as $itemid => $csum) { 1395 $sumarray[$itemid] = $csum->sum; 1396 } 1397 } 1398 1399 // MDL-10875 Empty grades must be evaluated as grademin, NOT always 0 1400 // This query returns a count of ungraded grades (NULL finalgrade OR no matching record in grade_grades table) 1401 $sql = "SELECT gi.id, COUNT(DISTINCT u.id) AS count 1402 FROM {grade_items} gi 1403 CROSS JOIN {user} u 1404 JOIN ($enrolledsql) je 1405 ON je.id = u.id 1406 JOIN {role_assignments} ra 1407 ON ra.userid = u.id 1408 LEFT OUTER JOIN {grade_grades} g 1409 ON (g.itemid = gi.id AND g.userid = u.id AND g.finalgrade IS NOT NULL) 1410 $groupsql 1411 WHERE gi.courseid = :courseid 1412 AND ra.roleid $gradebookrolessql 1413 AND ra.contextid $relatedctxsql 1414 AND u.deleted = 0 1415 AND g.id IS NULL 1416 $groupwheresql 1417 GROUP BY gi.id"; 1418 1419 $ungradedcounts = $DB->get_records_sql($sql, $params); 1420 1421 $avgrow = new html_table_row(); 1422 $avgrow->attributes['class'] = 'avg'; 1423 1424 foreach ($this->gtree->items as $itemid => $unused) { 1425 $item =& $this->gtree->items[$itemid]; 1426 1427 if ($item->needsupdate) { 1428 $avgcell = new html_table_cell(); 1429 $avgcell->attributes['class'] = 'i'. $itemid; 1430 $avgcell->text = $OUTPUT->container(get_string('error'), 'gradingerror'); 1431 $avgrow->cells[] = $avgcell; 1432 continue; 1433 } 1434 1435 if (!isset($sumarray[$item->id])) { 1436 $sumarray[$item->id] = 0; 1437 } 1438 1439 if (empty($ungradedcounts[$itemid])) { 1440 $ungradedcount = 0; 1441 } else { 1442 $ungradedcount = $ungradedcounts[$itemid]->count; 1443 } 1444 1445 if ($meanselection == GRADE_REPORT_MEAN_GRADED) { 1446 $meancount = $totalcount - $ungradedcount; 1447 } else { // Bump up the sum by the number of ungraded items * grademin 1448 $sumarray[$item->id] += $ungradedcount * $item->grademin; 1449 $meancount = $totalcount; 1450 } 1451 1452 // Determine which display type to use for this average 1453 if ($USER->gradeediting[$this->courseid]) { 1454 $displaytype = GRADE_DISPLAY_TYPE_REAL; 1455 1456 } else if ($averagesdisplaytype == GRADE_REPORT_PREFERENCE_INHERIT) { // no ==0 here, please resave the report and user preferences 1457 $displaytype = $item->get_displaytype(); 1458 1459 } else { 1460 $displaytype = $averagesdisplaytype; 1461 } 1462 1463 // Override grade_item setting if a display preference (not inherit) was set for the averages 1464 if ($averagesdecimalpoints == GRADE_REPORT_PREFERENCE_INHERIT) { 1465 $decimalpoints = $item->get_decimals(); 1466 1467 } else { 1468 $decimalpoints = $averagesdecimalpoints; 1469 } 1470 1471 if (!isset($sumarray[$item->id]) || $meancount == 0) { 1472 $avgcell = new html_table_cell(); 1473 $avgcell->attributes['class'] = 'i'. $itemid; 1474 $avgcell->text = '-'; 1475 $avgrow->cells[] = $avgcell; 1476 1477 } else { 1478 $sum = $sumarray[$item->id]; 1479 $avgradeval = $sum/$meancount; 1480 $gradehtml = grade_format_gradevalue($avgradeval, $item, true, $displaytype, $decimalpoints); 1481 1482 $numberofgrades = ''; 1483 if ($shownumberofgrades) { 1484 $numberofgrades = " ($meancount)"; 1485 } 1486 1487 $avgcell = new html_table_cell(); 1488 $avgcell->attributes['class'] = 'i'. $itemid; 1489 $avgcell->text = $gradehtml.$numberofgrades; 1490 $avgrow->cells[] = $avgcell; 1491 } 1492 } 1493 $rows[] = $avgrow; 1494 } 1495 return $rows; 1496 } 1497 1498 /** 1499 * Given a grade_category, grade_item or grade_grade, this function 1500 * figures out the state of the object and builds then returns a div 1501 * with the icons needed for the grader report. 1502 * 1503 * @param array $element 1504 * @return string HTML 1505 */ 1506 protected function get_icons($element) { 1507 global $CFG, $USER, $OUTPUT; 1508 1509 if (!$USER->gradeediting[$this->courseid]) { 1510 return '<div class="grade_icons" />'; 1511 } 1512 1513 // Init all icons 1514 $editicon = ''; 1515 1516 $editable = true; 1517 1518 if ($element['type'] == 'grade') { 1519 $item = $element['object']->grade_item; 1520 if ($item->is_course_item() or $item->is_category_item()) { 1521 $editable = $this->overridecat; 1522 } 1523 } 1524 1525 if ($element['type'] != 'categoryitem' && $element['type'] != 'courseitem' && $editable) { 1526 $editicon = $this->gtree->get_edit_icon($element, $this->gpr); 1527 } 1528 1529 $editcalculationicon = ''; 1530 $showhideicon = ''; 1531 $lockunlockicon = ''; 1532 1533 if (has_capability('moodle/grade:manage', $this->context)) { 1534 if ($this->get_pref('showcalculations')) { 1535 $editcalculationicon = $this->gtree->get_calculation_icon($element, $this->gpr); 1536 } 1537 1538 if ($this->get_pref('showeyecons')) { 1539 $showhideicon = $this->gtree->get_hiding_icon($element, $this->gpr); 1540 } 1541 1542 if ($this->get_pref('showlocks')) { 1543 $lockunlockicon = $this->gtree->get_locking_icon($element, $this->gpr); 1544 } 1545 1546 } 1547 1548 $gradeanalysisicon = ''; 1549 if ($this->get_pref('showanalysisicon') && $element['type'] == 'grade') { 1550 $gradeanalysisicon .= $this->gtree->get_grade_analysis_icon($element['object']); 1551 } 1552 1553 return $OUTPUT->container($editicon.$editcalculationicon.$showhideicon.$lockunlockicon.$gradeanalysisicon, 'grade_icons'); 1554 } 1555 1556 /** 1557 * Given a category element returns collapsing +/- icon if available 1558 * @param object $element 1559 * @return string HTML 1560 */ 1561 protected function get_collapsing_icon($element) { 1562 global $OUTPUT; 1563 1564 $icon = ''; 1565 // If object is a category, display expand/contract icon 1566 if ($element['type'] == 'category') { 1567 // Load language strings 1568 $strswitchminus = $this->get_lang_string('aggregatesonly', 'grades'); 1569 $strswitchplus = $this->get_lang_string('gradesonly', 'grades'); 1570 $strswitchwhole = $this->get_lang_string('fullmode', 'grades'); 1571 1572 $url = new moodle_url($this->gpr->get_return_url(null, array('target'=>$element['eid'], 'sesskey'=>sesskey()))); 1573 1574 if (in_array($element['object']->id, $this->collapsed['aggregatesonly'])) { 1575 $url->param('action', 'switch_plus'); 1576 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_plus', $strswitchplus)); 1577 1578 } else if (in_array($element['object']->id, $this->collapsed['gradesonly'])) { 1579 $url->param('action', 'switch_whole'); 1580 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_whole', $strswitchwhole)); 1581 1582 } else { 1583 $url->param('action', 'switch_minus'); 1584 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_minus', $strswitchminus)); 1585 } 1586 } 1587 return $icon; 1588 } 1589 1590 /** 1591 * Processes a single action against a category, grade_item or grade. 1592 * @param string $target eid ({type}{id}, e.g. c4 for category4) 1593 * @param string $action Which action to take (edit, delete etc...) 1594 * @return 1595 */ 1596 public function process_action($target, $action) { 1597 return self::do_process_action($target, $action, $this->course->id); 1598 } 1599 1600 /** 1601 * From the list of categories that this user prefers to collapse choose ones that belong to the current course. 1602 * 1603 * This function serves two purposes. 1604 * Mainly it helps migrating from user preference style when all courses were stored in one preference. 1605 * Also it helps to remove the settings for categories that were removed if the array for one course grows too big. 1606 * 1607 * @param int $courseid 1608 * @param array $collapsed 1609 * @return array 1610 */ 1611 protected static function filter_collapsed_categories($courseid, $collapsed) { 1612 global $DB; 1613 if (empty($collapsed)) { 1614 $collapsed = array('aggregatesonly' => array(), 'gradesonly' => array()); 1615 } 1616 if (empty($collapsed['aggregatesonly']) && empty($collapsed['gradesonly'])) { 1617 return $collapsed; 1618 } 1619 $cats = $DB->get_fieldset_select('grade_categories', 'id', 'courseid = ?', array($courseid)); 1620 $collapsed['aggregatesonly'] = array_values(array_intersect($collapsed['aggregatesonly'], $cats)); 1621 $collapsed['gradesonly'] = array_values(array_intersect($collapsed['gradesonly'], $cats)); 1622 return $collapsed; 1623 } 1624 1625 /** 1626 * Returns the list of categories that this user wants to collapse or display aggregatesonly 1627 * 1628 * This method also migrates on request from the old format of storing user preferences when they were stored 1629 * in one preference for all courses causing DB error when trying to insert very big value. 1630 * 1631 * @param int $courseid 1632 * @return array 1633 */ 1634 protected static function get_collapsed_preferences($courseid) { 1635 if ($collapsed = get_user_preferences('grade_report_grader_collapsed_categories'.$courseid)) { 1636 return json_decode($collapsed, true); 1637 } 1638 1639 // Try looking for old location of user setting that used to store all courses in one serialized user preference. 1640 if (($oldcollapsedpref = get_user_preferences('grade_report_grader_collapsed_categories')) !== null) { 1641 if ($collapsedall = @unserialize($oldcollapsedpref)) { 1642 // We found the old-style preference, filter out only categories that belong to this course and update the prefs. 1643 $collapsed = static::filter_collapsed_categories($courseid, $collapsedall); 1644 if (!empty($collapsed['aggregatesonly']) || !empty($collapsed['gradesonly'])) { 1645 static::set_collapsed_preferences($courseid, $collapsed); 1646 $collapsedall['aggregatesonly'] = array_diff($collapsedall['aggregatesonly'], $collapsed['aggregatesonly']); 1647 $collapsedall['gradesonly'] = array_diff($collapsedall['gradesonly'], $collapsed['gradesonly']); 1648 if (!empty($collapsedall['aggregatesonly']) || !empty($collapsedall['gradesonly'])) { 1649 set_user_preference('grade_report_grader_collapsed_categories', serialize($collapsedall)); 1650 } else { 1651 unset_user_preference('grade_report_grader_collapsed_categories'); 1652 } 1653 } 1654 } else { 1655 // We found the old-style preference, but it is unreadable, discard it. 1656 unset_user_preference('grade_report_grader_collapsed_categories'); 1657 } 1658 } else { 1659 $collapsed = array('aggregatesonly' => array(), 'gradesonly' => array()); 1660 } 1661 return $collapsed; 1662 } 1663 1664 /** 1665 * Sets the list of categories that user wants to see collapsed in user preferences 1666 * 1667 * This method may filter or even trim the list if it does not fit in DB field. 1668 * 1669 * @param int $courseid 1670 * @param array $collapsed 1671 */ 1672 protected static function set_collapsed_preferences($courseid, $collapsed) { 1673 global $DB; 1674 // In an unlikely case that the list of collapsed categories for one course is too big for the user preference size, 1675 // try to filter the list of categories since array may contain categories that were deleted. 1676 if (strlen(json_encode($collapsed)) >= 1333) { 1677 $collapsed = static::filter_collapsed_categories($courseid, $collapsed); 1678 } 1679 1680 // If this did not help, "forget" about some of the collapsed categories. Still better than to loose all information. 1681 while (strlen(json_encode($collapsed)) >= 1333) { 1682 if (count($collapsed['aggregatesonly'])) { 1683 array_pop($collapsed['aggregatesonly']); 1684 } 1685 if (count($collapsed['gradesonly'])) { 1686 array_pop($collapsed['gradesonly']); 1687 } 1688 } 1689 1690 if (!empty($collapsed['aggregatesonly']) || !empty($collapsed['gradesonly'])) { 1691 set_user_preference('grade_report_grader_collapsed_categories'.$courseid, json_encode($collapsed)); 1692 } else { 1693 unset_user_preference('grade_report_grader_collapsed_categories'.$courseid); 1694 } 1695 } 1696 1697 /** 1698 * Processes a single action against a category, grade_item or grade. 1699 * @param string $target eid ({type}{id}, e.g. c4 for category4) 1700 * @param string $action Which action to take (edit, delete etc...) 1701 * @param int $courseid affected course. 1702 * @return 1703 */ 1704 public static function do_process_action($target, $action, $courseid = null) { 1705 global $DB; 1706 // TODO: this code should be in some grade_tree static method 1707 $targettype = substr($target, 0, 2); 1708 $targetid = substr($target, 2); 1709 // TODO: end 1710 1711 if ($targettype !== 'cg') { 1712 // The following code only works with categories. 1713 return true; 1714 } 1715 1716 if (!$courseid) { 1717 debugging('Function grade_report_grader::do_process_action() now requires additional argument courseid', 1718 DEBUG_DEVELOPER); 1719 if (!$courseid = $DB->get_field('grade_categories', 'courseid', array('id' => $targetid), IGNORE_MISSING)) { 1720 return true; 1721 } 1722 } 1723 1724 $collapsed = static::get_collapsed_preferences($courseid); 1725 1726 switch ($action) { 1727 case 'switch_minus': // Add category to array of aggregatesonly 1728 if (!in_array($targetid, $collapsed['aggregatesonly'])) { 1729 $collapsed['aggregatesonly'][] = $targetid; 1730 static::set_collapsed_preferences($courseid, $collapsed); 1731 } 1732 break; 1733 1734 case 'switch_plus': // Remove category from array of aggregatesonly, and add it to array of gradesonly 1735 $key = array_search($targetid, $collapsed['aggregatesonly']); 1736 if ($key !== false) { 1737 unset($collapsed['aggregatesonly'][$key]); 1738 } 1739 if (!in_array($targetid, $collapsed['gradesonly'])) { 1740 $collapsed['gradesonly'][] = $targetid; 1741 } 1742 static::set_collapsed_preferences($courseid, $collapsed); 1743 break; 1744 case 'switch_whole': // Remove the category from the array of collapsed cats 1745 $key = array_search($targetid, $collapsed['gradesonly']); 1746 if ($key !== false) { 1747 unset($collapsed['gradesonly'][$key]); 1748 static::set_collapsed_preferences($courseid, $collapsed); 1749 } 1750 1751 break; 1752 default: 1753 break; 1754 } 1755 1756 return true; 1757 } 1758 1759 /** 1760 * Refactored function for generating HTML of sorting links with matching arrows. 1761 * Returns an array with 'studentname' and 'idnumber' as keys, with HTML ready 1762 * to inject into a table header cell. 1763 * @param array $extrafields Array of extra fields being displayed, such as 1764 * user idnumber 1765 * @return array An associative array of HTML sorting links+arrows 1766 */ 1767 public function get_sort_arrows(array $extrafields = array()) { 1768 global $OUTPUT; 1769 $arrows = array(); 1770 1771 $strsortasc = $this->get_lang_string('sortasc', 'grades'); 1772 $strsortdesc = $this->get_lang_string('sortdesc', 'grades'); 1773 $strfirstname = $this->get_lang_string('firstname'); 1774 $strlastname = $this->get_lang_string('lastname'); 1775 $iconasc = $OUTPUT->pix_icon('t/sort_asc', $strsortasc, '', array('class' => 'iconsmall sorticon')); 1776 $icondesc = $OUTPUT->pix_icon('t/sort_desc', $strsortdesc, '', array('class' => 'iconsmall sorticon')); 1777 1778 $firstlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'firstname')), $strfirstname); 1779 $lastlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'lastname')), $strlastname); 1780 1781 $arrows['studentname'] = $lastlink; 1782 1783 if ($this->sortitemid === 'lastname') { 1784 if ($this->sortorder == 'ASC') { 1785 $arrows['studentname'] .= $iconasc; 1786 } else { 1787 $arrows['studentname'] .= $icondesc; 1788 } 1789 } 1790 1791 $arrows['studentname'] .= ' ' . $firstlink; 1792 1793 if ($this->sortitemid === 'firstname') { 1794 if ($this->sortorder == 'ASC') { 1795 $arrows['studentname'] .= $iconasc; 1796 } else { 1797 $arrows['studentname'] .= $icondesc; 1798 } 1799 } 1800 1801 foreach ($extrafields as $field) { 1802 $fieldlink = html_writer::link(new moodle_url($this->baseurl, 1803 array('sortitemid'=>$field)), get_user_field_name($field)); 1804 $arrows[$field] = $fieldlink; 1805 1806 if ($field == $this->sortitemid) { 1807 if ($this->sortorder == 'ASC') { 1808 $arrows[$field] .= $iconasc; 1809 } else { 1810 $arrows[$field] .= $icondesc; 1811 } 1812 } 1813 } 1814 1815 return $arrows; 1816 } 1817 1818 /** 1819 * Returns the maximum number of students to be displayed on each page 1820 * 1821 * @return int The maximum number of students to display per page 1822 */ 1823 public function get_students_per_page() { 1824 return $this->get_pref('studentsperpage'); 1825 } 1826 } 1827
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated: Fri Nov 28 20:29:05 2014 | Cross-referenced by PHPXref 0.7.1 |