Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * File containing the grade_report class
 *
 * @package   core_grades
 * @copyright 2007 Moodle Pty Ltd (http://moodle.com)
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

> use core_user\fields; require_once($CFG->libdir.'/gradelib.php'); >
/** * An abstract class containing variables and methods used by all or most reports. * @copyright 2007 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ abstract class grade_report { /** * The courseid. * @var int $courseid */ public $courseid; /** * The course. * @var object $course */ public $course; /** Grade plugin return tracking object. * @var object $gpr */ public $gpr; /** * The context. * * @var context $context */ public $context; /** * The grade_tree object. * @var grade_tree $gtree */ public $gtree; /** * User preferences related to this report. * @var array $prefs */ public $prefs = array(); /** * The roles for this report. * @var string $gradebookroles */ public $gradebookroles; /** * base url for sorting by first/last name. * @var string $baseurl */ public $baseurl; /** * base url for paging. * @var string $pbarurl */ public $pbarurl; /** * Current page (for paging). * @var int $page */ public $page;
< /** < * Array of cached language strings (using get_string() all the time takes a long time!). < * @var array $lang_strings < */ < public $lang_strings = array(); <
// GROUP VARIABLES (including SQL) /** * The current group being displayed. * @var int $currentgroup */ public $currentgroup; /** * The current groupname being displayed. * @var string $currentgroupname */ public $currentgroupname; /** * Current course group mode * @var int $groupmode */ public $groupmode; /** * A HTML select element used to select the current group. * @var string $group_selector */ public $group_selector; /** * An SQL fragment used to add linking information to the group tables. * @var string $groupsql */ protected $groupsql; /** * An SQL constraint to append to the queries used by this object to build the report. * @var string $groupwheresql */ protected $groupwheresql; /** * The ordered params for $groupwheresql * @var array $groupwheresql_params */ protected $groupwheresql_params = array(); // USER VARIABLES (including SQL). /** * An SQL constraint to append to the queries used by this object to build the report. * @var string $userwheresql */ protected $userwheresql; /** * The ordered params for $userwheresql * @var array $userwheresql_params */ protected $userwheresql_params = array(); /**
> * To store user data * Constructor. Sets local copies of user preferences and initialises grade_tree. > * @var stdClass $user * @param int $courseid > */ * @param object $gpr grade plugin return tracking object > public $user; * @param string $context > * @param int $page The current page being viewed (when report is paged) > /** */ > * show course/category totals if they contain hidden items public function __construct($courseid, $gpr, $context, $page=null) { > * @var array $showtotalsifcontainhidden global $CFG, $COURSE, $DB; > */ > public $showtotalsifcontainhidden = []; if (empty($CFG->gradebookroles)) { > print_error('norolesdefined', 'grades'); > /** } > * To store a link to preferences page > * @var string $preferences_page $this->courseid = $courseid; > */ if ($this->courseid == $COURSE->id) { > protected $preferences_page; $this->course = $COURSE; > } else { > /** $this->course = $DB->get_record('course', array('id' => $this->courseid)); > * If the user is wanting to search for a particular user within searchable fields their needle will be placed here. } > * @var string $usersearch > */ $this->gpr = $gpr; > protected string $usersearch = ''; $this->context = $context; > $this->page = $page; > /** > * If the user is wanting to show only one particular user their id will be placed here. // roles to be displayed in the gradebook > * @var int $userid $this->gradebookroles = $CFG->gradebookroles; > */ > protected int $userid = -1; // Set up link to preferences page > $this->preferences_page = $CFG->wwwroot.'/grade/report/grader/preferences.php?id='.$courseid; > /**
< print_error('norolesdefined', 'grades');
> throw new \moodle_exception('norolesdefined', 'grades');
// init gtree in child class
> } > // Set any url params. > $this->usersearch = optional_param('gpr_search', '', PARAM_NOTAGS); /** > $this->userid = optional_param('gpr_userid', -1, PARAM_INT);
* Given the name of a user preference (without grade_report_ prefix), locally saves then returns * the value of that preference. If the preference has already been fetched before, * the saved value is returned. If the preference is not set at the User level, the $CFG equivalent * is given (site default). * Can be called statically, but then doesn't benefit from caching * @param string $pref The name of the preference (do not include the grade_report_ prefix) * @param int $objectid An optional itemid or categoryid to check for a more fine-grained preference * @return mixed The value of the preference */ public function get_pref($pref, $objectid=null) { global $CFG; $fullprefname = 'grade_report_' . $pref; $shortprefname = 'grade_' . $pref; $retval = null; if (!isset($this) OR get_class($this) != 'grade_report') { if (!empty($objectid)) { $retval = get_user_preferences($fullprefname . $objectid, self::get_pref($pref)); } else if (isset($CFG->$fullprefname)) { $retval = get_user_preferences($fullprefname, $CFG->$fullprefname); } else if (isset($CFG->$shortprefname)) { $retval = get_user_preferences($fullprefname, $CFG->$shortprefname); } else { $retval = null; } } else { if (empty($this->prefs[$pref.$objectid])) { if (!empty($objectid)) { $retval = get_user_preferences($fullprefname . $objectid); if (empty($retval)) { // No item pref found, we are returning the global preference $retval = $this->get_pref($pref); $objectid = null; } } else { $retval = get_user_preferences($fullprefname, $CFG->$fullprefname); } $this->prefs[$pref.$objectid] = $retval; } else { $retval = $this->prefs[$pref.$objectid]; } } return $retval; } /** * Uses set_user_preferences() to update the value of a user preference. If 'default' is given as the value, * the preference will be removed in favour of a higher-level preference. * @param string $pref The name of the preference. * @param mixed $pref_value The value of the preference. * @param int $itemid An optional itemid to which the preference will be assigned * @return bool Success or failure. */ public function set_pref($pref, $pref_value='default', $itemid=null) { $fullprefname = 'grade_report_' . $pref; if ($pref_value == 'default') { return unset_user_preference($fullprefname.$itemid); } else { return set_user_preference($fullprefname.$itemid, $pref_value); } } /** * Handles form data sent by this report for this report. Abstract method to implement in all children. * @abstract * @param array $data * @return mixed True or array of errors */ abstract public function process_data($data); /** * Processes a single action against a category, grade_item or grade. * @param string $target Sortorder * @param string $action Which action to take (edit, delete etc...) * @return */ abstract public function process_action($target, $action); /**
> * Add additional links specific to plugin * First checks the cached language strings, then returns match if found, or uses get_string() > * @param context_course $context Course context * to get it from the DB, caches it then returns it. > * @param int $courseid Course ID * @param string $strcode > * @param array $element An array representing an element in the grade_tree * @param string $section Optional language section > * @param grade_plugin_return $gpr A grade_plugin_return object * @return string > * @param string $mode Mode (user or grade item) */ > * @param stdClass $templatecontext Template context public function get_lang_string($strcode, $section=null) { > * @param bool $otherplugins If we need to insert links to other plugins if (empty($this->lang_strings[$strcode])) { > * @return ?stdClass Updated template context $this->lang_strings[$strcode] = get_string($strcode, $section); > */ } > public static function get_additional_context(context_course $context, int $courseid, array $element, return $this->lang_strings[$strcode]; > grade_plugin_return $gpr, string $mode, stdClass $templatecontext, bool $otherplugins = false): ?stdClass { } > > if (!$otherplugins) { /** > $component = 'gradereport_' . $gpr->plugin; * Fetches and returns a count of all the users that will be shown on this page. > $params = [$context, $courseid, $element, $gpr, $mode, $templatecontext]; * @param boolean $groups include groups limit > return component_callback($component, 'get_report_link', $params); * @param boolean $users include users limit - default false, used for searching purposes > } else { * @return int Count of users > // Loop through all installed grade reports. */ > foreach (core_component::get_plugin_list('gradereport') as $plugin => $plugindir) { public function get_numusers($groups = true, $users = false) { > $params = [$context, $courseid, $element, $gpr, $mode, $templatecontext]; global $CFG, $DB; > $component = 'gradereport_' . $plugin; $userwheresql = ""; > $templatecontextupdated = component_callback($component, 'get_report_link', $params); $groupsql = ""; > if ($templatecontextupdated) { $groupwheresql = ""; > $templatecontext = $templatecontextupdated; > } // Limit to users with a gradeable role. > } list($gradebookrolessql, $gradebookrolesparams) = $DB->get_in_or_equal(explode(',', $this->gradebookroles), SQL_PARAMS_NAMED, 'grbr0'); > return $templatecontext; > } // Limit to users with an active enrollment. > } list($enrolledsql, $enrolledparams) = get_enrolled_sql($this->context); > > /**
// We want to query both the current context and parent contexts.
> * list($relatedctxsql, $relatedctxparams) = $DB->get_in_or_equal($this->context->get_parent_context_ids(true), SQL_PARAMS_NAMED, 'relatedctx'); > * @deprecated since 4.2 > * @todo MDL-77307 This will be deleted in Moodle 4.6.
$params = array_merge($gradebookrolesparams, $enrolledparams, $relatedctxparams);
> debugging('grade_report::get_lang_string() is deprecated, please use' . > ' grade_helper::get_lang_string() instead.', DEBUG_DEVELOPER); if ($users) { >
$userwheresql = $this->userwheresql; $params = array_merge($params, $this->userwheresql_params); } if ($groups) { $groupsql = $this->groupsql; $groupwheresql = $this->groupwheresql; $params = array_merge($params, $this->groupwheresql_params); } $sql = "SELECT DISTINCT u.id FROM {user} u JOIN ($enrolledsql) je ON je.id = u.id JOIN {role_assignments} ra ON u.id = ra.userid $groupsql WHERE ra.roleid $gradebookrolessql AND u.deleted = 0 $userwheresql $groupwheresql AND ra.contextid $relatedctxsql"; $selectedusers = $DB->get_records_sql($sql, $params); $count = 0; // Check if user's enrolment is active and should be displayed. if (!empty($selectedusers)) { $coursecontext = $this->context->get_course_context(true); $defaultgradeshowactiveenrol = !empty($CFG->grade_report_showonlyactiveenrol); $showonlyactiveenrol = get_user_preferences('grade_report_showonlyactiveenrol', $defaultgradeshowactiveenrol); $showonlyactiveenrol = $showonlyactiveenrol || !has_capability('moodle/course:viewsuspendedusers', $coursecontext); if ($showonlyactiveenrol) { $useractiveenrolments = get_enrolled_users($coursecontext, '', 0, 'u.id', null, 0, 0, true); } foreach ($selectedusers as $id => $value) { if (!$showonlyactiveenrol || ($showonlyactiveenrol && array_key_exists($id, $useractiveenrolments))) { $count++; } } } return $count; } /** * Shows support for being used as a 'Grades' report. */ public static function supports_mygrades() { return false; } /** * Sets up this object's group variables, mainly to restrict the selection of users to display. */ protected function setup_groups() { // find out current groups mode if ($this->groupmode = groups_get_course_groupmode($this->course)) { if (empty($this->gpr->groupid)) { $this->currentgroup = groups_get_course_group($this->course, true); } else { $this->currentgroup = $this->gpr->groupid; } $this->group_selector = groups_print_course_menu($this->course, $this->pbarurl, true); if ($this->groupmode == SEPARATEGROUPS and !$this->currentgroup and !has_capability('moodle/site:accessallgroups', $this->context)) { $this->currentgroup = -2; // means can not access any groups at all } if ($this->currentgroup) { if ($group = groups_get_group($this->currentgroup)) { $this->currentgroupname = $group->name; } $this->groupsql = " JOIN {groups_members} gm ON gm.userid = u.id "; $this->groupwheresql = " AND gm.groupid = :gr_grpid "; $this->groupwheresql_params = array('gr_grpid'=>$this->currentgroup); } } } /** * Sets up this report's user criteria to restrict the selection of users to display. */ public function setup_users() { global $SESSION, $DB; $filterfirstnamekey = "filterfirstname-{$this->context->id}"; $filtersurnamekey = "filtersurname-{$this->context->id}"; $this->userwheresql = ""; $this->userwheresql_params = array(); if (!empty($SESSION->gradereport[$filterfirstnamekey])) { $this->userwheresql .= ' AND '.$DB->sql_like('u.firstname', ':firstname', false, false); $this->userwheresql_params['firstname'] = $SESSION->gradereport[$filterfirstnamekey] . '%'; } if (!empty($SESSION->gradereport[$filtersurnamekey])) { $this->userwheresql .= ' AND '.$DB->sql_like('u.lastname', ':lastname', false, false); $this->userwheresql_params['lastname'] = $SESSION->gradereport[$filtersurnamekey] . '%'; }
> } > // When a user wants to view a particular user rather than a set of users. > // By omission when selecting one user, also allow passing the search value around. /** > if ($this->userid !== -1) { * Returns an arrow icon inside an <a> tag, for the purpose of sorting a column. > $this->userwheresql .= " AND u.id = :uid"; * @param string $direction > $this->userwheresql_params['uid'] = $this->userid; * @param moodle_url $sortlink > } */ > protected function get_sort_arrow($direction='move', $sortlink=null) { > // A user wants to return a subset of learners that match their search criteria. global $OUTPUT; > if ($this->usersearch !== '' && $this->userid === -1) { $pix = array('up' => 't/sort_desc', 'down' => 't/sort_asc', 'move' => 't/sort'); > // Get the fields for all contexts because there is a special case later where it allows $matrix = array('up' => 'desc', 'down' => 'asc', 'move' => 'asc'); > // matches of fields you can't access if they are on your own account. $strsort = $this->get_lang_string('sort' . $matrix[$direction]); > $userfields = fields::for_identity(null, false)->with_userpic(); > ['mappings' => $mappings] = (array)$userfields->get_sql('u', true); $arrow = $OUTPUT->pix_icon($pix[$direction], '', '', ['class' => 'sorticon']); > [ return html_writer::link($sortlink, $arrow, ['title' => $strsort, 'aria-label' => $strsort]); > 'where' => $keywordswhere, } > 'params' => $keywordsparams, > ] = $this->get_users_search_sql($mappings, (array)$userfields); /** > $this->userwheresql .= " AND $keywordswhere"; * Optionally blank out course/category totals if they contain any hidden items > $this->userwheresql_params = array_merge($this->userwheresql_params, $keywordsparams); * @param string $courseid the course id > } * @param string $course_item an instance of grade_item > } * @param string $finalgrade the grade for the course_item > * @return array[] containing values for 'grade', 'grademax', 'grademin', 'aggregationstatus' and 'aggregationweight' > /** */ > * Prepare SQL where clause and associated parameters for any user searching being performed. protected function blank_hidden_total_and_adjust_bounds($courseid, $course_item, $finalgrade) { > * This mostly came from core_user\table\participants_search with some slight modifications four our use case. global $CFG, $DB; > * static $hiding_affected = null;//array of items in this course affected by hiding > * @param array $mappings Array of field mappings (fieldname => SQL code for the value) > * @param array $userfields An array that we cast from user profile fields to search within. // If we're dealing with multiple users we need to know when we've moved on to a new user. > * @return array SQL query data in the format ['where' => '', 'params' => []]. static $previous_userid = null; > */ > protected function get_users_search_sql(array $mappings, array $userfields): array { // If we're dealing with multiple courses we need to know when we've moved on to a new course. > global $DB, $USER; static $previous_courseid = null; > > $canviewfullnames = has_capability('moodle/site:viewfullnames', $this->context); $coursegradegrade = grade_grade::fetch(array('userid'=>$this->user->id, 'itemid'=>$course_item->id)); > $grademin = $course_item->grademin; > $params = []; $grademax = $course_item->grademax; > $searchkey1 = 'search01'; if ($coursegradegrade) { > $searchkey2 = 'search02'; $grademin = $coursegradegrade->get_grade_min(); > $searchkey3 = 'search03'; $grademax = $coursegradegrade->get_grade_max(); > } else { > $conditions = []; $coursegradegrade = new grade_grade(array('userid'=>$this->user->id, 'itemid'=>$course_item->id), false); > } > // Search by fullname. $hint = $coursegradegrade->get_aggregation_hint(); > [$fullname, $fullnameparams] = fields::get_sql_fullname('u', $canviewfullnames); $aggregationstatus = $hint['status']; > $conditions[] = $DB->sql_like($fullname, ':' . $searchkey1, false, false); $aggregationweight = $hint['weight']; > $params = array_merge($params, $fullnameparams); > if (!is_array($this->showtotalsifcontainhidden)) { > // Search by email. debugging('showtotalsifcontainhidden should be an array', DEBUG_DEVELOPER); > $email = $DB->sql_like('email', ':' . $searchkey2, false, false); $this->showtotalsifcontainhidden = array($courseid => $this->showtotalsifcontainhidden); > } > if (!in_array('email', $userfields)) { > $maildisplay = 'maildisplay0'; if ($this->showtotalsifcontainhidden[$courseid] == GRADE_REPORT_SHOW_REAL_TOTAL_IF_CONTAINS_HIDDEN) { > $userid1 = 'userid01'; return array('grade' => $finalgrade, > // Prevent users who hide their email address from being found by others 'grademin' => $grademin, > // who aren't allowed to see hidden email addresses. 'grademax' => $grademax, > $email = "(". $email ." AND (" . 'aggregationstatus' => $aggregationstatus, > "u.maildisplay <> :$maildisplay " . 'aggregationweight' => $aggregationweight); > "OR u.id = :$userid1". // Users can always find themselves. } > "))"; > $params[$maildisplay] = core_user::MAILDISPLAY_HIDE; // If we've moved on to another course or user, reload the grades. > $params[$userid1] = $USER->id; if ($previous_userid != $this->user->id || $previous_courseid != $courseid) { > } $hiding_affected = null; > $previous_userid = $this->user->id; > $conditions[] = $email; $previous_courseid = $courseid; > } > // Search by idnumber. > $idnumber = $DB->sql_like('idnumber', ':' . $searchkey3, false, false); if (!$hiding_affected) { > $items = grade_item::fetch_all(array('courseid'=>$courseid)); > if (!in_array('idnumber', $userfields)) { $grades = array(); > $userid2 = 'userid02'; $sql = "SELECT g.* > // Users who aren't allowed to see idnumbers should at most find themselves FROM {grade_grades} g > // when searching for an idnumber. JOIN {grade_items} gi ON gi.id = g.itemid > $idnumber = "(". $idnumber . " AND u.id = :$userid2)"; WHERE g.userid = {$this->user->id} AND gi.courseid = {$courseid}"; > $params[$userid2] = $USER->id; if ($gradesrecords = $DB->get_records_sql($sql)) { > } foreach ($gradesrecords as $grade) { > $grades[$grade->itemid] = new grade_grade($grade, false); > $conditions[] = $idnumber; } > unset($gradesrecords); > // Search all user identify fields. } > $extrasearchfields = fields::get_identity_fields(null, false); foreach ($items as $itemid => $unused) { > foreach ($extrasearchfields as $fieldindex => $extrasearchfield) { if (!isset($grades[$itemid])) { > if (in_array($extrasearchfield, ['email', 'idnumber', 'country'])) { $grade_grade = new grade_grade(); > // Already covered above. $grade_grade->userid = $this->user->id; > continue; $grade_grade->itemid = $items[$itemid]->id; > } $grades[$itemid] = $grade_grade; > // The param must be short (max 32 characters) so don't include field name. } > $param = $searchkey3 . '_ident' . $fieldindex; $grades[$itemid]->grade_item =& $items[$itemid]; > $fieldsql = $mappings[$extrasearchfield]; } > $condition = $DB->sql_like($fieldsql, ':' . $param, false, false); $hiding_affected = grade_grade::get_hiding_affected($grades, $items); > $params[$param] = "%$this->usersearch%"; } > > if (!in_array($extrasearchfield, $userfields)) { //if the item definitely depends on a hidden item > // User cannot see this field, but allow match if their own account. if (array_key_exists($course_item->id, $hiding_affected['altered']) || > $userid3 = 'userid03_ident' . $fieldindex; array_key_exists($course_item->id, $hiding_affected['alteredgrademin']) || > $condition = "(". $condition . " AND u.id = :$userid3)"; array_key_exists($course_item->id, $hiding_affected['alteredgrademax']) || > $params[$userid3] = $USER->id; array_key_exists($course_item->id, $hiding_affected['alteredaggregationstatus']) || > } array_key_exists($course_item->id, $hiding_affected['alteredaggregationweight'])) { > $conditions[] = $condition; if (!$this->showtotalsifcontainhidden[$courseid] && array_key_exists($course_item->id, $hiding_affected['altered'])) { > } // Hide the grade, but only when it has changed. > $finalgrade = null; > $where = "(". implode(" OR ", $conditions) .") "; } else { > $params[$searchkey1] = "%$this->usersearch%"; //use reprocessed marks that exclude hidden items > $params[$searchkey2] = "%$this->usersearch%"; if (array_key_exists($course_item->id, $hiding_affected['altered'])) { > $params[$searchkey3] = "%$this->usersearch%"; $finalgrade = $hiding_affected['altered'][$course_item->id]; > } > return [ if (array_key_exists($course_item->id, $hiding_affected['alteredgrademin'])) { > 'where' => $where, $grademin = $hiding_affected['alteredgrademin'][$course_item->id]; > 'params' => $params, } > ];
< * @param moodle_url $sortlink
> * @param moodle_url|null $sortlink
< protected function get_sort_arrow($direction='move', $sortlink=null) {
> protected function get_sort_arrow(string $direction = 'down', ?moodle_url $sortlink = null) {
< $pix = array('up' => 't/sort_desc', 'down' => 't/sort_asc', 'move' => 't/sort'); < $matrix = array('up' => 'desc', 'down' => 'asc', 'move' => 'asc'); < $strsort = $this->get_lang_string('sort' . $matrix[$direction]); <
> $pix = ['up' => 't/sort_desc', 'down' => 't/sort_asc']; > $matrix = ['up' => 'desc', 'down' => 'asc']; > $strsort = grade_helper::get_lang_string($matrix[$direction], 'moodle');
< return html_writer::link($sortlink, $arrow, ['title' => $strsort, 'aria-label' => $strsort]);
> return html_writer::link($sortlink, $arrow, ['title' => $strsort, 'aria-label' => $strsort, 'data-collapse' => 'sort']);
$aggregationweight = $hiding_affected['alteredaggregationweight'][$course_item->id]; } if (!$this->showtotalsifcontainhidden[$courseid]) { // If the course total is hidden we must hide the weight otherwise // it can be used to compute the course total. $aggregationstatus = 'unknown'; $aggregationweight = null; } } } else if (array_key_exists($course_item->id, $hiding_affected['unknowngrades'])) { //not sure whether or not this item depends on a hidden item if (!$this->showtotalsifcontainhidden[$courseid]) { //hide the grade $finalgrade = null; } else { //use reprocessed marks that exclude hidden items $finalgrade = $hiding_affected['unknowngrades'][$course_item->id]; if (array_key_exists($course_item->id, $hiding_affected['alteredgrademin'])) { $grademin = $hiding_affected['alteredgrademin'][$course_item->id]; } if (array_key_exists($course_item->id, $hiding_affected['alteredgrademax'])) { $grademax = $hiding_affected['alteredgrademax'][$course_item->id]; } if (array_key_exists($course_item->id, $hiding_affected['alteredaggregationstatus'])) { $aggregationstatus = $hiding_affected['alteredaggregationstatus'][$course_item->id]; } if (array_key_exists($course_item->id, $hiding_affected['alteredaggregationweight'])) { $aggregationweight = $hiding_affected['alteredaggregationweight'][$course_item->id]; } } } return array('grade' => $finalgrade, 'grademin' => $grademin, 'grademax' => $grademax, 'aggregationstatus'=>$aggregationstatus, 'aggregationweight'=>$aggregationweight); } /** * Optionally blank out course/category totals if they contain any hidden items * @deprecated since Moodle 2.8 - Call blank_hidden_total_and_adjust_bounds instead. * @param string $courseid the course id * @param string $course_item an instance of grade_item * @param string $finalgrade the grade for the course_item * @return string The new final grade */ protected function blank_hidden_total($courseid, $course_item, $finalgrade) { // Note it is flawed to call this function directly because // the aggregated grade does not make sense without the updated min and max information. debugging('grade_report::blank_hidden_total() is deprecated. Call grade_report::blank_hidden_total_and_adjust_bounds instead.', DEBUG_DEVELOPER); $result = $this->blank_hidden_total_and_adjust_bounds($courseid, $course_item, $finalgrade); return $result['grade']; }
> } > /** > * Calculate average grade for a given grade item. > * Based on calculate_averages function from grade/report/user/lib.php > * > * @param grade_item $gradeitem Grade item > * @param array $info Ungraded grade items counts and report preferences. > * @return array Average grade and meancount. > */ > public static function calculate_average(grade_item $gradeitem, array $info): array { > > $meanselection = $info['report']['meanselection']; > $totalcount = $info['report']['totalcount']; > $ungradedcounts = $info['ungradedcounts']; > $sumarray = $info['sumarray']; > > if (empty($sumarray[$gradeitem->id])) { > $sumarray[$gradeitem->id] = 0; > } > > if (empty($ungradedcounts[$gradeitem->id])) { > $ungradedcounts = 0; > } else { > $ungradedcounts = $ungradedcounts[$gradeitem->id]->count; > } > > // If they want the averages to include all grade items. > if ($meanselection == GRADE_REPORT_MEAN_GRADED) { > $meancount = $totalcount - $ungradedcounts; > } else { > // Bump up the sum by the number of ungraded items * grademin. > $sumarray[$gradeitem->id] += ($ungradedcounts * $gradeitem->grademin); > $meancount = $totalcount; > } > > $aggr['meancount'] = $meancount; > > if (empty($sumarray[$gradeitem->id]) || $meancount == 0) { > $aggr['average'] = null; > } else { > $sum = $sumarray[$gradeitem->id]; > $aggr['average'] = $sum / $meancount; > } > return $aggr; > } > > /** > * Get ungraded grade items info and sum of all grade items in a course. > * Based on calculate_averages function from grade/report/user/lib.php > * > * @return array Ungraded grade items counts with report preferences. > */ > public function ungraded_counts(): array { > global $DB; > > $groupid = null; > if (isset($this->gpr->groupid)) { > $groupid = $this->gpr->groupid; > } > > $info = []; > $info['report'] = [ > 'averagesdisplaytype' => $this->get_pref('averagesdisplaytype'), > 'averagesdecimalpoints' => $this->get_pref('averagesdecimalpoints'), > 'meanselection' => $this->get_pref('meanselection'), > 'shownumberofgrades' => $this->get_pref('shownumberofgrades'), > 'totalcount' => $this->get_numusers(!is_null($groupid)), > ]; > > // We want to query both the current context and parent contexts. > list($relatedctxsql, $relatedctxparams) = > $DB->get_in_or_equal($this->context->get_parent_context_ids(true), SQL_PARAMS_NAMED, 'relatedctx'); > > // Limit to users with a gradeable role ie students. > list($gradebookrolessql, $gradebookrolesparams) = > $DB->get_in_or_equal(explode(',', $this->gradebookroles), SQL_PARAMS_NAMED, 'grbr0'); > > // Limit to users with an active enrolment. > $defaultgradeshowactiveenrol = !empty($CFG->grade_report_showonlyactiveenrol); > $showonlyactiveenrol = get_user_preferences('grade_report_showonlyactiveenrol', $defaultgradeshowactiveenrol); > $showonlyactiveenrol = $showonlyactiveenrol || > !has_capability('moodle/course:viewsuspendedusers', $this->context); > list($enrolledsql, $enrolledparams) = get_enrolled_sql($this->context, '', 0, $showonlyactiveenrol); > > $params = array_merge($this->groupwheresql_params, $gradebookrolesparams, $enrolledparams, $relatedctxparams); > $params['courseid'] = $this->courseid; > > // Aggregate on whole course only. > if (empty($groupid)) { > $this->groupsql = null; > $this->groupwheresql = null; > } > > // Empty grades must be evaluated as grademin, NOT always 0. > // This query returns a count of ungraded grades (NULL finalgrade OR no matching record in grade_grades table). > // No join condition when joining grade_items and user to get a grade item row for every user. > // Then left join with grade_grades and look for rows with null final grade > // (which includes grade items with no grade_grade). > $sql = "SELECT gi.id, COUNT(u.id) AS count > FROM {grade_items} gi > JOIN {user} u ON u.deleted = 0 > JOIN ($enrolledsql) je ON je.id = u.id > JOIN ( > SELECT DISTINCT ra.userid > FROM {role_assignments} ra > WHERE ra.roleid $gradebookrolessql > AND ra.contextid $relatedctxsql > ) rainner ON rainner.userid = u.id > LEFT JOIN {grade_grades} gg > ON (gg.itemid = gi.id AND gg.userid = u.id AND gg.finalgrade IS NOT NULL AND gg.hidden = 0) > $this->groupsql > WHERE gi.courseid = :courseid > AND gg.finalgrade IS NULL > $this->groupwheresql > GROUP BY gi.id"; > $info['ungradedcounts'] = $DB->get_records_sql($sql, $params); > > // Find sums of all grade items in course. > $sql = "SELECT gg.itemid, SUM(gg.finalgrade) AS sum > FROM {grade_items} gi > JOIN {grade_grades} gg ON gg.itemid = gi.id > JOIN {user} u ON u.id = gg.userid > JOIN ($enrolledsql) je ON je.id = gg.userid > JOIN ( > SELECT DISTINCT ra.userid > FROM {role_assignments} ra > WHERE ra.roleid $gradebookrolessql > AND ra.contextid $relatedctxsql > ) rainner ON rainner.userid = u.id > $this->groupsql > WHERE gi.courseid = :courseid > AND u.deleted = 0 > AND gg.finalgrade IS NOT NULL > AND gg.hidden = 0 > $this->groupwheresql > GROUP BY gg.itemid"; > > $sumarray = []; > $sums = $DB->get_recordset_sql($sql, $params); > foreach ($sums as $itemid => $csum) { > $sumarray[$itemid] = grade_floatval($csum->sum); > } > $sums->close(); > $info['sumarray'] = $sumarray; > > return $info; > } > > /** > * Get grade item type names in a course to use in filter dropdown. > * > * @return array Item types. > */ > public function item_types(): array { > global $DB, $CFG; > > $modnames = []; > $sql = "(SELECT gi.itemmodule > FROM {grade_items} gi > WHERE gi.courseid = :courseid1 > AND gi.itemmodule IS NOT NULL) > UNION > (SELECT gi1.itemtype > FROM {grade_items} gi1 > WHERE gi1.courseid = :courseid2 > AND gi1.itemtype = 'manual')"; > > $itemtypes = $DB->get_records_sql($sql, ['courseid1' => $this->courseid, 'courseid2' => $this->courseid]); > foreach ($itemtypes as $itemtype => $value) { > if (file_exists("$CFG->dirroot/mod/$itemtype/lib.php")) { > $modnames[$itemtype] = get_string("modulename", $itemtype, null, true); > } else if ($itemtype == 'manual') { > $modnames[$itemtype] = get_string('manualitem', 'grades', null, true); > } > } > > return $modnames; > } > > /** > * Load a valid list of gradable users in a course. > * > * @param int $courseid The course ID. > * @param int|null $groupid The group ID (optional). > * @return array A list of enrolled gradable users. > */ > public static function get_gradable_users(int $courseid, ?int $groupid = null): array { > global $CFG; > require_once($CFG->dirroot . '/grade/lib.php'); > > $context = context_course::instance($courseid); > $defaultgradeshowactiveenrol = !empty($CFG->grade_report_showonlyactiveenrol); > $onlyactiveenrol = get_user_preferences('grade_report_showonlyactiveenrol', $defaultgradeshowactiveenrol) || > !has_capability('moodle/course:viewsuspendedusers', $context); > > return get_gradable_users($courseid, $groupid, $onlyactiveenrol); > } >