Файловый менеджер - Редактировать - /home/harasnat/www/mf/grade.tar
Назад
classes/external/get_groups_for_search_widget.php 0000604 00000013351 15062070555 0016454 0 ustar 00 <?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/>. namespace core_grades\external; use context_course; use core_external\external_api; use core_external\external_description; use core_external\external_function_parameters; use core_external\external_multiple_structure; use core_external\external_single_structure; use core_external\external_value; use core_external\external_warnings; /** * External group report API implementation * * @package core_grades * @copyright 2022 Mathew May <mathew.solutions> * @category external * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * @deprecated */ class get_groups_for_search_widget extends external_api { /** * Returns description of method parameters. * * @return external_function_parameters * @deprecated since 4.2 */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters ( [ 'courseid' => new external_value(PARAM_INT, 'Course Id', VALUE_REQUIRED), 'actionbaseurl' => new external_value(PARAM_URL, 'The base URL for the group action', VALUE_REQUIRED) ] ); } /** * Given a course ID find the existing user groups and map some fields to the returned array of group objects. * * @param int $courseid * @param string $actionbaseurl The base URL for the group action. * @return array Groups and warnings to pass back to the calling widget. * @deprecated since 4.2 */ public static function execute(int $courseid, string $actionbaseurl): array { global $DB, $USER, $COURSE; $params = self::validate_parameters( self::execute_parameters(), [ 'courseid' => $courseid, 'actionbaseurl' => $actionbaseurl ] ); $warnings = []; $context = context_course::instance($params['courseid']); parent::validate_context($context); $mappedgroups = []; $course = $DB->get_record('course', ['id' => $params['courseid']]); // Initialise the grade tracking object. if ($groupmode = $course->groupmode) { $aag = has_capability('moodle/site:accessallgroups', $context); $usergroups = []; $groupuserid = 0; if ($groupmode == VISIBLEGROUPS || $aag) { // Get user's own groups and put to the top. $usergroups = groups_get_all_groups($course->id, $USER->id, $course->defaultgroupingid); } else { $groupuserid = $USER->id; } $allowedgroups = groups_get_all_groups($course->id, $groupuserid, $course->defaultgroupingid); $allgroups = array_merge($allowedgroups, $usergroups); // Filter out any duplicate groups. $groupsmenu = array_intersect_key($allgroups, array_unique(array_column($allgroups, 'name'))); if (!$allowedgroups || $groupmode == VISIBLEGROUPS || $aag) { array_unshift($groupsmenu, (object) [ 'id' => 0, 'name' => get_string('allparticipants'), ]); } $mappedgroups = array_map(function($group) use ($COURSE, $actionbaseurl, $context) { $url = new \moodle_url($actionbaseurl, [ 'id' => $COURSE->id, 'group' => $group->id ]); return (object) [ 'id' => $group->id, 'name' => format_string($group->name, true, ['context' => $context]), 'url' => $url->out(false), 'active' => false ]; }, $groupsmenu); } return [ 'groups' => $mappedgroups, 'warnings' => $warnings, ]; } /** * Returns description of what the group search for the widget should return. * * @return external_single_structure * @deprecated since 4.2 */ public static function execute_returns(): external_single_structure { return new external_single_structure([ 'groups' => new external_multiple_structure(self::group_description()), 'warnings' => new external_warnings(), ]); } /** * Create group return value description. * * @return external_description */ public static function group_description(): external_description { $groupfields = [ 'id' => new external_value(PARAM_ALPHANUM, 'An ID for the group', VALUE_REQUIRED), 'url' => new external_value(PARAM_URL, 'The link that applies the group action', VALUE_REQUIRED), 'name' => new external_value(PARAM_TEXT, 'The full name of the group', VALUE_REQUIRED), 'active' => new external_value(PARAM_BOOL, 'Are we currently on this item?', VALUE_REQUIRED) ]; return new external_single_structure($groupfields); } /** * Mark the function as deprecated. * @return bool */ public static function execute_is_deprecated() { return true; } } classes/external/get_enrolled_users_for_search_widget.php 0000604 00000014413 15062070555 0020162 0 ustar 00 <?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/>. namespace core_grades\external; use core_external\external_api; use core_external\external_description; use core_external\external_function_parameters; use core_external\external_multiple_structure; use core_external\external_single_structure; use core_external\external_value; use core_external\external_warnings; use core_external\restricted_context_exception; use moodle_url; use core_user; defined('MOODLE_INTERNAL') || die; require_once($CFG->dirroot.'/grade/lib.php'); /** * Get the enrolled users within and map some fields to the returned array of user objects. * * @package core_grades * @copyright 2022 Mihail Geshoski <mihail@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * @since Moodle 4.1 * @deprecated */ class get_enrolled_users_for_search_widget extends external_api { /** * Returns description of method parameters. * * @return external_function_parameters * @deprecated since 4.2 */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters ( [ 'courseid' => new external_value(PARAM_INT, 'Course Id', VALUE_REQUIRED), 'actionbaseurl' => new external_value(PARAM_URL, 'The base URL for the user option', VALUE_REQUIRED), 'groupid' => new external_value(PARAM_INT, 'Group Id', VALUE_DEFAULT, 0) ] ); } /** * Given a course ID find the enrolled users within and map some fields to the returned array of user objects. * * @param int $courseid * @param string $actionbaseurl The base URL for the user option. * @param int|null $groupid * @return array Users and warnings to pass back to the calling widget. * @throws coding_exception * @throws invalid_parameter_exception * @throws moodle_exception * @throws restricted_context_exception * @deprecated since 4.2 */ public static function execute(int $courseid, string $actionbaseurl, ?int $groupid = 0): array { global $DB, $PAGE; $params = self::validate_parameters( self::execute_parameters(), [ 'courseid' => $courseid, 'actionbaseurl' => $actionbaseurl, 'groupid' => $groupid ] ); $warnings = []; $coursecontext = \context_course::instance($params['courseid']); parent::validate_context($coursecontext); require_capability('moodle/course:viewparticipants', $coursecontext); $course = $DB->get_record('course', ['id' => $params['courseid']]); // Create a graded_users_iterator because it will properly check the groups etc. $defaultgradeshowactiveenrol = !empty($CFG->grade_report_showonlyactiveenrol); $showonlyactiveenrol = get_user_preferences('grade_report_showonlyactiveenrol', $defaultgradeshowactiveenrol); $showonlyactiveenrol = $showonlyactiveenrol || !has_capability('moodle/course:viewsuspendedusers', $coursecontext); $gui = new \graded_users_iterator($course, null, $params['groupid']); $gui->require_active_enrolment($showonlyactiveenrol); $gui->init(); $users = []; while ($userdata = $gui->next_user()) { $guiuser = $userdata->user; $user = new \stdClass(); $user->fullname = fullname($guiuser); $user->id = $guiuser->id; $user->url = (new moodle_url($actionbaseurl, ['id' => $courseid, 'userid' => $guiuser->id]))->out(false); $userpicture = new \user_picture($guiuser); $userpicture->size = 1; $user->profileimage = $userpicture->get_url($PAGE)->out(false); $user->email = $guiuser->email; $user->active = false; $users[] = $user; } $gui->close(); return [ 'users' => $users, 'warnings' => $warnings, ]; } /** * Returns description of method result value. * * @return external_single_structure * @deprecated since 4.2 */ public static function execute_returns(): external_single_structure { return new external_single_structure([ 'users' => new external_multiple_structure(self::user_description()), 'warnings' => new external_warnings(), ]); } /** * Create user return value description. * * @return external_description */ public static function user_description(): external_description { $userfields = [ 'id' => new external_value(core_user::get_property_type('id'), 'ID of the user'), 'profileimage' => new external_value( PARAM_URL, 'The location of the users larger image', VALUE_OPTIONAL ), 'url' => new external_value( PARAM_URL, 'The link to the user report', VALUE_OPTIONAL ), 'fullname' => new external_value(PARAM_TEXT, 'The full name of the user', VALUE_OPTIONAL), 'email' => new external_value( core_user::get_property_type('email'), 'An email address - allow email as root@localhost', VALUE_OPTIONAL), 'active' => new external_value(PARAM_BOOL, 'Are we currently on this item?', VALUE_REQUIRED) ]; return new external_single_structure($userfields); } /** * Mark the function as deprecated. * @return bool */ public static function execute_is_deprecated() { return true; } } classes/external/create_gradecategories.php 0000604 00000027106 15062070555 0015216 0 ustar 00 <?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/>. namespace core_grades\external; use core_external\external_api; use core_external\external_function_parameters; use core_external\external_multiple_structure; use core_external\external_single_structure; use core_external\external_value; use core_external\external_warnings; defined('MOODLE_INTERNAL') || die; require_once("$CFG->libdir/gradelib.php"); require_once("$CFG->dirroot/grade/edit/tree/lib.php"); /** * Create gradecategories webservice. * * @package core_grades * @copyright 2021 Peter Burnett <peterburnett@catalyst-au.net> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * @since Moodle 3.11 */ class create_gradecategories extends external_api { /** * Returns description of method parameters * * @return external_function_parameters * @since Moodle 3.11 */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters( [ 'courseid' => new external_value(PARAM_INT, 'id of course', VALUE_REQUIRED), 'categories' => new external_multiple_structure( new external_single_structure([ 'fullname' => new external_value(PARAM_TEXT, 'fullname of category', VALUE_REQUIRED), 'options' => new external_single_structure([ 'aggregation' => new external_value(PARAM_INT, 'aggregation method', VALUE_OPTIONAL), 'aggregateonlygraded' => new external_value(PARAM_BOOL, 'exclude empty grades', VALUE_OPTIONAL), 'aggregateoutcomes' => new external_value(PARAM_BOOL, 'aggregate outcomes', VALUE_OPTIONAL), 'droplow' => new external_value(PARAM_INT, 'drop low grades', VALUE_OPTIONAL), 'itemname' => new external_value(PARAM_TEXT, 'the category total name', VALUE_OPTIONAL), 'iteminfo' => new external_value(PARAM_TEXT, 'the category iteminfo', VALUE_OPTIONAL), 'idnumber' => new external_value(PARAM_TEXT, 'the category idnumber', VALUE_OPTIONAL), 'gradetype' => new external_value(PARAM_INT, 'the grade type', VALUE_OPTIONAL), 'grademax' => new external_value(PARAM_INT, 'the grade max', VALUE_OPTIONAL), 'grademin' => new external_value(PARAM_INT, 'the grade min', VALUE_OPTIONAL), 'gradepass' => new external_value(PARAM_INT, 'the grade to pass', VALUE_OPTIONAL), 'display' => new external_value(PARAM_INT, 'the display type', VALUE_OPTIONAL), 'decimals' => new external_value(PARAM_INT, 'the decimal count', VALUE_OPTIONAL), 'hiddenuntil' => new external_value(PARAM_INT, 'grades hidden until', VALUE_OPTIONAL), 'locktime' => new external_value(PARAM_INT, 'lock grades after', VALUE_OPTIONAL), 'weightoverride' => new external_value(PARAM_BOOL, 'weight adjusted', VALUE_OPTIONAL), 'aggregationcoef2' => new external_value(PARAM_RAW, 'weight coefficient', VALUE_OPTIONAL), 'parentcategoryid' => new external_value(PARAM_INT, 'The parent category id', VALUE_OPTIONAL), 'parentcategoryidnumber' => new external_value(PARAM_TEXT, 'the parent category idnumber', VALUE_OPTIONAL), ], 'optional category data', VALUE_DEFAULT, []), ], 'Category to create', VALUE_REQUIRED) , 'Categories to create', VALUE_REQUIRED) ] ); } /** * Creates gradecategories inside of the specified course. * * @param int $courseid the courseid to create the gradecategory in. * @param array $categories the categories to create. * @return array array of created categoryids and warnings. * @since Moodle 3.11 */ public static function execute(int $courseid, array $categories): array { $params = self::validate_parameters(self::execute_parameters(), ['courseid' => $courseid, 'categories' => $categories]); // Now params are validated, update the references. $courseid = $params['courseid']; $categories = $params['categories']; // Check that the context and permissions are OK. $context = \context_course::instance($courseid); self::validate_context($context); require_capability('moodle/grade:manage', $context); return self::create_gradecategories_from_data($courseid, $categories); } /** * Returns description of method result value * * @return external_single_structure * @since Moodle 3.11 */ public static function execute_returns(): external_single_structure { return new external_single_structure([ 'categoryids' => new external_multiple_structure( new external_value(PARAM_INT, 'created cateogry ID') ), 'warnings' => new external_warnings(), ]); } /** * Takes an array of categories and creates the inside the category tree for the supplied courseid. * * @param int $courseid the courseid to create the categories inside of. * @param array $categories the categories to create. * @return array array of results and warnings. */ public static function create_gradecategories_from_data(int $courseid, array $categories): array { global $CFG, $DB; $defaultparentcat = \grade_category::fetch_course_category($courseid); // Setup default data so WS call needs to contain only data to set. // This is not done in the Parameters, so that the array of options can be optional. $defaultdata = [ 'aggregation' => grade_get_setting($courseid, 'aggregation', $CFG->grade_aggregation, true), 'aggregateonlygraded' => 1, 'aggregateoutcomes' => 0, 'droplow' => 0, 'grade_item_itemname' => '', 'grade_item_iteminfo' => '', 'grade_item_idnumber' => '', 'grade_item_gradetype' => GRADE_TYPE_VALUE, 'grade_item_grademax' => 100, 'grade_item_grademin' => 1, 'grade_item_gradepass' => 1, 'grade_item_display' => GRADE_DISPLAY_TYPE_DEFAULT, // Hack. This must be -2 to use the default setting. 'grade_item_decimals' => -2, 'grade_item_hiddenuntil' => 0, 'grade_item_locktime' => 0, 'grade_item_weightoverride' => 0, 'grade_item_aggregationcoef2' => 0, 'parentcategory' => $defaultparentcat->id ]; // Most of the data items need boilerplate prepended. These are the exceptions. $ignorekeys = [ 'aggregation', 'aggregateonlygraded', 'aggregateoutcomes', 'droplow', 'parentcategoryid', 'parentcategoryidnumber' ]; $createdcats = []; foreach ($categories as $category) { // Setup default data so WS call needs to contain only data to set. // This is not done in the Parameters, so that the array of options can be optional. $data = $defaultdata; $data['fullname'] = $category['fullname']; foreach ($category['options'] as $key => $value) { if (!in_array($key, $ignorekeys)) { $fullkey = 'grade_item_' . $key; $data[$fullkey] = $value; } else { $data[$key] = $value; } } // Handle parent category special case. // This figures the parent category id from the provided id OR idnumber. if (array_key_exists('parentcategoryid', $category['options']) && $parentcat = $DB->get_record('grade_categories', ['id' => $category['options']['parentcategoryid'], 'courseid' => $courseid])) { $data['parentcategory'] = $parentcat->id; } else if (array_key_exists('parentcategoryidnumber', $category['options']) && $parentcatgradeitem = $DB->get_record('grade_items', [ 'itemtype' => 'category', 'courseid' => $courseid, 'idnumber' => $category['options']['parentcategoryidnumber'] ], '*', IGNORE_MULTIPLE)) { if ($parentcat = $DB->get_record('grade_categories', ['courseid' => $courseid, 'id' => $parentcatgradeitem->iteminstance])) { $data['parentcategory'] = $parentcat->id; } } // Create new gradecategory item. $gradecategory = new \grade_category(['courseid' => $courseid], false); $gradecategory->apply_default_settings(); $gradecategory->apply_forced_settings(); // Data Validation. if (array_key_exists('grade_item_gradetype', $data) and $data['grade_item_gradetype'] == GRADE_TYPE_SCALE) { if (empty($data['grade_item_scaleid'])) { $warnings[] = ['item' => 'scaleid', 'warningcode' => 'invalidscale', 'message' => get_string('missingscale', 'grades')]; } } if (array_key_exists('grade_item_grademin', $data) and array_key_exists('grade_item_grademax', $data)) { if (($data['grade_item_grademax'] != 0 OR $data['grade_item_grademin'] != 0) AND ($data['grade_item_grademax'] == $data['grade_item_grademin'] OR $data['grade_item_grademax'] < $data['grade_item_grademin'])) { $warnings[] = ['item' => 'grademax', 'warningcode' => 'invalidgrade', 'message' => get_string('incorrectminmax', 'grades')]; } } if (!empty($warnings)) { return ['categoryids' => [], 'warnings' => $warnings]; } // Now call the update function with data. Transactioned so the gradebook isn't broken on bad data. // This is done per-category so that children can correctly discover the parent categories. try { $transaction = $DB->start_delegated_transaction(); \grade_edit_tree::update_gradecategory($gradecategory, (object) $data); $transaction->allow_commit(); $createdcats[] = $gradecategory->id; } catch (\Exception $e) { // If the submitted data was broken for any reason. $warnings['database'] = $e->getMessage(); $transaction->rollback($e); return ['warnings' => $warnings]; } } return['categoryids' => $createdcats, 'warnings' => []]; } } classes/external/get_grade_tree.php 0000604 00000010672 15062070555 0013503 0 ustar 00 <?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/>. namespace core_grades\external; use core_external\external_api; use core_external\external_function_parameters; use core_external\external_value; defined('MOODLE_INTERNAL') || die; require_once($CFG->dirroot.'/grade/lib.php'); /** * Web service to return the grade tree structure for a given course. * * @package core_grades * @copyright 2023 Mihail Geshoski <mihail@moodle.com> * @category external * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class get_grade_tree extends external_api { /** * Returns description of method parameters. * * @return external_function_parameters */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters ( [ 'courseid' => new external_value(PARAM_INT, 'Course ID', VALUE_REQUIRED) ] ); } /** * Given a course ID, return the grade tree structure for that course. * * @param int $courseid The course ID. * @return string JSON encoded data representing the course grade tree structure. */ public static function execute(int $courseid): string { $params = self::validate_parameters( self::execute_parameters(), [ 'courseid' => $courseid ] ); $context = \context_course::instance($params['courseid']); parent::validate_context($context); // Make sure that the user has the capability to view the full grade tree in the course. require_capability('moodle/grade:viewall', $context); // Get the course grade category. $coursegradecategory = \grade_category::fetch_course_category($params['courseid']); $coursegradetree = self::generate_course_grade_tree($coursegradecategory); return json_encode($coursegradetree); } /** * Describes the return structure. * * @return external_value */ public static function execute_returns(): external_value { return new external_value(PARAM_RAW, 'JSON encoded data representing the course grade tree structure.'); } /** * Recursively generates the course grade tree structure. * * @param \grade_category $gradecategory The course grade category. * @return array The course grade tree structure. */ private static function generate_course_grade_tree(\grade_category $gradecategory): array { $gradecategorydata = [ 'id' => $gradecategory->id, 'name' => $gradecategory->get_name(), 'iscategory' => true, 'haschildcategories' => false ]; // Get the children of the grade category. if ($gradecategorychildren = $gradecategory->get_children()) { foreach ($gradecategorychildren as $child) { // If the child is a grade category, recursively generate the grade tree structure for that category. if ($child['object'] instanceof \grade_category) { $gradecategorydata['haschildcategories'] = true; $gradecategorydata['children'][] = self::generate_course_grade_tree($child['object']); } else { // Otherwise, add the grade item to the grade tree structure. $gradecategorydata['children'][] = [ 'id' => $child['object']->id, 'name' => $child['object']->get_name(), 'iscategory' => false, 'children' => null ]; } } } else { // If the grade category has no children, set the children property to null. $gradecategorydata['children'] = null; } return $gradecategorydata; } } classes/external/get_feedback.php 0000604 00000010236 15062070555 0013122 0 ustar 00 <?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/>. namespace core_grades\external; use core_external\external_api; use core_external\external_function_parameters; use core_external\external_single_structure; use core_external\external_value; use invalid_parameter_exception; defined('MOODLE_INTERNAL') || die; require_once($CFG->dirroot.'/grade/lib.php'); /** * Web service to fetch students feedback for a grade item. * * @package core_grades * @copyright 2023 Kevin Percy <kevin.percy@moodle.com> * @category external * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class get_feedback extends external_api { /** * Returns description of method parameters. * * @return external_function_parameters */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters ( [ 'courseid' => new external_value(PARAM_INT, 'Course ID', VALUE_REQUIRED), 'userid' => new external_value(PARAM_INT, 'User ID', VALUE_REQUIRED), 'itemid' => new external_value(PARAM_INT, 'Grade Item ID', VALUE_REQUIRED) ] ); } /** * Given a user ID and grade item ID, return feedback and user details. * * @param int $courseid The course ID. * @param int $userid * @param int $itemid * @return array Feedback and user details */ public static function execute(int $courseid, int $userid, int $itemid): array { global $OUTPUT, $CFG; $params = self::validate_parameters( self::execute_parameters(), [ 'courseid' => $courseid, 'userid' => $userid, 'itemid' => $itemid ] ); $context = \context_course::instance($courseid); parent::validate_context($context); require_capability('gradereport/grader:view', $context); $gtree = new \grade_tree($params['courseid'], false, false, null, !$CFG->enableoutcomes); $gradeitem = $gtree->get_item($params['itemid']); // If Item ID is not part of Course ID, $gradeitem will be set to false. if ($gradeitem === false) { throw new invalid_parameter_exception('Course ID and item ID mismatch'); } $grade = $gradeitem->get_grade($params['userid'], false); $user = \core_user::get_user($params['userid']); $extrafields = \core_user\fields::get_identity_fields($context); return [ 'feedbacktext' => $grade->feedback, 'title' => $gradeitem->get_name(true), 'fullname' => fullname($user), 'picture' => $OUTPUT->user_picture($user, ['size' => 50, 'link' => false]), 'additionalfield' => empty($extrafields) ? '' : $user->{$extrafields[0]}, ]; } /** * Describes the return structure. * * @return external_single_structure */ public static function execute_returns(): external_single_structure { return new external_single_structure([ 'feedbacktext' => new external_value(PARAM_RAW, 'The full feedback text'), 'title' => new external_value(PARAM_TEXT, 'Title of the grade item that the feedback is for'), 'fullname' => new external_value(PARAM_TEXT, 'Students name'), 'picture' => new external_value(PARAM_RAW, 'Students picture'), 'additionalfield' => new external_value(PARAM_RAW, 'Additional field for the user (email or ID number, for example)'), ]); } } classes/external/get_gradeitems.php 0000604 00000007220 15062070555 0013521 0 ustar 00 <?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/>. namespace core_grades\external; defined('MOODLE_INTERNAL') || die; use context_course; use core_external\external_api; use core_external\external_function_parameters; use core_external\external_multiple_structure; use core_external\external_single_structure; use core_external\external_value; use core_external\external_warnings; use core_external\restricted_context_exception; use grade_item; require_once($CFG->libdir . '/gradelib.php'); /** * External grade get gradeitems API implementation * * @package core_grades * @copyright 2023 Mathew May <mathew.solutions> * @category external * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class get_gradeitems extends external_api { /** * Returns description of method parameters. * * @return external_function_parameters */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters ( [ 'courseid' => new external_value(PARAM_INT, 'Course ID', VALUE_REQUIRED) ] ); } /** * Given a course ID find the grading objects and return their names & IDs. * * @param int $courseid * @return array * @throws restricted_context_exception * @throws \invalid_parameter_exception */ public static function execute(int $courseid): array { $params = self::validate_parameters( self::execute_parameters(), [ 'courseid' => $courseid ] ); $warnings = []; $context = context_course::instance($params['courseid']); parent::validate_context($context); $allgradeitems = grade_item::fetch_all(['courseid' => $params['courseid']]); $gradeitems = array_filter($allgradeitems, function($item) { $item->itemname = $item->get_name(); $item->category = $item->get_parent_category()->get_name(); return $item->gradetype != GRADE_TYPE_NONE && !$item->is_category_item() && !$item->is_course_item(); }); return [ 'gradeItems' => $gradeitems, 'warnings' => $warnings, ]; } /** * Returns description of what gradeitems fetch should return. * * @return external_single_structure */ public static function execute_returns(): external_single_structure { return new external_single_structure([ 'gradeItems' => new external_multiple_structure( new external_single_structure([ 'id' => new external_value(PARAM_ALPHANUM, 'An ID for the grade item', VALUE_REQUIRED), 'itemname' => new external_value(PARAM_CLEANHTML, 'The full name of the grade item', VALUE_REQUIRED), 'category' => new external_value(PARAM_TEXT, 'The grade category of the grade item', VALUE_OPTIONAL), ]) ), 'warnings' => new external_warnings(), ]); } } classes/external/get_enrolled_users_for_selector.php 0000604 00000011060 15062070555 0017165 0 ustar 00 <?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/>. namespace core_grades\external; use core_user_external; use core_external\external_api; use core_external\external_function_parameters; use core_external\external_multiple_structure; use core_external\external_single_structure; use core_external\external_value; use core_external\external_warnings; use core_external\restricted_context_exception; use user_picture; defined('MOODLE_INTERNAL') || die; require_once($CFG->dirroot.'/grade/lib.php'); require_once($CFG->dirroot .'/user/externallib.php'); /** * Get the enrolled users within and map some fields to the returned array of user objects. * * @package core_grades * @copyright 2022 Mihail Geshoski <mihail@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * @since Moodle 4.2 */ class get_enrolled_users_for_selector extends external_api { /** * Returns description of method parameters. * * @return external_function_parameters */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters ( [ 'courseid' => new external_value(PARAM_INT, 'Course Id', VALUE_REQUIRED), 'groupid' => new external_value(PARAM_INT, 'Group Id', VALUE_DEFAULT, 0) ] ); } /** * Given a course ID find the enrolled users within and map some fields to the returned array of user objects. * * @param int $courseid * @param int|null $groupid * @return array Users and warnings to pass back to the calling widget. * @throws coding_exception * @throws invalid_parameter_exception * @throws moodle_exception * @throws restricted_context_exception */ public static function execute(int $courseid, ?int $groupid = 0): array { global $DB, $PAGE; $params = self::validate_parameters( self::execute_parameters(), [ 'courseid' => $courseid, 'groupid' => $groupid ] ); $warnings = []; $coursecontext = \context_course::instance($params['courseid']); parent::validate_context($coursecontext); require_capability('moodle/course:viewparticipants', $coursecontext); $course = $DB->get_record('course', ['id' => $params['courseid']]); // Create a graded_users_iterator because it will properly check the groups etc. $defaultgradeshowactiveenrol = !empty($CFG->grade_report_showonlyactiveenrol); $showonlyactiveenrol = get_user_preferences('grade_report_showonlyactiveenrol', $defaultgradeshowactiveenrol); $showonlyactiveenrol = $showonlyactiveenrol || !has_capability('moodle/course:viewsuspendedusers', $coursecontext); $gui = new \graded_users_iterator($course, null, $params['groupid']); $gui->require_active_enrolment($showonlyactiveenrol); $gui->init(); $users = []; while ($userdata = $gui->next_user()) { $user = $userdata->user; $user->fullname = fullname($user); $userpicture = new user_picture($user); $userpicture->size = 1; $user->profileimageurl = $userpicture->get_url($PAGE)->out(false); $userpicture->size = 0; // Size f2. $user->profileimageurlsmall = $userpicture->get_url($PAGE)->out(false); $users[] = $user; } $gui->close(); return [ 'users' => $users, 'warnings' => $warnings, ]; } /** * Returns description of method result value. * * @return external_single_structure */ public static function execute_returns(): external_single_structure { return new external_single_structure([ 'users' => new external_multiple_structure(core_user_external::user_description()), 'warnings' => new external_warnings(), ]); } } classes/output/import_key_manager_action_bar.php 0000604 00000004476 15062070555 0016323 0 ustar 00 <?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/>. namespace core_grades\output; use moodle_url; /** * Renderable class for the action bar elements in the gradebook import key manager page. * * @package core_grades * @copyright 2021 Mihail Geshoski <mihail@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class import_key_manager_action_bar extends action_bar { /** * Returns the template for the action bar. * * @return string */ public function get_template(): string { return 'core_grades/import_key_manager_action_bar'; } /** * Export the data for the mustache template. * * @param \renderer_base $output renderer to be used to render the action bar elements. * @return array */ public function export_for_template(\renderer_base $output): array { if ($this->context->contextlevel !== CONTEXT_COURSE) { return []; } $courseid = $this->context->instanceid; // Get the data used to output the general navigation selector and imports navigation selector. $importnavselectors = new import_action_bar($this->context, null, 'keymanager'); $data = $importnavselectors->export_for_template($output); // Add a button to the action bar with a link to the 'add user key' page. $adduserkeylink = new moodle_url('/grade/import/key.php', ['courseid' => $courseid]); $adduserkeybutton = new \single_button($adduserkeylink, get_string('adduserkey', 'userkey'), 'get', \single_button::BUTTON_PRIMARY); $data['adduserkeybutton'] = $adduserkeybutton->export_for_template($output); return $data; } } classes/output/manage_outcomes_action_bar.php 0000604 00000007716 15062070555 0015615 0 ustar 00 <?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/>. namespace core_grades\output; use moodle_url; /** * Renderable class for the action bar elements in the manage outcomes page. * * @package core_grades * @copyright 2021 Mihail Geshoski <mihail@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class manage_outcomes_action_bar extends action_bar { /** @var bool $hasoutcomes Whether there are existing outcomes. */ protected $hasoutcomes; /** * The class constructor. * * @param \context $context The context object. * @param bool $hasoutcomes Whether there are existing outcomes. */ public function __construct(\context $context, bool $hasoutcomes) { parent::__construct($context); $this->hasoutcomes = $hasoutcomes; } /** * Returns the template for the action bar. * * @return string */ public function get_template(): string { return 'core_grades/manage_outcomes_action_bar'; } /** * Export the data for the mustache template. * * @param \renderer_base $output renderer to be used to render the action bar elements. * @return array */ public function export_for_template(\renderer_base $output): array { $data = []; $courseid = 0; // Display the following buttons only if the user is in course gradebook. if ($this->context->contextlevel === CONTEXT_COURSE) { $courseid = $this->context->instanceid; // Add a button to the action bar with a link to the 'course outcomes' page. $backlink = new moodle_url('/grade/edit/outcome/course.php', ['id' => $courseid]); $backbutton = new \single_button($backlink, get_string('back'), 'get'); $data['backbutton'] = $backbutton->export_for_template($output); // Add a button to the action bar with a link to the 'import outcomes' page. The import outcomes // functionality is currently only available in the course context. $importoutcomeslink = new moodle_url('/grade/edit/outcome/import.php', ['courseid' => $courseid]); $importoutcomesbutton = new \single_button($importoutcomeslink, get_string('importoutcomes', 'grades'), 'get'); $data['importoutcomesbutton'] = $importoutcomesbutton->export_for_template($output); } // Add a button to the action bar with a link to the 'add new outcome' page. $addoutcomelink = new moodle_url('/grade/edit/outcome/edit.php', ['courseid' => $courseid]); $addoutcomebutton = new \single_button($addoutcomelink, get_string('outcomecreate', 'grades'), 'get', \single_button::BUTTON_PRIMARY); $data['addoutcomebutton'] = $addoutcomebutton->export_for_template($output); if ($this->hasoutcomes) { // Add a button to the action bar which enables export of all existing outcomes. $exportoutcomeslink = new moodle_url('/grade/edit/outcome/export.php', ['id' => $courseid, 'sesskey' => sesskey()]); $exportoutcomesbutton = new \single_button($exportoutcomeslink, get_string('exportalloutcomes', 'grades'), 'get'); $data['exportoutcomesbutton'] = $exportoutcomesbutton->export_for_template($output); } return $data; } } classes/output/action_bar.php 0000604 00000002702 15062070555 0012355 0 ustar 00 <?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/>. namespace core_grades\output; use templatable; use renderable; /** * The base class for the action bar in the gradebook pages. * * @package core_grades * @copyright 2021 Mihail Geshoski <mihail@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ abstract class action_bar implements templatable, renderable { /** @var \context $context The context object. */ protected $context; /** * The class constructor. * * @param \context $context The context object. */ public function __construct(\context $context) { $this->context = $context; } /** * Returns the template for the actions bar. * * @return string */ abstract public function get_template(): string; } classes/output/export_publish_action_bar.php 0000604 00000004667 15062070555 0015520 0 ustar 00 <?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/>. namespace core_grades\output; use moodle_url; /** * Renderable class for the action bar elements in the gradebook publish export page. * * @package core_grades * @copyright 2021 Mihail Geshoski <mihail@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class export_publish_action_bar extends action_bar { /** @var string $activeplugin The plugin of the current export grades page (xml, ods, ...). */ protected $activeplugin; /** * The class constructor. * * @param \context $context The context object. * @param string $activeplugin The plugin of the current export grades page (xml, ods, ...). */ public function __construct(\context $context, string $activeplugin) { parent::__construct($context); $this->activeplugin = $activeplugin; } /** * Returns the template for the action bar. * * @return string */ public function get_template(): string { return 'core_grades/export_publish_action_bar'; } /** * Export the data for the mustache template. * * @param \renderer_base $output renderer to be used to render the action bar elements. * @return array */ public function export_for_template(\renderer_base $output): array { if ($this->context->contextlevel !== CONTEXT_COURSE) { return []; } $courseid = $this->context->instanceid; // Add a back button to the action bar. $backlink = new moodle_url("/grade/export/{$this->activeplugin}/index.php", ['id' => $courseid]); $backbutton = new \single_button($backlink, get_string('back'), 'get'); return [ 'backbutton' => $backbutton->export_for_template($output) ]; } } classes/output/general_action_bar.php 0000604 00000017260 15062070555 0014057 0 ustar 00 <?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/>. namespace core_grades\output; use moodle_url; use core\output\select_menu; /** * Renderable class for the general action bar in the gradebook pages. * * This class is responsible for rendering the general navigation select menu in the gradebook pages. * * @package core_grades * @copyright 2021 Mihail Geshoski <mihail@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class general_action_bar extends action_bar { /** @var moodle_url $activeurl The URL that should be set as active in the URL selector element. */ protected $activeurl; /** * The type of the current gradebook page (report, settings, import, export, scales, outcomes, letters). * * @var string $activetype */ protected $activetype; /** @var string $activeplugin The plugin of the current gradebook page (grader, fullview, ...). */ protected $activeplugin; /** * The class constructor. * * @param \context $context The context object. * @param moodle_url $activeurl The URL that should be set as active in the URL selector element. * @param string $activetype The type of the current gradebook page (report, settings, import, export, scales, * outcomes, letters). * @param string $activeplugin The plugin of the current gradebook page (grader, fullview, ...). */ public function __construct(\context $context, moodle_url $activeurl, string $activetype, string $activeplugin) { parent::__construct($context); $this->activeurl = $activeurl; $this->activetype = $activetype; $this->activeplugin = $activeplugin; } /** * Export the data for the mustache template. * * @param \renderer_base $output renderer to be used to render the action bar elements. * @return array */ public function export_for_template(\renderer_base $output): array { $selectmenu = $this->get_action_selector(); if (is_null($selectmenu)) { return []; } return [ 'generalnavselector' => $selectmenu->export_for_template($output), ]; } /** * Returns the template for the action bar. * * @return string */ public function get_template(): string { return 'core_grades/general_action_bar'; } /** * Returns the URL selector object. * * @return \select_menu|null The URL select object. */ private function get_action_selector(): ?select_menu { if ($this->context->contextlevel !== CONTEXT_COURSE) { return null; } $courseid = $this->context->instanceid; $plugininfo = grade_get_plugin_info($courseid, $this->activetype, $this->activeplugin); $menu = []; $viewgroup = []; $setupgroup = []; $moregroup = []; foreach ($plugininfo as $plugintype => $plugins) { // Skip if the plugintype value is 'strings'. This particular item only returns an array of strings // which we do not need. if ($plugintype == 'strings') { continue; } // If $plugins is actually the definition of a child-less parent link. if (!empty($plugins->id)) { $string = $plugins->string; if (!empty($plugininfo[$this->activetype]->parent)) { $string = $plugininfo[$this->activetype]->parent->string; } $menu[$plugins->link->out(false)] = $string; continue; } foreach ($plugins as $key => $plugin) { // Depending on the plugin type, include the plugin to the appropriate item group for the URL selector // element. switch ($plugintype) { case 'report': $viewgroup[$plugin->link->out(false)] = $plugin->string; break; case 'settings': $setupgroup[$plugin->link->out(false)] = $plugin->string; break; case 'scale': // We only need the link to the 'view scales' page, otherwise skip and continue to the next // plugin. if ($key !== 'view') { continue 2; } $moregroup[$plugin->link->out(false)] = get_string('scales'); break; case 'outcome': // We only need the link to the 'outcomes used in course' page, otherwise skip and continue to // the next plugin. if ($key !== 'course') { continue 2; } $moregroup[$plugin->link->out(false)] = get_string('outcomes', 'grades'); break; case 'letter': // We only need the link to the 'view grade letters' page, otherwise skip and continue to the // next plugin. if ($key !== 'view') { continue 2; } $moregroup[$plugin->link->out(false)] = get_string('gradeletters', 'grades'); break; case 'import': $link = new moodle_url('/grade/import/index.php', ['id' => $courseid]); // If the link to the grade import options is already added to the group, skip and continue to // the next plugin. if (array_key_exists($link->out(false), $moregroup)) { continue 2; } $moregroup[$link->out(false)] = get_string('import', 'grades'); break; case 'export': $link = new moodle_url('/grade/export/index.php', ['id' => $courseid]); // If the link to the grade export options is already added to the group, skip and continue to // the next plugin. if (array_key_exists($link->out(false), $moregroup)) { continue 2; } $moregroup[$link->out(false)] = get_string('export', 'grades'); break; } } } if (!empty($viewgroup)) { $menu[][get_string('view')] = $viewgroup; } if (!empty($setupgroup)) { $menu[][get_string('setup', 'grades')] = $setupgroup; } if (!empty($moregroup)) { $menu[][get_string('moremenu')] = $moregroup; } $selectmenu = new select_menu('gradesactionselect', $menu, $this->activeurl->out(false)); $selectmenu->set_label(get_string('gradebooknavigationmenu', 'grades'), ['class' => 'sr-only']); return $selectmenu; } } classes/output/export_key_manager_action_bar.php 0000604 00000004477 15062070555 0016333 0 ustar 00 <?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/>. namespace core_grades\output; use moodle_url; /** * Renderable class for the action bar elements in the gradebook exports key manager page. * * @package core_grades * @copyright 2021 Mihail Geshoski <mihail@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class export_key_manager_action_bar extends action_bar { /** * Returns the template for the action bar. * * @return string */ public function get_template(): string { return 'core_grades/export_key_manager_action_bar'; } /** * Export the data for the mustache template. * * @param \renderer_base $output renderer to be used to render the action bar elements. * @return array */ public function export_for_template(\renderer_base $output): array { if ($this->context->contextlevel !== CONTEXT_COURSE) { return []; } $courseid = $this->context->instanceid; // Get the data used to output the general navigation selector and exports navigation selector. $exportnavselectors = new export_action_bar($this->context, null, 'keymanager'); $data = $exportnavselectors->export_for_template($output); // Add a button to the action bar with a link to the 'add user key' page. $adduserkeylink = new moodle_url('/grade/export/key.php', ['courseid' => $courseid]); $adduserkeybutton = new \single_button($adduserkeylink, get_string('adduserkey', 'userkey'), 'get', \single_button::BUTTON_PRIMARY); $data['adduserkeybutton'] = $adduserkeybutton->export_for_template($output); return $data; } } classes/output/export_action_bar.php 0000604 00000007764 15062070555 0013773 0 ustar 00 <?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/>. namespace core_grades\output; use moodle_url; /** * Renderable class for the action bar elements in the gradebook export pages. * * @package core_grades * @copyright 2021 Mihail Geshoski <mihail@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class export_action_bar extends action_bar { /** @var string $activeplugin The plugin of the current export grades page (xml, ods, ...). */ protected $activeplugin; /** * The class constructor. * * @param \context $context The context object. * @param null $unused This parameter has been deprecated since 4.1 and should not be used anymore. * @param string $activeplugin The plugin of the current export grades page (xml, ods, ...). */ public function __construct(\context $context, $unused, string $activeplugin) { if ($unused !== null) { debugging('Deprecated argument passed to ' . __FUNCTION__, DEBUG_DEVELOPER); } parent::__construct($context); $this->activeplugin = $activeplugin; } /** * Returns the template for the action bar. * * @return string */ public function get_template(): string { return 'core_grades/export_action_bar'; } /** * Export the data for the mustache template. * * @param \renderer_base $output renderer to be used to render the action bar elements. * @return array */ public function export_for_template(\renderer_base $output): array { if ($this->context->contextlevel !== CONTEXT_COURSE) { return []; } $courseid = $this->context->instanceid; // Get the data used to output the general navigation selector. $generalnavselector = new general_action_bar($this->context, new moodle_url('/grade/export/index.php', ['id' => $courseid]), 'export', $this->activeplugin); $data = $generalnavselector->export_for_template($output); // Get all grades export plugins. If there isn't any available export plugins there is no need to create and // display the exports navigation selector menu. Therefore, return only the current data. if (!$exports = \grade_helper::get_plugins_export($courseid)) { return $data; } // If exports key management is enabled, always display this item at the end of the list. if (array_key_exists('keymanager', $exports)) { $keymanager = $exports['keymanager']; unset($exports['keymanager']); $exports['keymanager'] = $keymanager; } $exportsmenu = []; $exportactiveurl = null; // Generate the data for the exports navigation selector menu. foreach ($exports as $export) { $exportsmenu[$export->link->out()] = $export->string; if ($export->id == $this->activeplugin) { $exportactiveurl = $export->link->out(); } } // This navigation selector menu will contain the links to all available grade export plugin pages. $exportsurlselect = new \core\output\select_menu('exportas', $exportsmenu, $exportactiveurl); $exportsurlselect->set_label(get_string('exportas', 'grades')); $data['exportselector'] = $exportsurlselect->export_for_template($output); return $data; } } classes/output/scales_action_bar.php 0000604 00000004735 15062070555 0013717 0 ustar 00 <?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/>. namespace core_grades\output; use moodle_url; /** * Renderable class for the action bar elements in the gradebook scales page. * * @package core_grades * @copyright 2021 Mihail Geshoski <mihail@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class scales_action_bar extends action_bar { /** * Returns the template for the action bar. * * @return string */ public function get_template(): string { return 'core_grades/scales_action_bar'; } /** * Export the data for the mustache template. * * @param \renderer_base $output renderer to be used to render the action bar elements. * @return array */ public function export_for_template(\renderer_base $output): array { $data = []; $courseid = 0; // If in the course context, we should display the general navigation selector in gradebook. if ($this->context->contextlevel === CONTEXT_COURSE) { $courseid = $this->context->instanceid; // Get the data used to output the general navigation selector. $generalnavselector = new general_action_bar($this->context, new moodle_url('/grade/edit/scale/index.php', ['id' => $courseid]), 'scale', 'scale'); $data = $generalnavselector->export_for_template($output); } // Add a button to the action bar with a link to the 'add new scale' page. $addnewscalelink = new moodle_url('/grade/edit/scale/edit.php', ['courseid' => $courseid]); $addnewscalebutton = new \single_button($addnewscalelink, get_string('scalescustomcreate'), 'get', \single_button::BUTTON_PRIMARY); $data['addnewscalebutton'] = $addnewscalebutton->export_for_template($output); return $data; } } classes/output/course_outcomes_action_bar.php 0000604 00000004761 15062070555 0015662 0 ustar 00 <?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/>. namespace core_grades\output; use moodle_url; /** * Renderable class for the action bar elements in the gradebook course outcomes page. * * @package core_grades * @copyright 2021 Mihail Geshoski <mihail@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class course_outcomes_action_bar extends action_bar { /** * Returns the template for the action bar. * * @return string */ public function get_template(): string { return 'core_grades/course_outcomes_action_bar'; } /** * Export the data for the mustache template. * * @param \renderer_base $output renderer to be used to render the action bar elements. * @return array */ public function export_for_template(\renderer_base $output): array { if ($this->context->contextlevel !== CONTEXT_COURSE) { return []; } $courseid = $this->context->instanceid; // Get the data used to output the general navigation selector. $generalnavselector = new general_action_bar($this->context, new moodle_url('/grade/edit/outcome/course.php', ['id' => $courseid]), 'outcome', 'course'); $data = $generalnavselector->export_for_template($output); if (has_capability('moodle/grade:manageoutcomes', $this->context)) { // Add a button to the action bar with a link to the 'manage outcomes' page. $manageoutcomeslink = new moodle_url('/grade/edit/outcome/index.php', ['id' => $courseid]); $manageoutcomesbutton = new \single_button($manageoutcomeslink, get_string('manageoutcomes', 'grades'), 'get', \single_button::BUTTON_PRIMARY); $data['manageoutcomesbutton'] = $manageoutcomesbutton->export_for_template($output); } return $data; } } classes/output/grade_letters_action_bar.php 0000604 00000004615 15062070555 0015266 0 ustar 00 <?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/>. namespace core_grades\output; use moodle_url; /** * Renderable class for the action bar elements in the grade letters page. * * @package core_grades * @copyright 2021 Mihail Geshoski <mihail@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class grade_letters_action_bar extends action_bar { /** * Returns the template for the action bar. * * @return string */ public function get_template(): string { return 'core_grades/grade_letters_action_bar'; } /** * Export the data for the mustache template. * * @param \renderer_base $output renderer to be used to render the action bar elements. * @return array */ public function export_for_template(\renderer_base $output): array { $data = []; // If in the course context, we should display the general navigation selector in gradebook. if ($this->context->contextlevel === CONTEXT_COURSE) { // Get the data used to output the general navigation selector. $generalnavselector = new general_action_bar($this->context, new moodle_url('/grade/edit/letter/index.php', ['id' => $this->context->id]), 'letter', 'view'); $data = $generalnavselector->export_for_template($output); } // Add a button to the action bar with a link to the 'edit grade letters' page. $editbuttonlink = new moodle_url('/grade/edit/letter/index.php', ['id' => $this->context->id, 'edit' => 1]); $editbutton = new \single_button($editbuttonlink, get_string('edit'), 'get', \single_button::BUTTON_PRIMARY); $data['editbutton'] = $editbutton->export_for_template($output); return $data; } } classes/output/import_action_bar.php 0000604 00000007764 15062070555 0013764 0 ustar 00 <?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/>. namespace core_grades\output; use moodle_url; /** * Renderable class for the action bar elements in the gradebook import pages. * * @package core_grades * @copyright 2021 Mihail Geshoski <mihail@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class import_action_bar extends action_bar { /** @var string $activeplugin The plugin of the current import grades page (xml, csv, ...). */ protected $activeplugin; /** * The class constructor. * * @param \context $context The context object. * @param null $unused This parameter has been deprecated since 4.1 and should not be used anymore. * @param string $activeplugin The plugin of the current import grades page (xml, csv, ...). */ public function __construct(\context $context, $unused, string $activeplugin) { if ($unused !== null) { debugging('Deprecated argument passed to ' . __FUNCTION__, DEBUG_DEVELOPER); } parent::__construct($context); $this->activeplugin = $activeplugin; } /** * Returns the template for the action bar. * * @return string */ public function get_template(): string { return 'core_grades/import_action_bar'; } /** * Export the data for the mustache template. * * @param \renderer_base $output renderer to be used to render the action bar elements. * @return array */ public function export_for_template(\renderer_base $output): array { if ($this->context->contextlevel !== CONTEXT_COURSE) { return []; } $courseid = $this->context->instanceid; // Get the data used to output the general navigation selector. $generalnavselector = new general_action_bar($this->context, new moodle_url('/grade/import/index.php', ['id' => $courseid]), 'import', $this->activeplugin); $data = $generalnavselector->export_for_template($output); // Get all grades import plugins. If there isn't any available import plugins there is no need to create and // display the imports navigation selector menu. Therefore, return only the current data. if (!$imports = \grade_helper::get_plugins_import($courseid)) { return $data; } // If imports key management is enabled, always display this item at the end of the list. if (array_key_exists('keymanager', $imports)) { $keymanager = $imports['keymanager']; unset($imports['keymanager']); $imports['keymanager'] = $keymanager; } $importsmenu = []; $importactiveurl = null; // Generate the data for the imports navigation selector menu. foreach ($imports as $import) { $importsmenu[$import->link->out()] = $import->string; if ($import->id == $this->activeplugin) { $importactiveurl = $import->link->out(); } } // This navigation selector menu will contain the links to all available grade export plugin pages. $importsurlselect = new \core\output\select_menu('importas', $importsmenu, $importactiveurl); $importsurlselect->set_label(get_string('importas', 'grades')); $data['importselector'] = $importsurlselect->export_for_template($output); return $data; } } classes/output/gradebook_setup_action_bar.php 0000604 00000007553 15062070555 0015623 0 ustar 00 <?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/>. namespace core_grades\output; use moodle_url; use html_writer; /** * Renderable class for the action bar elements in the gradebook setup pages. * * @package core_grades * @copyright 2021 Mihail Geshoski <mihail@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class gradebook_setup_action_bar extends action_bar { /** * Returns the template for the action bar. * * @return string */ public function get_template(): string { return 'core_grades/gradebook_setup_action_bar'; } /** * Export the data for the mustache template. * * @param \renderer_base $output renderer to be used to render the action bar elements. * @return array */ public function export_for_template(\renderer_base $output): array { global $CFG; if ($this->context->contextlevel !== CONTEXT_COURSE) { return []; } $courseid = $this->context->instanceid; // Get the data used to output the general navigation selector. $generalnavselector = new general_action_bar($this->context, new moodle_url('/grade/edit/tree/index.php', ['id' => $courseid]), 'settings', 'setup'); $data = $generalnavselector->export_for_template($output); $actions = []; $additemurl = new moodle_url('#'); // Add a button to the action bar dropdown with a link to the 'add grade item' modal. $actions[] = new \action_menu_link_secondary( $additemurl, null, get_string('additem', 'grades'), [ 'data-courseid' => $courseid, 'data-itemid' => -1, 'data-trigger' => 'add-item-form', 'data-gprplugin' => 'tree', ] ); // If outcomes are enabled, add a button to the action bar dropdown with a link to the 'add outcome item' modal. if (!empty($CFG->enableoutcomes) && count(\grade_outcome::fetch_all_available($courseid)) > 0) { // Add a button to the action bar dropdown with a link to the 'add outcome item' modal. $actions[] = new \action_menu_link_secondary( $additemurl, null, get_string('addoutcomeitem', 'grades'), [ 'data-courseid' => $courseid, 'data-itemid' => -1, 'data-trigger' => 'add-outcome-form', 'data-gprplugin' => 'tree', ] ); } // Add a button to the action bar dropdown with a link to the 'add category' modal. $actions[] = new \action_menu_link_secondary( $additemurl, null, get_string('addcategory', 'grades'), [ 'data-courseid' => $courseid, 'data-category' => -1, 'data-trigger' => 'add-category-form', 'data-gprplugin' => 'tree', ] ); $addmenu = new \action_menu($actions); $addmenu->set_menu_trigger(get_string('add'), 'btn font-weight-bold'); $data['addmenu'] = $addmenu->export_for_template($output); return $data; } } classes/form/add_item.php 0000604 00000057554 15062070555 0011444 0 ustar 00 <?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/>. namespace core_grades\form; defined('MOODLE_INTERNAL') || die; use context; use context_course; use core_form\dynamic_form; use grade_category; use grade_item; use grade_plugin_return; use grade_scale; use moodle_url; require_once($CFG->dirroot.'/grade/lib.php'); /** * Prints the add item gradebook form * * @copyright 2023 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU Public License * @package core_grades */ class add_item extends dynamic_form { /** Grade plugin return tracking object. * @var object $gpr */ public $gpr; /** * Helper function to grab the current grade item based on information within the form. * * @return array * @throws \moodle_exception */ private function get_gradeitem(): array { $courseid = $this->optional_param('courseid', null, PARAM_INT); $id = $this->optional_param('itemid', null, PARAM_INT); if ($gradeitem = grade_item::fetch(['id' => $id, 'courseid' => $courseid])) { $item = $gradeitem->get_record_data(); $parentcategory = $gradeitem->get_parent_category(); } else { $gradeitem = new grade_item(['courseid' => $courseid, 'itemtype' => 'manual'], false); $item = $gradeitem->get_record_data(); $parentcategory = grade_category::fetch_course_category($courseid); } $item->parentcategory = $parentcategory->id; $decimalpoints = $gradeitem->get_decimals(); if ($item->hidden > 1) { $item->hiddenuntil = $item->hidden; $item->hidden = 0; } else { $item->hiddenuntil = 0; } $item->locked = !empty($item->locked); $item->grademax = format_float($item->grademax, $decimalpoints); $item->grademin = format_float($item->grademin, $decimalpoints); if ($parentcategory->aggregation == GRADE_AGGREGATE_SUM || $parentcategory->aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN2) { $item->aggregationcoef = $item->aggregationcoef == 0 ? 0 : 1; } else { $item->aggregationcoef = format_float($item->aggregationcoef, 4); } if ($parentcategory->aggregation == GRADE_AGGREGATE_SUM) { $item->aggregationcoef2 = format_float($item->aggregationcoef2 * 100.0); } $item->cancontrolvisibility = $gradeitem->can_control_visibility(); return [ 'gradeitem' => $gradeitem, 'item' => $item ]; } /** * Form definition * * @return void * @throws \coding_exception * @throws \dml_exception * @throws \moodle_exception */ protected function definition() { global $CFG; $courseid = $this->optional_param('courseid', null, PARAM_INT); $id = $this->optional_param('itemid', 0, PARAM_INT); $gprplugin = $this->optional_param('gpr_plugin', '', PARAM_TEXT); if ($gprplugin && ($gprplugin !== 'tree')) { $this->gpr = new grade_plugin_return(['type' => 'report', 'plugin' => $gprplugin, 'courseid' => $courseid]); } else { $this->gpr = new grade_plugin_return(['type' => 'edit', 'plugin' => 'tree', 'courseid' => $courseid]); } $mform =& $this->_form; $local = $this->get_gradeitem(); $gradeitem = $local['gradeitem']; $item = $local['item']; // Hidden elements. $mform->addElement('hidden', 'id', 0); $mform->setType('id', PARAM_INT); $mform->addElement('hidden', 'courseid', $courseid); $mform->setType('courseid', PARAM_INT); $mform->addElement('hidden', 'itemid', $id); $mform->setType('itemid', PARAM_INT); $mform->addElement('hidden', 'itemtype', 'manual'); // All new items are manual only. $mform->setType('itemtype', PARAM_ALPHA); // Visible elements. $mform->addElement('text', 'itemname', get_string('itemname', 'grades')); $mform->setType('itemname', PARAM_TEXT); if (!empty($item->id)) { // If grades exist set a message so the user knows why they can not alter the grade type or scale. // We could never change the grade type for external items, so only need to show this for manual grade items. if ($gradeitem->has_grades() && !$gradeitem->is_external_item()) { // Set a message so the user knows why they can not alter the grade type or scale. if ($gradeitem->gradetype == GRADE_TYPE_SCALE) { $gradesexistmsg = get_string('modgradecantchangegradetyporscalemsg', 'grades'); } else { $gradesexistmsg = get_string('modgradecantchangegradetypemsg', 'grades'); } $gradesexisthtml = '<div class=\'alert\'>' . $gradesexistmsg . '</div>'; $mform->addElement('static', 'gradesexistmsg', '', $gradesexisthtml); } } // Manual grade items cannot have grade type GRADE_TYPE_NONE. $mform->addElement('select', 'gradetype', get_string('gradetype', 'grades'), [ GRADE_TYPE_VALUE => get_string('typevalue', 'grades'), GRADE_TYPE_SCALE => get_string('typescale', 'grades'), GRADE_TYPE_TEXT => get_string('typetext', 'grades') ]); $mform->addHelpButton('gradetype', 'gradetype', 'grades'); $mform->setDefault('gradetype', GRADE_TYPE_VALUE); $options = [0 => get_string('usenoscale', 'grades')]; if ($scales = grade_scale::fetch_all_local($courseid)) { foreach ($scales as $scale) { $options[$scale->id] = $scale->get_name(); } } if ($scales = grade_scale::fetch_all_global()) { foreach ($scales as $scale) { $options[$scale->id] = $scale->get_name(); } } $mform->addElement('select', 'scaleid', get_string('scale'), $options); $mform->addHelpButton('scaleid', 'typescale', 'grades'); $mform->hideIf('scaleid', 'gradetype', 'noteq', GRADE_TYPE_SCALE); $mform->addElement('select', 'rescalegrades', get_string('modgraderescalegrades', 'grades'), [ '' => get_string('choose'), 'no' => get_string('no'), 'yes' => get_string('yes') ]); $mform->addHelpButton('rescalegrades', 'modgraderescalegrades', 'grades'); $mform->hideIf('rescalegrades', 'gradetype', 'noteq', GRADE_TYPE_VALUE); $mform->addElement('float', 'grademax', get_string('grademax', 'grades')); $mform->addHelpButton('grademax', 'grademax', 'grades'); $mform->hideIf('grademax', 'gradetype', 'noteq', GRADE_TYPE_VALUE); if (get_config('moodle', 'grade_report_showmin')) { $mform->addElement('float', 'grademin', get_string('grademin', 'grades')); $mform->addHelpButton('grademin', 'grademin', 'grades'); $mform->hideIf('grademin', 'gradetype', 'noteq', GRADE_TYPE_VALUE); } // Hiding. if ($item->cancontrolvisibility) { $mform->addElement('advcheckbox', 'hidden', get_string('hidden', 'grades'), '', [], [0, 1]); $mform->hideIf('hidden', 'hiddenuntil[enabled]', 'checked'); } else { $mform->addElement('static', 'hidden', get_string('hidden', 'grades'), get_string('componentcontrolsvisibility', 'grades')); // Unset hidden to avoid data override. unset($item->hidden); } $mform->addHelpButton('hidden', 'hidden', 'grades'); // Locking. $mform->addElement('advcheckbox', 'locked', get_string('locked', 'grades')); $mform->addHelpButton('locked', 'locked', 'grades'); // Weight overrides. $mform->addElement('advcheckbox', 'weightoverride', get_string('adjustedweight', 'grades')); $mform->addHelpButton('weightoverride', 'weightoverride', 'grades'); $mform->hideIf('weightoverride', 'gradetype', 'eq', GRADE_TYPE_NONE); $mform->hideIf('weightoverride', 'gradetype', 'eq', GRADE_TYPE_TEXT); // Parent category related settings. $mform->addElement('float', 'aggregationcoef2', get_string('weight', 'grades')); $mform->addHelpButton('aggregationcoef2', 'weight', 'grades'); $mform->hideIf('aggregationcoef2', 'weightoverride'); $mform->hideIf('aggregationcoef2', 'gradetype', 'eq', GRADE_TYPE_NONE); $mform->hideIf('aggregationcoef2', 'gradetype', 'eq', GRADE_TYPE_TEXT); $options = []; $categories = grade_category::fetch_all(['courseid' => $courseid]); foreach ($categories as $cat) { $cat->apply_forced_settings(); $options[$cat->id] = $cat->get_name(); } if (count($categories) > 1) { $mform->addElement('select', 'parentcategory', get_string('gradecategory', 'grades'), $options); } $parentcategory = $gradeitem->get_parent_category(); if (!$parentcategory) { // If we do not have an id, we are creating a new grade item. // Assign the course category to this grade item. $parentcategory = grade_category::fetch_course_category($courseid); $gradeitem->parent_category = $parentcategory; } if ($gradeitem->is_external_item()) { // Following items are set up from modules and should not be overrided by user. if ($mform->elementExists('grademin')) { // The site setting grade_report_showmin may have prevented grademin being added to the form. $mform->hardFreeze('grademin'); } $mform->hardFreeze('itemname,gradetype,grademax,scaleid'); // For external items we can not change the grade type, even if no grades exist, so if it is set to // scale, then remove the grademax and grademin fields from the form - no point displaying them. if ($gradeitem->gradetype == GRADE_TYPE_SCALE) { $mform->removeElement('grademax'); if ($mform->elementExists('grademin')) { $mform->removeElement('grademin'); } } else { // Not using scale, so remove it. $mform->removeElement('scaleid'); } // Always remove the rescale grades element if it's an external item. $mform->removeElement('rescalegrades'); } else if ($gradeitem->has_grades()) { // Can't change the grade type or the scale if there are grades. $mform->hardFreeze('gradetype, scaleid'); // If we are using scales then remove the unnecessary rescale and grade fields. if ($gradeitem->gradetype == GRADE_TYPE_SCALE) { $mform->removeElement('rescalegrades'); $mform->removeElement('grademax'); if ($mform->elementExists('grademin')) { $mform->removeElement('grademin'); } } else { // Remove the scale field. $mform->removeElement('scaleid'); // Set the maximum grade to disabled unless a grade is chosen. $mform->hideIf('grademax', 'rescalegrades', 'eq', ''); } } else { // Remove rescale element if there are no grades. $mform->removeElement('rescalegrades'); } // If we wanted to change parent of existing item - we would have to verify there are no circular references in parents!!! if ($id > -1 && $mform->elementExists('parentcategory')) { $mform->hardFreeze('parentcategory'); } $parentcategory->apply_forced_settings(); if (!$parentcategory->is_aggregationcoef_used()) { if ($mform->elementExists('aggregationcoef')) { $mform->removeElement('aggregationcoef'); } } else { $coefstring = $gradeitem->get_coefstring(); if ($coefstring !== '') { if ($coefstring == 'aggregationcoefextrasum' || $coefstring == 'aggregationcoefextraweightsum') { // The advcheckbox is not compatible with disabledIf! $coefstring = 'aggregationcoefextrasum'; $element =& $mform->createElement('checkbox', 'aggregationcoef', get_string($coefstring, 'grades')); } else { $element =& $mform->createElement('text', 'aggregationcoef', get_string($coefstring, 'grades')); $mform->setType('aggregationcoef', PARAM_FLOAT); } if ($mform->elementExists('parentcategory')) { $mform->insertElementBefore($element, 'parentcategory'); } else { $mform->insertElementBefore($element, 'aggregationcoef2'); } $mform->addHelpButton('aggregationcoef', $coefstring, 'grades'); } $mform->hideIf('aggregationcoef', 'gradetype', 'eq', GRADE_TYPE_NONE); $mform->hideIf('aggregationcoef', 'gradetype', 'eq', GRADE_TYPE_TEXT); $mform->hideIf('aggregationcoef', 'parentcategory', 'eq', $parentcategory->id); } // Remove fields used by natural weighting if the parent category is not using natural weighting. // Or if the item is a scale and scales are not used in aggregation. if ($parentcategory->aggregation != GRADE_AGGREGATE_SUM || (empty($CFG->grade_includescalesinaggregation) && $gradeitem->gradetype == GRADE_TYPE_SCALE)) { if ($mform->elementExists('weightoverride')) { $mform->removeElement('weightoverride'); } if ($mform->elementExists('aggregationcoef2')) { $mform->removeElement('aggregationcoef2'); } } if ($category = $gradeitem->get_item_category()) { if ($category->aggregation == GRADE_AGGREGATE_SUM) { if ($mform->elementExists('gradetype')) { $mform->hardFreeze('gradetype'); } if ($mform->elementExists('grademin')) { $mform->hardFreeze('grademin'); } if ($mform->elementExists('grademax')) { $mform->hardFreeze('grademax'); } if ($mform->elementExists('scaleid')) { $mform->removeElement('scaleid'); } } } $url = new moodle_url('/grade/edit/tree/item.php', ['id' => $id, 'courseid' => $courseid]); $url = $this->gpr->add_url_params($url); $url = '<a class="showadvancedform" href="' . $url . '">' . get_string('showmore', 'form') .'</a>'; $mform->addElement('static', 'advancedform', $url); // Add return tracking info. $this->gpr->add_mform_elements($mform); $this->set_data($item); } /** * Return form context * * @return context */ protected function get_context_for_dynamic_submission(): context { $courseid = $this->optional_param('courseid', null, PARAM_INT); return context_course::instance($courseid); } /** * Check if current user has access to this form, otherwise throw exception * * @return void * @throws \required_capability_exception */ protected function check_access_for_dynamic_submission(): void { $courseid = $this->optional_param('courseid', null, PARAM_INT); require_capability('moodle/grade:manage', context_course::instance($courseid)); } /** * Load in existing data as form defaults * * @return void */ public function set_data_for_dynamic_submission(): void { $this->set_data((object)[ 'courseid' => $this->optional_param('courseid', null, PARAM_INT), 'itemid' => $this->optional_param('itemid', null, PARAM_INT) ]); } /** * Returns url to set in $PAGE->set_url() when form is being rendered or submitted via AJAX * * @return moodle_url * @throws \moodle_exception */ protected function get_page_url_for_dynamic_submission(): moodle_url { $params = [ 'id' => $this->optional_param('courseid', null, PARAM_INT), 'itemid' => $this->optional_param('itemid', null, PARAM_INT), ]; return new moodle_url('/grade/edit/tree/index.php', $params); } /** * Process the form submission, used if form was submitted via AJAX * * @return array * @throws \moodle_exception */ public function process_dynamic_submission() { $data = $this->get_data(); $url = $this->gpr->get_return_url('index.php?id=' . $data->courseid); $local = $this->get_gradeitem(); $gradeitem = $local['gradeitem']; $item = $local['item']; $parentcategory = grade_category::fetch_course_category($data->courseid); // Form submission handling. // This is a new item, and the category chosen is different than the default category. if (empty($gradeitem->id) && isset($data->parentcategory) && $parentcategory->id != $data->parentcategory) { $parentcategory = grade_category::fetch(['id' => $data->parentcategory]); } // If unset, give the aggregation values a default based on parent aggregation method. $defaults = grade_category::get_default_aggregation_coefficient_values($parentcategory->aggregation); if (!isset($data->aggregationcoef) || $data->aggregationcoef == '') { $data->aggregationcoef = $defaults['aggregationcoef']; } if (!isset($data->weightoverride)) { $data->weightoverride = $defaults['weightoverride']; } if (!isset($data->gradepass) || $data->gradepass == '') { $data->gradepass = 0; } if (!isset($data->grademin) || $data->grademin == '') { $data->grademin = 0; } $hide = empty($data->hiddenuntil) ? 0 : $data->hiddenuntil; if (!$hide) { $hide = empty($data->hidden) ? 0 : $data->hidden; } $locked = empty($data->locked) ? 0 : $data->locked; $locktime = empty($data->locktime) ? 0 : $data->locktime; $convert = ['grademax', 'grademin', 'aggregationcoef', 'aggregationcoef2']; foreach ($convert as $param) { if (property_exists($data, $param)) { $data->$param = unformat_float($data->$param); } } if (isset($data->aggregationcoef2) && $parentcategory->aggregation == GRADE_AGGREGATE_SUM) { $data->aggregationcoef2 = $data->aggregationcoef2 / 100.0; } else { $data->aggregationcoef2 = $defaults['aggregationcoef2']; } $oldmin = $gradeitem->grademin; $oldmax = $gradeitem->grademax; grade_item::set_properties($gradeitem, $data); $gradeitem->outcomeid = null; // Handle null decimals value. if (!property_exists($data, 'decimals') || $data->decimals < 0) { $gradeitem->decimals = null; } if (empty($gradeitem->id)) { $gradeitem->itemtype = 'manual'; // All new items to be manual only. $gradeitem->insert(); // Set parent if needed. if (isset($data->parentcategory)) { $gradeitem->set_parent($data->parentcategory, false); } } else { $gradeitem->update(); if (!empty($data->rescalegrades) && $data->rescalegrades == 'yes') { $newmin = $gradeitem->grademin; $newmax = $gradeitem->grademax; $gradeitem->rescale_grades_keep_percentage($oldmin, $oldmax, $newmin, $newmax, 'gradebook'); } } if ($item->cancontrolvisibility) { // Update hiding flag. $gradeitem->set_hidden($hide, true); } $gradeitem->set_locktime($locktime); // Locktime first - it might be removed when unlocking. $gradeitem->set_locked($locked); return [ 'result' => true, 'url' => $url, 'errors' => [], ]; } /** * Form validation. * * @param array $data array of ("fieldname"=>value) of submitted data * @param array $files array of uploaded files "element_name"=>tmp_file_path * @return array of "element_name"=>"error_description" if there are errors, * or an empty array if everything is OK (true allowed for backwards compatibility too). */ public function validation($data, $files): array { $errors = []; $local = $this->get_gradeitem(); $gradeitem = $local['gradeitem']; if (isset($data['gradetype']) && $data['gradetype'] == GRADE_TYPE_SCALE) { if (empty($data['scaleid'])) { $errors['scaleid'] = get_string('missingscale', 'grades'); } } // We need to make all the validations related with grademax and grademin // with them being correct floats, keeping the originals unmodified for // later validations / showing the form back... // TODO: Note that once MDL-73994 is fixed we'll have to re-visit this and // adapt the code below to the new values arriving here, without forgetting // the special case of empties and nulls. $grademax = isset($data['grademax']) ? unformat_float($data['grademax']) : null; $grademin = isset($data['grademin']) ? unformat_float($data['grademin']) : null; if (!is_null($grademin) && !is_null($grademax)) { if ($grademax == $grademin || $grademax < $grademin) { $errors['grademin'] = get_string('incorrectminmax', 'grades'); $errors['grademax'] = get_string('incorrectminmax', 'grades'); } } // We do not want the user to be able to change the grade type or scale for this item if grades exist. if ($gradeitem && $gradeitem->has_grades()) { // Check that grade type is set - should never not be set unless form has been modified. if (!isset($data['gradetype'])) { $errors['gradetype'] = get_string('modgradecantchangegradetype', 'grades'); } else if ($data['gradetype'] !== $gradeitem->gradetype) { // Check if we are changing the grade type. $errors['gradetype'] = get_string('modgradecantchangegradetype', 'grades'); } else if ($data['gradetype'] == GRADE_TYPE_SCALE) { // Check if we are changing the scale - can't do this when grades exist. if (isset($data['scaleid']) && ($data['scaleid'] !== $gradeitem->scaleid)) { $errors['scaleid'] = get_string('modgradecantchangescale', 'grades'); } } } if ($gradeitem) { if ($gradeitem->gradetype == GRADE_TYPE_VALUE) { if ((((bool) get_config('moodle', 'grade_report_showmin')) && grade_floats_different($grademin, $gradeitem->grademin)) || grade_floats_different($grademax, $gradeitem->grademax)) { if ($gradeitem->has_grades() && empty($data['rescalegrades'])) { $errors['rescalegrades'] = get_string('mustchooserescaleyesorno', 'grades'); } } } } return $errors; } } classes/form/add_category.php 0000604 00000072765 15062070555 0012324 0 ustar 00 <?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/>. namespace core_grades\form; use context; use context_course; use core_form\dynamic_form; use grade_category; use grade_edit_tree; use grade_helper; use grade_item; use grade_plugin_return; use grade_scale; use moodle_url; defined('MOODLE_INTERNAL') || die(); require_once($CFG->dirroot . '/grade/lib.php'); require_once($CFG->dirroot . '/grade/edit/tree/lib.php'); /** * Prints the add category gradebook form * * @copyright 2023 Ilya Tregubov <ilya@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU Public License * @package core_grades */ class add_category extends dynamic_form { /** Grade plugin return tracking object. * @var object $gpr */ public $gpr; /** Available aggregations. * @var array|null $aggregation_options */ private ?array $aggregation_options; /** * Helper function to grab the current grade category based on information within the form. * * @return array * @throws \moodle_exception */ private function get_gradecategory(): array { $courseid = $this->optional_param('courseid', null, PARAM_INT); $id = $this->optional_param('category', null, PARAM_INT); if ($gradecategory = grade_category::fetch(['id' => $id, 'courseid' => $courseid])) { $gradecategory->apply_forced_settings(); $category = $gradecategory->get_record_data(); // Set parent. $category->parentcategory = $gradecategory->parent; $gradeitem = $gradecategory->load_grade_item(); // Normalize coef values if needed. $parentcategory = $gradecategory->get_parent_category(); foreach ($gradeitem->get_record_data() as $key => $value) { $category->{"grade_item_$key"} = $value; } $decimalpoints = $gradeitem->get_decimals(); $category->grade_item_grademax = format_float($category->grade_item_grademax, $decimalpoints); $category->grade_item_grademin = format_float($category->grade_item_grademin, $decimalpoints); $category->grade_item_gradepass = format_float($category->grade_item_gradepass, $decimalpoints); $category->grade_item_multfactor = format_float($category->grade_item_multfactor, 4); $category->grade_item_plusfactor = format_float($category->grade_item_plusfactor, 4); $category->grade_item_aggregationcoef2 = format_float($category->grade_item_aggregationcoef2 * 100.0, 4); if (isset($parentcategory)) { if ($parentcategory->aggregation == GRADE_AGGREGATE_SUM || $parentcategory->aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN2) { $category->grade_item_aggregationcoef = $category->grade_item_aggregationcoef == 0 ? 0 : 1; } else { $category->grade_item_aggregationcoef = format_float($category->grade_item_aggregationcoef, 4); } } // Check if the gradebook is frozen. This allows grades not be altered at all until a user verifies that they // wish to update the grades. $gradebookcalculationsfreeze = get_config('core', 'gradebook_calculations_freeze_' . $courseid); // Stick with the original code if the grade book is frozen. if ($gradebookcalculationsfreeze && (int)$gradebookcalculationsfreeze <= 20150627) { if ($category->aggregation == GRADE_AGGREGATE_SUM) { // Input fields for grademin and grademax are disabled for the "Natural" category, // this means they will be ignored if user does not change aggregation method. // But if user does change aggregation method the default values should be used. $category->grademax = 100; $category->grade_item_grademax = 100; $category->grademin = 0; $category->grade_item_grademin = 0; } } else { if ($category->aggregation == GRADE_AGGREGATE_SUM && !$gradeitem->is_calculated()) { // Input fields for grademin and grademax are disabled for the "Natural" category, // this means they will be ignored if user does not change aggregation method. // But if user does change aggregation method the default values should be used. // This does not apply to calculated category totals. $category->grademax = 100; $category->grade_item_grademax = 100; $category->grademin = 0; $category->grade_item_grademin = 0; } } } else { $gradecategory = new grade_category(['courseid' => $courseid], false); $gradecategory->apply_default_settings(); $gradecategory->apply_forced_settings(); $category = $gradecategory->get_record_data(); $gradeitem = new grade_item(['courseid' => $courseid, 'itemtype' => 'manual'], false); foreach ($gradeitem->get_record_data() as $key => $value) { $category->{"grade_item_$key"} = $value; } } return [ 'gradecategory' => $gradecategory, 'categoryitem' => $category, 'gradeitem' => $gradeitem ]; } /** * Form definition * * @return void * @throws \coding_exception * @throws \dml_exception * @throws \moodle_exception */ protected function definition(): void { global $CFG, $OUTPUT, $COURSE; $courseid = $this->optional_param('courseid', null, PARAM_INT); $id = $this->optional_param('category', 0, PARAM_INT); $gprplugin = $this->optional_param('gpr_plugin', '', PARAM_TEXT); if ($gprplugin && ($gprplugin !== 'tree')) { $this->gpr = new grade_plugin_return(['type' => 'report', 'plugin' => $gprplugin, 'courseid' => $courseid]); } else { $this->gpr = new grade_plugin_return(['type' => 'edit', 'plugin' => 'tree', 'courseid' => $courseid]); } $mform = $this->_form; $this->aggregation_options = grade_helper::get_aggregation_strings(); $local = $this->get_gradecategory(); $category = $local['categoryitem']; // Hidden elements. $mform->addElement('hidden', 'id', 0); $mform->setType('id', PARAM_INT); $mform->addElement('hidden', 'courseid', $courseid); $mform->setType('courseid', PARAM_INT); $mform->addElement('hidden', 'category', $id); $mform->setType('category', PARAM_INT); // Visible elements. $mform->addElement('text', 'fullname', get_string('categoryname', 'grades')); $mform->setType('fullname', PARAM_TEXT); $mform->addRule('fullname', null, 'required', null, 'client'); $mform->addElement('select', 'aggregation', get_string('aggregation', 'grades'), $this->aggregation_options); $mform->addHelpButton('aggregation', 'aggregation', 'grades'); $mform->addElement('checkbox', 'aggregateonlygraded', get_string('aggregateonlygraded', 'grades')); $mform->addHelpButton('aggregateonlygraded', 'aggregateonlygraded', 'grades'); if (empty($CFG->enableoutcomes)) { $mform->addElement('hidden', 'aggregateoutcomes'); $mform->setType('aggregateoutcomes', PARAM_INT); } else { $mform->addElement('checkbox', 'aggregateoutcomes', get_string('aggregateoutcomes', 'grades')); $mform->addHelpButton('aggregateoutcomes', 'aggregateoutcomes', 'grades'); } $mform->addElement('text', 'keephigh', get_string('keephigh', 'grades'), 'size="3"'); $mform->setType('keephigh', PARAM_INT); $mform->addHelpButton('keephigh', 'keephigh', 'grades'); $mform->addElement('text', 'droplow', get_string('droplow', 'grades'), 'size="3"'); $mform->setType('droplow', PARAM_INT); $mform->addHelpButton('droplow', 'droplow', 'grades'); $mform->hideIf('droplow', 'keephigh', 'noteq', 0); $mform->hideIf('keephigh', 'droplow', 'noteq', 0); $mform->hideIf('droplow', 'keephigh', 'noteq', 0); if (!empty($category->id)) { $gradeitem = $local['gradeitem']; // If grades exist set a message so the user knows why they can not alter the grade type or scale. // We could never change the grade type for external items, so only need to show this for manual grade items. if ($gradeitem->has_overridden_grades()) { // Set a message so the user knows why the can not alter the grade type or scale. if ($gradeitem->gradetype == GRADE_TYPE_SCALE) { $gradesexistmsg = get_string('modgradecategorycantchangegradetyporscalemsg', 'grades'); } else { $gradesexistmsg = get_string('modgradecategorycantchangegradetypemsg', 'grades'); } $notification = new \core\output\notification($gradesexistmsg, \core\output\notification::NOTIFY_INFO); $notification->set_show_closebutton(false); $mform->addElement('static', 'gradesexistmsg', '', $OUTPUT->render($notification)); } } $options = [ GRADE_TYPE_NONE => get_string('typenone', 'grades'), GRADE_TYPE_VALUE => get_string('typevalue', 'grades'), GRADE_TYPE_SCALE => get_string('typescale', 'grades'), GRADE_TYPE_TEXT => get_string('typetext', 'grades') ]; $mform->addElement('select', 'grade_item_gradetype', get_string('gradetype', 'grades'), $options); $mform->addHelpButton('grade_item_gradetype', 'gradetype', 'grades'); $mform->setDefault('grade_item_gradetype', GRADE_TYPE_VALUE); $mform->hideIf('grade_item_gradetype', 'aggregation', 'eq', GRADE_AGGREGATE_SUM); $options = [0 => get_string('usenoscale', 'grades')]; if ($scales = grade_scale::fetch_all_local($COURSE->id)) { foreach ($scales as $scale) { $options[$scale->id] = $scale->get_name(); } } if ($scales = grade_scale::fetch_all_global()) { foreach ($scales as $scale) { $options[$scale->id] = $scale->get_name(); } } // Ugly BC hack - it was possible to use custom scale from other courses. if (!empty($category->grade_item_scaleid) && !isset($options[$category->grade_item_scaleid])) { if ($scale = grade_scale::fetch(['id' => $category->grade_item_scaleid])) { $options[$scale->id] = $scale->get_name().' '.get_string('incorrectcustomscale', 'grades'); } } $mform->addElement('select', 'grade_item_scaleid', get_string('scale'), $options); $mform->addHelpButton('grade_item_scaleid', 'typescale', 'grades'); $mform->hideIf('grade_item_scaleid', 'grade_item_gradetype', 'noteq', GRADE_TYPE_SCALE); $mform->hideIf('grade_item_scaleid', 'aggregation', 'eq', GRADE_AGGREGATE_SUM); $choices = []; $choices[''] = get_string('choose'); $choices['no'] = get_string('no'); $choices['yes'] = get_string('yes'); $mform->addElement('select', 'grade_item_rescalegrades', get_string('modgradecategoryrescalegrades', 'grades'), $choices); $mform->addHelpButton('grade_item_rescalegrades', 'modgradecategoryrescalegrades', 'grades'); $mform->hideIf('grade_item_rescalegrades', 'grade_item_gradetype', 'noteq', GRADE_TYPE_VALUE); $mform->addElement('float', 'grade_item_grademax', get_string('grademax', 'grades')); $mform->addHelpButton('grade_item_grademax', 'grademax', 'grades'); $mform->hideIf('grade_item_grademax', 'grade_item_gradetype', 'noteq', GRADE_TYPE_VALUE); $mform->hideIf('grade_item_grademax', 'aggregation', 'eq', GRADE_AGGREGATE_SUM); if ((bool) get_config('moodle', 'grade_report_showmin')) { $mform->addElement('float', 'grade_item_grademin', get_string('grademin', 'grades')); $mform->addHelpButton('grade_item_grademin', 'grademin', 'grades'); $mform->hideIf('grade_item_grademin', 'grade_item_gradetype', 'noteq', GRADE_TYPE_VALUE); $mform->hideIf('grade_item_grademin', 'aggregation', 'eq', GRADE_AGGREGATE_SUM); } // Hiding. // advcheckbox is not compatible with disabledIf! $mform->addElement('checkbox', 'grade_item_hidden', get_string('hidden', 'grades')); $mform->addHelpButton('grade_item_hidden', 'hidden', 'grades'); // Locking. $mform->addElement('checkbox', 'grade_item_locked', get_string('locked', 'grades')); $mform->addHelpButton('grade_item_locked', 'locked', 'grades'); $mform->addElement('advcheckbox', 'grade_item_weightoverride', get_string('adjustedweight', 'grades')); $mform->addHelpButton('grade_item_weightoverride', 'weightoverride', 'grades'); $mform->addElement('float', 'grade_item_aggregationcoef2', get_string('weight', 'grades')); $mform->addHelpButton('grade_item_aggregationcoef2', 'weight', 'grades'); $mform->hideIf('grade_item_aggregationcoef2', 'grade_item_weightoverride'); $options = []; $default = -1; $categories = grade_category::fetch_all(['courseid' => $courseid]); foreach ($categories as $cat) { $cat->apply_forced_settings(); $options[$cat->id] = $cat->get_name(); if ($cat->is_course_category()) { $default = $cat->id; } } if (count($categories) > 1) { $mform->addElement('select', 'parentcategory', get_string('parentcategory', 'grades'), $options); $mform->setDefault('parentcategory', $default); } $params = ['courseid' => $courseid]; if ($id > 0) { $params['id'] = $id; } $url = new moodle_url('/grade/edit/tree/category.php', $params); $url = $this->gpr->add_url_params($url); $url = '<a class="showadvancedform" href="' . $url . '">' . get_string('showmore', 'form') .'</a>'; $mform->addElement('static', 'advancedform', $url); // Add return tracking info. $this->gpr->add_mform_elements($mform); $this->set_data($category); } /** * This method implements changes to the form that need to be made once the form data is set. */ public function definition_after_data(): void { global $CFG; $mform =& $this->_form; $categoryobject = new grade_category(); foreach ($categoryobject->forceable as $property) { if ((int)$CFG->{"grade_{$property}_flag"} & 1) { if ($mform->elementExists($property)) { if (empty($CFG->grade_hideforcedsettings)) { $mform->hardFreeze($property); } else { if ($mform->elementExists($property)) { $mform->removeElement($property); } } } } } if ($CFG->grade_droplow > 0) { if ($mform->elementExists('keephigh')) { $mform->removeElement('keephigh'); } } else if ($CFG->grade_keephigh > 0) { if ($mform->elementExists('droplow')) { $mform->removeElement('droplow'); } } if ($id = $mform->getElementValue('id')) { $gradecategory = grade_category::fetch(['id' => $id]); $gradeitem = $gradecategory->load_grade_item(); // Remove agg coef if not used. if ($gradecategory->is_course_category()) { if ($mform->elementExists('parentcategory')) { $mform->removeElement('parentcategory'); } } else { // If we wanted to change parent of existing category // we would have to verify there are no circular references in parents!!! if ($mform->elementExists('parentcategory')) { $mform->hardFreeze('parentcategory'); } } // Prevent the user from using drop lowest/keep highest when the aggregation method cannot handle it. if (!$gradecategory->can_apply_limit_rules()) { if ($mform->elementExists('keephigh')) { $mform->setConstant('keephigh', 0); $mform->hardFreeze('keephigh'); } if ($mform->elementExists('droplow')) { $mform->setConstant('droplow', 0); $mform->hardFreeze('droplow'); } } if ($gradeitem->is_calculated()) { $gradesexistmsg = get_string('calculationwarning', 'grades'); $gradesexisthtml = '<div class=\'alert alert-warning\'>' . $gradesexistmsg . '</div>'; $mform->addElement('static', 'gradesexistmsg', '', $gradesexisthtml); // Following elements are ignored when calculation formula used. if ($mform->elementExists('aggregation')) { $mform->removeElement('aggregation'); } if ($mform->elementExists('keephigh')) { $mform->removeElement('keephigh'); } if ($mform->elementExists('droplow')) { $mform->removeElement('droplow'); } if ($mform->elementExists('aggregateonlygraded')) { $mform->removeElement('aggregateonlygraded'); } if ($mform->elementExists('aggregateoutcomes')) { $mform->removeElement('aggregateoutcomes'); } } // If it is a course category, remove the "required" rule from the "fullname" element. if ($gradecategory->is_course_category()) { unset($mform->_rules['fullname']); $key = array_search('fullname', $mform->_required); unset($mform->_required[$key]); } // If it is a course category and its fullname is ?, show an empty field. if ($gradecategory->is_course_category() && $mform->getElementValue('fullname') == '?') { $mform->setDefault('fullname', ''); } // Remove unwanted aggregation options. if ($mform->elementExists('aggregation')) { $allaggoptions = array_keys($this->aggregation_options); $aggel =& $mform->getElement('aggregation'); $visible = explode(',', $CFG->grade_aggregations_visible); if (!is_null($gradecategory->aggregation)) { // Current type is always visible. $visible[] = $gradecategory->aggregation; } foreach ($allaggoptions as $type) { if (!in_array($type, $visible)) { $aggel->removeOption($type); } } } } else { // Adding new category // Remove unwanted aggregation options. if ($mform->elementExists('aggregation')) { $allaggoptions = array_keys($this->aggregation_options); $aggel =& $mform->getElement('aggregation'); $visible = explode(',', $CFG->grade_aggregations_visible); foreach ($allaggoptions as $type) { if (!in_array($type, $visible)) { $aggel->removeOption($type); } } } $mform->removeElement('grade_item_rescalegrades'); } // Grade item. if ($id = $mform->getElementValue('id')) { $gradecategory = grade_category::fetch(['id' => $id]); $gradeitem = $gradecategory->load_grade_item(); // Load appropriate "hidden"/"hidden until" defaults. if (!$gradeitem->is_hiddenuntil()) { $mform->setDefault('grade_item_hidden', $gradeitem->get_hidden()); } if ($gradeitem->has_overridden_grades()) { // Can't change the grade type or the scale if there are grades. $mform->hardFreeze('grade_item_gradetype, grade_item_scaleid'); // If we are using scales then remove the unnecessary rescale and grade fields. if ($gradeitem->gradetype == GRADE_TYPE_SCALE) { $mform->removeElement('grade_item_rescalegrades'); $mform->removeElement('grade_item_grademax'); if ($mform->elementExists('grade_item_grademin')) { $mform->removeElement('grade_item_grademin'); } } else { // Not using scale, so remove it. $mform->removeElement('grade_item_scaleid'); $mform->hideIf('grade_item_grademax', 'grade_item_rescalegrades', 'eq', ''); $mform->hideIf('grade_item_grademin', 'grade_item_rescalegrades', 'eq', ''); } } else { // Remove the rescale element if there are no grades. $mform->removeElement('grade_item_rescalegrades'); } // Remove the aggregation coef element if not needed. if ($gradeitem->is_course_item()) { if ($mform->elementExists('grade_item_aggregationcoef')) { $mform->removeElement('grade_item_aggregationcoef'); } if ($mform->elementExists('grade_item_weightoverride')) { $mform->removeElement('grade_item_weightoverride'); } if ($mform->elementExists('grade_item_aggregationcoef2')) { $mform->removeElement('grade_item_aggregationcoef2'); } } else { if ($gradeitem->is_category_item()) { $category = $gradeitem->get_item_category(); $parentcategory = $category->get_parent_category(); } else { $parentcategory = $gradeitem->get_parent_category(); } $parentcategory->apply_forced_settings(); if (!$parentcategory->is_aggregationcoef_used()) { if ($mform->elementExists('grade_item_aggregationcoef')) { $mform->removeElement('grade_item_aggregationcoef'); } } else { $coefstring = $gradeitem->get_coefstring(); if ($coefstring == 'aggregationcoefextrasum' || $coefstring == 'aggregationcoefextraweightsum') { // Advcheckbox is not compatible with disabledIf! $coefstring = 'aggregationcoefextrasum'; $element =& $mform->createElement('checkbox', 'grade_item_aggregationcoef', get_string($coefstring, 'grades')); } else { $element =& $mform->createElement('text', 'grade_item_aggregationcoef', get_string($coefstring, 'grades')); $mform->setType('grade_item_aggregationcoef', PARAM_FLOAT); } $mform->insertElementBefore($element, 'parentcategory'); $mform->addHelpButton('grade_item_aggregationcoef', $coefstring, 'grades'); } // Remove fields used by natural weighting if the parent category is not using natural weighting. // Or if the item is a scale and scales are not used in aggregation. if ($parentcategory->aggregation != GRADE_AGGREGATE_SUM || (empty($CFG->grade_includescalesinaggregation) && $gradeitem->gradetype == GRADE_TYPE_SCALE)) { if ($mform->elementExists('grade_item_weightoverride')) { $mform->removeElement('grade_item_weightoverride'); } if ($mform->elementExists('grade_item_aggregationcoef2')) { $mform->removeElement('grade_item_aggregationcoef2'); } } } } } /** * Return form context * * @return context */ protected function get_context_for_dynamic_submission(): context { $courseid = $this->optional_param('courseid', null, PARAM_INT); return context_course::instance($courseid); } /** * Check if current user has access to this form, otherwise throw exception * * @return void * @throws \required_capability_exception */ protected function check_access_for_dynamic_submission(): void { $courseid = $this->optional_param('courseid', null, PARAM_INT); require_capability('moodle/grade:manage', context_course::instance($courseid)); } /** * Load in existing data as form defaults * * @return void */ public function set_data_for_dynamic_submission(): void { $this->set_data((object)[ 'courseid' => $this->optional_param('courseid', null, PARAM_INT), 'category' => $this->optional_param('category', null, PARAM_INT) ]); } /** * Returns url to set in $PAGE->set_url() when form is being rendered or submitted via AJAX * * @return moodle_url * @throws \moodle_exception */ protected function get_page_url_for_dynamic_submission(): moodle_url { $params = [ 'id' => $this->optional_param('courseid', null, PARAM_INT), 'category' => $this->optional_param('category', null, PARAM_INT), ]; return new moodle_url('/grade/edit/tree/index.php', $params); } /** * Process the form submission, used if form was submitted via AJAX * * @return array * @throws \moodle_exception */ public function process_dynamic_submission(): array { $data = $this->get_data(); $url = $this->gpr->get_return_url('index.php?id=' . $data->courseid); $local = $this->get_gradecategory(); $gradecategory = $local['gradecategory']; grade_edit_tree::update_gradecategory($gradecategory, $data); return [ 'result' => true, 'url' => $url, 'errors' => [], ]; } /** * Form validation. * * @param array $data array of ("fieldname"=>value) of submitted data * @param array $files array of uploaded files "element_name"=>tmp_file_path * @return array of "element_name"=>"error_description" if there are errors, * or an empty array if everything is OK (true allowed for backwards compatibility too). */ public function validation($data, $files): array { $gradeitem = false; if ($data['id']) { $gradecategory = grade_category::fetch(['id' => $data['id']]); $gradeitem = $gradecategory->load_grade_item(); } $errors = parent::validation($data, $files); if (array_key_exists('grade_item_gradetype', $data) && $data['grade_item_gradetype'] == GRADE_TYPE_SCALE) { if (empty($data['grade_item_scaleid'])) { $errors['grade_item_scaleid'] = get_string('missingscale', 'grades'); } } // We need to make all the validations related with grademax and grademin // with them being correct floats, keeping the originals unmodified for // later validations / showing the form back... // TODO: Note that once MDL-73994 is fixed we'll have to re-visit this and // adapt the code below to the new values arriving here, without forgetting // the special case of empties and nulls. $grademax = isset($data['grade_item_grademax']) ? unformat_float($data['grade_item_grademax']) : null; $grademin = isset($data['grade_item_grademin']) ? unformat_float($data['grade_item_grademin']) : null; if (!is_null($grademin) && !is_null($grademax)) { if (($grademax != 0 || $grademin != 0) && ($grademax == $grademin || $grademax < $grademin)) { $errors['grade_item_grademin'] = get_string('incorrectminmax', 'grades'); $errors['grade_item_grademax'] = get_string('incorrectminmax', 'grades'); } } if ($data['id'] && $gradeitem->has_overridden_grades()) { if ($gradeitem->gradetype == GRADE_TYPE_VALUE) { if (grade_floats_different($grademin, $gradeitem->grademin) || grade_floats_different($grademax, $gradeitem->grademax)) { if (empty($data['grade_item_rescalegrades'])) { $errors['grade_item_rescalegrades'] = get_string('mustchooserescaleyesorno', 'grades'); } } } } return $errors; } } classes/form/add_outcome.php 0000604 00000047432 15062070555 0012153 0 ustar 00 <?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/>. namespace core_grades\form; defined('MOODLE_INTERNAL') || die; use context; use context_course; use core_form\dynamic_form; use grade_category; use grade_item; use grade_outcome; use grade_plugin_return; use moodle_url; require_once($CFG->dirroot.'/grade/lib.php'); /** * Prints the add outcome gradebook form. * * @copyright 2023 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU Public License * @package core_grades */ class add_outcome extends dynamic_form { /** Grade plugin return tracking object. * @var object $gpr */ public $gpr; /** * Helper function to grab the current grade outcome item based on information within the form. * * @return array * @throws \moodle_exception */ private function get_gradeitem(): array { $courseid = $this->optional_param('courseid', null, PARAM_INT); $id = $this->optional_param('itemid', null, PARAM_INT); if ($gradeitem = grade_item::fetch(['id' => $id, 'courseid' => $courseid])) { // Redirect if outcomeid not present. if (empty($gradeitem->outcomeid)) { $url = new moodle_url('/grade/edit/tree/item.php', ['id' => $id, 'courseid' => $courseid]); redirect($this->gpr->add_url_params($url)); } $item = $gradeitem->get_record_data(); $parentcategory = $gradeitem->get_parent_category(); if ($item->itemtype == 'mod') { $cm = get_coursemodule_from_instance($item->itemmodule, $item->iteminstance, $item->courseid); $item->cmid = $cm->id; } else { $item->cmid = 0; } } else { $gradeitem = new grade_item(['courseid' => $courseid, 'itemtype' => 'manual'], false); $item = $gradeitem->get_record_data(); $parentcategory = grade_category::fetch_course_category($courseid); } $item->parentcategory = $parentcategory->id; if ($item->hidden > 1) { $item->hiddenuntil = $item->hidden; $item->hidden = 0; } else { $item->hiddenuntil = 0; } $item->locked = !empty($item->locked); if ($parentcategory->aggregation == GRADE_AGGREGATE_SUM || $parentcategory->aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN2) { $item->aggregationcoef = $item->aggregationcoef == 0 ? 0 : 1; } else { $item->aggregationcoef = format_float($item->aggregationcoef, 4); } if ($parentcategory->aggregation == GRADE_AGGREGATE_SUM) { $item->aggregationcoef2 = format_float($item->aggregationcoef2 * 100.0); } $item->cancontrolvisibility = $gradeitem->can_control_visibility(); return [ 'gradeitem' => $gradeitem, 'item' => $item ]; } /** * Form definition * * @return void * @throws \coding_exception * @throws \dml_exception * @throws \moodle_exception */ protected function definition() { $courseid = $this->optional_param('courseid', null, PARAM_INT); $id = $this->optional_param('itemid', 0, PARAM_INT); $gprplugin = $this->optional_param('gpr_plugin', '', PARAM_TEXT); if ($gprplugin && ($gprplugin !== 'tree')) { $this->gpr = new grade_plugin_return(['type' => 'report', 'plugin' => $gprplugin, 'courseid' => $courseid]); } else { $this->gpr = new grade_plugin_return(['type' => 'edit', 'plugin' => 'tree', 'courseid' => $courseid]); } $mform =& $this->_form; $local = $this->get_gradeitem(); $gradeitem = $local['gradeitem']; $item = $local['item']; // Hidden elements. $mform->addElement('hidden', 'id', 0); $mform->setType('id', PARAM_INT); $mform->addElement('hidden', 'courseid', $courseid); $mform->setType('courseid', PARAM_INT); $mform->addElement('hidden', 'itemid', $id); $mform->setType('itemid', PARAM_INT); // Allow setting of outcomes on module items too. $outcomeoptions = []; if ($outcomes = grade_outcome::fetch_all_available($courseid)) { foreach ($outcomes as $outcome) { $outcomeoptions[$outcome->id] = $outcome->get_name(); } } // Visible elements. $mform->addElement('text', 'itemname', get_string('itemname', 'grades')); $mform->addRule('itemname', get_string('required'), 'required', null, 'client'); $mform->setType('itemname', PARAM_TEXT); $mform->addElement('selectwithlink', 'outcomeid', get_string('outcome', 'grades'), $outcomeoptions); $mform->addHelpButton('outcomeid', 'outcome', 'grades'); $mform->addRule('outcomeid', get_string('required'), 'required'); $options = [0 => get_string('none')]; if ($coursemods = get_course_mods($courseid)) { foreach ($coursemods as $coursemod) { if ($mod = get_coursemodule_from_id($coursemod->modname, $coursemod->id)) { $options[$coursemod->id] = format_string($mod->name); } } } $mform->addElement('select', 'cmid', get_string('linkedactivity', 'grades'), $options); $mform->addHelpButton('cmid', 'linkedactivity', 'grades'); $mform->setDefault('cmid', 0); // Hiding. $mform->addElement('checkbox', 'hidden', get_string('hidden', 'grades')); $mform->addHelpButton('hidden', 'hidden', 'grades'); // Locking. $mform->addElement('advcheckbox', 'locked', get_string('locked', 'grades')); $mform->addHelpButton('locked', 'locked', 'grades'); // Parent category related settings. $mform->addElement('advcheckbox', 'weightoverride', get_string('adjustedweight', 'grades')); $mform->addHelpButton('weightoverride', 'weightoverride', 'grades'); $mform->addElement('text', 'aggregationcoef2', get_string('weight', 'grades')); $mform->addHelpButton('aggregationcoef2', 'weight', 'grades'); $mform->setType('aggregationcoef2', PARAM_RAW); $mform->hideIf('aggregationcoef2', 'weightoverride'); $options = []; $coefstring = ''; $categories = grade_category::fetch_all(['courseid' => $courseid]); foreach ($categories as $cat) { $cat->apply_forced_settings(); $options[$cat->id] = $cat->get_name(); if ($cat->is_aggregationcoef_used()) { if ($cat->aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN) { $coefstring = ($coefstring == '' || $coefstring == 'aggregationcoefweight') ? 'aggregationcoefweight' : 'aggregationcoef'; } else if ($cat->aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN2) { $coefstring = ($coefstring == '' || $coefstring == 'aggregationcoefextrasum') ? 'aggregationcoefextrasum' : 'aggregationcoef'; } else if ($cat->aggregation == GRADE_AGGREGATE_EXTRACREDIT_MEAN) { $coefstring = ($coefstring == '' || $coefstring == 'aggregationcoefextraweight') ? 'aggregationcoefextraweight' : 'aggregationcoef'; } else if ($cat->aggregation == GRADE_AGGREGATE_SUM) { $coefstring = ($coefstring == '' || $coefstring == 'aggregationcoefextrasum') ? 'aggregationcoefextrasum' : 'aggregationcoef'; } else { $coefstring = 'aggregationcoef'; } } else { $mform->disabledIf('aggregationcoef', 'parentcategory', 'eq', $cat->id); } } if (count($categories) > 1) { $mform->addElement('select', 'parentcategory', get_string('gradecategory', 'grades'), $options); $mform->disabledIf('parentcategory', 'cmid', 'noteq', 0); } if ($coefstring !== '') { if ($coefstring == 'aggregationcoefextrasum' || $coefstring == 'aggregationcoefextraweightsum') { $coefstring = 'aggregationcoefextrasum'; $mform->addElement('checkbox', 'aggregationcoef', get_string($coefstring, 'grades')); } else { $mform->addElement('text', 'aggregationcoef', get_string($coefstring, 'grades')); } $mform->addHelpButton('aggregationcoef', $coefstring, 'grades'); } // Remove the aggregation coef element if not needed. if ($gradeitem->is_course_item()) { if ($mform->elementExists('parentcategory')) { $mform->removeElement('parentcategory'); } if ($mform->elementExists('aggregationcoef')) { $mform->removeElement('aggregationcoef'); } } else { // If we wanted to change parent of existing item - we would have to verify there are no circular references in parents. if ($id > -1 && $mform->elementExists('parentcategory')) { $mform->hardFreeze('parentcategory'); } $parentcategory = $gradeitem->get_parent_category(); if (!$parentcategory) { // If we do not have an id, we are creating a new grade item. // Assign the course category to this grade item. $parentcategory = grade_category::fetch_course_category($courseid); $gradeitem->parent_category = $parentcategory; } $parentcategory->apply_forced_settings(); if (!$parentcategory->is_aggregationcoef_used() || !$parentcategory->aggregateoutcomes) { if ($mform->elementExists('aggregationcoef')) { $mform->removeElement('aggregationcoef'); } } else { // Fix label if needed. $agg_el =& $mform->getElement('aggregationcoef'); $aggcoef = ''; if ($parentcategory->aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN) { $aggcoef = 'aggregationcoefweight'; } else if ($parentcategory->aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN2) { $aggcoef = 'aggregationcoefextrasum'; } else if ($parentcategory->aggregation == GRADE_AGGREGATE_EXTRACREDIT_MEAN) { $aggcoef = 'aggregationcoefextraweight'; } else if ($parentcategory->aggregation == GRADE_AGGREGATE_SUM) { $aggcoef = 'aggregationcoefextrasum'; } if ($aggcoef !== '') { $agg_el->setLabel(get_string($aggcoef, 'grades')); $mform->addHelpButton('aggregationcoef', $aggcoef, 'grades'); } } // Remove the natural weighting fields for other aggregations, // or when the category does not aggregate outcomes. if ($parentcategory->aggregation != GRADE_AGGREGATE_SUM || !$parentcategory->aggregateoutcomes) { if ($mform->elementExists('weightoverride')) { $mform->removeElement('weightoverride'); } if ($mform->elementExists('aggregationcoef2')) { $mform->removeElement('aggregationcoef2'); } } } $url = new moodle_url('/grade/edit/tree/outcomeitem.php', ['id' => $id, 'courseid' => $courseid]); $url = $this->gpr->add_url_params($url); $url = '<a class="showadvancedform" href="' . $url . '">' . get_string('showmore', 'form') .'</a>'; $mform->addElement('static', 'advancedform', $url); // Add return tracking info. $this->gpr->add_mform_elements($mform); $this->set_data($item); } /** * Return form context * * @return context */ protected function get_context_for_dynamic_submission(): context { $courseid = $this->optional_param('courseid', null, PARAM_INT); return context_course::instance($courseid); } /** * Check if current user has access to this form, otherwise throw exception * * @return void * @throws \required_capability_exception */ protected function check_access_for_dynamic_submission(): void { $courseid = $this->optional_param('courseid', null, PARAM_INT); require_capability('moodle/grade:manage', context_course::instance($courseid)); } /** * Load in existing data as form defaults * * @return void */ public function set_data_for_dynamic_submission(): void { $this->set_data((object)[ 'courseid' => $this->optional_param('courseid', null, PARAM_INT), 'itemid' => $this->optional_param('itemid', null, PARAM_INT) ]); } /** * Returns url to set in $PAGE->set_url() when form is being rendered or submitted via AJAX * * @return moodle_url * @throws \moodle_exception */ protected function get_page_url_for_dynamic_submission(): moodle_url { $params = [ 'id' => $this->optional_param('courseid', null, PARAM_INT), 'itemid' => $this->optional_param('itemid', null, PARAM_INT), ]; return new moodle_url('/grade/edit/tree/index.php', $params); } /** * Process the form submission, used if form was submitted via AJAX * * @return array * @throws \moodle_exception */ public function process_dynamic_submission() { global $DB; $data = $this->get_data(); $url = $this->gpr->get_return_url('index.php?id=' . $data->courseid); $local = $this->get_gradeitem(); $gradeitem = $local['gradeitem']; $item = $local['item']; $parentcategory = grade_category::fetch_course_category($data->courseid); // Form submission handling. // If unset, give the aggregation values a default based on parent aggregation method. $defaults = grade_category::get_default_aggregation_coefficient_values($parentcategory->aggregation); if (!isset($data->aggregationcoef) || $data->aggregationcoef == '') { $data->aggregationcoef = $defaults['aggregationcoef']; } if (!isset($data->weightoverride)) { $data->weightoverride = $defaults['weightoverride']; } if (property_exists($data, 'calculation')) { $data->calculation = grade_item::normalize_formula($data->calculation, $data->courseid); } $hide = empty($data->hiddenuntil) ? 0 : $data->hiddenuntil; if (!$hide) { $hide = empty($data->hidden) ? 0 : $data->hidden; } $locked = empty($data->locked) ? 0 : $data->locked; $locktime = empty($data->locktime) ? 0 : $data->locktime; $convert = ['gradepass', 'aggregationcoef', 'aggregationcoef2']; foreach ($convert as $param) { if (property_exists($data, $param)) { $data->$param = unformat_float($data->$param); } } if (isset($data->aggregationcoef2) && $parentcategory->aggregation == GRADE_AGGREGATE_SUM) { $data->aggregationcoef2 = $data->aggregationcoef2 / 100.0; } else { $data->aggregationcoef2 = $defaults['aggregationcoef2']; } grade_item::set_properties($gradeitem, $data); // Link this outcome item to the user specified linked activity. if (empty($data->cmid) || $data->cmid == 0) { // Manual item. $gradeitem->itemtype = 'manual'; $gradeitem->itemmodule = null; $gradeitem->iteminstance = null; $gradeitem->itemnumber = 0; } else { $params = [$data->cmid]; $module = $DB->get_record_sql("SELECT cm.*, m.name as modname FROM {modules} m, {course_modules} cm WHERE cm.id = ? AND cm.module = m.id ", $params); $gradeitem->itemtype = 'mod'; $gradeitem->itemmodule = $module->modname; $gradeitem->iteminstance = $module->instance; if ($items = grade_item::fetch_all(['itemtype' => 'mod', 'itemmodule' => $gradeitem->itemmodule, 'iteminstance' => $gradeitem->iteminstance, 'courseid' => $data->courseid])) { if (!empty($gradeitem->id) && in_array($gradeitem, $items)) { // No change needed. } else { $max = 999; foreach ($items as $item) { if (empty($item->outcomeid)) { continue; } if ($item->itemnumber > $max) { $max = $item->itemnumber; } } $gradeitem->itemnumber = $max + 1; } } else { $gradeitem->itemnumber = 1000; } } // Fix scale used. $outcome = grade_outcome::fetch(['id' => $data->outcomeid]); $gradeitem->gradetype = GRADE_TYPE_SCALE; $gradeitem->scaleid = $outcome->scaleid; // TODO: we might recalculate existing outcome grades when changing scale. if (empty($gradeitem->id)) { $gradeitem->insert(); // Move next to activity if adding linked outcome. if ($gradeitem->itemtype == 'mod') { if ($linkeditem = grade_item::fetch(['itemtype' => 'mod', 'itemmodule' => $gradeitem->itemmodule, 'iteminstance' => $gradeitem->iteminstance, 'itemnumber' => 0, 'courseid' => $data->courseid])) { $gradeitem->set_parent($linkeditem->categoryid); $gradeitem->move_after_sortorder($linkeditem->sortorder); } } else { // Set parent if needed. if (isset($data->parentcategory)) { $gradeitem->set_parent($data->parentcategory, false); } } } else { $gradeitem->update(); } if ($item->cancontrolvisibility) { // Update hiding flag. $gradeitem->set_hidden($hide, true); } $gradeitem->set_locktime($locktime); // Locktime first - it might be removed when unlocking. $gradeitem->set_locked($locked, false, true); return [ 'result' => true, 'url' => $url, 'errors' => [], ]; } /** * Form validation. * * @param array $data array of ("fieldname"=>value) of submitted data * @param array $files array of uploaded files "element_name"=>tmp_file_path * @return array of "element_name"=>"error_description" if there are errors, * or an empty array if everything is OK (true allowed for backwards compatibility too). */ public function validation($data, $files): array { $errors = []; $local = $this->get_gradeitem(); $gradeitem = $local['gradeitem']; $item = $local['item']; if (!grade_verify_idnumber($gradeitem->id, $item->courseid, $gradeitem)) { $errors['idnumber'] = get_string('idnumbertaken'); } return $errors; } } classes/grades/grader/gradingpanel/scale/external/fetch.php 0000604 00000017777 15062070555 0020104 0 ustar 00 <?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/>. /** * Web service functions relating to scale grades and grading. * * @package core_grades * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ declare(strict_types = 1); namespace core_grades\grades\grader\gradingpanel\scale\external; use coding_exception; use context; use core_grades\component_gradeitem as gradeitem; use core_grades\component_gradeitems; use core_external\external_api; use core_external\external_function_parameters; use core_external\external_multiple_structure; use core_external\external_single_structure; use core_external\external_value; use core_external\external_warnings; use moodle_exception; use stdClass; /** * External grading panel scale API * * @package core_grades * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class fetch extends external_api { /** * Describes the parameters for fetching the grading panel for a simple grade. * * @return external_function_parameters * @since Moodle 3.8 */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters ([ 'component' => new external_value( PARAM_ALPHANUMEXT, 'The name of the component', VALUE_REQUIRED ), 'contextid' => new external_value( PARAM_INT, 'The ID of the context being graded', VALUE_REQUIRED ), 'itemname' => new external_value( PARAM_ALPHANUM, 'The grade item itemname being graded', VALUE_REQUIRED ), 'gradeduserid' => new external_value( PARAM_INT, 'The ID of the user show', VALUE_REQUIRED ), ]); } /** * Fetch the data required to build a grading panel for a simple grade. * * @param string $component * @param int $contextid * @param string $itemname * @param int $gradeduserid * @return array * @throws \dml_exception * @throws \invalid_parameter_exception * @throws \restricted_context_exception * @throws coding_exception * @throws moodle_exception * @since Moodle 3.8 */ public static function execute(string $component, int $contextid, string $itemname, int $gradeduserid): array { global $USER, $CFG; require_once("{$CFG->libdir}/gradelib.php"); [ 'component' => $component, 'contextid' => $contextid, 'itemname' => $itemname, 'gradeduserid' => $gradeduserid, ] = self::validate_parameters(self::execute_parameters(), [ 'component' => $component, 'contextid' => $contextid, 'itemname' => $itemname, 'gradeduserid' => $gradeduserid, ]); // Validate the context. $context = context::instance_by_id($contextid); self::validate_context($context); // Validate that the supplied itemname is a gradable item. if (!component_gradeitems::is_valid_itemname($component, $itemname)) { throw new coding_exception("The '{$itemname}' item is not valid for the '{$component}' component"); } // Fetch the gradeitem instance. $gradeitem = gradeitem::instance($component, $context, $itemname); if (!$gradeitem->is_using_scale()) { throw new moodle_exception("The {$itemname} item in {$component}/{$contextid} is not configured for grading with scales"); } $gradeduser = \core_user::get_user($gradeduserid, '*', MUST_EXIST); // One can access its own grades. Others just if they're graders. if ($gradeduserid != $USER->id) { $gradeitem->require_user_can_grade($gradeduser, $USER); } // Set up some items we need to return on other interfaces. $gradegrade = \grade_grade::fetch(['itemid' => $gradeitem->get_grade_item()->id, 'userid' => $gradeduser->id]); $gradername = $gradegrade ? fullname(\core_user::get_user($gradegrade->usermodified)) : null; $maxgrade = (int) $gradeitem->get_grade_item()->grademax; return self::get_fetch_data($gradeitem, $gradeduser, $maxgrade, $gradername); } /** * Get the data to be fetched. * * @param gradeitem $gradeitem * @param stdClass $gradeduser * @param int $maxgrade * @param string|null $gradername * @return array */ public static function get_fetch_data(gradeitem $gradeitem, stdClass $gradeduser, int $maxgrade, ?string $gradername): array { global $USER; $hasgrade = $gradeitem->user_has_grade($gradeduser); $grade = $gradeitem->get_formatted_grade_for_user($gradeduser, $USER); $currentgrade = (int) unformat_float($grade->grade); $menu = $gradeitem->get_grade_menu(); $values = array_map(function($description, $value) use ($currentgrade) { return [ 'value' => $value, 'title' => $description, 'selected' => ($value == $currentgrade), ]; }, $menu, array_keys($menu)); return [ 'templatename' => 'core_grades/grades/grader/gradingpanel/scale', 'hasgrade' => $hasgrade, 'grade' => [ 'options' => $values, 'usergrade' => $grade->usergrade, 'maxgrade' => $maxgrade, 'gradedby' => $gradername, 'timecreated' => $grade->timecreated, 'timemodified' => $grade->timemodified, ], 'warnings' => [], ]; } /** * Describes the data returned from the external function. * * @return external_single_structure * @since Moodle 3.8 */ public static function execute_returns(): external_single_structure { return new external_single_structure([ 'templatename' => new external_value(PARAM_SAFEPATH, 'The template to use when rendering this data'), 'hasgrade' => new external_value(PARAM_BOOL, 'Does the user have a grade?'), 'grade' => new external_single_structure([ 'options' => new external_multiple_structure( new external_single_structure([ 'value' => new external_value(PARAM_FLOAT, 'The grade value'), 'title' => new external_value(PARAM_RAW, 'The description fo the option'), 'selected' => new external_value(PARAM_BOOL, 'Whether this item is currently selected'), ]), 'The description of the grade option' ), 'usergrade' => new external_value(PARAM_RAW, 'Current user grade'), 'maxgrade' => new external_value(PARAM_RAW, 'Max possible grade'), 'gradedby' => new external_value(PARAM_RAW, 'The assumed grader of this grading instance'), 'timecreated' => new external_value(PARAM_INT, 'The time that the grade was created'), 'timemodified' => new external_value(PARAM_INT, 'The time that the grade was last updated'), ]), 'warnings' => new external_warnings(), ]); } } classes/grades/grader/gradingpanel/scale/external/store.php 0000604 00000014322 15062070555 0020126 0 ustar 00 <?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/>. /** * Web service functions relating to scale grades and grading. * * @package core_grades * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ declare(strict_types = 1); namespace core_grades\grades\grader\gradingpanel\scale\external; use coding_exception; use context; use core_grades\component_gradeitem as gradeitem; use core_grades\component_gradeitems; use core_external\external_api; use core_external\external_function_parameters; use core_external\external_single_structure; use core_external\external_value; use moodle_exception; /** * External grading panel scale API * * @package core_grades * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class store extends external_api { /** * Describes the parameters for fetching the grading panel for a simple grade. * * @return external_function_parameters * @since Moodle 3.8 */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters ([ 'component' => new external_value( PARAM_ALPHANUMEXT, 'The name of the component', VALUE_REQUIRED ), 'contextid' => new external_value( PARAM_INT, 'The ID of the context being graded', VALUE_REQUIRED ), 'itemname' => new external_value( PARAM_ALPHANUM, 'The grade item itemname being graded', VALUE_REQUIRED ), 'gradeduserid' => new external_value( PARAM_INT, 'The ID of the user show', VALUE_REQUIRED ), 'notifyuser' => new external_value( PARAM_BOOL, 'Wheteher to notify the user or not', VALUE_DEFAULT, false ), 'formdata' => new external_value( PARAM_RAW, 'The serialised form data representing the grade', VALUE_REQUIRED ), ]); } /** * Fetch the data required to build a grading panel for a simple grade. * * @param string $component * @param int $contextid * @param string $itemname * @param int $gradeduserid * @param string $formdata * @param bool $notifyuser * @return array * @throws coding_exception * @throws moodle_exception * @since Moodle 3.8 */ public static function execute(string $component, int $contextid, string $itemname, int $gradeduserid, bool $notifyuser, string $formdata): array { global $USER, $CFG; require_once("{$CFG->libdir}/gradelib.php"); [ 'component' => $component, 'contextid' => $contextid, 'itemname' => $itemname, 'gradeduserid' => $gradeduserid, 'notifyuser' => $notifyuser, 'formdata' => $formdata, ] = self::validate_parameters(self::execute_parameters(), [ 'component' => $component, 'contextid' => $contextid, 'itemname' => $itemname, 'gradeduserid' => $gradeduserid, 'notifyuser' => $notifyuser, 'formdata' => $formdata, ]); // Validate the context. $context = context::instance_by_id($contextid); self::validate_context($context); // Validate that the supplied itemname is a gradable item. if (!component_gradeitems::is_valid_itemname($component, $itemname)) { throw new coding_exception("The '{$itemname}' item is not valid for the '{$component}' component"); } // Fetch the gradeitem instance. $gradeitem = gradeitem::instance($component, $context, $itemname); // Validate that this gradeitem is actually enabled. if (!$gradeitem->is_grading_enabled()) { throw new moodle_exception("Grading is not enabled for {$itemname} in this context"); } // Fetch the record for the graded user. $gradeduser = \core_user::get_user($gradeduserid); // Require that this user can save grades. $gradeitem->require_user_can_grade($gradeduser, $USER); if (!$gradeitem->is_using_scale()) { throw new moodle_exception("The {$itemname} item in {$component}/{$contextid} is not configured for grading with scales"); } // Parse the serialised string into an object. $data = []; parse_str($formdata, $data); // Grade. $gradeitem->store_grade_from_formdata($gradeduser, $USER, (object) $data); // Notify. if ($notifyuser) { // Send notification. $gradeitem->send_student_notification($gradeduser, $USER); } $gradegrade = \grade_grade::fetch(['itemid' => $gradeitem->get_grade_item()->id, 'userid' => $gradeduser->id]); $gradername = $gradegrade ? fullname(\core_user::get_user($gradegrade->usermodified)) : null; $maxgrade = (int) $gradeitem->get_grade_item()->grademax; return fetch::get_fetch_data($gradeitem, $gradeduser, $maxgrade, $gradername); } /** * Describes the data returned from the external function. * * @return external_single_structure * @since Moodle 3.8 */ public static function execute_returns(): external_single_structure { return fetch::execute_returns(); } } classes/grades/grader/gradingpanel/point/external/fetch.php 0000604 00000017350 15062070555 0020131 0 ustar 00 <?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/>. /** * Web service functions relating to point grades and grading. * * @package core_grades * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ declare(strict_types = 1); namespace core_grades\grades\grader\gradingpanel\point\external; use coding_exception; use context; use core_grades\component_gradeitem as gradeitem; use core_grades\component_gradeitems; use core_external\external_api; use core_external\external_function_parameters; use core_external\external_single_structure; use core_external\external_value; use core_external\external_warnings; use moodle_exception; use stdClass; /** * External grading panel point API * * @package core_grades * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class fetch extends external_api { /** * Describes the parameters for fetching the grading panel for a simple grade. * * @return external_function_parameters * @since Moodle 3.8 */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters ([ 'component' => new external_value( PARAM_ALPHANUMEXT, 'The name of the component', VALUE_REQUIRED ), 'contextid' => new external_value( PARAM_INT, 'The ID of the context being graded', VALUE_REQUIRED ), 'itemname' => new external_value( PARAM_ALPHANUM, 'The grade item itemname being graded', VALUE_REQUIRED ), 'gradeduserid' => new external_value( PARAM_INT, 'The ID of the user show', VALUE_REQUIRED ), ]); } /** * Fetch the data required to build a grading panel for a simple grade. * * @param string $component * @param int $contextid * @param string $itemname * @param int $gradeduserid * @return array * @throws \dml_exception * @throws \invalid_parameter_exception * @throws \restricted_context_exception * @throws coding_exception * @throws moodle_exception * @since Moodle 3.8 */ public static function execute(string $component, int $contextid, string $itemname, int $gradeduserid): array { global $USER, $CFG; require_once("{$CFG->libdir}/gradelib.php"); [ 'component' => $component, 'contextid' => $contextid, 'itemname' => $itemname, 'gradeduserid' => $gradeduserid, ] = self::validate_parameters(self::execute_parameters(), [ 'component' => $component, 'contextid' => $contextid, 'itemname' => $itemname, 'gradeduserid' => $gradeduserid, ]); // Validate the context. $context = context::instance_by_id($contextid); self::validate_context($context); // Validate that the supplied itemname is a gradable item. if (!component_gradeitems::is_valid_itemname($component, $itemname)) { throw new coding_exception("The '{$itemname}' item is not valid for the '{$component}' component"); } // Fetch the gradeitem instance. $gradeitem = gradeitem::instance($component, $context, $itemname); if (!$gradeitem->is_using_direct_grading()) { throw new moodle_exception("The {$itemname} item in {$component}/{$contextid} is not configured for direct grading"); } // Fetch the actual data. $gradeduser = \core_user::get_user($gradeduserid, '*', MUST_EXIST); // One can access its own grades. Others just if they're graders. if ($gradeduserid != $USER->id) { $gradeitem->require_user_can_grade($gradeduser, $USER); } $hasgrade = $gradeitem->user_has_grade($gradeduser); $grade = $gradeitem->get_formatted_grade_for_user($gradeduser, $USER); $isgrading = $gradeitem->user_can_grade($gradeduser, $USER); // Set up some items we need to return on other interfaces. $gradegrade = \grade_grade::fetch(['itemid' => $gradeitem->get_grade_item()->id, 'userid' => $gradeduser->id]); $gradername = $gradegrade ? fullname(\core_user::get_user($gradegrade->usermodified)) : null; return self::get_fetch_data($grade, $hasgrade, $gradeitem, $gradername, $isgrading); } /** * Get the data to be fetched. * * @param stdClass $grade * @param bool $hasgrade * @param gradeitem $gradeitem * @param string|null $gradername * @param bool $isgrading * @return array */ public static function get_fetch_data( stdClass $grade, bool $hasgrade, gradeitem $gradeitem, ?string $gradername, bool $isgrading = false ): array { $templatename = 'core_grades/grades/grader/gradingpanel/point'; // We do not want to display anything if we are showing the grade as a letter. For example the 'Grade' might // read 'B-'. We do not want to show the user the actual point they were given. See MDL-71439. if (($gradeitem->get_grade_item()->get_displaytype() == GRADE_DISPLAY_TYPE_LETTER) && !$isgrading) { $templatename = 'core_grades/grades/grader/gradingpanel/point_blank'; } return [ 'templatename' => $templatename, 'hasgrade' => $hasgrade, 'grade' => [ 'grade' => $grade->grade, 'usergrade' => $grade->usergrade, 'maxgrade' => (int) $grade->maxgrade, 'gradedby' => $gradername, 'timecreated' => $grade->timecreated, 'timemodified' => $grade->timemodified, ], 'warnings' => [], ]; } /** * Describes the data returned from the external function. * * @return external_single_structure * @since Moodle 3.8 */ public static function execute_returns(): external_single_structure { return new external_single_structure([ 'templatename' => new external_value(PARAM_SAFEPATH, 'The template to use when rendering this data'), 'hasgrade' => new external_value(PARAM_BOOL, 'Does the user have a grade?'), 'grade' => new external_single_structure([ 'grade' => new external_value(PARAM_FLOAT, 'The numeric grade'), 'usergrade' => new external_value(PARAM_RAW, 'Current user grade'), 'maxgrade' => new external_value(PARAM_RAW, 'Max possible grade'), 'gradedby' => new external_value(PARAM_RAW, 'The assumed grader of this grading instance'), 'timecreated' => new external_value(PARAM_INT, 'The time that the grade was created'), 'timemodified' => new external_value(PARAM_INT, 'The time that the grade was last updated'), ]), 'warnings' => new external_warnings(), ]); } } classes/grades/grader/gradingpanel/point/external/store.php 0000604 00000014700 15062070555 0020170 0 ustar 00 <?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/>. /** * Web service functions relating to point grades and grading. * * @package core_grades * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ declare(strict_types = 1); namespace core_grades\grades\grader\gradingpanel\point\external; use coding_exception; use context; use core_grades\component_gradeitem as gradeitem; use core_grades\component_gradeitems; use core_external\external_api; use core_external\external_function_parameters; use core_external\external_single_structure; use core_external\external_value; use moodle_exception; /** * External grading panel point API * * @package core_grades * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class store extends external_api { /** * Describes the parameters for fetching the grading panel for a simple grade. * * @return external_function_parameters * @since Moodle 3.8 */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters ([ 'component' => new external_value( PARAM_ALPHANUMEXT, 'The name of the component', VALUE_REQUIRED ), 'contextid' => new external_value( PARAM_INT, 'The ID of the context being graded', VALUE_REQUIRED ), 'itemname' => new external_value( PARAM_ALPHANUM, 'The grade item itemname being graded', VALUE_REQUIRED ), 'gradeduserid' => new external_value( PARAM_INT, 'The ID of the user show', VALUE_REQUIRED ), 'notifyuser' => new external_value( PARAM_BOOL, 'Wheteher to notify the user or not', VALUE_DEFAULT, false ), 'formdata' => new external_value( PARAM_RAW, 'The serialised form data representing the grade', VALUE_REQUIRED ), ]); } /** * Fetch the data required to build a grading panel for a simple grade. * * @param string $component * @param int $contextid * @param string $itemname * @param int $gradeduserid * @param bool $notifyuser * @param string $formdata * @return array * @throws \dml_exception * @throws \invalid_parameter_exception * @throws \restricted_context_exception * @throws coding_exception * @throws moodle_exception * @since Moodle 3.8 */ public static function execute(string $component, int $contextid, string $itemname, int $gradeduserid, bool $notifyuser, string $formdata): array { global $USER, $CFG; require_once("{$CFG->libdir}/gradelib.php"); [ 'component' => $component, 'contextid' => $contextid, 'itemname' => $itemname, 'gradeduserid' => $gradeduserid, 'notifyuser' => $notifyuser, 'formdata' => $formdata, ] = self::validate_parameters(self::execute_parameters(), [ 'component' => $component, 'contextid' => $contextid, 'itemname' => $itemname, 'gradeduserid' => $gradeduserid, 'notifyuser' => $notifyuser, 'formdata' => $formdata, ]); // Validate the context. $context = context::instance_by_id($contextid); self::validate_context($context); // Validate that the supplied itemname is a gradable item. if (!component_gradeitems::is_valid_itemname($component, $itemname)) { throw new coding_exception("The '{$itemname}' item is not valid for the '{$component}' component"); } // Fetch the gradeitem instance. $gradeitem = gradeitem::instance($component, $context, $itemname); // Validate that this gradeitem is actually enabled. if (!$gradeitem->is_grading_enabled()) { throw new moodle_exception("Grading is not enabled for {$itemname} in this context"); } // Fetch the record for the graded user. $gradeduser = \core_user::get_user($gradeduserid); // Require that this user can save grades. $gradeitem->require_user_can_grade($gradeduser, $USER); if (!$gradeitem->is_using_direct_grading()) { throw new moodle_exception("The {$itemname} item in {$component}/{$contextid} is not configured for direct grading"); } // Parse the serialised string into an object. $data = []; parse_str($formdata, $data); // Grade. $gradeitem->store_grade_from_formdata($gradeduser, $USER, (object) $data); $hasgrade = $gradeitem->user_has_grade($gradeduser); // Notify. if ($notifyuser) { // Send notification. $gradeitem->send_student_notification($gradeduser, $USER); } // Fetch the updated grade back out. $grade = $gradeitem->get_formatted_grade_for_user($gradeduser, $USER); $gradegrade = \grade_grade::fetch(['itemid' => $gradeitem->get_grade_item()->id, 'userid' => $gradeduser->id]); $gradername = $gradegrade ? fullname(\core_user::get_user($gradegrade->usermodified)) : null; return fetch::get_fetch_data($grade, $hasgrade, $gradeitem, $gradername); } /** * Describes the data returned from the external function. * * @return external_single_structure * @since Moodle 3.8 */ public static function execute_returns(): external_single_structure { return fetch::execute_returns(); } } classes/component_gradeitem.php 0000604 00000044061 15062070555 0012743 0 ustar 00 <?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/>. /** * Compontent definition of a gradeitem. * * @package core_grades * @copyright Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ declare(strict_types = 1); namespace core_grades; use context; use gradingform_controller; use gradingform_instance; use moodle_exception; use stdClass; use grade_item as core_gradeitem; use grading_manager; /** * Compontent definition of a gradeitem. * * @package core_grades * @copyright Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ abstract class component_gradeitem { /** @var array The scale data for the current grade item */ protected $scale; /** @var string The component */ protected $component; /** @var context The context for this activity */ protected $context; /** @var string The item name */ protected $itemname; /** @var int The grade itemnumber */ protected $itemnumber; /** * component_gradeitem constructor. * * @param string $component * @param context $context * @param string $itemname * @throws \coding_exception */ final protected function __construct(string $component, context $context, string $itemname) { $this->component = $component; $this->context = $context; $this->itemname = $itemname; $this->itemnumber = component_gradeitems::get_itemnumber_from_itemname($component, $itemname); } /** * Fetch an instance of a specific component_gradeitem. * * @param string $component * @param context $context * @param string $itemname * @return self */ public static function instance(string $component, context $context, string $itemname): self { $itemnumber = component_gradeitems::get_itemnumber_from_itemname($component, $itemname); $classname = "{$component}\\grades\\{$itemname}_gradeitem"; if (!class_exists($classname)) { throw new \coding_exception("Unknown gradeitem {$itemname} for component {$classname}"); } return $classname::load_from_context($context); } /** * Load an instance of the current component_gradeitem based on context. * * @param context $context * @return self */ abstract public static function load_from_context(context $context): self; /** * The table name used for grading. * * @return string */ abstract protected function get_table_name(): string; /** * Get the itemid for the current gradeitem. * * @return int */ public function get_grade_itemid(): int { return component_gradeitems::get_itemnumber_from_itemname($this->component, $this->itemname); } /** * Whether grading is enabled for this item. * * @return bool */ abstract public function is_grading_enabled(): bool; /** * Get the grade value for this instance. * The itemname is translated to the relevant grade field for the activity. * * @return int */ abstract protected function get_gradeitem_value(): ?int; /** * Whether the grader can grade the gradee. * * @param stdClass $gradeduser The user being graded * @param stdClass $grader The user who is grading * @return bool */ abstract public function user_can_grade(stdClass $gradeduser, stdClass $grader): bool; /** * Require that the user can grade, throwing an exception if not. * * @param stdClass $gradeduser The user being graded * @param stdClass $grader The user who is grading * @throws \required_capability_exception */ abstract public function require_user_can_grade(stdClass $gradeduser, stdClass $grader): void; /** * Get the scale if a scale is being used. * * @return stdClass */ protected function get_scale(): ?stdClass { global $DB; $gradetype = $this->get_gradeitem_value(); if ($gradetype > 0) { return null; } // This is a scale. if (null === $this->scale) { $this->scale = $DB->get_record('scale', ['id' => -1 * $gradetype]); } return $this->scale; } /** * Check whether a scale is being used for this grade item. * * @return bool */ public function is_using_scale(): bool { $gradetype = $this->get_gradeitem_value(); return $gradetype < 0; } /** * Whether this grade item is configured to use direct grading. * * @return bool */ public function is_using_direct_grading(): bool { if ($this->is_using_scale()) { return false; } if ($this->get_advanced_grading_controller()) { return false; } return true; } /** * Whether this grade item is configured to use advanced grading. * * @return bool */ public function is_using_advanced_grading(): bool { if ($this->is_using_scale()) { return false; } if ($this->get_advanced_grading_controller()) { return true; } return false; } /** * Get the name of the advanced grading method. * * @return string */ public function get_advanced_grading_method(): ?string { $gradingmanager = $this->get_grading_manager(); if (empty($gradingmanager)) { return null; } return $gradingmanager->get_active_method(); } /** * Get the name of the component responsible for grading this gradeitem. * * @return string */ public function get_grading_component_name(): ?string { if (!$this->is_grading_enabled()) { return null; } if ($method = $this->get_advanced_grading_method()) { return "gradingform_{$method}"; } return 'core_grades'; } /** * Get the name of the component subtype responsible for grading this gradeitem. * * @return string */ public function get_grading_component_subtype(): ?string { if (!$this->is_grading_enabled()) { return null; } if ($method = $this->get_advanced_grading_method()) { return null; } if ($this->is_using_scale()) { return 'scale'; } return 'point'; } /** * Whether decimals are allowed. * * @return bool */ protected function allow_decimals(): bool { return $this->get_gradeitem_value() > 0; } /** * Get the grading manager for this advanced grading definition. * * @return grading_manager */ protected function get_grading_manager(): ?grading_manager { require_once(__DIR__ . '/../grading/lib.php'); return get_grading_manager($this->context, $this->component, $this->itemname); } /** * Get the advanced grading controller if advanced grading is enabled. * * @return gradingform_controller */ protected function get_advanced_grading_controller(): ?gradingform_controller { $gradingmanager = $this->get_grading_manager(); if (empty($gradingmanager)) { return null; } if ($gradingmethod = $gradingmanager->get_active_method()) { return $gradingmanager->get_controller($gradingmethod); } return null; } /** * Get the list of available grade items. * * @return array */ public function get_grade_menu(): array { return make_grades_menu($this->get_gradeitem_value()); } /** * Check whether the supplied grade is valid and throw an exception if not. * * @param float $grade The value being checked * @throws moodle_exception * @return bool */ public function check_grade_validity(?float $grade): bool { $grade = grade_floatval(unformat_float($grade)); if ($grade) { if ($this->is_using_scale()) { // Fetch all options for this scale. $scaleoptions = make_menu_from_list($this->get_scale()->scale); if ($grade != -1 && !array_key_exists((int) $grade, $scaleoptions)) { // The selected option did not exist. throw new moodle_exception('error:notinrange', 'core_grading', '', (object) [ 'maxgrade' => count($scaleoptions), 'grade' => $grade, ]); } } else if ($grade) { $maxgrade = $this->get_gradeitem_value(); if ($grade > $maxgrade) { // The grade is greater than the maximum possible value. throw new moodle_exception('error:notinrange', 'core_grading', '', (object) [ 'maxgrade' => $maxgrade, 'grade' => $grade, ]); } else if ($grade < 0) { // Negative grades are not supported. throw new moodle_exception('error:notinrange', 'core_grading', '', (object) [ 'maxgrade' => $maxgrade, 'grade' => $grade, ]); } } } return true; } /** * Create an empty row in the grade for the specified user and grader. * * @param stdClass $gradeduser The user being graded * @param stdClass $grader The user who is grading * @return stdClass The newly created grade record */ abstract public function create_empty_grade(stdClass $gradeduser, stdClass $grader): stdClass; /** * Get the grade record for the specified grade id. * * @param int $gradeid * @return stdClass * @throws \dml_exception */ public function get_grade(int $gradeid): stdClass { global $DB; return $DB->get_record($this->get_table_name(), ['id' => $gradeid]); } /** * Get the grade for the specified user. * * @param stdClass $gradeduser The user being graded * @param stdClass $grader The user who is grading * @return stdClass The grade value */ abstract public function get_grade_for_user(stdClass $gradeduser, stdClass $grader): ?stdClass; /** * Returns the grade that should be displayed to the user. * * The grade does not necessarily return a float value, this method takes grade settings into considering so * the correct value be shown, eg. a float vs a letter. * * @param stdClass $gradeduser * @param stdClass $grader * @return stdClass|null */ public function get_formatted_grade_for_user(stdClass $gradeduser, stdClass $grader): ?stdClass { global $DB; if ($grade = $this->get_grade_for_user($gradeduser, $grader)) { $gradeitem = $this->get_grade_item(); if (!$this->is_using_scale()) { $grade->grade = !is_null($grade->grade) ? (float)$grade->grade : null; // Cast non-null values, keeping nulls. $grade->usergrade = grade_format_gradevalue($grade->grade, $gradeitem); $grade->maxgrade = format_float($gradeitem->grademax, $gradeitem->get_decimals()); // If displaying the raw grade, also display the total value. if ($gradeitem->get_displaytype() == GRADE_DISPLAY_TYPE_REAL) { $grade->usergrade .= ' / ' . $grade->maxgrade; } } else { $grade->usergrade = '-'; if ($scale = $DB->get_record('scale', ['id' => $gradeitem->scaleid])) { $options = make_menu_from_list($scale->scale); $gradeint = (int) $grade->grade; if (isset($options[$gradeint])) { $grade->usergrade = $options[$gradeint]; } } $grade->maxgrade = format_float($gradeitem->grademax, $gradeitem->get_decimals()); } return $grade; } return null; } /** * Get the grade status for the specified user. * If the user has a grade as defined by the implementor return true else return false. * * @param stdClass $gradeduser The user being graded * @return bool The grade status */ abstract public function user_has_grade(stdClass $gradeduser): bool; /** * Get grades for all users for the specified gradeitem. * * @return stdClass[] The grades */ abstract public function get_all_grades(): array; /** * Get the grade item instance id. * * This is typically the cmid in the case of an activity, and relates to the iteminstance field in the grade_items * table. * * @return int */ abstract public function get_grade_instance_id(): int; /** * Get the core grade item from the current component grade item. * This is mainly used to access the max grade for a gradeitem * * @return \grade_item The grade item */ public function get_grade_item(): \grade_item { global $CFG; require_once("{$CFG->libdir}/gradelib.php"); [$itemtype, $itemmodule] = \core_component::normalize_component($this->component); $gradeitem = \grade_item::fetch([ 'itemtype' => $itemtype, 'itemmodule' => $itemmodule, 'itemnumber' => $this->itemnumber, 'iteminstance' => $this->get_grade_instance_id(), ]); return $gradeitem; } /** * Create or update the grade. * * @param stdClass $grade * @return bool Success */ abstract protected function store_grade(stdClass $grade): bool; /** * Create or update the grade. * * @param stdClass $gradeduser The user being graded * @param stdClass $grader The user who is grading * @param stdClass $formdata The data submitted * @return bool Success */ public function store_grade_from_formdata(stdClass $gradeduser, stdClass $grader, stdClass $formdata): bool { // Require gradelib for grade_floatval. require_once(__DIR__ . '/../../lib/gradelib.php'); $grade = $this->get_grade_for_user($gradeduser, $grader); if ($this->is_using_advanced_grading()) { $instanceid = $formdata->instanceid; $gradinginstance = $this->get_advanced_grading_instance($grader, $grade, (int) $instanceid); $grade->grade = $gradinginstance->submit_and_get_grade($formdata->advancedgrading, $grade->id); if ($grade->grade == -1) { // In advanced grading, a value of -1 means no data. return false; } } else { // Handle the case when grade is set to No Grade. if (isset($formdata->grade)) { $grade->grade = grade_floatval(unformat_float($formdata->grade)); } } return $this->store_grade($grade); } /** * Get the advanced grading instance for the specified grade entry. * * @param stdClass $grader The user who is grading * @param stdClass $grade The row from the grade table. * @param int $instanceid The instanceid of the advanced grading form * @return gradingform_instance */ public function get_advanced_grading_instance(stdClass $grader, stdClass $grade, int $instanceid = null): ?gradingform_instance { $controller = $this->get_advanced_grading_controller($this->itemname); if (empty($controller)) { // Advanced grading not enabeld for this item. return null; } if (!$controller->is_form_available()) { // The form is not available for this item. return null; } // Fetch the instance for the specified graderid/itemid. $gradinginstance = $controller->fetch_instance( (int) $grader->id, (int) $grade->id, $instanceid ); // Set the allowed grade range. $gradinginstance->get_controller()->set_grade_range( $this->get_grade_menu(), $this->allow_decimals() ); return $gradinginstance; } /** * Sends a notification about the item being graded for the student. * * @param stdClass $gradeduser The user being graded * @param stdClass $grader The user who is grading */ public function send_student_notification(stdClass $gradeduser, stdClass $grader): void { $contextname = $this->context->get_context_name(); $eventdata = new \core\message\message(); $eventdata->courseid = $this->context->get_course_context()->instanceid; $eventdata->component = 'moodle'; $eventdata->name = 'gradenotifications'; $eventdata->userfrom = $grader; $eventdata->userto = $gradeduser; $eventdata->subject = get_string('gradenotificationsubject', 'grades'); $eventdata->fullmessage = get_string('gradenotificationmessage', 'grades', $contextname); $eventdata->contexturl = $this->context->get_url(); $eventdata->contexturlname = $contextname; $eventdata->fullmessageformat = FORMAT_HTML; $eventdata->fullmessagehtml = ''; $eventdata->smallmessage = ''; $eventdata->notification = 1; message_send($eventdata); } } classes/privacy/provider.php 0000604 00000003016 15062070555 0012222 0 ustar 00 <?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/>. /** * Privacy Subsystem implementation for availability_grade. * * @package availability_grade * @copyright 2018 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace availability_grade\privacy; defined('MOODLE_INTERNAL') || die(); /** * Privacy Subsystem for availability_grade implementing null_provider. * * @copyright 2018 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class provider implements \core_privacy\local\metadata\null_provider { /** * Get the language string identifier with the component's language * file to explain why this plugin stores no data. * * @return string */ public static function get_reason() : string { return 'privacy:metadata'; } } classes/privacy/grade_grade_with_history.php 0000604 00000002477 15062070555 0015442 0 ustar 00 <?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/>. namespace core_grades\privacy; use grade_grade; /** * A grade_item which has a reference to its historical content. * * @package core_grades * @category grade * @copyright 2023 Andrew Lyons <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class grade_grade_with_history extends grade_grade { public int $historyid; public function __construct(\stdClass $params = null, $fetch = true) { // The grade history is not a real grade_grade so we remove the ID. $this->historyid = $params->id; unset($params->id); parent::__construct($params, $fetch); } } classes/component_gradeitems.php 0000604 00000017347 15062070555 0013135 0 ustar 00 <?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/>. /** * Helper class to fetch information about component grade items. * * @package core_grades * @copyright Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ declare(strict_types = 1); namespace core_grades; use code_grades\local\gradeitem\itemnumber_mapping; use code_grades\local\gradeitem\advancedgrading_mapping; /** * Helper class to fetch information about component grade items. * * @package core_grades * @copyright Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class component_gradeitems { /** * Get the gradeitems classname for the specific component. * * @param string $component The component to fetch the classname for * @return string The composed classname */ protected static function get_component_classname(string $component): string { return "{$component}\\grades\gradeitems"; } /** * Get the grade itemnumber mapping for a component. * * @param string $component The component that the grade item belongs to * @return array */ public static function get_itemname_mapping_for_component(string $component): array { $classname = "{$component}\\grades\gradeitems"; if (!class_exists($classname)) { return [ 0 => '', ]; } if (!is_subclass_of($classname, 'core_grades\local\gradeitem\itemnumber_mapping')) { throw new \coding_exception("The {$classname} class does not implement " . itemnumber_mapping::class); } return $classname::get_itemname_mapping_for_component(); } /** * Whether the named grading item exists. * * @param string $component * @param string $itemname * @return bool */ public static function is_valid_itemname(string $component, string $itemname): bool { $items = self::get_itemname_mapping_for_component($component); return array_search($itemname, $items) !== false; } /** * Check whether the component class defines the advanced grading items. * * @param string $component The component to check * @return bool */ public static function defines_advancedgrading_itemnames_for_component(string $component): bool { return is_subclass_of(self::get_component_classname($component), 'core_grades\local\gradeitem\advancedgrading_mapping'); } /** * Get the list of advanced grading item names for the named component. * * @param string $component * @return array */ public static function get_advancedgrading_itemnames_for_component(string $component): array { $classname = self::get_component_classname($component); if (!self::defines_advancedgrading_itemnames_for_component($component)) { throw new \coding_exception("The {$classname} class does not implement " . advancedgrading_mapping::class); } return $classname::get_advancedgrading_itemnames(); } /** * Whether the named grading item name supports advanced grading. * * @param string $component * @param string $itemname * @return bool */ public static function is_advancedgrading_itemname(string $component, string $itemname): bool { $gradingareas = self::get_advancedgrading_itemnames_for_component($component); return array_search($itemname, $gradingareas) !== false; } /** * Get the suffixed field name for an activity field mapped from its itemnumber. * * For legacy reasons, the first itemnumber has no suffix on field names. * * @param string $component The component that the grade item belongs to * @param int $itemnumber The grade itemnumber * @param string $fieldname The name of the field to be rewritten * @return string The translated field name */ public static function get_field_name_for_itemnumber(string $component, int $itemnumber, string $fieldname): string { $classname = "{$component}\grades\gradeitems"; if (class_exists($classname) && is_subclass_of($classname, 'core_grades\local\gradeitem\fieldname_mapping')) { $fieldname = $classname::get_field_name_for_itemnumber($component, $itemnumber, $fieldname); } else { $itemname = static::get_itemname_from_itemnumber($component, $itemnumber); if ($itemname) { $fieldname .= '_' . $itemname; } } return $fieldname; } /** * Get the suffixed field name for an activity field mapped from its itemnumber. * * For legacy reasons, the first itemnumber has no suffix on field names. * * @param string $component The component that the grade item belongs to * @param string $itemname The grade itemname * @param string $fieldname The name of the field to be rewritten * @return string The translated field name */ public static function get_field_name_for_itemname(string $component, string $itemname, string $fieldname): string { if (empty($itemname)) { return $fieldname; } $itemnumber = static::get_itemnumber_from_itemname($component, $itemname); if ($itemnumber > 0) { return "{$fieldname}_{$itemname}"; } return $fieldname; } /** * Get the itemname for an itemnumber. * * For legacy compatability when the itemnumber is 0, the itemname will always be empty. * * @param string $component The component that the grade item belongs to * @param int $itemnumber The grade itemnumber * @return int The grade itemnumber of the itemname */ public static function get_itemname_from_itemnumber(string $component, int $itemnumber): string { if ($itemnumber === 0) { return ''; } $mappings = self::get_itemname_mapping_for_component($component); if (isset($mappings[$itemnumber])) { return $mappings[$itemnumber]; } if ($itemnumber >= 1000) { // An itemnumber >= 1000 belongs to an outcome. return ''; } throw new \coding_exception("Unknown itemnumber mapping for {$itemnumber} in {$component}"); } /** * Get the itemnumber for a item name. * * For legacy compatability when the itemname is empty, the itemnumber will always be 0. * * @param string $component The component that the grade item belongs to * @param string $itemname The grade itemname * @return int The grade itemname of the itemnumber */ public static function get_itemnumber_from_itemname(string $component, string $itemname): int { if (empty($itemname)) { return 0; } $mappings = self::get_itemname_mapping_for_component($component); $flipped = array_flip($mappings); if (isset($flipped[$itemname])) { return $flipped[$itemname]; } throw new \coding_exception("Unknown itemnumber mapping for {$itemname} in {$component}"); } } classes/local/gradeitem/advancedgrading_mapping.php 0000604 00000002417 15062070555 0016566 0 ustar 00 <?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/>. /** * Grade item, itemnumber mapping. * * @package core_grades * @copyright Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ declare(strict_types = 1); namespace core_grades\local\gradeitem; /** * Grade item, itemnumber mapping. * * @package core_grades * @copyright Andrew Nicols <andrew@nicols.co.uk> */ interface advancedgrading_mapping { /** * Get the list of advanced grading item names for this component. * * @return array */ public static function get_advancedgrading_itemnames(): array; } classes/local/gradeitem/itemnumber_mapping.php 0000604 00000002407 15062070555 0015633 0 ustar 00 <?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/>. /** * Grade item, itemnumber mapping. * * @package core_grades * @copyright Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ declare(strict_types = 1); namespace core_grades\local\gradeitem; /** * Grade item, itemnumber mapping. * * @package core_grades * @copyright Andrew Nicols <andrew@nicols.co.uk> */ interface itemnumber_mapping { /** * Get the grade item mapping of item number to item name. * * @return array */ public static function get_itemname_mapping_for_component(): array; } classes/local/gradeitem/fieldname_mapping.php 0000604 00000003215 15062070555 0015406 0 ustar 00 <?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/>. /** * Grade item, fieldname mapping. * * @package core_grades * @copyright Ilya Tregubov <ilya.a.tregubov@gmail.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ declare(strict_types = 1); namespace core_grades\local\gradeitem; /** * Grade item, fieldname mapping. * * @package core_grades * @copyright Ilya Tregubov <ilya.a.tregubov@gmail.com> */ interface fieldname_mapping { /** * Get the suffixed field name for an activity field mapped from its itemnumber. * * For legacy reasons, the first itemnumber has no suffix on field names. * * @param string $component The component that the grade item belongs to * @param int $itemnumber The grade itemnumber * @param string $fieldname The name of the field to be rewritten * @return string The translated field name */ public static function get_field_name_for_itemnumber(string $component, int $itemnumber, string $fieldname): string; } lib.php 0000604 00000455446 15062070555 0006046 0 ustar 00 <?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/>. /** * Functions used by gradebook plugins and reports. * * @package core_grades * @copyright 2009 Petr Skoda and Nicolas Connault * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once($CFG->libdir . '/gradelib.php'); require_once($CFG->dirroot . '/grade/export/lib.php'); use \core_grades\output\action_bar; use \core_grades\output\general_action_bar; /** * This class iterates over all users that are graded in a course. * Returns detailed info about users and their grades. * * @author Petr Skoda <skodak@moodle.org> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class graded_users_iterator { /** * The couse whose users we are interested in */ protected $course; /** * An array of grade items or null if only user data was requested */ protected $grade_items; /** * The group ID we are interested in. 0 means all groups. */ protected $groupid; /** * A recordset of graded users */ protected $users_rs; /** * A recordset of user grades (grade_grade instances) */ protected $grades_rs; /** * Array used when moving to next user while iterating through the grades recordset */ protected $gradestack; /** * The first field of the users table by which the array of users will be sorted */ protected $sortfield1; /** * Should sortfield1 be ASC or DESC */ protected $sortorder1; /** * The second field of the users table by which the array of users will be sorted */ protected $sortfield2; /** * Should sortfield2 be ASC or DESC */ protected $sortorder2; /** * Should users whose enrolment has been suspended be ignored? */ protected $onlyactive = false; /** * Enable user custom fields */ protected $allowusercustomfields = false; /** * List of suspended users in course. This includes users whose enrolment status is suspended * or enrolment has expired or not started. */ protected $suspendedusers = array(); /** * Constructor * * @param object $course A course object * @param array $grade_items array of grade items, if not specified only user info returned * @param int $groupid iterate only group users if present * @param string $sortfield1 The first field of the users table by which the array of users will be sorted * @param string $sortorder1 The order in which the first sorting field will be sorted (ASC or DESC) * @param string $sortfield2 The second field of the users table by which the array of users will be sorted * @param string $sortorder2 The order in which the second sorting field will be sorted (ASC or DESC) */ public function __construct($course, $grade_items=null, $groupid=0, $sortfield1='lastname', $sortorder1='ASC', $sortfield2='firstname', $sortorder2='ASC') { $this->course = $course; $this->grade_items = $grade_items; $this->groupid = $groupid; $this->sortfield1 = $sortfield1; $this->sortorder1 = $sortorder1; $this->sortfield2 = $sortfield2; $this->sortorder2 = $sortorder2; $this->gradestack = array(); } /** * Initialise the iterator * * @return boolean success */ public function init() { global $CFG, $DB; $this->close(); export_verify_grades($this->course->id); $course_item = grade_item::fetch_course_item($this->course->id); if ($course_item->needsupdate) { // Can not calculate all final grades - sorry. return false; } $coursecontext = context_course::instance($this->course->id); list($relatedctxsql, $relatedctxparams) = $DB->get_in_or_equal($coursecontext->get_parent_context_ids(true), SQL_PARAMS_NAMED, 'relatedctx'); list($gradebookroles_sql, $params) = $DB->get_in_or_equal(explode(',', $CFG->gradebookroles), SQL_PARAMS_NAMED, 'grbr'); list($enrolledsql, $enrolledparams) = get_enrolled_sql($coursecontext, '', 0, $this->onlyactive); $params = array_merge($params, $enrolledparams, $relatedctxparams); if ($this->groupid) { $groupsql = "INNER JOIN {groups_members} gm ON gm.userid = u.id"; $groupwheresql = "AND gm.groupid = :groupid"; // $params contents: gradebookroles $params['groupid'] = $this->groupid; } else { $groupsql = ""; $groupwheresql = ""; } if (empty($this->sortfield1)) { // We must do some sorting even if not specified. $ofields = ", u.id AS usrt"; $order = "usrt ASC"; } else { $ofields = ", u.$this->sortfield1 AS usrt1"; $order = "usrt1 $this->sortorder1"; if (!empty($this->sortfield2)) { $ofields .= ", u.$this->sortfield2 AS usrt2"; $order .= ", usrt2 $this->sortorder2"; } if ($this->sortfield1 != 'id' and $this->sortfield2 != 'id') { // User order MUST be the same in both queries, // must include the only unique user->id if not already present. $ofields .= ", u.id AS usrt"; $order .= ", usrt ASC"; } } $userfields = 'u.*'; $customfieldssql = ''; if ($this->allowusercustomfields && !empty($CFG->grade_export_customprofilefields)) { $customfieldscount = 0; $customfieldsarray = grade_helper::get_user_profile_fields($this->course->id, $this->allowusercustomfields); foreach ($customfieldsarray as $field) { if (!empty($field->customid)) { $customfieldssql .= " LEFT JOIN (SELECT * FROM {user_info_data} WHERE fieldid = :cf$customfieldscount) cf$customfieldscount ON u.id = cf$customfieldscount.userid"; $userfields .= ", cf$customfieldscount.data AS customfield_{$field->customid}"; $params['cf'.$customfieldscount] = $field->customid; $customfieldscount++; } } } $users_sql = "SELECT $userfields $ofields FROM {user} u JOIN ($enrolledsql) je ON je.id = u.id $groupsql $customfieldssql JOIN ( SELECT DISTINCT ra.userid FROM {role_assignments} ra WHERE ra.roleid $gradebookroles_sql AND ra.contextid $relatedctxsql ) rainner ON rainner.userid = u.id WHERE u.deleted = 0 $groupwheresql ORDER BY $order"; $this->users_rs = $DB->get_recordset_sql($users_sql, $params); if (!$this->onlyactive) { $context = context_course::instance($this->course->id); $this->suspendedusers = get_suspended_userids($context); } else { $this->suspendedusers = array(); } if (!empty($this->grade_items)) { $itemids = array_keys($this->grade_items); list($itemidsql, $grades_params) = $DB->get_in_or_equal($itemids, SQL_PARAMS_NAMED, 'items'); $params = array_merge($params, $grades_params); $grades_sql = "SELECT g.* $ofields FROM {grade_grades} g JOIN {user} u ON g.userid = u.id JOIN ($enrolledsql) je ON je.id = u.id $groupsql JOIN ( SELECT DISTINCT ra.userid FROM {role_assignments} ra WHERE ra.roleid $gradebookroles_sql AND ra.contextid $relatedctxsql ) rainner ON rainner.userid = u.id WHERE u.deleted = 0 AND g.itemid $itemidsql $groupwheresql ORDER BY $order, g.itemid ASC"; $this->grades_rs = $DB->get_recordset_sql($grades_sql, $params); } else { $this->grades_rs = false; } return true; } /** * Returns information about the next user * @return mixed array of user info, all grades and feedback or null when no more users found */ public function next_user() { if (!$this->users_rs) { return false; // no users present } if (!$this->users_rs->valid()) { if ($current = $this->_pop()) { // this is not good - user or grades updated between the two reads above :-( } return false; // no more users } else { $user = $this->users_rs->current(); $this->users_rs->next(); } // find grades of this user $grade_records = array(); while (true) { if (!$current = $this->_pop()) { break; // no more grades } if (empty($current->userid)) { break; } if ($current->userid != $user->id) { // grade of the next user, we have all for this user $this->_push($current); break; } $grade_records[$current->itemid] = $current; } $grades = array(); $feedbacks = array(); if (!empty($this->grade_items)) { foreach ($this->grade_items as $grade_item) { if (!isset($feedbacks[$grade_item->id])) { $feedbacks[$grade_item->id] = new stdClass(); } if (array_key_exists($grade_item->id, $grade_records)) { $feedbacks[$grade_item->id]->feedback = $grade_records[$grade_item->id]->feedback; $feedbacks[$grade_item->id]->feedbackformat = $grade_records[$grade_item->id]->feedbackformat; unset($grade_records[$grade_item->id]->feedback); unset($grade_records[$grade_item->id]->feedbackformat); $grades[$grade_item->id] = new grade_grade($grade_records[$grade_item->id], false); } else { $feedbacks[$grade_item->id]->feedback = ''; $feedbacks[$grade_item->id]->feedbackformat = FORMAT_MOODLE; $grades[$grade_item->id] = new grade_grade(array('userid'=>$user->id, 'itemid'=>$grade_item->id), false); } $grades[$grade_item->id]->grade_item = $grade_item; } } // Set user suspended status. $user->suspendedenrolment = isset($this->suspendedusers[$user->id]); $result = new stdClass(); $result->user = $user; $result->grades = $grades; $result->feedbacks = $feedbacks; return $result; } /** * Close the iterator, do not forget to call this function */ public function close() { if ($this->users_rs) { $this->users_rs->close(); $this->users_rs = null; } if ($this->grades_rs) { $this->grades_rs->close(); $this->grades_rs = null; } $this->gradestack = array(); } /** * Should all enrolled users be exported or just those with an active enrolment? * * @param bool $onlyactive True to limit the export to users with an active enrolment */ public function require_active_enrolment($onlyactive = true) { if (!empty($this->users_rs)) { debugging('Calling require_active_enrolment() has no effect unless you call init() again', DEBUG_DEVELOPER); } $this->onlyactive = $onlyactive; } /** * Allow custom fields to be included * * @param bool $allow Whether to allow custom fields or not * @return void */ public function allow_user_custom_fields($allow = true) { if ($allow) { $this->allowusercustomfields = true; } else { $this->allowusercustomfields = false; } } /** * Add a grade_grade instance to the grade stack * * @param grade_grade $grade Grade object * * @return void */ private function _push($grade) { array_push($this->gradestack, $grade); } /** * Remove a grade_grade instance from the grade stack * * @return grade_grade current grade object */ private function _pop() { global $DB; if (empty($this->gradestack)) { if (empty($this->grades_rs) || !$this->grades_rs->valid()) { return null; // no grades present } $current = $this->grades_rs->current(); $this->grades_rs->next(); return $current; } else { return array_pop($this->gradestack); } } } /** * Print a selection popup form of the graded users in a course. * * @deprecated since 2.0 * * @param int $course id of the course * @param string $actionpage The page receiving the data from the popoup form * @param int $userid id of the currently selected user (or 'all' if they are all selected) * @param int $groupid id of requested group, 0 means all * @param int $includeall bool include all option * @param bool $return If true, will return the HTML, otherwise, will print directly * @return null */ function print_graded_users_selector($course, $actionpage, $userid=0, $groupid=0, $includeall=true, $return=false) { global $CFG, $USER, $OUTPUT; return $OUTPUT->render(grade_get_graded_users_select(substr($actionpage, 0, strpos($actionpage, '/')), $course, $userid, $groupid, $includeall)); } function grade_get_graded_users_select($report, $course, $userid, $groupid, $includeall) { global $USER, $CFG; if (is_null($userid)) { $userid = $USER->id; } $coursecontext = context_course::instance($course->id); $defaultgradeshowactiveenrol = !empty($CFG->grade_report_showonlyactiveenrol); $showonlyactiveenrol = get_user_preferences('grade_report_showonlyactiveenrol', $defaultgradeshowactiveenrol); $showonlyactiveenrol = $showonlyactiveenrol || !has_capability('moodle/course:viewsuspendedusers', $coursecontext); $menu = array(); // Will be a list of userid => user name $menususpendedusers = array(); // Suspended users go to a separate optgroup. $gui = new graded_users_iterator($course, null, $groupid); $gui->require_active_enrolment($showonlyactiveenrol); $gui->init(); $label = get_string('selectauser', 'grades'); if ($includeall) { $menu[0] = get_string('allusers', 'grades'); $label = get_string('selectalloroneuser', 'grades'); } while ($userdata = $gui->next_user()) { $user = $userdata->user; $userfullname = fullname($user); if ($user->suspendedenrolment) { $menususpendedusers[$user->id] = $userfullname; } else { $menu[$user->id] = $userfullname; } } $gui->close(); if ($includeall) { $menu[0] .= " (" . (count($menu) + count($menususpendedusers) - 1) . ")"; } if (!empty($menususpendedusers)) { $menu[] = array(get_string('suspendedusers') => $menususpendedusers); } $gpr = new grade_plugin_return(array('type' => 'report', 'course' => $course, 'groupid' => $groupid)); $select = new single_select( new moodle_url('/grade/report/'.$report.'/index.php', $gpr->get_options()), 'userid', $menu, $userid ); $select->label = $label; $select->formid = 'choosegradeuser'; return $select; } /** * Hide warning about changed grades during upgrade to 2.8. * * @param int $courseid The current course id. */ function hide_natural_aggregation_upgrade_notice($courseid) { unset_config('show_sumofgrades_upgrade_' . $courseid); } /** * Hide warning about changed grades during upgrade from 2.8.0-2.8.6 and 2.9.0. * * @param int $courseid The current course id. */ function grade_hide_min_max_grade_upgrade_notice($courseid) { unset_config('show_min_max_grades_changed_' . $courseid); } /** * Use the grade min and max from the grade_grade. * * This is reserved for core use after an upgrade. * * @param int $courseid The current course id. */ function grade_upgrade_use_min_max_from_grade_grade($courseid) { grade_set_setting($courseid, 'minmaxtouse', GRADE_MIN_MAX_FROM_GRADE_GRADE); grade_force_full_regrading($courseid); // Do this now, because it probably happened to late in the page load to be happen automatically. grade_regrade_final_grades($courseid); } /** * Use the grade min and max from the grade_item. * * This is reserved for core use after an upgrade. * * @param int $courseid The current course id. */ function grade_upgrade_use_min_max_from_grade_item($courseid) { grade_set_setting($courseid, 'minmaxtouse', GRADE_MIN_MAX_FROM_GRADE_ITEM); grade_force_full_regrading($courseid); // Do this now, because it probably happened to late in the page load to be happen automatically. grade_regrade_final_grades($courseid); } /** * Hide warning about changed grades during upgrade to 2.8. * * @param int $courseid The current course id. */ function hide_aggregatesubcats_upgrade_notice($courseid) { unset_config('show_aggregatesubcats_upgrade_' . $courseid); } /** * Hide warning about changed grades due to bug fixes * * @param int $courseid The current course id. */ function hide_gradebook_calculations_freeze_notice($courseid) { unset_config('gradebook_calculations_freeze_' . $courseid); } /** * Print warning about changed grades during upgrade to 2.8. * * @param int $courseid The current course id. * @param context $context The course context. * @param string $thispage The relative path for the current page. E.g. /grade/report/user/index.php * @param boolean $return return as string * * @return nothing or string if $return true */ function print_natural_aggregation_upgrade_notice($courseid, $context, $thispage, $return=false) { global $CFG, $OUTPUT; $html = ''; // Do not do anything if they cannot manage the grades of this course. if (!has_capability('moodle/grade:manage', $context)) { return $html; } $hidesubcatswarning = optional_param('seenaggregatesubcatsupgradedgrades', false, PARAM_BOOL) && confirm_sesskey(); $showsubcatswarning = get_config('core', 'show_aggregatesubcats_upgrade_' . $courseid); $hidenaturalwarning = optional_param('seensumofgradesupgradedgrades', false, PARAM_BOOL) && confirm_sesskey(); $shownaturalwarning = get_config('core', 'show_sumofgrades_upgrade_' . $courseid); $hideminmaxwarning = optional_param('seenminmaxupgradedgrades', false, PARAM_BOOL) && confirm_sesskey(); $showminmaxwarning = get_config('core', 'show_min_max_grades_changed_' . $courseid); $useminmaxfromgradeitem = optional_param('useminmaxfromgradeitem', false, PARAM_BOOL) && confirm_sesskey(); $useminmaxfromgradegrade = optional_param('useminmaxfromgradegrade', false, PARAM_BOOL) && confirm_sesskey(); $minmaxtouse = grade_get_setting($courseid, 'minmaxtouse', $CFG->grade_minmaxtouse); $gradebookcalculationsfreeze = get_config('core', 'gradebook_calculations_freeze_' . $courseid); $acceptgradebookchanges = optional_param('acceptgradebookchanges', false, PARAM_BOOL) && confirm_sesskey(); // Hide the warning if the user told it to go away. if ($hidenaturalwarning) { hide_natural_aggregation_upgrade_notice($courseid); } // Hide the warning if the user told it to go away. if ($hidesubcatswarning) { hide_aggregatesubcats_upgrade_notice($courseid); } // Hide the min/max warning if the user told it to go away. if ($hideminmaxwarning) { grade_hide_min_max_grade_upgrade_notice($courseid); $showminmaxwarning = false; } if ($useminmaxfromgradegrade) { // Revert to the new behaviour, we now use the grade_grade for min/max. grade_upgrade_use_min_max_from_grade_grade($courseid); grade_hide_min_max_grade_upgrade_notice($courseid); $showminmaxwarning = false; } else if ($useminmaxfromgradeitem) { // Apply the new logic, we now use the grade_item for min/max. grade_upgrade_use_min_max_from_grade_item($courseid); grade_hide_min_max_grade_upgrade_notice($courseid); $showminmaxwarning = false; } if (!$hidenaturalwarning && $shownaturalwarning) { $message = get_string('sumofgradesupgradedgrades', 'grades'); $hidemessage = get_string('upgradedgradeshidemessage', 'grades'); $urlparams = array( 'id' => $courseid, 'seensumofgradesupgradedgrades' => true, 'sesskey' => sesskey()); $goawayurl = new moodle_url($thispage, $urlparams); $goawaybutton = $OUTPUT->single_button($goawayurl, $hidemessage, 'get'); $html .= $OUTPUT->notification($message, 'notifysuccess'); $html .= $goawaybutton; } if (!$hidesubcatswarning && $showsubcatswarning) { $message = get_string('aggregatesubcatsupgradedgrades', 'grades'); $hidemessage = get_string('upgradedgradeshidemessage', 'grades'); $urlparams = array( 'id' => $courseid, 'seenaggregatesubcatsupgradedgrades' => true, 'sesskey' => sesskey()); $goawayurl = new moodle_url($thispage, $urlparams); $goawaybutton = $OUTPUT->single_button($goawayurl, $hidemessage, 'get'); $html .= $OUTPUT->notification($message, 'notifysuccess'); $html .= $goawaybutton; } if ($showminmaxwarning) { $hidemessage = get_string('upgradedgradeshidemessage', 'grades'); $urlparams = array( 'id' => $courseid, 'seenminmaxupgradedgrades' => true, 'sesskey' => sesskey()); $goawayurl = new moodle_url($thispage, $urlparams); $hideminmaxbutton = $OUTPUT->single_button($goawayurl, $hidemessage, 'get'); $moreinfo = html_writer::link(get_docs_url(get_string('minmaxtouse_link', 'grades')), get_string('moreinfo'), array('target' => '_blank')); if ($minmaxtouse == GRADE_MIN_MAX_FROM_GRADE_ITEM) { // Show the message that there were min/max issues that have been resolved. $message = get_string('minmaxupgradedgrades', 'grades') . ' ' . $moreinfo; $revertmessage = get_string('upgradedminmaxrevertmessage', 'grades'); $urlparams = array('id' => $courseid, 'useminmaxfromgradegrade' => true, 'sesskey' => sesskey()); $reverturl = new moodle_url($thispage, $urlparams); $revertbutton = $OUTPUT->single_button($reverturl, $revertmessage, 'get'); $html .= $OUTPUT->notification($message); $html .= $revertbutton . $hideminmaxbutton; } else if ($minmaxtouse == GRADE_MIN_MAX_FROM_GRADE_GRADE) { // Show the warning that there are min/max issues that have not be resolved. $message = get_string('minmaxupgradewarning', 'grades') . ' ' . $moreinfo; $fixmessage = get_string('minmaxupgradefixbutton', 'grades'); $urlparams = array('id' => $courseid, 'useminmaxfromgradeitem' => true, 'sesskey' => sesskey()); $fixurl = new moodle_url($thispage, $urlparams); $fixbutton = $OUTPUT->single_button($fixurl, $fixmessage, 'get'); $html .= $OUTPUT->notification($message); $html .= $fixbutton . $hideminmaxbutton; } } if ($gradebookcalculationsfreeze) { if ($acceptgradebookchanges) { // Accept potential changes in grades caused by extra credit bug MDL-49257. hide_gradebook_calculations_freeze_notice($courseid); $courseitem = grade_item::fetch_course_item($courseid); $courseitem->force_regrading(); grade_regrade_final_grades($courseid); $html .= $OUTPUT->notification(get_string('gradebookcalculationsuptodate', 'grades'), 'notifysuccess'); } else { // Show the warning that there may be extra credit weights problems. $a = new stdClass(); $a->gradebookversion = $gradebookcalculationsfreeze; if (preg_match('/(\d{8,})/', $CFG->release, $matches)) { $a->currentversion = $matches[1]; } else { $a->currentversion = $CFG->release; } $a->url = get_docs_url('Gradebook_calculation_changes'); $message = get_string('gradebookcalculationswarning', 'grades', $a); $fixmessage = get_string('gradebookcalculationsfixbutton', 'grades'); $urlparams = array('id' => $courseid, 'acceptgradebookchanges' => true, 'sesskey' => sesskey()); $fixurl = new moodle_url($thispage, $urlparams); $fixbutton = $OUTPUT->single_button($fixurl, $fixmessage, 'get'); $html .= $OUTPUT->notification($message); $html .= $fixbutton; } } if (!empty($html)) { $html = html_writer::tag('div', $html, array('class' => 'core_grades_notices')); } if ($return) { return $html; } else { echo $html; } } /** * grade_get_plugin_info * * @param int $courseid The course id * @param string $active_type type of plugin on current page - import, export, report or edit * @param string $active_plugin active plugin type - grader, user, cvs, ... * * @return array */ function grade_get_plugin_info($courseid, $active_type, $active_plugin) { global $CFG, $SITE; $context = context_course::instance($courseid); $plugin_info = array(); $count = 0; $active = ''; $url_prefix = $CFG->wwwroot . '/grade/'; // Language strings $plugin_info['strings'] = grade_helper::get_plugin_strings(); if ($reports = grade_helper::get_plugins_reports($courseid)) { $plugin_info['report'] = $reports; } if ($settings = grade_helper::get_info_manage_settings($courseid)) { $plugin_info['settings'] = $settings; } if ($scale = grade_helper::get_info_scales($courseid)) { $plugin_info['scale'] = array('view'=>$scale); } if ($outcomes = grade_helper::get_info_outcomes($courseid)) { $plugin_info['outcome'] = $outcomes; } if ($letters = grade_helper::get_info_letters($courseid)) { $plugin_info['letter'] = $letters; } if ($imports = grade_helper::get_plugins_import($courseid)) { $plugin_info['import'] = $imports; } if ($exports = grade_helper::get_plugins_export($courseid)) { $plugin_info['export'] = $exports; } // Let other plugins add plugins here so that we get extra tabs // in the gradebook. $callbacks = get_plugins_with_function('extend_gradebook_plugininfo', 'lib.php'); foreach ($callbacks as $plugins) { foreach ($plugins as $pluginfunction) { $plugin_info = $pluginfunction($plugin_info, $courseid); } } foreach ($plugin_info as $plugin_type => $plugins) { if (!empty($plugins->id) && $active_plugin == $plugins->id) { $plugin_info['strings']['active_plugin_str'] = $plugins->string; break; } foreach ($plugins as $plugin) { if (is_a($plugin, grade_plugin_info::class)) { if ($plugin_type === $active_type && $active_plugin == $plugin->id) { $plugin_info['strings']['active_plugin_str'] = $plugin->string; } } } } return $plugin_info; } /** * 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 $users A list of enrolled gradable users. */ function get_gradable_users(int $courseid, ?int $groupid = null): array { global $CFG; $context = context_course::instance($courseid); // Create a graded_users_iterator because it will properly check the groups etc. $defaultgradeshowactiveenrol = !empty($CFG->grade_report_showonlyactiveenrol); $onlyactiveenrol = get_user_preferences('grade_report_showonlyactiveenrol', $defaultgradeshowactiveenrol) || !has_capability('moodle/course:viewsuspendedusers', $context); $course = get_course($courseid); $gui = new graded_users_iterator($course, null, $groupid); $gui->require_active_enrolment($onlyactiveenrol); $gui->init(); // Flatten the users. $users = []; while ($user = $gui->next_user()) { $users[$user->user->id] = $user->user; } $gui->close(); return $users; } /** * A simple class containing info about grade plugins. * Can be subclassed for special rules * * @package core_grades * @copyright 2009 Nicolas Connault * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class grade_plugin_info { /** * A unique id for this plugin * * @var mixed */ public $id; /** * A URL to access this plugin * * @var mixed */ public $link; /** * The name of this plugin * * @var mixed */ public $string; /** * Another grade_plugin_info object, parent of the current one * * @var mixed */ public $parent; /** * Constructor * * @param int $id A unique id for this plugin * @param string $link A URL to access this plugin * @param string $string The name of this plugin * @param object $parent Another grade_plugin_info object, parent of the current one * * @return void */ public function __construct($id, $link, $string, $parent=null) { $this->id = $id; $this->link = $link; $this->string = $string; $this->parent = $parent; } } /** * Prints the page headers, breadcrumb trail, page heading, (optional) navigation and for any gradebook page. * All gradebook pages MUST use these functions in favour of the usual print_header(), print_header_simple(), * print_heading() etc. * * @param int $courseid Course id * @param string $active_type The type of the current page (report, settings, * import, export, scales, outcomes, letters) * @param string|null $active_plugin The plugin of the current page (grader, fullview etc...) * @param string|bool $heading The heading of the page. * @param boolean $return Whether to return (true) or echo (false) the HTML generated by this function * @param string|bool $buttons Additional buttons to display on the page * @param boolean $shownavigation should the gradebook navigation be shown? * @param string|null $headerhelpidentifier The help string identifier if required. * @param string|null $headerhelpcomponent The component for the help string. * @param stdClass|null $user The user object for use with the user context header. * @param action_bar|null $actionbar The actions bar which will be displayed on the page if $shownavigation is set * to true. If $actionbar is not explicitly defined, the general action bar * (\core_grades\output\general_action_bar) will be used by default. * @param null $unused This parameter has been deprecated since 4.3 and should not be used anymore. * @return string HTML code or nothing if $return == false */ function print_grade_page_head(int $courseid, string $active_type, ?string $active_plugin = null, string|bool $heading = false, bool $return = false, $buttons = false, bool $shownavigation = true, ?string $headerhelpidentifier = null, ?string $headerhelpcomponent = null, ?stdClass $user = null, ?action_bar $actionbar = null, $unused = null) { global $CFG, $OUTPUT, $PAGE, $USER; if ($unused !== null) { debugging('Deprecated argument passed to ' . __FUNCTION__, DEBUG_DEVELOPER); } // Put a warning on all gradebook pages if the course has modules currently scheduled for background deletion. require_once($CFG->dirroot . '/course/lib.php'); if (course_modules_pending_deletion($courseid, true)) { \core\notification::add(get_string('gradesmoduledeletionpendingwarning', 'grades'), \core\output\notification::NOTIFY_WARNING); } if ($active_type === 'preferences') { // In Moodle 2.8 report preferences were moved under 'settings'. Allow backward compatibility for 3rd party grade reports. $active_type = 'settings'; } $plugin_info = grade_get_plugin_info($courseid, $active_type, $active_plugin); // Determine the string of the active plugin. $stractive_type = $plugin_info['strings'][$active_type]; $stractiveplugin = ($active_plugin) ? $plugin_info['strings']['active_plugin_str'] : $heading; if ($active_type == 'report') { $PAGE->set_pagelayout('report'); } else { $PAGE->set_pagelayout('admin'); } $coursecontext = context_course::instance($courseid); // Title will be constituted by information starting from the unique identifying information for the page. if (in_array($active_type, ['report', 'settings'])) { $uniquetitle = $stractiveplugin; } else { $uniquetitle = $stractive_type . ': ' . $stractiveplugin; } $titlecomponents = [ $uniquetitle, get_string('grades'), $coursecontext->get_context_name(false), ]; $PAGE->set_title(implode(moodle_page::TITLE_SEPARATOR, $titlecomponents)); $PAGE->set_heading($PAGE->course->fullname); $PAGE->set_secondary_active_tab('grades'); if ($buttons instanceof single_button) { $buttons = $OUTPUT->render($buttons); } $PAGE->set_button($buttons); if ($courseid != SITEID) { grade_extend_settings($plugin_info, $courseid); } // Set the current report as active in the breadcrumbs. if ($active_plugin !== null && $reportnav = $PAGE->settingsnav->find($active_plugin, navigation_node::TYPE_SETTING)) { $reportnav->make_active(); } $returnval = $OUTPUT->header(); if (!$return) { echo $returnval; } if ($shownavigation) { $renderer = $PAGE->get_renderer('core_grades'); // If the navigation action bar is not explicitly defined, use the general (default) action bar. if (!$actionbar) { $actionbar = new general_action_bar($PAGE->context, $PAGE->url, $active_type, $active_plugin); } if ($return) { $returnval .= $renderer->render_action_bar($actionbar); } else { echo $renderer->render_action_bar($actionbar); } } $output = ''; // Add a help dialogue box if provided. if (isset($headerhelpidentifier) && !empty($heading)) { $output = $OUTPUT->heading_with_help($heading, $headerhelpidentifier, $headerhelpcomponent); } else if (isset($user)) { $renderer = $PAGE->get_renderer('core_grades'); // If the user is viewing their own grade report, no need to show the "Message" // and "Add to contact" buttons in the user heading. $showuserbuttons = $user->id != $USER->id; $output = $renderer->user_heading($user, $courseid, $showuserbuttons); } else if (!empty($heading)) { $output = $OUTPUT->heading($heading); } if ($return) { $returnval .= $output; } else { echo $output; } $returnval .= print_natural_aggregation_upgrade_notice($courseid, $coursecontext, $PAGE->url, $return); if ($return) { return $returnval; } } /** * Utility class used for return tracking when using edit and other forms in grade plugins * * @package core_grades * @copyright 2009 Nicolas Connault * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class grade_plugin_return { /** * Type of grade plugin (e.g. 'edit', 'report') * * @var string */ public $type; /** * Name of grade plugin (e.g. 'grader', 'overview') * * @var string */ public $plugin; /** * Course id being viewed * * @var int */ public $courseid; /** * Id of user whose information is being viewed/edited * * @var int */ public $userid; /** * Id of group for which information is being viewed/edited * * @var int */ public $groupid; /** * Current page # within output * * @var int */ public $page; /** * Constructor * * @param array $params - associative array with return parameters, if not supplied parameter are taken from _GET or _POST */ public function __construct($params = []) { $this->type = optional_param('gpr_type', null, PARAM_SAFEDIR); $this->plugin = optional_param('gpr_plugin', null, PARAM_PLUGIN); $this->courseid = optional_param('gpr_courseid', null, PARAM_INT); $this->userid = optional_param('gpr_userid', null, PARAM_INT); $this->groupid = optional_param('gpr_groupid', null, PARAM_INT); $this->page = optional_param('gpr_page', null, PARAM_INT); foreach ($params as $key => $value) { if (property_exists($this, $key)) { $this->$key = $value; } } // Allow course object rather than id to be used to specify course // - avoid unnecessary use of get_course. if (array_key_exists('course', $params)) { $course = $params['course']; $this->courseid = $course->id; } else { $course = null; } // If group has been explicitly set in constructor parameters, // we should respect that. if (!array_key_exists('groupid', $params)) { // Otherwise, 'group' in request parameters is a request for a change. // In that case, or if we have no group at all, we should get groupid from // groups_get_course_group, which will do some housekeeping as well as // give us the correct value. $changegroup = optional_param('group', -1, PARAM_INT); if ($changegroup !== -1 or (empty($this->groupid) and !empty($this->courseid))) { if ($course === null) { $course = get_course($this->courseid); } $this->groupid = groups_get_course_group($course, true); } } } /** * Old syntax of class constructor. Deprecated in PHP7. * * @deprecated since Moodle 3.1 */ public function grade_plugin_return($params = null) { debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER); self::__construct($params); } /** * Returns return parameters as options array suitable for buttons. * @return array options */ public function get_options() { if (empty($this->type)) { return array(); } $params = array(); if (!empty($this->plugin)) { $params['plugin'] = $this->plugin; } if (!empty($this->courseid)) { $params['id'] = $this->courseid; } if (!empty($this->userid)) { $params['userid'] = $this->userid; } if (!empty($this->groupid)) { $params['group'] = $this->groupid; } if (!empty($this->page)) { $params['page'] = $this->page; } return $params; } /** * Returns return url * * @param string $default default url when params not set * @param array $extras Extra URL parameters * * @return string url */ public function get_return_url($default, $extras=null) { global $CFG; if (empty($this->type) or empty($this->plugin)) { return $default; } $url = $CFG->wwwroot.'/grade/'.$this->type.'/'.$this->plugin.'/index.php'; $glue = '?'; if (!empty($this->courseid)) { $url .= $glue.'id='.$this->courseid; $glue = '&'; } if (!empty($this->userid)) { $url .= $glue.'userid='.$this->userid; $glue = '&'; } if (!empty($this->groupid)) { $url .= $glue.'group='.$this->groupid; $glue = '&'; } if (!empty($this->page)) { $url .= $glue.'page='.$this->page; $glue = '&'; } if (!empty($extras)) { foreach ($extras as $key=>$value) { $url .= $glue.$key.'='.$value; $glue = '&'; } } return $url; } /** * Returns string with hidden return tracking form elements. * @return string */ public function get_form_fields() { if (empty($this->type)) { return ''; } $result = '<input type="hidden" name="gpr_type" value="'.$this->type.'" />'; if (!empty($this->plugin)) { $result .= '<input type="hidden" name="gpr_plugin" value="'.$this->plugin.'" />'; } if (!empty($this->courseid)) { $result .= '<input type="hidden" name="gpr_courseid" value="'.$this->courseid.'" />'; } if (!empty($this->userid)) { $result .= '<input type="hidden" name="gpr_userid" value="'.$this->userid.'" />'; } if (!empty($this->groupid)) { $result .= '<input type="hidden" name="gpr_groupid" value="'.$this->groupid.'" />'; } if (!empty($this->page)) { $result .= '<input type="hidden" name="gpr_page" value="'.$this->page.'" />'; } return $result; } /** * Add hidden elements into mform * * @param object &$mform moodle form object * * @return void */ public function add_mform_elements(&$mform) { if (empty($this->type)) { return; } $mform->addElement('hidden', 'gpr_type', $this->type); $mform->setType('gpr_type', PARAM_SAFEDIR); if (!empty($this->plugin)) { $mform->addElement('hidden', 'gpr_plugin', $this->plugin); $mform->setType('gpr_plugin', PARAM_PLUGIN); } if (!empty($this->courseid)) { $mform->addElement('hidden', 'gpr_courseid', $this->courseid); $mform->setType('gpr_courseid', PARAM_INT); } if (!empty($this->userid)) { $mform->addElement('hidden', 'gpr_userid', $this->userid); $mform->setType('gpr_userid', PARAM_INT); } if (!empty($this->groupid)) { $mform->addElement('hidden', 'gpr_groupid', $this->groupid); $mform->setType('gpr_groupid', PARAM_INT); } if (!empty($this->page)) { $mform->addElement('hidden', 'gpr_page', $this->page); $mform->setType('gpr_page', PARAM_INT); } } /** * Add return tracking params into url * * @param moodle_url $url A URL * @return moodle_url with return tracking params */ public function add_url_params(moodle_url $url): moodle_url { if (empty($this->type)) { return $url; } $url->param('gpr_type', $this->type); if (!empty($this->plugin)) { $url->param('gpr_plugin', $this->plugin); } if (!empty($this->courseid)) { $url->param('gpr_courseid' ,$this->courseid); } if (!empty($this->userid)) { $url->param('gpr_userid', $this->userid); } if (!empty($this->groupid)) { $url->param('gpr_groupid', $this->groupid); } if (!empty($this->page)) { $url->param('gpr_page', $this->page); } return $url; } } /** * Function central to gradebook for building and printing the navigation (breadcrumb trail). * * @param string $path The path of the calling script (using __FILE__?) * @param string $pagename The language string to use as the last part of the navigation (non-link) * @param mixed $id Either a plain integer (assuming the key is 'id') or * an array of keys and values (e.g courseid => $courseid, itemid...) * * @return string */ function grade_build_nav($path, $pagename=null, $id=null) { global $CFG, $COURSE, $PAGE; $strgrades = get_string('grades', 'grades'); // Parse the path and build navlinks from its elements $dirroot_length = strlen($CFG->dirroot) + 1; // Add 1 for the first slash $path = substr($path, $dirroot_length); $path = str_replace('\\', '/', $path); $path_elements = explode('/', $path); $path_elements_count = count($path_elements); // First link is always 'grade' $PAGE->navbar->add($strgrades, new moodle_url('/grade/index.php', array('id'=>$COURSE->id))); $link = null; $numberofelements = 3; // Prepare URL params string $linkparams = array(); if (!is_null($id)) { if (is_array($id)) { foreach ($id as $idkey => $idvalue) { $linkparams[$idkey] = $idvalue; } } else { $linkparams['id'] = $id; } } $navlink4 = null; // Remove file extensions from filenames foreach ($path_elements as $key => $filename) { $path_elements[$key] = str_replace('.php', '', $filename); } // Second level links switch ($path_elements[1]) { case 'edit': // No link if ($path_elements[3] != 'index.php') { $numberofelements = 4; } break; case 'import': // No link break; case 'export': // No link break; case 'report': // $id is required for this link. Do not print it if $id isn't given if (!is_null($id)) { $link = new moodle_url('/grade/report/index.php', $linkparams); } if ($path_elements[2] == 'grader') { $numberofelements = 4; } break; default: // If this element isn't among the ones already listed above, it isn't supported, throw an error. debugging("grade_build_nav() doesn't support ". $path_elements[1] . " as the second path element after 'grade'."); return false; } $PAGE->navbar->add(get_string($path_elements[1], 'grades'), $link); // Third level links if (empty($pagename)) { $pagename = get_string($path_elements[2], 'grades'); } switch ($numberofelements) { case 3: $PAGE->navbar->add($pagename, $link); break; case 4: if ($path_elements[2] == 'grader' AND $path_elements[3] != 'index.php') { $PAGE->navbar->add(get_string('pluginname', 'gradereport_grader'), new moodle_url('/grade/report/grader/index.php', $linkparams)); } $PAGE->navbar->add($pagename); break; } return ''; } /** * General structure representing grade items in course * * @package core_grades * @copyright 2009 Nicolas Connault * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class grade_structure { public $context; public $courseid; /** * Reference to modinfo for current course (for performance, to save * retrieving it from courseid every time). Not actually set except for * the grade_tree type. * @var course_modinfo */ public $modinfo; /** * 1D array of grade items only */ public $items; /** * Returns icon of element * * @param array &$element An array representing an element in the grade_tree * @param bool $spacerifnone return spacer if no icon found * * @return string icon or spacer */ public function get_element_icon(&$element, $spacerifnone=false) { global $CFG, $OUTPUT; require_once $CFG->libdir.'/filelib.php'; $outputstr = ''; // Object holding pix_icon information before instantiation. $icon = new stdClass(); $icon->attributes = array( 'class' => 'icon itemicon' ); $icon->component = 'moodle'; $none = true; switch ($element['type']) { case 'item': case 'courseitem': case 'categoryitem': $none = false; $is_course = $element['object']->is_course_item(); $is_category = $element['object']->is_category_item(); $is_scale = $element['object']->gradetype == GRADE_TYPE_SCALE; $is_value = $element['object']->gradetype == GRADE_TYPE_VALUE; $is_outcome = !empty($element['object']->outcomeid); if ($element['object']->is_calculated()) { $icon->pix = 'i/calc'; $icon->title = s(get_string('calculatedgrade', 'grades')); } else if (($is_course or $is_category) and ($is_scale or $is_value)) { if ($category = $element['object']->get_item_category()) { $aggrstrings = grade_helper::get_aggregation_strings(); $stragg = $aggrstrings[$category->aggregation]; $icon->pix = 'i/calc'; $icon->title = s($stragg); switch ($category->aggregation) { case GRADE_AGGREGATE_MEAN: case GRADE_AGGREGATE_MEDIAN: case GRADE_AGGREGATE_WEIGHTED_MEAN: case GRADE_AGGREGATE_WEIGHTED_MEAN2: case GRADE_AGGREGATE_EXTRACREDIT_MEAN: $icon->pix = 'i/agg_mean'; break; case GRADE_AGGREGATE_SUM: $icon->pix = 'i/agg_sum'; break; } } } else if ($element['object']->itemtype == 'mod') { // Prevent outcomes displaying the same icon as the activity they are attached to. if ($is_outcome) { $icon->pix = 'i/outcomes'; $icon->title = s(get_string('outcome', 'grades')); } else { $modinfo = get_fast_modinfo($element['object']->courseid); $module = $element['object']->itemmodule; $instanceid = $element['object']->iteminstance; if (isset($modinfo->instances[$module][$instanceid])) { $icon->url = $modinfo->instances[$module][$instanceid]->get_icon_url(); } else { $icon->pix = 'monologo'; $icon->component = $element['object']->itemmodule; } $icon->title = s(get_string('modulename', $element['object']->itemmodule)); } } else if ($element['object']->itemtype == 'manual') { if ($element['object']->is_outcome_item()) { $icon->pix = 'i/outcomes'; $icon->title = s(get_string('outcome', 'grades')); } else { $icon->pix = 'i/manual_item'; $icon->title = s(get_string('manualitem', 'grades')); } } break; case 'category': $none = false; $icon->pix = 'i/folder'; $icon->title = s(get_string('category', 'grades')); break; } if ($none) { if ($spacerifnone) { $outputstr = $OUTPUT->spacer() . ' '; } } else if (isset($icon->url)) { $outputstr = html_writer::img($icon->url, $icon->title, $icon->attributes); } else { $outputstr = $OUTPUT->pix_icon($icon->pix, $icon->title, $icon->component, $icon->attributes); } return $outputstr; } /** * Returns the string that describes the type of the element. * * @param array $element An array representing an element in the grade_tree * @return string The string that describes the type of the grade element */ public function get_element_type_string(array $element): string { // If the element is a grade category. if ($element['type'] == 'category') { return get_string('category', 'grades'); } // If the element is a grade item. if (in_array($element['type'], ['item', 'courseitem', 'categoryitem'])) { // If calculated grade item. if ($element['object']->is_calculated()) { return get_string('calculatedgrade', 'grades'); } // If aggregated type grade item. if ($element['object']->is_aggregate_item()) { return get_string('aggregation', 'core_grades'); } // If external grade item (module, plugin, etc.). if ($element['object']->is_external_item()) { // If outcome grade item. if ($element['object']->is_outcome_item()) { return get_string('outcome', 'grades'); } return get_string('modulename', $element['object']->itemmodule); } // If manual grade item. if ($element['object']->itemtype == 'manual') { // If outcome grade item. if ($element['object']->is_outcome_item()) { return get_string('outcome', 'grades'); } return get_string('manualitem', 'grades'); } } return ''; } /** * Returns name of element optionally with icon and link * * @param array &$element An array representing an element in the grade_tree * @param bool $withlink Whether or not this header has a link * @param bool $icon Whether or not to display an icon with this header * @param bool $spacerifnone return spacer if no icon found * @param bool $withdescription Show description if defined by this item. * @param bool $fulltotal If the item is a category total, returns $categoryname."total" * instead of "Category total" or "Course total" * @param moodle_url|null $sortlink Link to sort column. * * @return string header */ public function get_element_header(array &$element, bool $withlink = false, bool $icon = true, bool $spacerifnone = false, bool $withdescription = false, bool $fulltotal = false, ?moodle_url $sortlink = null) { $header = ''; if ($icon) { $header .= $this->get_element_icon($element, $spacerifnone); } $title = $element['object']->get_name($fulltotal); $titleunescaped = $element['object']->get_name($fulltotal, false); $header .= $title; if ($element['type'] != 'item' and $element['type'] != 'categoryitem' and $element['type'] != 'courseitem') { return $header; } if ($sortlink) { $url = $sortlink; $header = html_writer::link($url, $header, [ 'title' => $titleunescaped, 'class' => 'gradeitemheader ' ]); } else { if ($withlink && $url = $this->get_activity_link($element)) { $a = new stdClass(); $a->name = get_string('modulename', $element['object']->itemmodule); $a->title = $titleunescaped; $title = get_string('linktoactivity', 'grades', $a); $header = html_writer::link($url, $header, [ 'title' => $title, 'class' => 'gradeitemheader ', ]); } else { $header = html_writer::span($header, 'gradeitemheader ', [ 'title' => $titleunescaped, 'tabindex' => '0' ]); } } if ($withdescription) { $desc = $element['object']->get_description(); if (!empty($desc)) { $header .= '<div class="gradeitemdescription">' . s($desc) . '</div><div class="gradeitemdescriptionfiller"></div>'; } } return $header; } private function get_activity_link($element) { global $CFG; /** @var array static cache of the grade.php file existence flags */ static $hasgradephp = array(); $itemtype = $element['object']->itemtype; $itemmodule = $element['object']->itemmodule; $iteminstance = $element['object']->iteminstance; $itemnumber = $element['object']->itemnumber; // Links only for module items that have valid instance, module and are // called from grade_tree with valid modinfo if ($itemtype != 'mod' || !$iteminstance || !$itemmodule || !$this->modinfo) { return null; } // Get $cm efficiently and with visibility information using modinfo $instances = $this->modinfo->get_instances(); if (empty($instances[$itemmodule][$iteminstance])) { return null; } $cm = $instances[$itemmodule][$iteminstance]; // Do not add link if activity is not visible to the current user if (!$cm->uservisible) { return null; } if (!array_key_exists($itemmodule, $hasgradephp)) { if (file_exists($CFG->dirroot . '/mod/' . $itemmodule . '/grade.php')) { $hasgradephp[$itemmodule] = true; } else { $hasgradephp[$itemmodule] = false; } } // If module has grade.php, link to that, otherwise view.php if ($hasgradephp[$itemmodule]) { $args = array('id' => $cm->id, 'itemnumber' => $itemnumber); if (isset($element['userid'])) { $args['userid'] = $element['userid']; } return new moodle_url('/mod/' . $itemmodule . '/grade.php', $args); } else { return new moodle_url('/mod/' . $itemmodule . '/view.php', array('id' => $cm->id)); } } /** * Returns URL of a page that is supposed to contain detailed grade analysis * * At the moment, only activity modules are supported. The method generates link * to the module's file grade.php with the parameters id (cmid), itemid, itemnumber, * gradeid and userid. If the grade.php does not exist, null is returned. * * @return moodle_url|null URL or null if unable to construct it */ public function get_grade_analysis_url(grade_grade $grade) { global $CFG; /** @var array static cache of the grade.php file existence flags */ static $hasgradephp = array(); if (empty($grade->grade_item) or !($grade->grade_item instanceof grade_item)) { throw new coding_exception('Passed grade without the associated grade item'); } $item = $grade->grade_item; if (!$item->is_external_item()) { // at the moment, only activity modules are supported return null; } if ($item->itemtype !== 'mod') { throw new coding_exception('Unknown external itemtype: '.$item->itemtype); } if (empty($item->iteminstance) or empty($item->itemmodule) or empty($this->modinfo)) { return null; } if (!array_key_exists($item->itemmodule, $hasgradephp)) { if (file_exists($CFG->dirroot . '/mod/' . $item->itemmodule . '/grade.php')) { $hasgradephp[$item->itemmodule] = true; } else { $hasgradephp[$item->itemmodule] = false; } } if (!$hasgradephp[$item->itemmodule]) { return null; } $instances = $this->modinfo->get_instances(); if (empty($instances[$item->itemmodule][$item->iteminstance])) { return null; } $cm = $instances[$item->itemmodule][$item->iteminstance]; if (!$cm->uservisible) { return null; } $url = new moodle_url('/mod/'.$item->itemmodule.'/grade.php', array( 'id' => $cm->id, 'itemid' => $item->id, 'itemnumber' => $item->itemnumber, 'gradeid' => $grade->id, 'userid' => $grade->userid, )); return $url; } /** * Returns an action icon leading to the grade analysis page * * @param grade_grade $grade * @return string * @deprecated since Moodle 4.2 - The row is not shown anymore - we have actions menu. * @todo MDL-77307 This will be deleted in Moodle 4.6. */ public function get_grade_analysis_icon(grade_grade $grade) { global $OUTPUT; debugging('The function get_grade_analysis_icon() is deprecated, please do not use it anymore.', DEBUG_DEVELOPER); $url = $this->get_grade_analysis_url($grade); if (is_null($url)) { return ''; } $title = get_string('gradeanalysis', 'core_grades'); return $OUTPUT->action_icon($url, new pix_icon('t/preview', ''), null, ['title' => $title, 'aria-label' => $title]); } /** * Returns a link leading to the grade analysis page * * @param grade_grade $grade * @return string|null */ public function get_grade_analysis_link(grade_grade $grade): ?string { $url = $this->get_grade_analysis_url($grade); if (is_null($url)) { return null; } $gradeanalysisstring = get_string('gradeanalysis', 'grades'); return html_writer::link($url, $gradeanalysisstring, ['class' => 'dropdown-item', 'aria-label' => $gradeanalysisstring, 'role' => 'menuitem']); } /** * Returns an action menu for the grade. * * @param grade_grade $grade A grade_grade object * @return string */ public function get_grade_action_menu(grade_grade $grade) : string { global $OUTPUT; $menuitems = []; $url = $this->get_grade_analysis_url($grade); if ($url) { $title = get_string('gradeanalysis', 'core_grades'); $menuitems[] = new action_menu_link_secondary($url, null, $title); } if ($menuitems) { $menu = new action_menu($menuitems); $icon = $OUTPUT->pix_icon('i/moremenu', get_string('actions')); $extraclasses = 'btn btn-link btn-icon icon-size-3 d-flex align-items-center justify-content-center'; $menu->set_menu_trigger($icon, $extraclasses); $menu->set_menu_left(); return $OUTPUT->render($menu); } else { return ''; } } /** * Returns the grade eid - the grade may not exist yet. * * @param grade_grade $grade_grade A grade_grade object * * @return string eid */ public function get_grade_eid($grade_grade) { if (empty($grade_grade->id)) { return 'n'.$grade_grade->itemid.'u'.$grade_grade->userid; } else { return 'g'.$grade_grade->id; } } /** * Returns the grade_item eid * @param grade_item $grade_item A grade_item object * @return string eid */ public function get_item_eid($grade_item) { return 'ig'.$grade_item->id; } /** * Given a grade_tree element, returns an array of parameters * used to build an icon for that element. * * @param array $element An array representing an element in the grade_tree * * @return array */ public function get_params_for_iconstr($element) { $strparams = new stdClass(); $strparams->category = ''; $strparams->itemname = ''; $strparams->itemmodule = ''; if (!method_exists($element['object'], 'get_name')) { return $strparams; } $strparams->itemname = html_to_text($element['object']->get_name()); // If element name is categorytotal, get the name of the parent category if ($strparams->itemname == get_string('categorytotal', 'grades')) { $parent = $element['object']->get_parent_category(); $strparams->category = $parent->get_name() . ' '; } else { $strparams->category = ''; } $strparams->itemmodule = null; if (isset($element['object']->itemmodule)) { $strparams->itemmodule = $element['object']->itemmodule; } return $strparams; } /** * Return a reset icon for the given element. * * @param array $element An array representing an element in the grade_tree * @param object $gpr A grade_plugin_return object * @param bool $returnactionmenulink return the instance of action_menu_link instead of string * @return string|action_menu_link * @deprecated since Moodle 4.2 - The row is not shown anymore - we have actions menu. * @todo MDL-77307 This will be deleted in Moodle 4.6. */ public function get_reset_icon($element, $gpr, $returnactionmenulink = false) { global $CFG, $OUTPUT; debugging('The function get_reset_icon() is deprecated, please do not use it anymore.', DEBUG_DEVELOPER); // Limit to category items set to use the natural weights aggregation method, and users // with the capability to manage grades. if ($element['type'] != 'category' || $element['object']->aggregation != GRADE_AGGREGATE_SUM || !has_capability('moodle/grade:manage', $this->context)) { return $returnactionmenulink ? null : ''; } $str = get_string('resetweights', 'grades', $this->get_params_for_iconstr($element)); $url = new moodle_url('/grade/edit/tree/action.php', array( 'id' => $this->courseid, 'action' => 'resetweights', 'eid' => $element['eid'], 'sesskey' => sesskey(), )); if ($returnactionmenulink) { return new action_menu_link_secondary($gpr->add_url_params($url), new pix_icon('t/reset', $str), get_string('resetweightsshort', 'grades')); } else { return $OUTPUT->action_icon($gpr->add_url_params($url), new pix_icon('t/reset', $str)); } } /** * Returns a link to reset weights for the given element. * * @param array $element An array representing an element in the grade_tree * @param object $gpr A grade_plugin_return object * @return string|null */ public function get_reset_weights_link(array $element, object $gpr): ?string { // Limit to category items set to use the natural weights aggregation method, and users // with the capability to manage grades. if ($element['type'] != 'category' || $element['object']->aggregation != GRADE_AGGREGATE_SUM || !has_capability('moodle/grade:manage', $this->context)) { return null; } $title = get_string('resetweightsshort', 'grades'); $str = get_string('resetweights', 'grades', $this->get_params_for_iconstr($element)); $url = new moodle_url('/grade/edit/tree/action.php', [ 'id' => $this->courseid, 'action' => 'resetweights', 'eid' => $element['eid'], 'sesskey' => sesskey(), ]); $gpr->add_url_params($url); return html_writer::link($url, $title, ['class' => 'dropdown-item', 'aria-label' => $str, 'role' => 'menuitem']); } /** * Returns a link to delete a given element. * * @param array $element An array representing an element in the grade_tree * @param object $gpr A grade_plugin_return object * @return string|null */ public function get_delete_link(array $element, object $gpr): ?string { if ($element['type'] == 'item' || ($element['type'] == 'category' && $element['depth'] > 1)) { if (grade_edit_tree::element_deletable($element)) { $deleteconfirmationurl = new moodle_url('index.php', [ 'id' => $this->courseid, 'action' => 'delete', 'confirm' => 1, 'eid' => $element['eid'], 'sesskey' => sesskey(), ]); $gpr->add_url_params($deleteconfirmationurl); $title = get_string('delete'); return html_writer::link( '', $title, [ 'class' => 'dropdown-item', 'aria-label' => $title, 'role' => 'menuitem', 'data-modal' => 'confirmation', 'data-modal-title-str' => json_encode(['confirm', 'core']), 'data-modal-content-str' => json_encode([ 'deletecheck', '', $element['object']->get_name() ]), 'data-modal-yes-button-str' => json_encode(['delete', 'core']), 'data-modal-destination' => $deleteconfirmationurl->out(false), ] ); } } return null; } /** * Returns a link to duplicate a given element. * * @param array $element An array representing an element in the grade_tree * @param object $gpr A grade_plugin_return object * @return string|null */ public function get_duplicate_link(array $element, object $gpr): ?string { if ($element['type'] == 'item' || ($element['type'] == 'category' && $element['depth'] > 1)) { if (grade_edit_tree::element_duplicatable($element)) { $duplicateparams = []; $duplicateparams['id'] = $this->courseid; $duplicateparams['action'] = 'duplicate'; $duplicateparams['eid'] = $element['eid']; $duplicateparams['sesskey'] = sesskey(); $url = new moodle_url('index.php', $duplicateparams); $title = get_string('duplicate'); $gpr->add_url_params($url); return html_writer::link($url, $title, ['class' => 'dropdown-item', 'aria-label' => $title, 'role' => 'menuitem']); } } return null; } /** * Return edit icon for give element * * @param array $element An array representing an element in the grade_tree * @param object $gpr A grade_plugin_return object * @param bool $returnactionmenulink return the instance of action_menu_link instead of string * @return string|action_menu_link * @deprecated since Moodle 4.2 - The row is not shown anymore - we have actions menu. * @todo MDL-77307 This will be deleted in Moodle 4.6. */ public function get_edit_icon($element, $gpr, $returnactionmenulink = false) { global $CFG, $OUTPUT; debugging('The function get_edit_icon() is deprecated, please do not use it anymore.', DEBUG_DEVELOPER); if (!has_capability('moodle/grade:manage', $this->context)) { if ($element['type'] == 'grade' and has_capability('moodle/grade:edit', $this->context)) { // oki - let them override grade } else { return $returnactionmenulink ? null : ''; } } static $strfeedback = null; static $streditgrade = null; if (is_null($streditgrade)) { $streditgrade = get_string('editgrade', 'grades'); $strfeedback = get_string('feedback'); } $strparams = $this->get_params_for_iconstr($element); $object = $element['object']; switch ($element['type']) { case 'item': case 'categoryitem': case 'courseitem': $stredit = get_string('editverbose', 'grades', $strparams); if (empty($object->outcomeid) || empty($CFG->enableoutcomes)) { $url = new moodle_url('/grade/edit/tree/item.php', array('courseid' => $this->courseid, 'id' => $object->id)); } else { $url = new moodle_url('/grade/edit/tree/outcomeitem.php', array('courseid' => $this->courseid, 'id' => $object->id)); } break; case 'category': $stredit = get_string('editverbose', 'grades', $strparams); $url = new moodle_url('/grade/edit/tree/category.php', array('courseid' => $this->courseid, 'id' => $object->id)); break; case 'grade': $stredit = $streditgrade; if (empty($object->id)) { $url = new moodle_url('/grade/edit/tree/grade.php', array('courseid' => $this->courseid, 'itemid' => $object->itemid, 'userid' => $object->userid)); } else { $url = new moodle_url('/grade/edit/tree/grade.php', array('courseid' => $this->courseid, 'id' => $object->id)); } if (!empty($object->feedback)) { $feedback = addslashes_js(trim(format_string($object->feedback, $object->feedbackformat))); } break; default: $url = null; } if ($url) { if ($returnactionmenulink) { return new action_menu_link_secondary($gpr->add_url_params($url), new pix_icon('t/edit', $stredit), get_string('editsettings')); } else { return $OUTPUT->action_icon($gpr->add_url_params($url), new pix_icon('t/edit', $stredit)); } } else { return $returnactionmenulink ? null : ''; } } /** * Returns a link leading to the edit grade/grade item/category page * * @param array $element An array representing an element in the grade_tree * @param object $gpr A grade_plugin_return object * @return string|null */ public function get_edit_link(array $element, object $gpr): ?string { global $CFG; $url = null; $title = ''; if ((!has_capability('moodle/grade:manage', $this->context) && (!($element['type'] == 'grade') || !has_capability('moodle/grade:edit', $this->context)))) { return null; } $object = $element['object']; if ($element['type'] == 'grade') { if (empty($object->id)) { $url = new moodle_url('/grade/edit/tree/grade.php', ['courseid' => $this->courseid, 'itemid' => $object->itemid, 'userid' => $object->userid]); } else { $url = new moodle_url('/grade/edit/tree/grade.php', ['courseid' => $this->courseid, 'id' => $object->id]); } $url = $gpr->add_url_params($url); $title = get_string('editgrade', 'grades'); } else if (($element['type'] == 'item') || ($element['type'] == 'categoryitem') || ($element['type'] == 'courseitem')) { $url = new moodle_url('#'); if (empty($object->outcomeid) || empty($CFG->enableoutcomes)) { return html_writer::link($url, get_string('itemsedit', 'grades'), [ 'class' => 'dropdown-item', 'aria-label' => get_string('itemsedit', 'grades'), 'role' => 'menuitem', 'data-gprplugin' => $gpr->plugin, 'data-courseid' => $this->courseid, 'data-itemid' => $object->id, 'data-trigger' => 'add-item-form' ]); } else if (count(grade_outcome::fetch_all_available($this->courseid)) > 0) { return html_writer::link($url, get_string('itemsedit', 'grades'), [ 'class' => 'dropdown-item', get_string('itemsedit', 'grades'), 'role' => 'menuitem', 'data-gprplugin' => $gpr->plugin, 'data-courseid' => $this->courseid, 'data-itemid' => $object->id, 'data-trigger' => 'add-outcome-form' ]); } } else if ($element['type'] == 'category') { $url = new moodle_url('#'); $title = get_string('categoryedit', 'grades'); return html_writer::link($url, $title, [ 'class' => 'dropdown-item', 'aria-label' => $title, 'role' => 'menuitem', 'data-gprplugin' => $gpr->plugin, 'data-courseid' => $this->courseid, 'data-category' => $object->id, 'data-trigger' => 'add-category-form' ]); } return html_writer::link($url, $title, ['class' => 'dropdown-item', 'aria-label' => $title, 'role' => 'menuitem']); } /** * Returns link to the advanced grading page * * @param array $element An array representing an element in the grade_tree * @param object $gpr A grade_plugin_return object * @return string|null */ public function get_advanced_grading_link(array $element, object $gpr): ?string { global $CFG; /** @var array static cache of the grade.php file existence flags */ static $hasgradephp = []; $itemtype = $element['object']->itemtype; $itemmodule = $element['object']->itemmodule; $iteminstance = $element['object']->iteminstance; $itemnumber = $element['object']->itemnumber; // Links only for module items that have valid instance, module and are // called from grade_tree with valid modinfo. if ($itemtype == 'mod' && $iteminstance && $itemmodule && $this->modinfo) { // Get $cm efficiently and with visibility information using modinfo. $instances = $this->modinfo->get_instances(); if (!empty($instances[$itemmodule][$iteminstance])) { $cm = $instances[$itemmodule][$iteminstance]; // Do not add link if activity is not visible to the current user. if ($cm->uservisible) { if (!array_key_exists($itemmodule, $hasgradephp)) { if (file_exists($CFG->dirroot . '/mod/' . $itemmodule . '/grade.php')) { $hasgradephp[$itemmodule] = true; } else { $hasgradephp[$itemmodule] = false; } } // If module has grade.php, add link to that. if ($hasgradephp[$itemmodule]) { $args = array('id' => $cm->id, 'itemnumber' => $itemnumber); if (isset($element['userid'])) { $args['userid'] = $element['userid']; } $url = new moodle_url('/mod/' . $itemmodule . '/grade.php', $args); $title = get_string('advancedgrading', 'gradereport_grader', $itemmodule); $gpr->add_url_params($url); return html_writer::link($url, $title, ['class' => 'dropdown-item', 'aria-label' => $title, 'role' => 'menuitem']); } } } } return null; } /** * Return hiding icon for give element * * @param array $element An array representing an element in the grade_tree * @param object $gpr A grade_plugin_return object * @param bool $returnactionmenulink return the instance of action_menu_link instead of string * @return string|action_menu_link * @deprecated since Moodle 4.2 - The row is not shown anymore - we have actions menu. * @todo MDL-77307 This will be deleted in Moodle 4.6. */ public function get_hiding_icon($element, $gpr, $returnactionmenulink = false) { global $CFG, $OUTPUT; debugging('The function get_hiding_icon() is deprecated, please do not use it anymore.', DEBUG_DEVELOPER); if (!$element['object']->can_control_visibility()) { return $returnactionmenulink ? null : ''; } if (!has_capability('moodle/grade:manage', $this->context) and !has_capability('moodle/grade:hide', $this->context)) { return $returnactionmenulink ? null : ''; } $strparams = $this->get_params_for_iconstr($element); $strshow = get_string('showverbose', 'grades', $strparams); $strhide = get_string('hideverbose', 'grades', $strparams); $url = new moodle_url('/grade/edit/tree/action.php', array('id' => $this->courseid, 'sesskey' => sesskey(), 'eid' => $element['eid'])); $url = $gpr->add_url_params($url); if ($element['object']->is_hidden()) { $type = 'show'; $tooltip = $strshow; // Change the icon and add a tooltip showing the date if ($element['type'] != 'category' and $element['object']->get_hidden() > 1) { $type = 'hiddenuntil'; $tooltip = get_string('hiddenuntildate', 'grades', userdate($element['object']->get_hidden())); } $url->param('action', 'show'); if ($returnactionmenulink) { $hideicon = new action_menu_link_secondary($url, new pix_icon('t/'.$type, $tooltip), get_string('show')); } else { $hideicon = $OUTPUT->action_icon($url, new pix_icon('t/'.$type, $tooltip, 'moodle', array('alt'=>$strshow, 'class'=>'smallicon'))); } } else { $url->param('action', 'hide'); if ($returnactionmenulink) { $hideicon = new action_menu_link_secondary($url, new pix_icon('t/hide', $strhide), get_string('hide')); } else { $hideicon = $OUTPUT->action_icon($url, new pix_icon('t/hide', $strhide)); } } return $hideicon; } /** * Returns a link with url to hide/unhide grade/grade item/grade category * * @param array $element An array representing an element in the grade_tree * @param object $gpr A grade_plugin_return object * @return string|null */ public function get_hiding_link(array $element, object $gpr): ?string { if (!$element['object']->can_control_visibility() || !has_capability('moodle/grade:manage', $this->context) || !has_capability('moodle/grade:hide', $this->context)) { return null; } $url = new moodle_url('/grade/edit/tree/action.php', ['id' => $this->courseid, 'sesskey' => sesskey(), 'eid' => $element['eid']]); $url = $gpr->add_url_params($url); if ($element['object']->is_hidden()) { $url->param('action', 'show'); $title = get_string('show'); } else { $url->param('action', 'hide'); $title = get_string('hide'); } $url = html_writer::link($url, $title, ['class' => 'dropdown-item', 'aria-label' => $title, 'role' => 'menuitem']); if ($element['type'] == 'grade') { $item = $element['object']->grade_item; if ($item->hidden) { $strparamobj = new stdClass(); $strparamobj->itemname = $item->get_name(true, true); $strnonunhideable = get_string('nonunhideableverbose', 'grades', $strparamobj); $url = html_writer::span($title, 'text-muted dropdown-item', ['title' => $strnonunhideable, 'aria-label' => $title, 'role' => 'menuitem']); } } return $url; } /** * Return locking icon for given element * * @param array $element An array representing an element in the grade_tree * @param object $gpr A grade_plugin_return object * * @return string * @deprecated since Moodle 4.2 - The row is not shown anymore - we have actions menu. * @todo MDL-77307 This will be deleted in Moodle 4.6. */ public function get_locking_icon($element, $gpr) { global $CFG, $OUTPUT; debugging('The function get_locking_icon() is deprecated, please do not use it anymore.', DEBUG_DEVELOPER); $strparams = $this->get_params_for_iconstr($element); $strunlock = get_string('unlockverbose', 'grades', $strparams); $strlock = get_string('lockverbose', 'grades', $strparams); $url = new moodle_url('/grade/edit/tree/action.php', array('id' => $this->courseid, 'sesskey' => sesskey(), 'eid' => $element['eid'])); $url = $gpr->add_url_params($url); // Don't allow an unlocking action for a grade whose grade item is locked: just print a state icon if ($element['type'] == 'grade' && $element['object']->grade_item->is_locked()) { $strparamobj = new stdClass(); $strparamobj->itemname = $element['object']->grade_item->itemname; $strnonunlockable = get_string('nonunlockableverbose', 'grades', $strparamobj); $action = html_writer::tag('span', $OUTPUT->pix_icon('t/locked', $strnonunlockable), array('class' => 'action-icon')); } else if ($element['object']->is_locked()) { $type = 'unlock'; $tooltip = $strunlock; // Change the icon and add a tooltip showing the date if ($element['type'] != 'category' and $element['object']->get_locktime() > 1) { $type = 'locktime'; $tooltip = get_string('locktimedate', 'grades', userdate($element['object']->get_locktime())); } if (!has_capability('moodle/grade:manage', $this->context) and !has_capability('moodle/grade:unlock', $this->context)) { $action = ''; } else { $url->param('action', 'unlock'); $action = $OUTPUT->action_icon($url, new pix_icon('t/'.$type, $tooltip, 'moodle', array('alt'=>$strunlock, 'class'=>'smallicon'))); } } else { if (!has_capability('moodle/grade:manage', $this->context) and !has_capability('moodle/grade:lock', $this->context)) { $action = ''; } else { $url->param('action', 'lock'); $action = $OUTPUT->action_icon($url, new pix_icon('t/lock', $strlock)); } } return $action; } /** * Returns link to lock/unlock grade/grade item/grade category * * @param array $element An array representing an element in the grade_tree * @param object $gpr A grade_plugin_return object * * @return string|null */ public function get_locking_link(array $element, object $gpr): ?string { if (has_capability('moodle/grade:manage', $this->context) && isset($element['object'])) { $title = ''; $url = new moodle_url('/grade/edit/tree/action.php', ['id' => $this->courseid, 'sesskey' => sesskey(), 'eid' => $element['eid']]); $url = $gpr->add_url_params($url); if ($element['type'] == 'category') { // Grade categories themselves cannot be locked. We lock/unlock their grade items. $children = $element['object']->get_children(true); $alllocked = true; foreach ($children as $child) { if (!$child['object']->is_locked()) { $alllocked = false; break; } } if ($alllocked && has_capability('moodle/grade:unlock', $this->context)) { $title = get_string('unlock', 'grades'); $url->param('action', 'unlock'); } else if (!$alllocked && has_capability('moodle/grade:lock', $this->context)) { $title = get_string('lock', 'grades'); $url->param('action', 'lock'); } else { return null; } } else if (($element['type'] == 'grade') && ($element['object']->grade_item->is_locked())) { // Don't allow an unlocking action for a grade whose grade item is locked: just print a state icon. $strparamobj = new stdClass(); $strparamobj->itemname = $element['object']->grade_item->get_name(true, true); $strnonunlockable = get_string('nonunlockableverbose', 'grades', $strparamobj); $title = get_string('unlock', 'grades'); return html_writer::span($title, 'text-muted dropdown-item', ['title' => $strnonunlockable, 'aria-label' => $title, 'role' => 'menuitem']); } else if ($element['object']->is_locked()) { if (has_capability('moodle/grade:unlock', $this->context)) { $title = get_string('unlock', 'grades'); $url->param('action', 'unlock'); } else { return null; } } else { if (has_capability('moodle/grade:lock', $this->context)) { $title = get_string('lock', 'grades'); $url->param('action', 'lock'); } else { return null; } } return html_writer::link($url, $title, ['class' => 'dropdown-item', 'aria-label' => $title, 'role' => 'menuitem']); } else { return null; } } /** * Return calculation icon for given element * * @param array $element An array representing an element in the grade_tree * @param object $gpr A grade_plugin_return object * @param bool $returnactionmenulink return the instance of action_menu_link instead of string * @return string|action_menu_link * @deprecated since Moodle 4.2 - The row is not shown anymore - we have actions menu. * @todo MDL-77307 This will be deleted in Moodle 4.6. */ public function get_calculation_icon($element, $gpr, $returnactionmenulink = false) { global $CFG, $OUTPUT; debugging('The function get_calculation_icon() is deprecated, please do not use it anymore.', DEBUG_DEVELOPER); if (!has_capability('moodle/grade:manage', $this->context)) { return $returnactionmenulink ? null : ''; } $type = $element['type']; $object = $element['object']; if ($type == 'item' or $type == 'courseitem' or $type == 'categoryitem') { $strparams = $this->get_params_for_iconstr($element); $streditcalculation = get_string('editcalculationverbose', 'grades', $strparams); $is_scale = $object->gradetype == GRADE_TYPE_SCALE; $is_value = $object->gradetype == GRADE_TYPE_VALUE; // show calculation icon only when calculation possible if (!$object->is_external_item() and ($is_scale or $is_value)) { if ($object->is_calculated()) { $icon = 't/calc'; } else { $icon = 't/calc_off'; } $url = new moodle_url('/grade/edit/tree/calculation.php', array('courseid' => $this->courseid, 'id' => $object->id)); $url = $gpr->add_url_params($url); if ($returnactionmenulink) { return new action_menu_link_secondary($url, new pix_icon($icon, $streditcalculation), get_string('editcalculation', 'grades')); } else { return $OUTPUT->action_icon($url, new pix_icon($icon, $streditcalculation)); } } } return $returnactionmenulink ? null : ''; } /** * Returns link to edit calculation for a grade item. * * @param array $element An array representing an element in the grade_tree * @param object $gpr A grade_plugin_return object * * @return string|null */ public function get_edit_calculation_link(array $element, object $gpr): ?string { if (has_capability('moodle/grade:manage', $this->context) && isset($element['object'])) { $object = $element['object']; $isscale = $object->gradetype == GRADE_TYPE_SCALE; $isvalue = $object->gradetype == GRADE_TYPE_VALUE; // Show calculation icon only when calculation possible. if (!$object->is_external_item() && ($isscale || $isvalue)) { $editcalculationstring = get_string('editcalculation', 'grades'); $url = new moodle_url('/grade/edit/tree/calculation.php', ['courseid' => $this->courseid, 'id' => $object->id]); $url = $gpr->add_url_params($url); return html_writer::link($url, $editcalculationstring, ['class' => 'dropdown-item', 'aria-label' => $editcalculationstring, 'role' => 'menuitem']); } } return null; } /** * Sets status icons for the grade. * * @param array $element array with grade item info * @return string|null status icons container HTML */ public function set_grade_status_icons(array $element): ?string { global $OUTPUT; $context = [ 'hidden' => $element['object']->is_hidden(), ]; if ($element['object'] instanceof grade_grade) { $grade = $element['object']; $context['overridden'] = $grade->is_overridden(); $context['excluded'] = $grade->is_excluded(); $context['feedback'] = !empty($grade->feedback) && $grade->load_grade_item()->gradetype != GRADE_TYPE_TEXT; } $context['classes'] = 'grade_icons data-collapse_gradeicons'; if ($element['object'] instanceof grade_category) { $context['classes'] = 'category_grade_icons'; $children = $element['object']->get_children(true); $alllocked = true; foreach ($children as $child) { if (!$child['object']->is_locked()) { $alllocked = false; break; } } if ($alllocked) { $context['locked'] = true; } } else { $context['locked'] = $element['object']->is_locked(); } // Don't even attempt rendering if there is no status to show. if (in_array(true, $context)) { return $OUTPUT->render_from_template('core_grades/status_icons', $context); } else { return null; } } /** * Returns an action menu for the grade. * * @param array $element Array with cell info. * @param string $mode Mode - gradeitem or user * @param grade_plugin_return $gpr * @param moodle_url|null $baseurl * @return string */ public function get_cell_action_menu(array $element, string $mode, grade_plugin_return $gpr, ?moodle_url $baseurl = null): string { global $OUTPUT, $USER; $context = new stdClass(); if ($mode == 'gradeitem' || $mode == 'setup') { $editable = true; if ($element['type'] == 'grade') { $context->datatype = 'grade'; $item = $element['object']->grade_item; if ($item->is_course_item() || $item->is_category_item()) { $editable = (bool)get_config('moodle', 'grade_overridecat');; } if (!empty($USER->editing)) { if ($editable) { $context->editurl = $this->get_edit_link($element, $gpr); } $context->hideurl = $this->get_hiding_link($element, $gpr); $context->lockurl = $this->get_locking_link($element, $gpr); } $context->gradeanalysisurl = $this->get_grade_analysis_link($element['object']); } else if (($element['type'] == 'item') || ($element['type'] == 'categoryitem') || ($element['type'] == 'courseitem') || ($element['type'] == 'userfield')) { $context->datatype = 'item'; if ($element['type'] == 'item') { if ($mode == 'setup') { $context->deleteurl = $this->get_delete_link($element, $gpr); $context->duplicateurl = $this->get_duplicate_link($element, $gpr); } else { $context = grade_report::get_additional_context($this->context, $this->courseid, $element, $gpr, $mode, $context, true); $context->advancedgradingurl = $this->get_advanced_grading_link($element, $gpr); } $context->divider1 = true; } if (($element['type'] == 'item') || (($element['type'] == 'userfield') && ($element['name'] !== 'fullname'))) { $context->divider2 = true; } if (!empty($USER->editing) || $mode == 'setup') { if (($element['type'] == 'userfield') && ($element['name'] !== 'fullname')) { $context->divider2 = true; } else if (($mode !== 'setup') && ($element['type'] !== 'userfield')) { $context->divider1 = true; $context->divider2 = true; } if ($element['type'] == 'item') { $context->editurl = $this->get_edit_link($element, $gpr); } $context->editcalculationurl = $this->get_edit_calculation_link($element, $gpr); if (isset($element['object'])) { $object = $element['object']; if ($object->itemmodule !== 'quiz') { $context->hideurl = $this->get_hiding_link($element, $gpr); } } $context->lockurl = $this->get_locking_link($element, $gpr); } // Sorting item. if ($baseurl) { $sortlink = clone($baseurl); if (isset($element['object']->id)) { $sortlink->param('sortitemid', $element['object']->id); } else if ($element['type'] == 'userfield') { $context->datatype = $element['name']; $sortlink->param('sortitemid', $element['name']); } if (($element['type'] == 'userfield') && ($element['name'] == 'fullname')) { $sortlink->param('sortitemid', 'firstname'); $context->ascendingfirstnameurl = $this->get_sorting_link($sortlink, $gpr); $context->descendingfirstnameurl = $this->get_sorting_link($sortlink, $gpr, 'desc'); $sortlink->param('sortitemid', 'lastname'); $context->ascendinglastnameurl = $this->get_sorting_link($sortlink, $gpr); $context->descendinglastnameurl = $this->get_sorting_link($sortlink, $gpr, 'desc'); } else { $context->ascendingurl = $this->get_sorting_link($sortlink, $gpr); $context->descendingurl = $this->get_sorting_link($sortlink, $gpr, 'desc'); } } if ($mode !== 'setup') { $context = grade_report::get_additional_context($this->context, $this->courseid, $element, $gpr, $mode, $context); } } else if ($element['type'] == 'category') { $context->datatype = 'category'; if ($mode !== 'setup') { $mode = 'category'; $context = grade_report::get_additional_context($this->context, $this->courseid, $element, $gpr, $mode, $context); } else { $context->deleteurl = $this->get_delete_link($element, $gpr); $context->resetweightsurl = $this->get_reset_weights_link($element, $gpr); } if (!empty($USER->editing) || $mode == 'setup') { if ($mode !== 'setup') { $context->divider1 = true; } $context->editurl = $this->get_edit_link($element, $gpr); $context->hideurl = $this->get_hiding_link($element, $gpr); $context->lockurl = $this->get_locking_link($element, $gpr); } } if (isset($element['object'])) { $context->dataid = $element['object']->id; } else if ($element['type'] == 'userfield') { $context->dataid = $element['name']; } if ($element['type'] != 'text' && !empty($element['object']->feedback)) { $viewfeedbackstring = get_string('viewfeedback', 'grades'); $context->viewfeedbackurl = html_writer::link('#', $viewfeedbackstring, ['class' => 'dropdown-item', 'aria-label' => $viewfeedbackstring, 'role' => 'menuitem', 'data-action' => 'feedback', 'data-courseid' => $this->courseid]); } } else if ($mode == 'user') { $context->datatype = 'user'; $context = grade_report::get_additional_context($this->context, $this->courseid, $element, $gpr, $mode, $context, true); $context->dataid = $element['userid']; } // Omit the second divider if there is nothing between it and the first divider. if (!isset($context->ascendingfirstnameurl) && !isset($context->ascendingurl)) { $context->divider2 = false; } if ($mode == 'setup') { $context->databoundary = 'window'; } if (!empty($USER->editing) || isset($context->gradeanalysisurl) || isset($context->gradesonlyurl) || isset($context->aggregatesonlyurl) || isset($context->fullmodeurl) || isset($context->reporturl0) || isset($context->ascendingfirstnameurl) || isset($context->ascendingurl) || isset($context->viewfeedbackurl) || ($mode == 'setup')) { return $OUTPUT->render_from_template('core_grades/cellmenu', $context); } return ''; } /** * Returns link to sort grade item column * * @param moodle_url $sortlink A base link for sorting * @param object $gpr A grade_plugin_return object * @param string $direction Direction od sorting * @return string */ public function get_sorting_link(moodle_url $sortlink, object $gpr, string $direction = 'asc'): string { if ($direction == 'asc') { $title = get_string('asc'); } else { $title = get_string('desc'); } $sortlink->param('sort', $direction); $gpr->add_url_params($sortlink); return html_writer::link($sortlink, $title, ['class' => 'dropdown-item', 'aria-label' => $title, 'role' => 'menuitem']); } } /** * Flat structure similar to grade tree. * * @uses grade_structure * @package core_grades * @copyright 2009 Nicolas Connault * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class grade_seq extends grade_structure { /** * 1D array of elements */ public $elements; /** * Constructor, retrieves and stores array of all grade_category and grade_item * objects for the given courseid. Full objects are instantiated. Ordering sequence is fixed if needed. * * @param int $courseid The course id * @param bool $category_grade_last category grade item is the last child * @param bool $nooutcomes Whether or not outcomes should be included */ public function __construct($courseid, $category_grade_last=false, $nooutcomes=false) { global $USER, $CFG; $this->courseid = $courseid; $this->context = context_course::instance($courseid); // get course grade tree $top_element = grade_category::fetch_course_tree($courseid, true); $this->elements = grade_seq::flatten($top_element, $category_grade_last, $nooutcomes); foreach ($this->elements as $key=>$unused) { $this->items[$this->elements[$key]['object']->id] =& $this->elements[$key]['object']; } } /** * Old syntax of class constructor. Deprecated in PHP7. * * @deprecated since Moodle 3.1 */ public function grade_seq($courseid, $category_grade_last=false, $nooutcomes=false) { debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER); self::__construct($courseid, $category_grade_last, $nooutcomes); } /** * Static recursive helper - makes the grade_item for category the last children * * @param array &$element The seed of the recursion * @param bool $category_grade_last category grade item is the last child * @param bool $nooutcomes Whether or not outcomes should be included * * @return array */ public function flatten(&$element, $category_grade_last, $nooutcomes) { if (empty($element['children'])) { return array(); } $children = array(); foreach ($element['children'] as $sortorder=>$unused) { if ($nooutcomes and $element['type'] != 'category' and $element['children'][$sortorder]['object']->is_outcome_item()) { continue; } $children[] = $element['children'][$sortorder]; } unset($element['children']); if ($category_grade_last and count($children) > 1 and ( $children[0]['type'] === 'courseitem' or $children[0]['type'] === 'categoryitem' ) ) { $cat_item = array_shift($children); array_push($children, $cat_item); } $result = array(); foreach ($children as $child) { if ($child['type'] == 'category') { $result = $result + grade_seq::flatten($child, $category_grade_last, $nooutcomes); } else { $child['eid'] = 'i'.$child['object']->id; $result[$child['object']->id] = $child; } } return $result; } /** * Parses the array in search of a given eid and returns a element object with * information about the element it has found. * * @param int $eid Gradetree Element ID * * @return object element */ public function locate_element($eid) { // it is a grade - construct a new object if (strpos($eid, 'n') === 0) { if (!preg_match('/n(\d+)u(\d+)/', $eid, $matches)) { return null; } $itemid = $matches[1]; $userid = $matches[2]; //extra security check - the grade item must be in this tree if (!$item_el = $this->locate_element('ig'.$itemid)) { return null; } // $gradea->id may be null - means does not exist yet $grade = new grade_grade(array('itemid'=>$itemid, 'userid'=>$userid)); $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods! return array('eid'=>'n'.$itemid.'u'.$userid,'object'=>$grade, 'type'=>'grade'); } else if (strpos($eid, 'g') === 0) { $id = (int) substr($eid, 1); if (!$grade = grade_grade::fetch(array('id'=>$id))) { return null; } //extra security check - the grade item must be in this tree if (!$item_el = $this->locate_element('ig'.$grade->itemid)) { return null; } $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods! return array('eid'=>'g'.$id,'object'=>$grade, 'type'=>'grade'); } // it is a category or item foreach ($this->elements as $element) { if ($element['eid'] == $eid) { return $element; } } return null; } } /** * This class represents a complete tree of categories, grade_items and final grades, * organises as an array primarily, but which can also be converted to other formats. * It has simple method calls with complex implementations, allowing for easy insertion, * deletion and moving of items and categories within the tree. * * @uses grade_structure * @package core_grades * @copyright 2009 Nicolas Connault * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class grade_tree extends grade_structure { /** * The basic representation of the tree as a hierarchical, 3-tiered array. * @var object $top_element */ public $top_element; /** * 2D array of grade items and categories * @var array $levels */ public $levels; /** * Grade items * @var array $items */ public $items; /** * Constructor, retrieves and stores a hierarchical array of all grade_category and grade_item * objects for the given courseid. Full objects are instantiated. Ordering sequence is fixed if needed. * * @param int $courseid The Course ID * @param bool $fillers include fillers and colspans, make the levels var "rectangular" * @param bool $category_grade_last category grade item is the last child * @param array $collapsed array of collapsed categories * @param bool $nooutcomes Whether or not outcomes should be included */ public function __construct($courseid, $fillers=true, $category_grade_last=false, $collapsed=null, $nooutcomes=false) { global $USER, $CFG, $COURSE, $DB; $this->courseid = $courseid; $this->levels = array(); $this->context = context_course::instance($courseid); if (!empty($COURSE->id) && $COURSE->id == $this->courseid) { $course = $COURSE; } else { $course = $DB->get_record('course', array('id' => $this->courseid)); } $this->modinfo = get_fast_modinfo($course); // get course grade tree $this->top_element = grade_category::fetch_course_tree($courseid, true); // collapse the categories if requested if (!empty($collapsed)) { grade_tree::category_collapse($this->top_element, $collapsed); } // no otucomes if requested if (!empty($nooutcomes)) { grade_tree::no_outcomes($this->top_element); } // move category item to last position in category if ($category_grade_last) { grade_tree::category_grade_last($this->top_element); } if ($fillers) { // inject fake categories == fillers grade_tree::inject_fillers($this->top_element, 0); // add colspans to categories and fillers grade_tree::inject_colspans($this->top_element); } grade_tree::fill_levels($this->levels, $this->top_element, 0); } /** * Old syntax of class constructor. Deprecated in PHP7. * * @deprecated since Moodle 3.1 */ public function grade_tree($courseid, $fillers=true, $category_grade_last=false, $collapsed=null, $nooutcomes=false) { debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER); self::__construct($courseid, $fillers, $category_grade_last, $collapsed, $nooutcomes); } /** * Static recursive helper - removes items from collapsed categories * * @param array &$element The seed of the recursion * @param array $collapsed array of collapsed categories * * @return void */ public function category_collapse(&$element, $collapsed) { if ($element['type'] != 'category') { return; } if (empty($element['children']) or count($element['children']) < 2) { return; } if (in_array($element['object']->id, $collapsed['aggregatesonly'])) { $category_item = reset($element['children']); //keep only category item $element['children'] = array(key($element['children'])=>$category_item); } else { if (in_array($element['object']->id, $collapsed['gradesonly'])) { // Remove category item reset($element['children']); $first_key = key($element['children']); unset($element['children'][$first_key]); } foreach ($element['children'] as $sortorder=>$child) { // Recurse through the element's children grade_tree::category_collapse($element['children'][$sortorder], $collapsed); } } } /** * Static recursive helper - removes all outcomes * * @param array &$element The seed of the recursion * * @return void */ public function no_outcomes(&$element) { if ($element['type'] != 'category') { return; } foreach ($element['children'] as $sortorder=>$child) { if ($element['children'][$sortorder]['type'] == 'item' and $element['children'][$sortorder]['object']->is_outcome_item()) { unset($element['children'][$sortorder]); } else if ($element['children'][$sortorder]['type'] == 'category') { grade_tree::no_outcomes($element['children'][$sortorder]); } } } /** * Static recursive helper - makes the grade_item for category the last children * * @param array &$element The seed of the recursion * * @return void */ public function category_grade_last(&$element) { if (empty($element['children'])) { return; } if (count($element['children']) < 2) { return; } $first_item = reset($element['children']); if ($first_item['type'] == 'categoryitem' or $first_item['type'] == 'courseitem') { // the category item might have been already removed $order = key($element['children']); unset($element['children'][$order]); $element['children'][$order] =& $first_item; } foreach ($element['children'] as $sortorder => $child) { grade_tree::category_grade_last($element['children'][$sortorder]); } } /** * Static recursive helper - fills the levels array, useful when accessing tree elements of one level * * @param array &$levels The levels of the grade tree through which to recurse * @param array &$element The seed of the recursion * @param int $depth How deep are we? * @return void */ public function fill_levels(&$levels, &$element, $depth) { if (!array_key_exists($depth, $levels)) { $levels[$depth] = array(); } // prepare unique identifier if ($element['type'] == 'category') { $element['eid'] = 'cg'.$element['object']->id; } else if (in_array($element['type'], array('item', 'courseitem', 'categoryitem'))) { $element['eid'] = 'ig'.$element['object']->id; $this->items[$element['object']->id] =& $element['object']; } $levels[$depth][] =& $element; $depth++; if (empty($element['children'])) { return; } $prev = 0; foreach ($element['children'] as $sortorder=>$child) { grade_tree::fill_levels($levels, $element['children'][$sortorder], $depth); $element['children'][$sortorder]['prev'] = $prev; $element['children'][$sortorder]['next'] = 0; if ($prev) { $element['children'][$prev]['next'] = $sortorder; } $prev = $sortorder; } } /** * Determines whether the grade tree item can be displayed. * This is particularly targeted for grade categories that have no total (None) when rendering the grade tree. * It checks if the grade tree item is of type 'category', and makes sure that the category, or at least one of children, * can be output. * * @param array $element The grade category element. * @return bool True if the grade tree item can be displayed. False, otherwise. */ public static function can_output_item($element) { $canoutput = true; if ($element['type'] === 'category') { $object = $element['object']; $category = grade_category::fetch(array('id' => $object->id)); // Category has total, we can output this. if ($category->get_grade_item()->gradetype != GRADE_TYPE_NONE) { return true; } // Category has no total and has no children, no need to output this. if (empty($element['children'])) { return false; } $canoutput = false; // Loop over children and make sure at least one child can be output. foreach ($element['children'] as $child) { $canoutput = self::can_output_item($child); if ($canoutput) { break; } } } return $canoutput; } /** * Static recursive helper - makes full tree (all leafes are at the same level) * * @param array &$element The seed of the recursion * @param int $depth How deep are we? * * @return int */ public function inject_fillers(&$element, $depth) { $depth++; if (empty($element['children'])) { return $depth; } $chdepths = array(); $chids = array_keys($element['children']); $last_child = end($chids); $first_child = reset($chids); foreach ($chids as $chid) { $chdepths[$chid] = grade_tree::inject_fillers($element['children'][$chid], $depth); } arsort($chdepths); $maxdepth = reset($chdepths); foreach ($chdepths as $chid=>$chd) { if ($chd == $maxdepth) { continue; } if (!self::can_output_item($element['children'][$chid])) { continue; } for ($i=0; $i < $maxdepth-$chd; $i++) { if ($chid == $first_child) { $type = 'fillerfirst'; } else if ($chid == $last_child) { $type = 'fillerlast'; } else { $type = 'filler'; } $oldchild =& $element['children'][$chid]; $element['children'][$chid] = array('object'=>'filler', 'type'=>$type, 'eid'=>'', 'depth'=>$element['object']->depth, 'children'=>array($oldchild)); } } return $maxdepth; } /** * Static recursive helper - add colspan information into categories * * @param array &$element The seed of the recursion * * @return int */ public function inject_colspans(&$element) { if (empty($element['children'])) { return 1; } $count = 0; foreach ($element['children'] as $key=>$child) { if (!self::can_output_item($child)) { continue; } $count += grade_tree::inject_colspans($element['children'][$key]); } $element['colspan'] = $count; return $count; } /** * Parses the array in search of a given eid and returns a element object with * information about the element it has found. * @param int $eid Gradetree Element ID * @return object element */ public function locate_element($eid) { // it is a grade - construct a new object if (strpos($eid, 'n') === 0) { if (!preg_match('/n(\d+)u(\d+)/', $eid, $matches)) { return null; } $itemid = $matches[1]; $userid = $matches[2]; //extra security check - the grade item must be in this tree if (!$item_el = $this->locate_element('ig'.$itemid)) { return null; } // $gradea->id may be null - means does not exist yet $grade = new grade_grade(array('itemid'=>$itemid, 'userid'=>$userid)); $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods! return array('eid'=>'n'.$itemid.'u'.$userid,'object'=>$grade, 'type'=>'grade'); } else if (strpos($eid, 'g') === 0) { $id = (int) substr($eid, 1); if (!$grade = grade_grade::fetch(array('id'=>$id))) { return null; } //extra security check - the grade item must be in this tree if (!$item_el = $this->locate_element('ig'.$grade->itemid)) { return null; } $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods! return array('eid'=>'g'.$id,'object'=>$grade, 'type'=>'grade'); } // it is a category or item foreach ($this->levels as $row) { foreach ($row as $element) { if ($element['type'] == 'filler') { continue; } if ($element['eid'] == $eid) { return $element; } } } return null; } /** * Returns a well-formed XML representation of the grade-tree using recursion. * * @param array $root The current element in the recursion. If null, starts at the top of the tree. * @param string $tabs The control character to use for tabs * * @return string $xml */ public function exporttoxml($root=null, $tabs="\t") { $xml = null; $first = false; if (is_null($root)) { $root = $this->top_element; $xml = '<?xml version="1.0" encoding="UTF-8" ?>' . "\n"; $xml .= "<gradetree>\n"; $first = true; } $type = 'undefined'; if (strpos($root['object']->table, 'grade_categories') !== false) { $type = 'category'; } else if (strpos($root['object']->table, 'grade_items') !== false) { $type = 'item'; } else if (strpos($root['object']->table, 'grade_outcomes') !== false) { $type = 'outcome'; } $xml .= "$tabs<element type=\"$type\">\n"; foreach ($root['object'] as $var => $value) { if (!is_object($value) && !is_array($value) && !empty($value)) { $xml .= "$tabs\t<$var>$value</$var>\n"; } } if (!empty($root['children'])) { $xml .= "$tabs\t<children>\n"; foreach ($root['children'] as $sortorder => $child) { $xml .= $this->exportToXML($child, $tabs."\t\t"); } $xml .= "$tabs\t</children>\n"; } $xml .= "$tabs</element>\n"; if ($first) { $xml .= "</gradetree>"; } return $xml; } /** * Returns a JSON representation of the grade-tree using recursion. * * @param array $root The current element in the recursion. If null, starts at the top of the tree. * @param string $tabs Tab characters used to indent the string nicely for humans to enjoy * * @return string */ public function exporttojson($root=null, $tabs="\t") { $json = null; $first = false; if (is_null($root)) { $root = $this->top_element; $first = true; } $name = ''; if (strpos($root['object']->table, 'grade_categories') !== false) { $name = $root['object']->fullname; if ($name == '?') { $name = $root['object']->get_name(); } } else if (strpos($root['object']->table, 'grade_items') !== false) { $name = $root['object']->itemname; } else if (strpos($root['object']->table, 'grade_outcomes') !== false) { $name = $root['object']->itemname; } $json .= "$tabs {\n"; $json .= "$tabs\t \"type\": \"{$root['type']}\",\n"; $json .= "$tabs\t \"name\": \"$name\",\n"; foreach ($root['object'] as $var => $value) { if (!is_object($value) && !is_array($value) && !empty($value)) { $json .= "$tabs\t \"$var\": \"$value\",\n"; } } $json = substr($json, 0, strrpos($json, ',')); if (!empty($root['children'])) { $json .= ",\n$tabs\t\"children\": [\n"; foreach ($root['children'] as $sortorder => $child) { $json .= $this->exportToJSON($child, $tabs."\t\t"); } $json = substr($json, 0, strrpos($json, ',')); $json .= "\n$tabs\t]\n"; } if ($first) { $json .= "\n}"; } else { $json .= "\n$tabs},\n"; } return $json; } /** * Returns the array of levels * * @return array */ public function get_levels() { return $this->levels; } /** * Returns the array of grade items * * @return array */ public function get_items() { return $this->items; } /** * Returns a specific Grade Item * * @param int $itemid The ID of the grade_item object * * @return grade_item */ public function get_item($itemid) { if (array_key_exists($itemid, $this->items)) { return $this->items[$itemid]; } else { return false; } } } /** * Local shortcut function for creating an edit/delete button for a grade_* object. * @param string $type 'edit' or 'delete' * @param int $courseid The Course ID * @param grade_* $object The grade_* object * @return string html */ function grade_button($type, $courseid, $object) { global $CFG, $OUTPUT; if (preg_match('/grade_(.*)/', get_class($object), $matches)) { $objectidstring = $matches[1] . 'id'; } else { throw new coding_exception('grade_button() only accepts grade_* objects as third parameter!'); } $strdelete = get_string('delete'); $stredit = get_string('edit'); if ($type == 'delete') { $url = new moodle_url('index.php', array('id' => $courseid, $objectidstring => $object->id, 'action' => 'delete', 'sesskey' => sesskey())); } else if ($type == 'edit') { $url = new moodle_url('edit.php', array('courseid' => $courseid, 'id' => $object->id)); } return $OUTPUT->action_icon($url, new pix_icon('t/'.$type, ${'str'.$type}, '', array('class' => 'iconsmall'))); } /** * This method adds settings to the settings block for the grade system and its * plugins * * @global moodle_page $PAGE */ function grade_extend_settings($plugininfo, $courseid) { global $PAGE; $gradenode = $PAGE->settingsnav->prepend(get_string('gradeadministration', 'grades'), null, navigation_node::TYPE_CONTAINER, null, 'gradeadmin'); $strings = array_shift($plugininfo); if ($reports = grade_helper::get_plugins_reports($courseid)) { foreach ($reports as $report) { $gradenode->add($report->string, $report->link, navigation_node::TYPE_SETTING, null, $report->id, new pix_icon('i/report', '')); } } if ($settings = grade_helper::get_info_manage_settings($courseid)) { $settingsnode = $gradenode->add($strings['settings'], null, navigation_node::TYPE_CONTAINER); foreach ($settings as $setting) { $settingsnode->add($setting->string, $setting->link, navigation_node::TYPE_SETTING, null, $setting->id, new pix_icon('i/settings', '')); } } if ($imports = grade_helper::get_plugins_import($courseid)) { $importnode = $gradenode->add($strings['import'], null, navigation_node::TYPE_CONTAINER); foreach ($imports as $import) { $importnode->add($import->string, $import->link, navigation_node::TYPE_SETTING, null, $import->id, new pix_icon('i/import', '')); } } if ($exports = grade_helper::get_plugins_export($courseid)) { $exportnode = $gradenode->add($strings['export'], null, navigation_node::TYPE_CONTAINER); foreach ($exports as $export) { $exportnode->add($export->string, $export->link, navigation_node::TYPE_SETTING, null, $export->id, new pix_icon('i/export', '')); } } if ($letters = grade_helper::get_info_letters($courseid)) { $letters = array_shift($letters); $gradenode->add($strings['letter'], $letters->link, navigation_node::TYPE_SETTING, null, $letters->id, new pix_icon('i/settings', '')); } if ($outcomes = grade_helper::get_info_outcomes($courseid)) { $outcomes = array_shift($outcomes); $gradenode->add($strings['outcome'], $outcomes->link, navigation_node::TYPE_SETTING, null, $outcomes->id, new pix_icon('i/outcomes', '')); } if ($scales = grade_helper::get_info_scales($courseid)) { $gradenode->add($strings['scale'], $scales->link, navigation_node::TYPE_SETTING, null, $scales->id, new pix_icon('i/scales', '')); } if ($gradenode->contains_active_node()) { // If the gradenode is active include the settings base node (gradeadministration) in // the navbar, typcially this is ignored. $PAGE->navbar->includesettingsbase = true; // If we can get the course admin node make sure it is closed by default // as in this case the gradenode will be opened if ($coursenode = $PAGE->settingsnav->get('courseadmin', navigation_node::TYPE_COURSE)){ $coursenode->make_inactive(); $coursenode->forceopen = false; } } } /** * Grade helper class * * This class provides several helpful functions that work irrespective of any * current state. * * @copyright 2010 Sam Hemelryk * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ abstract class grade_helper { /** * Cached manage settings info {@see get_info_settings} * @var grade_plugin_info|false */ protected static $managesetting = null; /** * Cached grade report plugins {@see get_plugins_reports} * @var array|false */ protected static $gradereports = null; /** * Cached grade report plugins preferences {@see get_info_scales} * @var array|false */ protected static $gradereportpreferences = null; /** * Cached scale info {@see get_info_scales} * @var grade_plugin_info|false */ protected static $scaleinfo = null; /** * Cached outcome info {@see get_info_outcomes} * @var grade_plugin_info|false */ protected static $outcomeinfo = null; /** * Cached leftter info {@see get_info_letters} * @var grade_plugin_info|false */ protected static $letterinfo = null; /** * Cached grade import plugins {@see get_plugins_import} * @var array|false */ protected static $importplugins = null; /** * Cached grade export plugins {@see get_plugins_export} * @var array|false */ protected static $exportplugins = null; /** * Cached grade plugin strings * @var array */ protected static $pluginstrings = null; /** * Cached grade aggregation strings * @var array */ protected static $aggregationstrings = null; /** * Cached grade tree plugin strings * @var array */ protected static $langstrings = []; /** * First checks the cached language strings, then returns match if found, or uses get_string() * to get it from the DB, caches it then returns it. * * @deprecated since 4.3 * @todo MDL-78780 This will be deleted in Moodle 4.7. * @param string $strcode * @param string|null $section Optional language section * @return string */ public static function get_lang_string(string $strcode, ?string $section = null): string { debugging('grade_helper::get_lang_string() is deprecated, please use' . ' get_string() instead.', DEBUG_DEVELOPER); if (empty(self::$langstrings[$strcode])) { self::$langstrings[$strcode] = get_string($strcode, $section); } return self::$langstrings[$strcode]; } /** * Gets strings commonly used by the describe plugins * * report => get_string('view'), * scale => get_string('scales'), * outcome => get_string('outcomes', 'grades'), * letter => get_string('letters', 'grades'), * export => get_string('export', 'grades'), * import => get_string('import'), * settings => get_string('settings') * * @return array */ public static function get_plugin_strings() { if (self::$pluginstrings === null) { self::$pluginstrings = array( 'report' => get_string('view'), 'scale' => get_string('scales'), 'outcome' => get_string('outcomes', 'grades'), 'letter' => get_string('letters', 'grades'), 'export' => get_string('export', 'grades'), 'import' => get_string('import'), 'settings' => get_string('edittree', 'grades') ); } return self::$pluginstrings; } /** * Gets strings describing the available aggregation methods. * * @return array */ public static function get_aggregation_strings() { if (self::$aggregationstrings === null) { self::$aggregationstrings = array( GRADE_AGGREGATE_MEAN => get_string('aggregatemean', 'grades'), GRADE_AGGREGATE_WEIGHTED_MEAN => get_string('aggregateweightedmean', 'grades'), GRADE_AGGREGATE_WEIGHTED_MEAN2 => get_string('aggregateweightedmean2', 'grades'), GRADE_AGGREGATE_EXTRACREDIT_MEAN => get_string('aggregateextracreditmean', 'grades'), GRADE_AGGREGATE_MEDIAN => get_string('aggregatemedian', 'grades'), GRADE_AGGREGATE_MIN => get_string('aggregatemin', 'grades'), GRADE_AGGREGATE_MAX => get_string('aggregatemax', 'grades'), GRADE_AGGREGATE_MODE => get_string('aggregatemode', 'grades'), GRADE_AGGREGATE_SUM => get_string('aggregatesum', 'grades') ); } return self::$aggregationstrings; } /** * Get grade_plugin_info object for managing settings if the user can * * @param int $courseid * @return grade_plugin_info[] */ public static function get_info_manage_settings($courseid) { if (self::$managesetting !== null) { return self::$managesetting; } $context = context_course::instance($courseid); self::$managesetting = array(); if ($courseid != SITEID && has_capability('moodle/grade:manage', $context)) { self::$managesetting['gradebooksetup'] = new grade_plugin_info('setup', new moodle_url('/grade/edit/tree/index.php', array('id' => $courseid)), get_string('gradebooksetup', 'grades')); self::$managesetting['coursesettings'] = new grade_plugin_info('coursesettings', new moodle_url('/grade/edit/settings/index.php', array('id'=>$courseid)), get_string('coursegradesettings', 'grades')); } if (self::$gradereportpreferences === null) { self::get_plugins_reports($courseid); } if (self::$gradereportpreferences) { self::$managesetting = array_merge(self::$managesetting, self::$gradereportpreferences); } return self::$managesetting; } /** * Returns an array of plugin reports as grade_plugin_info objects * * @param int $courseid * @return array */ public static function get_plugins_reports($courseid) { global $SITE, $CFG; if (self::$gradereports !== null) { return self::$gradereports; } $context = context_course::instance($courseid); $gradereports = array(); $gradepreferences = array(); foreach (core_component::get_plugin_list('gradereport') as $plugin => $plugindir) { //some reports make no sense if we're not within a course if ($courseid==$SITE->id && ($plugin=='grader' || $plugin=='user')) { continue; } // Remove outcomes report if outcomes not enabled. if ($plugin === 'outcomes' && empty($CFG->enableoutcomes)) { continue; } // Remove ones we can't see if (!has_capability('gradereport/'.$plugin.':view', $context)) { continue; } // Singleview doesn't doesn't accomodate for all cap combos yet, so this is hardcoded.. if ($plugin === 'singleview' && !has_all_capabilities(array('moodle/grade:viewall', 'moodle/grade:edit'), $context)) { continue; } $pluginstr = get_string('pluginname', 'gradereport_'.$plugin); $url = new moodle_url('/grade/report/'.$plugin.'/index.php', array('id'=>$courseid)); $gradereports[$plugin] = new grade_plugin_info($plugin, $url, $pluginstr); // Add link to preferences tab if such a page exists if (file_exists($plugindir.'/preferences.php')) { $url = new moodle_url('/grade/report/'.$plugin.'/preferences.php', array('id' => $courseid)); $gradepreferences[$plugin] = new grade_plugin_info($plugin, $url, get_string('preferences', 'grades') . ': ' . $pluginstr); } } if (count($gradereports) == 0) { $gradereports = false; $gradepreferences = false; } else if (count($gradepreferences) == 0) { $gradepreferences = false; asort($gradereports); } else { asort($gradereports); asort($gradepreferences); } self::$gradereports = $gradereports; self::$gradereportpreferences = $gradepreferences; return self::$gradereports; } /** * Get information on scales * @param int $courseid * @return grade_plugin_info */ public static function get_info_scales($courseid) { if (self::$scaleinfo !== null) { return self::$scaleinfo; } if (has_capability('moodle/course:managescales', context_course::instance($courseid))) { $url = new moodle_url('/grade/edit/scale/index.php', array('id'=>$courseid)); self::$scaleinfo = new grade_plugin_info('scale', $url, get_string('view')); } else { self::$scaleinfo = false; } return self::$scaleinfo; } /** * Get information on outcomes * @param int $courseid * @return grade_plugin_info[]|false */ public static function get_info_outcomes($courseid) { global $CFG, $SITE; if (self::$outcomeinfo !== null) { return self::$outcomeinfo; } $context = context_course::instance($courseid); $canmanage = has_capability('moodle/grade:manage', $context); $canupdate = has_capability('moodle/course:update', $context); if (!empty($CFG->enableoutcomes) && ($canmanage || $canupdate)) { $outcomes = array(); if ($canupdate) { if ($courseid!=$SITE->id) { $url = new moodle_url('/grade/edit/outcome/course.php', array('id'=>$courseid)); $outcomes['course'] = new grade_plugin_info('course', $url, get_string('outcomescourse', 'grades')); } $url = new moodle_url('/grade/edit/outcome/index.php', array('id'=>$courseid)); $outcomes['edit'] = new grade_plugin_info('edit', $url, get_string('editoutcomes', 'grades')); $url = new moodle_url('/grade/edit/outcome/import.php', array('courseid'=>$courseid)); $outcomes['import'] = new grade_plugin_info('import', $url, get_string('importoutcomes', 'grades')); } else { if ($courseid!=$SITE->id) { $url = new moodle_url('/grade/edit/outcome/course.php', array('id'=>$courseid)); $outcomes['edit'] = new grade_plugin_info('edit', $url, get_string('outcomescourse', 'grades')); } } self::$outcomeinfo = $outcomes; } else { self::$outcomeinfo = false; } return self::$outcomeinfo; } /** * Get information on letters * @param int $courseid * @return array */ public static function get_info_letters($courseid) { global $SITE; if (self::$letterinfo !== null) { return self::$letterinfo; } $context = context_course::instance($courseid); $canmanage = has_capability('moodle/grade:manage', $context); $canmanageletters = has_capability('moodle/grade:manageletters', $context); if ($canmanage || $canmanageletters) { // Redirect to system context when report is accessed from admin settings MDL-31633 if ($context->instanceid == $SITE->id) { $param = array('edit' => 1); } else { $param = array('edit' => 1,'id' => $context->id); } self::$letterinfo = array( 'view' => new grade_plugin_info('view', new moodle_url('/grade/edit/letter/index.php', array('id'=>$context->id)), get_string('view')), 'edit' => new grade_plugin_info('edit', new moodle_url('/grade/edit/letter/index.php', $param), get_string('edit')) ); } else { self::$letterinfo = false; } return self::$letterinfo; } /** * Get information import plugins * @param int $courseid * @return array */ public static function get_plugins_import($courseid) { global $CFG; if (self::$importplugins !== null) { return self::$importplugins; } $importplugins = array(); $context = context_course::instance($courseid); if (has_capability('moodle/grade:import', $context)) { foreach (core_component::get_plugin_list('gradeimport') as $plugin => $plugindir) { if (!has_capability('gradeimport/'.$plugin.':view', $context)) { continue; } $pluginstr = get_string('pluginname', 'gradeimport_'.$plugin); $url = new moodle_url('/grade/import/'.$plugin.'/index.php', array('id'=>$courseid)); $importplugins[$plugin] = new grade_plugin_info($plugin, $url, $pluginstr); } // Show key manager if grade publishing is enabled and the user has xml publishing capability. // XML is the only grade import plugin that has publishing feature. if ($CFG->gradepublishing && has_capability('gradeimport/xml:publish', $context)) { $url = new moodle_url('/grade/import/keymanager.php', array('id'=>$courseid)); $importplugins['keymanager'] = new grade_plugin_info('keymanager', $url, get_string('keymanager', 'grades')); } } if (count($importplugins) > 0) { asort($importplugins); self::$importplugins = $importplugins; } else { self::$importplugins = false; } return self::$importplugins; } /** * Get information export plugins * @param int $courseid * @return array */ public static function get_plugins_export($courseid) { global $CFG; if (self::$exportplugins !== null) { return self::$exportplugins; } $context = context_course::instance($courseid); $exportplugins = array(); $canpublishgrades = 0; if (has_capability('moodle/grade:export', $context)) { foreach (core_component::get_plugin_list('gradeexport') as $plugin => $plugindir) { if (!has_capability('gradeexport/'.$plugin.':view', $context)) { continue; } // All the grade export plugins has grade publishing capabilities. if (has_capability('gradeexport/'.$plugin.':publish', $context)) { $canpublishgrades++; } $pluginstr = get_string('pluginname', 'gradeexport_'.$plugin); $url = new moodle_url('/grade/export/'.$plugin.'/index.php', array('id'=>$courseid)); $exportplugins[$plugin] = new grade_plugin_info($plugin, $url, $pluginstr); } // Show key manager if grade publishing is enabled and the user has at least one grade publishing capability. if ($CFG->gradepublishing && $canpublishgrades != 0) { $url = new moodle_url('/grade/export/keymanager.php', array('id'=>$courseid)); $exportplugins['keymanager'] = new grade_plugin_info('keymanager', $url, get_string('keymanager', 'grades')); } } if (count($exportplugins) > 0) { asort($exportplugins); self::$exportplugins = $exportplugins; } else { self::$exportplugins = false; } return self::$exportplugins; } /** * Returns the value of a field from a user record * * @param stdClass $user object * @param stdClass $field object * @return string value of the field */ public static function get_user_field_value($user, $field) { if (!empty($field->customid)) { $fieldname = 'customfield_' . $field->customid; if (!empty($user->{$fieldname}) || is_numeric($user->{$fieldname})) { $fieldvalue = $user->{$fieldname}; } else { $fieldvalue = $field->default; } } else { $fieldvalue = $user->{$field->shortname}; } return $fieldvalue; } /** * Returns an array of user profile fields to be included in export * * @param int $courseid * @param bool $includecustomfields * @return array An array of stdClass instances with customid, shortname, datatype, default and fullname fields */ public static function get_user_profile_fields($courseid, $includecustomfields = false) { global $CFG, $DB; // Gets the fields that have to be hidden $hiddenfields = array_map('trim', explode(',', $CFG->hiddenuserfields)); $context = context_course::instance($courseid); $canseehiddenfields = has_capability('moodle/course:viewhiddenuserfields', $context); if ($canseehiddenfields) { $hiddenfields = array(); } $fields = array(); require_once($CFG->dirroot.'/user/lib.php'); // Loads user_get_default_fields() require_once($CFG->dirroot.'/user/profile/lib.php'); // Loads constants, such as PROFILE_VISIBLE_ALL $userdefaultfields = user_get_default_fields(); // Sets the list of profile fields $userprofilefields = array_map('trim', explode(',', $CFG->grade_export_userprofilefields)); if (!empty($userprofilefields)) { foreach ($userprofilefields as $field) { $field = trim($field); if (in_array($field, $hiddenfields) || !in_array($field, $userdefaultfields)) { continue; } $obj = new stdClass(); $obj->customid = 0; $obj->shortname = $field; $obj->fullname = get_string($field); $fields[] = $obj; } } // Sets the list of custom profile fields $customprofilefields = array_map('trim', explode(',', $CFG->grade_export_customprofilefields)); if ($includecustomfields && !empty($customprofilefields)) { $customfields = profile_get_user_fields_with_data(0); foreach ($customfields as $fieldobj) { $field = (object)$fieldobj->get_field_config_for_external(); // Make sure we can display this custom field if (!in_array($field->shortname, $customprofilefields)) { continue; } else if (in_array($field->shortname, $hiddenfields)) { continue; } else if ($field->visible != PROFILE_VISIBLE_ALL && !$canseehiddenfields) { continue; } $obj = new stdClass(); $obj->customid = $field->id; $obj->shortname = $field->shortname; $obj->fullname = format_string($field->name); $obj->datatype = $field->datatype; $obj->default = $field->defaultdata; $fields[] = $obj; } } return $fields; } /** * This helper method gets a snapshot of all the weights for a course. * It is used as a quick method to see if any wieghts have been automatically adjusted. * @param int $courseid * @return array of itemid -> aggregationcoef2 */ public static function fetch_all_natural_weights_for_course($courseid) { global $DB; $result = array(); $records = $DB->get_records('grade_items', array('courseid'=>$courseid), 'id', 'id, aggregationcoef2'); foreach ($records as $record) { $result[$record->id] = $record->aggregationcoef2; } return $result; } /** * Resets all static caches. * * @return void */ public static function reset_caches() { self::$managesetting = null; self::$gradereports = null; self::$gradereportpreferences = null; self::$scaleinfo = null; self::$outcomeinfo = null; self::$letterinfo = null; self::$importplugins = null; self::$exportplugins = null; self::$pluginstrings = null; self::$aggregationstrings = null; } } grading/manage.php 0000604 00000025276 15062070555 0010135 0 ustar 00 <?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/>. /** * A single gradable area management page * * This page alows the user to set the current active method in the given * area, provides access to the plugin editor and allows user to save the * current form as a template or re-use some existing form. * * @package core_grading * @copyright 2011 David Mudrak <david@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require(__DIR__.'/../../config.php'); require_once($CFG->dirroot.'/grade/grading/lib.php'); // identify gradable area by its id $areaid = optional_param('areaid', null, PARAM_INT); // alternatively the context, component and areaname must be provided $contextid = optional_param('contextid', null, PARAM_INT); $component = optional_param('component', null, PARAM_COMPONENT); $area = optional_param('area', null, PARAM_AREA); // keep the caller's URL so that we know where to send the user finally $returnurl = optional_param('returnurl', null, PARAM_LOCALURL); // active method selector $setmethod = optional_param('setmethod', null, PARAM_PLUGIN); // publish the given form definition as a new template in the forms bank $shareform = optional_param('shareform', null, PARAM_INT); // delete the given form definition $deleteform = optional_param('deleteform', null, PARAM_INT); // consider the required action as confirmed $confirmed = optional_param('confirmed', false, PARAM_BOOL); // a message to display, typically a previous action's result $message = optional_param('message', null, PARAM_NOTAGS); if (!is_null($areaid)) { // get manager by id $manager = get_grading_manager($areaid); } else { // get manager by context and component if (is_null($contextid) or is_null($component) or is_null($area)) { throw new coding_exception('The caller script must identify the gradable area.'); } $context = context::instance_by_id($contextid, MUST_EXIST); $manager = get_grading_manager($context, $component, $area); } if ($manager->get_context()->contextlevel < CONTEXT_COURSE) { throw new coding_exception('Unsupported gradable area context level'); } // get the currently active method $method = $manager->get_active_method(); list($context, $course, $cm) = get_context_info_array($manager->get_context()->id); require_login($course, true, $cm); require_capability('moodle/grade:managegradingforms', $context); if (!empty($returnurl)) { $returnurl = new moodle_url($returnurl); } else { $returnurl = null; } $PAGE->set_url($manager->get_management_url($returnurl)); navigation_node::override_active_url($manager->get_management_url()); $PAGE->set_title(get_string('gradingmanagement', 'core_grading')); $PAGE->set_heading(get_string('gradingmanagement', 'core_grading')); // We don't need to show the default header on a management page. $PAGE->activityheader->disable(); $output = $PAGE->get_renderer('core_grading'); // process the eventual change of the active grading method if (!empty($setmethod)) { require_sesskey(); if ($setmethod == 'none') { // here we expect that noone would actually want to call their plugin as 'none' $setmethod = null; } $manager->set_active_method($setmethod); redirect($PAGE->url); } // publish the form as a template if (!empty($shareform)) { require_capability('moodle/grade:sharegradingforms', context_system::instance()); $controller = $manager->get_controller($method); $definition = $controller->get_definition(); if (!$confirmed) { // let the user confirm they understand what they are doing (haha ;-) echo $output->header(); echo $output->confirm(get_string('manageactionshareconfirm', 'core_grading', s($definition->name)), new moodle_url($PAGE->url, array('shareform' => $shareform, 'confirmed' => 1)), $PAGE->url); echo $output->footer(); die(); } else { require_sesskey(); $newareaid = $manager->create_shared_area($method); $targetarea = get_grading_manager($newareaid); $targetcontroller = $targetarea->get_controller($method); $targetcontroller->update_definition($controller->get_definition_copy($targetcontroller)); $DB->set_field('grading_definitions', 'timecopied', time(), array('id' => $definition->id)); redirect(new moodle_url($PAGE->url, array('message' => get_string('manageactionsharedone', 'core_grading')))); } } // delete the form definition if (!empty($deleteform)) { $controller = $manager->get_controller($method); $definition = $controller->get_definition(); if (!$confirmed) { // let the user confirm they understand the consequences (also known as WTF-effect) echo $output->header(); echo $output->confirm(markdown_to_html(get_string('manageactiondeleteconfirm', 'core_grading', array( 'formname' => s($definition->name), 'component' => $manager->get_component_title(), 'area' => $manager->get_area_title()))), new moodle_url($PAGE->url, array('deleteform' => $deleteform, 'confirmed' => 1)), $PAGE->url); echo $output->footer(); die(); } else { require_sesskey(); $controller->delete_definition(); redirect(new moodle_url($PAGE->url, array('message' => get_string('manageactiondeletedone', 'core_grading')))); } } echo $output->header(); if (!empty($message)) { echo $output->management_message($message); } if ($PAGE->has_secondary_navigation()) { echo $output->heading(get_string('gradingmanagement', 'core_grading')); } else { echo $output->heading(get_string('gradingmanagementtitle', 'core_grading', array( 'component' => $manager->get_component_title(), 'area' => $manager->get_area_title()))); } // display the active grading method information and selector echo $output->management_method_selector($manager, $PAGE->url); // get the currently active method's controller if (!empty($method)) { $controller = $manager->get_controller($method); // display relevant actions echo $output->container_start('actions'); if ($controller->is_form_defined()) { $definition = $controller->get_definition(); // icon to edit the form definition echo $output->management_action_icon($controller->get_editor_url($returnurl), get_string('manageactionedit', 'core_grading'), 'b/document-edit'); // icon to delete the current form definition echo $output->management_action_icon(new moodle_url($PAGE->url, array('deleteform' => $definition->id)), get_string('manageactiondelete', 'core_grading'), 'b/edit-delete'); // icon to save the form as a new template if (has_capability('moodle/grade:sharegradingforms', context_system::instance())) { if (empty($definition->copiedfromid)) { $hasoriginal = false; } else { $hasoriginal = $DB->record_exists('grading_definitions', array('id' => $definition->copiedfromid)); } if (!$controller->is_form_available()) { // drafts can not be shared $allowshare = false; } else if (!$hasoriginal) { // was created from scratch or is orphaned if (empty($definition->timecopied)) { // was never shared before $allowshare = true; } else if ($definition->timemodified > $definition->timecopied) { // was modified since last time shared $allowshare = true; } else { // was not modified since last time shared $allowshare = false; } } else { // was created from a template and the template still exists if ($definition->timecreated == $definition->timemodified) { // was not modified since created $allowshare = false; } else if (empty($definition->timecopied)) { // was modified but was not re-shared yet $allowshare = true; } else if ($definition->timemodified > $definition->timecopied) { // was modified since last time re-shared $allowshare = true; } else { // was not modified since last time re-shared $allowshare = false; } } if ($allowshare) { echo $output->management_action_icon(new moodle_url($PAGE->url, array('shareform' => $definition->id)), get_string('manageactionshare', 'core_grading'), 'b/bookmark-new'); } } } else { echo $output->management_action_icon($controller->get_editor_url($returnurl), get_string('manageactionnew', 'core_grading'), 'b/document-new'); $pickurl = new moodle_url('/grade/grading/pick.php', array('targetid' => $controller->get_areaid())); if (!is_null($returnurl)) { $pickurl->param('returnurl', $returnurl->out(false)); } echo $output->management_action_icon($pickurl, get_string('manageactionclone', 'core_grading'), 'b/edit-copy'); } echo $output->container_end(); // display the message if the form is currently not available (if applicable) if ($message = $controller->form_unavailable_notification()) { echo $output->notification($message); } // display the grading form preview if ($controller->is_form_defined()) { if ($definition->status == gradingform_controller::DEFINITION_STATUS_READY) { $tag = html_writer::tag('span', get_string('statusready', 'core_grading'), array('class' => 'status ready')); } else { $tag = html_writer::tag('span', get_string('statusdraft', 'core_grading'), array('class' => 'status draft')); } echo $output->heading(format_string($definition->name) . ' ' . $tag, 3, 'definition-name'); echo $output->box($controller->render_preview($PAGE), 'definition-preview'); } } echo $output->footer(); grading/pick_form.php 0000604 00000003706 15062070555 0010650 0 ustar 00 <?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/>. /** * Defines forms used by pick.php * * @package core_grading * @copyright 2011 David Mudrak <david@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); require_once($CFG->dirroot.'/lib/formslib.php'); /** * Allows to search for a specific shared template * * @package core_grading * @copyright 2011 David Mudrak <david@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class grading_search_template_form extends moodleform { /** * Pretty simple search box */ public function definition() { $mform = $this->_form; $mform->addElement('header', 'searchheader', get_string('searchtemplate', 'core_grading')); $mform->addHelpButton('searchheader', 'searchtemplate', 'core_grading'); $mform->addGroup(array( $mform->createElement('checkbox', 'mode', '', get_string('searchownforms', 'core_grading')), $mform->createElement('text', 'needle', '', array('size' => 30)), $mform->createElement('submit', 'submitbutton', get_string('search')), ), 'buttonar', '', array(' '), false); $mform->setType('needle', PARAM_TEXT); $mform->setType('buttonar', PARAM_RAW); } } grading/form/upgrade.txt 0000604 00000001325 15062070555 0011314 0 ustar 00 This files describes API changes in /grade/grading/form/* - Advanced grading methods information provided here is intended especially for developers. === 3.10 === * Removed gradingform_provider. * Removed the following deprecated functions: get_gradingform_export_data delete_gradingform_for_context delete_gradingform_for_userid === 3.6 === * The privacy interface gradingform_provider has been deprecated. Please use gradingform_provider_v2 instead. === 2.5.2 === * Grading methods now can return grade with decimals. See API functions gradingform_controller::set_grade_range() and gradingform_controller::get_allow_grade_decimals(), and also examples in gradingform_rubric_instance::get_grade(). grading/form/rubric/rubriceditor.php 0000604 00000040332 15062070555 0013621 0 ustar 00 <?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 contains definition of class MoodleQuickForm_rubriceditor * * @package gradingform_rubric * @copyright 2011 Marina Glancy * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); require_once("HTML/QuickForm/input.php"); /** * Form element for handling rubric editor * * The rubric editor is defined as a separate form element. This allows us to render * criteria, levels and buttons using the rubric's own renderer. Also, the required * Javascript library is included, which processes, on the client, buttons needed * for reordering, adding and deleting criteria. * * If Javascript is disabled when one of those special buttons is pressed, the form * element is not validated and, instead of submitting the form, we process button presses. * * @package gradingform_rubric * @copyright 2011 Marina Glancy * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class MoodleQuickForm_rubriceditor extends HTML_QuickForm_input { /** @var string help message */ public $_helpbutton = ''; /** @var string|bool stores the result of the last validation: null - undefined, false - no errors, string - error(s) text */ protected $validationerrors = null; /** @var bool if element has already been validated **/ protected $wasvalidated = false; /** @var bool If non-submit (JS) button was pressed: null - unknown, true/false - button was/wasn't pressed */ protected $nonjsbuttonpressed = false; /** @var bool Message to display in front of the editor (that there exist grades on this rubric being edited) */ protected $regradeconfirmation = false; /** * Constructor for rubric editor * * @param string $elementName * @param string $elementLabel * @param array $attributes */ public function __construct($elementName=null, $elementLabel=null, $attributes=null) { parent::__construct($elementName, $elementLabel, $attributes); } /** * Old syntax of class constructor. Deprecated in PHP7. * * @deprecated since Moodle 3.1 */ public function MoodleQuickForm_rubriceditor($elementName=null, $elementLabel=null, $attributes=null) { debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER); self::__construct($elementName, $elementLabel, $attributes); } /** * get html for help button * * @return string html for help button */ public function getHelpButton() { return $this->_helpbutton; } /** * The renderer will take care itself about different display in normal and frozen states * * @return string */ public function getElementTemplateType() { return 'default'; } /** * Specifies that confirmation about re-grading needs to be added to this rubric editor. * $changelevel is saved in $this->regradeconfirmation and retrieved in toHtml() * * @see gradingform_rubric_controller::update_or_check_rubric() * @param int $changelevel */ public function add_regrade_confirmation($changelevel) { $this->regradeconfirmation = $changelevel; } /** * Returns html string to display this element * * @return string */ public function toHtml() { global $PAGE; $html = $this->_getTabs(); $renderer = $PAGE->get_renderer('gradingform_rubric'); $data = $this->prepare_data(null, $this->wasvalidated); if (!$this->_flagFrozen) { $mode = gradingform_rubric_controller::DISPLAY_EDIT_FULL; $module = array('name'=>'gradingform_rubriceditor', 'fullpath'=>'/grade/grading/form/rubric/js/rubriceditor.js', 'requires' => array('base', 'dom', 'event', 'event-touch', 'escape'), 'strings' => array(array('confirmdeletecriterion', 'gradingform_rubric'), array('confirmdeletelevel', 'gradingform_rubric'), array('criterionempty', 'gradingform_rubric'), array('levelempty', 'gradingform_rubric') )); $PAGE->requires->js_init_call('M.gradingform_rubriceditor.init', array( array('name' => $this->getName(), 'criteriontemplate' => $renderer->criterion_template($mode, $data['options'], $this->getName()), 'leveltemplate' => $renderer->level_template($mode, $data['options'], $this->getName()) )), true, $module); } else { // Rubric is frozen, no javascript needed if ($this->_persistantFreeze) { $mode = gradingform_rubric_controller::DISPLAY_EDIT_FROZEN; } else { $mode = gradingform_rubric_controller::DISPLAY_PREVIEW; } } if ($this->regradeconfirmation) { if (!isset($data['regrade'])) { $data['regrade'] = 1; } $html .= $renderer->display_regrade_confirmation($this->getName(), $this->regradeconfirmation, $data['regrade']); } if ($this->validationerrors) { $html .= html_writer::div($renderer->notification($this->validationerrors)); } $html .= $renderer->display_rubric($data['criteria'], $data['options'], $mode, $this->getName()); return $html; } /** * Prepares the data passed in $_POST: * - processes the pressed buttons 'addlevel', 'addcriterion', 'moveup', 'movedown', 'delete' (when JavaScript is disabled) * sets $this->nonjsbuttonpressed to true/false if such button was pressed * - if options not passed (i.e. we create a new rubric) fills the options array with the default values * - if options are passed completes the options array with unchecked checkboxes * - if $withvalidation is set, adds 'error_xxx' attributes to elements that contain errors and creates an error string * and stores it in $this->validationerrors * * @param array $value * @param boolean $withvalidation whether to enable data validation * @return array */ protected function prepare_data($value = null, $withvalidation = false) { if (null === $value) { $value = $this->getValue(); } if ($this->nonjsbuttonpressed === null) { $this->nonjsbuttonpressed = false; } $totalscore = 0; $errors = array(); $return = array('criteria' => array(), 'options' => gradingform_rubric_controller::get_default_options()); if (!isset($value['criteria'])) { $value['criteria'] = array(); $errors['err_nocriteria'] = 1; } // If options are present in $value, replace default values with submitted values if (!empty($value['options'])) { foreach (array_keys($return['options']) as $option) { // special treatment for checkboxes if (!empty($value['options'][$option])) { $return['options'][$option] = $value['options'][$option]; } else { $return['options'][$option] = null; } } } if (is_array($value)) { // for other array keys of $value no special treatmeant neeeded, copy them to return value as is foreach (array_keys($value) as $key) { if ($key != 'options' && $key != 'criteria') { $return[$key] = $value[$key]; } } } // iterate through criteria $lastaction = null; $lastid = null; $overallminscore = $overallmaxscore = 0; foreach ($value['criteria'] as $id => $criterion) { if ($id == 'addcriterion') { $id = $this->get_next_id(array_keys($value['criteria'])); $criterion = array('description' => '', 'levels' => array()); $i = 0; // when adding new criterion copy the number of levels and their scores from the last criterion if (!empty($value['criteria'][$lastid]['levels'])) { foreach ($value['criteria'][$lastid]['levels'] as $lastlevel) { $criterion['levels']['NEWID'.($i++)]['score'] = $lastlevel['score']; } } else { $criterion['levels']['NEWID'.($i++)]['score'] = 0; } // add more levels so there are at least 3 in the new criterion. Increment by 1 the score for each next one for ($i=$i; $i<3; $i++) { $criterion['levels']['NEWID'.$i]['score'] = $criterion['levels']['NEWID'.($i-1)]['score'] + 1; } // set other necessary fields (definition) for the levels in the new criterion foreach (array_keys($criterion['levels']) as $i) { $criterion['levels'][$i]['definition'] = ''; } $this->nonjsbuttonpressed = true; } $levels = array(); $minscore = $maxscore = null; if (array_key_exists('levels', $criterion)) { foreach ($criterion['levels'] as $levelid => $level) { if ($levelid == 'addlevel') { $levelid = $this->get_next_id(array_keys($criterion['levels'])); $level = array( 'definition' => '', 'score' => 0, ); foreach ($criterion['levels'] as $lastlevel) { if (isset($lastlevel['score'])) { $level['score'] = max($level['score'], ceil(unformat_float($lastlevel['score'])) + 1); } } $this->nonjsbuttonpressed = true; } if (!array_key_exists('delete', $level)) { $score = unformat_float($level['score'], true); if ($withvalidation) { if (!strlen(trim($level['definition']))) { $errors['err_nodefinition'] = 1; $level['error_definition'] = true; } if ($score === null || $score === false) { $errors['err_scoreformat'] = 1; $level['error_score'] = true; } } $levels[$levelid] = $level; if ($minscore === null || $score < $minscore) { $minscore = $score; } if ($maxscore === null || $score > $maxscore) { $maxscore = $score; } } else { $this->nonjsbuttonpressed = true; } } } $totalscore += (float)$maxscore; $criterion['levels'] = $levels; if ($withvalidation && !array_key_exists('delete', $criterion)) { if (count($levels)<2) { $errors['err_mintwolevels'] = 1; $criterion['error_levels'] = true; } if (!strlen(trim($criterion['description']))) { $errors['err_nodescription'] = 1; $criterion['error_description'] = true; } $overallmaxscore += $maxscore; $overallminscore += $minscore; } if (array_key_exists('moveup', $criterion) || $lastaction == 'movedown') { unset($criterion['moveup']); if ($lastid !== null) { $lastcriterion = $return['criteria'][$lastid]; unset($return['criteria'][$lastid]); $return['criteria'][$id] = $criterion; $return['criteria'][$lastid] = $lastcriterion; } else { $return['criteria'][$id] = $criterion; } $lastaction = null; $lastid = $id; $this->nonjsbuttonpressed = true; } else if (array_key_exists('delete', $criterion)) { $this->nonjsbuttonpressed = true; } else { if (array_key_exists('movedown', $criterion)) { unset($criterion['movedown']); $lastaction = 'movedown'; $this->nonjsbuttonpressed = true; } $return['criteria'][$id] = $criterion; $lastid = $id; } } if ($totalscore <= 0) { $errors['err_totalscore'] = 1; } // add sort order field to criteria $csortorder = 1; foreach (array_keys($return['criteria']) as $id) { $return['criteria'][$id]['sortorder'] = $csortorder++; } // create validation error string (if needed) if ($withvalidation) { if (!$return['options']['lockzeropoints']) { if ($overallminscore == $overallmaxscore) { $errors['err_novariations'] = 1; } } if (count($errors)) { $rv = array(); foreach ($errors as $error => $v) { $rv[] = get_string($error, 'gradingform_rubric'); } $this->validationerrors = join('<br/ >', $rv); } else { $this->validationerrors = false; } $this->wasvalidated = true; } return $return; } /** * Scans array $ids to find the biggest element ! NEWID*, increments it by 1 and returns * * @param array $ids * @return string */ protected function get_next_id($ids) { $maxid = 0; foreach ($ids as $id) { if (preg_match('/^NEWID(\d+)$/', $id, $matches) && ((int)$matches[1]) > $maxid) { $maxid = (int)$matches[1]; } } return 'NEWID'.($maxid+1); } /** * Checks if a submit button was pressed which is supposed to be processed on client side by JS * but user seem to have disabled JS in the browser. * (buttons 'add criteria', 'add level', 'move up', 'move down', etc.) * In this case the form containing this element is prevented from being submitted * * @param array $value * @return boolean true if non-submit button was pressed and not processed by JS */ public function non_js_button_pressed($value) { if ($this->nonjsbuttonpressed === null) { $this->prepare_data($value); } return $this->nonjsbuttonpressed; } /** * Validates that rubric has at least one criterion, at least two levels within one criterion, * each level has a valid score, all levels have filled definitions and all criteria * have filled descriptions * * @param array $value * @return string|false error text or false if no errors found */ public function validate($value) { if (!$this->wasvalidated) { $this->prepare_data($value, true); } return $this->validationerrors; } /** * Prepares the data for saving * * @see prepare_data() * @param array $submitValues * @param boolean $assoc * @return array */ public function exportValue(&$submitValues, $assoc = false) { $value = $this->prepare_data($this->_findValue($submitValues)); return $this->_prepareValue($value, $assoc); } } grading/form/rubric/edit_form.php 0000604 00000021417 15062070555 0013077 0 ustar 00 <?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/>. /** * The form used at the rubric editor page is defined here * * @package gradingform_rubric * @copyright 2011 Marina Glancy <marina@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); require_once($CFG->dirroot.'/lib/formslib.php'); require_once(__DIR__.'/rubriceditor.php'); MoodleQuickForm::registerElementType('rubriceditor', $CFG->dirroot.'/grade/grading/form/rubric/rubriceditor.php', 'MoodleQuickForm_rubriceditor'); /** * Defines the rubric edit form * * @package gradingform_rubric * @copyright 2011 Marina Glancy <marina@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class gradingform_rubric_editrubric extends moodleform { /** * Form element definition */ public function definition() { $form = $this->_form; $form->addElement('hidden', 'areaid'); $form->setType('areaid', PARAM_INT); $form->addElement('hidden', 'returnurl'); $form->setType('returnurl', PARAM_LOCALURL); // name $form->addElement('text', 'name', get_string('name', 'gradingform_rubric'), array('size' => 52, 'aria-required' => 'true')); $form->addRule('name', get_string('required'), 'required', null, 'client'); $form->setType('name', PARAM_TEXT); // description $options = gradingform_rubric_controller::description_form_field_options($this->_customdata['context']); $form->addElement('editor', 'description_editor', get_string('description', 'gradingform_rubric'), null, $options); $form->setType('description_editor', PARAM_RAW); // rubric completion status $choices = array(); $choices[gradingform_controller::DEFINITION_STATUS_DRAFT] = html_writer::tag('span', get_string('statusdraft', 'core_grading'), array('class' => 'status draft')); $choices[gradingform_controller::DEFINITION_STATUS_READY] = html_writer::tag('span', get_string('statusready', 'core_grading'), array('class' => 'status ready')); $form->addElement('select', 'status', get_string('rubricstatus', 'gradingform_rubric'), $choices)->freeze(); // rubric editor $form->addElement('rubriceditor', 'rubric', get_string('rubric', 'gradingform_rubric')); $form->setType('rubric', PARAM_RAW); $buttonarray = array(); $buttonarray[] = &$form->createElement('submit', 'saverubric', get_string('saverubric', 'gradingform_rubric')); if ($this->_customdata['allowdraft']) { $buttonarray[] = &$form->createElement('submit', 'saverubricdraft', get_string('saverubricdraft', 'gradingform_rubric')); } $editbutton = &$form->createElement('submit', 'editrubric', ' '); $editbutton->freeze(); $buttonarray[] = &$editbutton; $buttonarray[] = &$form->createElement('cancel'); $form->addGroup($buttonarray, 'buttonar', '', array(' '), false); $form->closeHeaderBefore('buttonar'); } /** * Setup the form depending on current values. This method is called after definition(), * data submission and set_data(). * All form setup that is dependent on form values should go in here. * * We remove the element status if there is no current status (i.e. rubric is only being created) * so the users do not get confused */ public function definition_after_data() { $form = $this->_form; $el = $form->getElement('status'); if (!$el->getValue()) { $form->removeElement('status'); } else { $vals = array_values($el->getValue()); if ($vals[0] == gradingform_controller::DEFINITION_STATUS_READY) { $this->findButton('saverubric')->setValue(get_string('save', 'gradingform_rubric')); } } } /** * Form vlidation. * If there are errors return array of errors ("fieldname"=>"error message"), * otherwise true if ok. * * @param array $data array of ("fieldname"=>value) of submitted data * @param array $files array of uploaded files "element_name"=>tmp_file_path * @return array of "element_name"=>"error_description" if there are errors, * or an empty array if everything is OK (true allowed for backwards compatibility too). */ public function validation($data, $files) { $err = parent::validation($data, $files); $err = array(); $form = $this->_form; $rubricel = $form->getElement('rubric'); if ($rubricel->non_js_button_pressed($data['rubric'])) { // if JS is disabled and button such as 'Add criterion' is pressed - prevent from submit $err['rubricdummy'] = 1; } else if (isset($data['editrubric'])) { // continue editing $err['rubricdummy'] = 1; } else if (isset($data['saverubric']) && $data['saverubric']) { // If user attempts to make rubric active - it needs to be validated if ($rubricel->validate($data['rubric']) !== false) { $err['rubricdummy'] = 1; } } return $err; } /** * Return submitted data if properly submitted or returns NULL if validation fails or * if there is no submitted data. * * @return object submitted data; NULL if not valid or not submitted or cancelled */ public function get_data() { $data = parent::get_data(); if (!empty($data->saverubric)) { $data->status = gradingform_controller::DEFINITION_STATUS_READY; } else if (!empty($data->saverubricdraft)) { $data->status = gradingform_controller::DEFINITION_STATUS_DRAFT; } return $data; } /** * Check if there are changes in the rubric and it is needed to ask user whether to * mark the current grades for re-grading. User may confirm re-grading and continue, * return to editing or cancel the changes * * @param gradingform_rubric_controller $controller */ public function need_confirm_regrading($controller) { $data = $this->get_data(); if (isset($data->rubric['regrade'])) { // we have already displayed the confirmation on the previous step return false; } if (!isset($data->saverubric) || !$data->saverubric) { // we only need confirmation when button 'Save rubric' is pressed return false; } if (!$controller->has_active_instances()) { // nothing to re-grade, confirmation not needed return false; } $changelevel = $controller->update_or_check_rubric($data); if ($changelevel == 0) { // no changes in the rubric, no confirmation needed return false; } // freeze form elements and pass the values in hidden fields // TODO MDL-29421 description_editor does not freeze the normal way, uncomment below when fixed $form = $this->_form; foreach (array('rubric', 'name'/*, 'description_editor'*/) as $fieldname) { $el =& $form->getElement($fieldname); $el->freeze(); $el->setPersistantFreeze(true); if ($fieldname == 'rubric') { $el->add_regrade_confirmation($changelevel); } } // replace button text 'saverubric' and unfreeze 'Back to edit' button $this->findButton('saverubric')->setValue(get_string('continue')); $el =& $this->findButton('editrubric'); $el->setValue(get_string('backtoediting', 'gradingform_rubric')); $el->unfreeze(); return true; } /** * Returns a form element (submit button) with the name $elementname * * @param string $elementname * @return HTML_QuickForm_element */ protected function &findButton($elementname) { $form = $this->_form; $buttonar =& $form->getElement('buttonar'); $elements =& $buttonar->getElements(); foreach ($elements as $el) { if ($el->getName() == $elementname) { return $el; } } return null; } } grading/form/rubric/pix/icon.png 0000604 00000000223 15062070555 0012644 0 ustar 00 �PNG IHDR �a bKGD � � ����� HIDAT8�� �0 /�,��T�h� ���R��$k�0y�� 0�� �Rkw_y�� �]��� /�@6��̉;�W=�K IEND�B`� grading/form/rubric/pix/icon.svg 0000604 00000001006 15062070555 0012657 0 ustar 00 <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd" [ <!ENTITY ns_flows "http://ns.adobe.com/Flows/1.0/"> ]><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 16 16" preserveAspectRatio="xMinYMid meet" overflow="visible"><path d="M15 0H1C.5 0 0 .5 0 1v14c0 .5.5 1 1 1h14c.5 0 1-.5 1-1V1c0-.5-.5-1-1-1zM8 14H2v-2h6v2zm0-3H2V9h6v2zm0-3H2V6h6v2zm3 6H9v-2h2v2zm0-3H9V9h2v2zm0-3H9V6h2v2zm3 6h-2v-2h2v2zm0-3h-2V9h2v2zm0-3h-2V6h2v2z" fill="#888"/></svg> grading/form/rubric/backup/moodle2/backup_gradingform_rubric_plugin.class.php 0000604 00000010561 15062070555 0023607 0 ustar 00 <?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/>. /** * Support for backup API * * @package gradingform_rubric * @copyright 2011 David Mudrak <david@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); /** * Defines rubric backup structures * * @package gradingform_rubric * @copyright 2011 David Mudrak <david@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class backup_gradingform_rubric_plugin extends backup_gradingform_plugin { /** * Declares rubric structures to append to the grading form definition */ protected function define_definition_plugin_structure() { // Append data only if the grand-parent element has 'method' set to 'rubric' $plugin = $this->get_plugin_element(null, '../../method', 'rubric'); // Create a visible container for our data $pluginwrapper = new backup_nested_element($this->get_recommended_name()); // Connect our visible container to the parent $plugin->add_child($pluginwrapper); // Define our elements $criteria = new backup_nested_element('criteria'); $criterion = new backup_nested_element('criterion', array('id'), array( 'sortorder', 'description', 'descriptionformat')); $levels = new backup_nested_element('levels'); $level = new backup_nested_element('level', array('id'), array( 'score', 'definition', 'definitionformat')); // Build elements hierarchy $pluginwrapper->add_child($criteria); $criteria->add_child($criterion); $criterion->add_child($levels); $levels->add_child($level); // Set sources to populate the data $criterion->set_source_table('gradingform_rubric_criteria', array('definitionid' => backup::VAR_PARENTID)); $level->set_source_table('gradingform_rubric_levels', array('criterionid' => backup::VAR_PARENTID)); // no need to annotate ids or files yet (one day when criterion definition supports // embedded files, they must be annotated here) return $plugin; } /** * Declares rubric structures to append to the grading form instances */ protected function define_instance_plugin_structure() { // Append data only if the ancestor 'definition' element has 'method' set to 'rubric' $plugin = $this->get_plugin_element(null, '../../../../method', 'rubric'); // Create a visible container for our data $pluginwrapper = new backup_nested_element($this->get_recommended_name()); // Connect our visible container to the parent $plugin->add_child($pluginwrapper); // Define our elements $fillings = new backup_nested_element('fillings'); $filling = new backup_nested_element('filling', array('id'), array( 'criterionid', 'levelid', 'remark', 'remarkformat')); // Build elements hierarchy $pluginwrapper->add_child($fillings); $fillings->add_child($filling); // Set sources to populate the data // Binding criterionid to ensure it's existence $filling->set_source_sql('SELECT rf.* FROM {gradingform_rubric_fillings} rf JOIN {grading_instances} gi ON gi.id = rf.instanceid JOIN {gradingform_rubric_criteria} rc ON rc.id = rf.criterionid AND gi.definitionid = rc.definitionid WHERE rf.instanceid = :instanceid', array('instanceid' => backup::VAR_PARENTID)); // no need to annotate ids or files yet (one day when remark field supports // embedded fileds, they must be annotated here) return $plugin; } } grading/form/rubric/backup/moodle2/restore_gradingform_rubric_plugin.class.php 0000604 00000007657 15062070555 0024041 0 ustar 00 <?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/>. /** * Support for restore API * * @package gradingform_rubric * @copyright 2011 David Mudrak <david@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); /** * Restores the rubric specific data from grading.xml file * * @package gradingform_rubric * @copyright 2011 David Mudrak <david@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class restore_gradingform_rubric_plugin extends restore_gradingform_plugin { /** * Declares the rubric XML paths attached to the form definition element * * @return array of {@link restore_path_element} */ protected function define_definition_plugin_structure() { $paths = array(); $paths[] = new restore_path_element('gradingform_rubric_criterion', $this->get_pathfor('/criteria/criterion')); $paths[] = new restore_path_element('gradingform_rubric_level', $this->get_pathfor('/criteria/criterion/levels/level')); return $paths; } /** * Declares the rubric XML paths attached to the form instance element * * @return array of {@link restore_path_element} */ protected function define_instance_plugin_structure() { $paths = array(); $paths[] = new restore_path_element('gradinform_rubric_filling', $this->get_pathfor('/fillings/filling')); return $paths; } /** * Processes criterion element data * * Sets the mapping 'gradingform_rubric_criterion' to be used later by * {@link self::process_gradinform_rubric_filling()} * * @param stdClass|array $data */ public function process_gradingform_rubric_criterion($data) { global $DB; $data = (object)$data; $oldid = $data->id; $data->definitionid = $this->get_new_parentid('grading_definition'); $newid = $DB->insert_record('gradingform_rubric_criteria', $data); $this->set_mapping('gradingform_rubric_criterion', $oldid, $newid); } /** * Processes level element data * * Sets the mapping 'gradingform_rubric_level' to be used later by * {@link self::process_gradinform_rubric_filling()} * * @param stdClass|array $data */ public function process_gradingform_rubric_level($data) { global $DB; $data = (object)$data; $oldid = $data->id; $data->criterionid = $this->get_new_parentid('gradingform_rubric_criterion'); $newid = $DB->insert_record('gradingform_rubric_levels', $data); $this->set_mapping('gradingform_rubric_level', $oldid, $newid); } /** * Processes filling element data * * @param stdClass|array $data */ public function process_gradinform_rubric_filling($data) { global $DB; $data = (object)$data; $data->instanceid = $this->get_new_parentid('grading_instance'); $data->criterionid = $this->get_mappingid('gradingform_rubric_criterion', $data->criterionid); $data->levelid = $this->get_mappingid('gradingform_rubric_level', $data->levelid); if (!empty($data->criterionid)) { $DB->insert_record('gradingform_rubric_fillings', $data); } } } grading/form/rubric/db/install.xml 0000604 00000007373 15062070555 0013200 0 ustar 00 <?xml version="1.0" encoding="UTF-8" ?> <XMLDB PATH="grade/grading/form/rubric/db" VERSION="20120122" COMMENT="XMLDB file for Moodle rubrics" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../../../lib/xmldb/xmldb.xsd" > <TABLES> <TABLE NAME="gradingform_rubric_criteria" COMMENT="Stores the rows of the rubric grid."> <FIELDS> <FIELD NAME="id" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="true"/> <FIELD NAME="definitionid" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="false" COMMENT="The ID of the form definition this criterion is part of"/> <FIELD NAME="sortorder" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="false" COMMENT="Defines the order of the criterion in the rubric"/> <FIELD NAME="description" TYPE="text" NOTNULL="false" SEQUENCE="false" COMMENT="The criterion description"/> <FIELD NAME="descriptionformat" TYPE="int" LENGTH="2" NOTNULL="false" SEQUENCE="false" COMMENT="The format of the description field"/> </FIELDS> <KEYS> <KEY NAME="primary" TYPE="primary" FIELDS="id"/> <KEY NAME="fk_definitionid" TYPE="foreign" FIELDS="definitionid" REFTABLE="grading_definitions" REFFIELDS="id"/> </KEYS> </TABLE> <TABLE NAME="gradingform_rubric_levels" COMMENT="Stores the columns of the rubric grid."> <FIELDS> <FIELD NAME="id" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="true"/> <FIELD NAME="criterionid" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="false" COMMENT="The rubric criterion we are level of"/> <FIELD NAME="score" TYPE="number" LENGTH="10" NOTNULL="true" SEQUENCE="false" DECIMALS="5" COMMENT="The score for this level"/> <FIELD NAME="definition" TYPE="text" NOTNULL="false" SEQUENCE="false" COMMENT="The optional text describing the level"/> <FIELD NAME="definitionformat" TYPE="int" LENGTH="10" NOTNULL="false" SEQUENCE="false" COMMENT="The format of the definition field"/> </FIELDS> <KEYS> <KEY NAME="primary" TYPE="primary" FIELDS="id"/> <KEY NAME="fk_criterionid" TYPE="foreign" FIELDS="criterionid" REFTABLE="gradingform_rubric_criteria" REFFIELDS="id"/> </KEYS> </TABLE> <TABLE NAME="gradingform_rubric_fillings" COMMENT="Stores the data of how the rubric is filled by a particular rater"> <FIELDS> <FIELD NAME="id" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="true"/> <FIELD NAME="instanceid" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="false" COMMENT="The ID of the grading form instance"/> <FIELD NAME="criterionid" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="false" COMMENT="The ID of the criterion (row) in the rubric"/> <FIELD NAME="levelid" TYPE="int" LENGTH="10" NOTNULL="false" SEQUENCE="false" COMMENT="If a particular level was selected during the assessment, its ID is stored here"/> <FIELD NAME="remark" TYPE="text" NOTNULL="false" SEQUENCE="false" COMMENT="Side note feedback regarding this particular criterion"/> <FIELD NAME="remarkformat" TYPE="int" LENGTH="2" NOTNULL="false" SEQUENCE="false" COMMENT="The format of the remark field"/> </FIELDS> <KEYS> <KEY NAME="primary" TYPE="primary" FIELDS="id"/> <KEY NAME="fk_instanceid" TYPE="foreign" FIELDS="instanceid" REFTABLE="grading_instances" REFFIELDS="id"/> <KEY NAME="fk_criterionid" TYPE="foreign" FIELDS="criterionid" REFTABLE="gradingform_rubric_criteria" REFFIELDS="id"/> <KEY NAME="uq_instance_criterion" TYPE="unique" FIELDS="instanceid, criterionid"/> </KEYS> <INDEXES> <INDEX NAME="ix_levelid" UNIQUE="false" FIELDS="levelid" COMMENT="levelid acts as a foreign key but null values are allowed"/> </INDEXES> </TABLE> </TABLES> </XMLDB> grading/form/rubric/db/services.php 0000604 00000003117 15062070555 0013334 0 ustar 00 <?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/>. /** * Rubric external functions and service definitions. * * @package gradingform_rubric * @copyright 2019 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die; $functions = [ 'gradingform_rubric_grader_gradingpanel_fetch' => [ 'classname' => 'gradingform_rubric\\grades\\grader\\gradingpanel\\external\\fetch', 'description' => 'Fetch the data required to display the grader grading panel, ' . 'creating the grade item if required', 'type' => 'write', 'ajax' => true, ], 'gradingform_rubric_grader_gradingpanel_store' => [ 'classname' => 'gradingform_rubric\\grades\\grader\\gradingpanel\\external\\store', 'description' => 'Store the grading data for a user from the grader grading panel.', 'type' => 'write', 'ajax' => true, ], ]; grading/form/rubric/db/upgrade.php 0000604 00000003166 15062070555 0013144 0 ustar 00 <?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/>. /** * This file keeps track of upgrades to plugin gradingform_rubric * * @package gradingform_rubric * @copyright 2011 David Mudrak <david@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); /** * Keeps track or rubric plugin upgrade path * * @param int $oldversion the DB version of currently installed plugin * @return bool true */ function xmldb_gradingform_rubric_upgrade($oldversion) { global $CFG; // Automatically generated Moodle v3.9.0 release upgrade line. // Put any upgrade step following this. // Automatically generated Moodle v4.0.0 release upgrade line. // Put any upgrade step following this. // Automatically generated Moodle v4.1.0 release upgrade line. // Put any upgrade step following this. // Automatically generated Moodle v4.2.0 release upgrade line. // Put any upgrade step following this. return true; } grading/form/rubric/edit.php 0000604 00000006271 15062070555 0012055 0 ustar 00 <?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/>. /** * Rubric editor page * * @package gradingform_rubric * @copyright 2011 Marina Glancy * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once(__DIR__.'/../../../../config.php'); require_once(__DIR__.'/lib.php'); require_once(__DIR__.'/edit_form.php'); require_once($CFG->dirroot.'/grade/grading/lib.php'); $areaid = required_param('areaid', PARAM_INT); $manager = get_grading_manager($areaid); list($context, $course, $cm) = get_context_info_array($manager->get_context()->id); require_login($course, true, $cm); require_capability('moodle/grade:managegradingforms', $context); $controller = $manager->get_controller('rubric'); $PAGE->set_url(new moodle_url('/grade/grading/form/rubric/edit.php', array('areaid' => $areaid))); $PAGE->set_title(get_string('definerubric', 'gradingform_rubric')); $PAGE->set_heading(get_string('definerubric', 'gradingform_rubric')); $mform = new gradingform_rubric_editrubric(null, array('areaid' => $areaid, 'context' => $context, 'allowdraft' => !$controller->has_active_instances()), 'post', '', array('class' => 'gradingform_rubric_editform')); $data = $controller->get_definition_for_editing(true); $returnurl = optional_param('returnurl', $manager->get_management_url(), PARAM_LOCALURL); $data->returnurl = $returnurl; $mform->set_data($data); if ($mform->is_cancelled()) { redirect($returnurl); } else if ($mform->is_submitted() && $mform->is_validated() && !$mform->need_confirm_regrading($controller)) { // Everything ok, validated, re-grading confirmed if needed. Make changes to the rubric. $data = $mform->get_data(); $controller->update_definition($data); // If we do not go back to management url and the minscore warning needs to be displayed, display it during redirection. $warning = null; if (!empty($data->returnurl) && $data->returnurl !== $manager->get_management_url()->out(false)) { if (empty($data->rubric['options']['lockzeropoints']) && ($scores = $controller->get_min_max_score()) && $scores['minscore'] <> 0) { $warning = get_string('zerolevelsabsent', 'gradingform_rubric').'<br>'. html_writer::link($manager->get_management_url(), get_string('back')); } } redirect($returnurl, $warning, null, \core\output\notification::NOTIFY_ERROR); } // Try to keep the session alive on this page as it may take some time // before significant interaction happens with the server. \core\session\manager::keepalive(); echo $OUTPUT->header(); $mform->display(); echo $OUTPUT->footer(); grading/form/rubric/lang/en/gradingform_rubric.php 0000604 00000015703 15062070555 0016320 0 ustar 00 <?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/>. /** * Language file for plugin gradingform_rubric * * @package gradingform_rubric * @copyright 2011 David Mudrak <david@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); $string['addcriterion'] = 'Add criterion'; $string['additionalfeedback'] = 'Additional feedback'; $string['alwaysshowdefinition'] = 'Allow users to preview rubric (otherwise it will only be displayed after grading)'; $string['backtoediting'] = 'Back to editing'; $string['confirmdeletecriterion'] = 'Are you sure you want to delete this criterion?'; $string['confirmdeletelevel'] = 'Are you sure you want to delete this level?'; $string['criterion'] = 'Criterion {$a}'; $string['criterionaddlevel'] = 'Add level'; $string['criteriondelete'] = 'Delete criterion'; $string['criterionduplicate'] = 'Duplicate criterion'; $string['criterionempty'] = 'Click to edit criterion'; $string['criterionmovedown'] = 'Move down'; $string['criterionmoveup'] = 'Move up'; $string['criterionremark'] = 'Remark for criterion {$a->description}: {$a->remark}'; $string['definerubric'] = 'Define rubric'; $string['description'] = 'Description'; $string['enableremarks'] = 'Allow grader to add text remarks for each criterion'; $string['err_mintwolevels'] = 'Each criterion must have at least two levels'; $string['err_nocriteria'] = 'Rubric must contain at least one criterion'; $string['err_nodefinition'] = 'Level definition can not be empty'; $string['err_nodescription'] = 'Criterion description can not be empty'; $string['err_novariations'] = 'Criterion levels cannot all be worth the same number of points'; $string['err_scoreformat'] = 'Number of points for each level must be a valid number'; $string['err_totalscore'] = 'Maximum number of points possible when graded by the rubric must be more than zero'; $string['gradingof'] = '{$a} grading'; $string['level'] = 'Level {$a->definition}, {$a->score} points.'; $string['leveldelete'] = 'Delete level {$a}'; $string['leveldefinition'] = 'Level {$a} definition'; $string['levelempty'] = 'Click to edit level'; $string['levelsgroup'] = 'Levels group'; $string['lockzeropoints'] = 'Calculate grade having a minimum score of the minimum achievable grade for the rubric'; $string['lockzeropoints_help'] = 'This setting only applies if the sum of the minimum number of points for each criterion is greater than 0. If ticked, the minimum score of the activity will be the minimum achievable grade for the rubric. If unticked, the minimum possible score for the rubric will be mapped to the minimum grade available for the activity (which is 0 unless a scale is used).'; $string['name'] = 'Name'; $string['needregrademessage'] = 'The rubric definition was changed after this student had been graded. The student can not see this rubric until you check the rubric and update the grade.'; $string['notset'] = 'Not set'; $string['pluginname'] = 'Rubric'; $string['pointsvalue'] = '{$a} points'; $string['previewrubric'] = 'Preview rubric'; $string['privacy:metadata:criterionid'] = 'An identifier for a specific criterion being graded.'; $string['privacy:metadata:fillingssummary'] = 'Stores information about the user\'s grade created by the rubric.'; $string['privacy:metadata:instanceid'] = 'An identifier relating to a grade in an activity.'; $string['privacy:metadata:levelid'] = 'The level obtained in the rubric.'; $string['privacy:metadata:remark'] = 'Remarks related to the rubric criterion being assessed.'; $string['regrademessage1'] = 'You are about to save changes to a rubric that has already been used for grading. Please indicate if existing grades need to be reviewed. If you set this then the rubric will be hidden from students until their item is regraded.'; $string['regrademessage5'] = 'You are about to save significant changes to a rubric that has already been used for grading. The gradebook value will be unchanged, but the rubric will be hidden from students until their item is regraded.'; $string['regradeoption0'] = 'Do not mark for regrade'; $string['regradeoption1'] = 'Mark for regrade'; $string['restoredfromdraft'] = 'NOTE: The last attempt to grade this person was not saved properly so draft grades have been restored. If you want to cancel these changes use the \'Cancel\' button below.'; $string['rubric'] = 'Rubric'; $string['rubricmapping'] = 'Score to grade mapping rules'; $string['rubricmappingexplained'] = 'The minimum possible score for this rubric is <b>{$a->minscore} points</b>. It will be converted to the minimum grade available for the activity (which is 0 unless a scale is used). The maximum score of <b>{$a->maxscore} points</b> will be converted to the maximum grade. Intermediate scores will be converted respectively. If a scale is used for grading, the score will be rounded and converted to the scale elements as if they were consecutive integers. This grade calculation may be changed by editing the form and ticking the box \'Calculate grade having a minimum score of the minimum achievable grade for the rubric\'.'; $string['rubricnotcompleted'] = 'Please choose something for each criterion'; $string['rubricoptions'] = 'Rubric options'; $string['rubricstatus'] = 'Current rubric status'; $string['save'] = 'Save'; $string['saverubric'] = 'Save rubric and make it ready'; $string['saverubricdraft'] = 'Save as draft'; $string['scoreinputforlevel'] = 'Score input for level {$a}'; $string['scorepostfix'] = '{$a} points'; $string['showdescriptionstudent'] = 'Display rubric description to those being graded'; $string['showdescriptionteacher'] = 'Display rubric description during evaluation'; $string['showremarksstudent'] = 'Show remarks to those being graded'; $string['showscorestudent'] = 'Display points for each level to those being graded'; $string['showscoreteacher'] = 'Display points for each level during evaluation'; $string['sortlevelsasc'] = 'Sort order for levels:'; $string['sortlevelsasc0'] = 'Descending by number of points'; $string['sortlevelsasc1'] = 'Ascending by number of points'; $string['zerolevelsabsent'] = 'Warning: The minimum possible score for this rubric is not 0; this can result in unexpected grades for the activity. To avoid this, each criterion should have a level with 0 points.<br> This warning may be ignored if a scale is used for grading, and the minimum levels in the rubric correspond to the minimum value of the scale.'; grading/form/rubric/preview.php 0000604 00000003557 15062070555 0012615 0 ustar 00 <?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/>. /** * Preview rubric page * * @package gradingform_rubric * @copyright 2011 Marina Glancy * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once(__DIR__.'/../../../../config.php'); require_once(__DIR__.'/lib.php'); require_once(__DIR__.'/edit_form.php'); require_once($CFG->dirroot.'/grade/grading/lib.php'); $areaid = required_param('areaid', PARAM_INT); $manager = get_grading_manager($areaid); list($context, $course, $cm) = get_context_info_array($manager->get_context()->id); require_login($course, true, $cm); $controller = $manager->get_controller('rubric'); $options = $controller->get_options(); if (!$controller->is_form_defined() || empty($options['alwaysshowdefinition'])) { throw new moodle_exception('nopermissions', 'error', '', get_string('previewrubric', 'gradingform_rubric')); } $title = get_string('gradingof', 'gradingform_rubric', $manager->get_area_title()); $PAGE->set_url(new moodle_url('/grade/grading/form/rubric/preview.php', array('areaid' => $areaid))); $PAGE->set_title($title); $PAGE->set_heading($title); echo $OUTPUT->header(); echo $OUTPUT->heading($title); echo $controller->render_preview($PAGE); echo $OUTPUT->footer(); grading/form/rubric/classes/privacy/provider.php 0000604 00000006765 15062070555 0016104 0 ustar 00 <?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/>. /** * Privacy class for requesting user data. * * @package gradingform_rubric * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradingform_rubric\privacy; defined('MOODLE_INTERNAL') || die(); use \core_privacy\local\metadata\collection; /** * Privacy class for requesting user data. * * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class provider implements \core_privacy\local\metadata\provider, \core_grading\privacy\gradingform_provider_v2 { /** * Returns meta data about this system. * * @param collection $collection The initialised collection to add items to. * @return collection A listing of user data stored through this system. */ public static function get_metadata(collection $collection) : collection { $collection->add_database_table('gradingform_rubric_fillings', [ 'instanceid' => 'privacy:metadata:instanceid', 'criterionid' => 'privacy:metadata:criterionid', 'levelid' => 'privacy:metadata:levelid', 'remark' => 'privacy:metadata:remark' ], 'privacy:metadata:fillingssummary'); return $collection; } /** * Export user data relating to an instance ID. * * @param \context $context Context to use with the export writer. * @param int $instanceid The instance ID to export data for. * @param array $subcontext The directory to export this data to. */ public static function export_gradingform_instance_data(\context $context, int $instanceid, array $subcontext) { global $DB; // Get records from the provided params. $params = ['instanceid' => $instanceid]; $sql = "SELECT rc.description, rl.definition, rl.score, rf.remark FROM {gradingform_rubric_fillings} rf JOIN {gradingform_rubric_criteria} rc ON rc.id = rf.criterionid JOIN {gradingform_rubric_levels} rl ON rf.levelid = rl.id WHERE rf.instanceid = :instanceid"; $records = $DB->get_records_sql($sql, $params); if ($records) { $subcontext = array_merge($subcontext, [get_string('rubric', 'gradingform_rubric'), $instanceid]); \core_privacy\local\request\writer::with_context($context)->export_data($subcontext, (object) $records); } } /** * Deletes all user data related to the provided instance IDs. * * @param array $instanceids The instance IDs to delete information from. */ public static function delete_gradingform_for_instances(array $instanceids) { global $DB; $DB->delete_records_list('gradingform_rubric_fillings', 'instanceid', $instanceids); } } grading/form/rubric/classes/grades/grader/gradingpanel/external/store.php 0000604 00000014220 15062070555 0022700 0 ustar 00 <?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/>. /** * Web services relating to fetching of a rubric for the grading panel. * * @package gradingform_rubric * @copyright 2019 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ declare(strict_types = 1); namespace gradingform_rubric\grades\grader\gradingpanel\external; global $CFG; use coding_exception; use context; use core_grades\component_gradeitem as gradeitem; use core_grades\component_gradeitems; use core_external\external_api; use core_external\external_function_parameters; use core_external\external_single_structure; use core_external\external_value; use moodle_exception; require_once($CFG->dirroot.'/grade/grading/form/rubric/lib.php'); /** * Web services relating to storing of a rubric for the grading panel. * * @package gradingform_rubric * @copyright 2019 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class store extends external_api { /** * Describes the parameters for storing the grading panel for a simple grade. * * @return external_function_parameters * @since Moodle 3.8 */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters ([ 'component' => new external_value( PARAM_ALPHANUMEXT, 'The name of the component', VALUE_REQUIRED ), 'contextid' => new external_value( PARAM_INT, 'The ID of the context being graded', VALUE_REQUIRED ), 'itemname' => new external_value( PARAM_ALPHANUM, 'The grade item itemname being graded', VALUE_REQUIRED ), 'gradeduserid' => new external_value( PARAM_INT, 'The ID of the user show', VALUE_REQUIRED ), 'notifyuser' => new external_value( PARAM_BOOL, 'Wheteher to notify the user or not', VALUE_DEFAULT, false ), 'formdata' => new external_value( PARAM_RAW, 'The serialised form data representing the grade', VALUE_REQUIRED ), ]); } /** * Fetch the data required to build a grading panel for a simple grade. * * @param string $component * @param int $contextid * @param string $itemname * @param int $gradeduserid * @param string $formdata * @param bool $notifyuser * @return array * @throws coding_exception * @throws moodle_exception * @since Moodle 3.8 */ public static function execute(string $component, int $contextid, string $itemname, int $gradeduserid, bool $notifyuser, string $formdata): array { global $USER; [ 'component' => $component, 'contextid' => $contextid, 'itemname' => $itemname, 'gradeduserid' => $gradeduserid, 'notifyuser' => $notifyuser, 'formdata' => $formdata, ] = self::validate_parameters(self::execute_parameters(), [ 'component' => $component, 'contextid' => $contextid, 'itemname' => $itemname, 'gradeduserid' => $gradeduserid, 'notifyuser' => $notifyuser, 'formdata' => $formdata, ]); // Validate the context. $context = context::instance_by_id($contextid); self::validate_context($context); // Validate that the supplied itemname is a gradable item. if (!component_gradeitems::is_valid_itemname($component, $itemname)) { throw new coding_exception("The '{$itemname}' item is not valid for the '{$component}' component"); } // Fetch the gradeitem instance. $gradeitem = gradeitem::instance($component, $context, $itemname); // Validate that this gradeitem is actually enabled. if (!$gradeitem->is_grading_enabled()) { throw new moodle_exception("Grading is not enabled for {$itemname} in this context"); } // Fetch the record for the graded user. $gradeduser = \core_user::get_user($gradeduserid); // Require that this user can save grades. $gradeitem->require_user_can_grade($gradeduser, $USER); if (RUBRIC !== $gradeitem->get_advanced_grading_method()) { throw new moodle_exception( "The {$itemname} item in {$component}/{$contextid} is not configured for advanced grading with a rubric" ); } // Parse the serialised string into an object. $data = []; parse_str($formdata, $data); // Grade. $gradeitem->store_grade_from_formdata($gradeduser, $USER, (object) $data); // Notify. if ($notifyuser) { // Send notification. $gradeitem->send_student_notification($gradeduser, $USER); } // Fetch the updated grade back out. $grade = $gradeitem->get_grade_for_user($gradeduser, $USER); return fetch::get_fetch_data($gradeitem, $gradeduser); } /** * Describes the data returned from the external function. * * @return external_single_structure * @since Moodle 3.8 */ public static function execute_returns(): external_single_structure { return fetch::execute_returns(); } } grading/form/rubric/classes/grades/grader/gradingpanel/external/fetch.php 0000604 00000033057 15062070555 0022646 0 ustar 00 <?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/>. /** * Web services relating to fetching of a rubric for the grading panel. * * @package gradingform_rubric * @copyright 2019 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ declare(strict_types = 1); namespace gradingform_rubric\grades\grader\gradingpanel\external; global $CFG; use coding_exception; use context; use core_grades\component_gradeitem as gradeitem; use core_grades\component_gradeitems; use core_external\external_api; use core_external\external_function_parameters; use core_external\external_multiple_structure; use core_external\external_single_structure; use core_external\external_value; use core_external\external_warnings; use stdClass; use moodle_exception; require_once($CFG->dirroot.'/grade/grading/form/rubric/lib.php'); /** * Web services relating to fetching of a rubric for the grading panel. * * @package gradingform_rubric * @copyright 2019 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class fetch extends external_api { /** * Describes the parameters for fetching the grading panel for a simple grade. * * @return external_function_parameters * @since Moodle 3.8 */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters ([ 'component' => new external_value( PARAM_ALPHANUMEXT, 'The name of the component', VALUE_REQUIRED ), 'contextid' => new external_value( PARAM_INT, 'The ID of the context being graded', VALUE_REQUIRED ), 'itemname' => new external_value( PARAM_ALPHANUM, 'The grade item itemname being graded', VALUE_REQUIRED ), 'gradeduserid' => new external_value( PARAM_INT, 'The ID of the user show', VALUE_REQUIRED ), ]); } /** * Fetch the data required to build a grading panel for a simple grade. * * @param string $component * @param int $contextid * @param string $itemname * @param int $gradeduserid * @return array * @since Moodle 3.8 */ public static function execute(string $component, int $contextid, string $itemname, int $gradeduserid): array { global $CFG, $USER; require_once("{$CFG->libdir}/gradelib.php"); [ 'component' => $component, 'contextid' => $contextid, 'itemname' => $itemname, 'gradeduserid' => $gradeduserid, ] = self::validate_parameters(self::execute_parameters(), [ 'component' => $component, 'contextid' => $contextid, 'itemname' => $itemname, 'gradeduserid' => $gradeduserid, ]); // Validate the context. $context = context::instance_by_id($contextid); self::validate_context($context); // Validate that the supplied itemname is a gradable item. if (!component_gradeitems::is_valid_itemname($component, $itemname)) { throw new coding_exception("The '{$itemname}' item is not valid for the '{$component}' component"); } // Fetch the gradeitem instance. $gradeitem = gradeitem::instance($component, $context, $itemname); if (RUBRIC !== $gradeitem->get_advanced_grading_method()) { throw new moodle_exception( "The {$itemname} item in {$component}/{$contextid} is not configured for advanced grading with a rubric" ); } // Fetch the actual data. $gradeduser = \core_user::get_user($gradeduserid, '*', MUST_EXIST); // One can access its own grades. Others just if they're graders. if ($gradeduserid != $USER->id) { $gradeitem->require_user_can_grade($gradeduser, $USER); } return self::get_fetch_data($gradeitem, $gradeduser); } /** * Get the data to be fetched and create the structure ready for Mustache. * * @param gradeitem $gradeitem * @param stdClass $gradeduser * @return array */ public static function get_fetch_data(gradeitem $gradeitem, stdClass $gradeduser): array { global $USER; // Set up all the controllers etc that we'll be needing. $hasgrade = $gradeitem->user_has_grade($gradeduser); $grade = $gradeitem->get_formatted_grade_for_user($gradeduser, $USER); $instance = $gradeitem->get_advanced_grading_instance($USER, $grade); if (!$instance) { throw new moodle_exception('error:gradingunavailable', 'grading'); } $controller = $instance->get_controller(); $definition = $controller->get_definition(); $fillings = $instance->get_rubric_filling(); $context = $controller->get_context(); $definitionid = (int) $definition->id; // Set up some items we need to return on other interfaces. $gradegrade = \grade_grade::fetch(['itemid' => $gradeitem->get_grade_item()->id, 'userid' => $gradeduser->id]); $gradername = $gradegrade ? fullname(\core_user::get_user($gradegrade->usermodified)) : null; $maxgrade = max(array_keys($controller->get_grade_range())); $teacherdescription = self::get_formatted_text( $context, $definitionid, 'description', $definition->description, (int) $definition->descriptionformat ); $criterion = []; if ($definition->rubric_criteria) { // Iterate over the defined criterion in the rubric and map out what we need to render each item. $criterion = array_map(function($criterion) use ($definitionid, $fillings, $context, $hasgrade) { // The general structure we'll be returning, we still need to get the remark (if any) and the levels associated. $result = [ 'id' => $criterion['id'], 'description' => self::get_formatted_text( $context, $definitionid, 'description', $criterion['description'], (int) $criterion['descriptionformat'] ), ]; // Do we have an existing grade filling? if so lets get the remark associated to this criteria. $filling = []; if (array_key_exists($criterion['id'], $fillings['criteria'])) { $filling = $fillings['criteria'][$criterion['id']]; $result['remark'] = self::get_formatted_text($context, $definitionid, 'remark', $filling['remark'], (int) $filling['remarkformat'] ); } // Lets build the levels within a criteria and figure out what needs to go where. $result['levels'] = array_map(function($level) use ($criterion, $filling, $context, $definitionid) { // The bulk of what'll be returned can be defined easily we'll add to this further down. $result = [ 'id' => $level['id'], 'criterionid' => $criterion['id'], 'score' => $level['score'], 'definition' => self::get_formatted_text( $context, $definitionid, 'definition', $level['definition'], (int) $level['definitionformat'] ), 'checked' => null, ]; // Consult the grade filling to see if a level has been selected and if it is the current level. if (array_key_exists('levelid', $filling) && $filling['levelid'] == $level['id']) { $result['checked'] = true; } return $result; }, $criterion['levels']); $nulllevel = [ 'id' => null, 'criterionid' => $criterion['id'], 'score' => '-', 'definition' => get_string('notset', 'gradingform_rubric'), 'checked' => !$hasgrade, ]; // Consult the grade filling to see if a level has been selected and if it is the current level. if (array_key_exists('levelid', $filling) && $filling['levelid'] == 0) { $nulllevel['checked'] = true; } array_unshift($result['levels'], $nulllevel); return $result; }, $definition->rubric_criteria); } return [ 'templatename' => 'gradingform_rubric/grades/grader/gradingpanel', 'hasgrade' => $hasgrade, 'grade' => [ 'instanceid' => $instance->get_id(), 'criteria' => $criterion, 'rubricmode' => 'evaluate editable', 'teacherdescription' => $teacherdescription, 'canedit' => false, 'usergrade' => $grade->usergrade, 'maxgrade' => $maxgrade, 'gradedby' => $gradername, 'timecreated' => $grade->timecreated, 'timemodified' => $grade->timemodified, ], 'warnings' => [], ]; } /** * Describes the data returned from the external function. * * @return external_single_structure * @since Moodle 3.8 */ public static function execute_returns(): external_single_structure { return new external_single_structure([ 'templatename' => new external_value(PARAM_SAFEPATH, 'The template to use when rendering this data'), 'hasgrade' => new external_value(PARAM_BOOL, 'Does the user have a grade?'), 'grade' => new external_single_structure([ 'instanceid' => new external_value(PARAM_INT, 'The id of the current grading instance'), 'rubricmode' => new external_value(PARAM_RAW, 'The mode i.e. evaluate editable'), 'canedit' => new external_value(PARAM_BOOL, 'Can the user edit this'), 'criteria' => new external_multiple_structure( new external_single_structure([ 'id' => new external_value(PARAM_INT, 'ID of the Criteria'), 'description' => new external_value(PARAM_RAW, 'Description of the Criteria'), 'remark' => new external_value(PARAM_RAW, 'Any remarks for this criterion for the user being assessed', VALUE_OPTIONAL), 'levels' => new external_multiple_structure(new external_single_structure([ 'id' => new external_value(PARAM_INT, 'ID of level'), 'criterionid' => new external_value(PARAM_INT, 'ID of the criterion this matches to'), 'score' => new external_value(PARAM_RAW, 'What this level is worth'), 'definition' => new external_value(PARAM_RAW, 'Definition of the level'), 'checked' => new external_value(PARAM_BOOL, 'Selected flag'), ])), ]) ), 'timecreated' => new external_value(PARAM_INT, 'The time that the grade was created'), 'usergrade' => new external_value(PARAM_RAW, 'Current user grade'), 'maxgrade' => new external_value(PARAM_RAW, 'Max possible grade'), 'gradedby' => new external_value(PARAM_RAW, 'The assumed grader of this grading instance'), 'timemodified' => new external_value(PARAM_INT, 'The time that the grade was last updated'), ]), 'warnings' => new external_warnings(), ]); } /** * Get a formatted version of the remark/description/etc. * * @param context $context * @param int $definitionid * @param string $filearea The file area of the field * @param string $text The text to be formatted * @param int $format The input format of the string * @return string */ protected static function get_formatted_text(context $context, int $definitionid, string $filearea, string $text, int $format): string { $formatoptions = [ 'noclean' => false, 'trusted' => false, 'filter' => true, ]; [$newtext] = \core_external\util::format_text( $text, $format, $context, 'grading', $filearea, $definitionid, $formatoptions ); return $newtext; } } grading/form/rubric/version.php 0000604 00000002120 15062070555 0012602 0 ustar 00 <?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/>. /** * Version information for plugin gradingform_rubric * * @package gradingform_rubric * @copyright 2011 David Mudrak <david@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); $plugin->component = 'gradingform_rubric'; $plugin->version = 2023100900; $plugin->requires = 2023100400; $plugin->maturity = MATURITY_STABLE; grading/form/rubric/tests/behat/edit_rubric.feature 0000604 00000020662 15062070555 0016514 0 ustar 00 @gradingform @gradingform_rubric Feature: Rubrics can be created and edited In order to use and refine rubrics to grade students As a teacher I need to edit previously used rubrics @javascript Scenario: I can use rubrics to grade and edit them later updating students grades Given the following "users" exist: | username | firstname | lastname | email | | teacher1 | Teacher | 1 | teacher1@example.com | | student1 | Student | 1 | student1@example.com | And the following "courses" exist: | fullname | shortname | format | | Course 1 | C1 | topics | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | And the following "activity" exists: | activity | assign | | course | C1 | | section | 1 | | name | Test assignment 1 name | | intro | Test assignment description | | assignfeedback_comments_enabled | 1 | | assignfeedback_editpdf_enabled | 1 | | advancedgradingmethod_submissions | rubric | And I log in as "teacher1" And I am on "Course 1" course homepage with editing mode on When I go to "Test assignment 1 name" advanced grading definition page # Defining a rubric. And I set the following fields to these values: | Name | Assignment 1 rubric | | Description | Rubric test description | And I define the following rubric: | TMP Criterion 1 | TMP Level 11 | 11 | TMP Level 12 | 12 | | TMP Criterion 2 | TMP Level 21 | 21 | TMP Level 22 | 22 | | TMP Criterion 3 | TMP Level 31 | 31 | TMP Level 32 | 32 | | TMP Criterion 4 | TMP Level 41 | 41 | TMP Level 42 | 42 | # Checking that only the last ones are saved. And I define the following rubric: | Criterion 1 | Level 11 | 1 | Level 12 | 20 | Level 13 | 40 | Level 14 | 50 | | Criterion 2 | Level 21 | 10 | Level 22 | 20 | Level 23 | 30 | | | | Criterion 3 | Level 31 | 5 | Level 32 | 20 | | | | | And I press "Save as draft" And I go to "Test assignment 1 name" advanced grading definition page And I click on "Move down" "button" in the "Criterion 1" "table_row" And I press "Save rubric and make it ready" Then I should see "Ready for use" # Grading two students. And I navigate to "Assignment" in current page administration And I go to "Student 1" "Test assignment 1 name" activity advanced grading page And I grade by filling the rubric with: | Criterion 1 | 50 | Very good | And I press "Save changes" # Checking that it complains if you don't select a level for each criterion. And I should see "Please choose something for each criterion" And I grade by filling the rubric with: | Criterion 1 | 50 | Very good | | Criterion 2 | 10 | Mmmm, you can do it better | | Criterion 3 | 5 | Not good | And I complete the advanced grading form with these values: | Feedback comments | In general... work harder... | # Checking that the user grade is correct. And I should see "65" in the "Student 1" "table_row" # Updating the user grade. And I am on the "Test assignment 1 name" "assign activity" page And I go to "Student 1" "Test assignment 1 name" activity advanced grading page And I grade by filling the rubric with: | Criterion 1 | 20 | Bad, I changed my mind | | Criterion 2 | 10 | Mmmm, you can do it better | | Criterion 3 | 5 | Not good | #And the level with "50" points was previously selected for the rubric criterion "Criterion 1" #And the level with "20" points is selected for the rubric criterion "Criterion 1" And I save the advanced grading form And I should see "35" in the "Student 1" "table_row" And I log out # Viewing it as a student. And I am on the "Test assignment 1 name" "assign activity" page logged in as student1 And I should see "35" in the ".feedback" "css_element" And I should see "Rubric test description" in the ".feedback" "css_element" And I should see "In general... work harder..." And the level with "10" points is selected for the rubric criterion "Criterion 2" And the level with "20" points is selected for the rubric criterion "Criterion 1" And the level with "5" points is selected for the rubric criterion "Criterion 3" And I log out And I am on the "Course 1" course page logged in as teacher1 # Editing a rubric definition without regrading students. And I go to "Test assignment 1 name" advanced grading definition page And "Save as draft" "button" should not exist And I click on "Move up" "button" in the "Criterion 1" "table_row" And I replace "Level 11" rubric level with "Level 11 edited" in "Criterion 1" criterion And I press "Save" And I should see "You are about to save changes to a rubric that has already been used for grading." And I set the field "menurubricregrade" to "Do not mark for regrade" And I press "Continue" And I log out # Check that the student still sees the grade. And I am on the "Test assignment 1 name" "assign activity" page logged in as student1 And I should see "35" in the ".feedback" "css_element" And the level with "20" points is selected for the rubric criterion "Criterion 1" And I log out # Editing a rubric with significant changes. And I log in as "teacher1" And I am on "Course 1" course homepage And I go to "Test assignment 1 name" advanced grading definition page And I click on "Move down" "button" in the "Criterion 2" "table_row" And I replace "1" rubric level with "60" in "Criterion 1" criterion And I press "Save" And I should see "You are about to save significant changes to a rubric that has already been used for grading. The gradebook value will be unchanged, but the rubric will be hidden from students until their item is regraded." And I press "Continue" And I log out # Check that the student doesn't see the grade. And I am on the "Test assignment 1 name" "assign activity" page logged in as student1 And I should see "35" in the ".feedback" "css_element" And the level with "20" points is not selected for the rubric criterion "Criterion 1" And I log out # Regrade student. And I am on the "Test assignment 1 name" "assign activity" page logged in as teacher1 And I go to "Student 1" "Test assignment 1 name" activity advanced grading page And I should see "The rubric definition was changed after this student had been graded. The student can not see this rubric until you check the rubric and update the grade." And I save the advanced grading form And I log out # Check that the student sees the grade again. And I am on the "Test assignment 1 name" "assign activity" page logged in as student1 And I should see "31.82" in the ".feedback" "css_element" And the level with "20" points is not selected for the rubric criterion "Criterion 1" # Hide all rubric info for students And I log out And I am on the "Course 1" course page logged in as teacher1 And I go to "Test assignment 1 name" advanced grading definition page And I set the field "Allow users to preview rubric (otherwise it will only be displayed after grading)" to "" And I set the field "Display rubric description during evaluation" to "" And I set the field "Display rubric description to those being graded" to "" And I set the field "Display points for each level during evaluation" to "" And I set the field "Display points for each level to those being graded" to "" And I press "Save" And I set the field "menurubricregrade" to "Do not mark for regrade" And I press "Continue" And I log out # Students should not see anything. And I am on the "Test assignment 1 name" "assign activity" page logged in as student1 And I should not see "Criterion 1" in the ".submissionstatustable" "css_element" And I should not see "Criterion 2" in the ".submissionstatustable" "css_element" And I should not see "Criterion 3" in the ".submissionstatustable" "css_element" And I should not see "Rubric test description" in the ".feedback" "css_element" grading/form/rubric/tests/behat/publish_rubric_templates.feature 0000604 00000005267 15062070555 0021317 0 ustar 00 @gradingform @gradingform_rubric Feature: Publish rubrics as templates In order to save time to teachers As a manager I need to publish rubrics and make them available to all teachers Background: Given the following "users" exist: | username | firstname | lastname | email | | teacher1 | Teacher | 1 | teacher1@example.com | | manager1 | Manager | 1 | manager1@example.com | And the following "courses" exist: | fullname | shortname | format | | Course 1 | C1 | topics | And the following "activities" exist: | activity | course | idnumber | name | intro | advancedgradingmethod_submissions | | assign | C1 | A1 | Test assignment 1 name | TA1 | rubric | | assign | C1 | A2 | Test assignment 2 name | TA2 | rubric | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | And the following "system role assigns" exist: | user | role | contextlevel | reference | | manager1 | manager | System | | And I log in as "manager1" And I am on "Course 1" course homepage And I go to "Test assignment 1 name" advanced grading definition page And I set the following fields to these values: | Name | Assignment 1 rubric | | Description | Assignment 1 description | And I define the following rubric: | Criterion 1 | Level 11 | 11 | Level 12 | 12 | | Criterion 2 | Level 21 | 21 | Level 22 | 22 | And I press "Save rubric and make it ready" When I publish "Test assignment 1 name" grading form definition as a public template And I log out And I log in as "teacher1" And I am on "Course 1" course homepage And I set "Test assignment 2 name" activity to use "Assignment 1 rubric" grading form Then I should see "Advanced grading" And I should see "Criterion 1" And I should see "Assignment 1 description" And I go to "Test assignment 2 name" advanced grading definition page And I should see "Current rubric status" @javascript Scenario: Create a rubric template and reuse it as a teacher, with Javascript enabled Then the field "Description" matches value "Assignment 1 description" And I should see "Criterion 1" And I press "Cancel" Scenario: Create a rubric template and reuse it as a teacher, with Javascript disabled Then the field "Description" matches value "Assignment 1 description" # Trying to avoid pointing by id or name as the code internals may change. And "//table[@class='criteria']//textarea[text()='Criterion 1']" "xpath_element" should exist And I press "Cancel" grading/form/rubric/tests/behat/negative_points.feature 0000604 00000006517 15062070555 0017422 0 ustar 00 @gradingform @gradingform_rubric @javascript Feature: Rubrics can have levels with negative scores In order to use and refine rubrics to grade students As a teacher I need to be able to penalise for very wrong submissions Scenario: Using negative levels in rubrics Given the following "users" exist: | username | firstname | lastname | email | | teacher1 | Teacher | 1 | teacher1@example.com | | student1 | Student | 1 | student1@example.com | | student2 | Student | 2 | student2@example.com | | student3 | Student | 3 | student3@example.com | And the following "courses" exist: | fullname | shortname | format | | Course 1 | C1 | topics | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | | student2 | C1 | student | | student3 | C1 | student | And the following "scales" exist: | name | scale | | Test scale 1 | Disappointing, Good, Very good, Excellent | And the following "activities" exist: | activity | name | intro | course | idnumber | grade | advancedgradingmethod_submissions | | assign | Test assignment 1 | Test | C1 | assign1 | 100 | rubric | And I change window size to "large" When I log in as "teacher1" And I am on "Course 1" course homepage with editing mode on And I go to "Test assignment 1" advanced grading definition page And I set the following fields to these values: | Name | Assignment 1 rubric | | Description | Rubric test description | And I define the following rubric: | Criterion 1 | Did not try | -11 | Level 12 | 25 | Level 13 | 40 | Level 14 | 50 | | Criterion 2 | Very bad | -20 | Level 22 | 25 | Level 23 | 30 | | | | Criterion 3 | Level 31 | 10 | Level 32 | 20 | | | | | And I press "Save rubric and make it ready" # Grading a student. And I navigate to "Assignment" in current page administration And I go to "Student 1" "Test assignment 1" activity advanced grading page And I grade by filling the rubric with: | Criterion 1 | 25 | | | Criterion 2 | 30 | | | Criterion 3 | 10 | | And I save the advanced grading form And I am on the "Test assignment 1" "assign activity" page And I go to "Student 2" "Test assignment 1" activity advanced grading page And I grade by filling the rubric with: | Criterion 1 | 25 | | | Criterion 2 | -20 | | | Criterion 3 | 10 | | And I save the advanced grading form And I am on the "Test assignment 1" "assign activity" page And I go to "Student 3" "Test assignment 1" activity advanced grading page And I grade by filling the rubric with: | Criterion 1 | -11 | | | Criterion 2 | -20 | | | Criterion 3 | 10 | | And I save the advanced grading form # Checking that the user grade is correct. And I should see "65.00" in the "student1@example.com" "table_row" And I should see "15.00" in the "student2@example.com" "table_row" And I should see "0.00" in the "student3@example.com" "table_row" And I should not see "-" in the "student3@example.com" "table_row" And I log out grading/form/rubric/tests/behat/grade_calculation.feature 0000604 00000005516 15062070555 0017662 0 ustar 00 @gradingform @gradingform_rubric @javascript Feature: Converting rubric score to grades In order to use and refine rubrics to grade students As a teacher I need to be able to use different grade settings Scenario Outline: Convert rubric scores to grades. Given the following "users" exist: | username | firstname | lastname | email | | teacher1 | Teacher | 1 | teacher1@example.com | | student1 | Student | 1 | student1@example.com | And the following "courses" exist: | fullname | shortname | format | | Course 1 | C1 | topics | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | And the following "scales" exist: | name | scale | | Test scale 1 | Disappointing, Good, Very good, Excellent | And the following "activities" exist: | activity | name | intro | course | idnumber | grade | advancedgradingmethod_submissions | | assign | Test assignment 1 | Test | C1 | assign1 | <grade> | rubric | When I log in as "teacher1" And I change window size to "large" And I am on "Course 1" course homepage with editing mode on And I go to "Test assignment 1" advanced grading definition page And I set the following fields to these values: | Name | Assignment 1 rubric | | Description | Rubric test description | | Calculate grade having a minimum score of the minimum achievable grade for the rubric | <lockzeropoints> | And I define the following rubric: | Criterion 1 | Level 11 | 20 | Level 12 | 25 | Level 13 | 40 | Level 14 | 50 | | Criterion 2 | Level 21 | 20 | Level 22 | 25 | Level 23 | 30 | | | | Criterion 3 | Level 31 | 10 | Level 32 | 20 | | | | | And I press "Save rubric and make it ready" And I navigate to "Assignment" in current page administration # Grading a student. And I go to "Student 1" "Test assignment 1" activity advanced grading page And I grade by filling the rubric with: | Criterion 1 | 25 | | | Criterion 2 | 20 | | | Criterion 3 | 10 | | And I save the advanced grading form # Checking that the user grade is correct. And I should see "<studentgrade>" in the "student1@example.com" "table_row" And I log out Examples: | grade | lockzeropoints | studentgrade | | 100 | 1 | 55.00 | | 70 | 1 | 38.50 | | Test scale 1 | 1 | Good | | 100 | | 10.00 | | 70 | | 7.00 | | Test scale 1 | | Disappointing | grading/form/rubric/tests/behat/behat_gradingform_rubric.php 0000604 00000052667 15062070555 0020377 0 ustar 00 <?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/>. /** * Steps definitions for rubrics. * * @package gradingform_rubric * @category test * @copyright 2013 David Monllaó * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ // NOTE: no MOODLE_INTERNAL test here, this file may be required by behat before including /config.php. require_once(__DIR__ . '/../../../../../../lib/behat/behat_base.php'); use Behat\Gherkin\Node\TableNode; use Behat\Mink\Exception\ElementNotFoundException; use Behat\Mink\Exception\ExpectationException; /** * Steps definitions to help with rubrics. * * @package gradingform_rubric * @category test * @copyright 2013 David Monllaó * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class behat_gradingform_rubric extends behat_base { /** * @var The number of levels added by default when a rubric is created. */ const DEFAULT_RUBRIC_LEVELS = 3; /** * Defines the rubric with the provided data, following rubric's definition grid cells. * * This method fills the rubric of the rubric definition * form; the provided TableNode should contain one row for * each criterion and each cell of the row should contain: * # Criterion description * # Criterion level 1 name * # Criterion level 1 points * # Criterion level 2 name * # Criterion level 2 points * # Criterion level 3 ..... * * Works with both JS and non-JS. * * @When /^I define the following rubric:$/ * @throws ExpectationException * @param TableNode $rubric */ public function i_define_the_following_rubric(TableNode $rubric) { // Being a smart method is nothing good when we talk about step definitions, in // this case we didn't have any other options as there are no labels no elements // id we can point to without having to "calculate" them. $steptableinfo = '| criterion description | level1 name | level1 points | level2 name | level2 points | ...'; $criteria = $rubric->getRows(); $addcriterionbutton = $this->find_button(get_string('addcriterion', 'gradingform_rubric')); // Cleaning the current ones. $deletebuttons = $this->find_all('css', "input[value='" . get_string('criteriondelete', 'gradingform_rubric') . "']"); if ($deletebuttons) { // We should reverse the deletebuttons because otherwise once we delete // the first one the DOM will change and the [X] one will not exist anymore. $deletebuttons = array_reverse($deletebuttons, true); foreach ($deletebuttons as $button) { $this->click_and_confirm($button); } } // The level number (NEWID$N) is not reset after each criterion. $levelnumber = 1; // The next criterion is created with the same number of levels than the last criterion. $defaultnumberoflevels = self::DEFAULT_RUBRIC_LEVELS; if ($criteria) { foreach ($criteria as $criterionit => $criterion) { // Unset empty levels in criterion. foreach ($criterion as $i => $value) { if (empty($value)) { unset($criterion[$i]); } } // Remove empty criterion, as TableNode might contain them to make table rows equal size. $newcriterion = array(); foreach ($criterion as $k => $c) { if (!empty($c)) { $newcriterion[$k] = $c; } } $criterion = $newcriterion; // Checking the number of cells. if (count($criterion) % 2 === 0) { throw new ExpectationException( 'The criterion levels should contain both definition and points, follow this format:' . $steptableinfo, $this->getSession() ); } // Minimum 2 levels per criterion. // description + definition1 + score1 + definition2 + score2 = 5. if (count($criterion) < 5) { throw new ExpectationException( get_string('err_mintwolevels', 'gradingform_rubric'), $this->getSession() ); } // Add new criterion. $this->execute('behat_general::i_click_on', [ $addcriterionbutton, 'NodeElement', ]); $criterionroot = 'rubric[criteria][NEWID' . ($criterionit + 1) . ']'; // Getting the criterion description, this one is visible by default. $this->set_rubric_field_value($criterionroot . '[description]', array_shift($criterion), true); // When JS is disabled each criterion's levels name numbers starts from 0. if (!$this->running_javascript()) { $levelnumber = 0; } // Setting the correct number of levels. $nlevels = count($criterion) / 2; if ($nlevels < $defaultnumberoflevels) { // Removing levels if there are too much levels. // When we add a new level the NEWID$N is increased from the last criterion. $lastcriteriondefaultlevel = $defaultnumberoflevels + $levelnumber - 1; $lastcriterionlevel = $nlevels + $levelnumber - 1; for ($i = $lastcriteriondefaultlevel; $i > $lastcriterionlevel; $i--) { // If JS is disabled seems that new levels are not added. if ($this->running_javascript()) { $deletelevel = $this->find_button($criterionroot . '[levels][NEWID' . $i . '][delete]'); $this->click_and_confirm($deletelevel); } else { // Only if the level exists. $buttonname = $criterionroot . '[levels][NEWID' . $i . '][delete]'; if ($deletelevel = $this->getSession()->getPage()->findButton($buttonname)) { $this->execute('behat_general::i_click_on', [ $deletelevel, 'NodeElement', ]); } } } } else if ($nlevels > $defaultnumberoflevels) { // Adding levels if we don't have enough. $addlevel = $this->find_button($criterionroot . '[levels][addlevel]'); for ($i = ($defaultnumberoflevels + 1); $i <= $nlevels; $i++) { $this->execute('behat_general::i_click_on', [ $addlevel, 'NodeElement', ]); } } // Updating it. if ($nlevels > self::DEFAULT_RUBRIC_LEVELS) { $defaultnumberoflevels = $nlevels; } else { // If it is less than the default value it sets it to // the default value. $defaultnumberoflevels = self::DEFAULT_RUBRIC_LEVELS; } foreach ($criterion as $i => $value) { $levelroot = $criterionroot . '[levels][NEWID' . $levelnumber . ']'; if ($i % 2 === 0) { // Pairs are the definitions. $fieldname = $levelroot . '[definition]'; $this->set_rubric_field_value($fieldname, $value); } else { // Odds are the points. // Checking it now, we would need to remove it if we are testing the form validations... if (!is_numeric($value)) { throw new ExpectationException( 'The points cells should contain numeric values, follow this format: ' . $steptableinfo, $this->getSession() ); } $fieldname = $levelroot . '[score]'; $this->set_rubric_field_value($fieldname, $value, true); // Increase the level by one every 2 cells. $levelnumber++; } } } } } /** * Replaces a value from the specified criterion. You can use it when editing rubrics, to set both name or points. * * @When /^I replace "(?P<current_value_string>(?:[^"]|\\")*)" rubric level with "(?P<value_string>(?:[^"]|\\")*)" in "(?P<criterion_string>(?:[^"]|\\")*)" criterion$/ * @throws ElementNotFoundException * @param string $currentvalue * @param string $value * @param string $criterionname */ public function i_replace_rubric_level_with($currentvalue, $value, $criterionname) { $currentvalueliteral = behat_context_helper::escape($currentvalue); $criterionliteral = behat_context_helper::escape($criterionname); $criterionxpath = "//div[@id='rubric-rubric']" . "/descendant::td[contains(concat(' ', normalize-space(@class), ' '), ' description ')]"; // It differs between JS on/off. if ($this->running_javascript()) { $criterionxpath .= "/descendant::span[@class='textvalue'][text()=$criterionliteral]" . "/ancestor::tr[contains(concat(' ', normalize-space(@class), ' '), ' criterion ')]"; } else { $criterionxpath .= "/descendant::textarea[text()=$criterionliteral]" . "/ancestor::tr[contains(concat(' ', normalize-space(@class), ' '), ' criterion ')]"; } $inputxpath = $criterionxpath . "/descendant::input[@type='text'][@value=$currentvalueliteral]"; $textareaxpath = $criterionxpath . "/descendant::textarea[text()=$currentvalueliteral]"; if ($this->running_javascript()) { $spansufix = "/ancestor::div[@class='level-wrapper']" . "/descendant::div[@class='definition']" . "/descendant::span[@class='textvalue']"; // Expanding the level input boxes. $this->execute('behat_general::i_click_on', [ $inputxpath . $spansufix . '|' . $textareaxpath . $spansufix, 'xpath', ]); $this->execute( 'behat_forms::i_set_the_field_with_xpath_to', [ $inputxpath . '|' . $textareaxpath, $value, ] ); } else { $fieldnode = $this->find('xpath', $inputxpath . '|' . $textareaxpath); $this->set_rubric_field_value($fieldnode->getAttribute('name'), $value); } } /** * Grades filling the current page rubric. Set one line per criterion and for each criterion set "| Criterion name | Points | Remark |". * * @When /^I grade by filling the rubric with:$/ * * @throws ExpectationException * @param TableNode $rubric */ public function i_grade_by_filling_the_rubric_with(TableNode $rubric) { $criteria = $rubric->getRowsHash(); $stepusage = '"I grade by filling the rubric with:" step needs you to provide a table where each row is a criterion' . ' and each criterion has 3 different values: | Criterion name | Number of points | Remark text |'; // If running Javascript, ensure we zoom in before filling the grades. if ($this->running_javascript()) { $this->execute('behat_general::click_link', get_string('togglezoom', 'mod_assign')); } // First element -> name, second -> points, third -> Remark. foreach ($criteria as $name => $criterion) { // We only expect the points and the remark, as the criterion name is $name. if (count($criterion) !== 2) { throw new ExpectationException($stepusage, $this->getSession()); } // Numeric value here. $points = $criterion[0]; if (!is_numeric($points)) { throw new ExpectationException($stepusage, $this->getSession()); } // Selecting a value. // When JS is disabled there are radio options, with JS enabled divs. $selectedlevelxpath = $this->get_level_xpath($points); if ($this->running_javascript()) { // Only clicking on the selected level if it was not already selected. $levelnode = $this->find('xpath', $selectedlevelxpath); // Using in_array() as there are only a few elements. if (!$levelnode->hasClass('checked')) { $levelnodexpath = $selectedlevelxpath . "//div[contains(concat(' ', normalize-space(@class), ' '), ' score ')]"; $this->execute('behat_general::i_click_on_in_the', array($levelnodexpath, "xpath_element", $this->escape($name), "table_row") ); } } else { // Getting the name of the field. $radioxpath = $this->get_criterion_xpath($name) . $selectedlevelxpath . "/descendant::input[@type='radio']"; $radionode = $this->find('xpath', $radioxpath); // which will delegate the process to the field type. $radionode->setValue($radionode->getAttribute('value')); } // Setting the remark. // First we need to get the textarea name, then we can set the value. $textarea = $this->get_node_in_container('css_element', 'textarea', 'table_row', $name); $this->execute('behat_forms::i_set_the_field_to', array($textarea->getAttribute('name'), $criterion[1])); } // If running Javascript, then ensure to close zoomed rubric. if ($this->running_javascript()) { $this->execute('behat_general::click_link', get_string('togglezoom', 'mod_assign')); } } /** * Checks that the level was previously selected and the user changed to another level. * * @Then /^the level with "(?P<points_number>\d+)" points was previously selected for the rubric criterion "(?P<criterion_name_string>(?:[^"]|\\")*)"$/ * @throws ExpectationException * @param string $criterionname * @param int $points * @return void */ public function the_level_with_points_was_previously_selected_for_the_rubric_criterion($points, $criterionname) { $levelxpath = $this->get_criterion_xpath($criterionname) . $this->get_level_xpath($points) . "[contains(concat(' ', normalize-space(@class), ' '), ' currentchecked ')]"; // Works both for JS and non-JS. // - JS: Class -> checked is there when is marked as green. // - Non-JS: When editing a rubric definition, there are radio inputs and when viewing a // grade @class contains checked. $levelxpath .= "[not(contains(concat(' ', normalize-space(@class), ' '), ' checked '))]" . "[not(/descendant::input[@type='radio'][@checked!='checked'])]"; try { $this->find('xpath', $levelxpath); } catch (ElementNotFoundException $e) { throw new ExpectationException('"' . $points . '" points level was not previously selected', $this->getSession()); } } /** * Checks that the level is currently selected. Works both when grading rubrics and viewing graded rubrics. * * @Then /^the level with "(?P<points_number>\d+)" points is selected for the rubric criterion "(?P<criterion_name_string>(?:[^"]|\\")*)"$/ * @throws ExpectationException * @param string $criterionname * @param int $points * @return void */ public function the_level_with_points_is_selected_for_the_rubric_criterion($points, $criterionname) { $levelxpath = $this->get_criterion_xpath($criterionname) . $this->get_level_xpath($points); // Works both for JS and non-JS. // - JS: Class -> checked is there when is marked as green. // - Non-JS: When editing a rubric definition, there are radio inputs and when viewing a // grade @class contains checked. $levelxpath .= "[" . "contains(concat(' ', normalize-space(@class), ' '), ' checked ')" . " or " . "/descendant::input[@type='radio'][@checked='checked']" . "]"; try { $this->find('xpath', $levelxpath); } catch (ElementNotFoundException $e) { throw new ExpectationException('"' . $points . '" points level is not selected', $this->getSession()); } } /** * Checks that the level is not currently selected. Works both when grading rubrics and viewing graded rubrics. * * @Then /^the level with "(?P<points_number>\d+)" points is not selected for the rubric criterion "(?P<criterion_name_string>(?:[^"]|\\")*)"$/ * @throws ExpectationException * @param string $criterionname * @param int $points * @return void */ public function the_level_with_points_is_not_selected_for_the_rubric_criterion($points, $criterionname) { $levelxpath = $this->get_criterion_xpath($criterionname) . $this->get_level_xpath($points); // Works both for JS and non-JS. // - JS: Class -> checked is there when is marked as green. // - Non-JS: When editing a rubric definition, there are radio inputs and when viewing a // grade @class contains checked. $levelxpath .= "[not(contains(concat(' ', normalize-space(@class), ' '), ' checked '))]" . "[./descendant::input[@type='radio'][@checked!='checked'] or not(./descendant::input[@type='radio'])]"; try { $this->find('xpath', $levelxpath); } catch (ElementNotFoundException $e) { throw new ExpectationException('"' . $points . '" points level is selected', $this->getSession()); } } /** * Makes a hidden rubric field visible (if necessary) and sets a value on it. * * @param string $name The name of the field * @param string $value The value to set * @param bool $visible * @return void */ protected function set_rubric_field_value($name, $value, $visible = false) { // Fields are hidden by default. if ($this->running_javascript() == true && $visible === false) { $xpath = "//*[@name='$name']/following-sibling::*[contains(concat(' ', normalize-space(@class), ' '), ' plainvalue ')]"; $this->execute('behat_general::i_click_on', [ $xpath, 'xpath', ]); } // Set the value now. $this->execute( 'behat_forms::i_set_the_field_to', [ $name, $value, ] ); } /** * Performs click confirming the action. * * @param NodeElement $node * @return void */ protected function click_and_confirm($node) { // Clicks to perform the action. $this->execute('behat_general::i_click_on', [ $node, 'NodeElement', ]); // Confirms the delete. if ($this->running_javascript()) { $this->execute('behat_general::i_click_on_in_the', [ get_string('yes'), 'button', get_string('confirmation', 'admin'), 'dialogue', ]); } } /** * Returns the xpath representing a selected level. * * It is not including the path to the criterion. * * It is the xpath when grading a rubric or viewing a rubric, * it is not the same xpath when editing a rubric. * * @param int $points * @return string */ protected function get_level_xpath($points) { return "//td[contains(concat(' ', normalize-space(@class), ' '), ' level ')]" . "[./descendant::span[@class='scorevalue'][text()='$points']]"; } /** * Returns the xpath representing the selected criterion. * * It is the xpath when grading a rubric or viewing a rubric, * it is not the same xpath when editing a rubric. * * @param string $criterionname Literal including the criterion name. * @return string */ protected function get_criterion_xpath($criterionname) { $literal = behat_context_helper::escape($criterionname); return "//tr[contains(concat(' ', normalize-space(@class), ' '), ' criterion ')]" . "[./descendant::td[@class='description'][text()=$literal]]"; } } grading/form/rubric/tests/behat/reuse_own_rubrics.feature 0000604 00000005034 15062070555 0017754 0 ustar 00 @gradingform @gradingform_rubric Feature: Reuse my rubrics in other activities In order to save time creating duplicated grading forms As a teacher I need to reuse rubrics that I created previously Background: Given the following "users" exist: | username | firstname | lastname | email | | teacher1 | Teacher | 1 | teacher1@example.com | And the following "courses" exist: | fullname | shortname | format | | Course 1 | C1 | topics | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | And the following "activities" exist: | activity | name | intro | course | section | idnumber | | assign | Test assignment 1 name | Test assignment 1 description | C1 | 1 | assign1 | | assign | Test assignment 2 name | Test assignment 2 description | C1 | 1 | assign1 | And I am on the "Test assignment 1 name" "assign activity editing" page logged in as teacher1 And I set the following fields to these values: | Grading method | Rubric | And I press "Save and return to course" And I go to "Test assignment 1 name" advanced grading definition page And I set the following fields to these values: | Name | Assignment 1 rubric | | Description | Assignment 1 description | And I define the following rubric: | Criterion 1 | Level 11 | 11 | Level 12 | 12 | Level 3 | 13 | | Criterion 2 | Level 21 | 21 | Level 22 | 22 | Level 3 | 23 | | Criterion 3 | Level 31 | 31 | Level 32 | 32 | | | And I press "Save rubric and make it ready" And I am on the "Test assignment 2 name" "assign activity editing" page And I set the following fields to these values: | Grading method | Rubric | And I press "Save and return to course" And I set "Test assignment 2 name" activity to use "Assignment 1 rubric" grading form Then I should see "Ready for use" And I should see "Criterion 1" And I should see "Criterion 2" And I should see "Criterion 3" And I am on "Course 1" course homepage And I go to "Test assignment 1 name" advanced grading definition page And I should see "Criterion 1" And I should see "Criterion 2" And I should see "Criterion 3" @javascript Scenario: A teacher can reuse one of his/her previously created rubrics, with Javascript enabled Scenario: A teacher can reuse one of his/her previously created rubrics, with Javascript disabled grading/form/rubric/tests/grades/grader/gradingpanel/external/store_test.php 0000604 00000023562 15062070555 0023455 0 ustar 00 <?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/>. declare(strict_types = 1); namespace gradingform_rubric\grades\grader\gradingpanel\external; use advanced_testcase; use coding_exception; use core_grades\component_gradeitem; use core_external\external_api; use mod_forum\local\entities\forum as forum_entity; use moodle_exception; /** * Unit tests for core_grades\component_gradeitems; * * @package gradingform_rubric * @category test * @copyright 2019 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class store_test extends advanced_testcase { /** * Ensure that an execute with an invalid component is rejected. */ public function test_execute_invalid_component(): void { $this->resetAfterTest(); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(coding_exception::class); $this->expectExceptionMessage("The 'foo' item is not valid for the 'mod_invalid' component"); store::execute('mod_invalid', 1, 'foo', 2, false, 'formdata'); } /** * Ensure that an execute with an invalid itemname on a valid component is rejected. */ public function test_execute_invalid_itemname(): void { $this->resetAfterTest(); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(coding_exception::class); $this->expectExceptionMessage("The 'foo' item is not valid for the 'mod_forum' component"); store::execute('mod_forum', 1, 'foo', 2, false, 'formdata'); } /** * Ensure that an execute against a different grading method is rejected. */ public function test_execute_incorrect_type(): void { $this->resetAfterTest(); $forum = $this->get_forum_instance([ 'grade_forum' => 5, ]); $course = $forum->get_course_record(); $teacher = $this->getDataGenerator()->create_and_enrol($course, 'teacher'); $student = $this->getDataGenerator()->create_and_enrol($course, 'student'); $this->setUser($teacher); $gradeitem = component_gradeitem::instance('mod_forum', $forum->get_context(), 'forum'); $this->expectException(moodle_exception::class); store::execute('mod_forum', (int) $forum->get_context()->id, 'forum', (int) $student->id, false, 'formdata'); } /** * Ensure that an execute against a different grading method is rejected. */ public function test_execute_disabled(): void { $this->resetAfterTest(); $forum = $this->get_forum_instance(); $course = $forum->get_course_record(); $teacher = $this->getDataGenerator()->create_and_enrol($course, 'teacher'); $student = $this->getDataGenerator()->create_and_enrol($course, 'student'); $this->setUser($teacher); $gradeitem = component_gradeitem::instance('mod_forum', $forum->get_context(), 'forum'); $this->expectException(moodle_exception::class); $this->expectExceptionMessage("Grading is not enabled"); store::execute('mod_forum', (int) $forum->get_context()->id, 'forum', (int) $student->id, false, 'formdata'); } /** * Ensure that an execute against the correct grading method returns the current state of the user. */ public function test_execute_store_graded(): void { $this->resetAfterTest(); $generator = \testing_util::get_data_generator(); $rubricgenerator = $generator->get_plugin_generator('gradingform_rubric'); [ 'forum' => $forum, 'controller' => $controller, 'definition' => $definition, 'student' => $student, 'teacher' => $teacher, ] = $this->get_test_data(); $this->setUser($teacher); $gradeitem = component_gradeitem::instance('mod_forum', $forum->get_context(), 'forum'); $grade = $gradeitem->get_grade_for_user($student, $teacher); $instance = $gradeitem->get_advanced_grading_instance($teacher, $grade); $submissiondata = $rubricgenerator->get_test_form_data($controller, (int) $student->id, 0, 'Too many mistakes. Please try again.', 2, 'Great number of pictures. Well done.' ); $formdata = http_build_query((object) [ 'instanceid' => $instance->get_id(), 'advancedgrading' => $submissiondata, ], '', '&'); $result = store::execute('mod_forum', (int) $forum->get_context()->id, 'forum', (int) $student->id, false, $formdata); $result = external_api::clean_returnvalue(store::execute_returns(), $result); $this->assertIsArray($result); $this->assertArrayHasKey('templatename', $result); $this->assertEquals('gradingform_rubric/grades/grader/gradingpanel', $result['templatename']); $this->assertArrayHasKey('warnings', $result); $this->assertIsArray($result['warnings']); $this->assertEmpty($result['warnings']); // Test the grade array items. $this->assertArrayHasKey('grade', $result); $this->assertIsArray($result['grade']); $this->assertIsInt($result['grade']['timecreated']); $this->assertArrayHasKey('timemodified', $result['grade']); $this->assertIsInt($result['grade']['timemodified']); $this->assertArrayHasKey('usergrade', $result['grade']); $this->assertEquals('1.00 / 2.00', $result['grade']['usergrade']); $this->assertArrayHasKey('maxgrade', $result['grade']); $this->assertIsInt($result['grade']['maxgrade']); $this->assertEquals(2, $result['grade']['maxgrade']); $this->assertArrayHasKey('gradedby', $result['grade']); $this->assertEquals(fullname($teacher), $result['grade']['gradedby']); $this->assertArrayHasKey('criteria', $result['grade']); $criteria = $result['grade']['criteria']; $this->assertCount(count($definition->rubric_criteria), $criteria); foreach ($criteria as $criterion) { $this->assertArrayHasKey('id', $criterion); $criterionid = $criterion['id']; $sourcecriterion = $definition->rubric_criteria[$criterionid]; $this->assertArrayHasKey('description', $criterion); $this->assertEquals($sourcecriterion['description'], $criterion['description']); $this->assertArrayHasKey('remark', $criterion); $this->assertArrayHasKey('levels', $criterion); $levels = $criterion['levels']; foreach ($levels as $level) { $levelid = $level['id']; if (!isset($levelid)) { continue; } $sourcelevel = $sourcecriterion['levels'][$levelid]; $this->assertArrayHasKey('criterionid', $level); $this->assertEquals($criterionid, $level['criterionid']); $this->assertArrayHasKey('checked', $level); $this->assertArrayHasKey('definition', $level); $this->assertEquals($sourcelevel['definition'], $level['definition']); $this->assertArrayHasKey('score', $level); $this->assertEquals($sourcelevel['score'], $level['score']); } } $this->assertEquals(1, $criteria[0]['levels'][1]['checked']); $this->assertEquals('Too many mistakes. Please try again.', $criteria[0]['remark']); $this->assertEquals(1, $criteria[1]['levels'][3]['checked']); $this->assertEquals('Great number of pictures. Well done.', $criteria[1]['remark']); } /** * Get a forum instance. * * @param array $config * @return forum_entity */ protected function get_forum_instance(array $config = []): forum_entity { $this->resetAfterTest(); $datagenerator = $this->getDataGenerator(); $course = $datagenerator->create_course(); $forum = $datagenerator->create_module('forum', array_merge($config, ['course' => $course->id])); $vaultfactory = \mod_forum\local\container::get_vault_factory(); $vault = $vaultfactory->get_forum_vault(); return $vault->get_from_id((int) $forum->id); } /** * Get test data for forums graded using a rubric. * * @return array */ protected function get_test_data(): array { global $DB; $this->resetAfterTest(); $generator = \testing_util::get_data_generator(); $rubricgenerator = $generator->get_plugin_generator('gradingform_rubric'); $forum = $this->get_forum_instance(); $course = $forum->get_course_record(); $teacher = $this->getDataGenerator()->create_and_enrol($course, 'teacher'); $student = $this->getDataGenerator()->create_and_enrol($course, 'student'); $this->setUser($teacher); $controller = $rubricgenerator->get_test_rubric($forum->get_context(), 'forum', 'forum'); $definition = $controller->get_definition(); $DB->set_field('forum', 'grade_forum', count($definition->rubric_criteria), ['id' => $forum->get_id()]); return [ 'forum' => $forum, 'controller' => $controller, 'definition' => $definition, 'student' => $student, 'teacher' => $teacher, ]; } } grading/form/rubric/tests/grades/grader/gradingpanel/external/fetch_test.php 0000604 00000036527 15062070555 0023417 0 ustar 00 <?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/>. declare(strict_types = 1); namespace gradingform_rubric\grades\grader\gradingpanel\external; use advanced_testcase; use coding_exception; use core_grades\component_gradeitem; use core_grades\component_gradeitems; use core_external\external_api; use mod_forum\local\entities\forum as forum_entity; use moodle_exception; /** * Unit tests for core_grades\component_gradeitems; * * @package gradingform_rubric * @category test * @copyright 2019 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class fetch_test extends advanced_testcase { /** * Ensure that an execute with an invalid component is rejected. */ public function test_execute_invalid_component(): void { $this->resetAfterTest(); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(coding_exception::class); $this->expectExceptionMessage("The 'foo' item is not valid for the 'mod_invalid' component"); fetch::execute('mod_invalid', 1, 'foo', 2); } /** * Ensure that an execute with an invalid itemname on a valid component is rejected. */ public function test_execute_invalid_itemname(): void { $this->resetAfterTest(); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(coding_exception::class); $this->expectExceptionMessage("The 'foo' item is not valid for the 'mod_forum' component"); fetch::execute('mod_forum', 1, 'foo', 2); } /** * Ensure that an execute against a different grading method is rejected. */ public function test_execute_incorrect_type(): void { $this->resetAfterTest(); $forum = $this->get_forum_instance([ // Negative numbers mean a scale. 'grade_forum' => 5, ]); $course = $forum->get_course_record(); $teacher = $this->getDataGenerator()->create_and_enrol($course, 'teacher'); $student = $this->getDataGenerator()->create_and_enrol($course, 'student'); $this->setUser($teacher); $gradeitem = component_gradeitem::instance('mod_forum', $forum->get_context(), 'forum'); $this->expectException(moodle_exception::class); $this->expectExceptionMessage("not configured for advanced grading with a rubric"); fetch::execute('mod_forum', (int) $forum->get_context()->id, 'forum', (int) $student->id); } /** * Ensure that an execute against the correct grading method returns the current state of the user. */ public function test_execute_fetch_empty(): void { $this->resetAfterTest(); [ 'forum' => $forum, 'controller' => $controller, 'definition' => $definition, 'student' => $student, 'teacher' => $teacher, ] = $this->get_test_data(); $this->setUser($teacher); $gradeitem = component_gradeitem::instance('mod_forum', $forum->get_context(), 'forum'); $result = fetch::execute('mod_forum', (int) $forum->get_context()->id, 'forum', (int) $student->id); $result = external_api::clean_returnvalue(fetch::execute_returns(), $result); $this->assertIsArray($result); $this->assertArrayHasKey('templatename', $result); $this->assertEquals('gradingform_rubric/grades/grader/gradingpanel', $result['templatename']); $this->assertArrayHasKey('warnings', $result); $this->assertIsArray($result['warnings']); $this->assertEmpty($result['warnings']); // Test the grade array items. $this->assertArrayHasKey('grade', $result); $this->assertIsArray($result['grade']); $this->assertIsInt($result['grade']['timecreated']); $this->assertArrayHasKey('timemodified', $result['grade']); $this->assertIsInt($result['grade']['timemodified']); $this->assertArrayHasKey('usergrade', $result['grade']); $this->assertEquals('- / 100.00', $result['grade']['usergrade']); $this->assertArrayHasKey('maxgrade', $result['grade']); $this->assertIsInt($result['grade']['maxgrade']); $this->assertEquals(100, $result['grade']['maxgrade']); $this->assertArrayHasKey('gradedby', $result['grade']); $this->assertEquals(null, $result['grade']['gradedby']); $this->assertArrayHasKey('criteria', $result['grade']); $criteria = $result['grade']['criteria']; $this->assertCount(count($definition->rubric_criteria), $criteria); foreach ($criteria as $criterion) { $this->assertArrayHasKey('id', $criterion); $criterionid = $criterion['id']; $sourcecriterion = $definition->rubric_criteria[$criterionid]; $this->assertArrayHasKey('description', $criterion); $this->assertEquals($sourcecriterion['description'], $criterion['description']); $this->assertArrayHasKey('levels', $criterion); $levels = $criterion['levels']; foreach ($levels as $level) { $levelid = $level['id']; if (!isset($levelid)) { continue; } $sourcelevel = $sourcecriterion['levels'][$levelid]; $this->assertArrayHasKey('criterionid', $level); $this->assertEquals($criterionid, $level['criterionid']); $this->assertArrayHasKey('checked', $level); $this->assertArrayHasKey('definition', $level); $this->assertEquals($sourcelevel['definition'], $level['definition']); $this->assertArrayHasKey('score', $level); $this->assertEquals($sourcelevel['score'], $level['score']); } } } /** * Ensure that an execute against the correct grading method returns the current state of the user. */ public function test_execute_fetch_graded(): void { $this->resetAfterTest(); [ 'forum' => $forum, 'controller' => $controller, 'definition' => $definition, 'student' => $student, 'teacher' => $teacher, ] = $this->get_test_data(); $this->execute_and_assert_fetch($forum, $controller, $definition, $teacher, $teacher, $student); } /** * Class mates should not get other's grades. */ public function test_execute_fetch_does_not_return_data_to_other_students(): void { $this->resetAfterTest(); [ 'forum' => $forum, 'controller' => $controller, 'definition' => $definition, 'student' => $student, 'teacher' => $teacher, 'course' => $course, ] = $this->get_test_data(); $evilstudent = $this->getDataGenerator()->create_and_enrol($course, 'student'); $this->expectException(\required_capability_exception::class); $this->execute_and_assert_fetch($forum, $controller, $definition, $evilstudent, $teacher, $student); } /** * Grades can be returned to graded user. */ public function test_execute_fetch_return_data_to_graded_user(): void { $this->resetAfterTest(); [ 'forum' => $forum, 'controller' => $controller, 'definition' => $definition, 'student' => $student, 'teacher' => $teacher, ] = $this->get_test_data(); $this->execute_and_assert_fetch($forum, $controller, $definition, $student, $teacher, $student); } /** * Executes and performs all the assertions of the fetch method with the given parameters. */ private function execute_and_assert_fetch ($forum, $controller, $definition, $fetcheruser, $grader, $gradeduser) { $generator = \testing_util::get_data_generator(); $rubricgenerator = $generator->get_plugin_generator('gradingform_rubric'); $this->setUser($grader); $gradeitem = component_gradeitem::instance('mod_forum', $forum->get_context(), 'forum'); $grade = $gradeitem->get_grade_for_user($gradeduser, $grader); $instance = $gradeitem->get_advanced_grading_instance($grader, $grade); $submissiondata = $rubricgenerator->get_test_form_data($controller, (int) $gradeduser->id, 0, 'Too many mistakes. Please try again.', 2, 'Great number of pictures. Well done.' ); $gradeitem->store_grade_from_formdata($gradeduser, $grader, (object) [ 'instanceid' => $instance->get_id(), 'advancedgrading' => $submissiondata, ]); $this->setUser($fetcheruser); $result = fetch::execute('mod_forum', (int) $forum->get_context()->id, 'forum', (int) $gradeduser->id); $result = external_api::clean_returnvalue(fetch::execute_returns(), $result); $this->assertIsArray($result); $this->assertArrayHasKey('templatename', $result); $this->assertEquals('gradingform_rubric/grades/grader/gradingpanel', $result['templatename']); $this->assertArrayHasKey('warnings', $result); $this->assertIsArray($result['warnings']); $this->assertEmpty($result['warnings']); // Test the grade array items. $this->assertArrayHasKey('grade', $result); $this->assertIsArray($result['grade']); $this->assertIsInt($result['grade']['timecreated']); $this->assertArrayHasKey('timemodified', $result['grade']); $this->assertIsInt($result['grade']['timemodified']); $this->assertArrayHasKey('usergrade', $result['grade']); $this->assertEquals('50.00 / 100.00', $result['grade']['usergrade']); $this->assertArrayHasKey('maxgrade', $result['grade']); $this->assertIsInt($result['grade']['maxgrade']); $this->assertEquals(100, $result['grade']['maxgrade']); $this->assertArrayHasKey('gradedby', $result['grade']); $this->assertEquals(fullname($grader), $result['grade']['gradedby']); $this->assertArrayHasKey('criteria', $result['grade']); $criteria = $result['grade']['criteria']; $this->assertCount(count($definition->rubric_criteria), $criteria); foreach ($criteria as $criterion) { $this->assertArrayHasKey('id', $criterion); $criterionid = $criterion['id']; $sourcecriterion = $definition->rubric_criteria[$criterionid]; $this->assertArrayHasKey('description', $criterion); $this->assertEquals($sourcecriterion['description'], $criterion['description']); $this->assertArrayHasKey('remark', $criterion); $this->assertArrayHasKey('levels', $criterion); $levels = $criterion['levels']; foreach ($levels as $level) { $levelid = $level['id']; if (!isset($levelid)) { continue; } $sourcelevel = $sourcecriterion['levels'][$levelid]; $this->assertArrayHasKey('criterionid', $level); $this->assertEquals($criterionid, $level['criterionid']); $this->assertArrayHasKey('checked', $level); $this->assertArrayHasKey('definition', $level); $this->assertEquals($sourcelevel['definition'], $level['definition']); $this->assertArrayHasKey('score', $level); $this->assertEquals($sourcelevel['score'], $level['score']); } } $this->assertEquals(1, $criteria[0]['levels'][1]['checked']); $this->assertEquals('Too many mistakes. Please try again.', $criteria[0]['remark']); $this->assertEquals(1, $criteria[1]['levels'][3]['checked']); $this->assertEquals('Great number of pictures. Well done.', $criteria[1]['remark']); } /** * Get a forum instance. * * @param array $config * @return forum_entity */ protected function get_forum_instance(array $config = []): forum_entity { $this->resetAfterTest(); $datagenerator = $this->getDataGenerator(); $course = $datagenerator->create_course(); $forum = $datagenerator->create_module('forum', array_merge($config, ['course' => $course->id, 'grade_forum' => 100])); $vaultfactory = \mod_forum\local\container::get_vault_factory(); $vault = $vaultfactory->get_forum_vault(); return $vault->get_from_id((int) $forum->id); } /** * Get test data for forums graded using a rubric. * * @return array */ protected function get_test_data(): array { global $DB; $this->resetAfterTest(); $generator = \testing_util::get_data_generator(); $rubricgenerator = $generator->get_plugin_generator('gradingform_rubric'); $forum = $this->get_forum_instance(); $course = $forum->get_course_record(); $teacher = $this->getDataGenerator()->create_and_enrol($course, 'teacher'); $student = $this->getDataGenerator()->create_and_enrol($course, 'student'); $this->setUser($teacher); $controller = $rubricgenerator->get_test_rubric($forum->get_context(), 'forum', 'forum'); $definition = $controller->get_definition(); // In the situation of mod_forum this would be the id from forum_grades. $itemid = 1; $instance = $controller->create_instance($student->id, $itemid); $data = $this->get_test_form_data( $controller, $itemid, 1, 'This user made several mistakes.', 0, 'Please add more pictures.' ); // Update this instance with data. $instance->update($data); return [ 'forum' => $forum, 'controller' => $controller, 'definition' => $definition, 'student' => $student, 'teacher' => $teacher, 'course' => $course, ]; } /** * Fetch a set of sample data. * * @param \gradingform_rubric_controller $controller * @param int $itemid * @param float $spellingscore * @param string $spellingremark * @param float $picturescore * @param string $pictureremark * @return array */ protected function get_test_form_data( \gradingform_rubric_controller $controller, int $itemid, float $spellingscore, string $spellingremark, float $picturescore, string $pictureremark ): array { $generator = \testing_util::get_data_generator(); $rubricgenerator = $generator->get_plugin_generator('gradingform_rubric'); return $rubricgenerator->get_test_form_data( $controller, $itemid, $spellingscore, $spellingremark, $picturescore, $pictureremark ); } } grading/form/rubric/tests/generator_test.php 0000604 00000031712 15062070555 0015315 0 ustar 00 <?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/>. /** * Generator testcase for the gradingforum_rubric generator. * * @package gradingform_rubric * @category test * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradingform_rubric; use advanced_testcase; use context_module; use gradingform_rubric_controller; use gradingform_controller; /** * Generator testcase for the gradingforum_rubric generator. * * @package gradingform_rubric * @category test * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class generator_test extends advanced_testcase { /** * Test rubric creation. */ public function test_rubric_creation(): void { $this->resetAfterTest(true); // Fetch generators. $generator = \testing_util::get_data_generator(); $rubricgenerator = $generator->get_plugin_generator('gradingform_rubric'); // Create items required for testing. $course = $generator->create_course(); $module = $generator->create_module('assign', ['course' => $course]); $user = $generator->create_user(); $context = context_module::instance($module->cmid); // Data for testing. $name = 'myfirstrubric'; $description = 'My first rubric'; $criteria = [ 'Alphabet' => [ 'Not known' => 0, 'Letters known but out of order' => 1, 'Letters known in order ascending' => 2, 'Letters known and can recite forwards and backwards' => 4, ], 'Times tables' => [ 'Not known' => 0, '2 times table known' => 2, '2 and 5 times table known' => 4, '2, 5, and 10 times table known' => 8, ], ]; // Unit under test. $this->setUser($user); $controller = $rubricgenerator->create_instance($context, 'mod_assign', 'submission', $name, $description, $criteria); $this->assertInstanceOf(gradingform_rubric_controller::class, $controller); $definition = $controller->get_definition(); $this->assertNotEmpty($definition->id); $this->assertEquals($name, $definition->name); $this->assertEquals($description, $definition->description); $this->assertEquals(gradingform_controller::DEFINITION_STATUS_READY, $definition->status); $this->assertNotEmpty($definition->timecreated); $this->assertNotEmpty($definition->timemodified); $this->assertEquals($user->id, $definition->usercreated); $this->assertNotEmpty($definition->rubric_criteria); $this->assertCount(2, $definition->rubric_criteria); // Check the alphabet criteria. $criteriaids = array_keys($definition->rubric_criteria); $alphabet = $definition->rubric_criteria[$criteriaids[0]]; $this->assertNotEmpty($alphabet['id']); $this->assertEquals(1, $alphabet['sortorder']); $this->assertEquals('Alphabet', $alphabet['description']); $this->assertNotEmpty($alphabet['levels']); $levels = $alphabet['levels']; $levelids = array_keys($levels); $level = $levels[$levelids[0]]; $this->assertEquals(0, $level['score']); $this->assertEquals('Not known', $level['definition']); $level = $levels[$levelids[1]]; $this->assertEquals(1, $level['score']); $this->assertEquals('Letters known but out of order', $level['definition']); $level = $levels[$levelids[2]]; $this->assertEquals(2, $level['score']); $this->assertEquals('Letters known in order ascending', $level['definition']); $level = $levels[$levelids[3]]; $this->assertEquals(4, $level['score']); $this->assertEquals('Letters known and can recite forwards and backwards', $level['definition']); // Check the times tables criteria. $tables = $definition->rubric_criteria[$criteriaids[1]]; $this->assertNotEmpty($tables['id']); $this->assertEquals(2, $tables['sortorder']); $this->assertEquals('Times tables', $tables['description']); $this->assertNotEmpty($tables['levels']); $levels = $tables['levels']; $levelids = array_keys($levels); $level = $levels[$levelids[0]]; $this->assertEquals(0, $level['score']); $this->assertEquals('Not known', $level['definition']); $level = $levels[$levelids[1]]; $this->assertEquals(2, $level['score']); $this->assertEquals('2 times table known', $level['definition']); $level = $levels[$levelids[2]]; $this->assertEquals(4, $level['score']); $this->assertEquals('2 and 5 times table known', $level['definition']); $level = $levels[$levelids[3]]; $this->assertEquals(8, $level['score']); $this->assertEquals('2, 5, and 10 times table known', $level['definition']); } /** * Test the get_level_and_criterion_for_values function. * This is used for finding criterion and level information within a rubric. */ public function test_get_level_and_criterion_for_values(): void { $this->resetAfterTest(true); // Fetch generators. $generator = \testing_util::get_data_generator(); $rubricgenerator = $generator->get_plugin_generator('gradingform_rubric'); // Create items required for testing. $course = $generator->create_course(); $module = $generator->create_module('assign', ['course' => $course]); $user = $generator->create_user(); $context = context_module::instance($module->cmid); // Data for testing. $description = 'My first rubric'; $criteria = [ 'Alphabet' => [ 'Not known' => 0, 'Letters known but out of order' => 1, 'Letters known in order ascending' => 2, 'Letters known and can recite forwards and backwards' => 4, ], 'Times tables' => [ 'Not known' => 0, '2 times table known' => 2, '2 and 5 times table known' => 4, '2, 5, and 10 times table known' => 8, ], ]; $this->setUser($user); $controller = $rubricgenerator->create_instance($context, 'mod_assign', 'submission', 'rubric', $description, $criteria); // Valid criterion and level. $result = $rubricgenerator->get_level_and_criterion_for_values($controller, 'Alphabet', 2); $this->assertEquals('Alphabet', $result['criterion']->description); $this->assertEquals('2', $result['level']->score); $this->assertEquals('Letters known in order ascending', $result['level']->definition); // Valid criterion. Invalid level. $result = $rubricgenerator->get_level_and_criterion_for_values($controller, 'Alphabet', 3); $this->assertEquals('Alphabet', $result['criterion']->description); $this->assertNull($result['level']); // Invalid criterion. $result = $rubricgenerator->get_level_and_criterion_for_values($controller, 'Foo', 0); $this->assertNull($result['criterion']); } /** * Tests for the get_test_rubric function. */ public function test_get_test_rubric(): void { $this->resetAfterTest(true); // Fetch generators. $generator = \testing_util::get_data_generator(); $rubricgenerator = $generator->get_plugin_generator('gradingform_rubric'); // Create items required for testing. $course = $generator->create_course(); $module = $generator->create_module('assign', ['course' => $course]); $user = $generator->create_user(); $context = context_module::instance($module->cmid); $this->setUser($user); $rubric = $rubricgenerator->get_test_rubric($context, 'assign', 'submissions'); $definition = $rubric->get_definition(); $this->assertEquals('testrubric', $definition->name); $this->assertEquals('Description text', $definition->description); $this->assertEquals(gradingform_controller::DEFINITION_STATUS_READY, $definition->status); // Should create a rubric with 2 criterion. $this->assertCount(2, $definition->rubric_criteria); } /** * Test the get_submitted_form_data function. */ public function test_get_submitted_form_data(): void { $this->resetAfterTest(true); // Fetch generators. $generator = \testing_util::get_data_generator(); $rubricgenerator = $generator->get_plugin_generator('gradingform_rubric'); // Create items required for testing. $course = $generator->create_course(); $module = $generator->create_module('assign', ['course' => $course]); $user = $generator->create_user(); $context = context_module::instance($module->cmid); $this->setUser($user); $controller = $rubricgenerator->get_test_rubric($context, 'assign', 'submissions'); $result = $rubricgenerator->get_submitted_form_data($controller, 93, [ 'Spelling is important' => [ 'score' => 1, 'remark' => 'Good speeling', ], 'Pictures' => [ 'score' => 2, 'remark' => 'Lots of nice pictures!', ] ]); $this->assertIsArray($result); $this->assertEquals(93, $result['itemid']); $this->assertIsArray($result['criteria']); $this->assertCount(2, $result['criteria']); $spelling = $rubricgenerator->get_level_and_criterion_for_values($controller, 'Spelling is important', 1); $this->assertIsArray($result['criteria'][$spelling['criterion']->id]); $this->assertEquals($spelling['level']->id, $result['criteria'][$spelling['criterion']->id]['levelid']); $this->assertEquals('Good speeling', $result['criteria'][$spelling['criterion']->id]['remark']); $pictures = $rubricgenerator->get_level_and_criterion_for_values($controller, 'Pictures', 2); $this->assertIsArray($result['criteria'][$pictures['criterion']->id]); $this->assertEquals($pictures['level']->id, $result['criteria'][$pictures['criterion']->id]['levelid']); $this->assertEquals('Lots of nice pictures!', $result['criteria'][$pictures['criterion']->id]['remark']); } /** * Test the get_test_form_data function. */ public function test_get_test_form_data(): void { $this->resetAfterTest(true); // Fetch generators. $generator = \testing_util::get_data_generator(); $rubricgenerator = $generator->get_plugin_generator('gradingform_rubric'); // Create items required for testing. $course = $generator->create_course(); $module = $generator->create_module('assign', ['course' => $course]); $user = $generator->create_user(); $context = context_module::instance($module->cmid); $this->setUser($user); $controller = $rubricgenerator->get_test_rubric($context, 'assign', 'submissions'); // Unit under test. $result = $rubricgenerator->get_test_form_data( $controller, 1839, 1, 'Propper good speling', 0, 'ASCII art is not a picture' ); $this->assertIsArray($result); $this->assertEquals(1839, $result['itemid']); $this->assertIsArray($result['criteria']); $this->assertCount(2, $result['criteria']); $spelling = $rubricgenerator->get_level_and_criterion_for_values($controller, 'Spelling is important', 1); $this->assertIsArray($result['criteria'][$spelling['criterion']->id]); $this->assertEquals($spelling['level']->id, $result['criteria'][$spelling['criterion']->id]['levelid']); $this->assertEquals('Propper good speling', $result['criteria'][$spelling['criterion']->id]['remark']); $pictures = $rubricgenerator->get_level_and_criterion_for_values($controller, 'Pictures', 0); $this->assertIsArray($result['criteria'][$pictures['criterion']->id]); $this->assertEquals($pictures['level']->id, $result['criteria'][$pictures['criterion']->id]['levelid']); $this->assertEquals('ASCII art is not a picture', $result['criteria'][$pictures['criterion']->id]['remark']); } } grading/form/rubric/tests/generator/rubric.php 0000604 00000007352 15062070555 0015547 0 ustar 00 <?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/>. /** * Generator for the gradingforum_rubric plugin. * * @package gradingform_rubric * @category test * @copyright 2018 Adrian Greeve <adriangreeve.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace tests\gradingform_rubric\generator; use gradingform_controller; use stdClass; /** * Test rubric. * * @package gradingform_rubric * @category test * @copyright 2018 Adrian Greeve <adriangreeve.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class rubric { /** @var array $criteria The criteria for this rubric. */ protected $criteria = []; /** @var string The name of this rubric. */ protected $name; /** @var string A description for this rubric. */ protected $description; /** @var array The rubric options. */ protected $options = []; /** * Create a new gradingform_rubric_generator_rubric. * * @param string $name * @param string $description */ public function __construct(string $name, string $description) { $this->name = $name; $this->description = $description; $this->set_option('sortlevelsasc', 1); $this->set_option('lockzeropoints', 1); $this->set_option('showdescriptionteacher', 1); $this->set_option('showdescriptionstudent', 1); $this->set_option('showscoreteacher', 1); $this->set_option('showscorestudent', 1); $this->set_option('enableremarks', 1); $this->set_option('showremarksstudent', 1); } /** * Creates the rubric using the appropriate APIs. */ public function get_definition(): stdClass { return (object) [ 'name' => $this->name, 'description_editor' => [ 'text' => $this->description, 'format' => FORMAT_HTML, 'itemid' => 1 ], 'rubric' => [ 'criteria' => $this->get_all_criterion_values(), 'options' => $this->options, ], 'saverubric' => 'Save rubric and make it ready', 'status' => gradingform_controller::DEFINITION_STATUS_READY, ]; } /** * Set an option for the rubric. * * @param string $key * @param mixed $value * @return self */ public function set_option(string $key, $value): self { $this->options[$key] = $value; return $this; } /** * Adds a criterion to the rubric. * * @param criterion $criterion The criterion object (class below). * @return self */ public function add_criteria(criterion $criterion): self { $this->criteria[] = $criterion; return $this; } /** * Get all criterion values. * * @return array */ protected function get_all_criterion_values(): array { $result = []; foreach ($this->criteria as $index => $criterion) { $id = $index + 1; $result["NEWID{$id}"] = $criterion->get_all_values($id); } return $result; } } grading/form/rubric/tests/generator/lib.php 0000604 00000020132 15062070555 0015016 0 ustar 00 <?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/>. /** * Generator for the gradingforum_rubric plugin. * * @package gradingform_rubric * @category test * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); require_once(__DIR__ . '/rubric.php'); require_once(__DIR__ . '/criterion.php'); use tests\gradingform_rubric\generator\rubric; use tests\gradingform_rubric\generator\criterion; /** * Generator for the gradingforum_rubric plugintype. * * @package gradingform_rubric * @category test * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class gradingform_rubric_generator extends component_generator_base { /** * Create an instance of a rubric. * * @param context $context * @param string $component * @param string $area * @param string $name * @param string $description * @param array $criteria The list of criteria to add to the generated rubric * @return gradingform_rubric_controller */ public function create_instance( context $context, string $component, string $area, string $name, string $description, array $criteria ): gradingform_rubric_controller { global $USER; if ($USER->id === 0) { throw new \coding_exception('Creation of a rubric must currently be run as a user.'); } // Fetch the controller for this context/component/area. $generator = \testing_util::get_data_generator(); $gradinggenerator = $generator->get_plugin_generator('core_grading'); $controller = $gradinggenerator->create_instance($context, $component, $area, 'rubric'); // Generate a definition for the supplied rubric. $rubric = $this->get_rubric($name, $description); foreach ($criteria as $name => $criterion) { $rubric->add_criteria($this->get_criterion($name, $criterion)); } // Update the controller wih the rubric definition. $controller->update_definition($rubric->get_definition()); return $controller; } /** * Get a new rubric for use with the rubric controller. * * Note: This is just a helper class used to build a new definition. It does not persist the data. * * @param string $name * @param string $description * @return rubric */ protected function get_rubric(string $name, string $description): rubric { return new rubric($name, $description); } /** * Get a new rubric for use with a gradingform_rubric_generator_rubric. * * Note: This is just a helper class used to build a new definition. It does not persist the data. * * @param string $description * @param array $levels Set of levels in the form definition => score * @return gradingform_rubric_generator_criterion */ protected function get_criterion(string $description, array $levels = []): criterion { return new criterion($description, $levels); } /** * Given a controller instance, fetch the level and criterion information for the specified values. * * @param gradingform_controller $controller * @param string $description The description to match the criterion on * @param float $score The value to match the level on * @return array */ public function get_level_and_criterion_for_values( gradingform_controller $controller, string $description, float $score ): array { $definition = $controller->get_definition(); $criteria = $definition->rubric_criteria; $criterion = $level = null; $criterion = array_reduce($criteria, function($carry, $criterion) use ($description) { if ($criterion['description'] === $description) { $carry = $criterion; } return $carry; }, null); if ($criterion) { $criterion = (object) $criterion; $level = array_reduce($criterion->levels, function($carry, $level) use ($score) { if ($level['score'] == $score) { $carry = $level; } return $carry; }); $level = $level ? (object) $level : null; } return [ 'criterion' => $criterion, 'level' => $level, ]; } /** * Get submitted form data for the supplied controller, itemid, and values. * The returned data is in the format used by rubric when handling form submission. * * @param gradingform_rubric_controller $controller * @param int $itemid * @param array $values A set of array values where the array key is the name of the criterion, and the value is an * array with the desired score, and any remark. */ public function get_submitted_form_data(gradingform_rubric_controller $controller, int $itemid, array $values): array { $result = [ 'itemid' => $itemid, 'criteria' => [], ]; foreach ($values as $criterionname => ['score' => $score, 'remark' => $remark]) { [ 'criterion' => $criterion, 'level' => $level, ] = $this->get_level_and_criterion_for_values($controller, $criterionname, $score); $result['criteria'][$criterion->id] = [ 'levelid' => $level->id, 'remark' => $remark, ]; } return $result; } /** * Generate a rubric controller with sample data required for testing of this class. * * @param context $context * @param string $component * @param string $area * @return gradingform_rubric_controller */ public function get_test_rubric(context $context, string $component, string $area): gradingform_rubric_controller { $criteria = [ 'Spelling is important' => [ 'Nothing but mistakes' => 0, 'Several mistakes' => 1, 'No mistakes' => 2, ], 'Pictures' => [ 'No pictures' => 0, 'One picture' => 1, 'More than one picture' => 2, ], ]; return $this->create_instance($context, $component, $area, 'testrubric', 'Description text', $criteria); } /** * Fetch a set of sample data. * * @param gradingform_rubric_controller $controller * @param int $itemid * @param float $spellingscore * @param string $spellingremark * @param float $picturescore * @param string $pictureremark * @return array */ public function get_test_form_data( gradingform_rubric_controller $controller, int $itemid, float $spellingscore, string $spellingremark, float $picturescore, string $pictureremark ): array { $generator = \testing_util::get_data_generator(); $rubricgenerator = $generator->get_plugin_generator('gradingform_rubric'); return $rubricgenerator->get_submitted_form_data($controller, $itemid, [ 'Spelling is important' => [ 'score' => $spellingscore, 'remark' => $spellingremark, ], 'Pictures' => [ 'score' => $picturescore, 'remark' => $pictureremark, ], ]); } } grading/form/rubric/tests/generator/criterion.php 0000604 00000006461 15062070555 0016257 0 ustar 00 <?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/>. /** * Generator for the gradingforum_rubric plugin. * * @package gradingform_rubric * @category test * @copyright 2018 Adrian Greeve <adriangreeve.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace tests\gradingform_rubric\generator; /** * Convenience class to create rubric criterion. * * @package gradingform_rubric * @copyright 2018 Adrian Greeve <adriangreeve.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class criterion { /** @var string $description A description of the criterion. */ public $description; /** @var integer $sortorder sort order of the criterion. */ public $sortorder = 0; /** @var array $levels The levels for this criterion. */ public $levels = []; /** * Constructor for this test_criterion object * * @param string $description A description of this criterion. * @param array $levels */ public function __construct(string $description, array $levels = []) { $this->description = $description; foreach ($levels as $definition => $score) { $this->add_level($definition, $score); } } /** * Adds levels to the criterion. * * @param string $definition The definition for this level. * @param int $score The score received if this level is selected. * @return self */ public function add_level(string $definition, int $score): self { $this->levels[] = [ 'definition' => $definition, 'score' => $score ]; return $this; } /** * Get the description for this criterion. * * @return string */ public function get_description(): string { return $this->description; } /** * Get the levels for this criterion. * * @return array */ public function get_levels(): array { return $this->levels; } /** * Get all values in an array for use when creating a new guide. * * @param int $sortorder * @return array */ public function get_all_values(int $sortorder): array { return [ 'sortorder' => $sortorder, 'description' => $this->get_description(), 'levels' => $this->get_all_level_values(), ]; } /** * Get all level values. * * @return array */ public function get_all_level_values(): array { $result = []; foreach ($this->get_levels() as $index => $level) { $id = $index + 1; $result["NEWID{$id}"] = $level; } return $result; } } grading/form/rubric/tests/privacy/provider_test.php 0000604 00000015161 15062070555 0016636 0 ustar 00 <?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/>. /** * Privacy tests for gradingform_rubric * * @package gradingform_rubric * @category test * @copyright 2018 Adrian Greeve <adriangreeve.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradingform_rubric\privacy; use core_privacy\tests\provider_testcase; use core_privacy\local\request\writer; use gradingform_rubric\privacy\provider; use gradingform_rubric_controller; use context_module; /** * Privacy tests for gradingform_rubric * * @copyright 2018 Adrian Greeve <adriangreeve.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class provider_test extends provider_testcase { /** * Test the export of rubric data. */ public function test_get_gradingform_export_data() { global $DB; $this->resetAfterTest(); $course = $this->getDataGenerator()->create_course(); $module = $this->getDataGenerator()->create_module('assign', ['course' => $course]); $modulecontext = context_module::instance($module->cmid); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); // Generate a test rubric and get its controller. $controller = $this->get_test_rubric($modulecontext, 'assign', 'submissions'); // In the situation of mod_assign this would be the id from assign_grades. $itemid = 1; $instance = $controller->create_instance($user->id, $itemid); $data = $this->get_test_form_data( $controller, $itemid, 1, 'This user made several mistakes.', 0, 'Please add more pictures.' ); // Update this instance with data. $instance->update($data); $instanceid = $instance->get_data('id'); // Let's try the method we are testing. provider::export_gradingform_instance_data($modulecontext, $instance->get_id(), ['Test']); $data = (array) writer::with_context($modulecontext)->get_data(['Test', 'Rubric', $instanceid]); $this->assertCount(2, $data); $this->assertEquals('Spelling is important', $data['Spelling is important']->description); $this->assertEquals('This user made several mistakes.', $data['Spelling is important']->remark); $this->assertEquals('Pictures', $data['Pictures']->description); $this->assertEquals('Please add more pictures.', $data['Pictures']->remark); } /** * Test the deletion of rubric user information via the instance ID. */ public function test_delete_gradingform_for_instances() { global $DB; $this->resetAfterTest(); $course = $this->getDataGenerator()->create_course(); $module = $this->getDataGenerator()->create_module('assign', ['course' => $course]); $modulecontext = context_module::instance($module->cmid); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); // Generate a test rubric and get its controller. $controller = $this->get_test_rubric($modulecontext, 'assign', 'submissions'); // In the situation of mod_assign this would be the id from assign_grades. $itemid = 1; $instance = $controller->create_instance($user->id, $itemid); $data = $this->get_test_form_data( $controller, $itemid, 1, 'This user made several mistakes.', 0, 'Please add more pictures.' ); // Update this instance with data. $instance->update($data); // Second instance. $itemid = 2; $instance = $controller->create_instance($user->id, $itemid); $data = $this->get_test_form_data( $controller, $itemid, 0, 'Too many mistakes. Please try again.', 2, 'Great number of pictures. Well done.' ); // Update this instance with data. $instance->update($data); // Check how many records we have in the fillings table. $records = $DB->get_records('gradingform_rubric_fillings'); $this->assertCount(4, $records); // Let's delete one of the instances (the last one would be the easiest). provider::delete_gradingform_for_instances([$instance->get_id()]); $records = $DB->get_records('gradingform_rubric_fillings'); $this->assertCount(2, $records); foreach ($records as $record) { $this->assertNotEquals($instance->get_id(), $record->instanceid); } } /** * Generate a rubric controller with sample data required for testing of this class. * * @param context_module $context * @param string $component * @param string $area * @return gradingform_rubric_controller */ protected function get_test_rubric(context_module $context, string $component, string $area): gradingform_rubric_controller { $generator = \testing_util::get_data_generator(); $rubricgenerator = $generator->get_plugin_generator('gradingform_rubric'); return $rubricgenerator->get_test_rubric($context, $component, $area); } /** * Fetch a set of sample data. * * @param gradingform_rubric_controller $controller * @param int $itemid * @param float $spellingscore * @param string $spellingremark * @param float $picturescore * @param string $pictureremark * @return array */ protected function get_test_form_data( gradingform_rubric_controller $controller, int $itemid, float $spellingscore, string $spellingremark, float $picturescore, string $pictureremark ): array { $generator = \testing_util::get_data_generator(); $rubricgenerator = $generator->get_plugin_generator('gradingform_rubric'); return $rubricgenerator->get_test_form_data( $controller, $itemid, $spellingscore, $spellingremark, $picturescore, $pictureremark ); } } grading/form/rubric/lib.php 0000604 00000126757 15062070555 0011712 0 ustar 00 <?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/>. /** * Grading method controller for the Rubric plugin * * @package gradingform_rubric * @copyright 2011 David Mudrak <david@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ use core_external\external_format_value; use core_external\external_multiple_structure; use core_external\external_single_structure; use core_external\external_value; defined('MOODLE_INTERNAL') || die(); require_once($CFG->dirroot.'/grade/grading/form/lib.php'); require_once($CFG->dirroot.'/lib/filelib.php'); /** rubric: Used to compare our gradeitem_type against. */ const RUBRIC = 'rubric'; /** * This controller encapsulates the rubric grading logic * * @package gradingform_rubric * @copyright 2011 David Mudrak <david@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class gradingform_rubric_controller extends gradingform_controller { // Modes of displaying the rubric (used in gradingform_rubric_renderer) /** Rubric display mode: For editing (moderator or teacher creates a rubric) */ const DISPLAY_EDIT_FULL = 1; /** Rubric display mode: Preview the rubric design with hidden fields */ const DISPLAY_EDIT_FROZEN = 2; /** Rubric display mode: Preview the rubric design (for person with manage permission) */ const DISPLAY_PREVIEW = 3; /** Rubric display mode: Preview the rubric (for people being graded) */ const DISPLAY_PREVIEW_GRADED= 8; /** Rubric display mode: For evaluation, enabled (teacher grades a student) */ const DISPLAY_EVAL = 4; /** Rubric display mode: For evaluation, with hidden fields */ const DISPLAY_EVAL_FROZEN = 5; /** Rubric display mode: Teacher reviews filled rubric */ const DISPLAY_REVIEW = 6; /** Rubric display mode: Dispaly filled rubric (i.e. students see their grades) */ const DISPLAY_VIEW = 7; /** * Extends the module settings navigation with the rubric grading settings * * This function is called when the context for the page is an activity module with the * FEATURE_ADVANCED_GRADING, the user has the permission moodle/grade:managegradingforms * and there is an area with the active grading method set to 'rubric'. * * @param settings_navigation $settingsnav {@link settings_navigation} * @param navigation_node $node {@link navigation_node} */ public function extend_settings_navigation(settings_navigation $settingsnav, navigation_node $node=null) { $node->add(get_string('definerubric', 'gradingform_rubric'), $this->get_editor_url(), settings_navigation::TYPE_CUSTOM, null, null, new pix_icon('icon', '', 'gradingform_rubric')); } /** * Extends the module navigation * * This function is called when the context for the page is an activity module with the * FEATURE_ADVANCED_GRADING and there is an area with the active grading method set to the given plugin. * * @param global_navigation $navigation {@link global_navigation} * @param navigation_node $node {@link navigation_node} */ public function extend_navigation(global_navigation $navigation, navigation_node $node=null) { if (has_capability('moodle/grade:managegradingforms', $this->get_context())) { // no need for preview if user can manage forms, he will have link to manage.php in settings instead return; } if ($this->is_form_defined() && ($options = $this->get_options()) && !empty($options['alwaysshowdefinition'])) { $node->add(get_string('gradingof', 'gradingform_rubric', get_grading_manager($this->get_areaid())->get_area_title()), new moodle_url('/grade/grading/form/'.$this->get_method_name().'/preview.php', array('areaid' => $this->get_areaid())), settings_navigation::TYPE_CUSTOM); } } /** * Saves the rubric definition into the database * * @see parent::update_definition() * @param stdClass $newdefinition rubric definition data as coming from gradingform_rubric_editrubric::get_data() * @param int|null $usermodified optional userid of the author of the definition, defaults to the current user */ public function update_definition(stdClass $newdefinition, $usermodified = null) { $this->update_or_check_rubric($newdefinition, $usermodified, true); if (isset($newdefinition->rubric['regrade']) && $newdefinition->rubric['regrade']) { $this->mark_for_regrade(); } } /** * Either saves the rubric definition into the database or check if it has been changed. * Returns the level of changes: * 0 - no changes * 1 - only texts or criteria sortorders are changed, students probably do not require re-grading * 2 - added levels but maximum score on rubric is the same, students still may not require re-grading * 3 - removed criteria or added levels or changed number of points, students require re-grading but may be re-graded automatically * 4 - removed levels - students require re-grading and not all students may be re-graded automatically * 5 - added criteria - all students require manual re-grading * * @param stdClass $newdefinition rubric definition data as coming from gradingform_rubric_editrubric::get_data() * @param int|null $usermodified optional userid of the author of the definition, defaults to the current user * @param boolean $doupdate if true actually updates DB, otherwise performs a check * */ public function update_or_check_rubric(stdClass $newdefinition, $usermodified = null, $doupdate = false) { global $DB; // firstly update the common definition data in the {grading_definition} table if ($this->definition === false) { if (!$doupdate) { // if we create the new definition there is no such thing as re-grading anyway return 5; } // if definition does not exist yet, create a blank one // (we need id to save files embedded in description) parent::update_definition(new stdClass(), $usermodified); parent::load_definition(); } if (!isset($newdefinition->rubric['options'])) { $newdefinition->rubric['options'] = self::get_default_options(); } $newdefinition->options = json_encode($newdefinition->rubric['options']); $editoroptions = self::description_form_field_options($this->get_context()); $newdefinition = file_postupdate_standard_editor($newdefinition, 'description', $editoroptions, $this->get_context(), 'grading', 'description', $this->definition->id); // reload the definition from the database $currentdefinition = $this->get_definition(true); $haschanges = array(); // Check if 'lockzeropoints' option has changed. $newlockzeropoints = $newdefinition->rubric['options']['lockzeropoints']; $currentoptions = $this->get_options(); if ((bool)$newlockzeropoints != (bool)$currentoptions['lockzeropoints']) { $haschanges[3] = true; } // update rubric data if (empty($newdefinition->rubric['criteria'])) { $newcriteria = array(); } else { $newcriteria = $newdefinition->rubric['criteria']; // new ones to be saved } $currentcriteria = $currentdefinition->rubric_criteria; $criteriafields = array('sortorder', 'description', 'descriptionformat'); $levelfields = array('score', 'definition', 'definitionformat'); foreach ($newcriteria as $id => $criterion) { // get list of submitted levels $levelsdata = array(); if (array_key_exists('levels', $criterion)) { $levelsdata = $criterion['levels']; } $criterionmaxscore = null; if (preg_match('/^NEWID\d+$/', $id)) { // insert criterion into DB $data = array('definitionid' => $this->definition->id, 'descriptionformat' => FORMAT_MOODLE); // TODO MDL-31235 format is not supported yet foreach ($criteriafields as $key) { if (array_key_exists($key, $criterion)) { $data[$key] = $criterion[$key]; } } if ($doupdate) { $id = $DB->insert_record('gradingform_rubric_criteria', $data); } $haschanges[5] = true; } else { // update criterion in DB $data = array(); foreach ($criteriafields as $key) { if (array_key_exists($key, $criterion) && $criterion[$key] != $currentcriteria[$id][$key]) { $data[$key] = $criterion[$key]; } } if (!empty($data)) { // update only if something is changed $data['id'] = $id; if ($doupdate) { $DB->update_record('gradingform_rubric_criteria', $data); } $haschanges[1] = true; } // remove deleted levels from DB and calculate the maximum score for this criteria foreach ($currentcriteria[$id]['levels'] as $levelid => $currentlevel) { if ($criterionmaxscore === null || $criterionmaxscore < $currentlevel['score']) { $criterionmaxscore = $currentlevel['score']; } if (!array_key_exists($levelid, $levelsdata)) { if ($doupdate) { $DB->delete_records('gradingform_rubric_levels', array('id' => $levelid)); } $haschanges[4] = true; } } } foreach ($levelsdata as $levelid => $level) { if (isset($level['score'])) { $level['score'] = unformat_float($level['score']); } if (preg_match('/^NEWID\d+$/', $levelid)) { // insert level into DB $data = array('criterionid' => $id, 'definitionformat' => FORMAT_MOODLE); // TODO MDL-31235 format is not supported yet foreach ($levelfields as $key) { if (array_key_exists($key, $level)) { $data[$key] = $level[$key]; } } if ($doupdate) { $levelid = $DB->insert_record('gradingform_rubric_levels', $data); } if ($criterionmaxscore !== null && $criterionmaxscore >= $level['score']) { // new level is added but the maximum score for this criteria did not change, re-grading may not be necessary $haschanges[2] = true; } else { $haschanges[3] = true; } } else { // update level in DB $data = array(); foreach ($levelfields as $key) { if (array_key_exists($key, $level) && $level[$key] != $currentcriteria[$id]['levels'][$levelid][$key]) { $data[$key] = $level[$key]; } } if (!empty($data)) { // update only if something is changed $data['id'] = $levelid; if ($doupdate) { $DB->update_record('gradingform_rubric_levels', $data); } if (isset($data['score'])) { $haschanges[3] = true; } $haschanges[1] = true; } } } } // remove deleted criteria from DB foreach (array_keys($currentcriteria) as $id) { if (!array_key_exists($id, $newcriteria)) { if ($doupdate) { $DB->delete_records('gradingform_rubric_criteria', array('id' => $id)); $DB->delete_records('gradingform_rubric_levels', array('criterionid' => $id)); } $haschanges[3] = true; } } foreach (array('status', 'description', 'descriptionformat', 'name', 'options') as $key) { if (isset($newdefinition->$key) && $newdefinition->$key != $this->definition->$key) { $haschanges[1] = true; } } if ($usermodified && $usermodified != $this->definition->usermodified) { $haschanges[1] = true; } if (!count($haschanges)) { return 0; } if ($doupdate) { parent::update_definition($newdefinition, $usermodified); $this->load_definition(); } // return the maximum level of changes $changelevels = array_keys($haschanges); sort($changelevels); return array_pop($changelevels); } /** * Marks all instances filled with this rubric with the status INSTANCE_STATUS_NEEDUPDATE */ public function mark_for_regrade() { global $DB; if ($this->has_active_instances()) { $conditions = array('definitionid' => $this->definition->id, 'status' => gradingform_instance::INSTANCE_STATUS_ACTIVE); $DB->set_field('grading_instances', 'status', gradingform_instance::INSTANCE_STATUS_NEEDUPDATE, $conditions); } } /** * Loads the rubric form definition if it exists * * There is a new array called 'rubric_criteria' appended to the list of parent's definition properties. */ protected function load_definition() { global $DB; $sql = "SELECT gd.*, rc.id AS rcid, rc.sortorder AS rcsortorder, rc.description AS rcdescription, rc.descriptionformat AS rcdescriptionformat, rl.id AS rlid, rl.score AS rlscore, rl.definition AS rldefinition, rl.definitionformat AS rldefinitionformat FROM {grading_definitions} gd LEFT JOIN {gradingform_rubric_criteria} rc ON (rc.definitionid = gd.id) LEFT JOIN {gradingform_rubric_levels} rl ON (rl.criterionid = rc.id) WHERE gd.areaid = :areaid AND gd.method = :method ORDER BY rc.sortorder,rl.score"; $params = array('areaid' => $this->areaid, 'method' => $this->get_method_name()); $rs = $DB->get_recordset_sql($sql, $params); $this->definition = false; foreach ($rs as $record) { // pick the common definition data if ($this->definition === false) { $this->definition = new stdClass(); foreach (array('id', 'name', 'description', 'descriptionformat', 'status', 'copiedfromid', 'timecreated', 'usercreated', 'timemodified', 'usermodified', 'timecopied', 'options') as $fieldname) { $this->definition->$fieldname = $record->$fieldname; } $this->definition->rubric_criteria = array(); } // pick the criterion data if (!empty($record->rcid) and empty($this->definition->rubric_criteria[$record->rcid])) { foreach (array('id', 'sortorder', 'description', 'descriptionformat') as $fieldname) { $this->definition->rubric_criteria[$record->rcid][$fieldname] = $record->{'rc'.$fieldname}; } $this->definition->rubric_criteria[$record->rcid]['levels'] = array(); } // pick the level data if (!empty($record->rlid)) { foreach (array('id', 'score', 'definition', 'definitionformat') as $fieldname) { $value = $record->{'rl'.$fieldname}; if ($fieldname == 'score') { $value = (float)$value; // To prevent display like 1.00000 } $this->definition->rubric_criteria[$record->rcid]['levels'][$record->rlid][$fieldname] = $value; } } } $rs->close(); $options = $this->get_options(); if (!$options['sortlevelsasc']) { foreach (array_keys($this->definition->rubric_criteria) as $rcid) { $this->definition->rubric_criteria[$rcid]['levels'] = array_reverse($this->definition->rubric_criteria[$rcid]['levels'], true); } } } /** * Returns the default options for the rubric display * * @return array */ public static function get_default_options() { $options = array( 'sortlevelsasc' => 1, 'lockzeropoints' => 1, 'alwaysshowdefinition' => 1, 'showdescriptionteacher' => 1, 'showdescriptionstudent' => 1, 'showscoreteacher' => 1, 'showscorestudent' => 1, 'enableremarks' => 1, 'showremarksstudent' => 1 ); return $options; } /** * Gets the options of this rubric definition, fills the missing options with default values * * The only exception is 'lockzeropoints' - if other options are present in the json string but this * one is absent, this means that the rubric was created before Moodle 3.2 and the 0 value should be used. * * @return array */ public function get_options() { $options = self::get_default_options(); if (!empty($this->definition->options)) { $thisoptions = json_decode($this->definition->options, true); // Assoc. array is expected. foreach ($thisoptions as $option => $value) { $options[$option] = $value; } if (!array_key_exists('lockzeropoints', $thisoptions)) { // Rubrics created before Moodle 3.2 don't have 'lockzeropoints' option. In this case they should not // assume default value 1 but use "legacy" value 0. $options['lockzeropoints'] = 0; } } return $options; } /** * Converts the current definition into an object suitable for the editor form's set_data() * * @param boolean $addemptycriterion whether to add an empty criterion if the rubric is completely empty (just being created) * @return stdClass */ public function get_definition_for_editing($addemptycriterion = false) { $definition = $this->get_definition(); $properties = new stdClass(); $properties->areaid = $this->areaid; if ($definition) { foreach (array('id', 'name', 'description', 'descriptionformat', 'status') as $key) { $properties->$key = $definition->$key; } $options = self::description_form_field_options($this->get_context()); $properties = file_prepare_standard_editor($properties, 'description', $options, $this->get_context(), 'grading', 'description', $definition->id); } $properties->rubric = array('criteria' => array(), 'options' => $this->get_options()); if (!empty($definition->rubric_criteria)) { $properties->rubric['criteria'] = $definition->rubric_criteria; } else if (!$definition && $addemptycriterion) { $properties->rubric['criteria'] = array('addcriterion' => 1); } return $properties; } /** * Returns the form definition suitable for cloning into another area * * @see parent::get_definition_copy() * @param gradingform_controller $target the controller of the new copy * @return stdClass definition structure to pass to the target's {@link update_definition()} */ public function get_definition_copy(gradingform_controller $target) { $new = parent::get_definition_copy($target); $old = $this->get_definition_for_editing(); $new->description_editor = $old->description_editor; $new->rubric = array('criteria' => array(), 'options' => $old->rubric['options']); $newcritid = 1; $newlevid = 1; foreach ($old->rubric['criteria'] as $oldcritid => $oldcrit) { unset($oldcrit['id']); if (isset($oldcrit['levels'])) { foreach ($oldcrit['levels'] as $oldlevid => $oldlev) { unset($oldlev['id']); $oldcrit['levels']['NEWID'.$newlevid] = $oldlev; unset($oldcrit['levels'][$oldlevid]); $newlevid++; } } else { $oldcrit['levels'] = array(); } $new->rubric['criteria']['NEWID'.$newcritid] = $oldcrit; $newcritid++; } return $new; } /** * Options for displaying the rubric description field in the form * * @param object $context * @return array options for the form description field */ public static function description_form_field_options($context) { global $CFG; return array( 'maxfiles' => -1, 'maxbytes' => get_user_max_upload_file_size($context, $CFG->maxbytes), 'context' => $context, ); } /** * Formats the definition description for display on page * * @return string */ public function get_formatted_description() { if (!isset($this->definition->description)) { return ''; } $context = $this->get_context(); $options = self::description_form_field_options($this->get_context()); $description = file_rewrite_pluginfile_urls($this->definition->description, 'pluginfile.php', $context->id, 'grading', 'description', $this->definition->id, $options); $formatoptions = array( 'noclean' => false, 'trusted' => false, 'filter' => true, 'context' => $context ); return format_text($description, $this->definition->descriptionformat, $formatoptions); } /** * Returns the rubric plugin renderer * * @param moodle_page $page the target page * @return gradingform_rubric_renderer */ public function get_renderer(moodle_page $page) { return $page->get_renderer('gradingform_'. $this->get_method_name()); } /** * Returns the HTML code displaying the preview of the grading form * * @param moodle_page $page the target page * @return string */ public function render_preview(moodle_page $page) { if (!$this->is_form_defined()) { throw new coding_exception('It is the caller\'s responsibility to make sure that the form is actually defined'); } $criteria = $this->definition->rubric_criteria; $options = $this->get_options(); $rubric = ''; if (has_capability('moodle/grade:managegradingforms', $page->context)) { $showdescription = true; } else { if (empty($options['alwaysshowdefinition'])) { // ensure we don't display unless show rubric option enabled return ''; } $showdescription = $options['showdescriptionstudent']; } $output = $this->get_renderer($page); if ($showdescription) { $rubric .= $output->box($this->get_formatted_description(), 'gradingform_rubric-description'); } if (has_capability('moodle/grade:managegradingforms', $page->context)) { if (!$options['lockzeropoints']) { // Warn about using grade calculation method where minimum number of points is flexible. $rubric .= $output->display_rubric_mapping_explained($this->get_min_max_score()); } $rubric .= $output->display_rubric($criteria, $options, self::DISPLAY_PREVIEW, 'rubric'); } else { $rubric .= $output->display_rubric($criteria, $options, self::DISPLAY_PREVIEW_GRADED, 'rubric'); } return $rubric; } /** * Deletes the rubric definition and all the associated information */ protected function delete_plugin_definition() { global $DB; // get the list of instances $instances = array_keys($DB->get_records('grading_instances', array('definitionid' => $this->definition->id), '', 'id')); // delete all fillings $DB->delete_records_list('gradingform_rubric_fillings', 'instanceid', $instances); // delete instances $DB->delete_records_list('grading_instances', 'id', $instances); // get the list of criteria records $criteria = array_keys($DB->get_records('gradingform_rubric_criteria', array('definitionid' => $this->definition->id), '', 'id')); // delete levels $DB->delete_records_list('gradingform_rubric_levels', 'criterionid', $criteria); // delete critera $DB->delete_records_list('gradingform_rubric_criteria', 'id', $criteria); } /** * If instanceid is specified and grading instance exists and it is created by this rater for * this item, this instance is returned. * If there exists a draft for this raterid+itemid, take this draft (this is the change from parent) * Otherwise new instance is created for the specified rater and itemid * * @param int $instanceid * @param int $raterid * @param int $itemid * @return gradingform_instance */ public function get_or_create_instance($instanceid, $raterid, $itemid) { global $DB; if ($instanceid && $instance = $DB->get_record('grading_instances', array('id' => $instanceid, 'raterid' => $raterid, 'itemid' => $itemid), '*', IGNORE_MISSING)) { return $this->get_instance($instance); } if ($itemid && $raterid) { $params = array('definitionid' => $this->definition->id, 'raterid' => $raterid, 'itemid' => $itemid); if ($rs = $DB->get_records('grading_instances', $params, 'timemodified DESC', '*', 0, 1)) { $record = reset($rs); $currentinstance = $this->get_current_instance($raterid, $itemid); if ($record->status == gradingform_rubric_instance::INSTANCE_STATUS_INCOMPLETE && (!$currentinstance || $record->timemodified > $currentinstance->get_data('timemodified'))) { $record->isrestored = true; return $this->get_instance($record); } } } return $this->create_instance($raterid, $itemid); } /** * Returns html code to be included in student's feedback. * * @param moodle_page $page * @param int $itemid * @param array $gradinginfo result of function grade_get_grades * @param string $defaultcontent default string to be returned if no active grading is found * @param boolean $cangrade whether current user has capability to grade in this context * @return string */ public function render_grade($page, $itemid, $gradinginfo, $defaultcontent, $cangrade) { return $this->get_renderer($page)->display_instances($this->get_active_instances($itemid), $defaultcontent, $cangrade); } // ///// full-text search support ///////////////////////////////////////////// /** * Prepare the part of the search query to append to the FROM statement * * @param string $gdid the alias of grading_definitions.id column used by the caller * @return string */ public static function sql_search_from_tables($gdid) { return " LEFT JOIN {gradingform_rubric_criteria} rc ON (rc.definitionid = $gdid) LEFT JOIN {gradingform_rubric_levels} rl ON (rl.criterionid = rc.id)"; } /** * Prepare the parts of the SQL WHERE statement to search for the given token * * The returned array cosists of the list of SQL comparions and the list of * respective parameters for the comparisons. The returned chunks will be joined * with other conditions using the OR operator. * * @param string $token token to search for * @return array */ public static function sql_search_where($token) { global $DB; $subsql = array(); $params = array(); // search in rubric criteria description $subsql[] = $DB->sql_like('rc.description', '?', false, false); $params[] = '%'.$DB->sql_like_escape($token).'%'; // search in rubric levels definition $subsql[] = $DB->sql_like('rl.definition', '?', false, false); $params[] = '%'.$DB->sql_like_escape($token).'%'; return array($subsql, $params); } /** * Calculates and returns the possible minimum and maximum score (in points) for this rubric * * @return array */ public function get_min_max_score() { if (!$this->is_form_available()) { return null; } $returnvalue = array('minscore' => 0, 'maxscore' => 0); foreach ($this->get_definition()->rubric_criteria as $id => $criterion) { $scores = array(); foreach ($criterion['levels'] as $level) { $scores[] = $level['score']; } sort($scores); $returnvalue['minscore'] += $scores[0]; $returnvalue['maxscore'] += $scores[sizeof($scores)-1]; } return $returnvalue; } /** * @return array An array containing a single key/value pair with the 'rubric_criteria' external_multiple_structure. * @see gradingform_controller::get_external_definition_details() * @since Moodle 2.5 */ public static function get_external_definition_details() { $rubric_criteria = new external_multiple_structure( new external_single_structure( array( 'id' => new external_value(PARAM_INT, 'criterion id', VALUE_OPTIONAL), 'sortorder' => new external_value(PARAM_INT, 'sortorder', VALUE_OPTIONAL), 'description' => new external_value(PARAM_RAW, 'description', VALUE_OPTIONAL), 'descriptionformat' => new external_format_value('description', VALUE_OPTIONAL), 'levels' => new external_multiple_structure( new external_single_structure( array( 'id' => new external_value(PARAM_INT, 'level id', VALUE_OPTIONAL), 'score' => new external_value(PARAM_FLOAT, 'score', VALUE_OPTIONAL), 'definition' => new external_value(PARAM_RAW, 'definition', VALUE_OPTIONAL), 'definitionformat' => new external_format_value('definition', VALUE_OPTIONAL) ) ), 'levels', VALUE_OPTIONAL ) ) ), 'definition details', VALUE_OPTIONAL ); return array('rubric_criteria' => $rubric_criteria); } /** * Returns an array that defines the structure of the rubric's filling. This function is used by * the web service function core_grading_external::get_gradingform_instances(). * * @return An array containing a single key/value pair with the 'criteria' external_multiple_structure * @see gradingform_controller::get_external_instance_filling_details() * @since Moodle 2.6 */ public static function get_external_instance_filling_details() { $criteria = new external_multiple_structure( new external_single_structure( array( 'id' => new external_value(PARAM_INT, 'filling id'), 'criterionid' => new external_value(PARAM_INT, 'criterion id'), 'levelid' => new external_value(PARAM_INT, 'level id', VALUE_OPTIONAL), 'remark' => new external_value(PARAM_RAW, 'remark', VALUE_OPTIONAL), 'remarkformat' => new external_format_value('remark', VALUE_OPTIONAL) ) ), 'filling', VALUE_OPTIONAL ); return array ('criteria' => $criteria); } } /** * Class to manage one rubric grading instance. * * Stores information and performs actions like update, copy, validate, submit, etc. * * @package gradingform_rubric * @copyright 2011 Marina Glancy * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class gradingform_rubric_instance extends gradingform_instance { /** @var array stores the rubric, has two keys: 'criteria' and 'options' */ protected $rubric; /** * Deletes this (INCOMPLETE) instance from database. */ public function cancel() { global $DB; parent::cancel(); $DB->delete_records('gradingform_rubric_fillings', array('instanceid' => $this->get_id())); } /** * Duplicates the instance before editing (optionally substitutes raterid and/or itemid with * the specified values) * * @param int $raterid value for raterid in the duplicate * @param int $itemid value for itemid in the duplicate * @return int id of the new instance */ public function copy($raterid, $itemid) { global $DB; $instanceid = parent::copy($raterid, $itemid); $currentgrade = $this->get_rubric_filling(); foreach ($currentgrade['criteria'] as $criterionid => $record) { $params = array('instanceid' => $instanceid, 'criterionid' => $criterionid, 'levelid' => $record['levelid'], 'remark' => $record['remark'], 'remarkformat' => $record['remarkformat']); $DB->insert_record('gradingform_rubric_fillings', $params); } return $instanceid; } /** * Determines whether the submitted form was empty. * * @param array $elementvalue value of element submitted from the form * @return boolean true if the form is empty */ public function is_empty_form($elementvalue) { $criteria = $this->get_controller()->get_definition()->rubric_criteria; foreach ($criteria as $id => $criterion) { if (isset($elementvalue['criteria'][$id]['levelid']) || !empty($elementvalue['criteria'][$id]['remark'])) { return false; } } return true; } /** * Removes the attempt from the gradingform_guide_fillings table * @param array $data the attempt data */ public function clear_attempt($data) { global $DB; foreach ($data['criteria'] as $criterionid => $record) { $DB->delete_records('gradingform_rubric_fillings', array('criterionid' => $criterionid, 'instanceid' => $this->get_id())); } } /** * Validates that rubric is fully completed and contains valid grade on each criterion * * @param array $elementvalue value of element as came in form submit * @return boolean true if the form data is validated and contains no errors */ public function validate_grading_element($elementvalue) { $criteria = $this->get_controller()->get_definition()->rubric_criteria; if (!isset($elementvalue['criteria']) || !is_array($elementvalue['criteria']) || sizeof($elementvalue['criteria']) < sizeof($criteria)) { return false; } foreach ($criteria as $id => $criterion) { if (!isset($elementvalue['criteria'][$id]['levelid']) || !array_key_exists($elementvalue['criteria'][$id]['levelid'], $criterion['levels'])) { return false; } } return true; } /** * Retrieves from DB and returns the data how this rubric was filled * * @param boolean $force whether to force DB query even if the data is cached * @return array */ public function get_rubric_filling($force = false) { global $DB; if ($this->rubric === null || $force) { $records = $DB->get_records('gradingform_rubric_fillings', array('instanceid' => $this->get_id())); $this->rubric = array('criteria' => array()); foreach ($records as $record) { $this->rubric['criteria'][$record->criterionid] = (array)$record; } } return $this->rubric; } /** * Updates the instance with the data received from grading form. This function may be * called via AJAX when grading is not yet completed, so it does not change the * status of the instance. * * @param array $data */ public function update($data) { global $DB; $currentgrade = $this->get_rubric_filling(); parent::update($data); foreach ($data['criteria'] as $criterionid => $record) { if (!array_key_exists($criterionid, $currentgrade['criteria'])) { $newrecord = array('instanceid' => $this->get_id(), 'criterionid' => $criterionid, 'levelid' => $record['levelid'], 'remarkformat' => FORMAT_MOODLE); if (isset($record['remark'])) { $newrecord['remark'] = $record['remark']; } $DB->insert_record('gradingform_rubric_fillings', $newrecord); } else { $newrecord = array('id' => $currentgrade['criteria'][$criterionid]['id']); foreach (array('levelid', 'remark'/*, 'remarkformat' */) as $key) { // TODO MDL-31235 format is not supported yet if (isset($record[$key]) && $currentgrade['criteria'][$criterionid][$key] != $record[$key]) { $newrecord[$key] = $record[$key]; } } if (count($newrecord) > 1) { $DB->update_record('gradingform_rubric_fillings', $newrecord); } } } foreach ($currentgrade['criteria'] as $criterionid => $record) { if (!array_key_exists($criterionid, $data['criteria'])) { $DB->delete_records('gradingform_rubric_fillings', array('id' => $record['id'])); } } $this->get_rubric_filling(true); } /** * Calculates the grade to be pushed to the gradebook * * @return float|int the valid grade from $this->get_controller()->get_grade_range() */ public function get_grade() { $grade = $this->get_rubric_filling(); if (!($scores = $this->get_controller()->get_min_max_score()) || $scores['maxscore'] <= $scores['minscore']) { return -1; } $graderange = array_keys($this->get_controller()->get_grade_range()); if (empty($graderange)) { return -1; } sort($graderange); $mingrade = $graderange[0]; $maxgrade = $graderange[sizeof($graderange) - 1]; $curscore = 0; foreach ($grade['criteria'] as $id => $record) { $curscore += $this->get_controller()->get_definition()->rubric_criteria[$id]['levels'][$record['levelid']]['score']; } $allowdecimals = $this->get_controller()->get_allow_grade_decimals(); $options = $this->get_controller()->get_options(); if ($options['lockzeropoints']) { // Grade calculation method when 0-level is locked. $grade = max($mingrade, $curscore / $scores['maxscore'] * $maxgrade); return $allowdecimals ? $grade : round($grade, 0); } else { // Alternative grade calculation method. $gradeoffset = ($curscore - $scores['minscore']) / ($scores['maxscore'] - $scores['minscore']) * ($maxgrade - $mingrade); return ($allowdecimals ? $gradeoffset : round($gradeoffset, 0)) + $mingrade; } } /** * Returns html for form element of type 'grading'. * * @param moodle_page $page * @param MoodleQuickForm_grading $gradingformelement * @return string */ public function render_grading_element($page, $gradingformelement) { global $USER; if (!$gradingformelement->_flagFrozen) { $module = array('name'=>'gradingform_rubric', 'fullpath'=>'/grade/grading/form/rubric/js/rubric.js'); $page->requires->js_init_call('M.gradingform_rubric.init', array(array('name' => $gradingformelement->getName())), true, $module); $mode = gradingform_rubric_controller::DISPLAY_EVAL; } else { if ($gradingformelement->_persistantFreeze) { $mode = gradingform_rubric_controller::DISPLAY_EVAL_FROZEN; } else { $mode = gradingform_rubric_controller::DISPLAY_REVIEW; } } $criteria = $this->get_controller()->get_definition()->rubric_criteria; $options = $this->get_controller()->get_options(); $value = $gradingformelement->getValue(); $html = ''; if ($value === null) { $value = $this->get_rubric_filling(); } else if (!$this->validate_grading_element($value)) { $html .= html_writer::tag('div', get_string('rubricnotcompleted', 'gradingform_rubric'), array('class' => 'gradingform_rubric-error')); } $currentinstance = $this->get_current_instance(); if ($currentinstance && $currentinstance->get_status() == gradingform_instance::INSTANCE_STATUS_NEEDUPDATE) { $html .= html_writer::div(get_string('needregrademessage', 'gradingform_rubric'), 'gradingform_rubric-regrade', array('role' => 'alert')); } $haschanges = false; if ($currentinstance) { $curfilling = $currentinstance->get_rubric_filling(); foreach ($curfilling['criteria'] as $criterionid => $curvalues) { $value['criteria'][$criterionid]['savedlevelid'] = $curvalues['levelid']; $newremark = null; $newlevelid = null; if (isset($value['criteria'][$criterionid]['remark'])) $newremark = $value['criteria'][$criterionid]['remark']; if (isset($value['criteria'][$criterionid]['levelid'])) $newlevelid = $value['criteria'][$criterionid]['levelid']; if ($newlevelid != $curvalues['levelid'] || $newremark != $curvalues['remark']) { $haschanges = true; } } } if ($this->get_data('isrestored') && $haschanges) { $html .= html_writer::tag('div', get_string('restoredfromdraft', 'gradingform_rubric'), array('class' => 'gradingform_rubric-restored')); } if (!empty($options['showdescriptionteacher'])) { $html .= html_writer::tag('div', $this->get_controller()->get_formatted_description(), array('class' => 'gradingform_rubric-description')); } $html .= $this->get_controller()->get_renderer($page)->display_rubric($criteria, $options, $mode, $gradingformelement->getName(), $value); return $html; } } grading/form/rubric/renderer.php 0000604 00000104365 15062070555 0012741 0 ustar 00 <?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/>. /** * Contains renderer used for displaying rubric * * @package gradingform_rubric * @copyright 2011 Marina Glancy * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); /** * Grading method plugin renderer * * @package gradingform_rubric * @copyright 2011 Marina Glancy * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class gradingform_rubric_renderer extends plugin_renderer_base { /** * This function returns html code for displaying criterion. Depending on $mode it may be the * code to edit rubric, to preview the rubric, to evaluate somebody or to review the evaluation. * * This function may be called from display_rubric() to display the whole rubric, or it can be * called by itself to return a template used by JavaScript to add new empty criteria to the * rubric being designed. * In this case it will use macros like {NAME}, {LEVELS}, {CRITERION-id}, etc. * * When overriding this function it is very important to remember that all elements of html * form (in edit or evaluate mode) must have the name $elementname. * * Also JavaScript relies on the class names of elements and when developer changes them * script might stop working. * * @param int $mode rubric display mode, see {@link gradingform_rubric_controller} * @param array $options display options for this rubric, defaults are: {@link gradingform_rubric_controller::get_default_options()} * @param string $elementname the name of the form element (in editor mode) or the prefix for div ids (in view mode) * @param array|null $criterion criterion data * @param string $levelsstr evaluated templates for this criterion levels * @param array|null $value (only in view mode) teacher's feedback on this criterion * @return string */ public function criterion_template($mode, $options, $elementname = '{NAME}', $criterion = null, $levelsstr = '{LEVELS}', $value = null) { // TODO MDL-31235 description format, remark format if ($criterion === null || !is_array($criterion) || !array_key_exists('id', $criterion)) { $criterion = array('id' => '{CRITERION-id}', 'description' => '{CRITERION-description}', 'sortorder' => '{CRITERION-sortorder}', 'class' => '{CRITERION-class}'); } else { foreach (array('sortorder', 'description', 'class') as $key) { // set missing array elements to empty strings to avoid warnings if (!array_key_exists($key, $criterion)) { $criterion[$key] = ''; } } } $criteriontemplate = html_writer::start_tag('tr', array('class' => 'criterion'. $criterion['class'], 'id' => '{NAME}-criteria-{CRITERION-id}')); if ($mode == gradingform_rubric_controller::DISPLAY_EDIT_FULL) { $criteriontemplate .= html_writer::start_tag('td', array('class' => 'controls')); foreach (array('moveup', 'delete', 'movedown', 'duplicate') as $key) { $value = get_string('criterion'.$key, 'gradingform_rubric'); $button = html_writer::empty_tag('input', array('type' => 'submit', 'name' => '{NAME}[criteria][{CRITERION-id}]['.$key.']', 'id' => '{NAME}-criteria-{CRITERION-id}-'.$key, 'value' => $value)); $criteriontemplate .= html_writer::tag('div', $button, array('class' => $key)); } $criteriontemplate .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => '{NAME}[criteria][{CRITERION-id}][sortorder]', 'value' => $criterion['sortorder'])); $criteriontemplate .= html_writer::end_tag('td'); // .controls // Criterion description text area. $descriptiontextareaparams = array( 'name' => '{NAME}[criteria][{CRITERION-id}][description]', 'id' => '{NAME}-criteria-{CRITERION-id}-description', 'aria-label' => get_string('criterion', 'gradingform_rubric', ''), 'cols' => '10', 'rows' => '5' ); $description = html_writer::tag('textarea', s($criterion['description']), $descriptiontextareaparams); } else { if ($mode == gradingform_rubric_controller::DISPLAY_EDIT_FROZEN) { $criteriontemplate .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => '{NAME}[criteria][{CRITERION-id}][sortorder]', 'value' => $criterion['sortorder'])); $criteriontemplate .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => '{NAME}[criteria][{CRITERION-id}][description]', 'value' => $criterion['description'])); } $description = s($criterion['description']); } $descriptionclass = 'description'; if (isset($criterion['error_description'])) { $descriptionclass .= ' error'; } // Description cell params. $descriptiontdparams = array( 'class' => $descriptionclass, 'id' => '{NAME}-criteria-{CRITERION-id}-description-cell' ); if ($mode != gradingform_rubric_controller::DISPLAY_EDIT_FULL && $mode != gradingform_rubric_controller::DISPLAY_EDIT_FROZEN) { // Set description's cell as tab-focusable. $descriptiontdparams['tabindex'] = '0'; // Set label for the criterion cell. $descriptiontdparams['aria-label'] = get_string('criterion', 'gradingform_rubric', s($criterion['description'])); } // Description cell. $criteriontemplate .= html_writer::tag('td', $description, $descriptiontdparams); // Levels table. $levelsrowparams = [ 'id' => '{NAME}-criteria-{CRITERION-id}-levels', 'aria-label' => get_string('levelsgroup', 'gradingform_rubric'), ]; // Add radiogroup role only when not previewing or editing. $isradiogroup = !in_array($mode, [ gradingform_rubric_controller::DISPLAY_EDIT_FULL, gradingform_rubric_controller::DISPLAY_EDIT_FROZEN, gradingform_rubric_controller::DISPLAY_PREVIEW, gradingform_rubric_controller::DISPLAY_PREVIEW_GRADED, ]); $levelsrowparams['role'] = $isradiogroup ? 'radiogroup' : 'list'; $levelsrow = html_writer::tag('tr', $levelsstr, $levelsrowparams); $levelstableparams = [ 'id' => '{NAME}-criteria-{CRITERION-id}-levels-table', 'role' => 'none', ]; $levelsstrtable = html_writer::tag('table', $levelsrow, $levelstableparams); $levelsclass = 'levels'; if (isset($criterion['error_levels'])) { $levelsclass .= ' error'; } $criteriontemplate .= html_writer::tag('td', $levelsstrtable, array('class' => $levelsclass)); if ($mode == gradingform_rubric_controller::DISPLAY_EDIT_FULL) { $value = get_string('criterionaddlevel', 'gradingform_rubric'); $button = html_writer::empty_tag('input', array('type' => 'submit', 'name' => '{NAME}[criteria][{CRITERION-id}][levels][addlevel]', 'id' => '{NAME}-criteria-{CRITERION-id}-levels-addlevel', 'value' => $value, 'class' => 'btn btn-secondary')); $criteriontemplate .= html_writer::tag('td', $button, array('class' => 'addlevel')); } $displayremark = ($options['enableremarks'] && ($mode != gradingform_rubric_controller::DISPLAY_VIEW || $options['showremarksstudent'])); if ($displayremark) { $currentremark = ''; if (isset($value['remark'])) { $currentremark = $value['remark']; } // Label for criterion remark. $remarkinfo = new stdClass(); $remarkinfo->description = s($criterion['description']); $remarkinfo->remark = $currentremark; $remarklabeltext = get_string('criterionremark', 'gradingform_rubric', $remarkinfo); if ($mode == gradingform_rubric_controller::DISPLAY_EVAL) { // HTML parameters for remarks text area. $remarkparams = array( 'name' => '{NAME}[criteria][{CRITERION-id}][remark]', 'id' => '{NAME}-criteria-{CRITERION-id}-remark', 'cols' => '10', 'rows' => '5', 'aria-label' => $remarklabeltext ); $input = html_writer::tag('textarea', s($currentremark), $remarkparams); $criteriontemplate .= html_writer::tag('td', $input, array('class' => 'remark')); } else if ($mode == gradingform_rubric_controller::DISPLAY_EVAL_FROZEN) { $criteriontemplate .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => '{NAME}[criteria][{CRITERION-id}][remark]', 'value' => $currentremark)); }else if ($mode == gradingform_rubric_controller::DISPLAY_REVIEW || $mode == gradingform_rubric_controller::DISPLAY_VIEW) { // HTML parameters for remarks cell. $remarkparams = array( 'class' => 'remark', 'tabindex' => '0', 'id' => '{NAME}-criteria-{CRITERION-id}-remark', 'aria-label' => $remarklabeltext ); $criteriontemplate .= html_writer::tag('td', s($currentremark), $remarkparams); } } $criteriontemplate .= html_writer::end_tag('tr'); // .criterion $criteriontemplate = str_replace('{NAME}', $elementname, $criteriontemplate); $criteriontemplate = str_replace('{CRITERION-id}', $criterion['id'], $criteriontemplate); return $criteriontemplate; } /** * This function returns html code for displaying one level of one criterion. Depending on $mode * it may be the code to edit rubric, to preview the rubric, to evaluate somebody or to review the evaluation. * * This function may be called from display_rubric() to display the whole rubric, or it can be * called by itself to return a template used by JavaScript to add new empty level to the * criterion during the design of rubric. * In this case it will use macros like {NAME}, {CRITERION-id}, {LEVEL-id}, etc. * * When overriding this function it is very important to remember that all elements of html * form (in edit or evaluate mode) must have the name $elementname. * * Also JavaScript relies on the class names of elements and when developer changes them * script might stop working. * * @param int $mode rubric display mode see {@link gradingform_rubric_controller} * @param array $options display options for this rubric, defaults are: {@link gradingform_rubric_controller::get_default_options()} * @param string $elementname the name of the form element (in editor mode) or the prefix for div ids (in view mode) * @param string|int $criterionid either id of the nesting criterion or a macro for template * @param array|null $level level data, also in view mode it might also have property $level['checked'] whether this level is checked * @return string */ public function level_template($mode, $options, $elementname = '{NAME}', $criterionid = '{CRITERION-id}', $level = null) { // TODO MDL-31235 definition format if (!isset($level['id'])) { $level = array('id' => '{LEVEL-id}', 'definition' => '{LEVEL-definition}', 'score' => '{LEVEL-score}', 'class' => '{LEVEL-class}', 'checked' => false); } else { foreach (array('score', 'definition', 'class', 'checked', 'index') as $key) { // set missing array elements to empty strings to avoid warnings if (!array_key_exists($key, $level)) { $level[$key] = ''; } } } // Get level index. $levelindex = isset($level['index']) ? $level['index'] : '{LEVEL-index}'; // Template for one level within one criterion $tdattributes = array( 'id' => '{NAME}-criteria-{CRITERION-id}-levels-{LEVEL-id}', 'class' => 'text-break level' . $level['class'] ); if (isset($level['tdwidth'])) { $tdattributes['style'] = "width: " . round($level['tdwidth']).'%;'; } $leveltemplate = html_writer::start_tag('div', array('class' => 'level-wrapper')); if ($mode == gradingform_rubric_controller::DISPLAY_EDIT_FULL) { $definitionparams = array( 'id' => '{NAME}-criteria-{CRITERION-id}-levels-{LEVEL-id}-definition', 'name' => '{NAME}[criteria][{CRITERION-id}][levels][{LEVEL-id}][definition]', 'aria-label' => get_string('leveldefinition', 'gradingform_rubric', $levelindex), 'cols' => '10', 'rows' => '4' ); $definition = html_writer::tag('textarea', s($level['definition']), $definitionparams); $scoreparams = array( 'type' => 'text', 'id' => '{NAME}[criteria][{CRITERION-id}][levels][{LEVEL-id}][score]', 'name' => '{NAME}[criteria][{CRITERION-id}][levels][{LEVEL-id}][score]', 'aria-label' => get_string('scoreinputforlevel', 'gradingform_rubric', $levelindex), 'size' => '3', 'value' => $level['score'] ); $score = html_writer::empty_tag('input', $scoreparams); } else { if ($mode == gradingform_rubric_controller::DISPLAY_EDIT_FROZEN) { $leveltemplate .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => '{NAME}[criteria][{CRITERION-id}][levels][{LEVEL-id}][definition]', 'value' => $level['definition'])); $leveltemplate .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => '{NAME}[criteria][{CRITERION-id}][levels][{LEVEL-id}][score]', 'value' => $level['score'])); } $definition = s($level['definition']); $score = $level['score']; } if ($mode == gradingform_rubric_controller::DISPLAY_EVAL) { $levelradioparams = array( 'type' => 'radio', 'id' => '{NAME}-criteria-{CRITERION-id}-levels-{LEVEL-id}-definition', 'name' => '{NAME}[criteria][{CRITERION-id}][levelid]', 'value' => $level['id'] ); if ($level['checked']) { $levelradioparams['checked'] = 'checked'; } $input = html_writer::empty_tag('input', $levelradioparams); $leveltemplate .= html_writer::div($input, 'radio'); } if ($mode == gradingform_rubric_controller::DISPLAY_EVAL_FROZEN && $level['checked']) { $leveltemplate .= html_writer::empty_tag('input', array( 'type' => 'hidden', 'name' => '{NAME}[criteria][{CRITERION-id}][levelid]', 'value' => $level['id'] ) ); } $score = html_writer::tag('span', $score, array('id' => '{NAME}-criteria-{CRITERION-id}-levels-{LEVEL-id}-score', 'class' => 'scorevalue')); $definitionclass = 'definition'; if (isset($level['error_definition'])) { $definitionclass .= ' error'; } if ($mode != gradingform_rubric_controller::DISPLAY_EDIT_FULL && $mode != gradingform_rubric_controller::DISPLAY_EDIT_FROZEN) { $tdattributes['tabindex'] = '0'; $levelinfo = new stdClass(); $levelinfo->definition = s($level['definition']); $levelinfo->score = $level['score']; $tdattributes['aria-label'] = get_string('level', 'gradingform_rubric', $levelinfo); if ($mode != gradingform_rubric_controller::DISPLAY_PREVIEW && $mode != gradingform_rubric_controller::DISPLAY_PREVIEW_GRADED) { // Add role of radio button to level cell if not in edit and preview mode. $tdattributes['role'] = 'radio'; if ($level['checked']) { $tdattributes['aria-checked'] = 'true'; } else { $tdattributes['aria-checked'] = 'false'; } } else { $tdattributes['role'] = 'listitem'; } } else { $tdattributes['role'] = 'listitem'; } $leveltemplateparams = array( 'id' => '{NAME}-criteria-{CRITERION-id}-levels-{LEVEL-id}-definition-container' ); $leveltemplate .= html_writer::div($definition, $definitionclass, $leveltemplateparams); $displayscore = true; if (!$options['showscoreteacher'] && in_array($mode, array(gradingform_rubric_controller::DISPLAY_EVAL, gradingform_rubric_controller::DISPLAY_EVAL_FROZEN, gradingform_rubric_controller::DISPLAY_REVIEW))) { $displayscore = false; } if (!$options['showscorestudent'] && in_array($mode, array(gradingform_rubric_controller::DISPLAY_VIEW, gradingform_rubric_controller::DISPLAY_PREVIEW_GRADED))) { $displayscore = false; } if ($displayscore) { $scoreclass = 'score d-inline'; if (isset($level['error_score'])) { $scoreclass .= ' error'; } $leveltemplate .= html_writer::tag('div', get_string('scorepostfix', 'gradingform_rubric', $score), array('class' => $scoreclass)); } if ($mode == gradingform_rubric_controller::DISPLAY_EDIT_FULL) { $value = get_string('leveldelete', 'gradingform_rubric', $levelindex); $buttonparams = array( 'type' => 'submit', 'name' => '{NAME}[criteria][{CRITERION-id}][levels][{LEVEL-id}][delete]', 'id' => '{NAME}-criteria-{CRITERION-id}-levels-{LEVEL-id}-delete', 'value' => $value ); $button = html_writer::empty_tag('input', $buttonparams); $leveltemplate .= html_writer::tag('div', $button, array('class' => 'delete')); } $leveltemplate .= html_writer::end_tag('div'); // .level-wrapper $leveltemplate = html_writer::tag('td', $leveltemplate, $tdattributes); // The .level cell. $leveltemplate = str_replace('{NAME}', $elementname, $leveltemplate); $leveltemplate = str_replace('{CRITERION-id}', $criterionid, $leveltemplate); $leveltemplate = str_replace('{LEVEL-id}', $level['id'], $leveltemplate); return $leveltemplate; } /** * This function returns html code for displaying rubric template (content before and after * criteria list). Depending on $mode it may be the code to edit rubric, to preview the rubric, * to evaluate somebody or to review the evaluation. * * This function is called from display_rubric() to display the whole rubric. * * When overriding this function it is very important to remember that all elements of html * form (in edit or evaluate mode) must have the name $elementname. * * Also JavaScript relies on the class names of elements and when developer changes them * script might stop working. * * @param int $mode rubric display mode see {@link gradingform_rubric_controller} * @param array $options display options for this rubric, defaults are: {@link gradingform_rubric_controller::get_default_options()} * @param string $elementname the name of the form element (in editor mode) or the prefix for div ids (in view mode) * @param string $criteriastr evaluated templates for this rubric's criteria * @return string */ protected function rubric_template($mode, $options, $elementname, $criteriastr) { $classsuffix = ''; // CSS suffix for class of the main div. Depends on the mode switch ($mode) { case gradingform_rubric_controller::DISPLAY_EDIT_FULL: $classsuffix = ' editor editable'; break; case gradingform_rubric_controller::DISPLAY_EDIT_FROZEN: $classsuffix = ' editor frozen'; break; case gradingform_rubric_controller::DISPLAY_PREVIEW: case gradingform_rubric_controller::DISPLAY_PREVIEW_GRADED: $classsuffix = ' editor preview'; break; case gradingform_rubric_controller::DISPLAY_EVAL: $classsuffix = ' evaluate editable'; break; case gradingform_rubric_controller::DISPLAY_EVAL_FROZEN: $classsuffix = ' evaluate frozen'; break; case gradingform_rubric_controller::DISPLAY_REVIEW: $classsuffix = ' review'; break; case gradingform_rubric_controller::DISPLAY_VIEW: $classsuffix = ' view'; break; } $rubrictemplate = html_writer::start_tag('div', array('id' => 'rubric-{NAME}', 'class' => 'clearfix gradingform_rubric'.$classsuffix)); // Rubric table. $rubrictableparams = [ 'class' => 'criteria', 'id' => '{NAME}-criteria', ]; $caption = html_writer::tag('caption', get_string('rubric', 'gradingform_rubric'), ['class' => 'sr-only']); $rubrictable = html_writer::tag('table', $caption . $criteriastr, $rubrictableparams); $rubrictemplate .= $rubrictable; if ($mode == gradingform_rubric_controller::DISPLAY_EDIT_FULL) { $value = get_string('addcriterion', 'gradingform_rubric'); $criteriainputparams = array( 'type' => 'submit', 'name' => '{NAME}[criteria][addcriterion]', 'id' => '{NAME}-criteria-addcriterion', 'value' => $value ); $input = html_writer::empty_tag('input', $criteriainputparams); $rubrictemplate .= html_writer::tag('div', $input, array('class' => 'addcriterion btn btn-secondary')); } $rubrictemplate .= $this->rubric_edit_options($mode, $options); $rubrictemplate .= html_writer::end_tag('div'); return str_replace('{NAME}', $elementname, $rubrictemplate); } /** * Generates html template to view/edit the rubric options. Expression {NAME} is used in * template for the form element name * * @param int $mode rubric display mode see {@link gradingform_rubric_controller} * @param array $options display options for this rubric, defaults are: {@link gradingform_rubric_controller::get_default_options()} * @return string */ protected function rubric_edit_options($mode, $options) { if ($mode != gradingform_rubric_controller::DISPLAY_EDIT_FULL && $mode != gradingform_rubric_controller::DISPLAY_EDIT_FROZEN && $mode != gradingform_rubric_controller::DISPLAY_PREVIEW) { // Options are displayed only for people who can manage return; } $html = html_writer::start_tag('div', array('class' => 'options')); $html .= html_writer::tag('div', get_string('rubricoptions', 'gradingform_rubric'), array('class' => 'optionsheading')); $attrs = array('type' => 'hidden', 'name' => '{NAME}[options][optionsset]', 'value' => 1); foreach ($options as $option => $value) { $html .= html_writer::start_tag('div', array('class' => 'option '.$option)); $attrs = array('name' => '{NAME}[options]['.$option.']', 'id' => '{NAME}-options-'.$option); switch ($option) { case 'sortlevelsasc': // Display option as dropdown $html .= html_writer::label(get_string($option, 'gradingform_rubric'), $attrs['id'], false); $value = (int)(!!$value); // make sure $value is either 0 or 1 if ($mode == gradingform_rubric_controller::DISPLAY_EDIT_FULL) { $selectoptions = array(0 => get_string($option.'0', 'gradingform_rubric'), 1 => get_string($option.'1', 'gradingform_rubric')); $valuestr = html_writer::select($selectoptions, $attrs['name'], $value, false, array('id' => $attrs['id'])); $html .= html_writer::tag('span', $valuestr, array('class' => 'value')); } else { $html .= html_writer::tag('span', get_string($option.$value, 'gradingform_rubric'), array('class' => 'value')); if ($mode == gradingform_rubric_controller::DISPLAY_EDIT_FROZEN) { $html .= html_writer::empty_tag('input', $attrs + array('type' => 'hidden', 'value' => $value)); } } break; default: if ($mode == gradingform_rubric_controller::DISPLAY_EDIT_FROZEN && $value) { // Id should be different then the actual input added later. $attrs['id'] .= '_hidden'; $html .= html_writer::empty_tag('input', $attrs + array('type' => 'hidden', 'value' => $value)); } // Display option as checkbox $attrs['type'] = 'checkbox'; $attrs['value'] = 1; if ($value) { $attrs['checked'] = 'checked'; } if ($mode == gradingform_rubric_controller::DISPLAY_EDIT_FROZEN || $mode == gradingform_rubric_controller::DISPLAY_PREVIEW) { $attrs['disabled'] = 'disabled'; unset($attrs['name']); // Id should be different then the actual input added later. $attrs['id'] .= '_disabled'; } $html .= html_writer::empty_tag('input', $attrs); $html .= html_writer::tag('label', get_string($option, 'gradingform_rubric'), array('for' => $attrs['id'])); break; } if (get_string_manager()->string_exists($option.'_help', 'gradingform_rubric')) { $html .= $this->help_icon($option, 'gradingform_rubric'); } $html .= html_writer::end_tag('div'); // .option } $html .= html_writer::end_tag('div'); // .options return $html; } /** * This function returns html code for displaying rubric. Depending on $mode it may be the code * to edit rubric, to preview the rubric, to evaluate somebody or to review the evaluation. * * It is very unlikely that this function needs to be overriden by theme. It does not produce * any html code, it just prepares data about rubric design and evaluation, adds the CSS * class to elements and calls the functions level_template, criterion_template and * rubric_template * * @param array $criteria data about the rubric design * @param array $options display options for this rubric, defaults are: {@link gradingform_rubric_controller::get_default_options()} * @param int $mode rubric display mode, see {@link gradingform_rubric_controller} * @param string $elementname the name of the form element (in editor mode) or the prefix for div ids (in view mode) * @param array $values evaluation result * @return string */ public function display_rubric($criteria, $options, $mode, $elementname = null, $values = null) { $criteriastr = ''; $cnt = 0; foreach ($criteria as $id => $criterion) { $criterion['class'] = $this->get_css_class_suffix($cnt++, sizeof($criteria) -1); $criterion['id'] = $id; $levelsstr = ''; $levelcnt = 0; if (isset($values['criteria'][$id])) { $criterionvalue = $values['criteria'][$id]; } else { $criterionvalue = null; } $index = 1; foreach ($criterion['levels'] as $levelid => $level) { $level['id'] = $levelid; $level['class'] = $this->get_css_class_suffix($levelcnt++, sizeof($criterion['levels']) -1); $level['checked'] = (isset($criterionvalue['levelid']) && ((int)$criterionvalue['levelid'] === $levelid)); if ($level['checked'] && ($mode == gradingform_rubric_controller::DISPLAY_EVAL_FROZEN || $mode == gradingform_rubric_controller::DISPLAY_REVIEW || $mode == gradingform_rubric_controller::DISPLAY_VIEW)) { $level['class'] .= ' checked'; //in mode DISPLAY_EVAL the class 'checked' will be added by JS if it is enabled. If JS is not enabled, the 'checked' class will only confuse } if (isset($criterionvalue['savedlevelid']) && ((int)$criterionvalue['savedlevelid'] === $levelid)) { $level['class'] .= ' currentchecked'; } $level['tdwidth'] = 100/count($criterion['levels']); $level['index'] = $index; $levelsstr .= $this->level_template($mode, $options, $elementname, $id, $level); $index++; } $criteriastr .= $this->criterion_template($mode, $options, $elementname, $criterion, $levelsstr, $criterionvalue); } return $this->rubric_template($mode, $options, $elementname, $criteriastr); } /** * Help function to return CSS class names for element (first/last/even/odd) with leading space * * @param int $idx index of this element in the row/column * @param int $maxidx maximum index of the element in the row/column * @return string */ protected function get_css_class_suffix($idx, $maxidx) { $class = ''; if ($idx == 0) { $class .= ' first'; } if ($idx == $maxidx) { $class .= ' last'; } if ($idx%2) { $class .= ' odd'; } else { $class .= ' even'; } return $class; } /** * Displays for the student the list of instances or default content if no instances found * * @param array $instances array of objects of type gradingform_rubric_instance * @param string $defaultcontent default string that would be displayed without advanced grading * @param boolean $cangrade whether current user has capability to grade in this context * @return string */ public function display_instances($instances, $defaultcontent, $cangrade) { $return = ''; if (sizeof($instances)) { $return .= html_writer::start_tag('div', array('class' => 'advancedgrade')); $idx = 0; foreach ($instances as $instance) { $return .= $this->display_instance($instance, $idx++, $cangrade); } $return .= html_writer::end_tag('div'); } return $return. $defaultcontent; } /** * Displays one grading instance * * @param gradingform_rubric_instance $instance * @param int $idx unique number of instance on page * @param bool $cangrade whether current user has capability to grade in this context */ public function display_instance(gradingform_rubric_instance $instance, $idx, $cangrade) { $criteria = $instance->get_controller()->get_definition()->rubric_criteria; $options = $instance->get_controller()->get_options(); $values = $instance->get_rubric_filling(); if ($cangrade) { $mode = gradingform_rubric_controller::DISPLAY_REVIEW; $showdescription = $options['showdescriptionteacher']; } else { $mode = gradingform_rubric_controller::DISPLAY_VIEW; $showdescription = $options['showdescriptionstudent']; } $output = ''; if ($showdescription) { $output .= $this->box($instance->get_controller()->get_formatted_description(), 'gradingform_rubric-description'); } $output .= $this->display_rubric($criteria, $options, $mode, 'rubric'.$idx, $values); return $output; } /** * Displays confirmation that students require re-grading * * @param string $elementname * @param int $changelevel * @param string $value * @return string */ public function display_regrade_confirmation($elementname, $changelevel, $value) { $html = html_writer::start_tag('div', array('class' => 'gradingform_rubric-regrade', 'role' => 'alert')); if ($changelevel<=2) { $html .= html_writer::label(get_string('regrademessage1', 'gradingform_rubric'), 'menu' . $elementname . 'regrade'); $selectoptions = array( 0 => get_string('regradeoption0', 'gradingform_rubric'), 1 => get_string('regradeoption1', 'gradingform_rubric') ); $html .= html_writer::select($selectoptions, $elementname.'[regrade]', $value, false); } else { $html .= get_string('regrademessage5', 'gradingform_rubric'); $html .= html_writer::empty_tag('input', array('name' => $elementname.'[regrade]', 'value' => 1, 'type' => 'hidden')); } $html .= html_writer::end_tag('div'); return $html; } /** * Generates and returns HTML code to display information box about how rubric score is converted to the grade * * @param array $scores * @return string */ public function display_rubric_mapping_explained($scores) { $html = ''; if (!$scores) { return $html; } if ($scores['minscore'] <> 0) { $html .= $this->output->notification(get_string('zerolevelsabsent', 'gradingform_rubric'), 'error'); } $html .= $this->output->notification(get_string('rubricmappingexplained', 'gradingform_rubric', (object)$scores), 'info'); return $html; } } grading/form/rubric/js/rubriceditor.js 0000604 00000040115 15062070556 0014062 0 ustar 00 M.gradingform_rubriceditor = {'templates' : {}, 'eventhandler' : null, 'name' : null, 'Y' : null}; /** * This function is called for each rubriceditor on page. */ M.gradingform_rubriceditor.init = function(Y, options) { M.gradingform_rubriceditor.name = options.name M.gradingform_rubriceditor.Y = Y M.gradingform_rubriceditor.templates[options.name] = { 'criterion' : options.criteriontemplate, 'level' : options.leveltemplate } M.gradingform_rubriceditor.disablealleditors() Y.on('click', M.gradingform_rubriceditor.clickanywhere, 'body', null) YUI().use('event-touch', function (Y) { Y.one('body').on('touchstart', M.gradingform_rubriceditor.clickanywhere); Y.one('body').on('touchend', M.gradingform_rubriceditor.clickanywhere); }) M.gradingform_rubriceditor.addhandlers() }; // Adds handlers for clicking submit button. This function must be called each time JS adds new elements to html M.gradingform_rubriceditor.addhandlers = function() { var Y = M.gradingform_rubriceditor.Y var name = M.gradingform_rubriceditor.name if (M.gradingform_rubriceditor.eventhandler) M.gradingform_rubriceditor.eventhandler.detach() M.gradingform_rubriceditor.eventhandler = Y.on('click', M.gradingform_rubriceditor.buttonclick, '#rubric-'+name+' input[type=submit]', null); } // switches all input text elements to non-edit mode M.gradingform_rubriceditor.disablealleditors = function() { var Y = M.gradingform_rubriceditor.Y var name = M.gradingform_rubriceditor.name Y.all('#rubric-'+name+' .level').each( function(node) {M.gradingform_rubriceditor.editmode(node, false)} ); Y.all('#rubric-'+name+' .description').each( function(node) {M.gradingform_rubriceditor.editmode(node, false)} ); } // function invoked on each click on the page. If level and/or criterion description is clicked // it switches this element to edit mode. If rubric button is clicked it does nothing so the 'buttonclick' // function is invoked M.gradingform_rubriceditor.clickanywhere = function(e) { if (e.type == 'touchstart') return var el = e.target // if clicked on button - disablecurrenteditor, continue if (el.get('tagName') == 'INPUT' && el.get('type') == 'submit') { return } // else if clicked on level and this level is not enabled - enable it // or if clicked on description and this description is not enabled - enable it var focustb = false while (el && !(el.hasClass('level') || el.hasClass('description'))) { if (el.hasClass('score')) focustb = true el = el.get('parentNode') } if (el) { if (el.one('textarea').hasClass('hiddenelement')) { M.gradingform_rubriceditor.disablealleditors() M.gradingform_rubriceditor.editmode(el, true, focustb) } return } // else disablecurrenteditor M.gradingform_rubriceditor.disablealleditors() } // switch the criterion description or level to edit mode or switch back M.gradingform_rubriceditor.editmode = function(el, editmode, focustb) { var ta = el.one('textarea') if (!editmode && ta.hasClass('hiddenelement')) return; if (editmode && !ta.hasClass('hiddenelement')) return; var pseudotablink = '<span class="pseudotablink" tabindex="0"></span>', taplain = ta.get('parentNode').one('.plainvalue'), tbplain = null, tb = el.one('.score input[type=text]') // add 'plainvalue' next to textarea for description/definition and next to input text field for score (if applicable) if (!taplain) { ta.get('parentNode').append('<div class="plainvalue">'+pseudotablink+'<span class="textvalue"> </span></div>') taplain = ta.get('parentNode').one('.plainvalue') taplain.one('.pseudotablink').on('focus', M.gradingform_rubriceditor.clickanywhere) if (tb) { tb.get('parentNode').append('<span class="plainvalue">'+pseudotablink+'<span class="textvalue"> </span></span>') tbplain = tb.get('parentNode').one('.plainvalue') tbplain.one('.pseudotablink').on('focus', M.gradingform_rubriceditor.clickanywhere) } } if (tb && !tbplain) tbplain = tb.get('parentNode').one('.plainvalue') if (!editmode) { // if we need to hide the input fields, copy their contents to plainvalue(s). If description/definition // is empty, display the default text ('Click to edit ...') and add/remove 'empty' CSS class to element var value = ta.get('value') if (value.length) taplain.removeClass('empty') else { value = (el.hasClass('level')) ? M.util.get_string('levelempty', 'gradingform_rubric') : M.util.get_string('criterionempty', 'gradingform_rubric') taplain.addClass('empty') } taplain.one('.textvalue').set('innerHTML', Y.Escape.html(value)); if (tb) tbplain.one('.textvalue').set('innerHTML', Y.Escape.html(tb.get('value'))); // hide/display textarea, textbox and plaintexts taplain.removeClass('hiddenelement') ta.addClass('hiddenelement') if (tb) { tbplain.removeClass('hiddenelement') tb.addClass('hiddenelement') } } else { // if we need to show the input fields, set the width/height for textarea so it fills the cell try { var width = parseFloat(ta.get('parentNode').getComputedStyle('width')), height if (el.hasClass('level')) height = parseFloat(el.getComputedStyle('height')) - parseFloat(el.one('.score').getComputedStyle('height')) else height = parseFloat(ta.get('parentNode').getComputedStyle('height')) ta.setStyle('width', Math.max(width-16,50)+'px') ta.setStyle('height', Math.max(height,20)+'px') } catch (err) { // this browser do not support 'computedStyle', leave the default size of the textbox } // hide/display textarea, textbox and plaintexts taplain.addClass('hiddenelement') ta.removeClass('hiddenelement') if (tb) { tbplain.addClass('hiddenelement') tb.removeClass('hiddenelement') } } // focus the proper input field in edit mode if (editmode) { if (tb && focustb) tb.focus(); else ta.focus() } } // handler for clicking on submit buttons within rubriceditor element. Adds/deletes/rearranges criteria and/or levels on client side M.gradingform_rubriceditor.buttonclick = function(e, confirmed) { var Y = M.gradingform_rubriceditor.Y var name = M.gradingform_rubriceditor.name if (e.target.get('type') != 'submit') return; M.gradingform_rubriceditor.disablealleditors() var chunks = e.target.get('id').split('-'), action = chunks[chunks.length-1] if (chunks[0] != name || chunks[1] != 'criteria') return; var elements_str if (chunks.length>4 || action == 'addlevel') { elements_str = '#rubric-'+name+' #'+name+'-criteria-'+chunks[2]+'-levels .level' } else { elements_str = '#rubric-'+name+' .criterion' } // prepare the id of the next inserted level or criterion var newlevid = 0; var newid = 0; if (action == 'addcriterion' || action == 'addlevel' || action == 'duplicate' ) { newid = M.gradingform_rubriceditor.calculatenewid('#rubric-'+name+' .criterion'); newlevid = M.gradingform_rubriceditor.calculatenewid('#rubric-'+name+' .level'); } if (chunks.length == 3 && action == 'addcriterion') { // ADD NEW CRITERION var levelsscores = [0], levidx = 1 var parentel = Y.one('#'+name+'-criteria') if (parentel.one('>tbody')) parentel = parentel.one('>tbody') if (parentel.all('.criterion').size()) { var lastcriterion = parentel.all('.criterion').item(parentel.all('.criterion').size()-1).all('.level') for (levidx=0;levidx<lastcriterion.size();levidx++) levelsscores[levidx] = lastcriterion.item(levidx).one('.score input[type=text]').get('value') } for (levidx;levidx<3;levidx++) levelsscores[levidx] = parseFloat(levelsscores[levidx-1])+1 var levelsstr = ''; for (levidx=0;levidx<levelsscores.length;levidx++) { levelsstr += M.gradingform_rubriceditor.templates[name].level. replace(/\{LEVEL-id\}/g, 'NEWID'+(newlevid+levidx)). replace(/\{LEVEL-score\}/g, levelsscores[levidx]). replace(/\{LEVEL-index\}/g, levidx + 1); } var newcriterion = M.gradingform_rubriceditor.templates[name]['criterion'].replace(/\{LEVELS\}/, levelsstr) parentel.append(newcriterion.replace(/\{CRITERION-id\}/g, 'NEWID'+newid).replace(/\{.+?\}/g, '')) M.gradingform_rubriceditor.assignclasses('#rubric-'+name+' #'+name+'-criteria-NEWID'+newid+'-levels .level') M.gradingform_rubriceditor.addhandlers(); M.gradingform_rubriceditor.disablealleditors() M.gradingform_rubriceditor.assignclasses(elements_str) M.gradingform_rubriceditor.editmode( Y.one('#rubric-' + name + ' #' + name + '-criteria-NEWID' + newid + '-description-cell'), true ); } else if (chunks.length == 5 && action == 'addlevel') { // ADD NEW LEVEL var newscore = 0; parent = Y.one('#'+name+'-criteria-'+chunks[2]+'-levels') var levelIndex = 1; parent.all('.level').each(function (node) { newscore = Math.max(newscore, parseFloat(node.one('.score input[type=text]').get('value')) + 1); levelIndex++; }); var newlevel = M.gradingform_rubriceditor.templates[name]['level']. replace(/\{CRITERION-id\}/g, chunks[2]).replace(/\{LEVEL-id\}/g, 'NEWID'+newlevid). replace(/\{LEVEL-score\}/g, newscore). replace(/\{LEVEL-index\}/g, levelIndex). replace(/\{.+?\}/g, ''); parent.append(newlevel) M.gradingform_rubriceditor.addhandlers(); M.gradingform_rubriceditor.disablealleditors() M.gradingform_rubriceditor.assignclasses(elements_str) M.gradingform_rubriceditor.editmode(parent.all('.level').item(parent.all('.level').size()-1), true) } else if (chunks.length == 4 && action == 'moveup') { // MOVE CRITERION UP el = Y.one('#'+name+'-criteria-'+chunks[2]) if (el.previous()) el.get('parentNode').insertBefore(el, el.previous()) M.gradingform_rubriceditor.assignclasses(elements_str) } else if (chunks.length == 4 && action == 'movedown') { // MOVE CRITERION DOWN el = Y.one('#'+name+'-criteria-'+chunks[2]) if (el.next()) el.get('parentNode').insertBefore(el.next(), el) M.gradingform_rubriceditor.assignclasses(elements_str) } else if (chunks.length == 4 && action == 'delete') { // DELETE CRITERION if (confirmed) { Y.one('#'+name+'-criteria-'+chunks[2]).remove() M.gradingform_rubriceditor.assignclasses(elements_str) } else { M.util.js_pending('gradingform_rubriceditor:deleteConfirmation'); require(['core/notification', 'core/str'], function(Notification, Str) { Notification.saveCancelPromise( Str.get_string('confirmation', 'admin'), Str.get_string('confirmdeletecriterion', 'gradingform_rubric'), Str.get_string('yes', 'moodle') ).then(function() { M.gradingform_rubriceditor.buttonclick.apply(this, [e, true]); return; }.bind(this)).catch(function() { // User cancelled. }); M.util.js_complete('gradingform_rubriceditor:deleteConfirmation'); }.bind(this)); } } else if (chunks.length == 4 && action == 'duplicate') { // Duplicate criterion. var levelsdef = [], levelsscores = [0], levidx = null; var parentel = Y.one('#'+name+'-criteria'); if (parentel.one('>tbody')) { parentel = parentel.one('>tbody'); } var source = Y.one('#'+name+'-criteria-'+chunks[2]); if (source.all('.level')) { var lastcriterion = source.all('.level'); for (levidx = 0; levidx < lastcriterion.size(); levidx++) { levelsdef[levidx] = lastcriterion.item(levidx).one('.definition .textvalue').get('innerHTML'); } for (levidx = 0; levidx < lastcriterion.size(); levidx++) { levelsscores[levidx] = lastcriterion.item(levidx).one('.score input[type=text]').get('value'); } } for (levidx; levidx < 3; levidx++) { levelsscores[levidx] = parseFloat(levelsscores[levidx-1]) + 1; } var levelsstr = ''; for (levidx = 0; levidx < levelsscores.length; levidx++) { levelsstr += M.gradingform_rubriceditor.templates[name].level .replace(/\{LEVEL-id\}/g, 'NEWID'+(newlevid+levidx)) .replace(/\{LEVEL-score\}/g, levelsscores[levidx]) .replace(/\{LEVEL-definition\}/g, levelsdef[levidx]); } var description = source.one('.description .textvalue'); var newcriterion = M.gradingform_rubriceditor.templates[name].criterion .replace(/\{LEVELS\}/, levelsstr) .replace(/\{CRITERION-description\}/, description.get('innerHTML')); parentel.append(newcriterion.replace(/\{CRITERION-id\}/g, 'NEWID'+newid).replace(/\{.+?\}/g, '')); M.gradingform_rubriceditor.assignclasses('#rubric-'+name+' #'+name+'-criteria-NEWID'+newid+'-levels .level'); M.gradingform_rubriceditor.addhandlers(); M.gradingform_rubriceditor.disablealleditors(); M.gradingform_rubriceditor.assignclasses(elements_str); M.gradingform_rubriceditor.editmode(Y.one('#rubric-'+name+' #'+name+'-criteria-NEWID'+newid+'-description-cell'),true); } else if (chunks.length == 6 && action == 'delete') { // DELETE LEVEL if (confirmed) { Y.one('#'+name+'-criteria-'+chunks[2]+'-'+chunks[3]+'-'+chunks[4]).remove() M.gradingform_rubriceditor.assignclasses(elements_str) } else { M.util.js_pending('gradingform_rubriceditor:deleteLevelConfirmation'); require(['core/notification', 'core/str'], function(Notification, Str) { Notification.saveCancelPromise( Str.get_string('confirmation', 'admin'), Str.get_string('confirmdeletelevel', 'gradingform_rubric'), Str.get_string('yes', 'moodle') ).then(function() { M.gradingform_rubriceditor.buttonclick.apply(this, [e, true]); return; }.bind(this)).catch(function() { // User cancelled. }); M.util.js_complete('gradingform_rubriceditor:deleteLevelConfirmation'); }.bind(this)); } } else { // unknown action return; } e.preventDefault(); } // properly set classes (first/last/odd/even), level width and/or criterion sortorder for elements Y.all(elements_str) M.gradingform_rubriceditor.assignclasses = function (elements_str) { var elements = M.gradingform_rubriceditor.Y.all(elements_str) for (var i=0;i<elements.size();i++) { elements.item(i).removeClass('first').removeClass('last').removeClass('even').removeClass('odd'). addClass(((i%2)?'odd':'even') + ((i==0)?' first':'') + ((i==elements.size()-1)?' last':'')) elements.item(i).all('input[type=hidden]').each( function(node) {if (node.get('name').match(/sortorder/)) node.set('value', i)} ); if (elements.item(i).hasClass('level')) elements.item(i).set('width', Math.round(100/elements.size())+'%') } } // returns unique id for the next added element, it should not be equal to any of Y.all(elements_str) ids M.gradingform_rubriceditor.calculatenewid = function (elements_str) { var newid = 1 M.gradingform_rubriceditor.Y.all(elements_str).each( function(node) { var idchunks = node.get('id').split('-'), id = idchunks.pop(); if (id.match(/^NEWID(\d+)$/)) newid = Math.max(newid, parseInt(id.substring(5))+1); } ); return newid } grading/form/rubric/js/rubric.js 0000604 00000003110 15062070556 0012645 0 ustar 00 M.gradingform_rubric = {}; /** * This function is called for each rubric on page. */ M.gradingform_rubric.init = function(Y, options) { Y.on('click', M.gradingform_rubric.levelclick, '#rubric-'+options.name+' .level', null, Y, options.name); // Capture also space and enter keypress. Y.on('key', M.gradingform_rubric.levelclick, '#rubric-' + options.name + ' .level', 'space', Y, options.name); Y.on('key', M.gradingform_rubric.levelclick, '#rubric-' + options.name + ' .level', 'enter', Y, options.name); Y.all('#rubric-'+options.name+' .radio').setStyle('display', 'none') Y.all('#rubric-'+options.name+' .level').each(function (node) { if (node.one('input[type=radio]').get('checked')) { node.addClass('checked'); } }); }; M.gradingform_rubric.levelclick = function(e, Y, name) { var el = e.target while (el && !el.hasClass('level')) el = el.get('parentNode') if (!el) return e.preventDefault(); el.siblings().removeClass('checked'); // Set aria-checked attribute for siblings to false. el.siblings().setAttribute('aria-checked', 'false'); chb = el.one('input[type=radio]') if (!chb.get('checked')) { chb.set('checked', true) el.addClass('checked') // Set aria-checked attribute to true if checked. el.setAttribute('aria-checked', 'true'); } else { el.removeClass('checked'); // Set aria-checked attribute to false if unchecked. el.setAttribute('aria-checked', 'false'); el.get('parentNode').all('input[type=radio]').set('checked', false) } } grading/form/rubric/amd/src/grades/grader/gradingpanel.js 0000604 00000005317 15062070556 0017452 0 ustar 00 // 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/>. /** * Grading panel for gradingform_rubric. * * @module gradingform_rubric/grades/grader/gradingpanel * @copyright 2019 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import {call as fetchMany} from 'core/ajax'; import {normaliseResult} from 'core_grades/grades/grader/gradingpanel/normalise'; import {compareData} from 'core_grades/grades/grader/gradingpanel/comparison'; // Note: We use jQuery.serializer here until we can rewrite Ajax to use XHR.send() import jQuery from 'jquery'; /** * For a given component, contextid, itemname & gradeduserid we can fetch the currently assigned grade. * * @param {String} component * @param {Number} contextid * @param {String} itemname * @param {Number} gradeduserid * * @returns {Promise} */ export const fetchCurrentGrade = (component, contextid, itemname, gradeduserid) => { return fetchMany([{ methodname: `gradingform_rubric_grader_gradingpanel_fetch`, args: { component, contextid, itemname, gradeduserid, }, }])[0]; }; /** * For a given component, contextid, itemname & gradeduserid we can store the currently assigned grade in a given form. * * @param {String} component * @param {Number} contextid * @param {String} itemname * @param {Number} gradeduserid * @param {Boolean} notifyUser * @param {HTMLElement} rootNode * * @returns {Promise} */ export const storeCurrentGrade = async(component, contextid, itemname, gradeduserid, notifyUser, rootNode) => { const form = rootNode.querySelector('form'); if (compareData(form) === true) { return normaliseResult(await fetchMany([{ methodname: `gradingform_rubric_grader_gradingpanel_store`, args: { component, contextid, itemname, gradeduserid, notifyuser: notifyUser, formdata: jQuery(form).serialize(), }, }])[0]); } else { return ''; } }; grading/form/rubric/amd/build/grades/grader/gradingpanel.min.js 0000604 00000002634 15062070556 0020543 0 ustar 00 define("gradingform_rubric/grades/grader/gradingpanel",["exports","core/ajax","core_grades/grades/grader/gradingpanel/normalise","core_grades/grades/grader/gradingpanel/comparison","jquery"],(function(_exports,_ajax,_normalise,_comparison,_jquery){var obj; /** * Grading panel for gradingform_rubric. * * @module gradingform_rubric/grades/grader/gradingpanel * @copyright 2019 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.storeCurrentGrade=_exports.fetchCurrentGrade=void 0,_jquery=(obj=_jquery)&&obj.__esModule?obj:{default:obj};_exports.fetchCurrentGrade=(component,contextid,itemname,gradeduserid)=>(0,_ajax.call)([{methodname:"gradingform_rubric_grader_gradingpanel_fetch",args:{component:component,contextid:contextid,itemname:itemname,gradeduserid:gradeduserid}}])[0];_exports.storeCurrentGrade=async(component,contextid,itemname,gradeduserid,notifyUser,rootNode)=>{const form=rootNode.querySelector("form");return!0===(0,_comparison.compareData)(form)?(0,_normalise.normaliseResult)(await(0,_ajax.call)([{methodname:"gradingform_rubric_grader_gradingpanel_store",args:{component:component,contextid:contextid,itemname:itemname,gradeduserid:gradeduserid,notifyuser:notifyUser,formdata:(0,_jquery.default)(form).serialize()}}])[0]):""}})); //# sourceMappingURL=gradingpanel.min.js.map grading/form/rubric/amd/build/grades/grader/gradingpanel.min.js.map 0000604 00000006663 15062070556 0021325 0 ustar 00 {"version":3,"file":"gradingpanel.min.js","sources":["../../../src/grades/grader/gradingpanel.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Grading panel for gradingform_rubric.\n *\n * @module gradingform_rubric/grades/grader/gradingpanel\n * @copyright 2019 Mathew May <mathew.solutions>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport {call as fetchMany} from 'core/ajax';\nimport {normaliseResult} from 'core_grades/grades/grader/gradingpanel/normalise';\nimport {compareData} from 'core_grades/grades/grader/gradingpanel/comparison';\n\n// Note: We use jQuery.serializer here until we can rewrite Ajax to use XHR.send()\nimport jQuery from 'jquery';\n\n/**\n * For a given component, contextid, itemname & gradeduserid we can fetch the currently assigned grade.\n *\n * @param {String} component\n * @param {Number} contextid\n * @param {String} itemname\n * @param {Number} gradeduserid\n *\n * @returns {Promise}\n */\nexport const fetchCurrentGrade = (component, contextid, itemname, gradeduserid) => {\n return fetchMany([{\n methodname: `gradingform_rubric_grader_gradingpanel_fetch`,\n args: {\n component,\n contextid,\n itemname,\n gradeduserid,\n },\n }])[0];\n};\n\n/**\n * For a given component, contextid, itemname & gradeduserid we can store the currently assigned grade in a given form.\n *\n * @param {String} component\n * @param {Number} contextid\n * @param {String} itemname\n * @param {Number} gradeduserid\n * @param {Boolean} notifyUser\n * @param {HTMLElement} rootNode\n *\n * @returns {Promise}\n */\nexport const storeCurrentGrade = async(component, contextid, itemname, gradeduserid, notifyUser, rootNode) => {\n const form = rootNode.querySelector('form');\n\n if (compareData(form) === true) {\n return normaliseResult(await fetchMany([{\n methodname: `gradingform_rubric_grader_gradingpanel_store`,\n args: {\n component,\n contextid,\n itemname,\n gradeduserid,\n notifyuser: notifyUser,\n formdata: jQuery(form).serialize(),\n },\n }])[0]);\n } else {\n return '';\n }\n};\n"],"names":["component","contextid","itemname","gradeduserid","methodname","args","async","notifyUser","rootNode","form","querySelector","notifyuser","formdata","serialize"],"mappings":";;;;;;;6MAwCiC,CAACA,UAAWC,UAAWC,SAAUC,gBACvD,cAAU,CAAC,CACdC,0DACAC,KAAM,CACFL,UAAAA,UACAC,UAAAA,UACAC,SAAAA,SACAC,aAAAA,iBAEJ,8BAeyBG,MAAMN,UAAWC,UAAWC,SAAUC,aAAcI,WAAYC,kBACvFC,KAAOD,SAASE,cAAc,eAEV,KAAtB,2BAAYD,OACL,oCAAsB,cAAU,CAAC,CACpCL,0DACAC,KAAM,CACFL,UAAAA,UACAC,UAAAA,UACAC,SAAAA,SACAC,aAAAA,aACAQ,WAAYJ,WACZK,UAAU,mBAAOH,MAAMI,gBAE3B,IAEG"} grading/form/rubric/templates/grades/grader/gradingpanel.mustache 0000604 00000013263 15062070556 0021314 0 ustar 00 {{! 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/>. }} {{! @template gradingform_rubric/grades/grader/gradingpanel Classes required for JS: * none Data attributes required for JS: * none Context variables required for this template: * instanceid: Instance of the module this grading form belongs too * criteria: A gradeable item in the Marking Guide * id: The ID of the criteria * description: Description of the criteria * levels: The level that a criteria can be graded at * criterionid: The ID of the criteria * checked: Flag for if this is the currently selected level * definition: Definition of the level * remark: Text input for the teacher to relay to the student Example context (json): { "instanceid": "42", "criteria": [ { "id": 13, "description": "Show your motivation to rock climbing", "levels": [ { "criterionid": 13, "checked": true, "definition": "Great work!" } ], "remark": "That's great!" } ] } }} <form id="gradingform_rubric-{{uniqid}}"> <input type="hidden" name="instanceid" value="{{instanceid}}"> <div id="rubric-advancedgrading-{{uniqid}}" class="criterion"> {{#criteria}} <div class="mb-3"> <div class="d-flex align-items-center mb-2"> <h5 id="criterion-description-{{id}}" class="px-0 mb-0 description font-weight-bold">{{{description}}}</h5> <button class="criterion-toggle btn btn-icon icon-no-margin text-reset p-0 font-weight-bold mb-0 ml-auto" type="button" data-toggle="collapse" data-target="#criteria-{{id}}" aria-expanded="true" aria-controls="criteria-{{id}}"> <span class="collapsed-icon"> {{#pix}} t/collapsed, core {{/pix}} <span class="sr-only">{{#str}} expandcriterion, core_grades {{/str}}</span> </span> <span class="expanded-icon"> {{#pix}} t/expanded, core {{/pix}} <span class="sr-only">{{#str}} collapsecriterion, core_grades {{/str}}</span> </span> </button> </div> <div class="collapse show" id="criteria-{{id}}" role="radiogroup" aria-labelledby="criterion-description-{{id}}"> {{#levels}} <div class="form-check"> <input class="form-check-input level" type="radio" name="advancedgrading[criteria][{{criterionid}}][levelid]" id="advancedgrading-criteria-{{criterionid}}-levels-{{id}}-definition" value="{{id}}" {{#checked}} aria-checked="true" tabindex="0" checked {{/checked}} {{^checked}} aria-checked="false" tabindex="-1" {{/checked}} > <label class="w-100" for="advancedgrading-criteria-{{criterionid}}-levels-{{id}}-definition"> <span> {{{definition}}} </span> <span class="pull-right"> {{#str}}pointsvalue, gradingform_rubric, {{score}}{{/str}} </span> </label> </div> {{/levels}} <div class="form-group"> <label class="text-muted" for="advancedgrading-criteria-{{id}}-remark">{{#str}} additionalfeedback, core_grades {{/str}}</label> <textarea class="form-control" name="advancedgrading[criteria][{{id}}][remark]" id="advancedgrading-criteria-{{id}}-remark" cols="10" rows="1" data-max-rows="5" data-auto-rows="true" >{{{remark}}}</textarea> </div> </div> </div> {{/criteria}} </div> </form> {{#js}} require(['core/auto_rows'], function(AutoRows) { AutoRows.init(document.getElementById('gradingform_rubric-{{uniqid}}')); }); {{/js}} grading/form/rubric/styles.css 0000604 00000015004 15062070556 0012447 0 ustar 00 /* .gradingform_rubric.editor[.frozen|.editable] .criteria .criterion[.first][.last][.odd|.even] .controls .moveup [input type=submit] .delete [input type=submit] .movedown [input type=submit] .description .levels td.level[.first][.last][.odd|.even] div.level-wrapper .definition [textarea] .score span [input type=text] .delete [input type=submit] .addlevel [input type=submit] .remark textarea .addcriterion [input type=submit] .options .optionsheading .option.OPTIONNAME .gradingform_rubric[.review][.evaluate[.editable|.frozen]] .criteria .criterion[.first][.last][.odd|.even] .description .levels td.level[.first][.last][.odd|.even] div.level-wrapper div.radio input .definition .score span */ .gradingform_rubric_editform .status { font-weight: normal; text-transform: uppercase; font-size: 60%; padding: 0.25em; border: 1px solid #eee; } .gradingform_rubric_editform .status.ready { background-color: #e7f1c3; border-color: #aea; } .gradingform_rubric_editform .status.draft { background-color: #f3f2aa; border-color: #ee2; } .gradingform_rubric { padding-bottom: 1.5em; } .gradingform_rubric.editor .criterion .controls, .gradingform_rubric .criterion .description, .gradingform_rubric .criterion .levels, .gradingform_rubric.editor .criterion .addlevel, .gradingform_rubric .criterion .remark, .gradingform_rubric .criterion .levels .level { vertical-align: top; } .gradingform_rubric.editor .criterion .controls, .gradingform_rubric .criterion .description, .gradingform_rubric.editor .criterion .addlevel, .gradingform_rubric .criterion .remark, .gradingform_rubric .criterion .levels .level { padding: 3px; } .gradingform_rubric .criteria { height: 100%; display: flex; width: 100%; overflow: auto; } .gradingform_rubric .criterion { border: 1px solid #ddd; overflow: hidden; } .gradingform_rubric .criterion.even td { background: #f0f0f0; } .gradingform_rubric .criterion.odd td { background: white; } .gradingform_rubric .criterion .description { min-width: 150px; font-weight: bold; } .gradingform_rubric .criterion .levels table { width: 100%; height: 100%; } .gradingform_rubric .criterion .levels, .gradingform_rubric .criterion .levels table, .gradingform_rubric .criterion .levels table tbody { padding: 0; margin: 0; } .gradingform_rubric .criterion .levels .level { border-left: 1px solid #ddd; max-width: 150px; } .gradingform_rubric .criterion .levels .level .level-wrapper { position: relative; } .gradingform_rubric .criterion .levels .level.last { border-right: 1px solid #ddd; } .gradingform_rubric .plainvalue.empty { font-style: italic; color: #aaa; } /* Make invisible the buttons 'Move up' for the first criterion and 'Move down' for the last, because those buttons will make no change */ .gradingform_rubric.editor .criterion.first .controls .moveup input, .gradingform_rubric.editor .criterion.last .controls .movedown input { display: none; } /* replace buttons with images */ .gradingform_rubric.editor .delete input, .gradingform_rubric.editor .duplicate input, .gradingform_rubric.editor .moveup input, .gradingform_rubric.editor .movedown input { text-indent: -1000em; cursor: pointer; border: none; } .gradingform_rubric.editor .criterion .controls .delete input { width: 24px; height: 24px; background: transparent url([[pix:t/delete]]) no-repeat center; margin: .3em .3em 0 .3em; } .gradingform_rubric.editor .criterion .controls .duplicate input { width: 24px; height: 24px; background: transparent url([[pix:t/copy]]) no-repeat center; margin: .3em .3em 0 .3em; } .gradingform_rubric.editor .levels .level .delete input { width: 24px; height: 24px; background: transparent url([[pix:t/delete]]) no-repeat center; } .gradingform_rubric.editor .moveup input { width: 24px; height: 24px; background: transparent url([[pix:t/up]]) no-repeat center; margin: .3em .3em 0 .3em; } .gradingform_rubric.editor .movedown input { width: 24px; height: 24px; background: transparent url([[pix:t/down]]) no-repeat center; margin: .3em .3em 0 .3em; } .gradingform_rubric.editor .addcriterion input, .gradingform_rubric.editor .addlevel input { background: #fff url([[pix:t/add]]) no-repeat 7px 8px; display: block; color: #555; font-weight: bold; text-decoration: none; } .gradingform_rubric.editor .addcriterion input { height: 30px; line-height: 29px; margin-bottom: 14px; padding-left: 20px; padding-right: 10px; } .gradingform_rubric.editor .addlevel input { padding-left: 24px; padding-right: 8px; } .gradingform_rubric .options .optionsheading { font-weight: bold; font-size: 1.1em; padding-bottom: 5px; } .gradingform_rubric .options .option { padding-bottom: 2px; } .gradingform_rubric .options .option label { margin-left: 5px; } .gradingform_rubric .options .option .value { margin-left: 5px; font-weight: bold; } .gradingform_rubric .criterion .levels.error { border: 1px solid red; } .gradingform_rubric .criterion .description.error, .gradingform_rubric .criterion .levels .level .definition.error, .gradingform_rubric .criterion .levels .level .score.error { background: #fdd; } .gradingform_rubric-regrade { padding: 10px; background: #fdd; border: 1px solid #f00; margin-bottom: 10px; } .gradingform_rubric-restored { padding: 10px; background: #ffd; border: 1px solid #ff0; margin-bottom: 10px; } .gradingform_rubric-error { color: red; font-weight: bold; } /* special classes for elements created by rubriceditor.js */ .gradingform_rubric.editor .hiddenelement { display: none; } .gradingform_rubric.editor .pseudotablink { background-color: transparent; border: 0 solid; height: 1px; width: 1px; color: transparent; padding: 0; margin: 0; position: relative; float: right; } .gradingpanel-gradingform_rubric [aria-checked="true"] { border: 1px solid black; } grading/form/lib.php 0000604 00000116664 15062070556 0010421 0 ustar 00 <?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/>. /** * Common classes used by gradingform plugintypes are defined here * * @package core_grading * @copyright 2011 David Mudrak <david@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); /** * Class represents a grading form definition used in a particular area * * General data about definition is stored in the standard DB table * grading_definitions. A separate entry is created for each grading area * (i.e. for each module). Plugins may define and use additional tables * to store additional data about definitions. * * Advanced grading plugins must declare a class gradingform_xxxx_controller * extending this class and put it in lib.php in the plugin folder. * * See {@link gradingform_rubric_controller} as an example * * Except for overwriting abstract functions, plugin developers may want * to overwrite functions responsible for loading and saving of the * definition to include additional data stored. * * @package core_grading * @copyright 2011 David Mudrak <david@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * @category grading */ abstract class gradingform_controller { /** undefined definition status */ const DEFINITION_STATUS_NULL = 0; /** the form is currently being edited and is not ready for usage yet */ const DEFINITION_STATUS_DRAFT = 10; /** the form was marked as ready for actual usage */ const DEFINITION_STATUS_READY = 20; /** @var stdClass the context */ protected $context; /** @var string the frankenstyle name of the component */ protected $component; /** @var string the name of the gradable area */ protected $area; /** @var int the id of the gradable area record */ protected $areaid; /** @var stdClass|false the definition structure */ protected $definition = false; /** @var array graderange array of valid grades for this area. Use set_grade_range and get_grade_range to access this */ private $graderange = null; /** @var bool if decimal values are allowed as grades. */ private $allowgradedecimals = false; /** @var boolean|null cached result of function has_active_instances() */ protected $hasactiveinstances = null; /** * Do not instantinate this directly, use {@link grading_manager::get_controller()} * * @param stdClass $context the context of the form * @param string $component the frankenstyle name of the component * @param string $area the name of the gradable area * @param int $areaid the id of the gradable area record */ public function __construct(stdClass $context, $component, $area, $areaid) { global $DB; $this->context = $context; list($type, $name) = core_component::normalize_component($component); $this->component = $type.'_'.$name; $this->area = $area; $this->areaid = $areaid; $this->load_definition(); } /** * Returns controller context * * @return stdClass controller context */ public function get_context() { return $this->context; } /** * Returns gradable component name * * @return string gradable component name */ public function get_component() { return $this->component; } /** * Returns gradable area name * * @return string gradable area name */ public function get_area() { return $this->area; } /** * Returns gradable area id * * @return int gradable area id */ public function get_areaid() { return $this->areaid; } /** * Is the form definition record available? * * Note that this actually checks whether the process of defining the form ever started * and not whether the form definition should be considered as final. * * @return boolean */ public function is_form_defined() { return ($this->definition !== false); } /** * Is the grading form defined and ready for usage? * * @return boolean */ public function is_form_available() { return ($this->is_form_defined() && $this->definition->status == self::DEFINITION_STATUS_READY); } /** * Is the grading form saved as a shared public template? * * @return boolean */ public function is_shared_template() { return ($this->get_context()->id == context_system::instance()->id and $this->get_component() == 'core_grading'); } /** * Is the grading form owned by the given user? * * The form owner is the user who created this instance of the form. * * @param int $userid the user id to check, defaults to the current user * @return boolean|null null if the form not defined yet, boolean otherwise */ public function is_own_form($userid = null) { global $USER; if (!$this->is_form_defined()) { return null; } if (is_null($userid)) { $userid = $USER->id; } return ($this->definition->usercreated == $userid); } /** * Returns a message why this form is unavailable. Maybe overriden by plugins to give more details. * @see is_form_available() * * @return string */ public function form_unavailable_notification() { if ($this->is_form_available()) { return null; } return get_string('gradingformunavailable', 'grading'); } /** * Returns URL of a page where the grading form can be defined and edited. * * @param moodle_url $returnurl optional URL of a page where the user should be sent once they are finished with editing * @return moodle_url */ public function get_editor_url(moodle_url $returnurl = null) { $params = array('areaid' => $this->areaid); if (!is_null($returnurl)) { $params['returnurl'] = $returnurl->out(false); } return new moodle_url('/grade/grading/form/'.$this->get_method_name().'/edit.php', $params); } /** * Extends the module settings navigation * * This function is called when the context for the page is an activity module with the * FEATURE_ADVANCED_GRADING, the user has the permission moodle/grade:managegradingforms * and there is an area with the active grading method set to the given plugin. * * @param settings_navigation $settingsnav {@link settings_navigation} * @param navigation_node $node {@link navigation_node} */ public function extend_settings_navigation(settings_navigation $settingsnav, navigation_node $node=null) { // do not extend by default } /** * Extends the module navigation * * This function is called when the context for the page is an activity module with the * FEATURE_ADVANCED_GRADING and there is an area with the active grading method set to the given plugin. * * @param global_navigation $navigation {@link global_navigation} * @param navigation_node $node {@link navigation_node} */ public function extend_navigation(global_navigation $navigation, navigation_node $node=null) { // do not extend by default } /** * Returns the grading form definition structure * * @param boolean $force whether to force loading from DB even if it was already loaded * @return stdClass|false definition data or false if the form is not defined yet */ public function get_definition($force = false) { if ($this->definition === false || $force) { $this->load_definition(); } return $this->definition; } /** * Returns the form definition suitable for cloning into another area * * @param gradingform_controller $target the controller of the new copy * @return stdClass definition structure to pass to the target's {@link update_definition()} */ public function get_definition_copy(gradingform_controller $target) { if (get_class($this) != get_class($target)) { throw new coding_exception('The source and copy controller mismatch'); } if ($target->is_form_defined()) { throw new coding_exception('The target controller already contains a form definition'); } $old = $this->get_definition(); // keep our id $new = new stdClass(); $new->copiedfromid = $old->id; $new->name = $old->name; // once we support files embedded into the description, we will want to // relink them into the new file area here (that is why we accept $target) $new->description = $old->description; $new->descriptionformat = $old->descriptionformat; $new->options = $old->options; $new->status = $old->status; return $new; } /** * Saves the defintion data into the database * * The implementation in this base class stores the common data into the record * into the {grading_definition} table. The plugins are likely to extend this * and save their data into own tables, too. * * @param stdClass $definition data containing values for the {grading_definition} table * @param int|null $usermodified optional userid of the author of the definition, defaults to the current user */ public function update_definition(stdClass $definition, $usermodified = null) { global $DB, $USER; if (is_null($usermodified)) { $usermodified = $USER->id; } if (!empty($this->definition->id)) { // prepare a record to be updated $record = new stdClass(); // populate it with scalar values from the passed definition structure foreach ($definition as $prop => $val) { if (is_array($val) or is_object($val)) { // probably plugin's data continue; } $record->{$prop} = $val; } // make sure we do not override some crucial values by accident if (!empty($record->id) and $record->id != $this->definition->id) { throw new coding_exception('Attempting to update other definition record.'); } $record->id = $this->definition->id; unset($record->areaid); unset($record->method); unset($record->timecreated); // set the modification flags $record->timemodified = time(); $record->usermodified = $usermodified; $DB->update_record('grading_definitions', $record); } else if ($this->definition === false) { // prepare a record to be inserted $record = new stdClass(); // populate it with scalar values from the passed definition structure foreach ($definition as $prop => $val) { if (is_array($val) or is_object($val)) { // probably plugin's data continue; } $record->{$prop} = $val; } // make sure we do not override some crucial values by accident if (!empty($record->id)) { throw new coding_exception('Attempting to create a new record while there is already one existing.'); } unset($record->id); $record->areaid = $this->areaid; $record->method = $this->get_method_name(); $record->timecreated = time(); $record->usercreated = $usermodified; $record->timemodified = $record->timecreated; $record->usermodified = $record->usercreated; if (empty($record->status)) { $record->status = self::DEFINITION_STATUS_DRAFT; } if (empty($record->descriptionformat)) { $record->descriptionformat = FORMAT_MOODLE; // field can not be empty } $DB->insert_record('grading_definitions', $record); } else { throw new coding_exception('Unknown status of the cached definition record.'); } } /** * Formats the definition description for display on page * * @return string */ public function get_formatted_description() { if (!isset($this->definition->description)) { return ''; } return format_text($this->definition->description, $this->definition->descriptionformat); } /** * Returns the current instance (either with status ACTIVE or NEEDUPDATE) for this definition for the * specified $raterid and $itemid (if multiple raters are allowed, or only for $itemid otherwise). * * @param int $raterid * @param int $itemid * @param boolean $idonly * @return mixed if $idonly=true returns id of the found instance, otherwise returns the instance object */ public function get_current_instance($raterid, $itemid, $idonly = false) { global $DB; $params = array( 'definitionid' => $this->definition->id, 'itemid' => $itemid, 'status1' => gradingform_instance::INSTANCE_STATUS_ACTIVE, 'status2' => gradingform_instance::INSTANCE_STATUS_NEEDUPDATE); $select = 'definitionid=:definitionid and itemid=:itemid and (status=:status1 or status=:status2)'; if (false) { // TODO MDL-31237 should be: if ($manager->allow_multiple_raters()) $select .= ' and raterid=:raterid'; $params['raterid'] = $raterid; } if ($idonly) { if ($current = $DB->get_record_select('grading_instances', $select, $params, 'id', IGNORE_MISSING)) { return $current->id; } } else { if ($current = $DB->get_record_select('grading_instances', $select, $params, '*', IGNORE_MISSING)) { return $this->get_instance($current); } } return null; } /** * Returns list of ACTIVE instances for the specified $itemid * (intentionally does not return instances with status NEEDUPDATE) * * @param int $itemid * @return array of gradingform_instance objects */ public function get_active_instances($itemid) { global $DB; $conditions = array('definitionid' => $this->definition->id, 'itemid' => $itemid, 'status' => gradingform_instance::INSTANCE_STATUS_ACTIVE); $records = $DB->get_recordset('grading_instances', $conditions); $rv = array(); foreach ($records as $record) { $rv[] = $this->get_instance($record); } $records->close(); return $rv; } /** * Returns an array of all active instances for this definition. * (intentionally does not return instances with status NEEDUPDATE) * * @param int since only return instances with timemodified >= since * @return array of gradingform_instance objects */ public function get_all_active_instances($since = 0) { global $DB; $conditions = array ($this->definition->id, gradingform_instance::INSTANCE_STATUS_ACTIVE, $since); $where = "definitionid = ? AND status = ? AND timemodified >= ?"; $records = $DB->get_records_select('grading_instances', $where, $conditions); $rv = array(); foreach ($records as $record) { $rv[] = $this->get_instance($record); } return $rv; } /** * Returns true if there are already people who has been graded on this definition. * In this case plugins may restrict changes of the grading definition * * @return boolean */ public function has_active_instances() { global $DB; if (empty($this->definition->id)) { return false; } if ($this->hasactiveinstances === null) { $conditions = array('definitionid' => $this->definition->id, 'status' => gradingform_instance::INSTANCE_STATUS_ACTIVE); $this->hasactiveinstances = $DB->record_exists('grading_instances', $conditions); } return $this->hasactiveinstances; } /** * Returns the object of type gradingform_XXX_instance (where XXX is the plugin method name) * * @param mixed $instance id or row from grading_isntances table * @return gradingform_instance */ protected function get_instance($instance) { global $DB; if (is_scalar($instance)) { // instance id is passed as parameter $instance = $DB->get_record('grading_instances', array('id' => $instance), '*', MUST_EXIST); } if ($instance) { $class = 'gradingform_'. $this->get_method_name(). '_instance'; return new $class($this, $instance); } return null; } /** * This function is invoked when user (teacher) starts grading. * It creates and returns copy of the current ACTIVE instance if it exists. If this is the * first grading attempt, a new instance is created. * The status of the returned instance is INCOMPLETE * * @param int $raterid * @param int $itemid * @return gradingform_instance */ public function create_instance($raterid, $itemid = null) { // first find if there is already an active instance for this itemid if ($itemid && $current = $this->get_current_instance($raterid, $itemid)) { return $this->get_instance($current->copy($raterid, $itemid)); } else { $class = 'gradingform_'. $this->get_method_name(). '_instance'; return $this->get_instance($class::create_new($this->definition->id, $raterid, $itemid)); } } /** * If instanceid is specified and grading instance exists and it is created by this rater for * this item, this instance is returned. * Otherwise new instance is created for the specified rater and itemid * * @param int $instanceid * @param int $raterid * @param int $itemid * @return gradingform_instance * @throws dml_exception */ public function get_or_create_instance($instanceid, $raterid, $itemid) { if (!is_numeric($instanceid)) { $instanceid = null; } return $this->fetch_instance($raterid, $itemid, $instanceid); } /** * If an instanceid is specified and grading instance exists and it is created by this rater for * this item, then the instance is returned. * * If instanceid is not known, then null can be passed to fetch the current instance matchign the specified raterid * and itemid. * * If the instanceid is falsey, or no instance was found, then create a new instance for the specified rater and item. * * @param int $raterid * @param int $itemid * @param int $instanceid * @return gradingform_instance * @throws dml_exception */ public function fetch_instance(int $raterid, int $itemid, ?int $instanceid): gradingform_instance { global $DB; $instance = null; if (null === $instanceid) { if ($instance = $this->get_current_instance($raterid, $itemid)) { return $instance; } $instanceid = $instancerecord->id ?? null; } if (!empty($instanceid)) { $instance = $DB->get_record('grading_instances', [ 'id' => $instanceid, 'raterid' => $raterid, 'itemid' => $itemid, ], '*', IGNORE_MISSING); if ($instance) { return $this->get_instance($instance); } } return $this->create_instance($raterid, $itemid); } /** * Returns the HTML code displaying the preview of the grading form * * Plugins are forced to override this. Ideally they should delegate * the task to their own renderer. * * @param moodle_page $page the target page * @return string */ abstract public function render_preview(moodle_page $page); /** * Deletes the form definition and all the associated data * * @see delete_plugin_definition() * @return void */ public function delete_definition() { global $DB; if (!$this->is_form_defined()) { // nothing to do return; } // firstly, let the plugin delete everything from their own tables $this->delete_plugin_definition(); // then, delete all instances left $DB->delete_records('grading_instances', array('definitionid' => $this->definition->id)); // finally, delete the main definition record $DB->delete_records('grading_definitions', array('id' => $this->definition->id)); $this->definition = false; } /** * Prepare the part of the search query to append to the FROM statement * * @param string $gdid the alias of grading_definitions.id column used by the caller * @return string */ public static function sql_search_from_tables($gdid) { return ''; } /** * Prepare the parts of the SQL WHERE statement to search for the given token * * The returned array cosists of the list of SQL comparions and the list of * respective parameters for the comparisons. The returned chunks will be joined * with other conditions using the OR operator. * * @param string $token token to search for * @return array */ public static function sql_search_where($token) { $subsql = array(); $params = array(); return array($subsql, $params); } // ////////////////////////////////////////////////////////////////////////// /** * Loads the form definition if it exists * * The default implementation just tries to load the record from the {grading_definitions} * table. The plugins are likely to override this with a more complex query that loads * all required data at once. */ protected function load_definition() { global $DB; $this->definition = $DB->get_record('grading_definitions', array( 'areaid' => $this->areaid, 'method' => $this->get_method_name()), '*', IGNORE_MISSING); } /** * Deletes all plugin data associated with the given form definiton * * @see delete_definition() */ abstract protected function delete_plugin_definition(); /** * Returns the name of the grading method plugin, eg 'rubric' * * @return string the name of the grading method plugin, eg 'rubric' * @see PARAM_PLUGIN */ protected function get_method_name() { if (preg_match('/^gradingform_([a-z][a-z0-9_]*[a-z0-9])_controller$/', get_class($this), $matches)) { return $matches[1]; } else { throw new coding_exception('Invalid class name'); } } /** * Returns html code to be included in student's feedback. * * @param moodle_page $page * @param int $itemid * @param array $gradinginfo result of function grade_get_grades if plugin want to use some of their info * @param string $defaultcontent default string to be returned if no active grading is found or for some reason can not be shown to a user * @param boolean $cangrade whether current user has capability to grade in this context * @return string */ public function render_grade($page, $itemid, $gradinginfo, $defaultcontent, $cangrade) { return $defaultcontent; } /** * Sets the range of grades used in this area. This is usually either range like 0-100 * or the scale where keys start from 1. * * Typically modules will call it: * $controller->set_grade_range(make_grades_menu($gradingtype), $gradingtype > 0); * Negative $gradingtype means that scale is used and the grade must be rounded * to the nearest int. Positive $gradingtype means that range 0..$gradingtype * is used for the grades and in this case grade does not have to be rounded. * * Sometimes modules always expect grade to be rounded (like mod_assign does). * * @param array $graderange array where first _key_ is the minimum grade and the * last key is the maximum grade. * @param bool $allowgradedecimals if decimal values are allowed as grades. */ public final function set_grade_range(array $graderange, $allowgradedecimals = false) { $this->graderange = $graderange; $this->allowgradedecimals = $allowgradedecimals; } /** * Returns the range of grades used in this area * * @return array */ public final function get_grade_range() { if (empty($this->graderange)) { return array(); } return $this->graderange; } /** * Returns if decimal values are allowed as grades * * @return bool */ public final function get_allow_grade_decimals() { return $this->allowgradedecimals; } /** * Overridden by sub classes that wish to make definition details available to web services. * When not overridden, only definition data common to all grading methods is made available. * When overriding, the return value should be an array containing one or more key/value pairs. * These key/value pairs should match the definition returned by the get_definition() function. * For examples, look at: * $gradingform_rubric_controller->get_external_definition_details() * $gradingform_guide_controller->get_external_definition_details() * @return array An array of one or more key/value pairs containing the external_multiple_structure/s * corresponding to the definition returned by $controller->get_definition() * @since Moodle 2.5 */ public static function get_external_definition_details() { return null; } /** * Overridden by sub classes that wish to make instance filling details available to web services. * When not overridden, only instance filling data common to all grading methods is made available. * When overriding, the return value should be an array containing one or more key/value pairs. * These key/value pairs should match the filling data returned by the get_<method>_filling() function * in the gradingform_instance subclass. * For examples, look at: * $gradingform_rubric_controller->get_external_instance_filling_details() * $gradingform_guide_controller->get_external_instance_filling_details() * * @return array An array of one or more key/value pairs containing the external_multiple_structure/s * corresponding to the definition returned by $gradingform_<method>_instance->get_<method>_filling() * @since Moodle 2.6 */ public static function get_external_instance_filling_details() { return null; } } /** * Class to manage one gradingform instance. * * Gradingform instance is created for each evaluation of a student, using advanced grading. * It is stored as an entry in the DB table gradingform_instance. * * One instance (usually the latest) has the status INSTANCE_STATUS_ACTIVE. Sometimes it may * happen that a teacher wants to change the definition when some students have already been * graded. In this case their instances change status to INSTANCE_STATUS_NEEDUPDATE. * * To support future use of AJAX for background saving of incomplete evaluations the * status INSTANCE_STATUS_INCOMPLETE is introduced. If 'Cancel' is pressed this entry * is deleted. * When grade is updated the previous active instance receives status INSTANCE_STATUS_ACTIVE. * * Advanced grading plugins must declare a class gradingform_xxxx_instance * extending this class and put it in lib.php in the plugin folder. * * The reference to an instance of this class is passed to an advanced grading form element * included in the grading form, so this class must implement functions for rendering * and validation of this form element. See {@link MoodleQuickForm_grading} * * @package core_grading * @copyright 2011 Marina Glancy * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * @category grading */ abstract class gradingform_instance { /** Valid istance status */ const INSTANCE_STATUS_ACTIVE = 1; /** The grade needs to be updated by grader (usually because of changes is grading method) */ const INSTANCE_STATUS_NEEDUPDATE = 2; /** The grader started grading but did clicked neither submit nor cancel */ const INSTANCE_STATUS_INCOMPLETE = 0; /** Grader re-graded the student and this is the status for previous grade stored as history */ const INSTANCE_STATUS_ARCHIVE = 3; /** @var stdClass record from table grading_instances */ protected $data; /** @var gradingform_controller link to the corresponding controller */ protected $controller; /** * Creates an instance * * @param gradingform_controller $controller * @param stdClass $data */ public function __construct($controller, $data) { $this->data = (object)$data; $this->controller = $controller; } /** * Creates a new empty instance in DB and mark its status as INCOMPLETE * * @param int $definitionid * @param int $raterid * @param int $itemid * @return int id of the created instance */ public static function create_new($definitionid, $raterid, $itemid) { global $DB; $instance = new stdClass(); $instance->definitionid = $definitionid; $instance->raterid = $raterid; $instance->itemid = $itemid; $instance->status = self::INSTANCE_STATUS_INCOMPLETE; $instance->timemodified = time(); $instance->feedbackformat = FORMAT_MOODLE; $instanceid = $DB->insert_record('grading_instances', $instance); return $instanceid; } /** * Duplicates the instance before editing (optionally substitutes raterid and/or itemid with * the specified values) * Plugins may want to override this function to copy data from additional tables as well * * @param int $raterid value for raterid in the duplicate * @param int $itemid value for itemid in the duplicate * @return int id of the new instance */ public function copy($raterid, $itemid) { global $DB; $data = (array)$this->data; // Cast to array to make a copy unset($data['id']); $data['raterid'] = $raterid; $data['itemid'] = $itemid; $data['timemodified'] = time(); $data['status'] = self::INSTANCE_STATUS_INCOMPLETE; $instanceid = $DB->insert_record('grading_instances', $data); return $instanceid; } /** * Returns the current (active or needupdate) instance for the same raterid and itemid as this * instance. This function is useful to find the status of the currently modified instance * * @return gradingform_instance */ public function get_current_instance() { if ($this->get_status() == self::INSTANCE_STATUS_ACTIVE || $this->get_status() == self::INSTANCE_STATUS_NEEDUPDATE) { return $this; } return $this->get_controller()->get_current_instance($this->data->raterid, $this->data->itemid); } /** * Returns the controller * * @return gradingform_controller */ public function get_controller() { return $this->controller; } /** * Returns the specified element from object $this->data * * @param string $key * @return mixed */ public function get_data($key) { if (isset($this->data->$key)) { return $this->data->$key; } return null; } /** * Returns instance id * * @return int */ public function get_id() { return $this->get_data('id'); } /** * Returns instance status * * @return int */ public function get_status() { return $this->get_data('status'); } /** * Marks the instance as ACTIVE and current active instance (if exists) as ARCHIVE */ protected function make_active() { global $DB; if ($this->data->status == self::INSTANCE_STATUS_ACTIVE) { // already active return; } if (empty($this->data->itemid)) { throw new coding_exception('You cannot mark active the grading instance without itemid'); } $currentid = $this->get_controller()->get_current_instance($this->data->raterid, $this->data->itemid, true); if ($currentid && $currentid != $this->get_id()) { $DB->update_record('grading_instances', array('id' => $currentid, 'status' => self::INSTANCE_STATUS_ARCHIVE)); } $DB->update_record('grading_instances', array('id' => $this->get_id(), 'status' => self::INSTANCE_STATUS_ACTIVE)); $this->data->status = self::INSTANCE_STATUS_ACTIVE; } /** * Deletes this (INCOMPLETE) instance from database. This function is invoked on cancelling the * grading form and/or during cron cleanup. * Plugins using additional tables must override this method to remove additional data. * Note that if the teacher just closes the window or presses 'Back' button of the browser, * this function is not invoked. */ public function cancel() { global $DB; // TODO MDL-31239 throw exception if status is not INSTANCE_STATUS_INCOMPLETE $DB->delete_records('grading_instances', array('id' => $this->get_id())); } /** * Updates the instance with the data received from grading form. This function may be * called via AJAX when grading is not yet completed, so it does not change the * status of the instance. * * @param array $elementvalue */ public function update($elementvalue) { global $DB; $newdata = new stdClass(); $newdata->id = $this->get_id(); $newdata->timemodified = time(); if (isset($elementvalue['itemid']) && $elementvalue['itemid'] != $this->data->itemid) { $newdata->itemid = $elementvalue['itemid']; } // TODO MDL-31087 also update: rawgrade, feedback, feedbackformat $DB->update_record('grading_instances', $newdata); foreach ($newdata as $key => $value) { $this->data->$key = $value; } } /** * Calculates the grade to be pushed to the gradebook * * Returned grade must be in range $this->get_controller()->get_grade_range() * Plugins must returned grade converted to int unless * $this->get_controller()->get_allow_grade_decimals() is true. * * @return float|int */ abstract public function get_grade(); /** * Determines whether the submitted form was empty. * * @param array $elementvalue value of element submitted from the form * @return boolean true if the form is empty */ public function is_empty_form($elementvalue) { return false; } /** * Removes the attempt from the gradingform_*_fillings table. * This function is not abstract as to not break plugins that might * use advanced grading. * @param array $data the attempt data */ public function clear_attempt($data) { // This function is empty because the way to clear a grade // attempt will be different depending on the grading method. return; } /** * Called when teacher submits the grading form: * updates the instance in DB, marks it as ACTIVE and returns the grade to be pushed to the gradebook. * $itemid must be specified here (it was not required when the instance was * created, because it might not existed in draft) * * @param array $elementvalue * @param int $itemid * @return int the grade on 0-100 scale */ public function submit_and_get_grade($elementvalue, $itemid) { $elementvalue['itemid'] = $itemid; if ($this->is_empty_form($elementvalue)) { $this->clear_attempt($elementvalue); $this->make_active(); return -1; } $this->update($elementvalue); $this->make_active(); return $this->get_grade(); } /** * Returns html for form element of type 'grading'. If there is a form input element * it must have the name $gradingformelement->getName(). * If there are more than one input elements they MUST be elements of array with * name $gradingformelement->getName(). * Example: {NAME}[myelement1], {NAME}[myelement2][sub1], {NAME}[myelement2][sub2], etc. * ( {NAME} is a shortcut for $gradingformelement->getName() ) * After submitting the form the value of $_POST[{NAME}] is passed to the functions * validate_grading_element() and submit_and_get_grade() * * Plugins may use $gradingformelement->getValue() to get the value passed on previous * form submit * * When forming html it is a plugin's responsibility to analyze flags * $gradingformelement->_flagFrozen and $gradingformelement->_persistantFreeze: * * (_flagFrozen == false) => form element is editable * * (_flagFrozen == false && _persistantFreeze == true) => form element is not editable * but all values are passed as hidden elements * * (_flagFrozen == false && _persistantFreeze == false) => form element is not editable * and no values are passed as hidden elements * * Plugins are welcome to use AJAX in the form element. But it is strongly recommended * that the grading only becomes active when teacher presses 'Submit' button (the * method submit_and_get_grade() is invoked) * * Also client-side JS validation may be implemented here * * @see MoodleQuickForm_grading in lib/form/grading.php * * @param moodle_page $page * @param MoodleQuickForm_grading $gradingformelement * @return string */ abstract function render_grading_element($page, $gradingformelement); /** * Server-side validation of the data received from grading form. * * @param mixed $elementvalue is the scalar or array received in $_POST * @return boolean true if the form data is validated and contains no errors */ public function validate_grading_element($elementvalue) { return true; } /** * Returns the error message displayed if validation failed. * If plugin wants to display custom message, the empty string should be returned here * and the custom message should be output in render_grading_element() * * Please note that in assignments grading in 2.2 the grading form is not validated * properly and this message is not being displayed. * * @see validate_grading_element() * @return string */ public function default_validation_error_message() { return ''; } } grading/form/guide/lang/en/gradingform_guide.php 0000604 00000015256 15062070556 0015742 0 ustar 00 <?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/>. /** * Strings for the marking guide advanced grading plugin * * @package gradingform_guide * @copyright 2012 Dan Marsden <dan@danmarsden.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); $string['addcomment'] = 'Add frequently used comment'; $string['additionalcomments'] = 'Additional comments'; $string['additionalcommentsforcriterion'] = 'Additional comments for criterion, {$a}'; $string['addcriterion'] = 'Add criterion'; $string['alwaysshowdefinition'] = 'Show guide definition to students'; $string['backtoediting'] = 'Back to editing'; $string['clicktocopy'] = 'Click to copy this text into the criteria feedback'; $string['clicktoedit'] = 'Click to edit'; $string['clicktoeditname'] = 'Click to edit criterion name'; $string['comment'] = 'Comment'; $string['commentpickerforcriterion'] = 'Frequently used comments picker for {$a} additional comments'; $string['comments'] = 'Frequently used comments'; $string['commentsdelete'] = 'Delete comment'; $string['commentsempty'] = 'Click to edit comment'; $string['commentsmovedown'] = 'Move down'; $string['commentsmoveup'] = 'Move up'; $string['confirmdeletecriterion'] = 'Are you sure you want to delete this item?'; $string['confirmdeletelevel'] = 'Are you sure you want to delete this level?'; $string['criterion'] = 'Criterion name'; $string['criteriondelete'] = 'Delete criterion'; $string['criterionempty'] = 'Click to edit criterion'; $string['criterionmovedown'] = 'Move down'; $string['criterionmoveup'] = 'Move up'; $string['criterionname'] = 'Criterion name'; $string['criterionremark'] = '{$a} criterion remark'; $string['definemarkingguide'] = 'Define marking guide'; $string['description'] = 'Description'; $string['descriptionmarkers'] = 'Description for Markers'; $string['descriptionstudents'] = 'Description for students'; $string['err_maxscoreisnegative'] = 'The max score is not valid, negative values are not allowed'; $string['err_maxscorenotnumeric'] = 'Criterion max score must be numeric'; $string['err_nocomment'] = 'Comment can not be empty'; $string['err_nodescription'] = 'Student description can not be empty'; $string['err_nodescriptionmarkers'] = 'Marker description can not be empty'; $string['err_nomaxscore'] = 'Criterion max score can not be empty'; $string['err_noshortname'] = 'Criterion name can not be empty'; $string['err_shortnametoolong'] = 'Criterion name must be less than 256 characters'; $string['err_scoreinvalid'] = 'The score given to \'{$a->criterianame}\' is not valid, the max score is: {$a->maxscore}'; $string['err_scoreisnegative'] = 'The score given to \'{$a->criterianame}\' is not valid, negative values are not allowed'; $string['gradingof'] = '{$a} grading'; $string['guide'] = 'Marking guide'; $string['guidemappingexplained'] = 'WARNING: Your marking guide has a maximum grade of <b>{$a->maxscore} points</b> but the maximum grade set in your activity is {$a->modulegrade} The maximum score set in your marking guide will be scaled to the maximum grade in the module.<br /> Intermediate scores will be converted respectively and rounded to the nearest available grade.'; $string['guidenotcompleted'] = 'Please provide a valid grade for each criterion'; $string['guideoptions'] = 'Marking guide options'; $string['guidestatus'] = 'Current marking guide status'; $string['hidemarkerdesc'] = 'Hide marker criterion descriptions'; $string['hidestudentdesc'] = 'Hide student criterion descriptions'; $string['informationforcriterion'] = '{$a} information'; $string['insertcomment'] = 'Insert frequently used comment'; $string['maxscore'] = 'Maximum score'; $string['name'] = 'Name'; $string['needregrademessage'] = 'The marking guide definition was changed after this student had been graded. The student can not see this marking guide until you check the marking guide and update the grade.'; $string['outof'] = 'Score out of {$a}'; $string['pluginname'] = 'Marking guide'; $string['previewmarkingguide'] = 'Preview marking guide'; $string['privacy:metadata:criterionid'] = 'An identifier to a criterion for advanced marking.'; $string['privacy:metadata:fillingssummary'] = 'Stores information about a user\'s grade and feedback for the marking guide.'; $string['privacy:metadata:instanceid'] = 'An identifier to a grade used by an activity.'; $string['privacy:metadata:preference:showmarkerdesc'] = 'Whether to show marker criterion descriptions'; $string['privacy:metadata:preference:showstudentdesc'] = 'Whether to show student criterion descriptions'; $string['privacy:metadata:remark'] = 'Remarks related to this grade criterion.'; $string['privacy:metadata:score'] = 'A score for this grade criterion.'; $string['regrademessage1'] = 'You are about to save changes to a marking guide that has already been used for grading. Please indicate if existing grades need to be reviewed. If you set this then the marking guide will be hidden from students until their item is regraded.'; $string['regrademessage5'] = 'You are about to save significant changes to a marking guide that has already been used for grading. The gradebook value will be unchanged, but the marking guide will be hidden from students until their item is regraded.'; $string['regradeoption0'] = 'Do not mark for regrade'; $string['regradeoption1'] = 'Mark for regrade'; $string['remark_help'] = 'Enter any additional comments about this criterion.'; $string['restoredfromdraft'] = 'NOTE: The last attempt to grade this person was not saved properly so draft grades have been restored. If you want to cancel these changes use the \'Cancel\' button below.'; $string['save'] = 'Save'; $string['saveguide'] = 'Save marking guide and make it ready'; $string['saveguidedraft'] = 'Save as draft'; $string['score'] = 'score'; $string['scoreforcriterion'] = '{$a} score'; $string['score_help'] = 'Enter a score for {$a->criterion} between 0 and {$a->maxscore}.'; $string['showmarkerdesc'] = 'Show marker criterion descriptions'; $string['showmarkspercriterionstudents'] = 'Show marks per criterion to students'; $string['showstudentdesc'] = 'Show student criterion descriptions'; grading/form/guide/amd/build/comment_chooser.min.js 0000604 00000004014 15062070556 0016364 0 ustar 00 /** * AMD code for the frequently used comments chooser for the marking guide grading form. * * @module gradingform_guide/comment_chooser * @copyright 2015 Jun Pataleta <jun@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ define("gradingform_guide/comment_chooser",["jquery","core/templates","core/notification","core/yui"],(function($,templates,notification){return{initialise:function(criterionId,buttonId,remarkId,commentOptions){function generateCommentsChooser(){var context={criterionId:criterionId,comments:commentOptions};templates.render("gradingform_guide/comment_chooser",context).done((function(compiledSource){!function(compiledSource,comments){var titleLabel="<label>"+M.util.get_string("insertcomment","gradingform_guide")+"</label>",cancelButtonId="comment-chooser-"+criterionId+"-cancel",cancelButton='<button id="'+cancelButtonId+'">'+M.util.get_string("cancel","moodle")+"</button>",chooserDialog=new M.core.dialogue({modal:!0,headerContent:titleLabel,bodyContent:compiledSource,footerContent:cancelButton,focusAfterHide:"#"+remarkId,id:"comments-chooser-dialog-"+criterionId});$("#"+cancelButtonId).click((function(){chooserDialog.hide()})),$.each(comments,(function(index,comment){var commentOptionId="#comment-option-"+criterionId+"-"+comment.id;$(commentOptionId).click((function(){var remarkTextArea=$("#"+remarkId),remarkText=remarkTextArea.val();""!==remarkText.trim()&&(remarkText+="\n"),remarkText+=comment.description,remarkTextArea.val(remarkText),chooserDialog.hide()})),$(document).off("keypress",commentOptionId).on("keypress",commentOptionId,(function(){var keyCode=event.which||event.keyCode;13!=keyCode&&32!=keyCode||$(commentOptionId).click()}))})),chooserDialog.after("visibleChange",(function(e){e.prevVal&&!e.newVal&&this.destroy()}),chooserDialog),chooserDialog.show()}(compiledSource,commentOptions)})).fail(notification.exception)}$("#"+buttonId).click((function(e){e.preventDefault(),generateCommentsChooser()}))}}})); //# sourceMappingURL=comment_chooser.min.js.map grading/form/guide/amd/build/comment_chooser.min.js.map 0000604 00000020006 15062070556 0017137 0 ustar 00 {"version":3,"file":"comment_chooser.min.js","sources":["../src/comment_chooser.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * AMD code for the frequently used comments chooser for the marking guide grading form.\n *\n * @module gradingform_guide/comment_chooser\n * @copyright 2015 Jun Pataleta <jun@moodle.com>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\ndefine(['jquery', 'core/templates', 'core/notification', 'core/yui'], function($, templates, notification) {\n\n // Private variables and functions.\n\n return /** @alias module:gradingform_guide/comment_chooser */ {\n // Public variables and functions.\n /**\n * Initialises the module.\n *\n * Basically, it performs the binding and handling of the button click event for\n * the 'Insert frequently used comment' button.\n *\n * @param {Integer} criterionId The criterion ID.\n * @param {String} buttonId The element ID of the button which the handler will be bound to.\n * @param {String} remarkId The element ID of the remark text area where the text of the selected comment will be copied to.\n * @param {Array} commentOptions The array of frequently used comments to be used as options.\n */\n initialise: function(criterionId, buttonId, remarkId, commentOptions) {\n /**\n * Display the chooser dialog using the compiled HTML from the mustache template\n * and binds onclick events for the generated comment options.\n *\n * @param {String} compiledSource The compiled HTML from the mustache template\n * @param {Array} comments Array containing comments.\n */\n function displayChooserDialog(compiledSource, comments) {\n var titleLabel = '<label>' + M.util.get_string('insertcomment', 'gradingform_guide') + '</label>';\n var cancelButtonId = 'comment-chooser-' + criterionId + '-cancel';\n var cancelButton = '<button id=\"' + cancelButtonId + '\">' + M.util.get_string('cancel', 'moodle') + '</button>';\n\n // Set dialog's body content.\n var chooserDialog = new M.core.dialogue({\n modal: true,\n headerContent: titleLabel,\n bodyContent: compiledSource,\n footerContent: cancelButton,\n focusAfterHide: '#' + remarkId,\n id: \"comments-chooser-dialog-\" + criterionId\n });\n\n // Bind click event to the cancel button.\n $(\"#\" + cancelButtonId).click(function() {\n chooserDialog.hide();\n });\n\n // Loop over each comment item and bind click events.\n $.each(comments, function(index, comment) {\n var commentOptionId = '#comment-option-' + criterionId + '-' + comment.id;\n\n // Delegate click event for the generated option link.\n $(commentOptionId).click(function() {\n var remarkTextArea = $('#' + remarkId);\n var remarkText = remarkTextArea.val();\n\n // Add line break if the current value of the remark text is not empty.\n if (remarkText.trim() !== '') {\n remarkText += '\\n';\n }\n remarkText += comment.description;\n\n remarkTextArea.val(remarkText);\n\n chooserDialog.hide();\n });\n\n // Handle keypress on list items.\n $(document).off('keypress', commentOptionId).on('keypress', commentOptionId, function() {\n var keyCode = event.which || event.keyCode;\n\n // Enter or space key.\n if (keyCode == 13 || keyCode == 32) {\n // Trigger click event.\n $(commentOptionId).click();\n }\n });\n });\n\n // Destroy the dialog when it is hidden to allow the grading section to\n // be loaded as a fragment multiple times within the same page.\n chooserDialog.after('visibleChange', function(e) {\n // Going from visible to hidden.\n if (e.prevVal && !e.newVal) {\n this.destroy();\n }\n }, chooserDialog);\n\n // Show dialog.\n chooserDialog.show();\n }\n\n /**\n * Generates the comments chooser dialog from the grading_form/comment_chooser mustache template.\n */\n function generateCommentsChooser() {\n // Template context.\n var context = {\n criterionId: criterionId,\n comments: commentOptions\n };\n\n // Render the template and display the comment chooser dialog.\n templates.render('gradingform_guide/comment_chooser', context)\n .done(function(compiledSource) {\n displayChooserDialog(compiledSource, commentOptions);\n })\n .fail(notification.exception);\n }\n\n // Bind click event for the comments chooser button.\n $(\"#\" + buttonId).click(function(e) {\n e.preventDefault();\n generateCommentsChooser();\n });\n }\n };\n});\n"],"names":["define","$","templates","notification","initialise","criterionId","buttonId","remarkId","commentOptions","generateCommentsChooser","context","comments","render","done","compiledSource","titleLabel","M","util","get_string","cancelButtonId","cancelButton","chooserDialog","core","dialogue","modal","headerContent","bodyContent","footerContent","focusAfterHide","id","click","hide","each","index","comment","commentOptionId","remarkTextArea","remarkText","val","trim","description","document","off","on","keyCode","event","which","after","e","prevVal","newVal","destroy","show","displayChooserDialog","fail","exception","preventDefault"],"mappings":";;;;;;;AAsBAA,2CAAO,CAAC,SAAU,iBAAkB,oBAAqB,aAAa,SAASC,EAAGC,UAAWC,oBAI3B,CAa1DC,WAAY,SAASC,YAAaC,SAAUC,SAAUC,yBA4EzCC,8BAEDC,QAAU,CACVL,YAAaA,YACbM,SAAUH,gBAIdN,UAAUU,OAAO,oCAAqCF,SACjDG,MAAK,SAASC,0BA7EOA,eAAgBH,cACtCI,WAAa,UAAYC,EAAEC,KAAKC,WAAW,gBAAiB,qBAAuB,WACnFC,eAAiB,mBAAqBd,YAAc,UACpDe,aAAe,eAAiBD,eAAiB,KAAOH,EAAEC,KAAKC,WAAW,SAAU,UAAY,YAGhGG,cAAgB,IAAIL,EAAEM,KAAKC,SAAS,CACpCC,OAAO,EACPC,cAAeV,WACfW,YAAaZ,eACba,cAAeP,aACfQ,eAAgB,IAAMrB,SACtBsB,GAAI,2BAA6BxB,cAIrCJ,EAAE,IAAMkB,gBAAgBW,OAAM,WAC1BT,cAAcU,UAIlB9B,EAAE+B,KAAKrB,UAAU,SAASsB,MAAOC,aACzBC,gBAAkB,mBAAqB9B,YAAc,IAAM6B,QAAQL,GAGvE5B,EAAEkC,iBAAiBL,OAAM,eACjBM,eAAiBnC,EAAE,IAAMM,UACzB8B,WAAaD,eAAeE,MAGN,KAAtBD,WAAWE,SACXF,YAAc,MAElBA,YAAcH,QAAQM,YAEtBJ,eAAeE,IAAID,YAEnBhB,cAAcU,UAIlB9B,EAAEwC,UAAUC,IAAI,WAAYP,iBAAiBQ,GAAG,WAAYR,iBAAiB,eACrES,QAAUC,MAAMC,OAASD,MAAMD,QAGpB,IAAXA,SAA4B,IAAXA,SAEjB3C,EAAEkC,iBAAiBL,cAO/BT,cAAc0B,MAAM,iBAAiB,SAASC,GAEtCA,EAAEC,UAAYD,EAAEE,aACXC,YAEV9B,eAGHA,cAAc+B,OAgBNC,CAAqBvC,eAAgBN,mBAExC8C,KAAKnD,aAAaoD,WAI3BtD,EAAE,IAAMK,UAAUwB,OAAM,SAASkB,GAC7BA,EAAEQ,iBACF/C"} grading/form/guide/amd/build/grades/grader/gradingpanel.min.js 0000604 00000002635 15062070556 0020353 0 ustar 00 define("gradingform_guide/grades/grader/gradingpanel",["exports","core/ajax","core_grades/grades/grader/gradingpanel/normalise","core_grades/grades/grader/gradingpanel/comparison","jquery"],(function(_exports,_ajax,_normalise,_comparison,_jquery){var obj; /** * Grading panel for gradingform_guide. * * @module gradingform_guide/grades/grader/gradingpanel * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.storeCurrentGrade=_exports.fetchCurrentGrade=void 0,_jquery=(obj=_jquery)&&obj.__esModule?obj:{default:obj};_exports.fetchCurrentGrade=(component,contextid,itemname,gradeduserid)=>(0,_ajax.call)([{methodname:"gradingform_guide_grader_gradingpanel_fetch",args:{component:component,contextid:contextid,itemname:itemname,gradeduserid:gradeduserid}}])[0];_exports.storeCurrentGrade=async(component,contextid,itemname,gradeduserid,notifyUser,rootNode)=>{const form=rootNode.querySelector("form");return!0===(0,_comparison.compareData)(form)?(0,_normalise.normaliseResult)(await(0,_ajax.call)([{methodname:"gradingform_guide_grader_gradingpanel_store",args:{component:component,contextid:contextid,itemname:itemname,gradeduserid:gradeduserid,notifyuser:notifyUser,formdata:(0,_jquery.default)(form).serialize()}}])[0]):""}})); //# sourceMappingURL=gradingpanel.min.js.map grading/form/guide/amd/build/grades/grader/gradingpanel/comments.min.js 0000604 00000002024 15062070556 0022170 0 ustar 00 define("gradingform_guide/grades/grader/gradingpanel/comments",["exports","./comments/selectors"],(function(_exports,_selectors){var obj; /** * Grading panel frequently used comments selector. * * @module gradingform_guide/grades/grader/gradingpanel/comments * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.init=void 0,_selectors=(obj=_selectors)&&obj.__esModule?obj:{default:obj};_exports.init=rootId=>{document.querySelector("#".concat(rootId)).addEventListener("click",(e=>{if(!e.target.matches(_selectors.default.frequentComment))return;e.preventDefault();const clicked=e.target.closest(_selectors.default.frequentComment),remark=clicked.closest(_selectors.default.criterion).querySelector(_selectors.default.remark);remark&&(remark.value.trim()?remark.value+="\n".concat(clicked.innerHTML):remark.value+=clicked.innerHTML)}))}})); //# sourceMappingURL=comments.min.js.map grading/form/guide/amd/build/grades/grader/gradingpanel/comments/selectors.min.js 0000604 00000000673 15062070556 0024203 0 ustar 00 define("gradingform_guide/grades/grader/gradingpanel/comments/selectors",["exports"],(function(_exports){Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.default=void 0;return _exports.default={frequentComment:'[data-gradingform_guide-role="frequent-comment"]',criterion:'[data-gradingform-guide-role="criterion"]',remark:'[data-gradingform-guide-role="remark"]'},_exports.default})); //# sourceMappingURL=selectors.min.js.map grading/form/guide/amd/build/grades/grader/gradingpanel/comments/selectors.min.js.map 0000604 00000002672 15062070556 0024760 0 ustar 00 {"version":3,"file":"selectors.min.js","sources":["../../../../../src/grades/grader/gradingpanel/comments/selectors.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Define all of the selectors we will be using on the Marking Guide interface.\n *\n * @module gradingform_guide/grades/grader/gradingpanel/comments/selectors\n * @copyright 2019 Mathew May <mathew.solutions>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\nexport default {\n frequentComment: '[data-gradingform_guide-role=\"frequent-comment\"]',\n criterion: '[data-gradingform-guide-role=\"criterion\"]',\n remark: '[data-gradingform-guide-role=\"remark\"]',\n};\n"],"names":["frequentComment","criterion","remark"],"mappings":"iNAsBe,CACXA,gBAAiB,mDACjBC,UAAW,4CACXC,OAAQ"} grading/form/guide/amd/build/grades/grader/gradingpanel/comments.min.js.map 0000604 00000004755 15062070556 0022761 0 ustar 00 {"version":3,"file":"comments.min.js","sources":["../../../../src/grades/grader/gradingpanel/comments.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Grading panel frequently used comments selector.\n *\n * @module gradingform_guide/grades/grader/gradingpanel/comments\n * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport Selectors from './comments/selectors';\n\n/**\n * Manage the frequently used comments in the Marking Guide form.\n *\n * @param {String} rootId\n */\nexport const init = (rootId) => {\n const rootNode = document.querySelector(`#${rootId}`);\n\n rootNode.addEventListener('click', (e) => {\n if (!e.target.matches(Selectors.frequentComment)) {\n return;\n }\n\n e.preventDefault();\n\n const clicked = e.target.closest(Selectors.frequentComment);\n const criterion = clicked.closest(Selectors.criterion);\n const remark = criterion.querySelector(Selectors.remark);\n\n if (!remark) {\n return;\n }\n\n // Either append the comment to an existing comment or set it as the comment.\n if (remark.value.trim()) {\n remark.value += `\\n${clicked.innerHTML}`;\n } else {\n remark.value += clicked.innerHTML;\n }\n });\n};\n"],"names":["rootId","document","querySelector","addEventListener","e","target","matches","Selectors","frequentComment","preventDefault","clicked","closest","remark","criterion","value","trim","innerHTML"],"mappings":";;;;;;;8JA8BqBA,SACAC,SAASC,yBAAkBF,SAEnCG,iBAAiB,SAAUC,QAC3BA,EAAEC,OAAOC,QAAQC,mBAAUC,wBAIhCJ,EAAEK,uBAEIC,QAAUN,EAAEC,OAAOM,QAAQJ,mBAAUC,iBAErCI,OADYF,QAAQC,QAAQJ,mBAAUM,WACnBX,cAAcK,mBAAUK,QAE5CA,SAKDA,OAAOE,MAAMC,OACbH,OAAOE,mBAAcJ,QAAQM,WAE7BJ,OAAOE,OAASJ,QAAQM"} grading/form/guide/amd/build/grades/grader/gradingpanel.min.js.map 0000604 00000006665 15062070556 0021136 0 ustar 00 {"version":3,"file":"gradingpanel.min.js","sources":["../../../src/grades/grader/gradingpanel.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Grading panel for gradingform_guide.\n *\n * @module gradingform_guide/grades/grader/gradingpanel\n * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport {call as fetchMany} from 'core/ajax';\nimport {normaliseResult} from 'core_grades/grades/grader/gradingpanel/normalise';\nimport {compareData} from 'core_grades/grades/grader/gradingpanel/comparison';\n\n// Note: We use jQuery.serializer here until we can rewrite Ajax to use XHR.send()\nimport jQuery from 'jquery';\n\n/**\n * For a given component, contextid, itemname & gradeduserid we can fetch the currently assigned grade.\n *\n * @param {String} component\n * @param {Number} contextid\n * @param {String} itemname\n * @param {Number} gradeduserid\n *\n * @returns {Promise}\n */\nexport const fetchCurrentGrade = (component, contextid, itemname, gradeduserid) => {\n return fetchMany([{\n methodname: `gradingform_guide_grader_gradingpanel_fetch`,\n args: {\n component,\n contextid,\n itemname,\n gradeduserid,\n },\n }])[0];\n};\n\n/**\n * For a given component, contextid, itemname & gradeduserid we can store the currently assigned grade in a given form.\n *\n * @param {String} component\n * @param {Number} contextid\n * @param {String} itemname\n * @param {Number} gradeduserid\n * @param {Boolean} notifyUser\n * @param {HTMLElement} rootNode\n *\n * @returns {Promise}\n */\nexport const storeCurrentGrade = async(component, contextid, itemname, gradeduserid, notifyUser, rootNode) => {\n const form = rootNode.querySelector('form');\n\n if (compareData(form) === true) {\n return normaliseResult(await fetchMany([{\n methodname: `gradingform_guide_grader_gradingpanel_store`,\n args: {\n component,\n contextid,\n itemname,\n gradeduserid,\n notifyuser: notifyUser,\n formdata: jQuery(form).serialize(),\n },\n }])[0]);\n } else {\n return '';\n }\n};\n"],"names":["component","contextid","itemname","gradeduserid","methodname","args","async","notifyUser","rootNode","form","querySelector","notifyuser","formdata","serialize"],"mappings":";;;;;;;6MAwCiC,CAACA,UAAWC,UAAWC,SAAUC,gBACvD,cAAU,CAAC,CACdC,yDACAC,KAAM,CACFL,UAAAA,UACAC,UAAAA,UACAC,SAAAA,SACAC,aAAAA,iBAEJ,8BAeyBG,MAAMN,UAAWC,UAAWC,SAAUC,aAAcI,WAAYC,kBACvFC,KAAOD,SAASE,cAAc,eAEV,KAAtB,2BAAYD,OACL,oCAAsB,cAAU,CAAC,CACpCL,yDACAC,KAAM,CACFL,UAAAA,UACAC,UAAAA,UACAC,SAAAA,SACAC,aAAAA,aACAQ,WAAYJ,WACZK,UAAU,mBAAOH,MAAMI,gBAE3B,IAEG"} grading/form/guide/amd/src/grades/grader/gradingpanel/comments.js 0000604 00000003517 15062070556 0021106 0 ustar 00 // 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/>. /** * Grading panel frequently used comments selector. * * @module gradingform_guide/grades/grader/gradingpanel/comments * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import Selectors from './comments/selectors'; /** * Manage the frequently used comments in the Marking Guide form. * * @param {String} rootId */ export const init = (rootId) => { const rootNode = document.querySelector(`#${rootId}`); rootNode.addEventListener('click', (e) => { if (!e.target.matches(Selectors.frequentComment)) { return; } e.preventDefault(); const clicked = e.target.closest(Selectors.frequentComment); const criterion = clicked.closest(Selectors.criterion); const remark = criterion.querySelector(Selectors.remark); if (!remark) { return; } // Either append the comment to an existing comment or set it as the comment. if (remark.value.trim()) { remark.value += `\n${clicked.innerHTML}`; } else { remark.value += clicked.innerHTML; } }); }; grading/form/guide/amd/src/grades/grader/gradingpanel/comments/selectors.js 0000604 00000002237 15062070556 0023107 0 ustar 00 // 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/>. /** * Define all of the selectors we will be using on the Marking Guide interface. * * @module gradingform_guide/grades/grader/gradingpanel/comments/selectors * @copyright 2019 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ export default { frequentComment: '[data-gradingform_guide-role="frequent-comment"]', criterion: '[data-gradingform-guide-role="criterion"]', remark: '[data-gradingform-guide-role="remark"]', }; grading/form/guide/amd/src/grades/grader/gradingpanel.js 0000604 00000005321 15062070556 0017254 0 ustar 00 // 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/>. /** * Grading panel for gradingform_guide. * * @module gradingform_guide/grades/grader/gradingpanel * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import {call as fetchMany} from 'core/ajax'; import {normaliseResult} from 'core_grades/grades/grader/gradingpanel/normalise'; import {compareData} from 'core_grades/grades/grader/gradingpanel/comparison'; // Note: We use jQuery.serializer here until we can rewrite Ajax to use XHR.send() import jQuery from 'jquery'; /** * For a given component, contextid, itemname & gradeduserid we can fetch the currently assigned grade. * * @param {String} component * @param {Number} contextid * @param {String} itemname * @param {Number} gradeduserid * * @returns {Promise} */ export const fetchCurrentGrade = (component, contextid, itemname, gradeduserid) => { return fetchMany([{ methodname: `gradingform_guide_grader_gradingpanel_fetch`, args: { component, contextid, itemname, gradeduserid, }, }])[0]; }; /** * For a given component, contextid, itemname & gradeduserid we can store the currently assigned grade in a given form. * * @param {String} component * @param {Number} contextid * @param {String} itemname * @param {Number} gradeduserid * @param {Boolean} notifyUser * @param {HTMLElement} rootNode * * @returns {Promise} */ export const storeCurrentGrade = async(component, contextid, itemname, gradeduserid, notifyUser, rootNode) => { const form = rootNode.querySelector('form'); if (compareData(form) === true) { return normaliseResult(await fetchMany([{ methodname: `gradingform_guide_grader_gradingpanel_store`, args: { component, contextid, itemname, gradeduserid, notifyuser: notifyUser, formdata: jQuery(form).serialize(), }, }])[0]); } else { return ''; } }; grading/form/guide/amd/src/comment_chooser.js 0000604 00000014102 15062070556 0015271 0 ustar 00 // 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/>. /** * AMD code for the frequently used comments chooser for the marking guide grading form. * * @module gradingform_guide/comment_chooser * @copyright 2015 Jun Pataleta <jun@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ define(['jquery', 'core/templates', 'core/notification', 'core/yui'], function($, templates, notification) { // Private variables and functions. return /** @alias module:gradingform_guide/comment_chooser */ { // Public variables and functions. /** * Initialises the module. * * Basically, it performs the binding and handling of the button click event for * the 'Insert frequently used comment' button. * * @param {Integer} criterionId The criterion ID. * @param {String} buttonId The element ID of the button which the handler will be bound to. * @param {String} remarkId The element ID of the remark text area where the text of the selected comment will be copied to. * @param {Array} commentOptions The array of frequently used comments to be used as options. */ initialise: function(criterionId, buttonId, remarkId, commentOptions) { /** * Display the chooser dialog using the compiled HTML from the mustache template * and binds onclick events for the generated comment options. * * @param {String} compiledSource The compiled HTML from the mustache template * @param {Array} comments Array containing comments. */ function displayChooserDialog(compiledSource, comments) { var titleLabel = '<label>' + M.util.get_string('insertcomment', 'gradingform_guide') + '</label>'; var cancelButtonId = 'comment-chooser-' + criterionId + '-cancel'; var cancelButton = '<button id="' + cancelButtonId + '">' + M.util.get_string('cancel', 'moodle') + '</button>'; // Set dialog's body content. var chooserDialog = new M.core.dialogue({ modal: true, headerContent: titleLabel, bodyContent: compiledSource, footerContent: cancelButton, focusAfterHide: '#' + remarkId, id: "comments-chooser-dialog-" + criterionId }); // Bind click event to the cancel button. $("#" + cancelButtonId).click(function() { chooserDialog.hide(); }); // Loop over each comment item and bind click events. $.each(comments, function(index, comment) { var commentOptionId = '#comment-option-' + criterionId + '-' + comment.id; // Delegate click event for the generated option link. $(commentOptionId).click(function() { var remarkTextArea = $('#' + remarkId); var remarkText = remarkTextArea.val(); // Add line break if the current value of the remark text is not empty. if (remarkText.trim() !== '') { remarkText += '\n'; } remarkText += comment.description; remarkTextArea.val(remarkText); chooserDialog.hide(); }); // Handle keypress on list items. $(document).off('keypress', commentOptionId).on('keypress', commentOptionId, function() { var keyCode = event.which || event.keyCode; // Enter or space key. if (keyCode == 13 || keyCode == 32) { // Trigger click event. $(commentOptionId).click(); } }); }); // Destroy the dialog when it is hidden to allow the grading section to // be loaded as a fragment multiple times within the same page. chooserDialog.after('visibleChange', function(e) { // Going from visible to hidden. if (e.prevVal && !e.newVal) { this.destroy(); } }, chooserDialog); // Show dialog. chooserDialog.show(); } /** * Generates the comments chooser dialog from the grading_form/comment_chooser mustache template. */ function generateCommentsChooser() { // Template context. var context = { criterionId: criterionId, comments: commentOptions }; // Render the template and display the comment chooser dialog. templates.render('gradingform_guide/comment_chooser', context) .done(function(compiledSource) { displayChooserDialog(compiledSource, commentOptions); }) .fail(notification.exception); } // Bind click event for the comments chooser button. $("#" + buttonId).click(function(e) { e.preventDefault(); generateCommentsChooser(); }); } }; }); grading/form/guide/classes/grades/grader/gradingpanel/external/store.php 0000604 00000014315 15062070556 0022515 0 ustar 00 <?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/>. /** * Web services relating to fetching of a marking guide for the grading panel. * * @package gradingform_guide * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ declare(strict_types = 1); namespace gradingform_guide\grades\grader\gradingpanel\external; global $CFG; use coding_exception; use context; use core_grades\component_gradeitem as gradeitem; use core_grades\component_gradeitems; use core_user; use core_external\external_api; use core_external\external_function_parameters; use core_external\external_single_structure; use core_external\external_value; use moodle_exception; require_once($CFG->dirroot.'/grade/grading/form/guide/lib.php'); /** * Web services relating to storing of a marking guide for the grading panel. * * @package gradingform_guide * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class store extends external_api { /** * Describes the parameters for storing the grading panel for a simple grade. * * @return external_function_parameters * @since Moodle 3.8 */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters ([ 'component' => new external_value( PARAM_ALPHANUMEXT, 'The name of the component', VALUE_REQUIRED ), 'contextid' => new external_value( PARAM_INT, 'The ID of the context being graded', VALUE_REQUIRED ), 'itemname' => new external_value( PARAM_ALPHANUM, 'The grade item itemname being graded', VALUE_REQUIRED ), 'gradeduserid' => new external_value( PARAM_INT, 'The ID of the user show', VALUE_REQUIRED ), 'notifyuser' => new external_value( PARAM_BOOL, 'Wheteher to notify the user or not', VALUE_DEFAULT, false ), 'formdata' => new external_value( PARAM_RAW, 'The serialised form data representing the grade', VALUE_REQUIRED ), ]); } /** * Fetch the data required to build a grading panel for a simple grade. * * @param string $component * @param int $contextid * @param string $itemname * @param int $gradeduserid * @param bool $notifyuser * @param string $formdata * * @return array * @throws \dml_exception * @throws \invalid_parameter_exception * @throws \restricted_context_exception * @throws coding_exception * @throws moodle_exception * @since Moodle 3.8 */ public static function execute(string $component, int $contextid, string $itemname, int $gradeduserid, bool $notifyuser, string $formdata): array { global $USER; [ 'component' => $component, 'contextid' => $contextid, 'itemname' => $itemname, 'gradeduserid' => $gradeduserid, 'notifyuser' => $notifyuser, 'formdata' => $formdata, ] = self::validate_parameters(self::execute_parameters(), [ 'component' => $component, 'contextid' => $contextid, 'itemname' => $itemname, 'gradeduserid' => $gradeduserid, 'notifyuser' => $notifyuser, 'formdata' => $formdata, ]); // Validate the context. $context = context::instance_by_id($contextid); self::validate_context($context); // Validate that the supplied itemname is a gradable item. if (!component_gradeitems::is_valid_itemname($component, $itemname)) { throw new coding_exception("The '{$itemname}' item is not valid for the '{$component}' component"); } // Fetch the gradeitem instance. $gradeitem = gradeitem::instance($component, $context, $itemname); // Validate that this gradeitem is actually enabled. if (!$gradeitem->is_grading_enabled()) { throw new moodle_exception("Grading is not enabled for {$itemname} in this context"); } // Fetch the record for the graded user. $gradeduser = core_user::get_user($gradeduserid); // Require that this user can save grades. $gradeitem->require_user_can_grade($gradeduser, $USER); if (MARKING_GUIDE !== $gradeitem->get_advanced_grading_method()) { throw new moodle_exception( "The {$itemname} item in {$component}/{$contextid} is not configured for advanced grading with a marking guide" ); } // Parse the serialised string into an object. $data = []; parse_str($formdata, $data); // Grade. $gradeitem->store_grade_from_formdata($gradeduser, $USER, (object) $data); // Notify. if ($notifyuser) { // Send notification. $gradeitem->send_student_notification($gradeduser, $USER); } return fetch::get_fetch_data($gradeitem, $gradeduser); } /** * Describes the data returned from the external function. * * @return external_single_structure * @since Moodle 3.8 */ public static function execute_returns(): external_single_structure { return fetch::execute_returns(); } } grading/form/guide/classes/grades/grader/gradingpanel/external/fetch.php 0000604 00000031315 15062070556 0022451 0 ustar 00 <?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/>. /** * Web services relating to fetching of a marking guide for the grading panel. * * @package gradingform_guide * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ declare(strict_types = 1); namespace gradingform_guide\grades\grader\gradingpanel\external; global $CFG; use coding_exception; use context; use core_user; use core_grades\component_gradeitem as gradeitem; use core_grades\component_gradeitems; use core_external\external_api; use core_external\external_function_parameters; use core_external\external_multiple_structure; use core_external\external_single_structure; use core_external\external_value; use core_external\external_warnings; use moodle_exception; use stdClass; require_once($CFG->dirroot.'/grade/grading/form/guide/lib.php'); /** * Web services relating to fetching of a marking guide for the grading panel. * * @package gradingform_guide * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class fetch extends external_api { /** * Describes the parameters for fetching the grading panel for a simple grade. * * @return external_function_parameters * @since Moodle 3.8 */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters ([ 'component' => new external_value( PARAM_ALPHANUMEXT, 'The name of the component', VALUE_REQUIRED ), 'contextid' => new external_value( PARAM_INT, 'The ID of the context being graded', VALUE_REQUIRED ), 'itemname' => new external_value( PARAM_ALPHANUM, 'The grade item itemname being graded', VALUE_REQUIRED ), 'gradeduserid' => new external_value( PARAM_INT, 'The ID of the user show', VALUE_REQUIRED ), ]); } /** * Fetch the data required to build a grading panel for a simple grade. * * @param string $component * @param int $contextid * @param string $itemname * @param int $gradeduserid * @return array * @throws \dml_exception * @throws \invalid_parameter_exception * @throws \restricted_context_exception * @throws coding_exception * @throws moodle_exception * @since Moodle 3.8 */ public static function execute(string $component, int $contextid, string $itemname, int $gradeduserid): array { global $CFG, $USER; require_once("{$CFG->libdir}/gradelib.php"); [ 'component' => $component, 'contextid' => $contextid, 'itemname' => $itemname, 'gradeduserid' => $gradeduserid, ] = self::validate_parameters(self::execute_parameters(), [ 'component' => $component, 'contextid' => $contextid, 'itemname' => $itemname, 'gradeduserid' => $gradeduserid, ]); // Validate the context. $context = context::instance_by_id($contextid); self::validate_context($context); // Validate that the supplied itemname is a gradable item. if (!component_gradeitems::is_valid_itemname($component, $itemname)) { throw new coding_exception("The '{$itemname}' item is not valid for the '{$component}' component"); } // Fetch the gradeitem instance. $gradeitem = gradeitem::instance($component, $context, $itemname); if (MARKING_GUIDE !== $gradeitem->get_advanced_grading_method()) { throw new moodle_exception( "The {$itemname} item in {$component}/{$contextid} is not configured for advanced grading with a marking guide" ); } // Fetch the actual data. $gradeduser = core_user::get_user($gradeduserid, '*', MUST_EXIST); // One can access its own grades. Others just if they're graders. if ($gradeduserid != $USER->id) { $gradeitem->require_user_can_grade($gradeduser, $USER); } return self::get_fetch_data($gradeitem, $gradeduser); } /** * Get the data to be fetched. * * @param gradeitem $gradeitem * @param stdClass $gradeduser * @return array */ public static function get_fetch_data(gradeitem $gradeitem, stdClass $gradeduser): array { global $USER; $hasgrade = $gradeitem->user_has_grade($gradeduser); $grade = $gradeitem->get_formatted_grade_for_user($gradeduser, $USER); $instance = $gradeitem->get_advanced_grading_instance($USER, $grade); if (!$instance) { throw new moodle_exception('error:gradingunavailable', 'grading'); } $controller = $instance->get_controller(); $definition = $controller->get_definition(); $fillings = $instance->get_guide_filling(); $context = $controller->get_context(); $definitionid = (int) $definition->id; // Set up some items we need to return on other interfaces. $gradegrade = \grade_grade::fetch(['itemid' => $gradeitem->get_grade_item()->id, 'userid' => $gradeduser->id]); $gradername = $gradegrade ? fullname(\core_user::get_user($gradegrade->usermodified)) : null; $maxgrade = max(array_keys($controller->get_grade_range())); $criterion = []; if ($definition->guide_criteria) { $criterion = array_map(function($criterion) use ($definitionid, $fillings, $context) { $result = [ 'id' => $criterion['id'], 'name' => $criterion['shortname'], 'maxscore' => $criterion['maxscore'], 'description' => self::get_formatted_text( $context, $definitionid, 'description', $criterion['description'], (int) $criterion['descriptionformat'] ), 'descriptionmarkers' => self::get_formatted_text( $context, $definitionid, 'descriptionmarkers', $criterion['descriptionmarkers'], (int) $criterion['descriptionmarkersformat'] ), 'score' => null, 'remark' => null, ]; if (array_key_exists($criterion['id'], $fillings['criteria'])) { $filling = $fillings['criteria'][$criterion['id']]; $result['score'] = $filling['score']; $result['remark'] = self::get_formatted_text( $context, $definitionid, 'remark', $filling['remark'], (int) $filling['remarkformat'] ); } return $result; }, $definition->guide_criteria); } $comments = []; if ($definition->guide_comments) { $comments = array_map(function($comment) use ($definitionid, $context) { return [ 'id' => $comment['id'], 'sortorder' => $comment['sortorder'], 'description' => self::get_formatted_text( $context, $definitionid, 'description', $comment['description'], (int) $comment['descriptionformat'] ), ]; }, $definition->guide_comments); } return [ 'templatename' => 'gradingform_guide/grades/grader/gradingpanel', 'hasgrade' => $hasgrade, 'grade' => [ 'instanceid' => $instance->get_id(), 'criterion' => $criterion, 'hascomments' => !empty($comments), 'comments' => $comments, 'usergrade' => $grade->usergrade, 'maxgrade' => $maxgrade, 'gradedby' => $gradername, 'timecreated' => $grade->timecreated, 'timemodified' => $grade->timemodified, ], 'warnings' => [], ]; } /** * Describes the data returned from the external function. * * @return external_single_structure * @since Moodle 3.8 */ public static function execute_returns(): external_single_structure { return new external_single_structure([ 'templatename' => new external_value(PARAM_SAFEPATH, 'The template to use when rendering this data'), 'hasgrade' => new external_value(PARAM_BOOL, 'Does the user have a grade?'), 'grade' => new external_single_structure([ 'instanceid' => new external_value(PARAM_INT, 'The id of the current grading instance'), 'criterion' => new external_multiple_structure( new external_single_structure([ 'id' => new external_value(PARAM_INT, 'The id of the criterion'), 'name' => new external_value(PARAM_RAW, 'The name of the criterion'), 'maxscore' => new external_value(PARAM_FLOAT, 'The maximum score for this criterion'), 'description' => new external_value(PARAM_RAW, 'The description of the criterion'), 'descriptionmarkers' => new external_value(PARAM_RAW, 'The description of the criterion for markers'), 'score' => new external_value(PARAM_FLOAT, 'The current score for user being assessed', VALUE_OPTIONAL), 'remark' => new external_value(PARAM_RAW, 'Any remarks for this criterion for the user being assessed', VALUE_OPTIONAL), ]), 'The criterion by which this item will be graded' ), 'hascomments' => new external_value(PARAM_BOOL, 'Whether there are any frequently-used comments'), 'comments' => new external_multiple_structure( new external_single_structure([ 'id' => new external_value(PARAM_INT, 'Comment id'), 'sortorder' => new external_value(PARAM_INT, 'The sortorder of this comment'), 'description' => new external_value(PARAM_RAW, 'The comment value'), ]), 'Frequently used comments' ), 'usergrade' => new external_value(PARAM_RAW, 'Current user grade'), 'maxgrade' => new external_value(PARAM_RAW, 'Max possible grade'), 'gradedby' => new external_value(PARAM_RAW, 'The assumed grader of this grading instance'), 'timecreated' => new external_value(PARAM_INT, 'The time that the grade was created'), 'timemodified' => new external_value(PARAM_INT, 'The time that the grade was last updated'), ]), 'warnings' => new external_warnings(), ]); } /** * Get a formatted version of the remark/description/etc. * * @param context $context * @param int $definitionid * @param string $filearea The file area of the field * @param string $text The text to be formatted * @param int $format The input format of the string * @return string */ protected static function get_formatted_text(context $context, int $definitionid, string $filearea, string $text, int $format): string { $formatoptions = [ 'noclean' => false, 'trusted' => false, 'filter' => true, ]; [$newtext] = \core_external\util::format_text( $text, $format, $context, 'grading', $filearea, $definitionid, $formatoptions ); return $newtext; } } grading/form/guide/classes/privacy/provider.php 0000604 00000012012 15062070556 0015672 0 ustar 00 <?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/>. /** * Privacy class for requesting user data. * * @package gradingform_guide * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradingform_guide\privacy; defined('MOODLE_INTERNAL') || die(); use \core_privacy\local\metadata\collection; use \core_privacy\local\request\transform; use \core_privacy\local\request\writer; /** * Privacy class for requesting user data. * * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class provider implements \core_privacy\local\metadata\provider, \core_grading\privacy\gradingform_provider_v2, \core_privacy\local\request\user_preference_provider { /** * Return the fields which contain personal data. * * @param collection $collection The initialised collection to add items to. * @return collection A listing of user data stored through this system. */ public static function get_metadata(collection $collection) : collection { $collection->add_database_table('gradingform_guide_fillings', [ 'instanceid' => 'privacy:metadata:instanceid', 'criterionid' => 'privacy:metadata:criterionid', 'remark' => 'privacy:metadata:remark', 'score' => 'privacy:metadata:score' ], 'privacy:metadata:fillingssummary'); $collection->add_user_preference( 'gradingform_guide-showmarkerdesc', 'privacy:metadata:preference:showmarkerdesc' ); $collection->add_user_preference( 'gradingform_guide-showstudentdesc', 'privacy:metadata:preference:showstudentdesc' ); return $collection; } /** * Export user data relating to an instance ID. * * @param \context $context Context to use with the export writer. * @param int $instanceid The instance ID to export data for. * @param array $subcontext The directory to export this data to. */ public static function export_gradingform_instance_data(\context $context, int $instanceid, array $subcontext) { global $DB; // Get records from the provided params. $params = ['instanceid' => $instanceid]; $sql = "SELECT gc.shortname, gc.description, gc.maxscore, gf.score, gf.remark FROM {gradingform_guide_fillings} gf JOIN {gradingform_guide_criteria} gc ON gc.id = gf.criterionid WHERE gf.instanceid = :instanceid"; $records = $DB->get_records_sql($sql, $params); if ($records) { $subcontext = array_merge($subcontext, [get_string('guide', 'gradingform_guide'), $instanceid]); writer::with_context($context)->export_data($subcontext, (object) $records); } } /** * Deletes all user data related to the provided instance IDs. * * @param array $instanceids The instance IDs to delete information from. */ public static function delete_gradingform_for_instances(array $instanceids) { global $DB; $DB->delete_records_list('gradingform_guide_fillings', 'instanceid', $instanceids); } /** * Store all user preferences for the plugin. * * @param int $userid The userid of the user whose data is to be exported. */ public static function export_user_preferences(int $userid) { $prefvalue = get_user_preferences('gradingform_guide-showmarkerdesc', null, $userid); if ($prefvalue !== null) { $transformedvalue = transform::yesno($prefvalue); writer::export_user_preference( 'gradingform_guide', 'gradingform_guide-showmarkerdesc', $transformedvalue, get_string('privacy:metadata:preference:showmarkerdesc', 'gradingform_guide') ); } $prefvalue = get_user_preferences('gradingform_guide-showstudentdesc', null, $userid); if ($prefvalue !== null) { $transformedvalue = transform::yesno($prefvalue); writer::export_user_preference( 'gradingform_guide', 'gradingform_guide-showstudentdesc', $transformedvalue, get_string('privacy:metadata:preference:showstudentdesc', 'gradingform_guide') ); } } } grading/form/guide/lib.php 0000604 00000130414 15062070556 0011503 0 ustar 00 <?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/>. /** * Grading method controller for the guide plugin * * @package gradingform_guide * @copyright 2012 Dan Marsden <dan@danmarsden.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ use core_external\external_format_value; use core_external\external_multiple_structure; use core_external\external_single_structure; use core_external\external_value; defined('MOODLE_INTERNAL') || die(); require_once($CFG->dirroot.'/grade/grading/form/lib.php'); /** guide: Used to compare our gradeitem_type against. */ const MARKING_GUIDE = 'guide'; /** * This controller encapsulates the guide grading logic * * @package gradingform_guide * @copyright 2012 Dan Marsden <dan@danmarsden.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class gradingform_guide_controller extends gradingform_controller { // Modes of displaying the guide (used in gradingform_guide_renderer). /** guide display mode: For editing (moderator or teacher creates a guide) */ const DISPLAY_EDIT_FULL = 1; /** guide display mode: Preview the guide design with hidden fields */ const DISPLAY_EDIT_FROZEN = 2; /** guide display mode: Preview the guide design (for person with manage permission) */ const DISPLAY_PREVIEW = 3; /** guide display mode: Preview the guide (for people being graded) */ const DISPLAY_PREVIEW_GRADED= 8; /** guide display mode: For evaluation, enabled (teacher grades a student) */ const DISPLAY_EVAL = 4; /** guide display mode: For evaluation, with hidden fields */ const DISPLAY_EVAL_FROZEN = 5; /** guide display mode: Teacher reviews filled guide */ const DISPLAY_REVIEW = 6; /** guide display mode: Dispaly filled guide (i.e. students see their grades) */ const DISPLAY_VIEW = 7; /** @var stdClass|false the definition structure */ protected $moduleinstance = false; /** * Extends the module settings navigation with the guide grading settings * * This function is called when the context for the page is an activity module with the * FEATURE_ADVANCED_GRADING, the user has the permission moodle/grade:managegradingforms * and there is an area with the active grading method set to 'guide'. * * @param settings_navigation $settingsnav {@link settings_navigation} * @param navigation_node $node {@link navigation_node} */ public function extend_settings_navigation(settings_navigation $settingsnav, navigation_node $node=null) { $node->add(get_string('definemarkingguide', 'gradingform_guide'), $this->get_editor_url(), settings_navigation::TYPE_CUSTOM, null, null, new pix_icon('icon', '', 'gradingform_guide')); } /** * Extends the module navigation * * This function is called when the context for the page is an activity module with the * FEATURE_ADVANCED_GRADING and there is an area with the active grading method set to the given plugin. * * @param global_navigation $navigation {@link global_navigation} * @param navigation_node $node {@link navigation_node} * @return void */ public function extend_navigation(global_navigation $navigation, navigation_node $node=null) { if (has_capability('moodle/grade:managegradingforms', $this->get_context())) { // No need for preview if user can manage forms, he will have link to manage.php in settings instead. return; } if ($this->is_form_defined() && ($options = $this->get_options()) && !empty($options['alwaysshowdefinition'])) { $node->add(get_string('gradingof', 'gradingform_guide', get_grading_manager($this->get_areaid())->get_area_title()), new moodle_url('/grade/grading/form/'.$this->get_method_name().'/preview.php', array('areaid' => $this->get_areaid())), settings_navigation::TYPE_CUSTOM); } } /** * Saves the guide definition into the database * * @see parent::update_definition() * @param stdClass $newdefinition guide definition data as coming from gradingform_guide_editguide::get_data() * @param int $usermodified optional userid of the author of the definition, defaults to the current user */ public function update_definition(stdClass $newdefinition, $usermodified = null) { $this->update_or_check_guide($newdefinition, $usermodified, true); if (isset($newdefinition->guide['regrade']) && $newdefinition->guide['regrade']) { $this->mark_for_regrade(); } } /** * Either saves the guide definition into the database or check if it has been changed. * * Returns the level of changes: * 0 - no changes * 1 - only texts or criteria sortorders are changed, students probably do not require re-grading * 2 - added levels but maximum score on guide is the same, students still may not require re-grading * 3 - removed criteria or changed number of points, students require re-grading but may be re-graded automatically * 4 - removed levels - students require re-grading and not all students may be re-graded automatically * 5 - added criteria - all students require manual re-grading * * @param stdClass $newdefinition guide definition data as coming from gradingform_guide_editguide::get_data() * @param int|null $usermodified optional userid of the author of the definition, defaults to the current user * @param bool $doupdate if true actually updates DB, otherwise performs a check * @return int */ public function update_or_check_guide(stdClass $newdefinition, $usermodified = null, $doupdate = false) { global $DB; // Firstly update the common definition data in the {grading_definition} table. if ($this->definition === false) { if (!$doupdate) { // If we create the new definition there is no such thing as re-grading anyway. return 5; } // If definition does not exist yet, create a blank one // (we need id to save files embedded in description). parent::update_definition(new stdClass(), $usermodified); parent::load_definition(); } if (!isset($newdefinition->guide['options'])) { $newdefinition->guide['options'] = self::get_default_options(); } $newdefinition->options = json_encode($newdefinition->guide['options']); $editoroptions = self::description_form_field_options($this->get_context()); $newdefinition = file_postupdate_standard_editor($newdefinition, 'description', $editoroptions, $this->get_context(), 'grading', 'description', $this->definition->id); // Reload the definition from the database. $currentdefinition = $this->get_definition(true); // Update guide data. $haschanges = array(); if (empty($newdefinition->guide['criteria'])) { $newcriteria = array(); } else { $newcriteria = $newdefinition->guide['criteria']; // New ones to be saved. } $currentcriteria = $currentdefinition->guide_criteria; $criteriafields = array('sortorder', 'description', 'descriptionformat', 'descriptionmarkers', 'descriptionmarkersformat', 'shortname', 'maxscore'); foreach ($newcriteria as $id => $criterion) { if (preg_match('/^NEWID\d+$/', $id)) { // Insert criterion into DB. $data = array('definitionid' => $this->definition->id, 'descriptionformat' => FORMAT_MOODLE, 'descriptionmarkersformat' => FORMAT_MOODLE); // TODO format is not supported yet. foreach ($criteriafields as $key) { if (array_key_exists($key, $criterion)) { $data[$key] = $criterion[$key]; } } if ($doupdate) { $id = $DB->insert_record('gradingform_guide_criteria', $data); } $haschanges[5] = true; } else { // Update criterion in DB. $data = array(); foreach ($criteriafields as $key) { if (array_key_exists($key, $criterion) && $criterion[$key] != $currentcriteria[$id][$key]) { $data[$key] = $criterion[$key]; } } if (!empty($data)) { // Update only if something is changed. $data['id'] = $id; if ($doupdate) { $DB->update_record('gradingform_guide_criteria', $data); } $haschanges[1] = true; } } } // Remove deleted criteria from DB. foreach (array_keys($currentcriteria) as $id) { if (!array_key_exists($id, $newcriteria)) { if ($doupdate) { $DB->delete_records('gradingform_guide_criteria', array('id' => $id)); } $haschanges[3] = true; } } // Now handle comments. if (empty($newdefinition->guide['comments'])) { $newcomment = array(); } else { $newcomment = $newdefinition->guide['comments']; // New ones to be saved. } $currentcomments = $currentdefinition->guide_comments; $commentfields = array('sortorder', 'description'); foreach ($newcomment as $id => $comment) { if (preg_match('/^NEWID\d+$/', $id)) { // Insert criterion into DB. $data = array('definitionid' => $this->definition->id, 'descriptionformat' => FORMAT_MOODLE); foreach ($commentfields as $key) { if (array_key_exists($key, $comment)) { // Check if key is the comment's description. if ($key === 'description') { // Get a trimmed value for the comment description. $description = trim($comment[$key]); // Check if the comment description is empty. if (empty($description)) { // Continue to the next comment object if the description is empty. continue 2; } } $data[$key] = $comment[$key]; } } if ($doupdate) { $id = $DB->insert_record('gradingform_guide_comments', $data); } } else { // Update criterion in DB. $data = array(); foreach ($commentfields as $key) { if (array_key_exists($key, $comment) && $comment[$key] != $currentcomments[$id][$key]) { $data[$key] = $comment[$key]; } } if (!empty($data)) { // Update only if something is changed. $data['id'] = $id; if ($doupdate) { $DB->update_record('gradingform_guide_comments', $data); } } } } // Remove deleted criteria from DB. foreach (array_keys($currentcomments) as $id) { if (!array_key_exists($id, $newcomment)) { if ($doupdate) { $DB->delete_records('gradingform_guide_comments', array('id' => $id)); } } } // End comments handle. foreach (array('status', 'description', 'descriptionformat', 'name', 'options') as $key) { if (isset($newdefinition->$key) && $newdefinition->$key != $this->definition->$key) { $haschanges[1] = true; } } if ($usermodified && $usermodified != $this->definition->usermodified) { $haschanges[1] = true; } if (!count($haschanges)) { return 0; } if ($doupdate) { parent::update_definition($newdefinition, $usermodified); $this->load_definition(); } // Return the maximum level of changes. $changelevels = array_keys($haschanges); sort($changelevels); return array_pop($changelevels); } /** * Marks all instances filled with this guide with the status INSTANCE_STATUS_NEEDUPDATE */ public function mark_for_regrade() { global $DB; if ($this->has_active_instances()) { $conditions = array('definitionid' => $this->definition->id, 'status' => gradingform_instance::INSTANCE_STATUS_ACTIVE); $DB->set_field('grading_instances', 'status', gradingform_instance::INSTANCE_STATUS_NEEDUPDATE, $conditions); } } /** * Loads the guide form definition if it exists * * There is a new array called 'guide_criteria' appended to the list of parent's definition properties. */ protected function load_definition() { global $DB; // Check to see if the user prefs have changed - putting here as this function is called on post even when // validation on the page fails. - hard to find a better place to locate this as it is specific to the guide. $showdesc = optional_param('showmarkerdesc', null, PARAM_BOOL); // Check if we need to change pref. $showdescstudent = optional_param('showstudentdesc', null, PARAM_BOOL); // Check if we need to change pref. if ($showdesc !== null) { set_user_preference('gradingform_guide-showmarkerdesc', $showdesc); } if ($showdescstudent !== null) { set_user_preference('gradingform_guide-showstudentdesc', $showdescstudent); } // Get definition. $definition = $DB->get_record('grading_definitions', array('areaid' => $this->areaid, 'method' => $this->get_method_name()), '*'); if (!$definition) { // The definition doesn't have to exist. It may be that we are only now creating it. $this->definition = false; return false; } $this->definition = $definition; // Now get criteria. $this->definition->guide_criteria = array(); $this->definition->guide_comments = array(); $criteria = $DB->get_recordset('gradingform_guide_criteria', array('definitionid' => $this->definition->id), 'sortorder'); foreach ($criteria as $criterion) { foreach (array('id', 'sortorder', 'description', 'descriptionformat', 'maxscore', 'descriptionmarkers', 'descriptionmarkersformat', 'shortname') as $fieldname) { if ($fieldname == 'maxscore') { // Strip any trailing 0. $this->definition->guide_criteria[$criterion->id][$fieldname] = (float)$criterion->{$fieldname}; } else { $this->definition->guide_criteria[$criterion->id][$fieldname] = $criterion->{$fieldname}; } } } $criteria->close(); // Now get comments. $comments = $DB->get_recordset('gradingform_guide_comments', array('definitionid' => $this->definition->id), 'sortorder'); foreach ($comments as $comment) { foreach (array('id', 'sortorder', 'description', 'descriptionformat') as $fieldname) { $this->definition->guide_comments[$comment->id][$fieldname] = $comment->{$fieldname}; } } $comments->close(); if (empty($this->moduleinstance)) { // Only set if empty. $modulename = $this->get_component(); $context = $this->get_context(); if (strpos($modulename, 'mod_') === 0) { $dbman = $DB->get_manager(); $modulename = substr($modulename, 4); if ($dbman->table_exists($modulename)) { $cm = get_coursemodule_from_id($modulename, $context->instanceid); if (!empty($cm)) { // This should only occur when the course is being deleted. $this->moduleinstance = $DB->get_record($modulename, array("id"=>$cm->instance)); } } } } } /** * Returns the default options for the guide display * * @return array */ public static function get_default_options() { $options = array( 'alwaysshowdefinition' => 1, 'showmarkspercriterionstudents' => 1, ); return $options; } /** * Gets the options of this guide definition, fills the missing options with default values * * @return array */ public function get_options() { $options = self::get_default_options(); if (!empty($this->definition->options)) { $thisoptions = json_decode($this->definition->options); foreach ($thisoptions as $option => $value) { $options[$option] = $value; } } return $options; } /** * Converts the current definition into an object suitable for the editor form's set_data() * * @param bool $addemptycriterion whether to add an empty criterion if the guide is completely empty (just being created) * @return stdClass */ public function get_definition_for_editing($addemptycriterion = false) { $definition = $this->get_definition(); $properties = new stdClass(); $properties->areaid = $this->areaid; if (isset($this->moduleinstance->grade)) { $properties->modulegrade = $this->moduleinstance->grade; } if ($definition) { foreach (array('id', 'name', 'description', 'descriptionformat', 'status') as $key) { $properties->$key = $definition->$key; } $options = self::description_form_field_options($this->get_context()); $properties = file_prepare_standard_editor($properties, 'description', $options, $this->get_context(), 'grading', 'description', $definition->id); } $properties->guide = array('criteria' => array(), 'options' => $this->get_options(), 'comments' => array()); if (!empty($definition->guide_criteria)) { $properties->guide['criteria'] = $definition->guide_criteria; } else if (!$definition && $addemptycriterion) { $properties->guide['criteria'] = array('addcriterion' => 1); } if (!empty($definition->guide_comments)) { $properties->guide['comments'] = $definition->guide_comments; } else if (!$definition && $addemptycriterion) { $properties->guide['comments'] = array('addcomment' => 1); } return $properties; } /** * Returns the form definition suitable for cloning into another area * * @see parent::get_definition_copy() * @param gradingform_controller $target the controller of the new copy * @return stdClass definition structure to pass to the target's {@link update_definition()} */ public function get_definition_copy(gradingform_controller $target) { $new = parent::get_definition_copy($target); $old = $this->get_definition_for_editing(); $new->description_editor = $old->description_editor; $new->guide = array('criteria' => array(), 'options' => $old->guide['options'], 'comments' => array()); $newcritid = 1; foreach ($old->guide['criteria'] as $oldcritid => $oldcrit) { unset($oldcrit['id']); $new->guide['criteria']['NEWID'.$newcritid] = $oldcrit; $newcritid++; } $newcomid = 1; foreach ($old->guide['comments'] as $oldcritid => $oldcom) { unset($oldcom['id']); $new->guide['comments']['NEWID'.$newcomid] = $oldcom; $newcomid++; } return $new; } /** * Options for displaying the guide description field in the form * * @param context $context * @return array options for the form description field */ public static function description_form_field_options($context) { global $CFG; return array( 'maxfiles' => -1, 'maxbytes' => get_max_upload_file_size($CFG->maxbytes), 'context' => $context, ); } /** * Formats the definition description for display on page * * @return string */ public function get_formatted_description() { if (!isset($this->definition->description)) { return ''; } $context = $this->get_context(); $options = self::description_form_field_options($this->get_context()); $description = file_rewrite_pluginfile_urls($this->definition->description, 'pluginfile.php', $context->id, 'grading', 'description', $this->definition->id, $options); $formatoptions = array( 'noclean' => false, 'trusted' => false, 'filter' => true, 'context' => $context ); return format_text($description, $this->definition->descriptionformat, $formatoptions); } /** * Returns the guide plugin renderer * * @param moodle_page $page the target page * @return gradingform_guide_renderer */ public function get_renderer(moodle_page $page) { return $page->get_renderer('gradingform_'. $this->get_method_name()); } /** * Returns the HTML code displaying the preview of the grading form * * @param moodle_page $page the target page * @return string */ public function render_preview(moodle_page $page) { if (!$this->is_form_defined()) { throw new coding_exception('It is the caller\'s responsibility to make sure that the form is actually defined'); } // Check if current user is able to see preview $options = $this->get_options(); if (empty($options['alwaysshowdefinition']) && !has_capability('moodle/grade:managegradingforms', $page->context)) { return ''; } $criteria = $this->definition->guide_criteria; $comments = $this->definition->guide_comments; $output = $this->get_renderer($page); $guide = ''; $guide .= $output->box($this->get_formatted_description(), 'gradingform_guide-description'); if (has_capability('moodle/grade:managegradingforms', $page->context)) { $guide .= $output->display_guide_mapping_explained($this->get_min_max_score()); $guide .= $output->display_guide($criteria, $comments, $options, self::DISPLAY_PREVIEW, 'guide'); } else { $guide .= $output->display_guide($criteria, $comments, $options, self::DISPLAY_PREVIEW_GRADED, 'guide'); } return $guide; } /** * Deletes the guide definition and all the associated information */ protected function delete_plugin_definition() { global $DB; // Get the list of instances. $instances = array_keys($DB->get_records('grading_instances', array('definitionid' => $this->definition->id), '', 'id')); // Delete all fillings. $DB->delete_records_list('gradingform_guide_fillings', 'instanceid', $instances); // Delete instances. $DB->delete_records_list('grading_instances', 'id', $instances); // Get the list of criteria records. $criteria = array_keys($DB->get_records('gradingform_guide_criteria', array('definitionid' => $this->definition->id), '', 'id')); // Delete critera. $DB->delete_records_list('gradingform_guide_criteria', 'id', $criteria); // Delete comments. $DB->delete_records('gradingform_guide_comments', array('definitionid' => $this->definition->id)); } /** * If instanceid is specified and grading instance exists and it is created by this rater for * this item, this instance is returned. * If there exists a draft for this raterid+itemid, take this draft (this is the change from parent) * Otherwise new instance is created for the specified rater and itemid * * @param int $instanceid * @param int $raterid * @param int $itemid * @return gradingform_instance */ public function get_or_create_instance($instanceid, $raterid, $itemid) { global $DB; if ($instanceid && $instance = $DB->get_record('grading_instances', array('id' => $instanceid, 'raterid' => $raterid, 'itemid' => $itemid), '*', IGNORE_MISSING)) { return $this->get_instance($instance); } if ($itemid && $raterid) { $params = array('definitionid' => $this->definition->id, 'raterid' => $raterid, 'itemid' => $itemid); if ($rs = $DB->get_records('grading_instances', $params, 'timemodified DESC', '*', 0, 1)) { $record = reset($rs); $currentinstance = $this->get_current_instance($raterid, $itemid); if ($record->status == gradingform_guide_instance::INSTANCE_STATUS_INCOMPLETE && (!$currentinstance || $record->timemodified > $currentinstance->get_data('timemodified'))) { $record->isrestored = true; return $this->get_instance($record); } } } return $this->create_instance($raterid, $itemid); } /** * Returns html code to be included in student's feedback. * * @param moodle_page $page * @param int $itemid * @param array $gradinginfo result of function grade_get_grades * @param string $defaultcontent default string to be returned if no active grading is found * @param bool $cangrade whether current user has capability to grade in this context * @return string */ public function render_grade($page, $itemid, $gradinginfo, $defaultcontent, $cangrade) { return $this->get_renderer($page)->display_instances($this->get_active_instances($itemid), $defaultcontent, $cangrade); } // Full-text search support. /** * Prepare the part of the search query to append to the FROM statement * * @param string $gdid the alias of grading_definitions.id column used by the caller * @return string */ public static function sql_search_from_tables($gdid) { return " LEFT JOIN {gradingform_guide_criteria} gc ON (gc.definitionid = $gdid)"; } /** * Prepare the parts of the SQL WHERE statement to search for the given token * * The returned array cosists of the list of SQL comparions and the list of * respective parameters for the comparisons. The returned chunks will be joined * with other conditions using the OR operator. * * @param string $token token to search for * @return array An array containing two more arrays * Array of search SQL fragments * Array of params for the search fragments */ public static function sql_search_where($token) { global $DB; $subsql = array(); $params = array(); // Search in guide criteria description. $subsql[] = $DB->sql_like('gc.description', '?', false, false); $params[] = '%'.$DB->sql_like_escape($token).'%'; return array($subsql, $params); } /** * Calculates and returns the possible minimum and maximum score (in points) for this guide * * @return array */ public function get_min_max_score() { if (!$this->is_form_available()) { return null; } $returnvalue = array('minscore' => 0, 'maxscore' => 0); $maxscore = 0; foreach ($this->get_definition()->guide_criteria as $id => $criterion) { $maxscore += $criterion['maxscore']; } $returnvalue['maxscore'] = $maxscore; $returnvalue['minscore'] = 0; if (!$this->is_shared_template()) { $fieldname = \core_grades\component_gradeitems::get_field_name_for_itemname($this->component, $this->area, 'grade'); if (!empty($this->moduleinstance->{$fieldname})) { $graderange = make_grades_menu($this->moduleinstance->{$fieldname}); $returnvalue['modulegrade'] = count($graderange) - 1; } } return $returnvalue; } /** * @return array An array containing 2 key/value pairs which hold the external_multiple_structure * for the 'guide_criteria' and the 'guide_comments'. * @see gradingform_controller::get_external_definition_details() * @since Moodle 2.5 */ public static function get_external_definition_details() { $guide_criteria = new external_multiple_structure( new external_single_structure( array( 'id' => new external_value(PARAM_INT, 'criterion id', VALUE_OPTIONAL), 'sortorder' => new external_value(PARAM_INT, 'sortorder', VALUE_OPTIONAL), 'description' => new external_value(PARAM_RAW, 'description', VALUE_OPTIONAL), 'descriptionformat' => new external_format_value('description', VALUE_OPTIONAL), 'shortname' => new external_value(PARAM_TEXT, 'description'), 'descriptionmarkers' => new external_value(PARAM_RAW, 'markers description', VALUE_OPTIONAL), 'descriptionmarkersformat' => new external_format_value('descriptionmarkers', VALUE_OPTIONAL), 'maxscore' => new external_value(PARAM_FLOAT, 'maximum score') ) ) ); $guide_comments = new external_multiple_structure( new external_single_structure( array( 'id' => new external_value(PARAM_INT, 'criterion id', VALUE_OPTIONAL), 'sortorder' => new external_value(PARAM_INT, 'sortorder', VALUE_OPTIONAL), 'description' => new external_value(PARAM_RAW, 'description', VALUE_OPTIONAL), 'descriptionformat' => new external_format_value('description', VALUE_OPTIONAL) ) ), 'comments', VALUE_OPTIONAL ); return array('guide_criteria' => $guide_criteria, 'guide_comments' => $guide_comments); } /** * Returns an array that defines the structure of the guide's filling. This function is used by * the web service function core_grading_external::get_gradingform_instances(). * * @return An array containing a single key/value pair with the 'criteria' external_multiple_structure * @see gradingform_controller::get_external_instance_filling_details() * @since Moodle 2.6 */ public static function get_external_instance_filling_details() { $criteria = new external_multiple_structure( new external_single_structure( array( 'id' => new external_value(PARAM_INT, 'filling id'), 'criterionid' => new external_value(PARAM_INT, 'criterion id'), 'levelid' => new external_value(PARAM_INT, 'level id', VALUE_OPTIONAL), 'remark' => new external_value(PARAM_RAW, 'remark', VALUE_OPTIONAL), 'remarkformat' => new external_format_value('remark', VALUE_OPTIONAL), 'score' => new external_value(PARAM_FLOAT, 'maximum score') ) ), 'filling', VALUE_OPTIONAL ); return array ('criteria' => $criteria); } } /** * Class to manage one guide grading instance. Stores information and performs actions like * update, copy, validate, submit, etc. * * @package gradingform_guide * @copyright 2012 Dan Marsden <dan@danmarsden.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class gradingform_guide_instance extends gradingform_instance { /** @var array */ protected $guide; /** @var array An array of validation errors */ protected $validationerrors = array(); /** * Deletes this (INCOMPLETE) instance from database. */ public function cancel() { global $DB; parent::cancel(); $DB->delete_records('gradingform_guide_fillings', array('instanceid' => $this->get_id())); } /** * Duplicates the instance before editing (optionally substitutes raterid and/or itemid with * the specified values) * * @param int $raterid value for raterid in the duplicate * @param int $itemid value for itemid in the duplicate * @return int id of the new instance */ public function copy($raterid, $itemid) { global $DB; $instanceid = parent::copy($raterid, $itemid); $currentgrade = $this->get_guide_filling(); foreach ($currentgrade['criteria'] as $criterionid => $record) { $params = array('instanceid' => $instanceid, 'criterionid' => $criterionid, 'score' => $record['score'], 'remark' => $record['remark'], 'remarkformat' => $record['remarkformat']); $DB->insert_record('gradingform_guide_fillings', $params); } return $instanceid; } /** * Determines whether the submitted form was empty. * * @param array $elementvalue value of element submitted from the form * @return boolean true if the form is empty */ public function is_empty_form($elementvalue) { $criteria = $this->get_controller()->get_definition()->guide_criteria; foreach ($criteria as $id => $criterion) { $score = $elementvalue['criteria'][$id]['score']; $remark = $elementvalue['criteria'][$id]['remark']; if ((isset($score) && $score !== '') || ((isset($remark) && $remark !== ''))) { return false; } } return true; } /** * Validates that guide is fully completed and contains valid grade on each criterion * * @param array $elementvalue value of element as came in form submit * @return boolean true if the form data is validated and contains no errors */ public function validate_grading_element($elementvalue) { $criteria = $this->get_controller()->get_definition()->guide_criteria; if (!isset($elementvalue['criteria']) || !is_array($elementvalue['criteria']) || count($elementvalue['criteria']) < count($criteria)) { return false; } // Reset validation errors. $this->validationerrors = null; foreach ($criteria as $id => $criterion) { if (!isset($elementvalue['criteria'][$id]['score']) || $criterion['maxscore'] < $elementvalue['criteria'][$id]['score'] || !is_numeric($elementvalue['criteria'][$id]['score']) || $elementvalue['criteria'][$id]['score'] < 0) { $this->validationerrors[$id]['score'] = $elementvalue['criteria'][$id]['score']; } } if (!empty($this->validationerrors)) { return false; } return true; } /** * Retrieves from DB and returns the data how this guide was filled * * @param bool $force whether to force DB query even if the data is cached * @return array */ public function get_guide_filling($force = false) { global $DB; if ($this->guide === null || $force) { $records = $DB->get_records('gradingform_guide_fillings', array('instanceid' => $this->get_id())); $this->guide = array('criteria' => array()); foreach ($records as $record) { $record->score = (float)$record->score; // Strip trailing 0. $this->guide['criteria'][$record->criterionid] = (array)$record; } } return $this->guide; } /** * Updates the instance with the data received from grading form. This function may be * called via AJAX when grading is not yet completed, so it does not change the * status of the instance. * * @param array $data */ public function update($data) { global $DB; $currentgrade = $this->get_guide_filling(); parent::update($data); foreach ($data['criteria'] as $criterionid => $record) { if (!array_key_exists($criterionid, $currentgrade['criteria'])) { $newrecord = array('instanceid' => $this->get_id(), 'criterionid' => $criterionid, 'score' => $record['score'], 'remarkformat' => FORMAT_MOODLE); if (isset($record['remark'])) { $newrecord['remark'] = $record['remark']; } $DB->insert_record('gradingform_guide_fillings', $newrecord); } else { $newrecord = array('id' => $currentgrade['criteria'][$criterionid]['id']); foreach (array('score', 'remark'/*, 'remarkformat' TODO */) as $key) { if (isset($record[$key]) && $currentgrade['criteria'][$criterionid][$key] != $record[$key]) { $newrecord[$key] = $record[$key]; } } if (count($newrecord) > 1) { $DB->update_record('gradingform_guide_fillings', $newrecord); } } } foreach ($currentgrade['criteria'] as $criterionid => $record) { if (!array_key_exists($criterionid, $data['criteria'])) { $DB->delete_records('gradingform_guide_fillings', array('id' => $record['id'])); } } $this->get_guide_filling(true); } /** * Removes the attempt from the gradingform_guide_fillings table * @param array $data the attempt data */ public function clear_attempt($data) { global $DB; foreach ($data['criteria'] as $criterionid => $record) { $DB->delete_records('gradingform_guide_fillings', array('criterionid' => $criterionid, 'instanceid' => $this->get_id())); } } /** * Calculates the grade to be pushed to the gradebook * * @return float|int the valid grade from $this->get_controller()->get_grade_range() */ public function get_grade() { $grade = $this->get_guide_filling(); if (!($scores = $this->get_controller()->get_min_max_score()) || $scores['maxscore'] <= $scores['minscore']) { return -1; } $graderange = array_keys($this->get_controller()->get_grade_range()); if (empty($graderange)) { return -1; } sort($graderange); $mingrade = $graderange[0]; $maxgrade = $graderange[count($graderange) - 1]; $curscore = 0; foreach ($grade['criteria'] as $record) { $curscore += $record['score']; } $gradeoffset = ($curscore-$scores['minscore'])/($scores['maxscore']-$scores['minscore'])* ($maxgrade-$mingrade); if ($this->get_controller()->get_allow_grade_decimals()) { return $gradeoffset + $mingrade; } return round($gradeoffset, 0) + $mingrade; } /** * Returns html for form element of type 'grading'. * * @param moodle_page $page * @param MoodleQuickForm_grading $gradingformelement * @return string */ public function render_grading_element($page, $gradingformelement) { if (!$gradingformelement->_flagFrozen) { $module = array('name'=>'gradingform_guide', 'fullpath'=>'/grade/grading/form/guide/js/guide.js'); $page->requires->js_init_call('M.gradingform_guide.init', array( array('name' => $gradingformelement->getName())), true, $module); $mode = gradingform_guide_controller::DISPLAY_EVAL; } else { if ($gradingformelement->_persistantFreeze) { $mode = gradingform_guide_controller::DISPLAY_EVAL_FROZEN; } else { $mode = gradingform_guide_controller::DISPLAY_REVIEW; } } $criteria = $this->get_controller()->get_definition()->guide_criteria; $comments = $this->get_controller()->get_definition()->guide_comments; $options = $this->get_controller()->get_options(); $value = $gradingformelement->getValue(); $html = ''; if ($value === null) { $value = $this->get_guide_filling(); } else if (!$this->validate_grading_element($value)) { $html .= html_writer::tag('div', get_string('guidenotcompleted', 'gradingform_guide'), array('class' => 'gradingform_guide-error')); if (!empty($this->validationerrors)) { foreach ($this->validationerrors as $id => $err) { $a = new stdClass(); $a->criterianame = format_text($criteria[$id]['shortname'], FORMAT_HTML); $a->maxscore = $criteria[$id]['maxscore']; if ($this->validationerrors[$id]['score'] < 0) { $html .= html_writer::tag('div', get_string('err_scoreisnegative', 'gradingform_guide', $a), array('class' => 'gradingform_guide-error')); } else { $html .= html_writer::tag('div', get_string('err_scoreinvalid', 'gradingform_guide', $a), array('class' => 'gradingform_guide-error')); } } } } $currentinstance = $this->get_current_instance(); if ($currentinstance && $currentinstance->get_status() == gradingform_instance::INSTANCE_STATUS_NEEDUPDATE) { $html .= html_writer::tag('div', get_string('needregrademessage', 'gradingform_guide'), array('class' => 'gradingform_guide-regrade', 'role' => 'alert')); } $haschanges = false; if ($currentinstance) { $curfilling = $currentinstance->get_guide_filling(); foreach ($curfilling['criteria'] as $criterionid => $curvalues) { $value['criteria'][$criterionid]['score'] = $curvalues['score']; $newremark = null; $newscore = null; if (isset($value['criteria'][$criterionid]['remark'])) { $newremark = $value['criteria'][$criterionid]['remark']; } if (isset($value['criteria'][$criterionid]['score'])) { $newscore = $value['criteria'][$criterionid]['score']; } if ($newscore != $curvalues['score'] || $newremark != $curvalues['remark']) { $haschanges = true; } } } if ($this->get_data('isrestored') && $haschanges) { $html .= html_writer::tag('div', get_string('restoredfromdraft', 'gradingform_guide'), array('class' => 'gradingform_guide-restored')); } $html .= html_writer::tag('div', $this->get_controller()->get_formatted_description(), array('class' => 'gradingform_guide-description')); $html .= $this->get_controller()->get_renderer($page)->display_guide($criteria, $comments, $options, $mode, $gradingformelement->getName(), $value, $this->validationerrors); return $html; } } /** * Get the icon mapping for font-awesome. * * @return array */ function gradingform_guide_get_fontawesome_icon_map(): array { return [ 'gradingform_guide:info' => 'fa-info-circle', 'gradingform_guide:plus' => 'fa-plus', ]; } grading/form/guide/styles.css 0000604 00000012230 15062070556 0012254 0 ustar 00 .gradingform_guide-regrade { padding: 10px; background: #fdd; border: 1px solid #f00; margin-bottom: 10px; } .gradingform_guide-restored { padding: 10px; background: #ffd; border: 1px solid #ff0; margin-bottom: 10px; } .gradingform_guide-error { color: red; font-weight: bold; } .gradingform_guide_editform .status { font-weight: normal; text-transform: uppercase; font-size: 60%; padding: 0.25em; border: 1px solid #eee; } .gradingform_guide_editform .status.ready { background-color: #e7f1c3; border-color: #aea; } .gradingform_guide_editform .status.draft { background-color: #f3f2aa; border-color: #ee2; } .gradingform_guide.editor .criterion .controls, .gradingform_guide .criterion .description, .gradingform_guide .criterion .remark { vertical-align: top; } .gradingform_guide.editor .criterion .controls, .gradingform_guide.editor .criterion .description, .gradingform_guide.editor .criterion .remark { padding: 3px; } .gradingform_guide .criteria { height: 100%; } .gradingform_guide .criterion { border: 1px solid #ddd; overflow: hidden; } .gradingform_guide .criterion.even { background: #f0f0f0; } .gradingform_guide .criterion .description { width: 100%; } .gradingform_guide .criterion .description .criterionmaxscore input { width: 20px; } .gradingform_guide .criterion .description .criterionname { font-weight: bold; } .gradingform_guide .criterion label { font-weight: bold; padding-right: 5px; } .gradingform_guide .plainvalue.empty { font-style: italic; color: #aaa; } .gradingform_guide .plainvalue.editname { font-weight: bold; } /* Make invisible the buttons 'Move up' for the first criterion and 'Move down' for the last, because those buttons will make no change */ .gradingform_guide.editor .criterion.first.last .controls .delete input, .gradingform_guide.editor .criterion.first .controls .moveup input, .gradingform_guide.editor .criterion.last .controls .movedown input { display: none; } /* replace buttons with images */ .gradingform_guide.editor .delete input, .gradingform_guide.editor .moveup input, .gradingform_guide.editor .movedown input { text-indent: -1000em; cursor: pointer; border: none; } .gradingform_guide.editor .criterion .controls .delete input { width: 20px; height: 16px; background: transparent url([[pix:t/delete]]) no-repeat center top; margin-top: 4px; } .gradingform_guide.editor .moveup input { width: 20px; height: 15px; background: transparent url([[pix:t/up]]) no-repeat center top; margin-top: 4px; } .gradingform_guide.editor .movedown input { width: 20px; height: 15px; background: transparent url([[pix:t/down]]) no-repeat center top; margin-top: 4px; } .gradingform_guide.editor .addcriterion input, .gradingform_guide.editor .addcomment input { background: transparent url([[pix:t/add]]) no-repeat; display: block; color: #555; font-weight: bold; text-decoration: none; } .gradingform_guide.editor .addcriterion input, .gradingform_guide.editor .addcomment input { background-position: left 5px top 8px; height: 30px; line-height: 29px; margin-bottom: 14px; padding-left: 20px; padding-right: 10px; } .gradingform_guide .options .optionsheading { font-weight: bold; font-size: 1.1em; padding-bottom: 5px; } .gradingform_guide .options .option { padding-bottom: 2px; } .gradingform_guide .options .option label { margin-left: 5px; } .gradingform_guide .options .option .value { margin-left: 5px; font-weight: bold; } .gradingform_guide .criterion .description.error { background: #fdd; } /* special classes for elements created by guideeditor.js */ .gradingform_guide.editor .hiddenelement { display: none; } .gradingform_guide.editor .pseudotablink { background-color: transparent; border: 0 solid; height: 1px; width: 1px; color: transparent; padding: 0; margin: 0; position: relative; float: right; } .jsenabled .gradingform_guide .markingguidecomment { cursor: pointer; } .jsenabled .gradingform_guide .markingguidecomment:before { content: url([[pix:t/add]]); padding-right: 2px; } .gradingform_guide .commentheader { font-weight: bold; font-size: 1.1em; padding-bottom: 5px; } .jsenabled .gradingform_guide .criterionnamelabel { display: none; } .jsenabled .gradingform_guide .criterionshortname { font-weight: bold; } .gradingform_guide table { width: 100%; } .gradingform_guide .descriptionreadonly { vertical-align: top; } .gradingform_guide .criteriondescriptionmarkers { width: 300px; } .gradingform_guide .markingguideremark { margin: 0; width: 100%; -moz-box-sizing: border-box; box-sizing: border-box; } .gradingform_guide .criteriondescriptionscore { display: inline; } .gradingform_guide .score label { display: block; } .gradingform_guide .score input { margin: 0; width: auto; } .gradingform_guide_comment_chooser { max-height: 80vh; overflow-y: auto; } .gradingform_guide-frequent-comments { position: absolute; top: 7px; right: 0; } grading/form/guide/js/guideeditor.js 0000604 00000027174 15062070556 0013512 0 ustar 00 M.gradingform_guideeditor = {'templates' : {}, 'eventhandler' : null, 'name' : null, 'Y' : null}; /** * This function is called for each guideeditor on page. */ M.gradingform_guideeditor.init = function(Y, options) { M.gradingform_guideeditor.name = options.name M.gradingform_guideeditor.Y = Y M.gradingform_guideeditor.templates[options.name] = { 'criterion' : options.criteriontemplate, 'comment' : options.commenttemplate } M.gradingform_guideeditor.disablealleditors() Y.on('click', M.gradingform_guideeditor.clickanywhere, 'body', null) YUI().use('event-touch', function (Y) { Y.one('body').on('touchstart', M.gradingform_guideeditor.clickanywhere); Y.one('body').on('touchend', M.gradingform_guideeditor.clickanywhere); }) M.gradingform_guideeditor.addhandlers() }; // Adds handlers for clicking submit button. This function must be called each time JS adds new elements to html M.gradingform_guideeditor.addhandlers = function() { var Y = M.gradingform_guideeditor.Y var name = M.gradingform_guideeditor.name if (M.gradingform_guideeditor.eventhandler) { M.gradingform_guideeditor.eventhandler.detach() } M.gradingform_guideeditor.eventhandler = Y.on('click', M.gradingform_guideeditor.buttonclick, '#guide-'+name+' input[type=submit]', null); } // switches all input text elements to non-edit mode M.gradingform_guideeditor.disablealleditors = function() { var Y = M.gradingform_guideeditor.Y var name = M.gradingform_guideeditor.name Y.all('#guide-'+name+' .criteria .description input[type=text]:not(.pseudotablink)').each( function(node) {M.gradingform_guideeditor.editmode(node, false)} ); Y.all('#guide-'+name+' .criteria .description textarea').each( function(node) {M.gradingform_guideeditor.editmode(node, false)} ); Y.all('#guide-'+name+' .comments .description textarea').each( function(node) {M.gradingform_guideeditor.editmode(node, false)} ); } // function invoked on each click on the page. If criterion values are clicked // it switches the element to edit mode. If guide button is clicked it does nothing so the 'buttonclick' // function is invoked M.gradingform_guideeditor.clickanywhere = function(e) { if (e.type == 'touchstart') { return } var el = e.target // if clicked on button - disablecurrenteditor, continue if (el.get('tagName') == 'INPUT' && el.get('type') == 'submit') { return } // if clicked on description item and this item is not enabled - enable it var container = null if ((container = el.ancestor('.criterionname')) || (container = el.ancestor('.criterionmaxscore'))) { el = container.one('input[type=text]') } else if ((container = el.ancestor('.criteriondesc')) || (container = el.ancestor('.criteriondescmarkers'))) { el = container.one('textarea') } else { el = null } if (el) { if (el.hasClass('hiddenelement')) { M.gradingform_guideeditor.disablealleditors() M.gradingform_guideeditor.editmode(el, true) } return } // else disablecurrenteditor M.gradingform_guideeditor.disablealleditors() } // switch the criterion item to edit mode or switch back M.gradingform_guideeditor.editmode = function(el, editmode) { var Y = M.gradingform_guideeditor.Y var ta = el if (!editmode && ta.hasClass('hiddenelement')) { return; } if (editmode && !ta.hasClass('hiddenelement')) { return; } var pseudotablink = '<span class="pseudotablink" tabindex="0"></span>', taplain = ta.next('.plainvalue'), tbplain = null, tb = el.one('.score input[type=text]') // add 'plainvalue' next to textarea for description/definition and next to input text field for score (if applicable) if (!taplain && ta.get('name') != '') { ta.insert('<div class="plainvalue">'+pseudotablink+'<span class="textvalue"> </span></div>', 'after') taplain = ta.next('.plainvalue') taplain.one('.pseudotablink').on('focus', M.gradingform_guideeditor.clickanywhere) if (tb) { tb.get('parentNode').append('<span class="plainvalue">'+pseudotablink+'<span class="textvalue"> </span></span>') tbplain = tb.get('parentNode').one('.plainvalue') tbplain.one('.pseudotablink').on('focus', M.gradingform_guideeditor.clickanywhere) } } if (tb && !tbplain) { tbplain = tb.get('parentNode').one('.plainvalue') } if (!editmode) { // if we need to hide the input fields, copy their contents to plainvalue(s). If description/definition // is empty, display the default text ('Click to edit ...') and add/remove 'empty' CSS class to element var value = Y.Lang.trim(ta.get('value')); if (value.length) { taplain.removeClass('empty') } else if (ta.get('name').indexOf('[shortname]') > 1){ value = M.util.get_string('clicktoeditname', 'gradingform_guide') taplain.addClass('editname') } else { value = M.util.get_string('clicktoedit', 'gradingform_guide') taplain.addClass('empty') } // Replace newlines with <br> tags, when displaying in the page. taplain.one('.textvalue').set('innerHTML', Y.Escape.html(value).replace(/(?:\r\n|\r|\n)/g, '<br>')) if (tb) { tbplain.one('.textvalue').set('innerHTML', Y.Escape.html(tb.get('value'))) } // hide/display textarea, textbox and plaintexts taplain.removeClass('hiddenelement') ta.addClass('hiddenelement') if (tb) { tbplain.removeClass('hiddenelement') tb.addClass('hiddenelement') } } else { // if we need to show the input fields, set the width/height for textarea so it fills the cell try { if (ta.get('name').indexOf('[maxscore]') > 1) { ta.setStyle('width', '25px'); } else { var width = parseFloat(ta.get('parentNode').getComputedStyle('width'))-10, height = parseFloat(ta.get('parentNode').getComputedStyle('height')) ta.setStyle('width', Math.max(width,50)+'px') ta.setStyle('height', Math.max(height,30)+'px') } } catch (err) { // this browser do not support 'computedStyle', leave the default size of the textbox } // hide/display textarea, textbox and plaintexts taplain.addClass('hiddenelement') ta.removeClass('hiddenelement') if (tb) { tbplain.addClass('hiddenelement') tb.removeClass('hiddenelement') } } // focus the proper input field in edit mode if (editmode) { ta.focus() } } // handler for clicking on submit buttons within guideeditor element. Adds/deletes/rearranges criteria/comments on client side M.gradingform_guideeditor.buttonclick = function(e, confirmed) { var Y = M.gradingform_guideeditor.Y var name = M.gradingform_guideeditor.name if (e.target.get('type') != 'submit') { return; } M.gradingform_guideeditor.disablealleditors() var chunks = e.target.get('id').split('-') var section = chunks[1] var action = chunks[chunks.length-1] if (chunks[0] != name || (section != 'criteria' && section != 'comments')) { return; } // prepare the id of the next inserted criterion var elements_str; if (section == 'criteria') { elements_str = '#guide-'+name+' .criteria .criterion' } else if (section == 'comments') { elements_str = '#guide-'+name+' .comments .criterion' } var newid = 0; if (action == 'addcriterion' || action == 'addcomment') { newid = M.gradingform_guideeditor.calculatenewid(elements_str); } if (chunks.length == 3 && (action == 'addcriterion' || action == 'addcomment')) { // ADD NEW CRITERION OR COMMENT var parentel = Y.one('#'+name+'-'+section) if (parentel.one('>tbody')) { parentel = parentel.one('>tbody') } if (section == 'criteria') { var newcriterion = M.gradingform_guideeditor.templates[name]['criterion'] parentel.append(newcriterion.replace(/\{CRITERION-id\}/g, 'NEWID'+newid).replace(/\{.+?\}/g, '')) } else if (section == 'comments') { var newcomment = M.gradingform_guideeditor.templates[name]['comment'] parentel.append(newcomment.replace(/\{COMMENT-id\}/g, 'NEWID'+newid).replace(/\{.+?\}/g, '')) } M.gradingform_guideeditor.addhandlers(); M.gradingform_guideeditor.disablealleditors() M.gradingform_guideeditor.assignclasses(elements_str) // Enable edit mode of the newly added criterion/comment entry. var inputTarget = 'shortname'; if (action == 'addcomment') { inputTarget = 'description'; } var inputTargetId = '#guide-' + name + ' #' + name + '-' + section + '-NEWID' + newid + '-' + inputTarget; M.gradingform_guideeditor.editmode(Y.one(inputTargetId), true); } else if (chunks.length == 4 && action == 'moveup') { // MOVE UP el = Y.one('#'+name+'-'+section+'-'+chunks[2]) if (el.previous()) { el.get('parentNode').insertBefore(el, el.previous()) } M.gradingform_guideeditor.assignclasses(elements_str) } else if (chunks.length == 4 && action == 'movedown') { // MOVE DOWN el = Y.one('#'+name+'-'+section+'-'+chunks[2]) if (el.next()) { el.get('parentNode').insertBefore(el.next(), el) } M.gradingform_guideeditor.assignclasses(elements_str) } else if (chunks.length == 4 && action == 'delete') { // DELETE if (confirmed) { Y.one('#'+name+'-'+section+'-'+chunks[2]).remove() M.gradingform_guideeditor.assignclasses(elements_str) } else { require(['core/notification', 'core/str'], function(Notification, Str) { Notification.saveCancelPromise( Str.get_string('confirmation', 'admin'), Str.get_string('confirmdeletecriterion', 'gradingform_guide'), Str.get_string('yes', 'moodle') ).then(function() { M.gradingform_guideeditor.buttonclick.apply(this, [e, true]); return; }.bind(this)).catch(function() { // User cancelled. }); }.bind(this)); } } else { // unknown action return; } e.preventDefault(); } // properly set classes (first/last/odd/even) and/or criterion sortorder for elements Y.all(elements_str) M.gradingform_guideeditor.assignclasses = function (elements_str) { var elements = M.gradingform_guideeditor.Y.all(elements_str) for (var i=0; i<elements.size(); i++) { elements.item(i).removeClass('first').removeClass('last').removeClass('even').removeClass('odd'). addClass(((i%2)?'odd':'even') + ((i==0)?' first':'') + ((i==elements.size()-1)?' last':'')) elements.item(i).all('input[type=hidden]').each( function(node) {if (node.get('name').match(/sortorder/)) { node.set('value', i)}} ); } } // returns unique id for the next added element, it should not be equal to any of Y.all(elements_str) ids M.gradingform_guideeditor.calculatenewid = function (elements_str) { var newid = 1 M.gradingform_guideeditor.Y.all(elements_str).each( function(node) { var idchunks = node.get('id').split('-'), id = idchunks.pop(); if (id.match(/^NEWID(\d+)$/)) { newid = Math.max(newid, parseInt(id.substring(5))+1)}; } ); return newid } grading/form/guide/js/guide.js 0000604 00000002074 15062070556 0012273 0 ustar 00 M.gradingform_guide = {}; /** * This function is called for each guide on page. */ M.gradingform_guide.init = function(Y, options) { var currentfocus = Y.one('.markingguideremark'); Y.all('.markingguideremark').on('blur', function(e) { currentfocus = e.currentTarget; }); Y.all('.markingguidecomment').on('click', function(e) { currentfocus.set('value', currentfocus.get('value') + '\n' + e.currentTarget.get('text')); currentfocus.focus(); }); Y.all('.showmarkerdesc input[type=radio]').on('click', function(e) { if (e.currentTarget.get('value')=='false') { Y.all('.criteriondescriptionmarkers').addClass('hide'); } else { Y.all('.criteriondescriptionmarkers').removeClass('hide'); } }); Y.all('.showstudentdesc input[type=radio]').on('click', function(e) { if (e.currentTarget.get('value')=='false') { Y.all('.criteriondescription').addClass('hide'); } else { Y.all('.criteriondescription').removeClass('hide'); } }); }; grading/form/guide/tests/grades/grader/gradingpanel/external/store_test.php 0000604 00000023107 15062070556 0023260 0 ustar 00 <?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/>. declare(strict_types = 1); namespace gradingform_guide\grades\grader\gradingpanel\external; use advanced_testcase; use coding_exception; use core_grades\component_gradeitem; use core_external\external_api; use mod_forum\local\entities\forum as forum_entity; use moodle_exception; /** * Unit tests for core_grades\component_gradeitems; * * @package gradingform_guide * @category test * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class store_test extends advanced_testcase { /** * Ensure that an execute with an invalid component is rejected. */ public function test_execute_invalid_component(): void { $this->resetAfterTest(); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(coding_exception::class); $this->expectExceptionMessage("The 'foo' item is not valid for the 'mod_invalid' component"); store::execute('mod_invalid', 1, 'foo', 2, false, 'formdata'); } /** * Ensure that an execute with an invalid itemname on a valid component is rejected. */ public function test_execute_invalid_itemname(): void { $this->resetAfterTest(); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(coding_exception::class); $this->expectExceptionMessage("The 'foo' item is not valid for the 'mod_forum' component"); store::execute('mod_forum', 1, 'foo', 2, false, 'formdata'); } /** * Ensure that an execute against a different grading method is rejected. */ public function test_execute_incorrect_type(): void { $this->resetAfterTest(); $forum = $this->get_forum_instance([ 'grade_forum' => 5, ]); $course = $forum->get_course_record(); $teacher = $this->getDataGenerator()->create_and_enrol($course, 'teacher'); $student = $this->getDataGenerator()->create_and_enrol($course, 'student'); $this->setUser($teacher); $gradeitem = component_gradeitem::instance('mod_forum', $forum->get_context(), 'forum'); $this->expectException(moodle_exception::class); $this->expectExceptionMessage("not configured for advanced grading with a marking guide"); store::execute('mod_forum', (int) $forum->get_context()->id, 'forum', (int) $student->id, false, 'formdata'); } /** * Ensure that an execute against a different grading method is rejected. */ public function test_execute_disabled(): void { $this->resetAfterTest(); $forum = $this->get_forum_instance(); $course = $forum->get_course_record(); $teacher = $this->getDataGenerator()->create_and_enrol($course, 'teacher'); $student = $this->getDataGenerator()->create_and_enrol($course, 'student'); $this->setUser($teacher); $gradeitem = component_gradeitem::instance('mod_forum', $forum->get_context(), 'forum'); $this->expectException(moodle_exception::class); $this->expectExceptionMessage("Grading is not enabled"); store::execute('mod_forum', (int) $forum->get_context()->id, 'forum', (int) $student->id, false, 'formdata'); } /** * Ensure that an execute against the correct grading method returns the current state of the user. */ public function test_execute_store_graded(): void { $this->resetAfterTest(); $generator = \testing_util::get_data_generator(); $guidegenerator = $generator->get_plugin_generator('gradingform_guide'); [ 'forum' => $forum, 'controller' => $controller, 'definition' => $definition, 'student' => $student, 'teacher' => $teacher, ] = $this->get_test_data(); $this->setUser($teacher); $gradeitem = component_gradeitem::instance('mod_forum', $forum->get_context(), 'forum'); $grade = $gradeitem->get_grade_for_user($student, $teacher); $instance = $gradeitem->get_advanced_grading_instance($teacher, $grade); $submissiondata = $guidegenerator->get_test_form_data($controller, (int) $student->id, 10, 'Propper good speling', 0, 'ASCII art is not a picture' ); $formdata = http_build_query((object) [ 'instanceid' => $instance->get_id(), 'advancedgrading' => $submissiondata, ], '', '&'); $result = store::execute('mod_forum', (int) $forum->get_context()->id, 'forum', (int) $student->id, false, $formdata); $result = external_api::clean_returnvalue(store::execute_returns(), $result); $this->assertIsArray($result); $this->assertArrayHasKey('templatename', $result); $this->assertEquals('gradingform_guide/grades/grader/gradingpanel', $result['templatename']); $this->assertArrayHasKey('warnings', $result); $this->assertIsArray($result['warnings']); $this->assertEmpty($result['warnings']); // Test the grade array items. $this->assertArrayHasKey('grade', $result); $this->assertIsArray($result['grade']); $this->assertIsInt($result['grade']['timecreated']); $this->assertArrayHasKey('timemodified', $result['grade']); $this->assertIsInt($result['grade']['timemodified']); $this->assertArrayHasKey('usergrade', $result['grade']); $this->assertEquals('0.50 / 2.00', $result['grade']['usergrade']); $this->assertArrayHasKey('maxgrade', $result['grade']); $this->assertIsInt($result['grade']['maxgrade']); $this->assertEquals(2, $result['grade']['maxgrade']); $this->assertArrayHasKey('gradedby', $result['grade']); $this->assertEquals(fullname($teacher), $result['grade']['gradedby']); $this->assertArrayHasKey('criterion', $result['grade']); $criteria = $result['grade']['criterion']; $this->assertCount(count($definition->guide_criteria), $criteria); foreach ($criteria as $criterion) { $this->assertArrayHasKey('id', $criterion); $criterionid = $criterion['id']; $sourcecriterion = $definition->guide_criteria[$criterionid]; $this->assertArrayHasKey('name', $criterion); $this->assertEquals($sourcecriterion['shortname'], $criterion['name']); $this->assertArrayHasKey('maxscore', $criterion); $this->assertEquals($sourcecriterion['maxscore'], $criterion['maxscore']); $this->assertArrayHasKey('description', $criterion); $this->assertEquals($sourcecriterion['description'], $criterion['description']); $this->assertArrayHasKey('descriptionmarkers', $criterion); $this->assertEquals($sourcecriterion['descriptionmarkers'], $criterion['descriptionmarkers']); $this->assertArrayHasKey('score', $criterion); $this->assertArrayHasKey('remark', $criterion); } $this->assertEquals(10, $criteria[0]['score']); $this->assertEquals('Propper good speling', $criteria[0]['remark']); $this->assertEquals(0, $criteria[1]['score']); $this->assertEquals('ASCII art is not a picture', $criteria[1]['remark']); } /** * Get a forum instance. * * @param array $config * @return forum_entity */ protected function get_forum_instance(array $config = []): forum_entity { $this->resetAfterTest(); $datagenerator = $this->getDataGenerator(); $course = $datagenerator->create_course(); $forum = $datagenerator->create_module('forum', array_merge($config, ['course' => $course->id])); $vaultfactory = \mod_forum\local\container::get_vault_factory(); $vault = $vaultfactory->get_forum_vault(); return $vault->get_from_id((int) $forum->id); } /** * Get test data for forums graded using a marking guide. * * @return array */ protected function get_test_data(): array { global $DB; $this->resetAfterTest(); $generator = \testing_util::get_data_generator(); $guidegenerator = $generator->get_plugin_generator('gradingform_guide'); $forum = $this->get_forum_instance(); $course = $forum->get_course_record(); $teacher = $this->getDataGenerator()->create_and_enrol($course, 'teacher'); $student = $this->getDataGenerator()->create_and_enrol($course, 'student'); $this->setUser($teacher); $controller = $guidegenerator->get_test_guide($forum->get_context(), 'forum', 'forum'); $definition = $controller->get_definition(); $DB->set_field('forum', 'grade_forum', count($definition->guide_criteria), ['id' => $forum->get_id()]); return [ 'forum' => $forum, 'controller' => $controller, 'definition' => $definition, 'student' => $student, 'teacher' => $teacher, ]; } } grading/form/guide/tests/grades/grader/gradingpanel/external/fetch_test.php 0000604 00000035526 15062070556 0023225 0 ustar 00 <?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/>. declare(strict_types = 1); namespace gradingform_guide\grades\grader\gradingpanel\external; use advanced_testcase; use coding_exception; use core_grades\component_gradeitem; use core_external\external_api; use mod_forum\local\entities\forum as forum_entity; use moodle_exception; /** * Unit tests for core_grades\component_gradeitems; * * @package gradingform_guide * @category test * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class fetch_test extends advanced_testcase { /** * Ensure that an execute with an invalid component is rejected. */ public function test_execute_invalid_component(): void { $this->resetAfterTest(); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(coding_exception::class); $this->expectExceptionMessage("The 'foo' item is not valid for the 'mod_invalid' component"); fetch::execute('mod_invalid', 1, 'foo', 2); } /** * Ensure that an execute with an invalid itemname on a valid component is rejected. */ public function test_execute_invalid_itemname(): void { $this->resetAfterTest(); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(coding_exception::class); $this->expectExceptionMessage("The 'foo' item is not valid for the 'mod_forum' component"); fetch::execute('mod_forum', 1, 'foo', 2); } /** * Ensure that an execute against a different grading method is rejected. */ public function test_execute_incorrect_type(): void { $this->resetAfterTest(); $forum = $this->get_forum_instance([ // Negative numbers mean a scale. 'grade_forum' => 5, ]); $course = $forum->get_course_record(); $teacher = $this->getDataGenerator()->create_and_enrol($course, 'teacher'); $student = $this->getDataGenerator()->create_and_enrol($course, 'student'); $this->setUser($teacher); $gradeitem = component_gradeitem::instance('mod_forum', $forum->get_context(), 'forum'); $this->expectException(moodle_exception::class); $this->expectExceptionMessage("not configured for advanced grading with a marking guide"); fetch::execute('mod_forum', (int) $forum->get_context()->id, 'forum', (int) $student->id); } /** * Ensure that an execute against the correct grading method returns the current state of the user. */ public function test_execute_fetch_empty(): void { $this->resetAfterTest(); [ 'forum' => $forum, 'controller' => $controller, 'definition' => $definition, 'student' => $student, 'teacher' => $teacher, ] = $this->get_test_data(); $this->setUser($teacher); $gradeitem = component_gradeitem::instance('mod_forum', $forum->get_context(), 'forum'); $result = fetch::execute('mod_forum', (int) $forum->get_context()->id, 'forum', (int) $student->id); $result = external_api::clean_returnvalue(fetch::execute_returns(), $result); $this->assertIsArray($result); $this->assertArrayHasKey('templatename', $result); $this->assertEquals('gradingform_guide/grades/grader/gradingpanel', $result['templatename']); $this->assertArrayHasKey('warnings', $result); $this->assertIsArray($result['warnings']); $this->assertEmpty($result['warnings']); // Test the grade array items. $this->assertArrayHasKey('grade', $result); $this->assertIsArray($result['grade']); $this->assertIsInt($result['grade']['timecreated']); $this->assertArrayHasKey('timemodified', $result['grade']); $this->assertIsInt($result['grade']['timemodified']); $this->assertArrayHasKey('usergrade', $result['grade']); $this->assertEquals('- / 100.00', $result['grade']['usergrade']); $this->assertArrayHasKey('maxgrade', $result['grade']); $this->assertIsInt($result['grade']['maxgrade']); $this->assertEquals(100, $result['grade']['maxgrade']); $this->assertArrayHasKey('gradedby', $result['grade']); $this->assertEquals(null, $result['grade']['gradedby']); $this->assertArrayHasKey('criterion', $result['grade']); $criteria = $result['grade']['criterion']; $this->assertCount(count($definition->guide_criteria), $criteria); foreach ($criteria as $criterion) { $this->assertArrayHasKey('id', $criterion); $criterionid = $criterion['id']; $sourcecriterion = $definition->guide_criteria[$criterionid]; $this->assertArrayHasKey('name', $criterion); $this->assertEquals($sourcecriterion['shortname'], $criterion['name']); $this->assertArrayHasKey('maxscore', $criterion); $this->assertEquals($sourcecriterion['maxscore'], $criterion['maxscore']); $this->assertArrayHasKey('description', $criterion); $this->assertEquals($sourcecriterion['description'], $criterion['description']); $this->assertArrayHasKey('descriptionmarkers', $criterion); $this->assertEquals($sourcecriterion['descriptionmarkers'], $criterion['descriptionmarkers']); $this->assertArrayHasKey('score', $criterion); $this->assertEmpty($criterion['score']); $this->assertArrayHasKey('remark', $criterion); $this->assertEmpty($criterion['remark']); } } /** * Ensure that an execute against the correct grading method returns the current state of the user. */ public function test_execute_fetch_graded(): void { $this->resetAfterTest(); [ 'forum' => $forum, 'controller' => $controller, 'definition' => $definition, 'student' => $student, 'teacher' => $teacher, ] = $this->get_test_data(); $this->execute_and_assert_fetch($forum, $controller, $definition, $teacher, $teacher, $student); } /** * Class mates should not get other's grades. */ public function test_execute_fetch_does_not_return_data_to_other_students(): void { $this->resetAfterTest(); [ 'forum' => $forum, 'controller' => $controller, 'definition' => $definition, 'student' => $student, 'teacher' => $teacher, 'course' => $course, ] = $this->get_test_data(); $evilstudent = $this->getDataGenerator()->create_and_enrol($course, 'student'); $this->expectException(\required_capability_exception::class); $this->execute_and_assert_fetch($forum, $controller, $definition, $evilstudent, $teacher, $student); } /** * Grades can be returned to graded user. */ public function test_execute_fetch_return_data_to_graded_user(): void { $this->resetAfterTest(); [ 'forum' => $forum, 'controller' => $controller, 'definition' => $definition, 'student' => $student, 'teacher' => $teacher, ] = $this->get_test_data(); $this->execute_and_assert_fetch($forum, $controller, $definition, $student, $teacher, $student); } /** * Executes and performs all the assertions of the fetch method with the given parameters. */ private function execute_and_assert_fetch ($forum, $controller, $definition, $fetcheruser, $grader, $gradeduser) { $generator = \testing_util::get_data_generator(); $guidegenerator = $generator->get_plugin_generator('gradingform_guide'); $this->setUser($grader); $gradeitem = component_gradeitem::instance('mod_forum', $forum->get_context(), 'forum'); $grade = $gradeitem->get_grade_for_user($gradeduser, $grader); $instance = $gradeitem->get_advanced_grading_instance($grader, $grade); $submissiondata = $guidegenerator->get_test_form_data($controller, (int) $gradeduser->id, 10, 'Propper good speling', 0, 'ASCII art is not a picture' ); $gradeitem->store_grade_from_formdata($gradeduser, $grader, (object) [ 'instanceid' => $instance->get_id(), 'advancedgrading' => $submissiondata, ]); $this->setUser($fetcheruser); // Set up some items we need to return on other interfaces. $result = fetch::execute('mod_forum', (int) $forum->get_context()->id, 'forum', (int) $gradeduser->id); $result = external_api::clean_returnvalue(fetch::execute_returns(), $result); $this->assertIsArray($result); $this->assertArrayHasKey('templatename', $result); $this->assertEquals('gradingform_guide/grades/grader/gradingpanel', $result['templatename']); $this->assertArrayHasKey('warnings', $result); $this->assertIsArray($result['warnings']); $this->assertEmpty($result['warnings']); // Test the grade array items. $this->assertArrayHasKey('grade', $result); $this->assertIsArray($result['grade']); $this->assertIsInt($result['grade']['timecreated']); $this->assertArrayHasKey('timemodified', $result['grade']); $this->assertIsInt($result['grade']['timemodified']); $this->assertArrayHasKey('usergrade', $result['grade']); $this->assertEquals('25.00 / 100.00', $result['grade']['usergrade']); $this->assertArrayHasKey('maxgrade', $result['grade']); $this->assertIsInt($result['grade']['maxgrade']); $this->assertEquals(100, $result['grade']['maxgrade']); $this->assertArrayHasKey('gradedby', $result['grade']); $this->assertEquals(fullname($grader), $result['grade']['gradedby']); $this->assertArrayHasKey('criterion', $result['grade']); $criteria = $result['grade']['criterion']; $this->assertCount(count($definition->guide_criteria), $criteria); foreach ($criteria as $criterion) { $this->assertArrayHasKey('id', $criterion); $criterionid = $criterion['id']; $sourcecriterion = $definition->guide_criteria[$criterionid]; $this->assertArrayHasKey('name', $criterion); $this->assertEquals($sourcecriterion['shortname'], $criterion['name']); $this->assertArrayHasKey('maxscore', $criterion); $this->assertEquals($sourcecriterion['maxscore'], $criterion['maxscore']); $this->assertArrayHasKey('description', $criterion); $this->assertEquals($sourcecriterion['description'], $criterion['description']); $this->assertArrayHasKey('descriptionmarkers', $criterion); $this->assertEquals($sourcecriterion['descriptionmarkers'], $criterion['descriptionmarkers']); $this->assertArrayHasKey('score', $criterion); $this->assertArrayHasKey('remark', $criterion); } $this->assertEquals(10, $criteria[0]['score']); $this->assertEquals('Propper good speling', $criteria[0]['remark']); $this->assertEquals(0, $criteria[1]['score']); $this->assertEquals('ASCII art is not a picture', $criteria[1]['remark']); } /** * Get a forum instance. * * @param array $config * @return forum_entity */ protected function get_forum_instance(array $config = []): forum_entity { $this->resetAfterTest(); $datagenerator = $this->getDataGenerator(); $course = $datagenerator->create_course(); $forum = $datagenerator->create_module('forum', array_merge($config, ['course' => $course->id, 'grade_forum' => 100])); $vaultfactory = \mod_forum\local\container::get_vault_factory(); $vault = $vaultfactory->get_forum_vault(); return $vault->get_from_id((int) $forum->id); } /** * Get test data for forums graded using a marking guide. * * @return array */ protected function get_test_data(): array { global $DB; $this->resetAfterTest(); $generator = \testing_util::get_data_generator(); $guidegenerator = $generator->get_plugin_generator('gradingform_guide'); $forum = $this->get_forum_instance(); $course = $forum->get_course_record(); $teacher = $this->getDataGenerator()->create_and_enrol($course, 'teacher'); $student = $this->getDataGenerator()->create_and_enrol($course, 'student'); $this->setUser($teacher); $controller = $guidegenerator->get_test_guide($forum->get_context(), 'forum', 'forum'); $definition = $controller->get_definition(); // In the situation of mod_forum this would be the id from forum_grades. $itemid = 1; $instance = $controller->create_instance($student->id, $itemid); $data = $this->get_test_form_data( $controller, $itemid, 5, 'This user made several mistakes.', 10, 'This user has two pictures.' ); // Update this instance with data. $instance->update($data); return [ 'forum' => $forum, 'controller' => $controller, 'definition' => $definition, 'student' => $student, 'teacher' => $teacher, 'course' => $course, ]; } /** * Fetch a set of sample data. * * @param \gradingform_guide_controller $controller * @param int $itemid * @param float $spellingscore * @param string $spellingremark * @param float $picturescore * @param string $pictureremark * @return array */ protected function get_test_form_data( \gradingform_guide_controller $controller, int $itemid, float $spellingscore, string $spellingremark, float $picturescore, string $pictureremark ): array { $generator = \testing_util::get_data_generator(); $guidegenerator = $generator->get_plugin_generator('gradingform_guide'); return $guidegenerator->get_test_form_data( $controller, $itemid, $spellingscore, $spellingremark, $picturescore, $pictureremark ); } } grading/form/guide/tests/generator_test.php 0000604 00000026277 15062070556 0015137 0 ustar 00 <?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/>. /** * Generator testcase for the gradingforum_guide generator. * * @package gradingform_guide * @category test * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradingform_guide; use context_module; use gradingform_controller; use gradingform_guide_controller; /** * Generator testcase for the gradingforum_guide generator. * * @package gradingform_guide * @category test * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class generator_test extends \advanced_testcase { /** * Test guide creation. */ public function test_guide_creation(): void { global $DB; $this->resetAfterTest(true); // Fetch generators. $generator = \testing_util::get_data_generator(); $guidegenerator = $generator->get_plugin_generator('gradingform_guide'); // Create items required for testing. $course = $generator->create_course(); $module = $generator->create_module('assign', ['course' => $course]); $user = $generator->create_user(); $context = context_module::instance($module->cmid); // Data for testing. $name = 'myfirstguide'; $description = 'My first guide'; $criteria = [ 'Alphabet' => [ 'description' => 'How well you know your alphabet', 'descriptionmarkers' => 'Basic literacy: Alphabet', 'maxscore' => 5, ], 'Times tables' => [ 'description' => 'How well you know your times-tables', 'descriptionmarkers' => 'Basic numeracy: Multiplication', 'maxscore' => 10, ], ]; // Unit under test. $this->setUser($user); $controller = $guidegenerator->create_instance($context, 'mod_assign', 'submission', $name, $description, $criteria); $this->assertInstanceOf(gradingform_guide_controller::class, $controller); $definition = $controller->get_definition(); $this->assertEquals('guide', $definition->method); $this->assertNotEmpty($definition->id); $this->assertEquals($name, $definition->name); $this->assertEquals($description, $definition->description); $this->assertEquals(gradingform_controller::DEFINITION_STATUS_READY, $definition->status); $this->assertNotEmpty($definition->timecreated); $this->assertNotEmpty($definition->timemodified); $this->assertEquals($user->id, $definition->usercreated); $this->assertNotEmpty($definition->guide_criteria); $this->assertCount(2, $definition->guide_criteria); // Check the alphabet criteria. $criteriaids = array_keys($definition->guide_criteria); $alphabet = $definition->guide_criteria[$criteriaids[0]]; $this->assertNotEmpty($alphabet['id']); $this->assertEquals(1, $alphabet['sortorder']); $this->assertEquals('How well you know your alphabet', $alphabet['description']); $this->assertEquals('Basic literacy: Alphabet', $alphabet['descriptionmarkers']); $this->assertEquals(5, $alphabet['maxscore']); // Check the times tables criteria. $tables = $definition->guide_criteria[$criteriaids[1]]; $this->assertNotEmpty($tables['id']); $this->assertEquals(2, $tables['sortorder']); $this->assertEquals('How well you know your times-tables', $tables['description']); $this->assertEquals('Basic numeracy: Multiplication', $tables['descriptionmarkers']); $this->assertEquals(10, $tables['maxscore']); } /** * Test the get_criterion_for_values function. * This is used for finding criterion and level information within a guide. */ public function test_get_criterion_for_values(): void { global $DB; $this->resetAfterTest(true); // Fetch generators. $generator = \testing_util::get_data_generator(); $guidegenerator = $generator->get_plugin_generator('gradingform_guide'); // Create items required for testing. $course = $generator->create_course(); $module = $generator->create_module('assign', ['course' => $course]); $user = $generator->create_user(); $context = context_module::instance($module->cmid); // Data for testing. $name = 'myfirstguide'; $description = 'My first guide'; $criteria = [ 'Alphabet' => [ 'description' => 'How well you know your alphabet', 'descriptionmarkers' => 'Basic literacy: Alphabet', 'maxscore' => 5, ], 'Times tables' => [ 'description' => 'How well you know your times-tables', 'descriptionmarkers' => 'Basic numeracy: Multiplication', 'maxscore' => 10, ], ]; $this->setUser($user); $controller = $guidegenerator->create_instance($context, 'mod_assign', 'submission', $name, $description, $criteria); // Valid criterion. $result = $guidegenerator->get_criterion_for_values($controller, 'Alphabet', 2); $this->assertEquals('Alphabet', $result->shortname); $this->assertEquals('How well you know your alphabet', $result->description); $this->assertEquals('Basic literacy: Alphabet', $result->descriptionmarkers); $this->assertEquals(5, $result->maxscore); // Invalid criterion. $result = $guidegenerator->get_criterion_for_values($controller, 'Foo', 0); $this->assertNull($result); } /** * Tests for the get_test_guide function. */ public function test_get_test_guide(): void { global $DB; $this->resetAfterTest(true); // Fetch generators. $generator = \testing_util::get_data_generator(); $guidegenerator = $generator->get_plugin_generator('gradingform_guide'); // Create items required for testing. $course = $generator->create_course(); $module = $generator->create_module('assign', ['course' => $course]); $user = $generator->create_user(); $context = context_module::instance($module->cmid); $this->setUser($user); $guide = $guidegenerator->get_test_guide($context, 'assign', 'submissions'); $definition = $guide->get_definition(); $this->assertEquals('testguide', $definition->name); $this->assertEquals('Description text', $definition->description); $this->assertEquals(gradingform_controller::DEFINITION_STATUS_READY, $definition->status); // Should create a guide with 2 criterion. $this->assertCount(2, $definition->guide_criteria); } /** * Test the get_submitted_form_data function. */ public function test_get_submitted_form_data(): void { global $DB; $this->resetAfterTest(true); // Fetch generators. $generator = \testing_util::get_data_generator(); $guidegenerator = $generator->get_plugin_generator('gradingform_guide'); // Create items required for testing. $course = $generator->create_course(); $module = $generator->create_module('assign', ['course' => $course]); $user = $generator->create_user(); $context = context_module::instance($module->cmid); $this->setUser($user); $controller = $guidegenerator->get_test_guide($context, 'assign', 'submissions'); $result = $guidegenerator->get_submitted_form_data($controller, 93, [ 'Spelling mistakes' => [ 'score' => 10, 'remark' => 'Pretty good but you had a couple of errors', ], 'Pictures' => [ 'score' => 15, 'remark' => 'Lots of nice pictures!', ] ]); $this->assertIsArray($result); $this->assertEquals(93, $result['itemid']); $this->assertIsArray($result['criteria']); $this->assertCount(2, $result['criteria']); $spelling = $guidegenerator->get_criterion_for_values($controller, 'Spelling mistakes'); $this->assertIsArray($result['criteria'][$spelling->id]); $this->assertEquals(10, $result['criteria'][$spelling->id]['score']); $this->assertEquals('Pretty good but you had a couple of errors', $result['criteria'][$spelling->id]['remark']); $pictures = $guidegenerator->get_criterion_for_values($controller, 'Pictures', 2); $this->assertIsArray($result['criteria'][$pictures->id]); $this->assertEquals(15, $result['criteria'][$pictures->id]['score']); $this->assertEquals('Lots of nice pictures!', $result['criteria'][$pictures->id]['remark']); } /** * Test the get_test_form_data function. */ public function test_get_test_form_data(): void { global $DB; $this->resetAfterTest(true); // Fetch generators. $generator = \testing_util::get_data_generator(); $guidegenerator = $generator->get_plugin_generator('gradingform_guide'); // Create items required for testing. $course = $generator->create_course(); $module = $generator->create_module('assign', ['course' => $course]); $user = $generator->create_user(); $context = context_module::instance($module->cmid); $this->setUser($user); $controller = $guidegenerator->get_test_guide($context, 'assign', 'submissions'); // Unit under test. $result = $guidegenerator->get_test_form_data( $controller, 1839, 10, 'Propper good speling', 0, 'ASCII art is not a picture' ); $this->assertIsArray($result); $this->assertEquals(1839, $result['itemid']); $this->assertIsArray($result['criteria']); $this->assertCount(2, $result['criteria']); $spelling = $guidegenerator->get_criterion_for_values($controller, 'Spelling mistakes'); $this->assertIsArray($result['criteria'][$spelling->id]); $this->assertEquals(10, $result['criteria'][$spelling->id]['score']); $this->assertEquals('Propper good speling', $result['criteria'][$spelling->id]['remark']); $pictures = $guidegenerator->get_criterion_for_values($controller, 'Pictures'); $this->assertIsArray($result['criteria'][$pictures->id]); $this->assertEquals(0, $result['criteria'][$pictures->id]['score']); $this->assertEquals('ASCII art is not a picture', $result['criteria'][$pictures->id]['remark']); } } grading/form/guide/tests/guide_test.php 0000604 00000006575 15062070556 0014245 0 ustar 00 <?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/>. namespace gradingform_guide; use gradingform_controller; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once($CFG->dirroot . '/grade/grading/lib.php'); require_once($CFG->dirroot . '/grade/grading/form/guide/lib.php'); /** * Test cases for the Marking Guide. * * @package gradingform_guide * @category test * @copyright 2015 Nikita Kalinin <nixorv@gmail.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class guide_test extends \advanced_testcase { /** * Unit test to get draft instance and create new instance. */ public function test_get_or_create_instance() { global $DB; $this->resetAfterTest(true); // Create fake areas. $fakearea = (object)array( 'contextid' => 1, 'component' => 'mod_assign', 'areaname' => 'submissions', 'activemethod' => 'guide' ); $fakearea1id = $DB->insert_record('grading_areas', $fakearea); $fakearea->contextid = 2; $fakearea2id = $DB->insert_record('grading_areas', $fakearea); // Create fake definitions. $fakedefinition = (object)array( 'areaid' => $fakearea1id, 'method' => 'guide', 'name' => 'fakedef', 'status' => gradingform_controller::DEFINITION_STATUS_READY, 'timecreated' => 0, 'usercreated' => 1, 'timemodified' => 0, 'usermodified' => 1, ); $fakedef1id = $DB->insert_record('grading_definitions', $fakedefinition); $fakedefinition->areaid = $fakearea2id; $fakedef2id = $DB->insert_record('grading_definitions', $fakedefinition); // Create fake guide instance in first area. $fakeinstance = (object)array( 'definitionid' => $fakedef1id, 'raterid' => 1, 'itemid' => 1, 'rawgrade' => null, 'status' => 0, 'feedback' => null, 'feedbackformat' => 0, 'timemodified' => 0 ); $fakeinstanceid = $DB->insert_record('grading_instances', $fakeinstance); $manager1 = get_grading_manager($fakearea1id); $manager2 = get_grading_manager($fakearea2id); $controller1 = $manager1->get_controller('guide'); $controller2 = $manager2->get_controller('guide'); $instance1 = $controller1->get_or_create_instance(0, 1, 1); $instance2 = $controller2->get_or_create_instance(0, 1, 1); // Definitions should not be the same. $this->assertEquals(false, $instance1->get_data('definitionid') == $instance2->get_data('definitionid')); } } grading/form/guide/tests/generator/lib.php 0000604 00000020325 15062070556 0014632 0 ustar 00 <?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/>. /** * Generator for the gradingforum_guide plugin. * * @package gradingform_guide * @category test * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); require_once(__DIR__ . '/guide.php'); require_once(__DIR__ . '/criterion.php'); use tests\gradingform_guide\generator\guide; use tests\gradingform_guide\generator\criterion; /** * Generator for the gradingforum_guide plugintype. * * @package gradingform_guide * @category test * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class gradingform_guide_generator extends component_generator_base { /** * Create an instance of a marking guide. * * @param context $context * @param string $component * @param string $area * @param string $name * @param string $description * @param array $criteria The list of criteria to add to the generated guide * @return gradingform_guide_controller */ public function create_instance( context $context, string $component, string $area, string $name, string $description, array $criteria ): gradingform_guide_controller { global $USER; if ($USER->id === 0) { throw new \coding_exception('Creation of a guide must currently be run as a user.'); } // Fetch the controller for this context/component/area. $generator = \testing_util::get_data_generator(); $gradinggenerator = $generator->get_plugin_generator('core_grading'); $controller = $gradinggenerator->create_instance($context, $component, $area, 'guide'); // Generate a definition for the supplied guide. $guide = $this->get_guide($name, $description); foreach ($criteria as $name => $options) { $guide->add_criteria($this->get_criterion( $name, $options['description'], $options['descriptionmarkers'], $options['maxscore'] )); } // Update the controller wih the guide definition. $controller->update_definition($guide->get_definition()); return $controller; } /** * Get a new guide for use with the guide controller. * * Note: This is just a helper class used to build a new definition. It does not persist the data. * * @param string $name * @param string $description * @return generator_guide */ protected function get_guide(string $name, string $description): guide { return new \tests\gradingform_guide\generator\guide($name, $description); } /** * Get a new criterion for use with a guide. * * Note: This is just a helper class used to build a new definition. It does not persist the data. * * @param string $shortname The shortname for the criterion * @param string $description The description for the criterion * @param string $descriptionmarkers The description for the marker for this criterion * @param float $maxscore The maximum score possible for this criterion * @return criterion */ protected function get_criterion( string $shortname, string $description, string $descriptionmarkers, float $maxscore ): criterion { return new criterion($shortname, $description, $descriptionmarkers, $maxscore); } /** * Given a controller instance, fetch the level and criterion information for the specified values. * * @param gradingform_controller $controller * @param string $shortname The shortname to match the criterion on * @return stdClass */ public function get_criterion_for_values(gradingform_controller $controller, string $shortname): ?stdClass { $definition = $controller->get_definition(); $criteria = $definition->guide_criteria; $criterion = array_reduce($criteria, function($carry, $criterion) use ($shortname) { if ($criterion['shortname'] === $shortname) { $carry = (object) $criterion; } return $carry; }, null); return $criterion; } /** * Get submitted form data * * @param gradingform_guide_controller $controller * @param int $itemid * @param array $values A set of array values where the array key is the name of the criterion, and the value is an * array with the desired score, and any remark. */ public function get_submitted_form_data(gradingform_guide_controller $controller, int $itemid, array $values): array { $result = [ 'itemid' => $itemid, 'criteria' => [], ]; foreach ($values as $criterionname => ['score' => $score, 'remark' => $remark]) { $criterion = $this->get_criterion_for_values($controller, $criterionname); $result['criteria'][$criterion->id] = [ 'score' => $score, 'remark' => $remark, ]; } return $result; } /** * Generate a guide controller with sample data required for testing of this class. * * @param context_module $context * @return gradingform_guide_controller */ public function get_test_guide( context_module $context, string $component = 'mod_assign', string $areaname = 'submission' ): gradingform_guide_controller { $generator = \testing_util::get_data_generator(); $gradinggenerator = $generator->get_plugin_generator('core_grading'); $controller = $gradinggenerator->create_instance($context, $component, $areaname, 'guide'); $generator = \testing_util::get_data_generator(); $guidegenerator = $generator->get_plugin_generator('gradingform_guide'); $guide = $guidegenerator->get_guide('testguide', 'Description text'); $guide->add_criteria($guidegenerator->get_criterion( 'Spelling mistakes', 'Full marks will be given for no spelling mistakes.', 'Deduct 5 points per spelling mistake made.', 25 )); $guide->add_criteria($guidegenerator->get_criterion( 'Pictures', 'Full marks will be given for including 3 pictures.', 'Give 5 points for each picture present', 15 )); $controller->update_definition($guide->get_definition()); return $controller; } /** * Fetch a set of sample data. * * @param gradingform_guide_controller $controller * @param int $itemid * @param float $spellingscore * @param string $spellingremark * @param float $picturescore * @param string $pictureremark * @return array */ public function get_test_form_data( gradingform_guide_controller $controller, int $itemid, float $spellingscore, string $spellingremark, float $picturescore, string $pictureremark ): array { $generator = \testing_util::get_data_generator(); $guidegenerator = $generator->get_plugin_generator('gradingform_guide'); return $guidegenerator->get_submitted_form_data($controller, $itemid, [ 'Spelling mistakes' => [ 'score' => $spellingscore, 'remark' => $spellingremark, ], 'Pictures' => [ 'score' => $picturescore, 'remark' => $pictureremark, ], ]); } } grading/form/guide/tests/generator/criterion.php 0000604 00000006646 15062070556 0016074 0 ustar 00 <?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/>. /** * Generator for the gradingforum_guide plugin. * * @package gradingform_guide * @category test * @copyright 2018 Adrian Greeve <adriangreeve.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace tests\gradingform_guide\generator; /** * Convenience class to create guide criterion. * * @package gradingform_guide * @copyright 2018 Adrian Greeve <adriangreeve.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class criterion { /** @var string $shortname A shortened name of the criterion. */ private $shortname; /** @var string $description A description of the criterion. */ private $description; /** @var string $descriptionmarkers A description of the criterion for markers. */ private $descriptionmarkers; /** @var float Maximum score */ private $maxscore = 0; /** * Constructor for this test_criterion object * * @param string $shortname The shortname for the criterion * @param string $description The description for the criterion * @param string $descriptionmarkers The description for the marker for this criterion * @param float $maxscore The maximum score possible for this criterion */ public function __construct(string $shortname, string $description, string $descriptionmarkers, float $maxscore) { $this->shortname = $shortname; $this->description = $description; $this->descriptionmarkers = $descriptionmarkers; $this->maxscore = $maxscore; } /** * Get the description for this criterion. * * @return string */ public function get_description(): string { return $this->description; } /** * Get the description for markers of this criterion. * * @return string */ public function get_descriptionmarkers(): string { return $this->descriptionmarkers; } /** * Get the shortname for this criterion. * * @return string */ public function get_shortname(): string { return $this->shortname; } /** * Get the maxscore for this criterion. * * @return float */ public function get_maxscore(): float { return $this->maxscore; } /** * Get all values in an array for use when creating a new guide. * * @param int $sortorder * @return array */ public function get_all_values(int $sortorder): array { return [ 'sortorder' => $sortorder, 'shortname' => $this->get_shortname(), 'description' => $this->get_description(), 'descriptionmarkers' => $this->get_descriptionmarkers(), 'maxscore' => $this->get_maxscore(), ]; } } grading/form/guide/tests/generator/guide.php 0000604 00000006706 15062070556 0015170 0 ustar 00 <?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/>. /** * Generator for the gradingforum_guide plugin. * * @package gradingform_guide * @category test * @copyright 2018 Adrian Greeve <adriangreeve.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace tests\gradingform_guide\generator; use gradingform_controller; use stdClass; /** * Test guide. * * @package gradingform_guide * @category test * @copyright 2018 Adrian Greeve <adriangreeve.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class guide { /** @var array $criteria The criteria for this guide. */ protected $criteria = []; /** @var string The name of this guide. */ protected $name; /** @var string A description for this guide. */ protected $description; /** @var array The guide options. */ protected $options = []; /** * Create a new gradingform_guide_generator_criterion. * * @param string $name * @param string $description */ public function __construct(string $name, string $description) { $this->name = $name; $this->description = $description; $this->set_option('alwaysshowdefinition', 1); $this->set_option('showmarkspercriterionstudents', 1); } /** * Creates the guide using the appropriate APIs. */ public function get_definition(): stdClass { return (object) [ 'name' => $this->name, 'description_editor' => [ 'text' => $this->description, 'format' => FORMAT_HTML, 'itemid' => 1 ], 'guide' => [ 'criteria' => $this->get_critiera_as_array(), 'options' => $this->options, 'comments' => [], ], 'saveguide' => 'Continue', 'status' => gradingform_controller::DEFINITION_STATUS_READY, ]; } /** * Set an option for the rubric. * * @param string $key * @param mixed $value * @return self */ public function set_option(string $key, $value): self { $this->options[$key] = $value; return $this; } /** * Adds a criterion to the guide. * * @param criterion $criterion The criterion object (class below). * @return self */ public function add_criteria(criterion $criterion): self { $this->criteria[] = $criterion; return $this; } /** * Get the criteria as an array for use in creation. * * @return array */ protected function get_critiera_as_array(): array { $return = []; foreach ($this->criteria as $index => $criterion) { $return["NEWID{$index}"] = $criterion->get_all_values($index + 1); } return $return; } } grading/form/guide/tests/privacy/provider_test.php 0000604 00000017701 15062070556 0016450 0 ustar 00 <?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/>. /** * Privacy tests for gradingform_guide. * * @package gradingform_guide * @category test * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradingform_guide\privacy; defined('MOODLE_INTERNAL') || die(); global $CFG; use core_privacy\tests\provider_testcase; use core_privacy\local\request\writer; use gradingform_guide\privacy\provider; /** * Privacy tests for gradingform_guide. * * @package gradingform_guide * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class provider_test extends provider_testcase { /** * Ensure that export_user_preferences returns no data if the user has no data. */ public function test_export_user_preferences_not_defined() { $user = \core_user::get_user_by_username('admin'); provider::export_user_preferences($user->id); $writer = writer::with_context(\context_system::instance()); $this->assertFalse($writer->has_any_data()); } /** * Ensure that export_user_preferences returns single preferences. */ public function test_export_user_preferences() { $this->resetAfterTest(); // Define a user preference. $user = $this->getDataGenerator()->create_user(); $this->setUser($user); set_user_preference('gradingform_guide-showmarkerdesc', 0, $user); set_user_preference('gradingform_guide-showstudentdesc', 1, $user); // Validate exported data. provider::export_user_preferences($user->id); $context = \context_user::instance($user->id); /** @var \core_privacy\tests\request\content_writer $writer */ $writer = writer::with_context($context); $this->assertTrue($writer->has_any_data()); $prefs = $writer->get_user_preferences('gradingform_guide'); $this->assertCount(2, (array) $prefs); $this->assertEquals( get_string('privacy:metadata:preference:showstudentdesc', 'gradingform_guide'), $prefs->{'gradingform_guide-showstudentdesc'}->description ); $this->assertEquals(get_string('no'), $prefs->{'gradingform_guide-showmarkerdesc'}->value); $this->assertEquals(get_string('yes'), $prefs->{'gradingform_guide-showstudentdesc'}->value); } /** * Test the export of guide data. */ public function test_get_gradingform_export_data() { global $DB; $this->resetAfterTest(); $course = $this->getDataGenerator()->create_course(); $module = $this->getDataGenerator()->create_module('assign', ['course' => $course]); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $modulecontext = \context_module::instance($module->cmid); $controller = $this->get_test_guide($modulecontext); // In the situation of mod_assign this would be the id from assign_grades. $itemid = 1; $instance = $controller->create_instance($user->id, $itemid); $data = $this->get_test_form_data( $controller, $itemid, 5, 'This user made several mistakes.', 10, 'This user has two pictures.' ); $instance->update($data); $instanceid = $instance->get_data('id'); // Let's try the method we are testing. provider::export_gradingform_instance_data($modulecontext, $instance->get_id(), ['Test']); $data = (array) writer::with_context($modulecontext)->get_data(['Test', 'Marking guide', $instanceid]); $this->assertCount(2, $data); $this->assertEquals('Spelling mistakes', $data['Spelling mistakes']->shortname); $this->assertEquals('This user made several mistakes.', $data['Spelling mistakes']->remark); $this->assertEquals('Pictures', $data['Pictures']->shortname); $this->assertEquals('This user has two pictures.', $data['Pictures']->remark); } /** * Test the deletion of guide user information via the instance ID. */ public function test_delete_gradingform_for_instances() { global $DB; $this->resetAfterTest(); $course = $this->getDataGenerator()->create_course(); $module = $this->getDataGenerator()->create_module('assign', ['course' => $course]); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $modulecontext = \context_module::instance($module->cmid); $controller = $this->get_test_guide($modulecontext); // In the situation of mod_assign this would be the id from assign_grades. $itemid = 1; $instance = $controller->create_instance($user->id, $itemid); $data = $this->get_test_form_data( $controller, $itemid, 5, 'This user made several mistakes.', 10, 'This user has two pictures.' ); $instance->update($data); $instanceid = $instance->get_data('id'); $itemid = 2; $instance = $controller->create_instance($user->id, $itemid); $data = $this->get_test_form_data( $controller, $itemid, 25, 'This user made no mistakes.', 5, 'This user has one pictures.' ); $instance->update($data); $instanceid = $instance->get_data('id'); // Check how many records we have in the fillings table. $records = $DB->get_records('gradingform_guide_fillings'); $this->assertCount(4, $records); // Let's delete one of the instances (the last one would be the easiest). provider::delete_gradingform_for_instances([$instance->get_id()]); $records = $DB->get_records('gradingform_guide_fillings'); $this->assertCount(2, $records); foreach ($records as $record) { $this->assertNotEquals($instance->get_id(), $record->instanceid); } } /** * Generate a guide controller with sample data required for testing of this class. * * @param \context_module $context * @return \gradingform_guide_controller */ protected function get_test_guide(\context_module $context): \gradingform_guide_controller { $generator = \testing_util::get_data_generator(); $guidegenerator = $generator->get_plugin_generator('gradingform_guide'); return $guidegenerator->get_test_guide($context); } /** * Fetch a set of sample data. * * @param \gradingform_guide_controller $controller * @param int $itemid * @param float $spellingscore * @param string $spellingremark * @param float $picturescore * @param string $pictureremark * @return array */ protected function get_test_form_data( \gradingform_guide_controller $controller, int $itemid, float $spellingscore, string $spellingremark, float $picturescore, string $pictureremark ): array { $generator = \testing_util::get_data_generator(); $guidegenerator = $generator->get_plugin_generator('gradingform_guide'); return $guidegenerator->get_test_form_data( $controller, $itemid, $spellingscore, $spellingremark, $picturescore, $pictureremark ); } } grading/form/guide/tests/behat/publish_guide_template.feature 0000604 00000005213 15062070556 0020542 0 ustar 00 @gradingform @gradingform_guide Feature: Publish guide as templates In order to save time to teachers As a manager I need to publish guides and make them available to all teachers Background: Given the following "users" exist: | username | firstname | lastname | email | | teacher1 | Teacher | 1 | teacher1@example.com | | manager1 | Manager | 1 | manager1@example.com | And the following "courses" exist: | fullname | shortname | format | | Course 1 | C1 | topics | And the following "activities" exist: | activity | course | idnumber | name | intro | advancedgradingmethod_submissions | | assign | C1 | A1 | Test assignment 1 name | TA1 | guide | | assign | C1 | A2 | Test assignment 2 name | TA2 | guide | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | And the following "system role assigns" exist: | user | role | contextlevel | reference | | manager1 | manager | System | | And I log in as "manager1" And I am on "Course 1" course homepage And I go to "Test assignment 1 name" advanced grading definition page And I set the following fields to these values: | Name | Assignment 1 marking guide | | Description | Marking guide test description | And I define the following marking guide: | Criterion name | Description for students | Description for markers | Maximum score | | Guide criterion A | Guide A description for students | Guide A description for markers | 40 | | Guide criterion B | Guide B description for students | Guide B description for markers | 60 | And I define the following frequently used comments: | Comment 1 | And I press "Save marking guide and make it ready" And I publish "Test assignment 1 name" grading form definition as a public template And I log out Scenario: Pick grading form from public template When I log in as "teacher1" And I am on "Course 1" course homepage And I go to "Test assignment 2 name" advanced grading page And I set "Test assignment 2 name" activity to use "Assignment 1 marking guide" grading form Then I should see "Ready for use" And I should see "Assignment 1 marking guide" And I should see "Marking guide test description" And I should see "Guide criterion A" And I should see "Guide criterion B" And I should see "Comment 1" grading/form/guide/tests/behat/behat_gradingform_guide.php 0000604 00000021655 15062070556 0020007 0 ustar 00 <?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/>. /** * Steps definitions for marking guides. * * @package gradingform_guide * @category test * @copyright 2015 Jun Pataleta * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once(__DIR__ . '/../../../../../../lib/behat/behat_base.php'); use Behat\Gherkin\Node\TableNode as TableNode, Behat\Mink\Exception\ElementNotFoundException as ElementNotFoundException, Behat\Mink\Exception\ExpectationException as ExpectationException; /** * Steps definitions to help with marking guides. * * @package gradingform_guide * @category test * @copyright 2015 Jun Pataleta * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class behat_gradingform_guide extends behat_base { /** * Defines the marking guide with the provided data, following marking guide's definition grid cells. * * This method fills the marking guide of the marking guide definition * form; the provided TableNode should contain one row for * each criterion and each cell of the row should contain: * # Criterion name, a.k.a. shortname * # Description for students * # Description for markers * # Max score * * Works with both JS and non-JS. * * @When /^I define the following marking guide:$/ * @throws ExpectationException * @param TableNode $guide */ public function i_define_the_following_marking_guide(TableNode $guide) { $steptableinfo = '| Criterion name | Description for students | Description for markers | Maximum score |'; if ($criteria = $guide->getHash()) { $addcriterionbutton = $this->find_button(get_string('addcriterion', 'gradingform_guide')); foreach ($criteria as $index => $criterion) { // Make sure the criterion array has 4 elements. if (count($criterion) != 4) { throw new ExpectationException( 'The criterion definition should contain name, description for students and markers, and maximum points. ' . 'Please follow this format: ' . $steptableinfo, $this->getSession() ); } // On load, there's already a criterion template ready. $shortnamevisible = false; if ($index > 0) { // So if the index is greater than 0, we click the Add new criterion button to add a new criterion. $addcriterionbutton->click(); $shortnamevisible = true; } $criterionroot = 'guide[criteria][NEWID' . ($index + 1) . ']'; // Set the field value for the Criterion name. $this->set_guide_field_value($criterionroot . '[shortname]', $criterion['Criterion name'], $shortnamevisible); // Set the field value for the Description for students field. $this->set_guide_field_value($criterionroot . '[description]', $criterion['Description for students']); // Set the field value for the Description for markers field. $this->set_guide_field_value($criterionroot . '[descriptionmarkers]', $criterion['Description for markers']); // Set the field value for the Max score field. $this->set_guide_field_value($criterionroot . '[maxscore]', $criterion['Maximum score']); } } } /** * Defines the marking guide with the provided data, following marking guide's definition grid cells. * * This method fills the table of frequently used comments of the marking guide definition form. * The provided TableNode should contain one row for each frequently used comment. * Each row contains: * # Comment * * Works with both JS and non-JS. * * @When /^I define the following frequently used comments:$/ * @throws ExpectationException * @param TableNode $commentstable */ public function i_define_the_following_frequently_used_comments(TableNode $commentstable) { $steptableinfo = '| Comment |'; if ($comments = $commentstable->getRows()) { $addcommentbutton = $this->find_button(get_string('addcomment', 'gradingform_guide')); foreach ($comments as $index => $comment) { // Make sure the comment array has only 1 element. if (count($comment) != 1) { throw new ExpectationException( 'The comment cannot be empty. Please follow this format: ' . $steptableinfo, $this->getSession() ); } // On load, there's already a comment template ready. $commentfieldvisible = false; if ($index > 0) { // So if the index is greater than 0, we click the Add frequently used comment button to add a new criterion. $addcommentbutton->click(); $commentfieldvisible = true; } $commentroot = 'guide[comments][NEWID' . ($index + 1) . ']'; // Set the field value for the frequently used comment. $this->set_guide_field_value($commentroot . '[description]', $comment[0], $commentfieldvisible); } } } /** * Performs grading of the student by filling out the marking guide. * Set one line per criterion and for each criterion set "| Criterion name | Points | Remark |". * * @When /^I grade by filling the marking guide with:$/ * * @throws ExpectationException * @param TableNode $guide * @return void */ public function i_grade_by_filling_the_marking_guide_with(TableNode $guide) { $criteria = $guide->getRowsHash(); $stepusage = '"I grade by filling the rubric with:" step needs you to provide a table where each row is a criterion' . ' and each criterion has 3 different values: | Criterion name | Number of points | Remark text |'; // First element -> name, second -> points, third -> Remark. foreach ($criteria as $name => $criterion) { // We only expect the points and the remark, as the criterion name is $name. if (count($criterion) !== 2) { throw new ExpectationException($stepusage, $this->getSession()); } // Numeric value here. $points = $criterion[0]; if (!is_numeric($points)) { throw new ExpectationException($stepusage, $this->getSession()); } $criterionid = 0; if ($criterionnamediv = $this->find('xpath', "//div[@class='criterionshortname'][text()='$name']")) { $criteriondivname = $criterionnamediv->getAttribute('name'); // Criterion's name is of the format "advancedgrading[criteria][ID][shortname]". // So just explode the string with "][" as delimiter to extract the criterion ID. if ($nameparts = explode('][', $criteriondivname)) { $criterionid = $nameparts[1]; } } if ($criterionid) { $criterionroot = 'advancedgrading[criteria]' . '[' . $criterionid . ']'; $this->execute('behat_forms::i_set_the_field_to', array($criterionroot . '[score]', $points)); $this->execute('behat_forms::i_set_the_field_to', array($criterionroot . '[remark]', $criterion[1])); } } } /** * Makes a hidden marking guide field visible (if necessary) and sets a value on it. * * @param string $name The name of the field * @param string $value The value to set * @param bool $visible * @return void */ protected function set_guide_field_value($name, $value, $visible = false) { // Fields are hidden by default. if ($this->running_javascript() && $visible === false) { $xpath = "//*[@name='$name']/following-sibling::*[contains(concat(' ', normalize-space(@class), ' '), ' plainvalue ')]"; $textnode = $this->find('xpath', $xpath); $textnode->click(); } // Set the value now. $field = $this->find_field($name); $field->setValue($value); } } grading/form/guide/tests/behat/edit_guide.feature 0000604 00000013372 15062070556 0016133 0 ustar 00 @gradingform @gradingform_guide Feature: Marking guides can be created and edited In order to use and refine marking guide to grade students As a teacher I need to edit previously used marking guides Background: Given the following "users" exist: | username | firstname | lastname | email | | teacher1 | Teacher | 1 | teacher1@example.com | | student1 | Student | 1 | student1@example.com | And the following "courses" exist: | fullname | shortname | format | | Course 1 | C1 | topics | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | And the following "activity" exists: | activity | assign | | course | C1 | | idnumber | assign1 | | name | Test assignment 1 name | | intro | Test assignment description | | section | 1 | | assignsubmission_file_enabled | 1 | | assignsubmission_onlinetext_enabled | 1 | | assignsubmission_file_maxfiles | 1 | | assignsubmission_file_maxsizebytes | 1000 | | assignfeedback_comments_enabled | 1 | | assignfeedback_file_enabled | 1 | | assignfeedback_comments_commentinline | 1 | And I am on the "Test assignment 1 name" "assign activity editing" page logged in as teacher1 And I set the following fields to these values: | Grading method | Marking guide | And I press "Save and return to course" # Defining a marking guide When I go to "Test assignment 1 name" advanced grading definition page And I change window size to "large" And I set the following fields to these values: | Name | Assignment 1 marking guide | | Description | Marking guide test description | And I define the following marking guide: | Criterion name | Description for students | Description for markers | Maximum score | | Guide criterion A | Guide A description for students | Guide A description for markers | 30 | | Guide criterion B | Guide B description for students | Guide B description for markers | 30 | | Guide criterion C | Guide C description for students | Guide C description for markers | 40 | And I define the following frequently used comments: | Comment 1 | | Comment 2 | | Comment 3 | | Comment "4" | And I press "Save marking guide and make it ready" Then I should see "Ready for use" And I should see "Guide criterion A" And I should see "Guide criterion B" And I should see "Guide criterion C" And I should see "Comment 1" And I should see "Comment 2" And I should see "Comment 3" And I should see "Comment \"4\"" @javascript Scenario: Deleting criterion and comment # Deleting criterion When I am on "Course 1" course homepage And I go to "Test assignment 1 name" advanced grading definition page And I click on "Delete criterion" "button" in the "Guide criterion B" "table_row" And I press "Yes" And I press "Save" Then I should see "Guide criterion A" And I should see "Guide criterion C" And I should see "WARNING: Your marking guide has a maximum grade of 70 points" But I should not see "Guide criterion B" # Deleting a frequently used comment When I am on "Course 1" course homepage And I go to "Test assignment 1 name" advanced grading definition page And I click on "Delete comment" "button" in the "Comment 3" "table_row" And I press "Yes" And I press "Save" Then I should see "Comment 1" And I should see "Comment 2" And I should see "Comment \"4\"" But I should not see "Comment 3" @javascript Scenario: Grading and viewing graded marking guide # Grading a student. When I navigate to "Assignment" in current page administration And I go to "Student 1" "Test assignment 1 name" activity advanced grading page And I grade by filling the marking guide with: | Guide criterion A | 25 | Very good | | Guide criterion B | 20 | | | Guide criterion C | 35 | Nice! | # Inserting frequently used comment. And I click on "Insert frequently used comment" "button" in the "Guide criterion B" "table_row" And I wait "1" seconds And I press "Comment \"4\"" And I wait "1" seconds Then the field "Guide criterion B criterion remark" matches value "Comment \"4\"" When I press "Save changes" And I am on the "Test assignment 1 name" "assign activity" page And I follow "View all submissions" # Checking that the user grade is correct. Then I should see "80" in the "Student 1" "table_row" And I log out # Viewing it as a student. And I am on the "Test assignment 1 name" "assign activity" page logged in as student1 And I should see "80" in the ".feedback" "css_element" And I should see "Marking guide test description" in the ".feedback" "css_element" And I should see "Very good" And I should see "Comment \"4\"" And I should see "Nice!" Scenario: I can use marking guides to grade and edit them later updating students grades with Javascript disabled grading/form/guide/README 0000604 00000000262 15062070556 0011101 0 ustar 00 Marking Guide grading form written by Dan Marsden <dan@danmarsden.com> based on Lightwork Rubric type 2 format and the spec available here: http://docs.moodle.org/dev/Lightwork grading/form/guide/edit.php 0000604 00000005107 15062070556 0011662 0 ustar 00 <?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/>. /** * Rubric editor page * * @package gradingform_guide * @copyright 2012 Dan Marsden <dan@danmarsden.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once(__DIR__.'/../../../../config.php'); require_once(__DIR__.'/lib.php'); require_once(__DIR__.'/edit_form.php'); require_once($CFG->dirroot.'/grade/grading/lib.php'); $areaid = required_param('areaid', PARAM_INT); $manager = get_grading_manager($areaid); list($context, $course, $cm) = get_context_info_array($manager->get_context()->id); require_login($course, true, $cm); require_capability('moodle/grade:managegradingforms', $context); $controller = $manager->get_controller('guide'); $PAGE->set_url(new moodle_url('/grade/grading/form/guide/edit.php', array('areaid' => $areaid))); $PAGE->set_title(get_string('definemarkingguide', 'gradingform_guide')); $PAGE->set_heading(get_string('definemarkingguide', 'gradingform_guide')); $mform = new gradingform_guide_editguide(null, array('areaid' => $areaid, 'context' => $context, 'allowdraft' => !$controller->has_active_instances()), 'post', '', array('class' => 'gradingform_guide_editform')); $data = $controller->get_definition_for_editing(true); $returnurl = optional_param('returnurl', $manager->get_management_url(), PARAM_LOCALURL); $data->returnurl = $returnurl; $mform->set_data($data); if ($mform->is_cancelled()) { redirect($returnurl); } else if ($mform->is_submitted() && $mform->is_validated() && !$mform->need_confirm_regrading($controller)) { // Everything ok, validated, re-grading confirmed if needed. Make changes to the rubric. $controller->update_definition($mform->get_data()); redirect($returnurl); } // Try to keep the session alive on this page as it may take some time // before significant interaction happens with the server. \core\session\manager::keepalive(); echo $OUTPUT->header(); $mform->display(); echo $OUTPUT->footer(); grading/form/guide/guideeditor.php 0000604 00000035135 15062070556 0013245 0 ustar 00 <?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/>. /** * This file contains the marking guide editor element * * @package gradingform_guide * @copyright 2012 Dan Marsden <dan@danmarsden.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); require_once("HTML/QuickForm/input.php"); /** * The editor for the marking guide advanced grading plugin. * * @package gradingform_guide * @copyright 2012 Dan Marsden <dan@danmarsden.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class moodlequickform_guideeditor extends HTML_QuickForm_input { /** @var string help message */ public $_helpbutton = ''; /** @var null|false|string stores the result of the last validation: null - undefined, false - no errors, * string - error(s) text */ protected $validationerrors = null; /** @var bool if element has already been validated **/ protected $wasvalidated = false; /** @var null|bool If non-submit (JS) button was pressed: null - unknown, true/false - button was/wasn't pressed */ protected $nonjsbuttonpressed = false; /** @var string|false Message to display in front of the editor (that there exist grades on this guide being edited) */ protected $regradeconfirmation = false; /** * Constructor * * @param string $elementname * @param string $elementlabel * @param array $attributes */ public function __construct($elementname=null, $elementlabel=null, $attributes=null) { parent::__construct($elementname, $elementlabel, $attributes); } /** * Old syntax of class constructor. Deprecated in PHP7. * * @deprecated since Moodle 3.1 */ public function moodlequickform_guideeditor($elementname=null, $elementlabel=null, $attributes=null) { debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER); self::__construct($elementname, $elementlabel, $attributes); } /** * get html for help button * * @return string html for help button */ public function getHelpButton() { return $this->_helpbutton; } /** * The renderer will take care itself about different display in normal and frozen states * * @return string */ public function getElementTemplateType() { return 'default'; } /** * Specifies that confirmation about re-grading needs to be added to this rubric editor. * $changelevel is saved in $this->regradeconfirmation and retrieved in toHtml() * * @see gradingform_rubric_controller::update_or_check_rubric() * @param int $changelevel */ public function add_regrade_confirmation($changelevel) { $this->regradeconfirmation = $changelevel; } /** * Returns html string to display this element * * @return string */ public function toHtml() { global $PAGE; $html = $this->_getTabs(); $renderer = $PAGE->get_renderer('gradingform_guide'); $data = $this->prepare_data(null, $this->wasvalidated); if (!$this->_flagFrozen) { $mode = gradingform_guide_controller::DISPLAY_EDIT_FULL; $module = array('name'=>'gradingform_guideeditor', 'fullpath'=>'/grade/grading/form/guide/js/guideeditor.js', 'requires' => array('base', 'dom', 'event', 'event-touch', 'escape'), 'strings' => array( array('confirmdeletecriterion', 'gradingform_guide'), array('clicktoedit', 'gradingform_guide'), array('clicktoeditname', 'gradingform_guide') )); $PAGE->requires->js_init_call('M.gradingform_guideeditor.init', array( array('name' => $this->getName(), 'criteriontemplate' => $renderer->criterion_template($mode, $data['options'], $this->getName()), 'commenttemplate' => $renderer->comment_template($mode, $this->getName()) )), true, $module); } else { // Guide is frozen, no javascript needed. if ($this->_persistantFreeze) { $mode = gradingform_guide_controller::DISPLAY_EDIT_FROZEN; } else { $mode = gradingform_guide_controller::DISPLAY_PREVIEW; } } if ($this->regradeconfirmation) { if (!isset($data['regrade'])) { $data['regrade'] = 1; } $html .= $renderer->display_regrade_confirmation($this->getName(), $this->regradeconfirmation, $data['regrade']); } if ($this->validationerrors) { $html .= html_writer::div($renderer->notification($this->validationerrors)); } $html .= $renderer->display_guide($data['criteria'], $data['comments'], $data['options'], $mode, $this->getName()); return $html; } /** * Prepares the data passed in $_POST: * - processes the pressed buttons 'addlevel', 'addcriterion', 'moveup', 'movedown', 'delete' (when JavaScript is disabled) * sets $this->nonjsbuttonpressed to true/false if such button was pressed * - if options not passed (i.e. we create a new guide) fills the options array with the default values * - if options are passed completes the options array with unchecked checkboxes * - if $withvalidation is set, adds 'error_xxx' attributes to elements that contain errors and creates an error string * and stores it in $this->validationerrors * * @param array $value * @param boolean $withvalidation whether to enable data validation * @return array */ protected function prepare_data($value = null, $withvalidation = false) { if (null === $value) { $value = $this->getValue(); } if ($this->nonjsbuttonpressed === null) { $this->nonjsbuttonpressed = false; } $errors = array(); $return = array('criteria' => array(), 'options' => gradingform_guide_controller::get_default_options(), 'comments' => array()); if (!isset($value['criteria'])) { $value['criteria'] = array(); $errors['err_nocriteria'] = 1; } // If options are present in $value, replace default values with submitted values. if (!empty($value['options'])) { foreach (array_keys($return['options']) as $option) { // Special treatment for checkboxes. if (!empty($value['options'][$option])) { $return['options'][$option] = $value['options'][$option]; } else { $return['options'][$option] = null; } } } if (is_array($value)) { // For other array keys of $value no special treatmeant neeeded, copy them to return value as is. foreach (array_keys($value) as $key) { if ($key != 'options' && $key != 'criteria' && $key != 'comments') { $return[$key] = $value[$key]; } } } // Iterate through criteria. $lastaction = null; $lastid = null; foreach ($value['criteria'] as $id => $criterion) { if ($id == 'addcriterion') { $id = $this->get_next_id(array_keys($value['criteria'])); $criterion = array('description' => ''); $this->nonjsbuttonpressed = true; } if ($withvalidation && !array_key_exists('delete', $criterion)) { if (!strlen(trim($criterion['shortname']))) { $errors['err_noshortname'] = 1; $criterion['error_description'] = true; } if (strlen(trim($criterion['shortname'])) > 255) { $errors['err_shortnametoolong'] = 1; $criterion['error_description'] = true; } if (!strlen(trim($criterion['maxscore']))) { $errors['err_nomaxscore'] = 1; $criterion['error_description'] = true; } else if (!is_numeric($criterion['maxscore'])) { $errors['err_maxscorenotnumeric'] = 1; $criterion['error_description'] = true; } else if ($criterion['maxscore'] < 0) { $errors['err_maxscoreisnegative'] = 1; $criterion['error_description'] = true; } } if (array_key_exists('moveup', $criterion) || $lastaction == 'movedown') { unset($criterion['moveup']); if ($lastid !== null) { $lastcriterion = $return['criteria'][$lastid]; unset($return['criteria'][$lastid]); $return['criteria'][$id] = $criterion; $return['criteria'][$lastid] = $lastcriterion; } else { $return['criteria'][$id] = $criterion; } $lastaction = null; $lastid = $id; $this->nonjsbuttonpressed = true; } else if (array_key_exists('delete', $criterion)) { $this->nonjsbuttonpressed = true; } else { if (array_key_exists('movedown', $criterion)) { unset($criterion['movedown']); $lastaction = 'movedown'; $this->nonjsbuttonpressed = true; } $return['criteria'][$id] = $criterion; $lastid = $id; } } // Add sort order field to criteria. $csortorder = 1; foreach (array_keys($return['criteria']) as $id) { $return['criteria'][$id]['sortorder'] = $csortorder++; } // Iterate through comments. $lastaction = null; $lastid = null; if (!empty($value['comments'])) { foreach ($value['comments'] as $id => $comment) { if ($id == 'addcomment') { $id = $this->get_next_id(array_keys($value['comments'])); $comment = array('description' => ''); $this->nonjsbuttonpressed = true; } if (array_key_exists('moveup', $comment) || $lastaction == 'movedown') { unset($comment['moveup']); if ($lastid !== null) { $lastcomment = $return['comments'][$lastid]; unset($return['comments'][$lastid]); $return['comments'][$id] = $comment; $return['comments'][$lastid] = $lastcomment; } else { $return['comments'][$id] = $comment; } $lastaction = null; $lastid = $id; $this->nonjsbuttonpressed = true; } else if (array_key_exists('delete', $comment)) { $this->nonjsbuttonpressed = true; } else { if (array_key_exists('movedown', $comment)) { unset($comment['movedown']); $lastaction = 'movedown'; $this->nonjsbuttonpressed = true; } $return['comments'][$id] = $comment; $lastid = $id; } } // Add sort order field to comments. $csortorder = 1; foreach (array_keys($return['comments']) as $id) { $return['comments'][$id]['sortorder'] = $csortorder++; } } // Create validation error string (if needed). if ($withvalidation) { if (count($errors)) { $rv = array(); foreach ($errors as $error => $v) { $rv[] = get_string($error, 'gradingform_guide'); } $this->validationerrors = join('<br/ >', $rv); } else { $this->validationerrors = false; } $this->wasvalidated = true; } return $return; } /** * Scans array $ids to find the biggest element ! NEWID*, increments it by 1 and returns * * @param array $ids * @return string */ protected function get_next_id($ids) { $maxid = 0; foreach ($ids as $id) { if (preg_match('/^NEWID(\d+)$/', $id, $matches) && ((int)$matches[1]) > $maxid) { $maxid = (int)$matches[1]; } } return 'NEWID'.($maxid+1); } /** * Checks if a submit button was pressed which is supposed to be processed on client side by JS * but user seem to have disabled JS in the browser. * (buttons 'add criteria', 'add level', 'move up', 'move down', 'add comment') * In this case the form containing this element is prevented from being submitted * * @param array $value * @return boolean true if non-submit button was pressed and not processed by JS */ public function non_js_button_pressed($value) { if ($this->nonjsbuttonpressed === null) { $this->prepare_data($value); } return $this->nonjsbuttonpressed; } /** * Validates that guide has at least one criterion, filled definitions and all criteria * have filled descriptions * * @param array $value * @return string|false error text or false if no errors found */ public function validate($value) { if (!$this->wasvalidated) { $this->prepare_data($value, true); } return $this->validationerrors; } /** * Prepares the data for saving * @see prepare_data() * * @param array $submitvalues * @param boolean $assoc * @return array */ public function exportValue(&$submitvalues, $assoc = false) { $value = $this->prepare_data($this->_findValue($submitvalues)); return $this->_prepareValue($value, $assoc); } } grading/form/guide/db/services.php 0000604 00000003163 15062070556 0013145 0 ustar 00 <?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/>. /** * External functions and service definitions for the Marking Guide advanced grading form. * * @package gradingform_guide * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die; $functions = [ 'gradingform_guide_grader_gradingpanel_fetch' => [ 'classname' => 'gradingform_guide\\grades\\grader\\gradingpanel\\external\\fetch', 'description' => 'Fetch the data required to display the grader grading panel, ' . 'creating the grade item if required', 'type' => 'write', 'ajax' => true, ], 'gradingform_guide_grader_gradingpanel_store' => [ 'classname' => 'gradingform_guide\\grades\\grader\\gradingpanel\\external\\store', 'description' => 'Store the grading data for a user from the grader grading panel.', 'type' => 'write', 'ajax' => true, ], ]; grading/form/guide/db/upgrade.php 0000604 00000003336 15062070556 0012753 0 ustar 00 <?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/>. /** * This file keeps track of upgrades to the marking guide grading method. * * @package gradingform_guide * @category upgrade * @copyright 2016 Jun Pataleta * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); /** * Marking guide grading method upgrade task. * * @param int $oldversion The version we are upgrading form. * @return bool Returns true on success. * @throws coding_exception * @throws downgrade_exception * @throws upgrade_exception */ function xmldb_gradingform_guide_upgrade($oldversion) { global $DB; // Automatically generated Moodle v3.9.0 release upgrade line. // Put any upgrade step following this. // Automatically generated Moodle v4.0.0 release upgrade line. // Put any upgrade step following this. // Automatically generated Moodle v4.1.0 release upgrade line. // Put any upgrade step following this. // Automatically generated Moodle v4.2.0 release upgrade line. // Put any upgrade step following this. return true; } grading/form/guide/db/install.xml 0000604 00000010077 15062070556 0013003 0 ustar 00 <?xml version="1.0" encoding="UTF-8" ?> <XMLDB PATH="grade/grading/form/guide/db" VERSION="20120404" COMMENT="XMLDB file for Moodle marking guide" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../../../lib/xmldb/xmldb.xsd" > <TABLES> <TABLE NAME="gradingform_guide_criteria" COMMENT="Stores the rows of the criteria grid."> <FIELDS> <FIELD NAME="id" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="true"/> <FIELD NAME="definitionid" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="false" COMMENT="The ID of the form definition this criterion is part of"/> <FIELD NAME="sortorder" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="false" COMMENT="Defines the order of the criterion in the guide"/> <FIELD NAME="shortname" TYPE="char" LENGTH="255" NOTNULL="true" SEQUENCE="false" COMMENT="shortname of this criterion"/> <FIELD NAME="description" TYPE="text" NOTNULL="false" SEQUENCE="false" COMMENT="The criterion description for students"/> <FIELD NAME="descriptionformat" TYPE="int" LENGTH="2" NOTNULL="false" SEQUENCE="false" COMMENT="The format of the description field"/> <FIELD NAME="descriptionmarkers" TYPE="text" NOTNULL="false" SEQUENCE="false" COMMENT="Description for Markers"/> <FIELD NAME="descriptionmarkersformat" TYPE="int" LENGTH="2" NOTNULL="false" SEQUENCE="false"/> <FIELD NAME="maxscore" TYPE="number" LENGTH="10" NOTNULL="true" SEQUENCE="false" DECIMALS="5" COMMENT="maximum grade that can be assigned using this criterion"/> </FIELDS> <KEYS> <KEY NAME="primary" TYPE="primary" FIELDS="id"/> <KEY NAME="fk_definitionid" TYPE="foreign" FIELDS="definitionid" REFTABLE="grading_definitions" REFFIELDS="id"/> </KEYS> </TABLE> <TABLE NAME="gradingform_guide_fillings" COMMENT="Stores the data of how the guide is filled by a particular rater"> <FIELDS> <FIELD NAME="id" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="true"/> <FIELD NAME="instanceid" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="false" COMMENT="The ID of the grading form instance"/> <FIELD NAME="criterionid" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="false" COMMENT="The ID of the criterion (row) in the guide"/> <FIELD NAME="remark" TYPE="text" NOTNULL="false" SEQUENCE="false" COMMENT="Side note feedback regarding this particular criterion"/> <FIELD NAME="remarkformat" TYPE="int" LENGTH="2" NOTNULL="false" SEQUENCE="false" COMMENT="The format of the remark field"/> <FIELD NAME="score" TYPE="number" LENGTH="10" NOTNULL="true" SEQUENCE="false" DECIMALS="5" COMMENT="The score assigned"/> </FIELDS> <KEYS> <KEY NAME="primary" TYPE="primary" FIELDS="id"/> <KEY NAME="fk_instanceid" TYPE="foreign" FIELDS="instanceid" REFTABLE="grading_instances" REFFIELDS="id"/> <KEY NAME="fk_criterionid" TYPE="foreign" FIELDS="criterionid" REFTABLE="gradingform_guide_criteria" REFFIELDS="id"/> <KEY NAME="uq_instance_criterion" TYPE="unique" FIELDS="instanceid, criterionid"/> </KEYS> </TABLE> <TABLE NAME="gradingform_guide_comments" COMMENT="frequently used comments used in marking guide"> <FIELDS> <FIELD NAME="id" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="true"/> <FIELD NAME="definitionid" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="false" COMMENT="The ID of the form definition this faq is part of"/> <FIELD NAME="sortorder" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="false" COMMENT="Defines the order of the comments"/> <FIELD NAME="description" TYPE="text" NOTNULL="false" SEQUENCE="false" COMMENT="The comment description"/> <FIELD NAME="descriptionformat" TYPE="int" LENGTH="2" NOTNULL="false" SEQUENCE="false" COMMENT="The format of the description field"/> </FIELDS> <KEYS> <KEY NAME="primary" TYPE="primary" FIELDS="id"/> <KEY NAME="fk_definitionid" TYPE="foreign" FIELDS="definitionid" REFTABLE="grading_definitions" REFFIELDS="id"/> </KEYS> </TABLE> </TABLES> </XMLDB> grading/form/guide/preview.php 0000604 00000003612 15062070556 0012415 0 ustar 00 <?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/>. /** * Preview marking guide page * * @package gradingform_guide * @copyright 2012 Dan Marsden <dan@danmarsden.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once(__DIR__.'/../../../../config.php'); require_once(__DIR__.'/lib.php'); require_once(__DIR__.'/edit_form.php'); require_once($CFG->dirroot.'/grade/grading/lib.php'); $areaid = required_param('areaid', PARAM_INT); $manager = get_grading_manager($areaid); list($context, $course, $cm) = get_context_info_array($manager->get_context()->id); require_login($course, true, $cm); $controller = $manager->get_controller('guide'); $options = $controller->get_options(); if (!$controller->is_form_defined() || empty($options['alwaysshowdefinition'])) { throw new moodle_exception('nopermissions', 'error', '', get_string('previewmarkingguide', 'gradingform_guide')); } $title = get_string('gradingof', 'gradingform_guide', $manager->get_area_title()); $PAGE->set_url(new moodle_url('/grade/grading/form/guide/preview.php', array('areaid' => $areaid))); $PAGE->set_title($title); $PAGE->set_heading($title); echo $OUTPUT->header(); echo $OUTPUT->heading($title); echo $controller->render_preview($PAGE); echo $OUTPUT->footer(); grading/form/guide/version.php 0000604 00000002100 15062070556 0012410 0 ustar 00 <?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/>. /** * Marking guide, advanced grade plugin * * @package gradingform_guide * @copyright 2012 Dan Marsden <dan@danmarsden.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); $plugin->component = 'gradingform_guide'; $plugin->version = 2023100900; $plugin->requires = 2023100400; $plugin->maturity = MATURITY_STABLE; grading/form/guide/renderer.php 0000604 00000122032 15062070556 0012540 0 ustar 00 <?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/>. /** * Contains the Guide grading form renderer in all of its glory * * @package gradingform_guide * @copyright 2012 Dan Marsden <dan@danmarsden.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); /** * Grading method plugin renderer * * @package gradingform_guide * @copyright 2012 Dan Marsden <dan@danmarsden.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class gradingform_guide_renderer extends plugin_renderer_base { /** * This function returns html code for displaying criterion. Depending on $mode it may be the * code to edit guide, to preview the guide, to evaluate somebody or to review the evaluation. * * This function may be called from display_guide() to display the whole guide, or it can be * called by itself to return a template used by JavaScript to add new empty criteria to the * guide being designed. * In this case it will use macros like {NAME}, {LEVELS}, {CRITERION-id}, etc. * * When overriding this function it is very important to remember that all elements of html * form (in edit or evaluate mode) must have the name $elementname. * * Also JavaScript relies on the class names of elements and when developer changes them * script might stop working. * * @param int $mode guide display mode, one of gradingform_guide_controller::DISPLAY_* {@link gradingform_guide_controller()} * @param array $options An array of options. * showmarkspercriterionstudents (bool) If true adds the current score to the display * @param string $elementname the name of the form element (in editor mode) or the prefix for div ids (in view mode) * @param array $criterion criterion data * @param array $value (only in view mode) teacher's feedback on this criterion * @param array $validationerrors An array containing validation errors to be shown * @param array $comments Array of frequently used comments. * @return string */ public function criterion_template($mode, $options, $elementname = '{NAME}', $criterion = null, $value = null, $validationerrors = null, $comments = null) { if ($criterion === null || !is_array($criterion) || !array_key_exists('id', $criterion)) { $criterion = array('id' => '{CRITERION-id}', 'description' => '{CRITERION-description}', 'sortorder' => '{CRITERION-sortorder}', 'class' => '{CRITERION-class}', 'descriptionmarkers' => '{CRITERION-descriptionmarkers}', 'shortname' => '{CRITERION-shortname}', 'maxscore' => '{CRITERION-maxscore}'); } else { foreach (array('sortorder', 'description', 'class', 'shortname', 'descriptionmarkers', 'maxscore') as $key) { // Set missing array elements to empty strings to avoid warnings. if (!array_key_exists($key, $criterion)) { $criterion[$key] = ''; } } } $criteriontemplate = html_writer::start_tag('tr', array('class' => 'criterion'. $criterion['class'], 'id' => '{NAME}-criteria-{CRITERION-id}')); $descriptionclass = 'description'; if ($mode == gradingform_guide_controller::DISPLAY_EDIT_FULL) { $criteriontemplate .= html_writer::start_tag('td', array('class' => 'controls')); foreach (array('moveup', 'delete', 'movedown') as $key) { $value = get_string('criterion'.$key, 'gradingform_guide'); $button = html_writer::empty_tag('input', array('type' => 'submit', 'name' => '{NAME}[criteria][{CRITERION-id}]['.$key.']', 'id' => '{NAME}-criteria-{CRITERION-id}-'.$key, 'value' => $value, 'title' => $value)); $criteriontemplate .= html_writer::tag('div', $button, array('class' => $key)); } $criteriontemplate .= html_writer::end_tag('td'); // Controls. $criteriontemplate .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => '{NAME}[criteria][{CRITERION-id}][sortorder]', 'value' => $criterion['sortorder'])); $shortnameinput = html_writer::empty_tag('input', array('type' => 'text', 'name' => '{NAME}[criteria][{CRITERION-id}][shortname]', 'id ' => '{NAME}-criteria-{CRITERION-id}-shortname', 'value' => $criterion['shortname'], 'aria-labelledby' => '{NAME}-criterion-name-label')); $shortname = html_writer::tag('div', $shortnameinput, array('class' => 'criterionname')); $descriptioninput = html_writer::tag('textarea', s($criterion['description']), array('name' => '{NAME}[criteria][{CRITERION-id}][description]', 'id' => '{NAME}[criteria][{CRITERION-id}][description]', 'cols' => '65', 'rows' => '5')); $description = html_writer::tag('div', $descriptioninput, array('class' => 'criteriondesc')); $descriptionmarkersinput = html_writer::tag('textarea', s($criterion['descriptionmarkers']), array('name' => '{NAME}[criteria][{CRITERION-id}][descriptionmarkers]', 'id' => '{NAME}[criteria][{CRITERION-id}][descriptionmarkers]', 'cols' => '65', 'rows' => '5')); $descriptionmarkers = html_writer::tag('div', $descriptionmarkersinput, array('class' => 'criteriondescmarkers')); $maxscore = html_writer::empty_tag('input', array('type'=> 'text', 'name' => '{NAME}[criteria][{CRITERION-id}][maxscore]', 'size' => '3', 'value' => $criterion['maxscore'], 'id' => '{NAME}[criteria][{CRITERION-id}][maxscore]')); $maxscore = html_writer::tag('div', $maxscore, array('class'=>'criterionmaxscore')); } else { if ($mode == gradingform_guide_controller::DISPLAY_EDIT_FROZEN) { $criteriontemplate .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => '{NAME}[criteria][{CRITERION-id}][sortorder]', 'value' => $criterion['sortorder'])); $criteriontemplate .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => '{NAME}[criteria][{CRITERION-id}][shortname]', 'value' => $criterion['shortname'])); $criteriontemplate .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => '{NAME}[criteria][{CRITERION-id}][description]', 'value' => $criterion['description'])); $criteriontemplate .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => '{NAME}[criteria][{CRITERION-id}][descriptionmarkers]', 'value' => $criterion['descriptionmarkers'])); $criteriontemplate .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => '{NAME}[criteria][{CRITERION-id}][maxscore]', 'value' => $criterion['maxscore'])); } else if ($mode == gradingform_guide_controller::DISPLAY_EVAL || $mode == gradingform_guide_controller::DISPLAY_VIEW) { $descriptionclass = 'descriptionreadonly'; } $shortnameparams = array( 'name' => '{NAME}[criteria][{CRITERION-id}][shortname]', 'id' => '{NAME}[criteria][{CRITERION-id}][shortname]', 'aria-describedby' => '{NAME}-criterion-name-label' ); $shortname = html_writer::div( format_text($criterion['shortname'], FORMAT_HTML), 'criterionshortname', $shortnameparams ); $descmarkerclass = ''; $descstudentclass = ''; if ($mode == gradingform_guide_controller::DISPLAY_EVAL) { if (!get_user_preferences('gradingform_guide-showmarkerdesc', true)) { $descmarkerclass = ' hide'; } if (!get_user_preferences('gradingform_guide-showstudentdesc', true)) { $descstudentclass = ' hide'; } } $description = html_writer::tag('div', format_text($criterion['description'], $criterion['descriptionformat']), array('class'=>'criteriondescription'.$descstudentclass, 'name' => '{NAME}[criteria][{CRITERION-id}][descriptionmarkers]')); $descriptionmarkers = html_writer::tag('div', format_text($criterion['descriptionmarkers'], $criterion['descriptionmarkersformat']), array('class'=>'criteriondescriptionmarkers'.$descmarkerclass, 'name' => '{NAME}[criteria][{CRITERION-id}][descriptionmarkers]')); $maxscore = html_writer::tag('div', s($criterion['maxscore']), array('class'=>'criteriondescriptionscore', 'name' => '{NAME}[criteria][{CRITERION-id}][maxscore]')); // Retain newlines as <br> tags when displaying the marking guide. $description = nl2br($description); $descriptionmarkers = nl2br($descriptionmarkers); } if (isset($criterion['error_description'])) { $descriptionclass .= ' error'; } $title = $shortname; if ($mode == gradingform_guide_controller::DISPLAY_EDIT_FULL || $mode == gradingform_guide_controller::DISPLAY_PREVIEW) { $title .= html_writer::tag('label', get_string('descriptionstudents', 'gradingform_guide'), array('for'=>'{NAME}[criteria][{CRITERION-id}][description]')); $title .= $description; $title .= html_writer::tag('label', get_string('descriptionmarkers', 'gradingform_guide'), array('for'=>'{NAME}[criteria][{CRITERION-id}][descriptionmarkers]')); $title .= $descriptionmarkers; $title .= html_writer::tag('label', get_string('maxscore', 'gradingform_guide'), array('for'=>'{NAME}[criteria][{CRITERION-id}][maxscore]')); $title .= $maxscore; } else if ($mode == gradingform_guide_controller::DISPLAY_PREVIEW_GRADED || $mode == gradingform_guide_controller::DISPLAY_VIEW) { $title .= $description; if (!empty($options['showmarkspercriterionstudents'])) { $title .= html_writer::label(get_string('maxscore', 'gradingform_guide'), null); $title .= $maxscore; } } else { $title .= $description . $descriptionmarkers; } // Title cell params. $titletdparams = array( 'class' => $descriptionclass, 'id' => '{NAME}-criteria-{CRITERION-id}-shortname-cell' ); if ($mode != gradingform_guide_controller::DISPLAY_EDIT_FULL && $mode != gradingform_guide_controller::DISPLAY_EDIT_FROZEN) { // Set description's cell as tab-focusable. $titletdparams['tabindex'] = '0'; } $criteriontemplate .= html_writer::tag('td', $title, $titletdparams); $currentremark = ''; $currentscore = ''; if (isset($value['remark'])) { $currentremark = $value['remark']; } if (isset($value['score'])) { $currentscore = $value['score']; } // Element ID of the remark text area. $remarkid = $elementname . '-criteria-' . $criterion['id'] . '-remark'; if ($mode == gradingform_guide_controller::DISPLAY_EVAL) { $scoreclass = ''; if (!empty($validationerrors[$criterion['id']]['score'])) { $scoreclass = 'error'; $currentscore = $validationerrors[$criterion['id']]['score']; // Show invalid score in form. } // Grading remark text area parameters. $remarkparams = array( 'name' => '{NAME}[criteria][{CRITERION-id}][remark]', 'id' => $remarkid, 'cols' => '65', 'rows' => '5', 'class' => 'markingguideremark form-control', 'aria-labelledby' => '{NAME}-remarklabel{CRITERION-id}' ); // Grading remark text area. $input = html_writer::tag('textarea', s($currentremark), $remarkparams); // Show the frequently-used comments chooser only if there are defined entries. $commentchooser = ''; if (!empty($comments)) { // Frequently used comments chooser. $chooserbuttonid = 'criteria-' . $criterion['id'] . '-commentchooser'; $commentchooserparams = array('id' => $chooserbuttonid, 'class' => 'commentchooser btn btn-secondary'); $commentchooser = html_writer::tag('button', get_string('insertcomment', 'gradingform_guide'), $commentchooserparams); // Option items for the frequently used comments chooser dialog. $commentoptions = array(); foreach ($comments as $id => $comment) { $commentoption = new stdClass(); $commentoption->id = $id; $commentoption->description = html_to_text(format_text($comment['description'], $comment['descriptionformat'])); $commentoptions[] = $commentoption; } // Include string for JS for the comment chooser title. $this->page->requires->string_for_js('insertcomment', 'gradingform_guide'); // Include comment_chooser module. $this->page->requires->js_call_amd('gradingform_guide/comment_chooser', 'initialise', array($criterion['id'], $chooserbuttonid, $remarkid, $commentoptions)); } // Hidden marking guide remark label. $remarklabelparams = array( 'class' => 'hidden', 'id' => '{NAME}-remarklabel{CRITERION-id}' ); $remarklabeltext = get_string('criterionremark', 'gradingform_guide', format_text($criterion['shortname'], FORMAT_HTML)); $remarklabel = html_writer::label($remarklabeltext, $remarkid, false, $remarklabelparams); $criteriontemplate .= html_writer::tag('td', $remarklabel . $input . $commentchooser, array('class' => 'remark')); // Score input and max score. $scoreinputparams = array( 'type' => 'text', 'name' => '{NAME}[criteria][{CRITERION-id}][score]', 'class' => $scoreclass . ' form-control', 'id' => '{NAME}-criteria-{CRITERION-id}-score', 'size' => '3', 'value' => $currentscore, 'aria-labelledby' => '{NAME}-score-label' ); $score = html_writer::empty_tag('input', $scoreinputparams); $score .= html_writer::div('/' . s($criterion['maxscore'])); $criteriontemplate .= html_writer::tag('td', $score, array('class' => 'score')); } else if ($mode == gradingform_guide_controller::DISPLAY_EVAL_FROZEN) { $criteriontemplate .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => '{NAME}[criteria][{CRITERION-id}][remark]', 'value' => $currentremark)); } else if ($mode == gradingform_guide_controller::DISPLAY_REVIEW || $mode == gradingform_guide_controller::DISPLAY_VIEW) { // Hidden marking guide remark description. $remarkdescparams = array( 'id' => '{NAME}-criteria-{CRITERION-id}-remark-desc' ); $remarkdesctext = get_string('criterionremark', 'gradingform_guide', $criterion['shortname']); $remarkdesc = html_writer::div($remarkdesctext, 'hidden', $remarkdescparams); // Remarks cell. $remarkdiv = html_writer::div(s($currentremark)); $remarkcellparams = array( 'class' => 'remark', 'tabindex' => '0', 'id' => '{NAME}-criteria-{CRITERION-id}-remark', 'aria-describedby' => '{NAME}-criteria-{CRITERION-id}-remark-desc' ); $criteriontemplate .= html_writer::tag('td', $remarkdesc . $remarkdiv, $remarkcellparams); // Score cell. if (!empty($options['showmarkspercriterionstudents'])) { $scorecellparams = array( 'class' => 'score', 'tabindex' => '0', 'id' => '{NAME}-criteria-{CRITERION-id}-score', 'aria-describedby' => '{NAME}-score-label' ); $scorediv = html_writer::div(s($currentscore) . ' / ' . s($criterion['maxscore'])); $criteriontemplate .= html_writer::tag('td', $scorediv, $scorecellparams); } } $criteriontemplate .= html_writer::end_tag('tr'); // Criterion. $criteriontemplate = str_replace('{NAME}', $elementname, $criteriontemplate); $criteriontemplate = str_replace('{CRITERION-id}', $criterion['id'], $criteriontemplate); return $criteriontemplate; } /** * This function returns html code for displaying criterion. Depending on $mode it may be the * code to edit guide, to preview the guide, to evaluate somebody or to review the evaluation. * * This function may be called from display_guide() to display the whole guide, or it can be * called by itself to return a template used by JavaScript to add new empty criteria to the * guide being designed. * In this case it will use macros like {NAME}, {LEVELS}, {CRITERION-id}, etc. * * When overriding this function it is very important to remember that all elements of html * form (in edit or evaluate mode) must have the name $elementname. * * Also JavaScript relies on the class names of elements and when developer changes them * script might stop working. * * @param int $mode guide display mode, one of gradingform_guide_controller::DISPLAY_* {@link gradingform_guide_controller} * @param string $elementname the name of the form element (in editor mode) or the prefix for div ids (in view mode) * @param array $comment * @return string */ public function comment_template($mode, $elementname = '{NAME}', $comment = null) { if ($comment === null || !is_array($comment) || !array_key_exists('id', $comment)) { $comment = array('id' => '{COMMENT-id}', 'description' => '{COMMENT-description}', 'sortorder' => '{COMMENT-sortorder}', 'class' => '{COMMENT-class}'); } else { foreach (array('sortorder', 'description', 'class') as $key) { // Set missing array elements to empty strings to avoid warnings. if (!array_key_exists($key, $comment)) { $criterion[$key] = ''; } } } $commenttemplate = html_writer::start_tag('tr', array('class' => 'criterion'. $comment['class'], 'id' => '{NAME}-comments-{COMMENT-id}')); if ($mode == gradingform_guide_controller::DISPLAY_EDIT_FULL) { $commenttemplate .= html_writer::start_tag('td', array('class' => 'controls')); foreach (array('moveup', 'delete', 'movedown') as $key) { $value = get_string('comments'.$key, 'gradingform_guide'); $button = html_writer::empty_tag('input', array('type' => 'submit', 'name' => '{NAME}[comments][{COMMENT-id}]['.$key.']', 'id' => '{NAME}-comments-{COMMENT-id}-'.$key, 'value' => $value, 'title' => $value)); $commenttemplate .= html_writer::tag('div', $button, array('class' => $key)); } $commenttemplate .= html_writer::end_tag('td'); // Controls. $commenttemplate .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => '{NAME}[comments][{COMMENT-id}][sortorder]', 'value' => $comment['sortorder'])); $description = html_writer::tag('textarea', s($comment['description']), array('name' => '{NAME}[comments][{COMMENT-id}][description]', 'id' => '{NAME}-comments-{COMMENT-id}-description', 'aria-labelledby' => '{NAME}-comment-label', 'cols' => '65', 'rows' => '5')); $description = html_writer::tag('div', $description, array('class'=>'criteriondesc')); } else { if ($mode == gradingform_guide_controller::DISPLAY_EDIT_FROZEN) { $commenttemplate .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => '{NAME}[comments][{COMMENT-id}][sortorder]', 'value' => $comment['sortorder'])); $commenttemplate .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => '{NAME}[comments][{COMMENT-id}][description]', 'value' => $comment['description'])); } if ($mode == gradingform_guide_controller::DISPLAY_EVAL) { $description = html_writer::tag('span', s($comment['description']), array('name' => '{NAME}[comments][{COMMENT-id}][description]', 'title' => get_string('clicktocopy', 'gradingform_guide'), 'id' => '{NAME}[comments][{COMMENT-id}]', 'class'=>'markingguidecomment')); } else { $description = format_text($comment['description'], $comment['descriptionformat']); } // Retain newlines as <br> tags when displaying 'frequently used comments'. $description = nl2br($description); } $descriptionclass = 'description'; if (isset($comment['error_description'])) { $descriptionclass .= ' error'; } $descriptioncellparams = array( 'class' => $descriptionclass, 'id' => '{NAME}-comments-{COMMENT-id}-description-cell' ); // Make description cell tab-focusable when in review mode. if ($mode != gradingform_guide_controller::DISPLAY_EDIT_FULL && $mode != gradingform_guide_controller::DISPLAY_EDIT_FROZEN) { $descriptioncellparams['tabindex'] = '0'; } $commenttemplate .= html_writer::tag('td', $description, $descriptioncellparams); $commenttemplate .= html_writer::end_tag('tr'); // Criterion. $commenttemplate = str_replace('{NAME}', $elementname, $commenttemplate); $commenttemplate = str_replace('{COMMENT-id}', $comment['id'], $commenttemplate); return $commenttemplate; } /** * This function returns html code for displaying guide template (content before and after * criteria list). Depending on $mode it may be the code to edit guide, to preview the guide, * to evaluate somebody or to review the evaluation. * * This function is called from display_guide() to display the whole guide. * * When overriding this function it is very important to remember that all elements of html * form (in edit or evaluate mode) must have the name $elementname. * * Also JavaScript relies on the class names of elements and when developer changes them * script might stop working. * * @param int $mode guide display mode, one of gradingform_guide_controller::DISPLAY_* {@link gradingform_guide_controller} * @param array $options An array of options provided to {@link gradingform_guide_renderer::guide_edit_options()} * @param string $elementname the name of the form element (in editor mode) or the prefix for div ids (in view mode) * @param string $criteriastr evaluated templates for this guide's criteria * @param string $commentstr * @return string */ protected function guide_template($mode, $options, $elementname, $criteriastr, $commentstr) { $classsuffix = ''; // CSS suffix for class of the main div. Depends on the mode. switch ($mode) { case gradingform_guide_controller::DISPLAY_EDIT_FULL: $classsuffix = ' editor editable'; break; case gradingform_guide_controller::DISPLAY_EDIT_FROZEN: $classsuffix = ' editor frozen'; break; case gradingform_guide_controller::DISPLAY_PREVIEW: case gradingform_guide_controller::DISPLAY_PREVIEW_GRADED: $classsuffix = ' editor preview'; break; case gradingform_guide_controller::DISPLAY_EVAL: $classsuffix = ' evaluate editable'; break; case gradingform_guide_controller::DISPLAY_EVAL_FROZEN: $classsuffix = ' evaluate frozen'; break; case gradingform_guide_controller::DISPLAY_REVIEW: $classsuffix = ' review'; break; case gradingform_guide_controller::DISPLAY_VIEW: $classsuffix = ' view'; break; } $guidetemplate = html_writer::start_tag('div', array('id' => 'guide-{NAME}', 'class' => 'clearfix gradingform_guide'.$classsuffix)); // Hidden guide label. $guidedescparams = array( 'id' => 'guide-{NAME}-desc', 'aria-hidden' => 'true' ); $guidetemplate .= html_writer::div(get_string('guide', 'gradingform_guide'), 'hidden', $guidedescparams); // Hidden criterion name label/description. $guidetemplate .= html_writer::div(get_string('criterionname', 'gradingform_guide'), 'hidden', array('id' => '{NAME}-criterion-name-label')); // Hidden score label/description. $guidetemplate .= html_writer::div(get_string('score', 'gradingform_guide'), 'hidden', array('id' => '{NAME}-score-label')); // Criteria table parameters. $criteriatableparams = array( 'class' => 'criteria', 'id' => '{NAME}-criteria', 'aria-describedby' => 'guide-{NAME}-desc'); $guidetemplate .= html_writer::tag('table', $criteriastr, $criteriatableparams); if ($mode == gradingform_guide_controller::DISPLAY_EDIT_FULL) { $value = get_string('addcriterion', 'gradingform_guide'); $input = html_writer::empty_tag('input', array('type' => 'submit', 'name' => '{NAME}[criteria][addcriterion]', 'id' => '{NAME}-criteria-addcriterion', 'value' => $value, 'title' => $value)); $guidetemplate .= html_writer::tag('div', $input, array('class' => 'addcriterion')); } if (!empty($commentstr)) { $guidetemplate .= html_writer::div(get_string('comments', 'gradingform_guide'), 'commentheader', array('id' => '{NAME}-comments-label')); $guidetemplate .= html_writer::div(get_string('comment', 'gradingform_guide'), 'hidden', array('id' => '{NAME}-comment-label', 'aria-hidden' => 'true')); $commentstableparams = array( 'class' => 'comments', 'id' => '{NAME}-comments', 'aria-describedby' => '{NAME}-comments-label'); $guidetemplate .= html_writer::tag('table', $commentstr, $commentstableparams); } if ($mode == gradingform_guide_controller::DISPLAY_EDIT_FULL) { $value = get_string('addcomment', 'gradingform_guide'); $input = html_writer::empty_tag('input', array('type' => 'submit', 'name' => '{NAME}[comments][addcomment]', 'id' => '{NAME}-comments-addcomment', 'value' => $value, 'title' => $value)); $guidetemplate .= html_writer::tag('div', $input, array('class' => 'addcomment')); } $guidetemplate .= $this->guide_edit_options($mode, $options); $guidetemplate .= html_writer::end_tag('div'); return str_replace('{NAME}', $elementname, $guidetemplate); } /** * Generates html template to view/edit the guide options. Expression {NAME} is used in * template for the form element name * * @param int $mode guide display mode, one of gradingform_guide_controller::DISPLAY_* {@link gradingform_guide_controller} * @param array $options * @return string */ protected function guide_edit_options($mode, $options) { if ($mode != gradingform_guide_controller::DISPLAY_EDIT_FULL && $mode != gradingform_guide_controller::DISPLAY_EDIT_FROZEN && $mode != gradingform_guide_controller::DISPLAY_PREVIEW) { // Options are displayed only for people who can manage. return; } $html = html_writer::start_tag('div', array('class' => 'options')); $html .= html_writer::tag('div', get_string('guideoptions', 'gradingform_guide'), array('class' => 'optionsheading')); $attrs = array('type' => 'hidden', 'name' => '{NAME}[options][optionsset]', 'value' => 1, 'class' => 'form-control'); $html .= html_writer::empty_tag('input', $attrs); foreach ($options as $option => $value) { $html .= html_writer::start_tag('div', array('class' => 'option '.$option)); $attrs = array('name' => '{NAME}[options]['.$option.']', 'id' => '{NAME}-options-'.$option); switch ($option) { case 'sortlevelsasc': // Display option as dropdown. $html .= html_writer::tag('span', get_string($option, 'gradingform_guide'), array('class' => 'label')); $value = (int)(!!$value); // Make sure $value is either 0 or 1. if ($mode == gradingform_guide_controller::DISPLAY_EDIT_FULL) { $selectoptions = array(0 => get_string($option.'0', 'gradingform_guide'), 1 => get_string($option.'1', 'gradingform_guide')); $valuestr = html_writer::select($selectoptions, $attrs['name'], $value, false, array('id' => $attrs['id'])); $html .= html_writer::tag('span', $valuestr, array('class' => 'value')); // TODO add here button 'Sort levels'. } else { $html .= html_writer::tag('span', get_string($option.$value, 'gradingform_guide'), array('class' => 'value')); if ($mode == gradingform_guide_controller::DISPLAY_EDIT_FROZEN) { $html .= html_writer::empty_tag('input', $attrs + array('type' => 'hidden', 'value' => $value)); } } break; default: if ($mode == gradingform_guide_controller::DISPLAY_EDIT_FROZEN && $value) { $html .= html_writer::empty_tag('input', $attrs + array('type' => 'hidden', 'value' => $value)); } // Display option as checkbox. $attrs['type'] = 'checkbox'; $attrs['value'] = 1; if ($value) { $attrs['checked'] = 'checked'; } if ($mode == gradingform_guide_controller::DISPLAY_EDIT_FROZEN || $mode == gradingform_guide_controller::DISPLAY_PREVIEW) { $attrs['disabled'] = 'disabled'; unset($attrs['name']); } $html .= html_writer::empty_tag('input', $attrs); $html .= html_writer::tag('label', get_string($option, 'gradingform_guide'), array('for' => $attrs['id'])); break; } $html .= html_writer::end_tag('div'); // Option. } $html .= html_writer::end_tag('div'); // Options. return $html; } /** * This function returns html code for displaying guide. Depending on $mode it may be the code * to edit guide, to preview the guide, to evaluate somebody or to review the evaluation. * * It is very unlikely that this function needs to be overriden by theme. It does not produce * any html code, it just prepares data about guide design and evaluation, adds the CSS * class to elements and calls the functions level_template, criterion_template and * guide_template * * @param array $criteria data about the guide design * @param array $comments * @param array $options * @param int $mode guide display mode, one of gradingform_guide_controller::DISPLAY_* {@link gradingform_guide_controller} * @param string $elementname the name of the form element (in editor mode) or the prefix for div ids (in view mode) * @param array $values evaluation result * @param array $validationerrors * @return string */ public function display_guide($criteria, $comments, $options, $mode, $elementname = null, $values = null, $validationerrors = null) { $criteriastr = ''; $cnt = 0; foreach ($criteria as $id => $criterion) { $criterion['class'] = $this->get_css_class_suffix($cnt++, count($criteria) -1); $criterion['id'] = $id; if (isset($values['criteria'][$id])) { $criterionvalue = $values['criteria'][$id]; } else { $criterionvalue = null; } $criteriastr .= $this->criterion_template($mode, $options, $elementname, $criterion, $criterionvalue, $validationerrors, $comments); } $cnt = 0; $commentstr = ''; // Check if comments should be displayed. if ($mode == gradingform_guide_controller::DISPLAY_EDIT_FULL || $mode == gradingform_guide_controller::DISPLAY_EDIT_FROZEN || $mode == gradingform_guide_controller::DISPLAY_PREVIEW || $mode == gradingform_guide_controller::DISPLAY_EVAL_FROZEN) { foreach ($comments as $id => $comment) { $comment['id'] = $id; $comment['class'] = $this->get_css_class_suffix($cnt++, count($comments) -1); $commentstr .= $this->comment_template($mode, $elementname, $comment); } } $output = $this->guide_template($mode, $options, $elementname, $criteriastr, $commentstr); if ($mode == gradingform_guide_controller::DISPLAY_EVAL) { $showdesc = get_user_preferences('gradingform_guide-showmarkerdesc', true); $showdescstud = get_user_preferences('gradingform_guide-showstudentdesc', true); $checked1 = array(); $checked2 = array(); $checked_s1 = array(); $checked_s2 = array(); $checked = array('checked' => 'checked'); if ($showdesc) { $checked1 = $checked; } else { $checked2 = $checked; } if ($showdescstud) { $checked_s1 = $checked; } else { $checked_s2 = $checked; } $radio1 = html_writer::tag('input', get_string('showmarkerdesc', 'gradingform_guide'), array('type' => 'radio', 'name' => 'showmarkerdesc', 'value' => "true")+$checked1); $radio1 = html_writer::tag('label', $radio1); $radio2 = html_writer::tag('input', get_string('hidemarkerdesc', 'gradingform_guide'), array('type' => 'radio', 'name' => 'showmarkerdesc', 'value' => "false")+$checked2); $radio2 = html_writer::tag('label', $radio2); $output .= html_writer::tag('div', $radio1 . $radio2, array('class' => 'showmarkerdesc')); $radio1 = html_writer::tag('input', get_string('showstudentdesc', 'gradingform_guide'), array('type' => 'radio', 'name' => 'showstudentdesc', 'value' => "true")+$checked_s1); $radio1 = html_writer::tag('label', $radio1); $radio2 = html_writer::tag('input', get_string('hidestudentdesc', 'gradingform_guide'), array('type' => 'radio', 'name' => 'showstudentdesc', 'value' => "false")+$checked_s2); $radio2 = html_writer::tag('label', $radio2); $output .= html_writer::tag('div', $radio1 . $radio2, array('class' => 'showstudentdesc')); } return $output; } /** * Help function to return CSS class names for element (first/last/even/odd) with leading space * * @param int $idx index of this element in the row/column * @param int $maxidx maximum index of the element in the row/column * @return string */ protected function get_css_class_suffix($idx, $maxidx) { $class = ''; if ($idx == 0) { $class .= ' first'; } if ($idx == $maxidx) { $class .= ' last'; } if ($idx % 2) { $class .= ' odd'; } else { $class .= ' even'; } return $class; } /** * Displays for the student the list of instances or default content if no instances found * * @param array $instances array of objects of type gradingform_guide_instance * @param string $defaultcontent default string that would be displayed without advanced grading * @param bool $cangrade whether current user has capability to grade in this context * @return string */ public function display_instances($instances, $defaultcontent, $cangrade) { $return = ''; if (count($instances)) { $return .= html_writer::start_tag('div', array('class' => 'advancedgrade')); $idx = 0; foreach ($instances as $instance) { $return .= $this->display_instance($instance, $idx++, $cangrade); } $return .= html_writer::end_tag('div'); } return $return. $defaultcontent; } /** * Displays one grading instance * * @param gradingform_guide_instance $instance * @param int $idx unique number of instance on page * @param bool $cangrade whether current user has capability to grade in this context */ public function display_instance(gradingform_guide_instance $instance, $idx, $cangrade) { $criteria = $instance->get_controller()->get_definition()->guide_criteria; $options = $instance->get_controller()->get_options(); $values = $instance->get_guide_filling(); if ($cangrade) { $mode = gradingform_guide_controller::DISPLAY_REVIEW; } else { $mode = gradingform_guide_controller::DISPLAY_VIEW; } $output = $this->box($instance->get_controller()->get_formatted_description(), 'gradingform_guide-description'). $this->display_guide($criteria, array(), $options, $mode, 'guide'.$idx, $values); return $output; } /** * Displays a confirmation message after a regrade has occured * * @param string $elementname * @param int $changelevel * @param int $value The regrade option that was used * @return string */ public function display_regrade_confirmation($elementname, $changelevel, $value) { $html = html_writer::start_tag('div', array('class' => 'gradingform_guide-regrade', 'role' => 'alert')); if ($changelevel<=2) { $html .= get_string('regrademessage1', 'gradingform_guide'); $selectoptions = array( 0 => get_string('regradeoption0', 'gradingform_guide'), 1 => get_string('regradeoption1', 'gradingform_guide') ); $html .= html_writer::select($selectoptions, $elementname.'[regrade]', $value, false); } else { $html .= get_string('regrademessage5', 'gradingform_guide'); $html .= html_writer::empty_tag('input', array('name' => $elementname.'[regrade]', 'value' => 1, 'type' => 'hidden')); } $html .= html_writer::end_tag('div'); return $html; } /** * Generates and returns HTML code to display information box about how guide score is converted to the grade * * @param array $scores * @return string */ public function display_guide_mapping_explained($scores) { $html = ''; if (!$scores) { return $html; } if (isset($scores['modulegrade']) && $scores['maxscore'] != $scores['modulegrade']) { $html .= $this->box(html_writer::tag('div', get_string('guidemappingexplained', 'gradingform_guide', (object)$scores)) , 'generalbox gradingform_guide-error'); } return $html; } } grading/form/guide/styles.scss 0000604 00000000122 15062070556 0012434 0 ustar 00 .gradingform_guide-fac { position: absolute; right: -5px; top: 5px; } grading/form/guide/pix/plus.png 0000604 00000000346 15062070556 0012515 0 ustar 00 �PNG IHDR Vu\� bKGD � � ����� �IDAT(���1 1DgB����h%��z��r���h)l#(�^��nl�J �l���|�9�����±�] �4� hl��/F�RZ������K� ��I ��'Z;0p ]�KZ;��6�4� �tb}!�ԑ�ڃ]��+�����W �b~� ,x,���� IEND�B`� grading/form/guide/pix/icon.svg 0000604 00000001006 15062070556 0012467 0 ustar 00 <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd" [ <!ENTITY ns_flows "http://ns.adobe.com/Flows/1.0/"> ]><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 16 16" preserveAspectRatio="xMinYMid meet" overflow="visible"><path d="M15 0H1C.5 0 0 .5 0 1v14c0 .5.5 1 1 1h14c.5 0 1-.5 1-1V1c0-.5-.5-1-1-1zM8 14H2v-2h6v2zm0-3H2V9h6v2zm0-3H2V6h6v2zm3 6H9v-2h2v2zm0-3H9V9h2v2zm0-3H9V6h2v2zm3 6h-2v-2h2v2zm0-3h-2V9h2v2zm0-3h-2V6h2v2z" fill="#888"/></svg> grading/form/guide/pix/info.svg 0000604 00000001107 15062070556 0012474 0 ustar 00 <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd" [ <!ENTITY ns_flows "http://ns.adobe.com/Flows/1.0/"> ]><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 16 16" preserveAspectRatio="xMinYMid meet" overflow="visible"><path d="M8 0C3.6 0 0 3.6 0 8s3.6 8 8 8 8-3.6 8-8-3.6-8-8-8zm0 14c-3.3 0-6-2.7-6-6s2.7-6 6-6 6 2.7 6 6-2.7 6-6 6zm1.2-2c0 .5-.5 1-1 1h-.4c-.5 0-1-.5-1-1V7.4c0-.5.5-1 1-1h.5c.5 0 1 .5 1 1V12zm0-7.8c0 .7-.6 1.2-1.2 1.2-.7 0-1.2-.6-1.2-1.2C6.8 3.5 7.3 3 8 3s1.2.5 1.2 1.2z" fill="#888"/></svg> grading/form/guide/pix/info.png 0000604 00000001136 15062070556 0012463 0 ustar 00 �PNG IHDR �a bKGD � � ����� IDAT8���=oA��ً}��"N��*X ! BQ|���P �٧i�m�ibR�b:� �I�.� E*:a�n(r],Y0��μ�;�3;5�2� �Ӊ�؋��y�a/�fuu5o���<�a��"Uݚ��|�8N ���B����� h�q<kYָeY�"rCU_��,A�}?w&`�p �\�V�K�e FQtE�A��k��3U�~�A��F�QN���S�V?� `�)� �Z�1� ����E��RU?%���� �9�u�����60�� � cv��RUn�����M�\�E^'ke � ���Z�� ���d x� I�L��b0�2s�X�i�� � �|�<Jl�R�� `/9<�_� v��q���<���W�E����D�0���c<�;T�- /"o3"�9��#U�ϐ� 9��y�7�}?A����q ��z�O �Bኪ�O2瀽R�t�q���0%"�"06��]*��t�d���v��PD*�:���^���5�� 2x���Y>� IEND�B`� grading/form/guide/pix/plus.svg 0000604 00000000737 15062070556 0012534 0 ustar 00 <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd" [ <!ENTITY ns_flows "http://ns.adobe.com/Flows/1.0/"> ]><svg xmlns="http://www.w3.org/2000/svg" width="12" height="12" viewBox="0 0 12 12" preserveAspectRatio="xMinYMid meet" overflow="visible"><path d="M11 4.5H7.5V1c0-.5-.5-1-1-1h-1c-.5 0-1 .5-1 1v3.5H1c-.5 0-1 .5-1 1v1c0 .5.5 1 1 1h3.5V11c0 .5.5 1 1 1h1c.5 0 1-.5 1-1V7.5H11c.6 0 1-.5 1-1v-1c0-.5-.4-1-1-1z" fill="#888"/></svg> grading/form/guide/pix/icon.png 0000604 00000000223 15062070556 0012454 0 ustar 00 �PNG IHDR �a bKGD � � ����� HIDAT8�� �0 /�,��T�h� ���R��$k�0y�� 0�� �Rkw_y�� �]��� /�@6��̉;�W=�K IEND�B`� grading/form/guide/templates/comment_chooser.mustache 0000604 00000003524 15062070556 0017142 0 ustar 00 {{! 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/>. }} {{! @template gradingform_guide/comment_chooser Moodle comment chooser template for marking guide. The purpose of this template is to render a list of frequently used comments that can be used by the comment chooser dialog. Classes required for JS: * none Data attributes required for JS: * none Context variables required for this template: * criterionId The criterion ID this chooser template is being generated for. * comments Array of id / description pairs. Example context (json): { "criterionId": "1", "comments": [ { "id": "1", "description": "Test comment description 1" }, { "id": "2", "description": "Test comment description 2" } ] } }} <div class="gradingform_guide_comment_chooser" id="comment_chooser"> <div class="list-group"> {{#comments}} <button class="list-group-item list-group-item-action" id="comment-option-{{criterionId}}-{{id}}" tabindex="0"> {{description}} </button> {{/comments}} </div> </div> grading/form/guide/templates/grades/grader/gradingpanel.mustache 0000604 00000017264 15062070556 0021130 0 ustar 00 {{! 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/>. }} {{! @template gradingform_guide/grades/grader/gradingpanel Classes required for JS: * none Data attributes required for JS: * none Context variables required for this template: * instanceid: Instance of the module this grading form belongs too * criterion: A gradeable item in the Marking Guide * name: Name of the gradeable item * id: ID of the gradeable item * description: Description shown to students for this gradeable item * descriptionmarkers: Description shown to teachers for this gradeable item * maxscore: Max allowable assinable points for this item * score: Current score assigned to the learner for this item * remark: Text input for the teacher to relay to the student * hascomments: Flag for frequently used comments * comments: Array of frequently used comments * description: Description of a frequently used comment Example context (json): { "instanceid": "42", "criterion": [ { "name": "Motivation", "id": 13, "description": "Show your motivation to rock climbing", "descriptionmarkers": "Does the student show interest in climbing?", "maxscore": 37, "score": 20, "remark": "That's great!", "hascomments": true, "comments": [ {"description": "Great work!"}, {"description": "You should really try it before jumping to conclusions"} ] } ] } }} <form id="gradingform_guide-{{uniqid}}"> <input type="hidden" name="instanceid" value="{{instanceid}}"> {{#criterion}} <div class="mb-3 criterion" data-gradingform-guide-role="criterion"> <div class="d-flex align-items-center"> <h5 class="description font-weight-bold mb-0">{{name}}</h5> <button class="btn btn-link px-1" aria-controls="gradingform_guide-{{uniqid}}-criteria-{{id}}-description" aria-expanded="false" data-target="#gradingform_guide-{{uniqid}}-criteria-{{id}}-description" data-toggle="collapse" type="button" > {{# pix }} info, gradingform_guide {{/ pix }} <span class="sr-only">{{#str}}informationforcriterion, gradingform_guide, {{name}}{{/str}}</span> </button> <button class="criterion-toggle btn btn-icon icon-no-margin text-reset p-0 font-weight-bold mb-0 ml-auto" type="button" data-toggle="collapse" data-target="#criteria-{{id}}" aria-expanded="true" aria-controls="criteria-{{id}}"> <span class="collapsed-icon"> {{#pix}} t/collapsed, core {{/pix}} <span class="sr-only">{{#str}} expandcriterion, core_grades {{/str}}</span> </span> <span class="expanded-icon"> {{#pix}} t/expanded, core {{/pix}} <span class="sr-only">{{#str}} collapsecriterion, core_grades {{/str}}</span> </span> </button> </div> <div class="collapse" id="gradingform_guide-{{uniqid}}-criteria-{{id}}-description"> <div class="border p-3 mb-3 bg-white rounded"> {{{description}}} {{#descriptionmarkers}} <hr> {{{descriptionmarkers}}} {{/descriptionmarkers}} </div> </div> <div class="collapse show" id="criteria-{{id}}"> <div class="form-group"> <label for="gradingform_guide-{{uniqid}}-criteria-{{id}}-score">{{#str}}outof, gradingform_guide, {{maxscore}}{{/str}}</label> <input class="form-control" type="number" name="advancedgrading[criteria][{{id}}][score]" value="{{score}}" id="gradingform_guide-{{uniqid}}-criteria-{{id}}-score" aria-describedby="gradingform_guide-{{uniqid}}-help-{{id}}-score" min="0" max="{{maxscore}}" aria-label="{{#str}}scoreforcriterion, gradingform_guide, {{name}}{{/str}}"> <span id="gradingform_guide-{{uniqid}}-help-{{id}}-score" aria-hidden="true" class="sr-only">{{! }}{{#str}}score_help, gradingform_guide, { "criterion": {{# quote }}{{ name }}{{/ quote }}, "maxscore": {{# quote }}{{ maxscore }}{{/ quote }} }{{/str}} </span> </div> <div class="form-group "> <label for="gradingform_guide-{{uniqid}}-criteria-{{id}}-remark">{{#str}}additionalcomments, gradingform_guide{{/str}}</label> <div class="input-group mb-3 form-inset form-inset-right"> <textarea class="form-control" type="text" name="advancedgrading[criteria][{{id}}][remark]" id="gradingform_guide-{{uniqid}}-criteria-{{id}}-remark" aria-describedby="gradingform_guide-{{uniqid}}-help-{{id}}-remark" aria-label="{{#str}}additionalcommentsforcriterion, gradingform_guide, {{name}}{{/str}}" data-gradingform-guide-role="remark" rows="2" data-max-rows="5" data-auto-rows >{{remark}}</textarea> {{#hascomments}} <button class="btn btn-icon form-inset-item icon-no-margin p-0 mt-1 mr-1 text-reset collapsed" aria-controls="gradingform_guide-{{uniqid}}-criteria-{{id}}-remark-frequent-comments" aria-expanded="false" data-toggle="collapse" data-target="#gradingform_guide-{{uniqid}}-criteria-{{id}}-remark-frequent-comments" type="button" > {{#pix}}plus, gradingform_guide{{/pix}} <span class="sr-only">{{#str}}commentpickerforcriterion, gradingform_guide, {{name}}{{/str}}</span> </button> {{/hascomments}} </div> {{#hascomments}} <div class="collapse" id="gradingform_guide-{{uniqid}}-criteria-{{id}}-remark-frequent-comments"> <div data-gradingform_guide-frequent-comments="gradingform_guide-{{uniqid}}-criteria-{{id}}-remark"> <h6>{{#str}}comments, gradingform_guide{{/str}}</h6> <div class="list-group"> {{#comments}} <button type="button" class="list-group-item list-group-item-action" data-gradingform_guide-role="frequent-comment">{{description}}</button> {{/comments}} </div> </div> </div> {{/hascomments}} <span id="gradingform_guide-{{uniqid}}-help-{{id}}-remark" aria-hidden="true" class="sr-only">{{#str}}remark_help, gradingform_guide{{/str}}</span> </div> </div> </div> {{/criterion}} </form> {{#js}} require(['gradingform_guide/grades/grader/gradingpanel/comments', 'core/auto_rows'], function(Comments, AutoRows) { Comments.init('gradingform_guide-{{uniqid}}'); AutoRows.init(document.getElementById('gradingform_guide-{{uniqid}}')); }); {{/js}} grading/form/guide/edit_form.php 0000604 00000021551 15062070556 0012706 0 ustar 00 <?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/>. /** * The form used at the guide editor page is defined here * * @package gradingform_guide * @copyright 2012 Dan Marsden <dan@danmarsden.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); require_once($CFG->dirroot.'/lib/formslib.php'); require_once(__DIR__.'/guideeditor.php'); MoodleQuickForm::registerElementType('guideeditor', $CFG->dirroot.'/grade/grading/form/guide/guideeditor.php', 'moodlequickform_guideeditor'); /** * Defines the guide edit form * * @package gradingform_guide * @copyright 2012 Dan Marsden <dan@danmarsden.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class gradingform_guide_editguide extends moodleform { /** * Form element definition */ public function definition() { $form = $this->_form; $form->addElement('hidden', 'areaid'); $form->setType('areaid', PARAM_INT); $form->addElement('hidden', 'returnurl'); $form->setType('returnurl', PARAM_LOCALURL); // Name. $form->addElement('text', 'name', get_string('name', 'gradingform_guide'), array('size' => 52, 'maxlength' => 255)); $form->addRule('name', get_string('required'), 'required', null, 'client'); $form->setType('name', PARAM_TEXT); $form->addRule('name', null, 'maxlength', 255, 'client'); // Description. $options = gradingform_guide_controller::description_form_field_options($this->_customdata['context']); $form->addElement('editor', 'description_editor', get_string('description'), null, $options); $form->setType('description_editor', PARAM_RAW); // Guide completion status. $choices = array(); $choices[gradingform_controller::DEFINITION_STATUS_DRAFT] = html_writer::tag('span', get_string('statusdraft', 'core_grading'), array('class' => 'status draft')); $choices[gradingform_controller::DEFINITION_STATUS_READY] = html_writer::tag('span', get_string('statusready', 'core_grading'), array('class' => 'status ready')); $form->addElement('select', 'status', get_string('guidestatus', 'gradingform_guide'), $choices)->freeze(); // Guide editor. $element = $form->addElement('guideeditor', 'guide', get_string('pluginname', 'gradingform_guide')); $form->setType('guide', PARAM_RAW); $buttonarray = array(); $buttonarray[] = &$form->createElement('submit', 'saveguide', get_string('saveguide', 'gradingform_guide')); if ($this->_customdata['allowdraft']) { $buttonarray[] = &$form->createElement('submit', 'saveguidedraft', get_string('saveguidedraft', 'gradingform_guide')); } $editbutton = &$form->createElement('submit', 'editguide', ' '); $editbutton->freeze(); $buttonarray[] = &$editbutton; $buttonarray[] = &$form->createElement('cancel'); $form->addGroup($buttonarray, 'buttonar', '', array(' '), false); $form->closeHeaderBefore('buttonar'); } /** * Setup the form depending on current values. This method is called after definition(), * data submission and set_data(). * All form setup that is dependent on form values should go in here. * * We remove the element status if there is no current status (i.e. guide is only being created) * so the users do not get confused */ public function definition_after_data() { $form = $this->_form; $el = $form->getElement('status'); if (!$el->getValue()) { $form->removeElement('status'); } else { $vals = array_values($el->getValue()); if ($vals[0] == gradingform_controller::DEFINITION_STATUS_READY) { $this->findbutton('saveguide')->setValue(get_string('save', 'gradingform_guide')); } } } /** * Form vlidation. * If there are errors return array of errors ("fieldname"=>"error message"), * otherwise true if ok. * * @param array $data array of ("fieldname"=>value) of submitted data * @param array $files array of uploaded files "element_name"=>tmp_file_path * @return array of "element_name"=>"error_description" if there are errors, * or an empty array if everything is OK (true allowed for backwards compatibility too). */ public function validation($data, $files) { $err = parent::validation($data, $files); $err = array(); $form = $this->_form; $guideel = $form->getElement('guide'); if ($guideel->non_js_button_pressed($data['guide'])) { // If JS is disabled and button such as 'Add criterion' is pressed - prevent from submit. $err['guidedummy'] = 1; } else if (isset($data['editguide'])) { // Continue editing. $err['guidedummy'] = 1; } else if ((isset($data['saveguide']) && $data['saveguide']) || (isset($data['saveguidedraft']) && $data['saveguidedraft'])) { // If user attempts to make guide active - it needs to be validated. if ($guideel->validate($data['guide']) !== false) { $err['guidedummy'] = 1; } } return $err; } /** * Return submitted data if properly submitted or returns NULL if validation fails or * if there is no submitted data. * * @return object submitted data; NULL if not valid or not submitted or cancelled */ public function get_data() { $data = parent::get_data(); if (!empty($data->saveguide)) { $data->status = gradingform_controller::DEFINITION_STATUS_READY; } else if (!empty($data->saveguidedraft)) { $data->status = gradingform_controller::DEFINITION_STATUS_DRAFT; } return $data; } /** * Check if there are changes in the guide and it is needed to ask user whether to * mark the current grades for re-grading. User may confirm re-grading and continue, * return to editing or cancel the changes * * @param gradingform_guide_controller $controller */ public function need_confirm_regrading($controller) { $data = $this->get_data(); if (isset($data->guide['regrade'])) { // We have already displayed the confirmation on the previous step. return false; } if (!isset($data->saveguide) || !$data->saveguide) { // We only need confirmation when button 'Save guide' is pressed. return false; } if (!$controller->has_active_instances()) { // Nothing to re-grade, confirmation not needed. return false; } $changelevel = $controller->update_or_check_guide($data); if ($changelevel == 0) { // No changes in the guide, no confirmation needed. return false; } // Freeze form elements and pass the values in hidden fields. // TODO description_editor does not freeze the normal way! $form = $this->_form; foreach (array('guide', 'name'/*, 'description_editor'*/) as $fieldname) { $el =& $form->getElement($fieldname); $el->freeze(); $el->setPersistantFreeze(true); if ($fieldname == 'guide') { $el->add_regrade_confirmation($changelevel); } } // Replace button text 'saveguide' and unfreeze 'Back to edit' button. $this->findbutton('saveguide')->setValue(get_string('continue')); $el =& $this->findbutton('editguide'); $el->setValue(get_string('backtoediting', 'gradingform_guide')); $el->unfreeze(); return true; } /** * Returns a form element (submit button) with the name $elementname * * @param string $elementname * @return HTML_QuickForm_element */ protected function &findbutton($elementname) { $form = $this->_form; $buttonar =& $form->getElement('buttonar'); $elements =& $buttonar->getElements(); foreach ($elements as $el) { if ($el->getName() == $elementname) { return $el; } } return null; } } grading/form/guide/backup/moodle2/restore_gradingform_guide_plugin.class.php 0000604 00000010432 15062070556 0023441 0 ustar 00 <?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/>. /** * Support for restore API * * @package gradingform_guide * @copyright 2012 Dan Marsden <dan@danmarsden.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); /** * Restores the marking guide specific data from grading.xml file * * @package gradingform_guide * @copyright 2012 Dan Marsden <dan@danmarsden.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class restore_gradingform_guide_plugin extends restore_gradingform_plugin { /** * Declares the marking guide XML paths attached to the form definition element * * @return array of {@link restore_path_element} */ protected function define_definition_plugin_structure() { $paths = array(); $paths[] = new restore_path_element('gradingform_guide_criterion', $this->get_pathfor('/guidecriteria/guidecriterion')); $paths[] = new restore_path_element('gradingform_guide_comment', $this->get_pathfor('/guidecomments/guidecomment')); // MDL-37714: Correctly locate frequent used comments in both the // current and incorrect old format. $paths[] = new restore_path_element('gradingform_guide_comment_legacy', $this->get_pathfor('/guidecriteria/guidecomments/guidecomment')); return $paths; } /** * Declares the marking guide XML paths attached to the form instance element * * @return array of {@link restore_path_element} */ protected function define_instance_plugin_structure() { $paths = array(); $paths[] = new restore_path_element('gradinform_guide_filling', $this->get_pathfor('/fillings/filling')); return $paths; } /** * Processes criterion element data * * Sets the mapping 'gradingform_guide_criterion' to be used later by * {@link self::process_gradinform_guide_filling()} * * @param array|stdClass $data */ public function process_gradingform_guide_criterion($data) { global $DB; $data = (object)$data; $oldid = $data->id; $data->definitionid = $this->get_new_parentid('grading_definition'); $newid = $DB->insert_record('gradingform_guide_criteria', $data); $this->set_mapping('gradingform_guide_criterion', $oldid, $newid); } /** * Processes comments element data * * @param array|stdClass $data The data to insert as a comment */ public function process_gradingform_guide_comment($data) { global $DB; $data = (object)$data; $data->definitionid = $this->get_new_parentid('grading_definition'); $DB->insert_record('gradingform_guide_comments', $data); } /** * Processes comments element data * * @param array|stdClass $data The data to insert as a comment */ public function process_gradingform_guide_comment_legacy($data) { global $DB; $data = (object)$data; $data->definitionid = $this->get_new_parentid('grading_definition'); $DB->insert_record('gradingform_guide_comments', $data); } /** * Processes filling element data * * @param array|stdClass $data The data to insert as a filling */ public function process_gradinform_guide_filling($data) { global $DB; $data = (object)$data; $data->instanceid = $this->get_new_parentid('grading_instance'); $data->criterionid = $this->get_mappingid('gradingform_guide_criterion', $data->criterionid); $DB->insert_record('gradingform_guide_fillings', $data); } } grading/form/guide/backup/moodle2/backup_gradingform_guide_plugin.class.php 0000604 00000010417 15062070556 0023226 0 ustar 00 <?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/>. /** * Support for backup API * * @package gradingform_guide * @copyright 2012 Dan Marsden <dan@danmarsden.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); /** * Defines marking guide backup structures * * @package gradingform_guide * @copyright 2012 Dan Marsden <dan@danmarsden.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class backup_gradingform_guide_plugin extends backup_gradingform_plugin { /** * Declares marking guide structures to append to the grading form definition * @return backup_plugin_element */ protected function define_definition_plugin_structure() { // Append data only if the grand-parent element has 'method' set to 'guide'. $plugin = $this->get_plugin_element(null, '../../method', 'guide'); // Create a visible container for our data. $pluginwrapper = new backup_nested_element($this->get_recommended_name()); // Connect our visible container to the parent. $plugin->add_child($pluginwrapper); // Define our elements. $criteria = new backup_nested_element('guidecriteria'); $criterion = new backup_nested_element('guidecriterion', array('id'), array( 'sortorder', 'shortname', 'description', 'descriptionformat', 'descriptionmarkers', 'descriptionmarkersformat', 'maxscore')); $comments = new backup_nested_element('guidecomments'); $comment = new backup_nested_element('guidecomment', array('id'), array( 'sortorder', 'description', 'descriptionformat')); // Build elements hierarchy. $pluginwrapper->add_child($criteria); $criteria->add_child($criterion); $pluginwrapper->add_child($comments); $comments->add_child($comment); // Set sources to populate the data. $criterion->set_source_table('gradingform_guide_criteria', array('definitionid' => backup::VAR_PARENTID)); $comment->set_source_table('gradingform_guide_comments', array('definitionid' => backup::VAR_PARENTID)); // No need to annotate ids or files yet (one day when criterion definition supports // embedded files, they must be annotated here). return $plugin; } /** * Declares marking guide structures to append to the grading form instances * @return backup_plugin_element */ protected function define_instance_plugin_structure() { // Append data only if the ancestor 'definition' element has 'method' set to 'guide'. $plugin = $this->get_plugin_element(null, '../../../../method', 'guide'); // Create a visible container for our data. $pluginwrapper = new backup_nested_element($this->get_recommended_name()); // Connect our visible container to the parent. $plugin->add_child($pluginwrapper); // Define our elements. $fillings = new backup_nested_element('fillings'); $filling = new backup_nested_element('filling', array('id'), array( 'criterionid', 'remark', 'remarkformat', 'score')); // Build elements hierarchy. $pluginwrapper->add_child($fillings); $fillings->add_child($filling); // Set sources to populate the data. $filling->set_source_table('gradingform_guide_fillings', array('instanceid' => backup::VAR_PARENTID)); // No need to annotate ids or files yet (one day when remark field supports // embedded fileds, they must be annotated here). return $plugin; } } grading/renderer.php 0000604 00000007347 15062070556 0010513 0 ustar 00 <?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/>. /** * Renderer for core_grading subsystem * * @package core_grading * @copyright 2011 David Mudrak <david@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); /** * Standard HTML output renderer for core_grading subsystem * * @package core_grading * @copyright 2011 David Mudrak <david@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * @category grading */ class core_grading_renderer extends plugin_renderer_base { /** * Renders the active method selector at the grading method management screen * * @param grading_manager $manager * @param moodle_url $targeturl * @return string */ public function management_method_selector(grading_manager $manager, moodle_url $targeturl) { $method = $manager->get_active_method(); $methods = $manager->get_available_methods(false); $methods['none'] = get_string('gradingmethodnone', 'core_grading'); $selector = new single_select(new moodle_url($targeturl, array('sesskey' => sesskey())), 'setmethod', $methods, empty($method) ? 'none' : $method, null, 'activemethodselector'); $selector->set_label(get_string('changeactivemethod', 'core_grading')); $selector->set_help_icon('gradingmethod', 'core_grading'); return $this->output->render($selector); } /** * Renders an action icon at the gradng method management screen * * @param moodle_url $url action URL * @param string $text action text * @param string $icon the name of the icon to use * @return string */ public function management_action_icon(moodle_url $url, $text, $icon) { $img = $this->output->pix_icon($icon, ''); $txt = html_writer::tag('div', $text, array('class' => 'action-text')); return html_writer::link($url, $img . $txt, array('class' => 'action btn btn-lg')); } /** * Renders a message for the user, typically as an action result * * @param string $message * @return string */ public function management_message($message) { $this->page->requires->strings_for_js(array('clicktoclose'), 'core_grading'); $this->page->requires->yui_module('moodle-core_grading-manage', 'M.core_grading.init_manage'); return $this->output->box(format_string($message) . ' - ' . html_writer::tag('span', ''), 'message', 'actionresultmessagebox'); } /** * Renders the template action icon * * @param moodle_url $url action URL * @param string $text action text * @param string $icon the name of the icon to use * @param string $class extra class of this action * @return string */ public function pick_action_icon(moodle_url $url, $text, $icon = '', $class = '') { $img = $this->output->pix_icon($icon, ''); $txt = html_writer::tag('div', $text, array('class' => 'action-text')); return html_writer::link($url, $img . $txt, array('class' => 'action '.$class)); } } grading/lib.php 0000604 00000056254 15062070556 0007454 0 ustar 00 <?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/>. /** * Advanced grading methods support * * @package core_grading * @copyright 2011 David Mudrak <david@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); use core_grades\component_gradeitems; /** * Factory method returning an instance of the grading manager * * There are basically ways how to use this factory method. If the area record * id is known to the caller, get the manager for that area by providing just * the id. If the area record id is not know, the context, component and area name * can be provided. Note that null values are allowed in the second case as the context, * component and the area name can be set explicitly later. * * @category grading * @example $manager = get_grading_manager($areaid); * @example $manager = get_grading_manager(context_system::instance()); * @example $manager = get_grading_manager($context, 'mod_assign', 'submission'); * @param stdClass|int|null $context_or_areaid if $areaid is passed, no other parameter is needed * @param string|null $component the frankenstyle name of the component * @param string|null $area the name of the gradable area * @return grading_manager */ function get_grading_manager($context_or_areaid = null, $component = null, $area = null) { global $DB; $manager = new grading_manager(); if (is_object($context_or_areaid)) { $context = $context_or_areaid; } else { $context = null; if (is_numeric($context_or_areaid)) { $manager->load($context_or_areaid); return $manager; } } if (!is_null($context)) { $manager->set_context($context); } if (!is_null($component)) { $manager->set_component($component); } if (!is_null($area)) { $manager->set_area($area); } return $manager; } /** * General class providing access to common grading features * * Grading manager provides access to the particular grading method controller * in that area. * * Fully initialized instance of the grading manager operates over a single * gradable area. It is possible to work with a partially initialized manager * that knows just context and component without known area, for example. * It is also possible to change context, component and area of an existing * manager. Such pattern is used when copying form definitions, for example. * * @package core_grading * @copyright 2011 David Mudrak <david@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * @category grading */ class grading_manager { /** @var stdClass the context */ protected $context; /** @var string the frankenstyle name of the component */ protected $component; /** @var string the name of the gradable area */ protected $area; /** @var stdClass|false|null the raw record from {grading_areas}, false if does not exist, null if invalidated cache */ private $areacache = null; /** * Returns grading manager context * * @return stdClass grading manager context */ public function get_context() { return $this->context; } /** * Sets the context the manager operates on * * @param stdClass $context */ public function set_context(stdClass $context) { $this->areacache = null; $this->context = $context; } /** * Returns grading manager component * * @return string grading manager component */ public function get_component() { return $this->component; } /** * Sets the component the manager operates on * * @param string $component the frankenstyle name of the component */ public function set_component($component) { $this->areacache = null; list($type, $name) = core_component::normalize_component($component); $this->component = $type.'_'.$name; } /** * Returns grading manager area name * * @return string grading manager area name */ public function get_area() { return $this->area; } /** * Sets the area the manager operates on * * @param string $area the name of the gradable area */ public function set_area($area) { $this->areacache = null; $this->area = $area; } /** * Returns a text describing the context and the component * * At the moment this works for gradable areas in course modules. In the future, this * method should be improved so it works for other contexts (blocks, gradebook items etc) * or subplugins. * * @return string */ public function get_component_title() { $this->ensure_isset(array('context', 'component')); if ($this->get_context()->contextlevel == CONTEXT_SYSTEM) { if ($this->get_component() == 'core_grading') { $title = ''; // we are in the bank UI } else { throw new coding_exception('Unsupported component at the system context'); } } else if ($this->get_context()->contextlevel >= CONTEXT_COURSE) { list($context, $course, $cm) = get_context_info_array($this->get_context()->id); if ($cm && strval($cm->name) !== '') { $title = format_string($cm->name, true, array('context' => $context)); } else { debugging('Gradable areas are currently supported at the course module level only', DEBUG_DEVELOPER); $title = $this->get_component(); } } else { throw new coding_exception('Unsupported gradable area context level'); } return $title; } /** * Returns the localized title of the currently set area * * @return string */ public function get_area_title() { if ($this->get_context()->contextlevel == CONTEXT_SYSTEM) { return ''; } else if ($this->get_context()->contextlevel >= CONTEXT_COURSE) { $this->ensure_isset(array('context', 'component', 'area')); $areas = $this->get_available_areas(); if (array_key_exists($this->get_area(), $areas)) { return $areas[$this->get_area()]; } else { debugging('Unknown area!'); return '???'; } } else { throw new coding_exception('Unsupported context level'); } } /** * Loads the gradable area info from the database * * @param int $areaid */ public function load($areaid) { global $DB; $this->areacache = $DB->get_record('grading_areas', array('id' => $areaid), '*', MUST_EXIST); $this->context = context::instance_by_id($this->areacache->contextid, MUST_EXIST); $this->component = $this->areacache->component; $this->area = $this->areacache->areaname; } /** * Returns the list of installed grading plugins together, optionally extended * with a simple direct grading. * * @param bool $includenone should the 'Simple direct grading' be included * @return array of the (string)name => (string)localized title of the method */ public static function available_methods($includenone = true) { if ($includenone) { $list = array('' => get_string('gradingmethodnone', 'core_grading')); } else { $list = array(); } foreach (core_component::get_plugin_list('gradingform') as $name => $location) { $list[$name] = get_string('pluginname', 'gradingform_'.$name); } return $list; } /** * Returns the list of available grading methods in the given context * * Currently this is just a static list obtained from {@link self::available_methods()}. * In the future, the list of available methods may be controlled per-context. * * Requires the context property to be set in advance. * * @param bool $includenone should the 'Simple direct grading' be included * @return array of the (string)name => (string)localized title of the method */ public function get_available_methods($includenone = true) { $this->ensure_isset(array('context')); return self::available_methods($includenone); } /** * Returns the list of gradable areas provided by the given component * * This performs a callback to the library of the relevant plugin to obtain * the list of supported areas. * * @param string $component normalized component name * @return array of (string)areacode => (string)localized title of the area */ public static function available_areas($component) { global $CFG; if (component_gradeitems::defines_advancedgrading_itemnames_for_component($component)) { $result = []; foreach (component_gradeitems::get_advancedgrading_itemnames_for_component($component) as $itemnumber => $itemname) { $result[$itemname] = get_string("gradeitem:{$itemname}", $component); } return $result; } list($plugintype, $pluginname) = core_component::normalize_component($component); if ($component === 'core_grading') { return array(); } else if ($plugintype === 'mod') { $callbackfunction = "grading_areas_list"; if (component_callback_exists($component, $callbackfunction)) { debugging( "Components supporting advanced grading should be updated to implement the component_gradeitems class", DEBUG_DEVELOPER ); return component_callback($component, $callbackfunction, [], []); } } else { throw new coding_exception('Unsupported area location'); } } /** * Returns the list of gradable areas in the given context and component * * This performs a callback to the library of the relevant plugin to obtain * the list of supported areas. * @return array of (string)areacode => (string)localized title of the area */ public function get_available_areas() { global $CFG; $this->ensure_isset(array('context', 'component')); if ($this->get_context()->contextlevel == CONTEXT_SYSTEM) { if ($this->get_component() !== 'core_grading') { throw new coding_exception('Unsupported component at the system context'); } else { return array(); } } else if ($this->get_context()->contextlevel == CONTEXT_MODULE) { $modulecontext = $this->get_context(); $coursecontext = $modulecontext->get_course_context(); $cm = get_fast_modinfo($coursecontext->instanceid)->get_cm($modulecontext->instanceid); return self::available_areas("mod_{$cm->modname}"); } else { throw new coding_exception('Unsupported gradable area context level'); } } /** * Returns the currently active grading method in the gradable area * * @return string|null the name of the grading plugin of null if it has not been set */ public function get_active_method() { global $DB; $this->ensure_isset(array('context', 'component', 'area')); // get the current grading area record if it exists if (is_null($this->areacache)) { $this->areacache = $DB->get_record('grading_areas', array( 'contextid' => $this->context->id, 'component' => $this->component, 'areaname' => $this->area), '*', IGNORE_MISSING); } if ($this->areacache === false) { // no area record yet return null; } return $this->areacache->activemethod; } /** * Sets the currently active grading method in the gradable area * * @param string $method the method name, eg 'rubric' (must be available) * @return bool true if the method changed or was just set, false otherwise */ public function set_active_method($method) { global $DB; $this->ensure_isset(array('context', 'component', 'area')); // make sure the passed method is empty or a valid plugin name if (empty($method)) { $method = null; } else { if ('gradingform_'.$method !== clean_param('gradingform_'.$method, PARAM_COMPONENT)) { throw new moodle_exception('invalid_method_name', 'core_grading'); } $available = $this->get_available_methods(false); if (!array_key_exists($method, $available)) { throw new moodle_exception('invalid_method_name', 'core_grading'); } } // get the current grading area record if it exists if (is_null($this->areacache)) { $this->areacache = $DB->get_record('grading_areas', array( 'contextid' => $this->context->id, 'component' => $this->component, 'areaname' => $this->area), '*', IGNORE_MISSING); } $methodchanged = false; if ($this->areacache === false) { // no area record yet, create one with the active method set $area = array( 'contextid' => $this->context->id, 'component' => $this->component, 'areaname' => $this->area, 'activemethod' => $method); $DB->insert_record('grading_areas', $area); $methodchanged = true; } else { // update the existing record if needed if ($this->areacache->activemethod !== $method) { $DB->set_field('grading_areas', 'activemethod', $method, array('id' => $this->areacache->id)); $methodchanged = true; } } $this->areacache = null; return $methodchanged; } /** * Extends the settings navigation with the grading settings * * This function is called when the context for the page is an activity module with the * FEATURE_ADVANCED_GRADING and the user has the permission moodle/grade:managegradingforms. * * @param settings_navigation $settingsnav {@link settings_navigation} * @param navigation_node $modulenode {@link navigation_node} */ public function extend_settings_navigation(settings_navigation $settingsnav, navigation_node $modulenode=null) { $this->ensure_isset(array('context', 'component')); $areas = $this->get_available_areas(); if (empty($areas)) { // no money, no funny return; } else { // make just a single node for the management screen $areatitle = reset($areas); $areaname = key($areas); $this->set_area($areaname); $managementnode = $modulenode->add(get_string('gradingmanagement', 'core_grading'), $this->get_management_url(), settings_navigation::TYPE_CUSTOM, null, 'advgrading'); } } /** * Extends the module navigation with the advanced grading information * * This function is called when the context for the page is an activity module with the * FEATURE_ADVANCED_GRADING. * * @param global_navigation $navigation * @param navigation_node $modulenode */ public function extend_navigation(global_navigation $navigation, navigation_node $modulenode=null) { $this->ensure_isset(array('context', 'component')); $areas = $this->get_available_areas(); foreach ($areas as $areaname => $areatitle) { $this->set_area($areaname); if ($controller = $this->get_active_controller()) { $controller->extend_navigation($navigation, $modulenode); } } } /** * Returns the given method's controller in the gradable area * * @param string $method the method name, eg 'rubric' (must be available) * @return gradingform_controller */ public function get_controller($method) { global $CFG, $DB; $this->ensure_isset(array('context', 'component', 'area')); // make sure the passed method is a valid plugin name if ('gradingform_'.$method !== clean_param('gradingform_'.$method, PARAM_COMPONENT)) { throw new moodle_exception('invalid_method_name', 'core_grading'); } $available = $this->get_available_methods(false); if (!array_key_exists($method, $available)) { throw new moodle_exception('invalid_method_name', 'core_grading'); } // get the current grading area record if it exists if (is_null($this->areacache)) { $this->areacache = $DB->get_record('grading_areas', array( 'contextid' => $this->context->id, 'component' => $this->component, 'areaname' => $this->area), '*', IGNORE_MISSING); } if ($this->areacache === false) { // no area record yet, create one $area = array( 'contextid' => $this->context->id, 'component' => $this->component, 'areaname' => $this->area); $areaid = $DB->insert_record('grading_areas', $area); // reload the cache $this->areacache = $DB->get_record('grading_areas', array('id' => $areaid), '*', MUST_EXIST); } require_once($CFG->dirroot.'/grade/grading/form/'.$method.'/lib.php'); $classname = 'gradingform_'.$method.'_controller'; return new $classname($this->context, $this->component, $this->area, $this->areacache->id); } /** * Returns the controller for the active method if it is available * * @return null|gradingform_controller */ public function get_active_controller() { if ($gradingmethod = $this->get_active_method()) { $controller = $this->get_controller($gradingmethod); if ($controller->is_form_available()) { return $controller; } } return null; } /** * Returns the URL of the grading area management page * * @param moodle_url $returnurl optional URL of the page where the user should be sent back to * @return moodle_url */ public function get_management_url(moodle_url $returnurl = null) { $this->ensure_isset(array('context', 'component')); if ($this->areacache) { $params = array('areaid' => $this->areacache->id); } else { $params = array('contextid' => $this->context->id, 'component' => $this->component); if ($this->area) { $params['area'] = $this->area; } } if (!is_null($returnurl)) { $params['returnurl'] = $returnurl->out(false); } return new moodle_url('/grade/grading/manage.php', $params); } /** * Creates a new shared area to hold a grading form template * * Shared area are implemented as virtual gradable areas at the system level context * with the component set to core_grading and unique random area name. * * @param string $method the name of the plugin we create the area for * @return int the new area id */ public function create_shared_area($method) { global $DB; // generate some unique random name for the new area $name = $method . '_' . sha1(rand().uniqid($method, true)); // create new area record $area = array( 'contextid' => context_system::instance()->id, 'component' => 'core_grading', 'areaname' => $name, 'activemethod' => $method); return $DB->insert_record('grading_areas', $area); } /** * Removes all data associated with the given context * * This is called by {@link context::delete_content()} * * @param int $contextid context id */ public static function delete_all_for_context($contextid) { global $DB; $areaids = $DB->get_fieldset_select('grading_areas', 'id', 'contextid = ?', array($contextid)); $methods = array_keys(self::available_methods(false)); foreach($areaids as $areaid) { $manager = get_grading_manager($areaid); foreach ($methods as $method) { $controller = $manager->get_controller($method); $controller->delete_definition(); } } $DB->delete_records_list('grading_areas', 'id', $areaids); } /** * Helper method to tokenize the given string * * Splits the given string into smaller strings. This is a helper method for * full text searching in grading forms. If the given string is surrounded with * double quotes, the resulting array consists of a single item containing the * quoted content. * * Otherwise, string like 'grammar, english language' would be tokenized into * the three tokens 'grammar', 'english', 'language'. * * One-letter tokens like are dropped in non-phrase mode. Repeated tokens are * returned just once. * * @param string $needle * @return array */ public static function tokenize($needle) { // check if we are searching for the exact phrase if (preg_match('/^[\s]*"[\s]*(.*?)[\s]*"[\s]*$/', $needle, $matches)) { $token = $matches[1]; if ($token === '') { return array(); } else { return array($token); } } // split the needle into smaller parts separated by non-word characters $tokens = preg_split("/\W/u", $needle); // keep just non-empty parts $tokens = array_filter($tokens); // distinct $tokens = array_unique($tokens); // drop one-letter tokens foreach ($tokens as $ix => $token) { if (strlen($token) == 1) { unset($tokens[$ix]); } } return array_values($tokens); } // ////////////////////////////////////////////////////////////////////////// /** * Make sure that the given properties were set to some not-null value * * @param array $properties the list of properties * @throws coding_exception */ private function ensure_isset(array $properties) { foreach ($properties as $property) { if (!isset($this->$property)) { throw new coding_exception('The property "'.$property.'" is not set.'); } } } } grading/classes/privacy/provider.php 0000604 00000040004 15062070556 0013634 0 ustar 00 <?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/>. /** * Privacy class for requesting user data. * * @package core_grading * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace core_grading\privacy; defined('MOODLE_INTERNAL') || die(); use \core_privacy\local\metadata\collection; use \core_privacy\local\request\approved_contextlist; use \core_privacy\local\request\contextlist; use \core_privacy\local\request\transform; use \core_privacy\local\request\writer; use \core_privacy\manager; /** * Privacy class for requesting user data. * * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class provider implements \core_privacy\local\metadata\provider, \core_privacy\local\request\plugin\provider, \core_privacy\local\request\core_userlist_provider, \core_privacy\local\request\subsystem\provider { /** * Returns meta data about this system. * * @param collection $collection The initialised collection to add items to. * @return collection A listing of user data stored through this system. */ public static function get_metadata(collection $collection) : collection { $collection->add_database_table('grading_definitions', [ 'method' => 'privacy:metadata:grading_definitions:method', 'areaid' => 'privacy:metadata:grading_definitions:areaid', 'name' => 'privacy:metadata:grading_definitions:name', 'description' => 'privacy:metadata:grading_definitions:description', 'status' => 'privacy:metadata:grading_definitions:status', 'copiedfromid' => 'privacy:metadata:grading_definitions:copiedfromid', 'timecopied' => 'privacy:metadata:grading_definitions:timecopied', 'timecreated' => 'privacy:metadata:grading_definitions:timecreated', 'usercreated' => 'privacy:metadata:grading_definitions:usercreated', 'timemodified' => 'privacy:metadata:grading_definitions:timemodified', 'usermodified' => 'privacy:metadata:grading_definitions:usermodified', 'options' => 'privacy:metadata:grading_definitions:options', ], 'privacy:metadata:grading_definitions'); $collection->add_database_table('grading_instances', [ 'raterid' => 'privacy:metadata:grading_instances:raterid', 'rawgrade' => 'privacy:metadata:grading_instances:rawgrade', 'status' => 'privacy:metadata:grading_instances:status', 'feedback' => 'privacy:metadata:grading_instances:feedback', 'feedbackformat' => 'privacy:metadata:grading_instances:feedbackformat', 'timemodified' => 'privacy:metadata:grading_instances:timemodified', ], 'privacy:metadata:grading_instances'); // Link to subplugin. $collection->add_plugintype_link('gradingform', [], 'privacy:metadata:gradingformpluginsummary'); return $collection; } /** * Get the list of contexts that contain user information for the specified user. * * @param int $userid The user to search. * @return contextlist $contextlist The contextlist containing the list of contexts used in this plugin. */ public static function get_contexts_for_userid(int $userid) : contextlist { $contextlist = new contextlist(); $sql = "SELECT c.id FROM {context} c JOIN {grading_areas} a ON a.contextid = c.id JOIN {grading_definitions} d ON d.areaid = a.id LEFT JOIN {grading_instances} i ON i.definitionid = d.id AND i.raterid = :raterid WHERE c.contextlevel = :contextlevel AND (d.usercreated = :usercreated OR d.usermodified = :usermodified OR i.id IS NOT NULL)"; $params = [ 'usercreated' => $userid, 'usermodified' => $userid, 'raterid' => $userid, 'contextlevel' => CONTEXT_MODULE ]; $contextlist->add_from_sql($sql, $params); return $contextlist; } /** * Get the list of users who have data within a context. * * @param userlist $userlist The userlist containing the list of users who have data in this context/plugin combination. */ public static function get_users_in_context(\core_privacy\local\request\userlist $userlist) { $context = $userlist->get_context(); if ($context->contextlevel != CONTEXT_MODULE) { return; } $params = ['contextid' => $context->id]; $sql = "SELECT d.usercreated, d.usermodified FROM {grading_definitions} d JOIN {grading_areas} a ON a.id = d.areaid WHERE a.contextid = :contextid"; $userlist->add_from_sql('usercreated', $sql, $params); $userlist->add_from_sql('usermodified', $sql, $params); $sql = "SELECT i.raterid FROM {grading_definitions} d JOIN {grading_areas} a ON a.id = d.areaid JOIN {grading_instances} i ON i.definitionid = d.id WHERE a.contextid = :contextid"; $userlist->add_from_sql('raterid', $sql, $params); } /** * Export all user data for the specified user, in the specified contexts. * * @param approved_contextlist $contextlist The approved contexts to export information for. */ public static function export_user_data(approved_contextlist $contextlist) { // Remove contexts different from MODULE. $contexts = array_reduce($contextlist->get_contexts(), function($carry, $context) { if ($context->contextlevel == CONTEXT_MODULE) { $carry[] = $context; } return $carry; }, []); if (empty($contexts)) { return; } $userid = $contextlist->get_user()->id; $subcontext = [get_string('gradingmethod', 'grading')]; foreach ($contexts as $context) { // Export grading definitions created or modified on this context. self::export_definitions($context, $subcontext, $userid); } } /** * Export all user data related to a context and itemid. * * @param \context $context Context to export on. * @param int $itemid Item ID to export on. * @param array $subcontext Directory location to export to. */ public static function export_item_data(\context $context, int $itemid, array $subcontext) { global $DB; $sql = "SELECT gi.id AS instanceid, gd.id AS definitionid, gd.method FROM {grading_areas} ga JOIN {grading_definitions} gd ON gd.areaid = ga.id JOIN {grading_instances} gi ON gi.definitionid = gd.id AND gi.itemid = :itemid WHERE ga.contextid = :contextid"; $params = [ 'itemid' => $itemid, 'contextid' => $context->id, ]; $records = $DB->get_recordset_sql($sql, $params); foreach ($records as $record) { $instancedata = manager::component_class_callback( "gradingform_{$record->method}", gradingform_provider_v2::class, 'export_gradingform_instance_data', [$context, $record->instanceid, $subcontext] ); } $records->close(); } /** * Deletes all user data related to a context and possibly an itemid. * * @param \context $context The context to delete on. * @param int|null $itemid An optional item ID to refine the deletion. */ public static function delete_instance_data(\context $context, int $itemid = null) { if (is_null($itemid)) { self::delete_data_for_instances($context); } else { self::delete_data_for_instances($context, [$itemid]); } } /** * Deletes all user data related to a context and possibly itemids. * * @param \context $context The context to delete on. * @param array $itemids An optional list of item IDs to refine the deletion. */ public static function delete_data_for_instances(\context $context, array $itemids = []) { global $DB; $itemsql = ''; $params = ['contextid' => $context->id]; if (!empty($itemids)) { list($itemsql, $itemparams) = $DB->get_in_or_equal($itemids, SQL_PARAMS_NAMED); $params = array_merge($params, $itemparams); $itemsql = "AND itemid $itemsql"; } $sql = "SELECT gi.id AS instanceid, gd.id, gd.method FROM {grading_definitions} gd JOIN {grading_instances} gi ON gi.definitionid = gd.id JOIN {grading_areas} ga ON ga.id = gd.areaid WHERE ga.contextid = :contextid $itemsql"; $records = $DB->get_records_sql($sql, $params); if ($records) { $firstrecord = current($records); $method = $firstrecord->method; $instanceids = array_map(function($record) { return $record->instanceid; }, $records); manager::component_class_callback( "gradingform_{$method}", gradingform_provider_v2::class, 'delete_gradingform_for_instances', [$instanceids]); // Delete grading_instances rows. $DB->delete_records_list('grading_instances', 'id', $instanceids); } } /** * Exports the data related to grading definitions within the specified context/subcontext. * * @param \context $context Context owner of the data. * @param array $subcontext Subcontext owner of the data. * @param int $userid The user whose information is to be exported. */ protected static function export_definitions(\context $context, array $subcontext, int $userid = 0) { global $DB; $join = "JOIN {grading_areas} a ON a.id = d.areaid JOIN {context} c ON a.contextid = c.id AND c.contextlevel = :contextlevel"; $select = 'a.contextid = :contextid'; $params = [ 'contextlevel' => CONTEXT_MODULE, 'contextid' => $context->id ]; if (!empty($userid)) { $join .= ' LEFT JOIN {grading_instances} i ON i.definitionid = d.id AND i.raterid = :raterid'; $select .= ' AND (usercreated = :usercreated OR usermodified = :usermodified OR i.id IS NOT NULL)'; $params['usercreated'] = $userid; $params['usermodified'] = $userid; $params['raterid'] = $userid; } $sql = "SELECT gd.id, gd.method, gd.name, gd.description, gd.timecopied, gd.timecreated, gd.usercreated, gd.timemodified, gd.usermodified FROM ( SELECT DISTINCT d.id FROM {grading_definitions} d $join WHERE $select ) ids JOIN {grading_definitions} gd ON gd.id = ids.id"; $definitions = $DB->get_recordset_sql($sql, $params); $defdata = []; foreach ($definitions as $definition) { $tmpdata = [ 'method' => $definition->method, 'name' => $definition->name, 'description' => $definition->description, 'timecreated' => transform::datetime($definition->timecreated), 'usercreated' => transform::user($definition->usercreated), 'timemodified' => transform::datetime($definition->timemodified), 'usermodified' => transform::user($definition->usermodified), ]; if (!empty($definition->timecopied)) { $tmpdata['timecopied'] = transform::datetime($definition->timecopied); } $defdata[] = (object) $tmpdata; // Export grading_instances information. self::export_grading_instances($context, $subcontext, $definition->id, $userid); } $definitions->close(); if (!empty($defdata)) { $data = (object) [ 'definitions' => $defdata, ]; writer::with_context($context)->export_data($subcontext, $data); } } /** * Exports the data related to grading instances within the specified definition. * * @param \context $context Context owner of the data. * @param array $subcontext Subcontext owner of the data. * @param int $definitionid The definition ID whose grading instance information is to be exported. * @param int $userid The user whose information is to be exported. */ protected static function export_grading_instances(\context $context, array $subcontext, int $definitionid, int $userid = 0) { global $DB; $params = ['definitionid' => $definitionid]; if (!empty($userid)) { $params['raterid'] = $userid; } $instances = $DB->get_recordset('grading_instances', $params); $instancedata = []; foreach ($instances as $instance) { // TODO: Get the status name (instead of the ID). $tmpdata = [ 'rawgrade' => $instance->rawgrade, 'status' => $instance->status, 'feedback' => $instance->feedback, 'feedbackformat' => $instance->feedbackformat, 'timemodified' => transform::datetime($instance->timemodified), ]; $instancedata[] = (object) $tmpdata; } $instances->close(); if (!empty($instancedata)) { $data = (object) [ 'instances' => $instancedata, ]; writer::with_context($context)->export_related_data($subcontext, 'gradinginstances', $data); } } /** * No deletion of the advanced grading is done. * * @param \context $context the context to delete in. */ public static function delete_data_for_all_users_in_context(\context $context) { // The only information left to be deleted here is the grading definitions. Currently we are not deleting these. } /** * Deletion of data in this provider is only related to grades and so can not be * deleted for the creator of the advanced grade criteria. * * @param approved_contextlist $contextlist a list of contexts approved for deletion. */ public static function delete_data_for_user(approved_contextlist $contextlist) { // The only information left to be deleted here is the grading definitions. Currently we are not deleting these. } /** * Delete multiple users within a single context. * * @param approved_userlist $userlist The approved context and user information to delete information for. */ public static function delete_data_for_users(\core_privacy\local\request\approved_userlist $userlist) { // The only information left to be deleted here is the grading definitions. Currently we are not deleting these. } } grading/classes/privacy/gradingform_legacy_polyfill.php 0000604 00000004034 15062070556 0017542 0 ustar 00 <?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/>. /** * This file contains the polyfill to allow a plugin to operate with Moodle 3.3 up. * * @package core_grading * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace core_grading\privacy; defined('MOODLE_INTERNAL') || die(); /** * The trait used to provide backwards compatability for third-party plugins. * * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ trait gradingform_legacy_polyfill { /** * Export user data relating to an instance ID. * * @param \context $context Context to use with the export writer. * @param int $instanceid The instance ID to export data for. * @param array $subcontext The directory to export this data to. */ public static function export_gradingform_instance_data(\context $context, int $instanceid, array $subcontext) { static::_export_gradingform_instance_data($context, $instanceid, $subcontext); } /** * Deletes all user data related to the provided instance IDs. * * @param array $instanceids The instance IDs to delete information from. */ public static function delete_gradingform_for_instances(array $instanceids) { static::_delete_gradingform_for_instances($instanceids); } } grading/classes/privacy/gradingform_provider_v2.php 0000604 00000003370 15062070556 0016627 0 ustar 00 <?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/>. /** * Privacy class for requesting user data. * * @package core_grading * @copyright 2018 Adrian Greeve <adriangreeve.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace core_grading\privacy; defined('MOODLE_INTERNAL') || die(); interface gradingform_provider_v2 extends \core_privacy\local\request\plugin\subsystem_provider, \core_privacy\local\request\shared_userlist_provider { /** * Export user data relating to an instance ID. * * @param \context $context Context to use with the export writer. * @param int $instanceid The instance ID to export data for. * @param array $subcontext The directory to export this data to. */ public static function export_gradingform_instance_data(\context $context, int $instanceid, array $subcontext); /** * Deletes all user data related to the provided instance IDs. * * @param array $instanceids The instance IDs to delete information from. */ public static function delete_gradingform_for_instances(array $instanceids); } grading/tests/privacy/provider_test.php 0000604 00000050170 15062070556 0014405 0 ustar 00 <?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/>. /** * Privacy tests for core_grading. * * @package core_grading * @category test * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace core_grading\privacy; defined('MOODLE_INTERNAL') || die(); global $CFG; use core_privacy\tests\provider_testcase; use core_privacy\local\request\approved_contextlist; use core_privacy\local\request\transform; use core_privacy\local\request\writer; use core_grading\privacy\provider; /** * Privacy tests for core_grading. * * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class provider_test extends provider_testcase { /** @var stdClass User without data. */ protected $user0; /** @var stdClass User with data. */ protected $user1; /** @var stdClass User with data. */ protected $user2; /** @var context context_module of an activity without grading definitions. */ protected $instancecontext0; /** @var context context_module of the activity where the grading definitions are. */ protected $instancecontext1; /** @var context context_module of the activity where the grading definitions are. */ protected $instancecontext2; /** * Test getting the context for the user ID related to this plugin. */ public function test_get_contexts_for_userid() { global $DB; $this->resetAfterTest(); $this->grading_setup_test_scenario_data(); $this->assertCount(2, $DB->get_records('grading_definitions')); // User1 has created grading definitions for instance1 and instance2. $contextlist = provider::get_contexts_for_userid($this->user1->id); $this->assertCount(2, $contextlist); $this->assertContainsEquals($this->instancecontext1->id, $contextlist->get_contextids()); $this->assertContainsEquals($this->instancecontext2->id, $contextlist->get_contextids()); $this->assertNotContainsEquals($this->instancecontext0->id, $contextlist->get_contextids()); // User2 has only modified grading definitions for instance2. $contextlist = provider::get_contexts_for_userid($this->user2->id); $this->assertCount(1, $contextlist); $this->assertContainsEquals($this->instancecontext2->id, $contextlist->get_contextids()); // User0 hasn't created or modified any grading definition. $contextlist = provider::get_contexts_for_userid($this->user0->id); $this->assertCount(0, $contextlist); } /** * Test retrieval of user ids in a given context. */ public function test_get_users_in_context() { $this->resetAfterTest(); $this->grading_setup_test_scenario_data(); // Instance two has one user who created the definitions and another who modified it. $userlist = new \core_privacy\local\request\userlist($this->instancecontext2, 'core_grading'); provider::get_users_in_context($userlist); // Check that we get both. $this->assertCount(2, $userlist->get_userids()); } /** * Export for a user with no grading definitions created or modified will not have any data exported. */ public function test_export_user_data_no_content() { $this->resetAfterTest(); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $context = \context_system::instance(); /** @var \core_privacy\tests\request\content_writer $writer */ $writer = writer::with_context($context); $this->assertFalse($writer->has_any_data()); $this->export_context_data_for_user($user->id, $context, 'core_grading'); $this->assertFalse(writer::with_context($context)->has_any_data()); } /** * Test that data is exported correctly for this plugin. */ public function test_export_user_data() { global $DB; $this->resetAfterTest(); $now = time(); $defnameprefix = 'fakename'; $this->grading_setup_test_scenario_data($defnameprefix, $now); $this->assertCount(2, $DB->get_records('grading_definitions')); // Validate exported data: instance1 - user0 has NO data. $this->setUser($this->user0); writer::reset(); $writer = writer::with_context($this->instancecontext1); $this->assertFalse($writer->has_any_data()); $this->export_context_data_for_user($this->user0->id, $this->instancecontext1, 'core_grading'); $data = $writer->get_data([get_string('gradingmethod', 'grading')]); $this->assertEmpty($data); // Validate exported data: instance0 - user1 has NO data. $this->setUser($this->user1); writer::reset(); $writer = writer::with_context($this->instancecontext0); $this->assertFalse($writer->has_any_data()); $this->export_context_data_for_user($this->user1->id, $this->instancecontext0, 'core_grading'); $data = $writer->get_data([get_string('gradingmethod', 'grading')]); $this->assertEmpty($data); // Validate exported data: instance1 - user1 has data (user has created and modified it). writer::reset(); $writer = writer::with_context($this->instancecontext1); $this->assertFalse($writer->has_any_data()); $this->export_context_data_for_user($this->user1->id, $this->instancecontext1, 'core_grading'); $data = $writer->get_data([get_string('gradingmethod', 'grading')]); $this->assertCount(1, $data->definitions); $firstkey = reset($data->definitions); $this->assertNotEmpty($firstkey->name); $this->assertEquals('test_method', $firstkey->method); $this->assertEquals(transform::datetime($now), $firstkey->timecreated); $this->assertEquals($this->user1->id, $firstkey->usercreated); $this->assertEquals($defnameprefix.'1', $firstkey->name); // Validate exported data: instance2 - user1 has data (user has created it). writer::reset(); $writer = writer::with_context($this->instancecontext2); $this->assertFalse($writer->has_any_data()); $this->export_context_data_for_user($this->user1->id, $this->instancecontext2, 'core_grading'); $data = $writer->get_data([get_string('gradingmethod', 'grading')]); $this->assertCount(1, $data->definitions); $firstkey = reset($data->definitions); $this->assertNotEmpty($firstkey->name); $this->assertEquals('test_method', $firstkey->method); $this->assertEquals(transform::datetime($now), $firstkey->timecreated); $this->assertEquals($this->user1->id, $firstkey->usercreated); $this->assertEquals($defnameprefix.'2', $firstkey->name); // Validate exported data: instance1 - user2 has NO data. $this->setUser($this->user2); writer::reset(); $writer = writer::with_context($this->instancecontext1); $this->assertFalse($writer->has_any_data()); $this->export_context_data_for_user($this->user2->id, $this->instancecontext1, 'core_grading'); $data = $writer->get_data([get_string('gradingmethod', 'grading')]); $this->assertEmpty($data); // Validate exported data: instance2 - user2 has data (user has modified it). $this->setUser($this->user2); writer::reset(); $writer = writer::with_context($this->instancecontext2); $this->assertFalse($writer->has_any_data()); $this->export_context_data_for_user($this->user2->id, $this->instancecontext2, 'core_grading'); $data = $writer->get_data([get_string('gradingmethod', 'grading')]); $this->assertCount(1, $data->definitions); } /** * Test for provider::delete_data_for_all_users_in_context(). */ public function test_delete_data_for_all_users_in_context() { global $DB; $this->resetAfterTest(); $this->grading_setup_test_scenario_data(); // Before deletion, we should have 2 grading_definitions. $this->assertCount(2, $DB->get_records('grading_definitions')); // Delete data. provider::delete_data_for_all_users_in_context($this->instancecontext0); provider::delete_data_for_all_users_in_context($this->instancecontext1); provider::delete_data_for_all_users_in_context($this->instancecontext2); // Before deletion, we should have same grading_definitions (nothing was deleted). $this->assertCount(2, $DB->get_records('grading_definitions')); } /** * Test for provider::delete_data_for_user(). */ public function test_delete_data_for_user() { global $DB; $this->resetAfterTest(); $this->grading_setup_test_scenario_data(); // Before deletion, we should have 2 grading_definitions. $this->assertCount(2, $DB->get_records('grading_definitions')); // Delete data for $user0. $contextlist = provider::get_contexts_for_userid($this->user0->id); $approvedcontextlist = new approved_contextlist( $this->user0, 'core_grading', $contextlist->get_contextids() ); provider::delete_data_for_user($approvedcontextlist); // Delete data for $user1. $contextlist = provider::get_contexts_for_userid($this->user1->id); $approvedcontextlist = new approved_contextlist( $this->user1, 'core_grading', $contextlist->get_contextids() ); provider::delete_data_for_user($approvedcontextlist); // Delete data for $user2. $contextlist = provider::get_contexts_for_userid($this->user2->id); $approvedcontextlist = new approved_contextlist( $this->user2, 'core_grading', $contextlist->get_contextids() ); provider::delete_data_for_user($approvedcontextlist); // Before deletion, we should have same grading_definitions (nothing was deleted). $this->assertCount(2, $DB->get_records('grading_definitions')); } /** * Test exporting user data relating to an item ID. */ public function test_export_item_data() { global $DB; $this->resetAfterTest(); $course = $this->getDataGenerator()->create_course(); $module = $this->getDataGenerator()->create_module('assign', ['course' => $course]); $user = $this->getDataGenerator()->create_user(); $guidegenerator = \testing_util::get_data_generator()->get_plugin_generator('gradingform_guide'); $this->setUser($user); $modulecontext = \context_module::instance($module->cmid); $controller = $guidegenerator->get_test_guide($modulecontext); // In the situation of mod_assign this would be the id from assign_grades. $itemid = 1; $instance = $controller->create_instance($user->id, $itemid); $data = $guidegenerator->get_test_form_data( $controller, $itemid, 5, 'This user made several mistakes.', 10, 'This user has two pictures.' ); $instance->update($data); $instanceid = $instance->get_data('id'); provider::export_item_data($modulecontext, $itemid, ['Test']); $data = (array) writer::with_context($modulecontext)->get_data(['Test', 'Marking guide', $instance->get_data('id')]); $this->assertCount(2, $data); $this->assertEquals('This user made several mistakes.', $data['Spelling mistakes']->remark); $this->assertEquals(5, $data['Spelling mistakes']->score); $this->assertEquals('This user has two pictures.', $data['Pictures']->remark); $this->assertEquals(10, $data['Pictures']->score); } /** * Test deleting user data related to a context and item ID. */ public function test_delete_instance_data() { global $DB; $this->resetAfterTest(); $course = $this->getDataGenerator()->create_course(); $module = $this->getDataGenerator()->create_module('assign', ['course' => $course]); $user = $this->getDataGenerator()->create_user(); $guidegenerator = \testing_util::get_data_generator()->get_plugin_generator('gradingform_guide'); $this->setUser($user); $modulecontext = \context_module::instance($module->cmid); $controller = $guidegenerator->get_test_guide($modulecontext); // In the situation of mod_assign this would be the id from assign_grades. $itemid = 1; $instance = $controller->create_instance($user->id, $itemid); $data = $guidegenerator->get_test_form_data( $controller, $itemid, 5, 'This user made several mistakes.', 10, 'This user has two pictures.' ); $instance->update($data); $itemid = 2; $instance = $controller->create_instance($user->id, $itemid); $data = $guidegenerator->get_test_form_data( $controller, $itemid, 25, 'This user made no mistakes.', 5, 'This user has one picture.' ); $instance->update($data); // Check how many records we have in the fillings table. $records = $DB->get_records('gradingform_guide_fillings'); $this->assertCount(4, $records); // Let's delete one of the instances (the last one would be the easiest). provider::delete_instance_data($modulecontext, $itemid); $records = $DB->get_records('gradingform_guide_fillings'); $this->assertCount(2, $records); foreach ($records as $record) { $this->assertNotEquals($instance->get_id(), $record->instanceid); } // This will delete all the rest of the instances for this context. provider::delete_instance_data($modulecontext); $records = $DB->get_records('gradingform_guide_fillings'); $this->assertEmpty($records); } /** * Test the deletion of multiple instances at once. */ public function test_delete_data_for_instances() { global $DB; $this->resetAfterTest(); $course = $this->getDataGenerator()->create_course(); $module = $this->getDataGenerator()->create_module('assign', ['course' => $course]); $user1 = $this->getDataGenerator()->create_user(); $user2 = $this->getDataGenerator()->create_user(); $user3 = $this->getDataGenerator()->create_user(); $guidegenerator = \testing_util::get_data_generator()->get_plugin_generator('gradingform_guide'); $this->setUser($user1); $modulecontext = \context_module::instance($module->cmid); $controller = $guidegenerator->get_test_guide($modulecontext); // In the situation of mod_assign this would be the id from assign_grades. $itemid1 = 1; $instance1 = $controller->create_instance($user1->id, $itemid1); $data = $guidegenerator->get_test_form_data( $controller, $itemid1, 5, 'This user made several mistakes.', 10, 'This user has two pictures.' ); $instance1->update($data); $itemid2 = 2; $instance2 = $controller->create_instance($user2->id, $itemid2); $data = $guidegenerator->get_test_form_data( $controller, $itemid2, 15, 'This user made a couple of mistakes.', 10, 'This user has one picture.' ); $instance2->update($data); $itemid3 = 3; $instance3 = $controller->create_instance($user3->id, $itemid3); $data = $guidegenerator->get_test_form_data( $controller, $itemid3, 20, 'This user made one mistakes.', 10, 'This user has one picture.' ); $instance3->update($data); $records = $DB->get_records('gradingform_guide_fillings'); $this->assertCount(6, $records); // Delete all user data for items 1 and 3. provider::delete_data_for_instances($modulecontext, [$itemid1, $itemid3]); $records = $DB->get_records('gradingform_guide_fillings'); $this->assertCount(2, $records); $instanceid = $instance2->get_data('id'); // The instance id should match for all remaining records. foreach ($records as $record) { $this->assertEquals($instanceid, $record->instanceid); } } /** * Helper function to setup the environment. * * course * | * +--instance0 (assignment) * | | * +--instance1 (assignment) * | | * | +--grading_definition1 (created and modified by user1) * | | * +--instance2 (assignment) * | | * | +--grading_definition2 (created by user1 and modified by user2) * * * user0 hasn't any data. * * @param string $defnameprefix * @param timestamp $now */ protected function grading_setup_test_scenario_data($defnameprefix = null, $now = null) { global $DB; $this->user0 = $this->getDataGenerator()->create_user(); $this->user1 = $this->getDataGenerator()->create_user(); $this->user2 = $this->getDataGenerator()->create_user(); // Create a course. $course = $this->getDataGenerator()->create_course(); $coursecontext = \context_course::instance($course->id); // Create some assignment instances. $params = (object)array( 'course' => $course->id, 'name' => 'Testing instance' ); $generator = $this->getDataGenerator()->get_plugin_generator('mod_assign'); $instance0 = $generator->create_instance($params); $cm0 = get_coursemodule_from_instance('assign', $instance0->id); $this->instancecontext0 = \context_module::instance($cm0->id); $instance1 = $generator->create_instance($params); $cm1 = get_coursemodule_from_instance('assign', $instance1->id); $this->instancecontext1 = \context_module::instance($cm1->id); $instance2 = $generator->create_instance($params); $cm2 = get_coursemodule_from_instance('assign', $instance2->id); $this->instancecontext2 = \context_module::instance($cm2->id); // Create fake grading areas. $fakearea1 = (object)array( 'contextid' => $this->instancecontext1->id, 'component' => 'mod_assign', 'areaname' => 'submissions', 'activemethod' => 'test_method' ); $fakeareaid1 = $DB->insert_record('grading_areas', $fakearea1); $fakearea2 = clone($fakearea1); $fakearea2->contextid = $this->instancecontext2->id; $fakeareaid2 = $DB->insert_record('grading_areas', $fakearea2); // Create fake grading definitions. if (empty($now)) { $now = time(); } if (empty($defnameprefix)) { $defnameprefix = 'fakename'; } $fakedefinition1 = (object)array( 'areaid' => $fakeareaid1, 'method' => 'test_method', 'name' => $defnameprefix.'1', 'status' => 0, 'timecreated' => $now, 'usercreated' => $this->user1->id, 'timemodified' => $now + 1, 'usermodified' => $this->user1->id, ); $fakedefid1 = $DB->insert_record('grading_definitions', $fakedefinition1); $fakedefinition2 = clone($fakedefinition1); $fakedefinition2->areaid = $fakeareaid2; $fakedefinition2->name = $defnameprefix.'2'; $fakedefinition2->usermodified = $this->user2->id; $fakedefid2 = $DB->insert_record('grading_definitions', $fakedefinition2); } } grading/tests/privacy/legacy_polyfill_test.php 0000604 00000011461 15062070556 0015731 0 ustar 00 <?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/>. namespace core_grading\privacy; defined('MOODLE_INTERNAL') || die(); /** * Unit tests for the Grading API's privacy legacy_polyfill. * * @package core_grading * @category test * @copyright 2018 Jake Dallimore <jrhdallimore@gmail.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class legacy_polyfill_test extends \advanced_testcase { /** * Test that the core_grading\privacy\legacy_polyfill works and that the static _export_gradingform_instance_data can be called. */ public function test_export_gradingform_instance_data() { $context = \context_system::instance(); $mock = $this->createMock(test_gradingform_legacy_polyfill_mock_wrapper::class); $mock->expects($this->once()) ->method('get_return_value') ->with('_export_gradingform_instance_data', [$context, 3, ['subcontext']]); test_legacy_polyfill_gradingform_provider::$mock = $mock; test_legacy_polyfill_gradingform_provider::export_gradingform_instance_data($context, 3, ['subcontext']); } /** * Test for _get_metadata shim. */ public function test_get_metadata() { $collection = new \core_privacy\local\metadata\collection('core_gradingform'); $this->assertSame($collection, test_legacy_polyfill_gradingform_provider::get_metadata($collection)); } /** * Test the _delete_gradingform_for_instances shim. */ public function test_delete_gradingform_for_instances() { $context = \context_system::instance(); $mock = $this->createMock(test_gradingform_legacy_polyfill_mock_wrapper::class); $mock->expects($this->once()) ->method('get_return_value') ->with('_delete_gradingform_for_instances', [[3, 17]]); test_legacy_polyfill_gradingform_provider::$mock = $mock; test_legacy_polyfill_gradingform_provider::delete_gradingform_for_instances([3, 17]); } } /** * Legacy polyfill test class for the gradingform_provider. * * @copyright 2018 Jake Dallimore <jrhdallimore@gmail.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class test_legacy_polyfill_gradingform_provider implements \core_privacy\local\metadata\provider, \core_grading\privacy\gradingform_provider_v2 { use \core_grading\privacy\gradingform_legacy_polyfill; use \core_privacy\local\legacy_polyfill; /** * @var test_legacy_polyfill_gradingform_provider $mock. */ public static $mock = null; /** * Export user data relating to an instance ID. * * @param \context $context Context to use with the export writer. * @param int $instanceid The instance ID to export data for. * @param array $subcontext The directory to export this data to. */ protected static function _export_gradingform_instance_data(\context $context, $instanceid, $subcontext) { static::$mock->get_return_value(__FUNCTION__, func_get_args()); } /** * Deletes all user data related to the provided instance IDs. * * @param array $instanceids The instance IDs to delete information from. */ protected static function _delete_gradingform_for_instances($instanceids) { static::$mock->get_return_value(__FUNCTION__, func_get_args()); } /** * Returns metadata about this plugin. * * @param \core_privacy\local\metadata\collection $collection The initialised collection to add items to. * @return \core_privacy\local\metadata\collection A listing of user data stored through this system. */ protected static function _get_metadata(\core_privacy\local\metadata\collection $collection) { return $collection; } } /** * Called inside the polyfill methods in the test polyfill provider, allowing us to ensure these are called with correct params. * * @copyright 2018 Jake Dallimore <jrhdallimore@gmail.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class test_gradingform_legacy_polyfill_mock_wrapper { /** * Get the return value for the specified item. */ public function get_return_value() { } } grading/tests/generator/lib.php 0000604 00000003713 15062070556 0012574 0 ustar 00 <?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/>. /** * Generator for the core_grading subsystem generator. * * @package core_grading * @category test * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); /** * Generator for the core_grading subsystem generator. * * @package core_grading * @category test * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class core_grading_generator extends component_generator_base { /** * Create an instance of an advanced grading area. * * @param context $context * @param string $component * @param string $areaname An area belonging to the specified component * @param string $method An available gradingform type * @return gradingform_controller The controller for the created instance */ public function create_instance(context $context, string $component, string $areaname, string $method): gradingform_controller { require_once(__DIR__ . '/../../lib.php'); $manager = get_grading_manager($context, $component, $areaname); $manager->set_active_method($method); return $manager->get_controller($method); } } grading/tests/generator_test.php 0000604 00000005106 15062070556 0013063 0 ustar 00 <?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/>. /** * Generator testcase for the gradingforum_rubric generator. * * @package core_grading * @category test * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace core_grading; use advanced_testcase; use context_module; use gradingform_controller; use gradingform_rubric_controller; /** * Generator testcase for the core_grading generator. * * @package core_grading * @category test * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class generator_test extends advanced_testcase { /** * Test gradingform controller creation. */ public function test_create_instance(): void { $this->resetAfterTest(true); // Fetch generators. $generator = \testing_util::get_data_generator(); $gradinggenerator = $generator->get_plugin_generator('core_grading'); // Create items required for testing. $course = $generator->create_course(); $module = $generator->create_module('assign', ['course' => $course]); $user = $generator->create_user(); $context = context_module::instance($module->cmid); // The assignment module has an itemumber 0 which is an advanced grading area called 'submissions'. $component = 'mod_assign'; $area = 'submissions'; $controller = $gradinggenerator->create_instance($context, $component, $area, 'rubric'); // This should be a rubric. $this->assertInstanceOf(gradingform_controller::class, $controller); $this->assertInstanceOf(gradingform_rubric_controller::class, $controller); $this->assertEquals($context, $controller->get_context()); $this->assertEquals($component, $controller->get_component()); $this->assertEquals($area, $controller->get_area()); } } grading/tests/grading_manager_test.php 0000604 00000012462 15062070556 0014205 0 ustar 00 <?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/>. namespace core_grading; use grading_manager; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once($CFG->dirroot . '/grade/grading/lib.php'); // Include the code to test /** * Test cases for the grading manager API * * @package core_grading * @category test * @copyright 2011 David Mudrak <david@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class grading_manager_test extends \advanced_testcase { public function test_basic_instantiation() { $manager1 = get_grading_manager(); $fakecontext = (object)array( 'id' => 42, 'contextlevel' => CONTEXT_MODULE, 'instanceid' => 22, 'path' => '/1/3/15/42', 'depth' => 4); $manager2 = get_grading_manager($fakecontext); $manager3 = get_grading_manager($fakecontext, 'assignment_upload'); $manager4 = get_grading_manager($fakecontext, 'assignment_upload', 'submission'); } /** * Unit test to set and get grading areas */ public function test_set_and_get_grading_area() { global $DB; $this->resetAfterTest(true); //sleep(2); // to make sure the microtime will always return unique values // No sleeping in tests!!! --skodak $areaname1 = 'area1-' . (string)microtime(true); $areaname2 = 'area2-' . (string)microtime(true); $fakecontext = (object)array( 'id' => 42, 'contextlevel' => CONTEXT_MODULE, 'instanceid' => 22, 'path' => '/1/3/15/42', 'depth' => 4); // non-existing area $gradingman = get_grading_manager($fakecontext, 'mod_foobar', $areaname1); $this->assertNull($gradingman->get_active_method()); // creates area implicitly and sets active method $this->assertTrue($gradingman->set_active_method('rubric')); $this->assertEquals('rubric', $gradingman->get_active_method()); // repeat setting of already set active method $this->assertFalse($gradingman->set_active_method('rubric')); // switch the manager to another area $gradingman->set_area($areaname2); $this->assertNull($gradingman->get_active_method()); // switch back and ask again $gradingman->set_area($areaname1); $this->assertEquals('rubric', $gradingman->get_active_method()); // attempting to set an invalid method $this->expectException(\moodle_exception::class); $gradingman->set_active_method('no_one_should_ever_try_to_implement_a_method_with_this_silly_name'); } /** * Unit test to check the tokenize method */ public function test_tokenize() { $UTFfailuremessage = 'A test using UTF-8 characters has failed. Consider updating PHP and PHP\'s PCRE or INTL extensions (MDL-30494)'; $needle = " šašek, \n\n \r a král; \t"; $tokens = grading_manager::tokenize($needle); $this->assertEquals(2, count($tokens), $UTFfailuremessage); $this->assertTrue(in_array('šašek', $tokens), $UTFfailuremessage); $this->assertTrue(in_array('král', $tokens), $UTFfailuremessage); $needle = ' " šašek a král " '; $tokens = grading_manager::tokenize($needle); $this->assertEquals(1, count($tokens)); $this->assertTrue(in_array('šašek a král', $tokens)); $needle = '""'; $tokens = grading_manager::tokenize($needle); $this->assertTrue(empty($tokens)); $needle = '"0"'; $tokens = grading_manager::tokenize($needle); $this->assertEquals(1, count($tokens)); $this->assertTrue(in_array('0', $tokens)); $needle = '<span>Aha</span>, then who\'s a bad guy here he?'; $tokens = grading_manager::tokenize($needle); $this->assertEquals(8, count($tokens)); $this->assertTrue(in_array('span', $tokens)); // Extracted the tag name $this->assertTrue(in_array('Aha', $tokens)); $this->assertTrue(in_array('who', $tokens)); // Removed the trailing 's $this->assertTrue(!in_array('a', $tokens)); //Single letter token was dropped $this->assertTrue(in_array('he', $tokens)); // Removed the trailing ? $needle = 'grammar, "english language"'; $tokens = grading_manager::tokenize($needle); $this->assertTrue(in_array('grammar', $tokens)); $this->assertTrue(in_array('english', $tokens)); $this->assertTrue(in_array('language', $tokens)); $this->assertTrue(!in_array('english language', $tokens)); // Quoting part of the string is not supported } } grading/tests/behat/behat_grading.php 0000604 00000017167 15062070556 0013711 0 ustar 00 <?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/>. /** * Grading methods steps definitions. * * @package core_grading * @category test * @copyright 2013 David Monllaó * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ // NOTE: no MOODLE_INTERNAL test here, this file may be required by behat before including /config.php. require_once(__DIR__ . '/../../../../lib/behat/behat_base.php'); use Behat\Gherkin\Node\TableNode as TableNode; /** * Generic grading methods step definitions. * * @package core_grading * @category test * @copyright 2013 David Monllaó * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class behat_grading extends behat_base { /** * Goes to the selected advanced grading page. You should be in the course page when this step begins. * * @Given /^I go to "(?P<activity_name_string>(?:[^"]|\\")*)" advanced grading page$/ * @param string $activityname */ public function i_go_to_advanced_grading_page($activityname) { try { $this->execute("behat_general::i_click_on_in_the", [$this->escape($activityname), 'link', 'page', 'region']); } catch (Exception $e) { $this->execute('behat_navigation::go_to_breadcrumb_location', $this->escape($activityname)); } $this->execute('behat_navigation::i_navigate_to_in_current_page_administration', get_string('gradingmanagement', 'grading')); } /** * Goes to the selected advanced grading definition page. You should be in the course page when this step begins. * * @Given /^I go to "(?P<activity_name_string>(?:[^"]|\\")*)" advanced grading definition page$/ * @param string $activityname */ public function i_go_to_advanced_grading_definition_page($activityname) { // Transforming to literals, probably not necessary, just in case. $newactionliteral = behat_context_helper::escape(get_string("manageactionnew", "grading")); $editactionliteral = behat_context_helper::escape(get_string("manageactionedit", "grading")); // Working both when adding and editing. $definitionxpath = "//a[@class='action btn btn-lg']" . "[./descendant::*[contains(., $newactionliteral) or contains(., $editactionliteral)]]"; $this->execute('behat_grading::i_go_to_advanced_grading_page', $this->escape($activityname)); $this->execute("behat_general::i_click_on", array($this->escape($definitionxpath), "xpath_element")); } /** * Goes to the student's advanced grading page. * * @Given /^I go to "(?P<user_fullname_string>(?:[^"]|\\")*)" "(?P<activity_name_string>(?:[^"]|\\")*)" activity advanced grading page$/ * @param string $userfullname The user full name including firstname and lastname. * @param string $activityname The activity name */ public function i_go_to_activity_advanced_grading_page($userfullname, $activityname) { // Step to access the user grade page from the grading page. $gradetext = get_string('gradeverb'); $this->execute('behat_navigation::go_to_breadcrumb_location', $this->escape($activityname)); $this->execute('behat_general::click_link', get_string('viewgrading', 'mod_assign')); $this->execute('behat_general::i_click_on_in_the', array( $this->escape($gradetext), 'link', $this->escape($userfullname), 'table_row' )); } /** * Publishes current activity grading defined form as a public template. * * @Given /^I publish "(?P<activity_name_string>(?:[^"]|\\")*)" grading form definition as a public template$/ * @param string $activityname */ public function i_publish_grading_form_definition_as_a_public_template($activityname) { $this->execute('behat_grading::i_go_to_advanced_grading_page', $this->escape($activityname)); $this->execute("behat_general::i_click_on", array($this->escape(get_string("manageactionshare", "grading")), "link")); $this->execute('behat_forms::press_button', get_string('continue')); } /** * Sets a previously created grading form as the activity grading form. * * @Given /^I set "(?P<activity_name_string>(?:[^"]|\\")*)" activity to use "(?P<grading_form_template_string>(?:[^"]|\\")*)" grading form$/ * @param string $activityname * @param string $templatename */ public function i_set_activity_to_use_grading_form($activityname, $templatename) { $templateliteral = behat_context_helper::escape($templatename); $templatexpath = "//h2[@class='template-name'][contains(., $templateliteral)]/" . "following-sibling::div[contains(concat(' ', normalize-space(@class), ' '), ' template-actions ')]"; // Should work with both templates and own forms. $literaltemplate = behat_context_helper::escape(get_string('templatepick', 'grading')); $literalownform = behat_context_helper::escape(get_string('templatepickownform', 'grading')); $usetemplatexpath = "/a[./descendant::div[text()=$literaltemplate]]|" . "/a[./descendant::div[text()=$literalownform]]"; $this->execute('behat_grading::i_go_to_advanced_grading_page', $this->escape($activityname)); $this->execute('behat_general::click_link', $this->escape(get_string('manageactionclone', 'grading'))); $this->execute('behat_forms::i_set_the_field_to', array(get_string('searchownforms', 'grading'), 1)); $this->execute('behat_general::i_click_on_in_the', array(get_string('search'), "button", "region-main", "region") ); $this->execute('behat_general::i_click_on_in_the', array($this->escape($usetemplatexpath), "xpath_element", $this->escape($templatexpath), "xpath_element") ); $this->execute('behat_forms::press_button', get_string('continue')); } /** * Saves the current page advanced grading form. * * @When /^I save the advanced grading form$/ */ public function i_save_the_advanced_grading_form() { $this->execute('behat_forms::press_button', get_string('savechanges')); $this->execute('behat_general::i_click_on', array($this->escape(get_string('editsettings')), 'link')); $this->execute('behat_forms::press_button', get_string('cancel')); $this->execute('behat_general::click_link', get_string('viewgrading', 'mod_assign')); } /** * Grades an activity using advanced grading. Note the grade is set by other steps, depending on the grading method. * * @Given /^I complete the advanced grading form with these values:$/ * @param TableNode $data */ public function i_complete_the_advanced_grading_form_with_these_values(TableNode $data) { $this->execute("behat_forms::i_set_the_following_fields_to_these_values", $data); $this->execute('behat_grading::i_save_the_advanced_grading_form'); } } grading/pick.php 0000604 00000026004 15062070556 0007622 0 ustar 00 <?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/>. /** * Allows to choose a form from the list of available templates * * @package core_grading * @copyright 2011 David Mudrak <david@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require(__DIR__.'/../../config.php'); require_once($CFG->dirroot.'/grade/grading/lib.php'); require_once($CFG->dirroot.'/grade/grading/pick_form.php'); $targetid = required_param('targetid', PARAM_INT); // area we are coming from $pick = optional_param('pick', null, PARAM_INT); // create new form from this template $remove = optional_param('remove', null, PARAM_INT); // remove this template $confirmed = optional_param('confirmed', false, PARAM_BOOL); // is the action confirmed // the manager of the target area $targetmanager = get_grading_manager($targetid); if ($targetmanager->get_context()->contextlevel < CONTEXT_COURSE) { throw new coding_exception('Unsupported gradable area context level'); } // currently active method in the target area $method = $targetmanager->get_active_method(); $targetcontroller = $targetmanager->get_controller($method); $targetcontrollerclass = get_class($targetcontroller); // make sure there is no such form defined in the target area if ($targetcontroller->is_form_defined()) { redirect(new moodle_url('/grade/grading/manage.php', array('areaid' => $targetid))); } list($context, $course, $cm) = get_context_info_array($targetmanager->get_context()->id); require_login($course, true, $cm); require_capability('moodle/grade:managegradingforms', $context); // user's capability in the templates bank $canshare = has_capability('moodle/grade:sharegradingforms', context_system::instance()); $canmanage = has_capability('moodle/grade:managesharedforms', context_system::instance()); // setup the page $PAGE->set_url(new moodle_url('/grade/grading/pick.php', array('targetid' => $targetid))); navigation_node::override_active_url($targetmanager->get_management_url()); $PAGE->set_title(get_string('gradingmanagement', 'core_grading')); $PAGE->set_heading(get_string('gradingmanagement', 'core_grading')); $output = $PAGE->get_renderer('core_grading'); // process picking a template if ($pick) { $sourceid = $DB->get_field('grading_definitions', 'areaid', array('id' => $pick), MUST_EXIST); $sourcemanager = get_grading_manager($sourceid); $sourcecontroller = $sourcemanager->get_controller($method); if (!$sourcecontroller->is_shared_template() and !$sourcecontroller->is_own_form()) { // note that we don't actually check whether the user has still the capability // moodle/grade:managegradingforms in the source area. so when users loose // their teacher role in a course, they can't access the course but they can // still copy the forms they have created there. throw new moodle_exception('attempt_to_pick_others_form', 'core_grading'); } if (!$sourcecontroller->is_form_defined()) { throw new moodle_exception('form_definition_mismatch', 'core_grading'); } $definition = $sourcecontroller->get_definition(); if (!$confirmed) { echo $output->header(); echo $output->confirm(get_string('templatepickconfirm', 'core_grading',array( 'formname' => s($definition->name), 'component' => $targetmanager->get_component_title(), 'area' => $targetmanager->get_area_title())), new moodle_url($PAGE->url, array('pick' => $pick, 'confirmed' => 1)), $PAGE->url); echo $output->box($sourcecontroller->render_preview($PAGE), 'template-preview-confirm'); echo $output->footer(); die(); } else { require_sesskey(); $targetcontroller->update_definition($sourcecontroller->get_definition_copy($targetcontroller)); $DB->set_field('grading_definitions', 'timecopied', time(), array('id' => $definition->id)); redirect(new moodle_url('/grade/grading/manage.php', array('areaid' => $targetid))); } } // process removing a template if ($remove) { $sourceid = $DB->get_field('grading_definitions', 'areaid', array('id' => $remove), MUST_EXIST); $sourcemanager = get_grading_manager($sourceid); $sourcecontroller = $sourcemanager->get_controller($method); if (!$sourcecontroller->is_shared_template()) { throw new moodle_exception('attempt_to_delete_nontemplate', 'core_grading'); } if (!$sourcecontroller->is_form_defined()) { throw new moodle_exception('form_definition_mismatch', 'core_grading'); } $definition = $sourcecontroller->get_definition(); if ($canmanage or ($canshare and ($definition->usercreated == $USER->id))) { // ok, this user can drop the template } else { throw new moodle_exception('no_permission_to_remove_template', 'core_grading'); } if (!$confirmed) { echo $output->header(); echo $output->confirm(get_string('templatedeleteconfirm', 'core_grading', s($definition->name)), new moodle_url($PAGE->url, array('remove' => $remove, 'confirmed' => 1)), $PAGE->url); echo $output->box($sourcecontroller->render_preview($PAGE), 'template-preview-confirm'); echo $output->footer(); die(); } else { require_sesskey(); $sourcecontroller->delete_definition(); redirect($PAGE->url); } } $searchform = new grading_search_template_form($PAGE->url, null, 'GET', '', array('class' => 'templatesearchform')); if ($searchdata = $searchform->get_data()) { $tokens = grading_manager::tokenize($searchdata->needle); $includeownforms = (!empty($searchdata->mode)); } else { $tokens = array(); $includeownforms = false; } // construct the SQL to find all matching templates $sql = "SELECT DISTINCT gd.id, gd.areaid, gd.name, gd.usercreated FROM {grading_definitions} gd JOIN {grading_areas} ga ON (gd.areaid = ga.id) JOIN {context} cx ON (ga.contextid = cx.id)"; // join method-specific tables from the plugin scope $sql .= $targetcontrollerclass::sql_search_from_tables('gd.id'); $sql .= " WHERE gd.method = ?"; $params = array($method); if (!$includeownforms) { // search for public templates only $sql .= " AND ga.contextid = ? AND ga.component = 'core_grading'"; $params[] = context_system::instance()->id; } else { // search both templates and own forms in other areas $sql .= " AND ((ga.contextid = ? AND ga.component = 'core_grading') OR (gd.usercreated = ? AND gd.status = ?))"; $params = array_merge($params, array(context_system::instance()->id, $USER->id, gradingform_controller::DEFINITION_STATUS_READY)); } if ($tokens) { $subsql = array(); // search for any of the tokens in the definition name foreach ($tokens as $token) { $subsql[] = $DB->sql_like('gd.name', '?', false, false); $params[] = '%'.$DB->sql_like_escape($token).'%'; } // search for any of the tokens in the definition description foreach ($tokens as $token) { $subsql[] = $DB->sql_like('gd.description', '?', false, false); $params[] = '%'.$DB->sql_like_escape($token).'%'; } // search for the needle in method-specific tables foreach ($tokens as $token) { list($methodsql, $methodparams) = $targetcontrollerclass::sql_search_where($token); $subsql = array_merge($subsql, $methodsql); $params = array_merge($params, $methodparams); } $sql .= " AND ((" . join(")\n OR (", $subsql) . "))"; } $sql .= " ORDER BY gd.name"; $rs = $DB->get_recordset_sql($sql, $params); echo $output->header(); $searchform->display(); $found = 0; foreach ($rs as $template) { $found++; $out = ''; $manager = get_grading_manager($template->areaid); $controller = $manager->get_controller($method); if ($controller->is_shared_template()) { $templatetag = html_writer::tag('span', get_string('templatetypeshared', 'core_grading'), array('class' => 'type shared')); $templatesrc = ''; } else if ($controller->is_own_form()) { $templatetag = html_writer::tag('span', get_string('templatetypeown', 'core_grading'), array('class' => 'type ownform')); $templatesrc = get_string('templatesource', 'core_grading', array( 'component' => $manager->get_component_title(), 'area' => $manager->get_area_title())); } else { throw new coding_exception('Something is wrong, the displayed form must be either template or own form'); } $out .= $output->heading(s($template->name).' '.$templatetag, 2, 'template-name'); $out .= $output->container($templatesrc, 'template-source'); $out .= $output->box($controller->render_preview($PAGE), 'template-preview'); $actions = array(); if ($controller->is_shared_template()) { $actions[] = $output->pick_action_icon(new moodle_url($PAGE->url, array('pick' => $template->id)), get_string('templatepick', 'core_grading'), 'i/valid', 'pick template'); if ($canmanage or ($canshare and ($template->usercreated == $USER->id))) { //$actions[] = $output->pick_action_icon(new moodle_url($PAGE->url, array('edit' => $template->id)), // get_string('templateedit', 'core_grading'), 'i/edit', 'edit'); $actions[] = $output->pick_action_icon(new moodle_url($PAGE->url, array('remove' => $template->id)), get_string('templatedelete', 'core_grading'), 't/delete', 'remove'); } } else if ($controller->is_own_form()) { $actions[] = $output->pick_action_icon(new moodle_url($PAGE->url, array('pick' => $template->id)), get_string('templatepickownform', 'core_grading'), 'i/valid', 'pick ownform'); } $out .= $output->box(join(' ', $actions), 'template-actions'); $out .= $output->box($controller->get_formatted_description(), 'template-description'); // ideally we should highlight just the name, description and the fields // in the preview that were actually searched. to make our life easier, we // simply highlight the tokens everywhere they appear, even if that exact // piece was not searched. echo highlight(join(' ', $tokens), $out); } $rs->close(); if (!$found) { echo $output->heading(get_string('nosharedformfound', 'core_grading')); } echo $output->single_button( new moodle_url('/grade/grading/manage.php', array('areaid' => $targetid)), get_string('back'), 'get'); echo $output->footer(); grading/yui/manage/manage.js 0000604 00000002602 15062070556 0012005 0 ustar 00 /** * YUI module for advanced grading methods - the manage page * * @author David Mudrak <david@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ YUI.add('moodle-core_grading-manage', function(Y) { var MANAGE = function() { MANAGE.superclass.constructor.apply(this, arguments); } Y.extend(MANAGE, Y.Base, { initializer : function(config) { this.setup_messagebox(); }, setup_messagebox : function() { Y.one('#actionresultmessagebox span').setContent(M.util.get_string('clicktoclose', 'core_grading')); Y.one('#actionresultmessagebox').on('click', function(e) { e.halt(); var box = e.currentTarget; var anim = new Y.Anim({ node: box, duration: 1, to: { opacity: 0, height: 0 }, }); anim.run(); anim.on('end', function() { var box = this.get('node'); // this === anim box.remove(true); }); }); } }, { NAME : 'grading_manage_page', ATTRS : { } }); M.core_grading = M.core_grading || {}; M.core_grading.init_manage = function(config) { return new MANAGE(config); } }, '@VERSION@', { requires:['base', 'anim'] }); amd/src/gradebooksetup_forms.js 0000604 00000010517 15062070556 0012664 0 ustar 00 // 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/>. /** * Prints the add item gradebook form * * @module core_grades * @copyright 2023 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU Public License */ import ModalForm from 'core_form/modalform'; import {getString} from 'core/str'; import Notification from 'core/notification'; import * as FormChangeChecker from 'core_form/changechecker'; const Selectors = { advancedFormLink: 'a.showadvancedform' }; /** * Initialize module */ export const init = () => { // Sometimes the trigger does not exist, so lets conditionally add it. document.addEventListener('click', event => { const args = {}; let formClass = null; let title = null; let trigger = null; if (event.target.closest('[data-trigger="add-item-form"]')) { event.preventDefault(); trigger = event.target.closest('[data-trigger="add-item-form"]'); formClass = 'core_grades\\form\\add_item'; title = trigger.getAttribute('data-itemid') === '-1' ? getString('newitem', 'core_grades') : getString('itemsedit', 'core_grades'); args.itemid = trigger.getAttribute('data-itemid'); } else if (event.target.closest('[data-trigger="add-category-form"]')) { event.preventDefault(); trigger = event.target.closest('[data-trigger="add-category-form"]'); formClass = 'core_grades\\form\\add_category'; title = trigger.getAttribute('data-category') === '-1' ? getString('newcategory', 'core_grades') : getString('categoryedit', 'core_grades'); args.category = trigger.getAttribute('data-category'); } else if (event.target.closest('[data-trigger="add-outcome-form"]')) { event.preventDefault(); trigger = event.target.closest('[data-trigger="add-outcome-form"]'); formClass = 'core_grades\\form\\add_outcome'; title = trigger.getAttribute('data-itemid') === '-1' ? getString('newoutcomeitem', 'core_grades') : getString('outcomeitemsedit', 'core_grades'); args.itemid = trigger.getAttribute('data-itemid'); } if (trigger) { args.courseid = trigger.getAttribute('data-courseid'); args.gpr_plugin = trigger.getAttribute('data-gprplugin'); const modalForm = new ModalForm({ modalConfig: { title: title, }, formClass: formClass, args: args, saveButtonText: getString('save', 'core'), returnFocus: trigger, }); // Show a toast notification when the form is submitted. modalForm.addEventListener(modalForm.events.FORM_SUBMITTED, event => { if (event.detail.result) { window.location.assign(event.detail.url); } else { Notification.addNotification({ type: 'error', message: getString('saving_failed', 'core_grades') }); } }); modalForm.show(); } const showAdvancedForm = event.target.closest(Selectors.advancedFormLink); if (showAdvancedForm) { // Navigate to the advanced form page and cary over any entered data. event.preventDefault(); const form = event.target.closest('form'); form.action = showAdvancedForm.href; // Disable the form change checker as we are going to carry over the data to the advanced form. FormChangeChecker.disableAllChecks(); form.submit(); } }); }; amd/src/searchwidget/initials.js 0000604 00000016370 15062070556 0012730 0 ustar 00 // 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/>. /** * A small dropdown to filter users within the gradebook. * * @module core_grades/searchwidget/initials * @copyright 2022 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import Pending from 'core/pending'; import * as Url from 'core/url'; import CustomEvents from "core/custom_interaction_events"; import $ from 'jquery'; /** * Whether the event listener has already been registered for this module. * * @type {boolean} */ let registered = false; // Contain our selectors within this file until they could be of use elsewhere. const selectors = { pageListItem: 'page-item', pageClickableItem: '.page-link', activeItem: 'active', formDropdown: '.initialsdropdownform', parentDomNode: '.initials-selector', firstInitial: 'firstinitial', lastInitial: 'lastinitial', initialBars: '.initialbar', // Both first and last name use this class. targetButton: 'initialswidget', formItems: { type: 'submit', save: 'save', cancel: 'cancel' } }; /** * Our initial hook into the module which will eventually allow us to handle the dropdown initials bar form. * * @param {String} callingLink The link to redirect upon form submission. * @param {Null|Number} userid The user id to filter by. * @param {Null|String} searchvalue The search value to filter by. */ export const init = (callingLink, userid = null, searchvalue = null) => { if (registered) { return; } const pendingPromise = new Pending(); registerListenerEvents(callingLink, userid, searchvalue); // BS events always bubble so, we need to listen for the event higher up the chain. $(selectors.parentDomNode).on('shown.bs.dropdown', () => { document.querySelector(selectors.pageClickableItem).focus({preventScroll: true}); }); pendingPromise.resolve(); registered = true; }; /** * Register event listeners. * * @param {String} callingLink The link to redirect upon form submission. * @param {Null|Number} userid The user id to filter by. * @param {Null|String} searchvalue The search value to filter by. */ const registerListenerEvents = (callingLink, userid = null, searchvalue = null) => { const events = [ 'click', CustomEvents.events.activate, CustomEvents.events.keyboardActivate ]; CustomEvents.define(document, events); // Register events. events.forEach((event) => { document.addEventListener(event, (e) => { // Always fetch the latest information when we click as state is a fickle thing. let {firstActive, lastActive, sifirst, silast} = onClickVariables(); let itemToReset = ''; // Prevent the usual form behaviour. if (e.target.closest(selectors.formDropdown)) { e.preventDefault(); } // Handle the state of active initials before form submission. if (e.target.closest(`${selectors.formDropdown} .${selectors.pageListItem}`)) { // Ensure the li items don't cause weird clicking emptying out the form. if (e.target.classList.contains(selectors.pageListItem)) { return; } const initialsBar = e.target.closest(selectors.initialBars); // Find out which initial bar we are in. // We want to find the current active item in the menu area the user selected. // We also want to fetch the raw item out of the array for instant manipulation. if (initialsBar.classList.contains(selectors.firstInitial)) { sifirst = e.target; itemToReset = firstActive; } else { silast = e.target; itemToReset = lastActive; } swapActiveItems(itemToReset, e); } // Handle form submissions. if (e.target.closest(`${selectors.formDropdown}`) && e.target.type === selectors.formItems.type) { if (e.target.dataset.action === selectors.formItems.save) { // Ensure we strip out the value (All) as it messes with the PHP side of the initials bar. // Then we will redirect the user back onto the page with new filters applied. const params = { 'id': e.target.closest(selectors.formDropdown).dataset.courseid, 'searchvalue': searchvalue !== null ? searchvalue : '', 'sifirst': sifirst.parentElement.classList.contains('initialbarall') ? '' : sifirst.value, 'silast': silast.parentElement.classList.contains('initialbarall') ? '' : silast.value, }; if (userid !== null) { params.userid = userid; } window.location = Url.relativeUrl(callingLink, params); } if (e.target.dataset.action === selectors.formItems.cancel) { $(`.${selectors.targetButton}`).dropdown('toggle'); } } }); }); }; /** * A small abstracted helper function which allows us to ensure we have up-to-date lists of nodes. * * @returns {{firstActive: HTMLElement, lastActive: HTMLElement, sifirst: ?String, silast: ?String}} */ const onClickVariables = () => { // Ensure we have an up-to-date initials bar. const firstItems = [...document.querySelectorAll(`.${selectors.firstInitial} li`)]; const lastItems = [...document.querySelectorAll(`.${selectors.lastInitial} li`)]; const firstActive = firstItems.filter((item) => item.classList.contains(selectors.activeItem))[0]; const lastActive = lastItems.filter((item) => item.classList.contains(selectors.activeItem))[0]; // Ensure we retain both of the selections from a previous instance. let sifirst = firstActive.querySelector(selectors.pageClickableItem); let silast = lastActive.querySelector(selectors.pageClickableItem); return {firstActive, lastActive, sifirst, silast}; }; /** * Given we are provided the old li and current click event, swap around the active properties. * * @param {HTMLElement} itemToReset * @param {Event} e */ const swapActiveItems = (itemToReset, e) => { itemToReset.classList.remove(selectors.activeItem); itemToReset.querySelector(selectors.pageClickableItem).ariaCurrent = false; // Set the select item as the current item. const itemToSetActive = e.target.parentElement; itemToSetActive.classList.add(selectors.activeItem); e.target.ariaCurrent = true; }; amd/src/searchwidget/basewidget.js 0000604 00000025504 15062070556 0013231 0 ustar 00 // 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/>. /** * A widget to search users or grade items within the gradebook. * * @module core_grades/searchwidget/basewidget * @copyright 2022 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import {debounce} from 'core/utils'; import * as Templates from 'core/templates'; import * as Selectors from 'core_grades/searchwidget/selectors'; import Notification from 'core/notification'; import Log from 'core/log'; /** * Build the base searching widget. * * @method init * @param {HTMLElement} widgetContentContainer The selector for the widget container element. * @param {Promise} bodyPromise The promise from the callee of the contents to place in the widget container. * @param {Array} data An array of all the data generated by the callee. * @param {Function} searchFunc Partially applied function we need to manage search the passed dataset. * @param {string|null} unsearchableContent The content rendered in a non-searchable area. * @param {Function|null} afterSelect Callback executed after an item is selected. */ export const init = async( widgetContentContainer, bodyPromise, data, searchFunc, unsearchableContent = null, afterSelect = null, ) => { Log.debug('The core_grades/searchwidget/basewidget component is deprecated. Please refer to core/search_combobox() instead.'); bodyPromise.then(async(bodyContent) => { // Render the body content. widgetContentContainer.innerHTML = bodyContent; // Render the unsearchable content if defined. if (unsearchableContent) { const unsearchableContentContainer = widgetContentContainer.querySelector(Selectors.regions.unsearchableContent); unsearchableContentContainer.innerHTML += unsearchableContent; } const searchResultsContainer = widgetContentContainer.querySelector(Selectors.regions.searchResults); // Display a loader until the search results are rendered. await showLoader(searchResultsContainer); // Render the search results. await renderSearchResults(searchResultsContainer, data); registerListenerEvents(widgetContentContainer, data, searchFunc, afterSelect); }).catch(Notification.exception); }; /** * Register the event listeners for the search widget. * * @method registerListenerEvents * @param {HTMLElement} widgetContentContainer The selector for the widget container element. * @param {Array} data An array of all the data generated by the callee. * @param {Function} searchFunc Partially applied function we need to manage search the passed dataset. * @param {Function|null} afterSelect Callback executed after an item is selected. */ export const registerListenerEvents = (widgetContentContainer, data, searchFunc, afterSelect = null) => { const searchResultsContainer = widgetContentContainer.querySelector(Selectors.regions.searchResults); const searchInput = widgetContentContainer.querySelector(Selectors.actions.search); if (!searchInput) { // Too late. The widget is already closed and its content is empty. return; } // We want to focus on the first known user interable element within the dropdown. searchInput.focus(); const clearSearchButton = widgetContentContainer.querySelector(Selectors.actions.clearSearch); // The search input is triggered. searchInput.addEventListener('input', debounce(async() => { // If search query is present display the 'clear search' button, otherwise hide it. if (searchInput.value.length > 0) { clearSearchButton.classList.remove('d-none'); } else { clearSearchButton.classList.add('d-none'); } // Remove aria-activedescendant when the available options change. searchInput.removeAttribute('aria-activedescendant'); // Display the search results. await renderSearchResults( searchResultsContainer, debounceCallee( searchInput.value, data, searchFunc() ) ); }, 300)); // Clear search is triggered. clearSearchButton.addEventListener('click', async(e) => { e.stopPropagation(); // Clear the entered search query in the search bar. searchInput.value = ""; searchInput.focus(); clearSearchButton.classList.add('d-none'); // Remove aria-activedescendant when the available options change. searchInput.removeAttribute('aria-activedescendant'); // Display all results. await renderSearchResults( searchResultsContainer, debounceCallee( searchInput.value, data, searchFunc() ) ); }); const inputElement = document.getElementById(searchInput.dataset.inputElement); if (inputElement && afterSelect) { inputElement.addEventListener('change', e => { const selectedOption = widgetContentContainer.querySelector( Selectors.elements.getSearchWidgetSelectOption(searchInput), ); if (selectedOption) { afterSelect(e.target.value); } }); } // Backward compatibility. Handle the click event for the following cases: // - When we have <li> tags without an afterSelect callback function being provided (old js). // - When we have <a> tags without href (old template). widgetContentContainer.addEventListener('click', e => { const deprecatedOption = e.target.closest( 'a.dropdown-item[role="menuitem"]:not([href]), .dropdown-item[role="option"]:not([href])' ); if (deprecatedOption) { // We are in one of these situations: // - We have <li> tags without an afterSelect callback function being provided. // - We have <a> tags without href. if (inputElement && afterSelect) { afterSelect(deprecatedOption.dataset.value); } else { const url = (data.find(object => object.id == deprecatedOption.dataset.value) || {url: ''}).url; location.href = url; } } }); // Backward compatibility. Handle the keydown event for the following cases: // - When we have <li> tags without an afterSelect callback function being provided (old js). // - When we have <a> tags without href (old template). widgetContentContainer.addEventListener('keydown', e => { const deprecatedOption = e.target.closest( 'a.dropdown-item[role="menuitem"]:not([href]), .dropdown-item[role="option"]:not([href])' ); if (deprecatedOption && (e.key === ' ' || e.key === 'Enter')) { // We are in one of these situations: // - We have <li> tags without an afterSelect callback function being provided. // - We have <a> tags without href. e.preventDefault(); if (inputElement && afterSelect) { afterSelect(deprecatedOption.dataset.value); } else { const url = (data.find(object => object.id == deprecatedOption.dataset.value) || {url: ''}).url; location.href = url; } } }); }; /** * Renders the loading placeholder for the search widget. * * @method showLoader * @param {HTMLElement} container The DOM node where we'll render the loading placeholder. */ export const showLoader = async(container) => { container.innerHTML = ''; const {html, js} = await Templates.renderForPromise('core_grades/searchwidget/loading', {}); Templates.replaceNodeContents(container, html, js); }; /** * We have a small helper that'll call the curried search function allowing callers to filter * the data set however we want rather than defining how data must be filtered. * * @method debounceCallee * @param {String} searchValue The input from the user that we'll search against. * @param {Array} data An array of all the data generated by the callee. * @param {Function} searchFunction Partially applied function we need to manage search the passed dataset. * @return {Array} The filtered subset of the provided data that we'll then render into the results. */ const debounceCallee = (searchValue, data, searchFunction) => { if (searchValue.length > 0) { // Search query is present. return searchFunction(data, searchValue); } return data; }; /** * Given the output of the callers' search function, render out the results into the search results container. * * @method renderSearchResults * @param {HTMLElement} searchResultsContainer The DOM node of the widget where we'll render the provided results. * @param {Array} searchResultsData The filtered subset of the provided data that we'll then render into the results. */ const renderSearchResults = async(searchResultsContainer, searchResultsData) => { const templateData = { 'searchresults': searchResultsData, }; // Build up the html & js ready to place into the help section. const {html, js} = await Templates.renderForPromise('core_grades/searchwidget/searchresults', templateData); await Templates.replaceNodeContents(searchResultsContainer, html, js); // Backward compatibility. if (searchResultsContainer.getAttribute('role') !== 'listbox') { const deprecatedOptions = searchResultsContainer.querySelectorAll( 'a.dropdown-item[role="menuitem"][href=""], .dropdown-item[role="option"]:not([href])' ); for (const option of deprecatedOptions) { option.tabIndex = 0; option.removeAttribute('href'); } } }; /** * We want to create the basic promises and hooks that the caller will implement, so we can build the search widget * ahead of time and allow the caller to resolve their promises once complete. * * @method promisesAndResolvers * @returns {{bodyPromise: Promise, bodyPromiseResolver}} */ export const promisesAndResolvers = () => { // We want to show the widget instantly but loading whilst waiting for our data. let bodyPromiseResolver; const bodyPromise = new Promise(resolve => { bodyPromiseResolver = resolve; }); return {bodyPromiseResolver, bodyPromise}; }; amd/src/searchwidget/selectors.js 0000604 00000003125 15062070556 0013111 0 ustar 00 // 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/>. /** * Selectors for the search widget. * * @module core_grades/searchwidget/selectors * @copyright 2022 Mihail Geshoski <mihail@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ export default { regions: { searchResults: '[data-region="search-results-container-widget"]', unsearchableContent: '[data-region="unsearchable-content-container-widget"]', }, actions: { search: '[data-action="search"]', clearSearch: '[data-action="clearsearch"]', }, elements: { getSearchWidgetSelector: searchtype => `.search-widget[data-searchtype="${searchtype}"]`, getSearchWidgetDropdownSelector: searchtype => `.search-widget[data-searchtype="${searchtype}"] .dropdown-menu`, getSearchWidgetSelectOption: searchInput => `#${searchInput.getAttribute('aria-controls')} [role="option"][aria-selected="true"]`, }, }; amd/src/searchwidget/repository.js 0000604 00000004003 15062070556 0013321 0 ustar 00 // 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/>. /** * A repo for the search widget. * * @module core_grades/searchwidget/repository * @copyright 2022 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import ajax from 'core/ajax'; /** * Given a course ID, we want to fetch the gradable items, so we may fetch reports based on activity items. * Note: This will be worked upon in the single view issue. * * @method gradeitemFetch * @param {int} courseid ID of the course to fetch the users of. * @return {object} jQuery promise */ export const gradeitemFetch = (courseid) => { const request = { methodname: 'gradereport_singleview_get_grade_items_for_search_widget', args: { courseid: courseid, }, }; return ajax.call([request])[0]; }; /** * Given a course ID, we want to fetch the enrolled learners, so we may fetch their reports. * * @method userFetch * @param {int} courseid ID of the course to fetch the users of. * @param {int} groupId ID of the group to fetch the users of. * @return {object} jQuery promise */ export const userFetch = (courseid, groupId) => { const request = { methodname: 'core_grades_get_enrolled_users_for_selector', args: { courseid: courseid, groupid: groupId, }, }; return ajax.call([request])[0]; }; amd/src/bulkactions/edit/tree/move_options_tree.js 0000604 00000007643 15062070556 0016410 0 ustar 00 // 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/>. /** * Keyboard navigation and aria-tree compatibility for the grade move options. * * @module core_grades/bulkactions/edit/tree/move_options_tree * @copyright 2023 Mihail Geshoski <mihail@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import Tree from 'core/tree'; import {getList} from 'core/normalise'; /** @constant {Object} The object containing the relevant selectors. */ const Selectors = { moveOptionsTree: '#destination-selector [role="tree"]', moveOption: '#destination-selector [role="treeitem"]', toggleGroupLink: '#destination-selector .collapse-list-link', }; export default class MoveOptionsTree extends Tree { /** @property {function|null} afterSelectMoveOptionCallback Callback function to run after selecting a move option. */ afterSelectMoveOptionCallback = null; /** @property {HTMLElement|null} selectedMoveOption The selected move option. */ selectedMoveOption = null; /** * The class constructor. * * @param {function|null} afterSelectMoveOptionCallback Callback function used to define actions that should be run * after selecting a move option. * @returns {void} */ constructor(afterSelectMoveOptionCallback) { super(Selectors.moveOptionsTree); this.afterSelectMoveOptionCallback = afterSelectMoveOptionCallback; } /** * Handle a key down event. * * @method handleKeyDown * @param {Event} e The event. */ handleKeyDown(e) { // If the user presses enter or space, select the item. if (e.keyCode === this.keys.enter || e.keyCode === this.keys.space) { this.selectMoveOption(e.target); } else { // Otherwise, let the default behaviour happen. super.handleKeyDown(e); } } /** * Handle an item click. * * @param {Event} event The click event. * @param {jQuery} item The item clicked. * @returns {void} */ handleItemClick(event, item) { const isToggleGroupLink = event.target.closest(Selectors.toggleGroupLink); // If the click is on the toggle group (chevron) link, let the default behaviour happen. if (isToggleGroupLink) { super.handleItemClick(event, item); return; } // If the click is on the item itself, select it. this.selectMoveOption(getList(item)[0]); } /** * Select a move option. * * @method selectMoveOption * @param {HTMLElement} moveOption The move option to select. */ selectMoveOption(moveOption) { // Create the cache of the visible items. this.refreshVisibleItemsCache(); // Deselect all the move options. document.querySelectorAll(Selectors.moveOption).forEach(item => { item.dataset.selected = "false"; }); // Select and set the focus on the specified move option. moveOption.dataset.selected = "true"; this.selectedMoveOption = moveOption; moveOption.focus(); // Call the callback function if it is defined. if (typeof this.afterSelectMoveOptionCallback === 'function') { this.afterSelectMoveOptionCallback(); } } } amd/src/bulkactions/edit/tree/move.js 0000604 00000013302 15062070556 0013603 0 ustar 00 // 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/>. /** * Class that defines the bulk move action in the gradebook setup page. * * @module core_grades/bulkactions/edit/tree/move * @copyright 2023 Mihail Geshoski <mihail@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import BulkAction from 'core/bulkactions/bulk_action'; import {get_string as getString} from 'core/str'; import ModalSaveCancel from 'core/modal_save_cancel'; import Templates from 'core/templates'; import Ajax from 'core/ajax'; import ModalEvents from 'core/modal_events'; import MoveOptionsTree from 'core_grades/bulkactions/edit/tree/move_options_tree'; /** @constant {Object} The object containing the relevant selectors. */ const Selectors = { editTreeForm: '#gradetreeform', bulkMoveInput: 'input[name="bulkmove"]', bulkMoveAfterInput: 'input[name="moveafter"]' }; export default class GradebookEditTreeBulkMove extends BulkAction { /** @property {int|null} courseId The course ID. */ courseId = null; /** @property {MoveOptionsTree|null} moveOptionsTree The move options tree object. */ moveOptionsTree = null; /** @property {string|null} gradeTree The grade tree structure. */ gradeTree = null; /** * The class constructor. * * @param {int} courseId The course ID. * @returns {void} */ constructor(courseId) { super(); this.courseId = courseId; } /** * Defines the selector of the element that triggers the bulk move action. * * @returns {string} The bulk move action trigger selector. */ getBulkActionTriggerSelector() { return 'button[data-action="move"]'; } /** * Defines the behavior once the bulk move action is triggered. * * @method executeBulkAction * @returns {void} */ async triggerBulkAction() { const modal = await this.showModal(); this.registerCustomListenerEvents(modal); } /** * Renders the bulk move action trigger element. * * @method renderBulkActionTrigger * @returns {Promise} The bulk move action trigger promise */ async renderBulkActionTrigger() { return Templates.render('core_grades/bulkactions/edit/tree/bulk_move_trigger', {}); } /** * Register custom event listeners. * * @method registerCustomClickListenerEvents * @param {Object} modal The modal object. * @returns {void} */ async registerCustomListenerEvents(modal) { await modal.getBody(); // Initialize the move options tree once the modal is shown. modal.getRoot().on(ModalEvents.shown, () => { this.moveOptionsTree = new MoveOptionsTree(() => { // Enable the 'Move' action button once something is selected. modal.setButtonDisabled('save', false); }); }); // Destroy the modal once it is hidden. modal.getRoot().on(ModalEvents.hidden, () => { modal.destroy(); }); // Define the move action event. modal.getRoot().on(ModalEvents.save, () => { // Make sure that a move option is selected. if (this.moveOptionsTree && this.moveOptionsTree.selectedMoveOption) { // Set the relevant form values. document.querySelector(Selectors.bulkMoveInput).value = 1; document.querySelector(Selectors.bulkMoveAfterInput).value = this.moveOptionsTree.selectedMoveOption.dataset.id; // Submit the form. document.querySelector(Selectors.editTreeForm).submit(); } }); } /** * Fetch the grade tree structure for the current course. * * @method fetchGradeTree * @returns {Promise} The grade tree promise */ fetchGradeTree() { const request = { methodname: 'core_grades_get_grade_tree', args: { courseid: this.courseId, }, }; return Ajax.call([request])[0]; } /** * Renders the bulk move modal body. * * @method renderModalBody * @returns {Promise} The modal body promise */ async renderModalBody() { // We need to fetch the grade tree structure only once. if (this.gradeTree === null) { this.gradeTree = await this.fetchGradeTree(); } return Templates.render('core_grades/bulkactions/edit/tree/bulk_move_grade_tree', JSON.parse(this.gradeTree)); } /** * Show the bulk move modal. * * @method showModal * @returns {Promise} The modal promise */ async showModal() { const modal = await ModalSaveCancel.create({ title: await getString('movesitems', 'grades'), body: await this.renderModalBody(), buttons: { save: await getString('move') }, large: true, }); // Disable the 'Move' action button until something is selected. modal.setButtonDisabled('save', true); modal.show(); return modal; } } amd/src/bulkactions/edit/tree/bulk_actions.js 0000604 00000005347 15062070556 0015324 0 ustar 00 // 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/>. import BulkActions from "core/bulkactions/bulk_actions"; import GradebookEditTreeBulkMove from "core_grades/bulkactions/edit/tree/move"; /** * Class for defining the bulk actions area in the gradebook setup page. * * @module core_grades/bulkactions/edit/tree/bulk_actions * @copyright 2023 Mihail Geshoski <mihail@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ const Selectors = { selectBulkItemCheckbox: 'input[type="checkbox"].itemselect' }; export default class GradebookEditTreeBulkActions extends BulkActions { /** @property {int|null} courseID The course ID. */ courseID = null; /** * Returns the instance of the class. * * @param {int} courseID * @returns {GradebookEditTreeBulkActions} */ static init(courseID) { return new this(courseID); } /** * The class constructor. * * @param {int} courseID The course ID. * @returns {void} */ constructor(courseID) { super(); this.courseID = courseID; } /** * Returns the array of the relevant bulk action objects for the gradebook setup page. * * @method getBulkActions * @returns {Array} */ getBulkActions() { return [ new GradebookEditTreeBulkMove(this.courseID) ]; } /** * Returns the array of selected items. * * @method getSelectedItems * @returns {Array} */ getSelectedItems() { return document.querySelectorAll(`${Selectors.selectBulkItemCheckbox}:checked`); } /** * Adds the listener for the item select change event. * * @method registerItemSelectChangeEvent * @param {function} eventHandler The event handler function. * @returns {void} */ registerItemSelectChangeEvent(eventHandler) { const itemSelectCheckboxes = document.querySelectorAll(Selectors.selectBulkItemCheckbox); itemSelectCheckboxes.forEach((checkbox) => { checkbox.addEventListener('change', eventHandler.bind(this)); }); } } amd/src/comboboxsearch/grade.js 0000604 00000020405 15062070556 0012515 0 ustar 00 // 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/>. /** * Allow the user to search for grades within the grade area. * * @module core_grades/comboboxsearch/grade * @copyright 2023 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import search_combobox from 'core/comboboxsearch/search_combobox'; import * as Repository from 'core_grades/searchwidget/repository'; import {renderForPromise, replaceNodeContents} from 'core/templates'; import {debounce} from 'core/utils'; export default class GradeItemSearch extends search_combobox { courseID; constructor() { super(); // Define our standard lookups. this.selectors = { ...this.selectors, courseid: '[data-region="courseid"]', placeholder: '.gradesearchdropdown [data-region="searchplaceholder"]', }; const component = document.querySelector(this.componentSelector()); this.courseID = component.querySelector(this.selectors.courseid).dataset.courseid; this.renderDefault(); } static init() { return new GradeItemSearch(); } /** * The overall div that contains the searching widget. * * @returns {string} */ componentSelector() { return '.grade-search'; } /** * The dropdown div that contains the searching widget result space. * * @returns {string} */ dropdownSelector() { return '.gradesearchdropdown'; } /** * The triggering div that contains the searching widget. * * @returns {string} */ triggerSelector() { return '.gradesearchwidget'; } /** * Build the content then replace the node. */ async renderDropdown() { const {html, js} = await renderForPromise('core/local/comboboxsearch/resultset', { results: this.getMatchedResults(), hasresults: this.getMatchedResults().length > 0, searchterm: this.getSearchTerm(), }); replaceNodeContents(this.selectors.placeholder, html, js); } /** * Build the content then replace the node by default we want our form to exist. */ async renderDefault() { this.setMatchedResults(await this.filterDataset(await this.getDataset())); this.filterMatchDataset(); await this.renderDropdown(); this.updateNodes(); this.registerInputEvents(); // Add a small BS listener so that we can set the focus correctly on open. this.$component.on('shown.bs.dropdown', () => { this.searchInput.focus({preventScroll: true}); }); } /** * Get the data we will be searching against in this component. * * @returns {Promise<*>} */ async fetchDataset() { return await Repository.gradeitemFetch(this.courseID).then((r) => r.gradeitems); } /** * Dictate to the search component how and what we want to match upon. * * @param {Array} filterableData * @returns {Array} The users that match the given criteria. */ async filterDataset(filterableData) { // Sometimes we just want to show everything. if (this.getPreppedSearchTerm() === '') { return filterableData; } return filterableData.filter((grade) => Object.keys(grade).some((key) => { if (grade[key] === "") { return false; } return grade[key].toString().toLowerCase().includes(this.getPreppedSearchTerm()); })); } /** * Given we have a subset of the dataset, set the field that we matched upon to inform the end user. */ filterMatchDataset() { this.setMatchedResults( this.getMatchedResults().map((grade) => { return { id: grade.id, name: grade.name, link: this.selectOneLink(grade.id), }; }) ); } /** * Handle any keyboard inputs. */ registerInputEvents() { // Register & handle the text input. this.searchInput.addEventListener('input', debounce(async() => { this.setSearchTerms(this.searchInput.value); // We can also require a set amount of input before search. if (this.searchInput.value === '') { // Hide the "clear" search button in the search bar. this.clearSearchButton.classList.add('d-none'); } else { // Display the "clear" search button in the search bar. this.clearSearchButton.classList.remove('d-none'); } // User has given something for us to filter against. await this.filterrenderpipe(); }, 300)); } /** * The handler for when a user interacts with the component. * * @param {MouseEvent} e The triggering event that we are working with. */ async clickHandler(e) { if (e.target.closest(this.selectors.dropdown)) { // Forcibly prevent BS events so that we can control the open and close. // Really needed because by default input elements cant trigger a dropdown. e.stopImmediatePropagation(); } this.clearSearchButton.addEventListener('click', async() => { this.searchInput.value = ''; this.setSearchTerms(this.searchInput.value); await this.filterrenderpipe(); }); // Prevent normal key presses activating this. if (e.target.closest('.dropdown-item') && e.button === 0) { window.location = e.target.closest('.dropdown-item').href; } } /** * The handler for when a user presses a key within the component. * * @param {KeyboardEvent} e The triggering event that we are working with. */ keyHandler(e) { super.keyHandler(e); // Switch the key presses to handle keyboard nav. switch (e.key) { case 'Tab': if (e.target.closest(this.selectors.input)) { e.preventDefault(); this.clearSearchButton.focus({preventScroll: true}); } break; case 'Escape': if (document.activeElement.getAttribute('role') === 'option') { e.stopPropagation(); this.searchInput.focus({preventScroll: true}); } else if (e.target.closest(this.selectors.input)) { const trigger = this.component.querySelector(this.selectors.trigger); trigger.focus({preventScroll: true}); } } } /** * Override the input event listener for the text input area. */ registerInputHandlers() { // Register & handle the text input. this.searchInput.addEventListener('input', debounce(() => { this.setSearchTerms(this.searchInput.value); // We can also require a set amount of input before search. if (this.getSearchTerm() === '') { // Hide the "clear" search button in the search bar. this.clearSearchButton.classList.add('d-none'); } else { // Display the "clear" search button in the search bar. this.clearSearchButton.classList.remove('d-none'); } }, 300)); } /** * Build up the view all link that is dedicated to a particular result. * * @param {Number} gradeID The ID of the grade item selected. */ selectOneLink(gradeID) { throw new Error(`selectOneLink(${gradeID}) must be implemented in ${this.constructor.name}`); } } amd/src/edittree_index.js 0000604 00000027710 15062070556 0011437 0 ustar 00 // 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/>. /** * Enhance the gradebook tree setup with various facilities. * * @module core_grades/edittree_index * @copyright 2016 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import storage from 'core/localstorage'; import {addIconToContainer} from 'core/loadingicon'; import Notification from 'core/notification'; import Pending from 'core/pending'; const SELECTORS = { CATEGORY_TOGGLE: '.toggle-category', GRADEBOOK_SETUP_TABLE: '.setup-grades', WEIGHT_OVERRIDE_CHECKBOX: '.weightoverride', BULK_MOVE_SELECT: '#menumoveafter', BULK_MOVE_INPUT: '#bulkmoveinput', GRADEBOOK_SETUP_WRAPPER: '.gradetree-wrapper', GRADEBOOK_SETUP_BOX: '.gradetreebox' }; /** * Register related event listeners. * * @method registerListenerEvents * @param {int} courseId The ID of course. * @param {int} userId The ID of the current logged user. */ const registerListenerEvents = (courseId, userId) => { document.addEventListener('change', e => { // Toggle the availability of the weight input field based on the changed state (checked/unchecked) of the // related checkbox element. if (e.target.matches(SELECTORS.WEIGHT_OVERRIDE_CHECKBOX)) { toggleWeightInput(e.target); } // Submit the bulk move form when the selected option in the bulk move select element has been changed. if (e.target.matches(SELECTORS.BULK_MOVE_SELECT)) { submitBulkMoveForm(e.target); } }); const gradebookSetup = document.querySelector(SELECTORS.GRADEBOOK_SETUP_TABLE); gradebookSetup.addEventListener('click', e => { const toggle = e.target.closest(SELECTORS.CATEGORY_TOGGLE); // Collapse or expand the grade category when the visibility toggle button is activated. if (toggle) { e.preventDefault(); toggleCategory(toggle, courseId, userId, true); } }); }; /** * Toggle the weight input field based on its checkbox. * * @method toggleWeightInput * @param {object} weightOverrideCheckbox The weight override checkbox element. */ const toggleWeightInput = (weightOverrideCheckbox) => { const row = weightOverrideCheckbox.closest('tr'); const itemId = row.dataset.itemid; const weightOverrideInput = row.querySelector(`input[name="weight_${itemId}"]`); weightOverrideInput.disabled = !weightOverrideCheckbox.checked; }; /** * Submit the bulk move form. * * @method toggleWeightInput * @param {object} bulkMoveSelect The bulk move select element. */ const submitBulkMoveForm = (bulkMoveSelect) => { const form = bulkMoveSelect.closest('form'); const bulkMoveInput = form.querySelector(SELECTORS.BULK_MOVE_INPUT); bulkMoveInput.value = 1; form.submit(); }; /** * Method that collapses all relevant grade categories based on the locally stored state of collapsed grade categories * for a given user. * * @method collapseGradeCategories * @param {int} courseId The ID of course. * @param {int} userId The ID of the current logged user. */ const collapseGradeCategories = (courseId, userId) => { const gradebookSetup = document.querySelector(SELECTORS.GRADEBOOK_SETUP_TABLE); const storedCollapsedCategories = storage.get(`core_grade_collapsedgradecategories_${courseId}_${userId}`); if (storedCollapsedCategories) { // Fetch all grade categories that are locally stored as collapsed and re-apply the collapse action. const collapsedCategories = JSON.parse(storedCollapsedCategories); collapsedCategories.forEach((category) => { const categoryToggleElement = gradebookSetup.querySelector(`${SELECTORS.CATEGORY_TOGGLE}[data-category="${category}"`); if (categoryToggleElement) { toggleCategory(categoryToggleElement, courseId, userId, false); } }); } }; /** * Method that updates the locally stored state of collapsed grade categories based on a performed toggle action on a * given grade category. * * @method updateCollapsedCategoriesStoredState * @param {string} category The category to be added or removed from the collapsed grade categories local storage. * @param {int} courseId The ID of course. * @param {int} userId The ID of the current logged user. * @param {boolean} isCollapsing Whether the category is being collapsed or not. */ const updateCollapsedCategoriesStoredState = (category, courseId, userId, isCollapsing) => { const currentStoredCollapsedCategories = storage.get(`core_grade_collapsedgradecategories_${courseId}_${userId}`); let collapsedCategories = currentStoredCollapsedCategories ? JSON.parse(currentStoredCollapsedCategories) : []; if (isCollapsing) { collapsedCategories.push(category); } else { collapsedCategories = collapsedCategories.filter(cat => cat !== category); } storage.set(`core_grade_collapsedgradecategories_${courseId}_${userId}`, JSON.stringify(collapsedCategories)); }; /** * Method that handles the grade category toggle action. * * @method toggleCategory * @param {object} toggleElement The category toggle node that was clicked. * @param {int} courseId The ID of course. * @param {int} userId The ID of the current logged user. * @param {boolean} storeCollapsedState Whether to store (local storage) the state of collapsed grade categories. */ const toggleCategory = (toggleElement, courseId, userId, storeCollapsedState) => { const target = toggleElement.dataset.target; const category = toggleElement.dataset.category; // Whether the toggle action is collapsing the category or not. const isCollapsing = toggleElement.getAttribute('aria-expanded') === "true"; const gradebookSetup = toggleElement.closest(SELECTORS.GRADEBOOK_SETUP_TABLE); // Find all targeted 'children' rows of the toggled category. const targetRows = gradebookSetup.querySelectorAll(target); // Find the maximum grade cell in the grade category that is being collapsed/expanded. const toggleElementRow = toggleElement.closest('tr'); const maxGradeCell = toggleElementRow.querySelector('.column-range'); if (isCollapsing) { toggleElement.setAttribute('aria-expanded', 'false'); // Update the 'data-target' of the toggle category node to make sure that when we perform another toggle action // to expand this category we only target rows which have been hidden by this category toggle action. toggleElement.dataset.target = `[data-hidden-by='${category}']`; if (maxGradeCell) { const relatedCategoryAggregationRow = gradebookSetup.querySelector(`[data-aggregationforcategory='${category}']`); maxGradeCell.innerHTML = relatedCategoryAggregationRow.querySelector('.column-range').innerHTML; } } else { toggleElement.setAttribute('aria-expanded', 'true'); // Update the 'data-target' of the toggle category node to make sure that when we perform another toggle action // to collapse this category we only target rows which are children of this category and are not currently hidden. toggleElement.dataset.target = `.${category}[data-hidden='false']`; if (maxGradeCell) { maxGradeCell.innerHTML = ''; } } // If explicitly instructed, update accordingly the locally stored state of collapsed categories based on the // toggle action performed on the given grade category. if (storeCollapsedState) { updateCollapsedCategoriesStoredState(category, courseId, userId, isCollapsing); } // Loop through all targeted child row elements and update the required data attributes to either hide or show // them depending on the toggle action (collapsing or expanding). targetRows.forEach((row) => { if (isCollapsing) { row.dataset.hidden = 'true'; row.dataset.hiddenBy = category; } else { row.dataset.hidden = 'false'; row.dataset.hiddenBy = ''; } }); // Since the user report is presented in an HTML table, rowspans are used under each category to create a visual // hierarchy between categories and grading items. When expanding or collapsing a category we need to also update // (subtract or add) the rowspan values associated to each parent category row to preserve the correct visual // hierarchy in the table. updateParentCategoryRowspans(toggleElement, targetRows.length); }; /** * Method that updates the rowspan value of all 'parent' category rows of a given category node. * * @method updateParentCategoryRowspans * @param {object} toggleElement The category toggle node that was clicked. * @param {int} num The number we want to add or subtract from the rowspan value of the 'parent' category row elements. */ const updateParentCategoryRowspans = (toggleElement, num) => { const gradebookSetup = toggleElement.closest(SELECTORS.GRADEBOOK_SETUP_TABLE); // Get the row element which contains the category toggle node. const rowElement = toggleElement.closest('tr'); // Loop through the class list of the toggle category row element. // The list contains classes which identify all parent categories of the toggled category. rowElement.classList.forEach((className) => { // Find the toggle node of the 'parent' category that is identified by the given class name. const parentCategoryToggleElement = gradebookSetup.querySelector(`[data-target=".${className}[data-hidden='false']"`); if (parentCategoryToggleElement) { // Get the row element which contains the parent category toggle node. const categoryRowElement = parentCategoryToggleElement.closest('tr'); // Find the rowspan element associated to this parent category. const categoryRowSpanElement = categoryRowElement.nextElementSibling.querySelector('[rowspan]'); // Depending on whether the toggle action has expanded or collapsed the category, either add or // subtract from the 'parent' category rowspan. if (toggleElement.getAttribute('aria-expanded') === "true") { categoryRowSpanElement.rowSpan = categoryRowSpanElement.rowSpan + num; } else { // The category has been collapsed. categoryRowSpanElement.rowSpan = categoryRowSpanElement.rowSpan - num; } } }); }; /** * Initialize module. * * @method init * @param {int} courseId The ID of course. * @param {int} userId The ID of the current logged user. */ export const init = (courseId, userId) => { const pendingPromise = new Pending(); const gradebookSetupBox = document.querySelector(SELECTORS.GRADEBOOK_SETUP_BOX); // Display a loader while the relevant grade categories are being re-collapsed on page load (based on the locally // stored state for the given user). addIconToContainer(gradebookSetupBox).then((loader) => { setTimeout(() => { collapseGradeCategories(courseId, userId); // Once the grade categories have been re-collapsed, remove the loader and display the Gradebook setup content. loader.remove(); document.querySelector(SELECTORS.GRADEBOOK_SETUP_WRAPPER).classList.remove('d-none'); pendingPromise.resolve(); }, 150); return; }).fail(Notification.exception); registerListenerEvents(courseId, userId); }; amd/src/grades/grader/gradingpanel/repository.js 0000604 00000003344 15062070556 0016023 0 ustar 00 // 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/>. /** * Repository for simple direct grading panel. * * @module core_grades/grades/grader/gradingpanel/repository * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import {call as fetchMany} from 'core/ajax'; import {normaliseResult} from './normalise'; export const fetchGrade = type => (component, contextid, itemname, gradeduserid) => { return fetchMany([{ methodname: `core_grades_grader_gradingpanel_${type}_fetch`, args: { component, contextid, itemname, gradeduserid, }, }])[0]; }; export const saveGrade = type => async(component, contextid, itemname, gradeduserid, notifyUser, formdata) => { return normaliseResult(await fetchMany([{ methodname: `core_grades_grader_gradingpanel_${type}_store`, args: { component, contextid, itemname, gradeduserid, notifyuser: notifyUser, formdata, }, }])[0]); }; amd/src/grades/grader/gradingpanel/normalise.js 0000604 00000003373 15062070556 0015577 0 ustar 00 // 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/>. /** * Error handling and normalisation of provided data. * * @module core_grades/grades/grader/gradingpanel/normalise * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ /** * Normalise a resultset for consumption by the grader. * * @param {Object} result The result returned from a grading web service * @return {Object} */ export const normaliseResult = result => { return { result, failed: !!result.warnings.length, success: !result.warnings.length, error: null, }; }; /** * Return the resultset used to describe an invalid result. * * @return {Object} */ export const invalidResult = () => { return { success: false, failed: false, result: {}, error: null, }; }; /** * Return the resultset used to describe a failed update. * * @param {Object} error * @return {Object} */ export const failedUpdate = error => { return { success: false, failed: true, result: {}, error, }; }; amd/src/grades/grader/gradingpanel/comparison.js 0000604 00000006046 15062070556 0015760 0 ustar 00 // 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/>. /** * Compare a given form's values and its previously set data attributes. * * @module core_grades/grades/grader/gradingpanel/comparison * @copyright 2019 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ export const fillInitialValues = (form) => { Array.prototype.forEach.call(form.elements, (input) => { if (input.type === 'submit' || input.type === 'button') { return; } else if (input.type === 'radio' || input.type === 'checkbox') { input.dataset.initialValue = JSON.stringify(input.checked); } else if (typeof input.value !== 'undefined') { input.dataset.initialValue = JSON.stringify(input.value); } else if (input.type === 'select-one') { Array.prototype.forEach.call(input.options, (option) => { option.dataset.initialValue = JSON.stringify(option.selected); }); } }); }; /** * Compare the form data with the initial form data from when the form was set up. * * If values have changed, return a truthy value. * * @param {HTMLElement} form * @return {Boolean} */ export const compareData = (form) => { const result = Array.prototype.some.call(form.elements, (input) => { if (input.type === 'submit' || input.type === 'button') { return false; } else if (input.type === 'radio' || input.type === 'checkbox') { if (typeof input.dataset.initialValue !== 'undefined') { return input.dataset.initialValue !== JSON.stringify(input.checked); } } else if (typeof input.value !== 'undefined') { if (typeof input.dataset.initialValue !== 'undefined') { return input.dataset.initialValue !== JSON.stringify(input.value); } } else if (input.type === 'select-one') { return Array.prototype.some.call(input.options, (option) => { if (typeof option.dataset.initialValue !== 'undefined') { return option.dataset.initialValue !== JSON.stringify(option.selected); } return false; }); } // No value found to check. Assume that there were changes. return true; }); // Fill the initial values again as the form may not be reloaded. fillInitialValues(form); return result; }; amd/src/grades/grader/gradingpanel/scale.js 0000604 00000003373 15062070556 0014675 0 ustar 00 // 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/>. /** * Grading panel for simple direct grading. * * @module core_grades/grades/grader/gradingpanel/scale * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import {saveGrade, fetchGrade} from './repository'; import {compareData} from 'core_grades/grades/grader/gradingpanel/comparison'; // Note: We use jQuery.serializer here until we can rewrite Ajax to use XHR.send() import jQuery from 'jquery'; import {invalidResult} from './normalise'; export const fetchCurrentGrade = (...args) => fetchGrade('scale')(...args); export const storeCurrentGrade = (component, context, itemname, userId, notifyUser, rootNode) => { const form = rootNode.querySelector('form'); const grade = form.querySelector('select[name="grade"]'); if (!grade.checkValidity() || !grade.value.trim()) { return invalidResult; } if (compareData(form) === true) { return saveGrade('scale')(component, context, itemname, userId, notifyUser, jQuery(form).serialize()); } else { return ''; } }; amd/src/grades/grader/gradingpanel/point.js 0000604 00000004363 15062070556 0014737 0 ustar 00 // 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/>. /** * Grading panel for simple direct grading. * * @module core_grades/grades/grader/gradingpanel/point * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import {saveGrade, fetchGrade} from './repository'; import {compareData} from 'core_grades/grades/grader/gradingpanel/comparison'; // Note: We use jQuery.serializer here until we can rewrite Ajax to use XHR.send() import jQuery from 'jquery'; import {invalidResult} from './normalise'; /** * Fetch the current grade for a user. * * @param {object} args * @param {String} args.component * @param {Number} args.context * @param {String} args.itemname * @param {Number} args.userId * @param {Element} args.rootNode * @returns {Object} */ export const fetchCurrentGrade = (...args) => fetchGrade('point')(...args); /** * Store a new grade for a user. * * @param {String} component * @param {Number} context * @param {String} itemname * @param {Number} userId * @param {Boolean} notifyUser * @param {Element} rootNode * @returns {Object} */ export const storeCurrentGrade = async(component, context, itemname, userId, notifyUser, rootNode) => { const form = rootNode.querySelector('form'); const grade = form.querySelector('input[name="grade"]'); if (!grade.checkValidity() || !grade.value.trim()) { return invalidResult; } if (compareData(form) === true) { return await saveGrade('point')(component, context, itemname, userId, notifyUser, jQuery(form).serialize()); } else { return ''; } }; amd/src/edittree_weights.js 0000604 00000034557 15062070556 0012011 0 ustar 00 // 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/>. /** * This module provides functionality for managing weight calculations and adjustments for grade items. * * @module core_grades/edittree_weight * @copyright 2023 Shamim Rezaie <shamim@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import {getString} from 'core/str'; import {prefetchStrings} from 'core/prefetch'; /** * Selectors. * * @type {Object} */ const selectors = { weightOverrideCheckbox: 'input[type="checkbox"][name^="weightoverride_"]', weightOverrideInput: 'input[type="text"][name^="weight_"]', aggregationForCategory: category => `[data-aggregationforcategory='${category}']`, childrenByCategory: category => `tr[data-parent-category="${category}"]`, categoryByIdentifier: identifier => `tr.category[data-category="${identifier}"]`, }; /** * An object representing grading-related constants. * The same as what's defined in lib/grade/constants.php. * * @type {Object} * @property {Object} aggregation Aggregation settings. * @property {number} aggregation.sum Aggregation method: sum. * @property {Object} type Grade type settings. * @property {number} type.none Grade type: none. * @property {number} type.value Grade type: value. * @property {number} type.scale Grade type: scale. */ const grade = { aggregation: { sum: 13, }, }; /** * The character used as the decimal separator for number formatting. * * @type {string} */ let decimalSeparator; /** * This setting indicates if we should use algorithm prior to MDL-49257 fix for calculating extra credit weights. * Even though the old algorithm has bugs in it, we need to preserve existing grades. * * @type {boolean} */ let oldExtraCreditCalculation; /** * Recalculates the natural weights for grade items within a given category. * * @param {HTMLElement} categoryElement The DOM element representing the category. */ // Suppress 'complexity' linting rule to keep this function as close to grade_category::auto_update_weights. // eslint-disable-next-line complexity const recalculateNaturalWeights = (categoryElement) => { const childElements = document.querySelectorAll(selectors.childrenByCategory(categoryElement.dataset.category)); // Calculate the sum of the grademax's of all the items within this category. let totalGradeMax = 0; // Out of 100, how much weight has been manually overridden by a user? let totalOverriddenWeight = 0; let totalOverriddenGradeMax = 0; // Has every assessment in this category been overridden? let automaticGradeItemsPresent = false; // Does the grade item require normalising? let requiresNormalising = false; // Is there an error in the weight calculations? let erroneous = false; // This array keeps track of the id and weight of every grade item that has been overridden. const overrideArray = {}; for (const childElement of childElements) { const weightInput = childElement.querySelector(selectors.weightOverrideInput); const weightCheckbox = childElement.querySelector(selectors.weightOverrideCheckbox); // There are cases where a grade item should be excluded from calculations: // - If the item's grade type is 'text' or 'none'. // - If the grade item is an outcome item and the settings are set to not aggregate outcome items. // - If the item's grade type is 'scale' and the settings are set to ignore scales in aggregations. // All these cases are already taken care of in the backend, and no 'weight' input element is rendered on the page // if a grade item should not have a weight. if (!weightInput) { continue; } const itemWeight = parseWeight(weightInput.value); const itemAggregationCoefficient = parseInt(childElement.dataset.aggregationcoef); const itemGradeMax = parseFloat(childElement.dataset.grademax); // Record the ID and the weight for this grade item. overrideArray[childElement.dataset.itemid] = { extraCredit: itemAggregationCoefficient, weight: itemWeight, weightOverride: weightCheckbox.checked, }; // If this item has had its weight overridden then set the flag to true, but // only if all previous items were also overridden. Note that extra credit items // are counted as overridden grade items. if (!weightCheckbox.checked && itemAggregationCoefficient === 0) { automaticGradeItemsPresent = true; } if (itemAggregationCoefficient > 0) { // An extra credit grade item doesn't contribute to totalOverriddenGradeMax. continue; } else if (weightCheckbox.checked && itemWeight <= 0) { // An overridden item that defines a weight of 0 does not contribute to totalOverriddenGradeMax. continue; } totalGradeMax += itemGradeMax; if (weightCheckbox.checked) { totalOverriddenWeight += itemWeight; totalOverriddenGradeMax += itemGradeMax; } } // Initialise this variable (used to keep track of the weight override total). let normaliseTotal = 0; // Keep a record of how much the override total is to see if it is above 100. If it is then we need to set the // other weights to zero and normalise the others. let overriddenTotal = 0; // Total up all the weights. for (const gradeItemDetail of Object.values(overrideArray)) { // Exclude grade items with extra credit or negative weights (which will be set to zero later). if (!gradeItemDetail.extraCredit && gradeItemDetail.weight > 0) { normaliseTotal += gradeItemDetail.weight; } // The overridden total includes items that are marked as overridden, not extra credit, and have a positive weight. if (gradeItemDetail.weightOverride && !gradeItemDetail.extraCredit && gradeItemDetail.weight > 0) { // Add overridden weights up to see if they are greater than 1. overriddenTotal += gradeItemDetail.weight; } } if (overriddenTotal > 100) { // Make sure that this category of weights gets normalised. requiresNormalising = true; // The normalised weights are only the overridden weights, so we just use the total of those. normaliseTotal = overriddenTotal; } const totalNonOverriddenGradeMax = totalGradeMax - totalOverriddenGradeMax; for (const childElement of childElements) { const weightInput = childElement.querySelector(selectors.weightOverrideInput); const weightCheckbox = childElement.querySelector(selectors.weightOverrideCheckbox); const itemAggregationCoefficient = parseInt(childElement.dataset.aggregationcoef); const itemGradeMax = parseFloat(childElement.dataset.grademax); if (!weightInput) { continue; } else if (!oldExtraCreditCalculation && itemAggregationCoefficient > 0 && weightCheckbox.checked) { // For an item with extra credit ignore other weights and overrides but do not change anything at all // if its weight was already overridden. continue; } // Remove any error messages and classes. weightInput.classList.remove('is-invalid'); const errorArea = weightInput.closest('td').querySelector('.invalid-feedback'); errorArea.textContent = ''; if (!oldExtraCreditCalculation && itemAggregationCoefficient > 0 && !weightCheckbox.checked) { // For an item with extra credit ignore other weights and overrides. weightInput.value = totalGradeMax ? formatFloat(itemGradeMax * 100 / totalGradeMax) : 0; } else if (!weightCheckbox.checked) { // Calculations with a grade maximum of zero will cause problems. Just set the weight to zero. if (totalOverriddenWeight >= 100 || totalNonOverriddenGradeMax === 0 || itemGradeMax === 0) { // There is no more weight to distribute. weightInput.value = formatFloat(0); } else { // Calculate this item's weight as a percentage of the non-overridden total grade maxes // then convert it to a proportion of the available non-overridden weight. weightInput.value = formatFloat((itemGradeMax / totalNonOverriddenGradeMax) * (100 - totalOverriddenWeight)); } } else if ((!automaticGradeItemsPresent && normaliseTotal !== 100) || requiresNormalising || overrideArray[childElement.dataset.itemid].weight < 0) { if (overrideArray[childElement.dataset.itemid].weight < 0) { weightInput.value = formatFloat(0); } // Zero is a special case. If the total is zero then we need to set the weight of the parent category to zero. if (normaliseTotal !== 0) { erroneous = true; const error = normaliseTotal > 100 ? 'erroroverweight' : 'errorunderweight'; // eslint-disable-next-line promise/always-return,promise/catch-or-return getString(error, 'core_grades').then((errorString) => { errorArea.textContent = errorString; }); weightInput.classList.add('is-invalid'); } } } if (!erroneous) { const categoryGradeMax = parseFloat(categoryElement.dataset.grademax); if (categoryGradeMax !== totalGradeMax) { // The category grade max is not the same as the total grade max, so we need to update the category grade max. categoryElement.dataset.grademax = totalGradeMax; const relatedCategoryAggregationRow = document.querySelector( selectors.aggregationForCategory(categoryElement.dataset.category) ); relatedCategoryAggregationRow.querySelector('.column-range').innerHTML = formatFloat(totalGradeMax, 2, 2); const parentCategory = document.querySelector(selectors.categoryByIdentifier(categoryElement.dataset.parentCategory)); if (parentCategory && (parseInt(parentCategory.dataset.aggregation) === grade.aggregation.sum)) { recalculateNaturalWeights(parentCategory); } } } }; /** * Formats a floating-point number as a string with the specified number of decimal places. * Unnecessary trailing zeros are removed up to the specified minimum number of decimal places. * * @param {number} number The float value to be formatted. * @param {number} [decimalPoints=3] The number of decimal places to use. * @param {number} [minDecimals=1] The minimum number of decimal places to use. * @returns {string} The formatted weight value with the specified decimal places. */ const formatFloat = (number, decimalPoints = 3, minDecimals = 1) => { return number.toFixed(decimalPoints) .replace(new RegExp(`0{0,${decimalPoints - minDecimals}}$`), '') .replace('.', decimalSeparator); }; /** * Parses a weight string and returns a normalized float value. * * @param {string} weightString The weight as a string, possibly with localized formatting. * @returns {number} The parsed weight as a float. If parsing fails, returns 0. */ const parseWeight = (weightString) => { const normalizedWeightString = weightString.replace(decimalSeparator, '.'); return isNaN(Number(normalizedWeightString)) ? 0 : parseFloat(normalizedWeightString || 0); }; /** * Initializes the weight management module with optional configuration. * * @param {string} decSep The character used as the decimal separator for number formatting. * @param {boolean} oldCalculation A flag indicating whether to use the old (pre MDL-49257) extra credit calculation. */ export const init = (decSep, oldCalculation) => { decimalSeparator = decSep; oldExtraCreditCalculation = oldCalculation; prefetchStrings('core_grades', ['erroroverweight', 'errorunderweight']); document.addEventListener('change', e => { // Update the weights of all grade items in the category when the weight of any grade item in the category is changed. if (e.target.matches(selectors.weightOverrideInput) || e.target.matches(selectors.weightOverrideCheckbox)) { // The following is named gradeItemRow, but it may also be a row that's representing a grade category. // It's ok because it serves as the categories associated grade item in our calculations. const gradeItemRow = e.target.closest('tr'); const categoryElement = document.querySelector(selectors.categoryByIdentifier(gradeItemRow.dataset.parentCategory)); // This is only required if we are using natural weights. if (parseInt(categoryElement.dataset.aggregation) === grade.aggregation.sum) { const weightElement = gradeItemRow.querySelector(selectors.weightOverrideInput); weightElement.value = formatFloat(Math.max(0, parseWeight(weightElement.value))); recalculateNaturalWeights(categoryElement); } } }); document.addEventListener('submit', e => { // If the form is being submitted, then we need to ensure that the weight input fields are all set to // a valid value. if (e.target.matches('#gradetreeform')) { const firstInvalidWeightInput = e.target.querySelector('input.is-invalid'); if (firstInvalidWeightInput) { const firstFocusableInvalidWeightInput = e.target.querySelector('input.is-invalid:enabled'); if (firstFocusableInvalidWeightInput) { firstFocusableInvalidWeightInput.focus(); } else { firstInvalidWeightInput.scrollIntoView({block: 'center'}); } e.preventDefault(); } } }); }; amd/build/gradebooksetup_forms.min.js 0000604 00000007336 15062070556 0013763 0 ustar 00 define("core_grades/gradebooksetup_forms",["exports","core_form/modalform","core/str","core/notification","core_form/changechecker"],(function(_exports,_modalform,_str,_notification,FormChangeChecker){function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}} /** * Prints the add item gradebook form * * @module core_grades * @copyright 2023 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU Public License */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.init=void 0,_modalform=_interopRequireDefault(_modalform),_notification=_interopRequireDefault(_notification),FormChangeChecker=function(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}newObj.default=obj,cache&&cache.set(obj,newObj);return newObj}(FormChangeChecker);const Selectors_advancedFormLink="a.showadvancedform";_exports.init=()=>{document.addEventListener("click",(event=>{const args={};let formClass=null,title=null,trigger=null;if(event.target.closest('[data-trigger="add-item-form"]')?(event.preventDefault(),trigger=event.target.closest('[data-trigger="add-item-form"]'),formClass="core_grades\\form\\add_item",title="-1"===trigger.getAttribute("data-itemid")?(0,_str.getString)("newitem","core_grades"):(0,_str.getString)("itemsedit","core_grades"),args.itemid=trigger.getAttribute("data-itemid")):event.target.closest('[data-trigger="add-category-form"]')?(event.preventDefault(),trigger=event.target.closest('[data-trigger="add-category-form"]'),formClass="core_grades\\form\\add_category",title="-1"===trigger.getAttribute("data-category")?(0,_str.getString)("newcategory","core_grades"):(0,_str.getString)("categoryedit","core_grades"),args.category=trigger.getAttribute("data-category")):event.target.closest('[data-trigger="add-outcome-form"]')&&(event.preventDefault(),trigger=event.target.closest('[data-trigger="add-outcome-form"]'),formClass="core_grades\\form\\add_outcome",title="-1"===trigger.getAttribute("data-itemid")?(0,_str.getString)("newoutcomeitem","core_grades"):(0,_str.getString)("outcomeitemsedit","core_grades"),args.itemid=trigger.getAttribute("data-itemid")),trigger){args.courseid=trigger.getAttribute("data-courseid"),args.gpr_plugin=trigger.getAttribute("data-gprplugin");const modalForm=new _modalform.default({modalConfig:{title:title},formClass:formClass,args:args,saveButtonText:(0,_str.getString)("save","core"),returnFocus:trigger});modalForm.addEventListener(modalForm.events.FORM_SUBMITTED,(event=>{event.detail.result?window.location.assign(event.detail.url):_notification.default.addNotification({type:"error",message:(0,_str.getString)("saving_failed","core_grades")})})),modalForm.show()}const showAdvancedForm=event.target.closest(Selectors_advancedFormLink);if(showAdvancedForm){event.preventDefault();const form=event.target.closest("form");form.action=showAdvancedForm.href,FormChangeChecker.disableAllChecks(),form.submit()}}))}})); //# sourceMappingURL=gradebooksetup_forms.min.js.map amd/build/comboboxsearch/grade.min.js 0000604 00000011213 15062070556 0013604 0 ustar 00 define("core_grades/comboboxsearch/grade",["exports","core/comboboxsearch/search_combobox","core_grades/searchwidget/repository","core/templates","core/utils"],(function(_exports,_search_combobox,Repository,_templates,_utils){var obj;function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.default=void 0,_search_combobox=(obj=_search_combobox)&&obj.__esModule?obj:{default:obj},Repository=function(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}newObj.default=obj,cache&&cache.set(obj,newObj);return newObj}(Repository);class GradeItemSearch extends _search_combobox.default{constructor(){super(),function(obj,key,value){key in obj?Object.defineProperty(obj,key,{value:value,enumerable:!0,configurable:!0,writable:!0}):obj[key]=value}(this,"courseID",void 0),this.selectors={...this.selectors,courseid:'[data-region="courseid"]',placeholder:'.gradesearchdropdown [data-region="searchplaceholder"]'};const component=document.querySelector(this.componentSelector());this.courseID=component.querySelector(this.selectors.courseid).dataset.courseid,this.renderDefault()}static init(){return new GradeItemSearch}componentSelector(){return".grade-search"}dropdownSelector(){return".gradesearchdropdown"}triggerSelector(){return".gradesearchwidget"}async renderDropdown(){const{html:html,js:js}=await(0,_templates.renderForPromise)("core/local/comboboxsearch/resultset",{results:this.getMatchedResults(),hasresults:this.getMatchedResults().length>0,searchterm:this.getSearchTerm()});(0,_templates.replaceNodeContents)(this.selectors.placeholder,html,js)}async renderDefault(){this.setMatchedResults(await this.filterDataset(await this.getDataset())),this.filterMatchDataset(),await this.renderDropdown(),this.updateNodes(),this.registerInputEvents(),this.$component.on("shown.bs.dropdown",(()=>{this.searchInput.focus({preventScroll:!0})}))}async fetchDataset(){return await Repository.gradeitemFetch(this.courseID).then((r=>r.gradeitems))}async filterDataset(filterableData){return""===this.getPreppedSearchTerm()?filterableData:filterableData.filter((grade=>Object.keys(grade).some((key=>""!==grade[key]&&grade[key].toString().toLowerCase().includes(this.getPreppedSearchTerm())))))}filterMatchDataset(){this.setMatchedResults(this.getMatchedResults().map((grade=>({id:grade.id,name:grade.name,link:this.selectOneLink(grade.id)}))))}registerInputEvents(){this.searchInput.addEventListener("input",(0,_utils.debounce)((async()=>{this.setSearchTerms(this.searchInput.value),""===this.searchInput.value?this.clearSearchButton.classList.add("d-none"):this.clearSearchButton.classList.remove("d-none"),await this.filterrenderpipe()}),300))}async clickHandler(e){e.target.closest(this.selectors.dropdown)&&e.stopImmediatePropagation(),this.clearSearchButton.addEventListener("click",(async()=>{this.searchInput.value="",this.setSearchTerms(this.searchInput.value),await this.filterrenderpipe()})),e.target.closest(".dropdown-item")&&0===e.button&&(window.location=e.target.closest(".dropdown-item").href)}keyHandler(e){switch(super.keyHandler(e),e.key){case"Tab":e.target.closest(this.selectors.input)&&(e.preventDefault(),this.clearSearchButton.focus({preventScroll:!0}));break;case"Escape":if("option"===document.activeElement.getAttribute("role"))e.stopPropagation(),this.searchInput.focus({preventScroll:!0});else if(e.target.closest(this.selectors.input)){this.component.querySelector(this.selectors.trigger).focus({preventScroll:!0})}}}registerInputHandlers(){this.searchInput.addEventListener("input",(0,_utils.debounce)((()=>{this.setSearchTerms(this.searchInput.value),""===this.getSearchTerm()?this.clearSearchButton.classList.add("d-none"):this.clearSearchButton.classList.remove("d-none")}),300))}selectOneLink(gradeID){throw new Error("selectOneLink(".concat(gradeID,") must be implemented in ").concat(this.constructor.name))}}return _exports.default=GradeItemSearch,_exports.default})); //# sourceMappingURL=grade.min.js.map amd/build/comboboxsearch/grade.min.js.map 0000604 00000026601 15062070556 0014367 0 ustar 00 {"version":3,"file":"grade.min.js","sources":["../../src/comboboxsearch/grade.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Allow the user to search for grades within the grade area.\n *\n * @module core_grades/comboboxsearch/grade\n * @copyright 2023 Mathew May <mathew.solutions>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\nimport search_combobox from 'core/comboboxsearch/search_combobox';\nimport * as Repository from 'core_grades/searchwidget/repository';\nimport {renderForPromise, replaceNodeContents} from 'core/templates';\nimport {debounce} from 'core/utils';\n\nexport default class GradeItemSearch extends search_combobox {\n\n courseID;\n\n constructor() {\n super();\n\n // Define our standard lookups.\n this.selectors = {\n ...this.selectors,\n courseid: '[data-region=\"courseid\"]',\n placeholder: '.gradesearchdropdown [data-region=\"searchplaceholder\"]',\n };\n const component = document.querySelector(this.componentSelector());\n this.courseID = component.querySelector(this.selectors.courseid).dataset.courseid;\n\n this.renderDefault();\n }\n\n static init() {\n return new GradeItemSearch();\n }\n\n /**\n * The overall div that contains the searching widget.\n *\n * @returns {string}\n */\n componentSelector() {\n return '.grade-search';\n }\n\n /**\n * The dropdown div that contains the searching widget result space.\n *\n * @returns {string}\n */\n dropdownSelector() {\n return '.gradesearchdropdown';\n }\n\n /**\n * The triggering div that contains the searching widget.\n *\n * @returns {string}\n */\n triggerSelector() {\n return '.gradesearchwidget';\n }\n\n /**\n * Build the content then replace the node.\n */\n async renderDropdown() {\n const {html, js} = await renderForPromise('core/local/comboboxsearch/resultset', {\n results: this.getMatchedResults(),\n hasresults: this.getMatchedResults().length > 0,\n searchterm: this.getSearchTerm(),\n });\n replaceNodeContents(this.selectors.placeholder, html, js);\n }\n\n /**\n * Build the content then replace the node by default we want our form to exist.\n */\n async renderDefault() {\n this.setMatchedResults(await this.filterDataset(await this.getDataset()));\n this.filterMatchDataset();\n\n await this.renderDropdown();\n\n this.updateNodes();\n this.registerInputEvents();\n\n // Add a small BS listener so that we can set the focus correctly on open.\n this.$component.on('shown.bs.dropdown', () => {\n this.searchInput.focus({preventScroll: true});\n });\n }\n\n /**\n * Get the data we will be searching against in this component.\n *\n * @returns {Promise<*>}\n */\n async fetchDataset() {\n return await Repository.gradeitemFetch(this.courseID).then((r) => r.gradeitems);\n }\n\n /**\n * Dictate to the search component how and what we want to match upon.\n *\n * @param {Array} filterableData\n * @returns {Array} The users that match the given criteria.\n */\n async filterDataset(filterableData) {\n // Sometimes we just want to show everything.\n if (this.getPreppedSearchTerm() === '') {\n return filterableData;\n }\n return filterableData.filter((grade) => Object.keys(grade).some((key) => {\n if (grade[key] === \"\") {\n return false;\n }\n return grade[key].toString().toLowerCase().includes(this.getPreppedSearchTerm());\n }));\n }\n\n /**\n * Given we have a subset of the dataset, set the field that we matched upon to inform the end user.\n */\n filterMatchDataset() {\n this.setMatchedResults(\n this.getMatchedResults().map((grade) => {\n return {\n id: grade.id,\n name: grade.name,\n link: this.selectOneLink(grade.id),\n };\n })\n );\n }\n\n /**\n * Handle any keyboard inputs.\n */\n registerInputEvents() {\n // Register & handle the text input.\n this.searchInput.addEventListener('input', debounce(async() => {\n this.setSearchTerms(this.searchInput.value);\n // We can also require a set amount of input before search.\n if (this.searchInput.value === '') {\n // Hide the \"clear\" search button in the search bar.\n this.clearSearchButton.classList.add('d-none');\n } else {\n // Display the \"clear\" search button in the search bar.\n this.clearSearchButton.classList.remove('d-none');\n }\n // User has given something for us to filter against.\n await this.filterrenderpipe();\n }, 300));\n }\n\n /**\n * The handler for when a user interacts with the component.\n *\n * @param {MouseEvent} e The triggering event that we are working with.\n */\n async clickHandler(e) {\n if (e.target.closest(this.selectors.dropdown)) {\n // Forcibly prevent BS events so that we can control the open and close.\n // Really needed because by default input elements cant trigger a dropdown.\n e.stopImmediatePropagation();\n }\n this.clearSearchButton.addEventListener('click', async() => {\n this.searchInput.value = '';\n this.setSearchTerms(this.searchInput.value);\n await this.filterrenderpipe();\n });\n // Prevent normal key presses activating this.\n if (e.target.closest('.dropdown-item') && e.button === 0) {\n window.location = e.target.closest('.dropdown-item').href;\n }\n }\n\n /**\n * The handler for when a user presses a key within the component.\n *\n * @param {KeyboardEvent} e The triggering event that we are working with.\n */\n keyHandler(e) {\n super.keyHandler(e);\n // Switch the key presses to handle keyboard nav.\n switch (e.key) {\n case 'Tab':\n if (e.target.closest(this.selectors.input)) {\n e.preventDefault();\n this.clearSearchButton.focus({preventScroll: true});\n }\n break;\n case 'Escape':\n if (document.activeElement.getAttribute('role') === 'option') {\n e.stopPropagation();\n this.searchInput.focus({preventScroll: true});\n } else if (e.target.closest(this.selectors.input)) {\n const trigger = this.component.querySelector(this.selectors.trigger);\n trigger.focus({preventScroll: true});\n }\n }\n }\n\n /**\n * Override the input event listener for the text input area.\n */\n registerInputHandlers() {\n // Register & handle the text input.\n this.searchInput.addEventListener('input', debounce(() => {\n this.setSearchTerms(this.searchInput.value);\n // We can also require a set amount of input before search.\n if (this.getSearchTerm() === '') {\n // Hide the \"clear\" search button in the search bar.\n this.clearSearchButton.classList.add('d-none');\n } else {\n // Display the \"clear\" search button in the search bar.\n this.clearSearchButton.classList.remove('d-none');\n }\n }, 300));\n }\n\n /**\n * Build up the view all link that is dedicated to a particular result.\n *\n * @param {Number} gradeID The ID of the grade item selected.\n */\n selectOneLink(gradeID) {\n throw new Error(`selectOneLink(${gradeID}) must be implemented in ${this.constructor.name}`);\n }\n}\n"],"names":["GradeItemSearch","search_combobox","constructor","selectors","this","courseid","placeholder","component","document","querySelector","componentSelector","courseID","dataset","renderDefault","dropdownSelector","triggerSelector","html","js","results","getMatchedResults","hasresults","length","searchterm","getSearchTerm","setMatchedResults","filterDataset","getDataset","filterMatchDataset","renderDropdown","updateNodes","registerInputEvents","$component","on","searchInput","focus","preventScroll","Repository","gradeitemFetch","then","r","gradeitems","filterableData","getPreppedSearchTerm","filter","grade","Object","keys","some","key","toString","toLowerCase","includes","map","id","name","link","selectOneLink","addEventListener","async","setSearchTerms","value","clearSearchButton","classList","add","remove","filterrenderpipe","e","target","closest","dropdown","stopImmediatePropagation","button","window","location","href","keyHandler","input","preventDefault","activeElement","getAttribute","stopPropagation","trigger","registerInputHandlers","gradeID","Error"],"mappings":"i0CA2BqBA,wBAAwBC,yBAIzCC,6LAISC,UAAY,IACVC,KAAKD,UACRE,SAAU,2BACVC,YAAa,gEAEXC,UAAYC,SAASC,cAAcL,KAAKM,0BACzCC,SAAWJ,UAAUE,cAAcL,KAAKD,UAAUE,UAAUO,QAAQP,cAEpEQ,qCAIE,IAAIb,gBAQfU,0BACW,gBAQXI,yBACW,uBAQXC,wBACW,kDAODC,KAACA,KAADC,GAAOA,UAAY,+BAAiB,sCAAuC,CAC7EC,QAASd,KAAKe,oBACdC,WAAYhB,KAAKe,oBAAoBE,OAAS,EAC9CC,WAAYlB,KAAKmB,qDAEDnB,KAAKD,UAAUG,YAAaU,KAAMC,+BAOjDO,wBAAwBpB,KAAKqB,oBAAoBrB,KAAKsB,oBACtDC,2BAECvB,KAAKwB,sBAENC,mBACAC,2BAGAC,WAAWC,GAAG,qBAAqB,UAC/BC,YAAYC,MAAM,CAACC,eAAe,yCAU9BC,WAAWC,eAAejC,KAAKO,UAAU2B,MAAMC,GAAMA,EAAEC,iCASpDC,sBAEoB,KAAhCrC,KAAKsC,uBACED,eAEJA,eAAeE,QAAQC,OAAUC,OAAOC,KAAKF,OAAOG,MAAMC,KAC1C,KAAfJ,MAAMI,MAGHJ,MAAMI,KAAKC,WAAWC,cAAcC,SAAS/C,KAAKsC,4BAOjEf,0BACSH,kBACDpB,KAAKe,oBAAoBiC,KAAKR,QACnB,CACHS,GAAIT,MAAMS,GACVC,KAAMV,MAAMU,KACZC,KAAMnD,KAAKoD,cAAcZ,MAAMS,SAS/CvB,2BAESG,YAAYwB,iBAAiB,SAAS,oBAASC,eAC3CC,eAAevD,KAAK6B,YAAY2B,OAEN,KAA3BxD,KAAK6B,YAAY2B,WAEZC,kBAAkBC,UAAUC,IAAI,eAGhCF,kBAAkBC,UAAUE,OAAO,gBAGtC5D,KAAK6D,qBACZ,yBAQYC,GACXA,EAAEC,OAAOC,QAAQhE,KAAKD,UAAUkE,WAGhCH,EAAEI,gCAEDT,kBAAkBJ,iBAAiB,SAASC,eACxCzB,YAAY2B,MAAQ,QACpBD,eAAevD,KAAK6B,YAAY2B,aAC/BxD,KAAK6D,sBAGXC,EAAEC,OAAOC,QAAQ,mBAAkC,IAAbF,EAAEK,SACxCC,OAAOC,SAAWP,EAAEC,OAAOC,QAAQ,kBAAkBM,MAS7DC,WAAWT,gBACDS,WAAWT,GAETA,EAAElB,SACD,MACGkB,EAAEC,OAAOC,QAAQhE,KAAKD,UAAUyE,SAChCV,EAAEW,sBACGhB,kBAAkB3B,MAAM,CAACC,eAAe,eAGhD,YACmD,WAAhD3B,SAASsE,cAAcC,aAAa,QACpCb,EAAEc,uBACG/C,YAAYC,MAAM,CAACC,eAAe,SACpC,GAAI+B,EAAEC,OAAOC,QAAQhE,KAAKD,UAAUyE,OAAQ,CAC/BxE,KAAKG,UAAUE,cAAcL,KAAKD,UAAU8E,SACpD/C,MAAM,CAACC,eAAe,MAQ9C+C,6BAESjD,YAAYwB,iBAAiB,SAAS,oBAAS,UAC3CE,eAAevD,KAAK6B,YAAY2B,OAER,KAAzBxD,KAAKmB,qBAEAsC,kBAAkBC,UAAUC,IAAI,eAGhCF,kBAAkBC,UAAUE,OAAO,YAE7C,MAQPR,cAAc2B,eACJ,IAAIC,8BAAuBD,4CAAmC/E,KAAKF,YAAYoD"} amd/build/bulkactions/edit/tree/move.min.js.map 0000604 00000016674 15062070556 0015470 0 ustar 00 {"version":3,"file":"move.min.js","sources":["../../../../src/bulkactions/edit/tree/move.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Class that defines the bulk move action in the gradebook setup page.\n *\n * @module core_grades/bulkactions/edit/tree/move\n * @copyright 2023 Mihail Geshoski <mihail@moodle.com>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport BulkAction from 'core/bulkactions/bulk_action';\nimport {get_string as getString} from 'core/str';\nimport ModalSaveCancel from 'core/modal_save_cancel';\nimport Templates from 'core/templates';\nimport Ajax from 'core/ajax';\nimport ModalEvents from 'core/modal_events';\nimport MoveOptionsTree from 'core_grades/bulkactions/edit/tree/move_options_tree';\n\n/** @constant {Object} The object containing the relevant selectors. */\nconst Selectors = {\n editTreeForm: '#gradetreeform',\n bulkMoveInput: 'input[name=\"bulkmove\"]',\n bulkMoveAfterInput: 'input[name=\"moveafter\"]'\n};\n\nexport default class GradebookEditTreeBulkMove extends BulkAction {\n\n /** @property {int|null} courseId The course ID. */\n courseId = null;\n\n /** @property {MoveOptionsTree|null} moveOptionsTree The move options tree object. */\n moveOptionsTree = null;\n\n /** @property {string|null} gradeTree The grade tree structure. */\n gradeTree = null;\n\n /**\n * The class constructor.\n *\n * @param {int} courseId The course ID.\n * @returns {void}\n */\n constructor(courseId) {\n super();\n this.courseId = courseId;\n }\n\n /**\n * Defines the selector of the element that triggers the bulk move action.\n *\n * @returns {string} The bulk move action trigger selector.\n */\n getBulkActionTriggerSelector() {\n return 'button[data-action=\"move\"]';\n }\n\n /**\n * Defines the behavior once the bulk move action is triggered.\n *\n * @method executeBulkAction\n * @returns {void}\n */\n async triggerBulkAction() {\n const modal = await this.showModal();\n this.registerCustomListenerEvents(modal);\n }\n\n /**\n * Renders the bulk move action trigger element.\n *\n * @method renderBulkActionTrigger\n * @returns {Promise} The bulk move action trigger promise\n */\n async renderBulkActionTrigger() {\n return Templates.render('core_grades/bulkactions/edit/tree/bulk_move_trigger', {});\n }\n\n /**\n * Register custom event listeners.\n *\n * @method registerCustomClickListenerEvents\n * @param {Object} modal The modal object.\n * @returns {void}\n */\n async registerCustomListenerEvents(modal) {\n await modal.getBody();\n // Initialize the move options tree once the modal is shown.\n modal.getRoot().on(ModalEvents.shown, () => {\n this.moveOptionsTree = new MoveOptionsTree(() => {\n // Enable the 'Move' action button once something is selected.\n modal.setButtonDisabled('save', false);\n });\n });\n // Destroy the modal once it is hidden.\n modal.getRoot().on(ModalEvents.hidden, () => {\n modal.destroy();\n });\n // Define the move action event.\n modal.getRoot().on(ModalEvents.save, () => {\n // Make sure that a move option is selected.\n if (this.moveOptionsTree && this.moveOptionsTree.selectedMoveOption) {\n // Set the relevant form values.\n document.querySelector(Selectors.bulkMoveInput).value = 1;\n document.querySelector(Selectors.bulkMoveAfterInput).value = this.moveOptionsTree.selectedMoveOption.dataset.id;\n // Submit the form.\n document.querySelector(Selectors.editTreeForm).submit();\n }\n });\n }\n\n /**\n * Fetch the grade tree structure for the current course.\n *\n * @method fetchGradeTree\n * @returns {Promise} The grade tree promise\n */\n fetchGradeTree() {\n const request = {\n methodname: 'core_grades_get_grade_tree',\n args: {\n courseid: this.courseId,\n },\n };\n return Ajax.call([request])[0];\n }\n\n /**\n * Renders the bulk move modal body.\n *\n * @method renderModalBody\n * @returns {Promise} The modal body promise\n */\n async renderModalBody() {\n // We need to fetch the grade tree structure only once.\n if (this.gradeTree === null) {\n this.gradeTree = await this.fetchGradeTree();\n }\n\n return Templates.render('core_grades/bulkactions/edit/tree/bulk_move_grade_tree',\n JSON.parse(this.gradeTree));\n }\n\n /**\n * Show the bulk move modal.\n *\n * @method showModal\n * @returns {Promise} The modal promise\n */\n async showModal() {\n const modal = await ModalSaveCancel.create({\n title: await getString('movesitems', 'grades'),\n body: await this.renderModalBody(),\n buttons: {\n save: await getString('move')\n },\n large: true,\n });\n // Disable the 'Move' action button until something is selected.\n modal.setButtonDisabled('save', true);\n modal.show();\n\n return modal;\n }\n}\n"],"names":["Selectors","GradebookEditTreeBulkMove","BulkAction","constructor","courseId","getBulkActionTriggerSelector","modal","this","showModal","registerCustomListenerEvents","Templates","render","getBody","getRoot","on","ModalEvents","shown","moveOptionsTree","MoveOptionsTree","setButtonDisabled","hidden","destroy","save","selectedMoveOption","document","querySelector","value","dataset","id","submit","fetchGradeTree","request","methodname","args","courseid","Ajax","call","gradeTree","JSON","parse","ModalSaveCancel","create","title","body","renderModalBody","buttons","large","show"],"mappings":"i9BAgCMA,uBACY,iBADZA,wBAEa,yBAFbA,6BAGkB,gCAGHC,kCAAkCC,qBAiBnDC,YAAYC,kDAdD,6CAGO,uCAGN,WAUHA,SAAWA,SAQpBC,qCACW,6DAUDC,YAAcC,KAAKC,iBACpBC,6BAA6BH,8CAU3BI,mBAAUC,OAAO,sDAAuD,uCAUhDL,aACzBA,MAAMM,UAEZN,MAAMO,UAAUC,GAAGC,sBAAYC,OAAO,UAC7BC,gBAAkB,IAAIC,4BAAgB,KAEvCZ,MAAMa,kBAAkB,QAAQ,SAIxCb,MAAMO,UAAUC,GAAGC,sBAAYK,QAAQ,KACnCd,MAAMe,aAGVf,MAAMO,UAAUC,GAAGC,sBAAYO,MAAM,KAE7Bf,KAAKU,iBAAmBV,KAAKU,gBAAgBM,qBAE7CC,SAASC,cAAczB,yBAAyB0B,MAAQ,EACxDF,SAASC,cAAczB,8BAA8B0B,MAAQnB,KAAKU,gBAAgBM,mBAAmBI,QAAQC,GAE7GJ,SAASC,cAAczB,wBAAwB6B,aAW3DC,uBACUC,QAAU,CACZC,WAAY,6BACZC,KAAM,CACFC,SAAU3B,KAAKH,kBAGhB+B,cAAKC,KAAK,CAACL,UAAU,kCAWL,OAAnBxB,KAAK8B,iBACAA,gBAAkB9B,KAAKuB,kBAGzBpB,mBAAUC,OAAO,yDACpB2B,KAAKC,MAAMhC,KAAK8B,oCAUd/B,YAAckC,2BAAgBC,OAAO,CACvCC,YAAa,mBAAU,aAAc,UACrCC,WAAYpC,KAAKqC,kBACjBC,QAAS,CACLvB,WAAY,mBAAU,SAE1BwB,OAAO,WAGXxC,MAAMa,kBAAkB,QAAQ,GAChCb,MAAMyC,OAECzC"} amd/build/bulkactions/edit/tree/move_options_tree.min.js.map 0000604 00000011750 15062070556 0020250 0 ustar 00 {"version":3,"file":"move_options_tree.min.js","sources":["../../../../src/bulkactions/edit/tree/move_options_tree.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Keyboard navigation and aria-tree compatibility for the grade move options.\n *\n * @module core_grades/bulkactions/edit/tree/move_options_tree\n * @copyright 2023 Mihail Geshoski <mihail@moodle.com>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport Tree from 'core/tree';\nimport {getList} from 'core/normalise';\n\n/** @constant {Object} The object containing the relevant selectors. */\nconst Selectors = {\n moveOptionsTree: '#destination-selector [role=\"tree\"]',\n moveOption: '#destination-selector [role=\"treeitem\"]',\n toggleGroupLink: '#destination-selector .collapse-list-link',\n};\n\nexport default class MoveOptionsTree extends Tree {\n\n /** @property {function|null} afterSelectMoveOptionCallback Callback function to run after selecting a move option. */\n afterSelectMoveOptionCallback = null;\n\n /** @property {HTMLElement|null} selectedMoveOption The selected move option. */\n selectedMoveOption = null;\n\n /**\n * The class constructor.\n *\n * @param {function|null} afterSelectMoveOptionCallback Callback function used to define actions that should be run\n * after selecting a move option.\n * @returns {void}\n */\n constructor(afterSelectMoveOptionCallback) {\n super(Selectors.moveOptionsTree);\n this.afterSelectMoveOptionCallback = afterSelectMoveOptionCallback;\n }\n\n /**\n * Handle a key down event.\n *\n * @method handleKeyDown\n * @param {Event} e The event.\n */\n handleKeyDown(e) {\n // If the user presses enter or space, select the item.\n if (e.keyCode === this.keys.enter || e.keyCode === this.keys.space) {\n this.selectMoveOption(e.target);\n } else { // Otherwise, let the default behaviour happen.\n super.handleKeyDown(e);\n }\n }\n\n /**\n * Handle an item click.\n *\n * @param {Event} event The click event.\n * @param {jQuery} item The item clicked.\n * @returns {void}\n */\n handleItemClick(event, item) {\n const isToggleGroupLink = event.target.closest(Selectors.toggleGroupLink);\n // If the click is on the toggle group (chevron) link, let the default behaviour happen.\n if (isToggleGroupLink) {\n super.handleItemClick(event, item);\n return;\n }\n // If the click is on the item itself, select it.\n this.selectMoveOption(getList(item)[0]);\n }\n\n /**\n * Select a move option.\n *\n * @method selectMoveOption\n * @param {HTMLElement} moveOption The move option to select.\n */\n selectMoveOption(moveOption) {\n // Create the cache of the visible items.\n this.refreshVisibleItemsCache();\n // Deselect all the move options.\n document.querySelectorAll(Selectors.moveOption).forEach(item => {\n item.dataset.selected = \"false\";\n });\n // Select and set the focus on the specified move option.\n moveOption.dataset.selected = \"true\";\n this.selectedMoveOption = moveOption;\n moveOption.focus();\n // Call the callback function if it is defined.\n if (typeof this.afterSelectMoveOptionCallback === 'function') {\n this.afterSelectMoveOptionCallback();\n }\n }\n}\n"],"names":["Selectors","MoveOptionsTree","Tree","constructor","afterSelectMoveOptionCallback","handleKeyDown","e","keyCode","this","keys","enter","space","selectMoveOption","target","handleItemClick","event","item","closest","moveOption","refreshVisibleItemsCache","document","querySelectorAll","forEach","dataset","selected","selectedMoveOption","focus"],"mappings":"icA2BMA,0BACe,sCADfA,qBAEU,0CAFVA,0BAGe,kDAGAC,wBAAwBC,cAezCC,YAAYC,qCACFJ,gFAbsB,gDAGX,WAWZI,8BAAgCA,8BASzCC,cAAcC,GAENA,EAAEC,UAAYC,KAAKC,KAAKC,OAASJ,EAAEC,UAAYC,KAAKC,KAAKE,WACpDC,iBAAiBN,EAAEO,cAElBR,cAAcC,GAW5BQ,gBAAgBC,MAAOC,MACOD,MAAMF,OAAOI,QAAQjB,iCAGrCc,gBAAgBC,MAAOC,WAI5BJ,kBAAiB,sBAAQI,MAAM,IASxCJ,iBAAiBM,iBAERC,2BAELC,SAASC,iBAAiBrB,sBAAsBsB,SAAQN,OACpDA,KAAKO,QAAQC,SAAW,WAG5BN,WAAWK,QAAQC,SAAW,YACzBC,mBAAqBP,WAC1BA,WAAWQ,QAEuC,mBAAvClB,KAAKJ,oCACPA"} amd/build/bulkactions/edit/tree/bulk_actions.min.js.map 0000604 00000006763 15062070556 0017175 0 ustar 00 {"version":3,"file":"bulk_actions.min.js","sources":["../../../../src/bulkactions/edit/tree/bulk_actions.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\nimport BulkActions from \"core/bulkactions/bulk_actions\";\nimport GradebookEditTreeBulkMove from \"core_grades/bulkactions/edit/tree/move\";\n\n/**\n * Class for defining the bulk actions area in the gradebook setup page.\n *\n * @module core_grades/bulkactions/edit/tree/bulk_actions\n * @copyright 2023 Mihail Geshoski <mihail@moodle.com>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nconst Selectors = {\n selectBulkItemCheckbox: 'input[type=\"checkbox\"].itemselect'\n};\n\nexport default class GradebookEditTreeBulkActions extends BulkActions {\n\n /** @property {int|null} courseID The course ID. */\n courseID = null;\n\n /**\n * Returns the instance of the class.\n *\n * @param {int} courseID\n * @returns {GradebookEditTreeBulkActions}\n */\n static init(courseID) {\n return new this(courseID);\n }\n\n /**\n * The class constructor.\n *\n * @param {int} courseID The course ID.\n * @returns {void}\n */\n constructor(courseID) {\n super();\n this.courseID = courseID;\n }\n\n /**\n * Returns the array of the relevant bulk action objects for the gradebook setup page.\n *\n * @method getBulkActions\n * @returns {Array}\n */\n getBulkActions() {\n return [\n new GradebookEditTreeBulkMove(this.courseID)\n ];\n }\n\n /**\n * Returns the array of selected items.\n *\n * @method getSelectedItems\n * @returns {Array}\n */\n getSelectedItems() {\n return document.querySelectorAll(`${Selectors.selectBulkItemCheckbox}:checked`);\n }\n\n /**\n * Adds the listener for the item select change event.\n *\n * @method registerItemSelectChangeEvent\n * @param {function} eventHandler The event handler function.\n * @returns {void}\n */\n registerItemSelectChangeEvent(eventHandler) {\n const itemSelectCheckboxes = document.querySelectorAll(Selectors.selectBulkItemCheckbox);\n itemSelectCheckboxes.forEach((checkbox) => {\n checkbox.addEventListener('change', eventHandler.bind(this));\n });\n }\n}\n"],"names":["Selectors","GradebookEditTreeBulkActions","BulkActions","courseID","this","constructor","getBulkActions","GradebookEditTreeBulkMove","getSelectedItems","document","querySelectorAll","registerItemSelectChangeEvent","eventHandler","forEach","checkbox","addEventListener","bind"],"mappings":";;;;;;;;MA0BMA,iCACsB,0CAGPC,qCAAqCC,kCAW1CC,iBACD,IAAIC,KAAKD,UASpBE,YAAYF,0CAlBD,6IAoBFA,SAAWA,SASpBG,uBACW,CACH,IAAIC,cAA0BH,KAAKD,WAU3CK,0BACWC,SAASC,2BAAoBV,8CAUxCW,8BAA8BC,cACGH,SAASC,iBAAiBV,kCAClCa,SAASC,WAC1BA,SAASC,iBAAiB,SAAUH,aAAaI,KAAKZ"} amd/build/bulkactions/edit/tree/bulk_actions.min.js 0000604 00000003070 15062070556 0016405 0 ustar 00 define("core_grades/bulkactions/edit/tree/bulk_actions",["exports","core/bulkactions/bulk_actions","core_grades/bulkactions/edit/tree/move"],(function(_exports,_bulk_actions,_move){function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}}Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.default=void 0,_bulk_actions=_interopRequireDefault(_bulk_actions),_move=_interopRequireDefault(_move); /** * Class for defining the bulk actions area in the gradebook setup page. * * @module core_grades/bulkactions/edit/tree/bulk_actions * @copyright 2023 Mihail Geshoski <mihail@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ const Selectors_selectBulkItemCheckbox='input[type="checkbox"].itemselect';class GradebookEditTreeBulkActions extends _bulk_actions.default{static init(courseID){return new this(courseID)}constructor(courseID){var obj,key,value;super(),value=null,(key="courseID")in(obj=this)?Object.defineProperty(obj,key,{value:value,enumerable:!0,configurable:!0,writable:!0}):obj[key]=value,this.courseID=courseID}getBulkActions(){return[new _move.default(this.courseID)]}getSelectedItems(){return document.querySelectorAll("".concat(Selectors_selectBulkItemCheckbox,":checked"))}registerItemSelectChangeEvent(eventHandler){document.querySelectorAll(Selectors_selectBulkItemCheckbox).forEach((checkbox=>{checkbox.addEventListener("change",eventHandler.bind(this))}))}}return _exports.default=GradebookEditTreeBulkActions,_exports.default})); //# sourceMappingURL=bulk_actions.min.js.map amd/build/bulkactions/edit/tree/move_options_tree.min.js 0000604 00000003223 15062070556 0017470 0 ustar 00 define("core_grades/bulkactions/edit/tree/move_options_tree",["exports","core/tree","core/normalise"],(function(_exports,_tree,_normalise){var obj;function _defineProperty(obj,key,value){return key in obj?Object.defineProperty(obj,key,{value:value,enumerable:!0,configurable:!0,writable:!0}):obj[key]=value,obj}Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.default=void 0,_tree=(obj=_tree)&&obj.__esModule?obj:{default:obj};const Selectors_moveOptionsTree='#destination-selector [role="tree"]',Selectors_moveOption='#destination-selector [role="treeitem"]',Selectors_toggleGroupLink="#destination-selector .collapse-list-link";class MoveOptionsTree extends _tree.default{constructor(afterSelectMoveOptionCallback){super(Selectors_moveOptionsTree),_defineProperty(this,"afterSelectMoveOptionCallback",null),_defineProperty(this,"selectedMoveOption",null),this.afterSelectMoveOptionCallback=afterSelectMoveOptionCallback}handleKeyDown(e){e.keyCode===this.keys.enter||e.keyCode===this.keys.space?this.selectMoveOption(e.target):super.handleKeyDown(e)}handleItemClick(event,item){event.target.closest(Selectors_toggleGroupLink)?super.handleItemClick(event,item):this.selectMoveOption((0,_normalise.getList)(item)[0])}selectMoveOption(moveOption){this.refreshVisibleItemsCache(),document.querySelectorAll(Selectors_moveOption).forEach((item=>{item.dataset.selected="false"})),moveOption.dataset.selected="true",this.selectedMoveOption=moveOption,moveOption.focus(),"function"==typeof this.afterSelectMoveOptionCallback&&this.afterSelectMoveOptionCallback()}}return _exports.default=MoveOptionsTree,_exports.default})); //# sourceMappingURL=move_options_tree.min.js.map amd/build/bulkactions/edit/tree/move.min.js 0000604 00000005714 15062070556 0014705 0 ustar 00 define("core_grades/bulkactions/edit/tree/move",["exports","core/bulkactions/bulk_action","core/str","core/modal_save_cancel","core/templates","core/ajax","core/modal_events","core_grades/bulkactions/edit/tree/move_options_tree"],(function(_exports,_bulk_action,_str,_modal_save_cancel,_templates,_ajax,_modal_events,_move_options_tree){function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}}function _defineProperty(obj,key,value){return key in obj?Object.defineProperty(obj,key,{value:value,enumerable:!0,configurable:!0,writable:!0}):obj[key]=value,obj}Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.default=void 0,_bulk_action=_interopRequireDefault(_bulk_action),_modal_save_cancel=_interopRequireDefault(_modal_save_cancel),_templates=_interopRequireDefault(_templates),_ajax=_interopRequireDefault(_ajax),_modal_events=_interopRequireDefault(_modal_events),_move_options_tree=_interopRequireDefault(_move_options_tree);const Selectors_editTreeForm="#gradetreeform",Selectors_bulkMoveInput='input[name="bulkmove"]',Selectors_bulkMoveAfterInput='input[name="moveafter"]';class GradebookEditTreeBulkMove extends _bulk_action.default{constructor(courseId){super(),_defineProperty(this,"courseId",null),_defineProperty(this,"moveOptionsTree",null),_defineProperty(this,"gradeTree",null),this.courseId=courseId}getBulkActionTriggerSelector(){return'button[data-action="move"]'}async triggerBulkAction(){const modal=await this.showModal();this.registerCustomListenerEvents(modal)}async renderBulkActionTrigger(){return _templates.default.render("core_grades/bulkactions/edit/tree/bulk_move_trigger",{})}async registerCustomListenerEvents(modal){await modal.getBody(),modal.getRoot().on(_modal_events.default.shown,(()=>{this.moveOptionsTree=new _move_options_tree.default((()=>{modal.setButtonDisabled("save",!1)}))})),modal.getRoot().on(_modal_events.default.hidden,(()=>{modal.destroy()})),modal.getRoot().on(_modal_events.default.save,(()=>{this.moveOptionsTree&&this.moveOptionsTree.selectedMoveOption&&(document.querySelector(Selectors_bulkMoveInput).value=1,document.querySelector(Selectors_bulkMoveAfterInput).value=this.moveOptionsTree.selectedMoveOption.dataset.id,document.querySelector(Selectors_editTreeForm).submit())}))}fetchGradeTree(){const request={methodname:"core_grades_get_grade_tree",args:{courseid:this.courseId}};return _ajax.default.call([request])[0]}async renderModalBody(){return null===this.gradeTree&&(this.gradeTree=await this.fetchGradeTree()),_templates.default.render("core_grades/bulkactions/edit/tree/bulk_move_grade_tree",JSON.parse(this.gradeTree))}async showModal(){const modal=await _modal_save_cancel.default.create({title:await(0,_str.get_string)("movesitems","grades"),body:await this.renderModalBody(),buttons:{save:await(0,_str.get_string)("move")},large:!0});return modal.setButtonDisabled("save",!0),modal.show(),modal}}return _exports.default=GradebookEditTreeBulkMove,_exports.default})); //# sourceMappingURL=move.min.js.map amd/build/grades/grader/gradingpanel/point.min.js 0000604 00000002275 15062070556 0016031 0 ustar 00 define("core_grades/grades/grader/gradingpanel/point",["exports","./repository","core_grades/grades/grader/gradingpanel/comparison","jquery","./normalise"],(function(_exports,_repository,_comparison,_jquery,_normalise){var obj; /** * Grading panel for simple direct grading. * * @module core_grades/grades/grader/gradingpanel/point * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.storeCurrentGrade=_exports.fetchCurrentGrade=void 0,_jquery=(obj=_jquery)&&obj.__esModule?obj:{default:obj};_exports.fetchCurrentGrade=function(){return(0,_repository.fetchGrade)("point")(...arguments)};_exports.storeCurrentGrade=async(component,context,itemname,userId,notifyUser,rootNode)=>{const form=rootNode.querySelector("form"),grade=form.querySelector('input[name="grade"]');return grade.checkValidity()&&grade.value.trim()?!0===(0,_comparison.compareData)(form)?await(0,_repository.saveGrade)("point")(component,context,itemname,userId,notifyUser,(0,_jquery.default)(form).serialize()):"":_normalise.invalidResult}})); //# sourceMappingURL=point.min.js.map amd/build/grades/grader/gradingpanel/scale.min.js.map 0000604 00000004525 15062070556 0016543 0 ustar 00 {"version":3,"file":"scale.min.js","sources":["../../../../src/grades/grader/gradingpanel/scale.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Grading panel for simple direct grading.\n *\n * @module core_grades/grades/grader/gradingpanel/scale\n * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport {saveGrade, fetchGrade} from './repository';\nimport {compareData} from 'core_grades/grades/grader/gradingpanel/comparison';\n// Note: We use jQuery.serializer here until we can rewrite Ajax to use XHR.send()\nimport jQuery from 'jquery';\nimport {invalidResult} from './normalise';\n\nexport const fetchCurrentGrade = (...args) => fetchGrade('scale')(...args);\n\nexport const storeCurrentGrade = (component, context, itemname, userId, notifyUser, rootNode) => {\n const form = rootNode.querySelector('form');\n const grade = form.querySelector('select[name=\"grade\"]');\n\n if (!grade.checkValidity() || !grade.value.trim()) {\n return invalidResult;\n }\n\n if (compareData(form) === true) {\n return saveGrade('scale')(component, context, itemname, userId, notifyUser, jQuery(form).serialize());\n } else {\n return '';\n }\n};\n"],"names":["component","context","itemname","userId","notifyUser","rootNode","form","querySelector","grade","checkValidity","value","trim","serialize","invalidResult"],"mappings":";;;;;;;6MA6BiC,kBAAa,0BAAW,QAAX,2CAEb,CAACA,UAAWC,QAASC,SAAUC,OAAQC,WAAYC,kBAC1EC,KAAOD,SAASE,cAAc,QAC9BC,MAAQF,KAAKC,cAAc,+BAE5BC,MAAMC,iBAAoBD,MAAME,MAAMC,QAIjB,KAAtB,2BAAYL,OACL,yBAAU,QAAV,CAAmBN,UAAWC,QAASC,SAAUC,OAAQC,YAAY,mBAAOE,MAAMM,aAElF,GANAC"} amd/build/grades/grader/gradingpanel/repository.min.js.map 0000604 00000004544 15062070556 0017674 0 ustar 00 {"version":3,"file":"repository.min.js","sources":["../../../../src/grades/grader/gradingpanel/repository.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Repository for simple direct grading panel.\n *\n * @module core_grades/grades/grader/gradingpanel/repository\n * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\nimport {call as fetchMany} from 'core/ajax';\nimport {normaliseResult} from './normalise';\n\nexport const fetchGrade = type => (component, contextid, itemname, gradeduserid) => {\n return fetchMany([{\n methodname: `core_grades_grader_gradingpanel_${type}_fetch`,\n args: {\n component,\n contextid,\n itemname,\n gradeduserid,\n },\n }])[0];\n};\n\nexport const saveGrade = type => async(component, contextid, itemname, gradeduserid, notifyUser, formdata) => {\n return normaliseResult(await fetchMany([{\n methodname: `core_grades_grader_gradingpanel_${type}_store`,\n args: {\n component,\n contextid,\n itemname,\n gradeduserid,\n notifyuser: notifyUser,\n formdata,\n },\n }])[0]);\n};\n"],"names":["type","component","contextid","itemname","gradeduserid","methodname","args","async","notifyUser","formdata","notifyuser"],"mappings":"gQAyB0BA,MAAQ,CAACC,UAAWC,UAAWC,SAAUC,gBACxD,cAAU,CAAC,CACdC,qDAA+CL,eAC/CM,KAAM,CACFL,UAAAA,UACAC,UAAAA,UACAC,SAAAA,SACAC,aAAAA,iBAEJ,sBAGiBJ,MAAQO,MAAMN,UAAWC,UAAWC,SAAUC,aAAcI,WAAYC,YACtF,oCAAsB,cAAU,CAAC,CACpCJ,qDAA+CL,eAC/CM,KAAM,CACFL,UAAAA,UACAC,UAAAA,UACAC,SAAAA,SACAC,aAAAA,aACAM,WAAYF,WACZC,SAAAA,aAEJ"} amd/build/grades/grader/gradingpanel/scale.min.js 0000604 00000002264 15062070556 0015765 0 ustar 00 define("core_grades/grades/grader/gradingpanel/scale",["exports","./repository","core_grades/grades/grader/gradingpanel/comparison","jquery","./normalise"],(function(_exports,_repository,_comparison,_jquery,_normalise){var obj; /** * Grading panel for simple direct grading. * * @module core_grades/grades/grader/gradingpanel/scale * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.storeCurrentGrade=_exports.fetchCurrentGrade=void 0,_jquery=(obj=_jquery)&&obj.__esModule?obj:{default:obj};_exports.fetchCurrentGrade=function(){return(0,_repository.fetchGrade)("scale")(...arguments)};_exports.storeCurrentGrade=(component,context,itemname,userId,notifyUser,rootNode)=>{const form=rootNode.querySelector("form"),grade=form.querySelector('select[name="grade"]');return grade.checkValidity()&&grade.value.trim()?!0===(0,_comparison.compareData)(form)?(0,_repository.saveGrade)("scale")(component,context,itemname,userId,notifyUser,(0,_jquery.default)(form).serialize()):"":_normalise.invalidResult}})); //# sourceMappingURL=scale.min.js.map amd/build/grades/grader/gradingpanel/repository.min.js 0000604 00000001572 15062070556 0017116 0 ustar 00 define("core_grades/grades/grader/gradingpanel/repository",["exports","core/ajax","./normalise"],(function(_exports,_ajax,_normalise){Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.saveGrade=_exports.fetchGrade=void 0;_exports.fetchGrade=type=>(component,contextid,itemname,gradeduserid)=>(0,_ajax.call)([{methodname:"core_grades_grader_gradingpanel_".concat(type,"_fetch"),args:{component:component,contextid:contextid,itemname:itemname,gradeduserid:gradeduserid}}])[0];_exports.saveGrade=type=>async(component,contextid,itemname,gradeduserid,notifyUser,formdata)=>(0,_normalise.normaliseResult)(await(0,_ajax.call)([{methodname:"core_grades_grader_gradingpanel_".concat(type,"_store"),args:{component:component,contextid:contextid,itemname:itemname,gradeduserid:gradeduserid,notifyuser:notifyUser,formdata:formdata}}])[0])})); //# sourceMappingURL=repository.min.js.map amd/build/grades/grader/gradingpanel/normalise.min.js.map 0000604 00000004331 15062070556 0017440 0 ustar 00 {"version":3,"file":"normalise.min.js","sources":["../../../../src/grades/grader/gradingpanel/normalise.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Error handling and normalisation of provided data.\n *\n * @module core_grades/grades/grader/gradingpanel/normalise\n * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\n/**\n * Normalise a resultset for consumption by the grader.\n *\n * @param {Object} result The result returned from a grading web service\n * @return {Object}\n */\nexport const normaliseResult = result => {\n return {\n result,\n failed: !!result.warnings.length,\n success: !result.warnings.length,\n error: null,\n };\n};\n\n/**\n * Return the resultset used to describe an invalid result.\n *\n * @return {Object}\n */\nexport const invalidResult = () => {\n return {\n success: false,\n failed: false,\n result: {},\n error: null,\n };\n};\n\n/**\n * Return the resultset used to describe a failed update.\n *\n * @param {Object} error\n * @return {Object}\n */\nexport const failedUpdate = error => {\n return {\n success: false,\n failed: true,\n result: {},\n error,\n };\n};\n"],"names":["result","failed","warnings","length","success","error"],"mappings":"wPA6B+BA,SACpB,CACHA,OAAAA,OACAC,SAAUD,OAAOE,SAASC,OAC1BC,SAAUJ,OAAOE,SAASC,OAC1BE,MAAO,8BASc,KAClB,CACHD,SAAS,EACTH,QAAQ,EACRD,OAAQ,GACRK,MAAO,6BAUaA,QACjB,CACHD,SAAS,EACTH,QAAQ,EACRD,OAAQ,GACRK,MAAAA"} amd/build/grades/grader/gradingpanel/point.min.js.map 0000604 00000005554 15062070556 0016610 0 ustar 00 {"version":3,"file":"point.min.js","sources":["../../../../src/grades/grader/gradingpanel/point.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Grading panel for simple direct grading.\n *\n * @module core_grades/grades/grader/gradingpanel/point\n * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport {saveGrade, fetchGrade} from './repository';\nimport {compareData} from 'core_grades/grades/grader/gradingpanel/comparison';\n// Note: We use jQuery.serializer here until we can rewrite Ajax to use XHR.send()\nimport jQuery from 'jquery';\nimport {invalidResult} from './normalise';\n\n/**\n * Fetch the current grade for a user.\n *\n * @param {object} args\n * @param {String} args.component\n * @param {Number} args.context\n * @param {String} args.itemname\n * @param {Number} args.userId\n * @param {Element} args.rootNode\n * @returns {Object}\n */\nexport const fetchCurrentGrade = (...args) => fetchGrade('point')(...args);\n\n/**\n * Store a new grade for a user.\n *\n * @param {String} component\n * @param {Number} context\n * @param {String} itemname\n * @param {Number} userId\n * @param {Boolean} notifyUser\n * @param {Element} rootNode\n * @returns {Object}\n */\nexport const storeCurrentGrade = async(component, context, itemname, userId, notifyUser, rootNode) => {\n const form = rootNode.querySelector('form');\n const grade = form.querySelector('input[name=\"grade\"]');\n\n if (!grade.checkValidity() || !grade.value.trim()) {\n return invalidResult;\n }\n\n if (compareData(form) === true) {\n return await saveGrade('point')(component, context, itemname, userId, notifyUser, jQuery(form).serialize());\n } else {\n return '';\n }\n};\n"],"names":["async","component","context","itemname","userId","notifyUser","rootNode","form","querySelector","grade","checkValidity","value","trim","serialize","invalidResult"],"mappings":";;;;;;;6MAwCiC,kBAAa,0BAAW,QAAX,2CAabA,MAAMC,UAAWC,QAASC,SAAUC,OAAQC,WAAYC,kBAC/EC,KAAOD,SAASE,cAAc,QAC9BC,MAAQF,KAAKC,cAAc,8BAE5BC,MAAMC,iBAAoBD,MAAME,MAAMC,QAIjB,KAAtB,2BAAYL,YACC,yBAAU,QAAV,CAAmBN,UAAWC,QAASC,SAAUC,OAAQC,YAAY,mBAAOE,MAAMM,aAExF,GANAC"} amd/build/grades/grader/gradingpanel/comparison.min.js.map 0000604 00000010405 15062070556 0017620 0 ustar 00 {"version":3,"file":"comparison.min.js","sources":["../../../../src/grades/grader/gradingpanel/comparison.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Compare a given form's values and its previously set data attributes.\n *\n * @module core_grades/grades/grader/gradingpanel/comparison\n * @copyright 2019 Mathew May <mathew.solutions>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nexport const fillInitialValues = (form) => {\n Array.prototype.forEach.call(form.elements, (input) => {\n if (input.type === 'submit' || input.type === 'button') {\n return;\n } else if (input.type === 'radio' || input.type === 'checkbox') {\n input.dataset.initialValue = JSON.stringify(input.checked);\n } else if (typeof input.value !== 'undefined') {\n input.dataset.initialValue = JSON.stringify(input.value);\n } else if (input.type === 'select-one') {\n Array.prototype.forEach.call(input.options, (option) => {\n option.dataset.initialValue = JSON.stringify(option.selected);\n });\n }\n });\n};\n\n\n/**\n * Compare the form data with the initial form data from when the form was set up.\n *\n * If values have changed, return a truthy value.\n *\n * @param {HTMLElement} form\n * @return {Boolean}\n */\nexport const compareData = (form) => {\n const result = Array.prototype.some.call(form.elements, (input) => {\n if (input.type === 'submit' || input.type === 'button') {\n return false;\n } else if (input.type === 'radio' || input.type === 'checkbox') {\n if (typeof input.dataset.initialValue !== 'undefined') {\n return input.dataset.initialValue !== JSON.stringify(input.checked);\n }\n } else if (typeof input.value !== 'undefined') {\n if (typeof input.dataset.initialValue !== 'undefined') {\n return input.dataset.initialValue !== JSON.stringify(input.value);\n }\n } else if (input.type === 'select-one') {\n return Array.prototype.some.call(input.options, (option) => {\n if (typeof option.dataset.initialValue !== 'undefined') {\n return option.dataset.initialValue !== JSON.stringify(option.selected);\n }\n\n return false;\n });\n }\n\n // No value found to check. Assume that there were changes.\n return true;\n });\n\n // Fill the initial values again as the form may not be reloaded.\n fillInitialValues(form);\n\n return result;\n};\n"],"names":["fillInitialValues","form","Array","prototype","forEach","call","elements","input","type","dataset","initialValue","JSON","stringify","checked","value","options","option","selected","result","some"],"mappings":";;;;;;;;MAuBaA,kBAAqBC,OAC9BC,MAAMC,UAAUC,QAAQC,KAAKJ,KAAKK,UAAWC,QACtB,WAAfA,MAAMC,MAAoC,WAAfD,MAAMC,OAEX,UAAfD,MAAMC,MAAmC,aAAfD,MAAMC,KACvCD,MAAME,QAAQC,aAAeC,KAAKC,UAAUL,MAAMM,cACpB,IAAhBN,MAAMO,MACpBP,MAAME,QAAQC,aAAeC,KAAKC,UAAUL,MAAMO,OAC5B,eAAfP,MAAMC,MACbN,MAAMC,UAAUC,QAAQC,KAAKE,MAAMQ,SAAUC,SACzCA,OAAOP,QAAQC,aAAeC,KAAKC,UAAUI,OAAOC,oFAexChB,aAClBiB,OAAShB,MAAMC,UAAUgB,KAAKd,KAAKJ,KAAKK,UAAWC,WAClC,WAAfA,MAAMC,MAAoC,WAAfD,MAAMC,YAC1B,EACJ,GAAmB,UAAfD,MAAMC,MAAmC,aAAfD,MAAMC,cACG,IAA/BD,MAAME,QAAQC,oBACdH,MAAME,QAAQC,eAAiBC,KAAKC,UAAUL,MAAMM,cAE5D,QAA2B,IAAhBN,MAAMO,eACsB,IAA/BP,MAAME,QAAQC,oBACdH,MAAME,QAAQC,eAAiBC,KAAKC,UAAUL,MAAMO,YAE5D,GAAmB,eAAfP,MAAMC,YACNN,MAAMC,UAAUgB,KAAKd,KAAKE,MAAMQ,SAAUC,aACF,IAAhCA,OAAOP,QAAQC,cACfM,OAAOP,QAAQC,eAAiBC,KAAKC,UAAUI,OAAOC,mBAQlE,YAIXjB,kBAAkBC,MAEXiB"} amd/build/grades/grader/gradingpanel/normalise.min.js 0000604 00000001040 15062070556 0016656 0 ustar 00 define("core_grades/grades/grader/gradingpanel/normalise",["exports"],(function(_exports){Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.normaliseResult=_exports.invalidResult=_exports.failedUpdate=void 0;_exports.normaliseResult=result=>({result:result,failed:!!result.warnings.length,success:!result.warnings.length,error:null});_exports.invalidResult=()=>({success:!1,failed:!1,result:{},error:null});_exports.failedUpdate=error=>({success:!1,failed:!0,result:{},error:error})})); //# sourceMappingURL=normalise.min.js.map amd/build/grades/grader/gradingpanel/comparison.min.js 0000604 00000003261 15062070556 0017046 0 ustar 00 define("core_grades/grades/grader/gradingpanel/comparison",["exports"],(function(_exports){Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.fillInitialValues=_exports.compareData=void 0; /** * Compare a given form's values and its previously set data attributes. * * @module core_grades/grades/grader/gradingpanel/comparison * @copyright 2019 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ const fillInitialValues=form=>{Array.prototype.forEach.call(form.elements,(input=>{"submit"!==input.type&&"button"!==input.type&&("radio"===input.type||"checkbox"===input.type?input.dataset.initialValue=JSON.stringify(input.checked):void 0!==input.value?input.dataset.initialValue=JSON.stringify(input.value):"select-one"===input.type&&Array.prototype.forEach.call(input.options,(option=>{option.dataset.initialValue=JSON.stringify(option.selected)})))}))};_exports.fillInitialValues=fillInitialValues;_exports.compareData=form=>{const result=Array.prototype.some.call(form.elements,(input=>{if("submit"===input.type||"button"===input.type)return!1;if("radio"===input.type||"checkbox"===input.type){if(void 0!==input.dataset.initialValue)return input.dataset.initialValue!==JSON.stringify(input.checked)}else if(void 0!==input.value){if(void 0!==input.dataset.initialValue)return input.dataset.initialValue!==JSON.stringify(input.value)}else if("select-one"===input.type)return Array.prototype.some.call(input.options,(option=>void 0!==option.dataset.initialValue&&option.dataset.initialValue!==JSON.stringify(option.selected)));return!0}));return fillInitialValues(form),result}})); //# sourceMappingURL=comparison.min.js.map amd/build/edittree_weights.min.js 0000604 00000014245 15062070556 0013073 0 ustar 00 define("core_grades/edittree_weights",["exports","core/str","core/prefetch"],(function(_exports,_str,_prefetch){Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.init=void 0; /** * This module provides functionality for managing weight calculations and adjustments for grade items. * * @module core_grades/edittree_weight * @copyright 2023 Shamim Rezaie <shamim@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ const selectors_weightOverrideCheckbox='input[type="checkbox"][name^="weightoverride_"]',selectors_weightOverrideInput='input[type="text"][name^="weight_"]',selectors_aggregationForCategory=category=>"[data-aggregationforcategory='".concat(category,"']"),selectors_childrenByCategory=category=>'tr[data-parent-category="'.concat(category,'"]'),selectors_categoryByIdentifier=identifier=>'tr.category[data-category="'.concat(identifier,'"]'),grade_aggregation={sum:13};let decimalSeparator,oldExtraCreditCalculation;const recalculateNaturalWeights=categoryElement=>{const childElements=document.querySelectorAll(selectors_childrenByCategory(categoryElement.dataset.category));let totalGradeMax=0,totalOverriddenWeight=0,totalOverriddenGradeMax=0,automaticGradeItemsPresent=!1,requiresNormalising=!1,erroneous=!1;const overrideArray={};for(const childElement of childElements){const weightInput=childElement.querySelector(selectors_weightOverrideInput),weightCheckbox=childElement.querySelector(selectors_weightOverrideCheckbox);if(!weightInput)continue;const itemWeight=parseWeight(weightInput.value),itemAggregationCoefficient=parseInt(childElement.dataset.aggregationcoef),itemGradeMax=parseFloat(childElement.dataset.grademax);overrideArray[childElement.dataset.itemid]={extraCredit:itemAggregationCoefficient,weight:itemWeight,weightOverride:weightCheckbox.checked},weightCheckbox.checked||0!==itemAggregationCoefficient||(automaticGradeItemsPresent=!0),itemAggregationCoefficient>0||(weightCheckbox.checked&&itemWeight<=0||(totalGradeMax+=itemGradeMax,weightCheckbox.checked&&(totalOverriddenWeight+=itemWeight,totalOverriddenGradeMax+=itemGradeMax)))}let normaliseTotal=0,overriddenTotal=0;for(const gradeItemDetail of Object.values(overrideArray))!gradeItemDetail.extraCredit&&gradeItemDetail.weight>0&&(normaliseTotal+=gradeItemDetail.weight),gradeItemDetail.weightOverride&&!gradeItemDetail.extraCredit&&gradeItemDetail.weight>0&&(overriddenTotal+=gradeItemDetail.weight);overriddenTotal>100&&(requiresNormalising=!0,normaliseTotal=overriddenTotal);const totalNonOverriddenGradeMax=totalGradeMax-totalOverriddenGradeMax;for(const childElement of childElements){const weightInput=childElement.querySelector(selectors_weightOverrideInput),weightCheckbox=childElement.querySelector(selectors_weightOverrideCheckbox),itemAggregationCoefficient=parseInt(childElement.dataset.aggregationcoef),itemGradeMax=parseFloat(childElement.dataset.grademax);if(!weightInput)continue;if(!oldExtraCreditCalculation&&itemAggregationCoefficient>0&&weightCheckbox.checked)continue;weightInput.classList.remove("is-invalid");const errorArea=weightInput.closest("td").querySelector(".invalid-feedback");if(errorArea.textContent="",!oldExtraCreditCalculation&&itemAggregationCoefficient>0&&!weightCheckbox.checked)weightInput.value=totalGradeMax?formatFloat(100*itemGradeMax/totalGradeMax):0;else if(weightCheckbox.checked){if((!automaticGradeItemsPresent&&100!==normaliseTotal||requiresNormalising||overrideArray[childElement.dataset.itemid].weight<0)&&(overrideArray[childElement.dataset.itemid].weight<0&&(weightInput.value=formatFloat(0)),0!==normaliseTotal)){erroneous=!0;const error=normaliseTotal>100?"erroroverweight":"errorunderweight";(0,_str.getString)(error,"core_grades").then((errorString=>{errorArea.textContent=errorString})),weightInput.classList.add("is-invalid")}}else weightInput.value=formatFloat(totalOverriddenWeight>=100||0===totalNonOverriddenGradeMax||0===itemGradeMax?0:itemGradeMax/totalNonOverriddenGradeMax*(100-totalOverriddenWeight))}if(!erroneous){if(parseFloat(categoryElement.dataset.grademax)!==totalGradeMax){categoryElement.dataset.grademax=totalGradeMax;document.querySelector(selectors_aggregationForCategory(categoryElement.dataset.category)).querySelector(".column-range").innerHTML=formatFloat(totalGradeMax,2,2);const parentCategory=document.querySelector(selectors_categoryByIdentifier(categoryElement.dataset.parentCategory));parentCategory&&parseInt(parentCategory.dataset.aggregation)===grade_aggregation.sum&&recalculateNaturalWeights(parentCategory)}}},formatFloat=function(number){let decimalPoints=arguments.length>1&&void 0!==arguments[1]?arguments[1]:3,minDecimals=arguments.length>2&&void 0!==arguments[2]?arguments[2]:1;return number.toFixed(decimalPoints).replace(new RegExp("0{0,".concat(decimalPoints-minDecimals,"}$")),"").replace(".",decimalSeparator)},parseWeight=weightString=>{const normalizedWeightString=weightString.replace(decimalSeparator,".");return isNaN(Number(normalizedWeightString))?0:parseFloat(normalizedWeightString||0)};_exports.init=(decSep,oldCalculation)=>{decimalSeparator=decSep,oldExtraCreditCalculation=oldCalculation,(0,_prefetch.prefetchStrings)("core_grades",["erroroverweight","errorunderweight"]),document.addEventListener("change",(e=>{if(e.target.matches(selectors_weightOverrideInput)||e.target.matches(selectors_weightOverrideCheckbox)){const gradeItemRow=e.target.closest("tr"),categoryElement=document.querySelector(selectors_categoryByIdentifier(gradeItemRow.dataset.parentCategory));if(parseInt(categoryElement.dataset.aggregation)===grade_aggregation.sum){const weightElement=gradeItemRow.querySelector(selectors_weightOverrideInput);weightElement.value=formatFloat(Math.max(0,parseWeight(weightElement.value))),recalculateNaturalWeights(categoryElement)}}})),document.addEventListener("submit",(e=>{if(e.target.matches("#gradetreeform")){const firstInvalidWeightInput=e.target.querySelector("input.is-invalid");if(firstInvalidWeightInput){const firstFocusableInvalidWeightInput=e.target.querySelector("input.is-invalid:enabled");firstFocusableInvalidWeightInput?firstFocusableInvalidWeightInput.focus():firstInvalidWeightInput.scrollIntoView({block:"center"}),e.preventDefault()}}}))}})); //# sourceMappingURL=edittree_weights.min.js.map amd/build/edittree_index.min.js 0000604 00000012350 15062070556 0012523 0 ustar 00 define("core_grades/edittree_index",["exports","core/localstorage","core/loadingicon","core/notification","core/pending"],(function(_exports,_localstorage,_loadingicon,_notification,_pending){function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}} /** * Enhance the gradebook tree setup with various facilities. * * @module core_grades/edittree_index * @copyright 2016 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.init=void 0,_localstorage=_interopRequireDefault(_localstorage),_notification=_interopRequireDefault(_notification),_pending=_interopRequireDefault(_pending);const SELECTORS_CATEGORY_TOGGLE=".toggle-category",SELECTORS_GRADEBOOK_SETUP_TABLE=".setup-grades",SELECTORS_WEIGHT_OVERRIDE_CHECKBOX=".weightoverride",SELECTORS_BULK_MOVE_SELECT="#menumoveafter",SELECTORS_BULK_MOVE_INPUT="#bulkmoveinput",SELECTORS_GRADEBOOK_SETUP_WRAPPER=".gradetree-wrapper",SELECTORS_GRADEBOOK_SETUP_BOX=".gradetreebox",toggleWeightInput=weightOverrideCheckbox=>{const row=weightOverrideCheckbox.closest("tr"),itemId=row.dataset.itemid;row.querySelector('input[name="weight_'.concat(itemId,'"]')).disabled=!weightOverrideCheckbox.checked},submitBulkMoveForm=bulkMoveSelect=>{const form=bulkMoveSelect.closest("form");form.querySelector(SELECTORS_BULK_MOVE_INPUT).value=1,form.submit()},toggleCategory=(toggleElement,courseId,userId,storeCollapsedState)=>{const target=toggleElement.dataset.target,category=toggleElement.dataset.category,isCollapsing="true"===toggleElement.getAttribute("aria-expanded"),gradebookSetup=toggleElement.closest(SELECTORS_GRADEBOOK_SETUP_TABLE),targetRows=gradebookSetup.querySelectorAll(target),maxGradeCell=toggleElement.closest("tr").querySelector(".column-range");if(isCollapsing){if(toggleElement.setAttribute("aria-expanded","false"),toggleElement.dataset.target="[data-hidden-by='".concat(category,"']"),maxGradeCell){const relatedCategoryAggregationRow=gradebookSetup.querySelector("[data-aggregationforcategory='".concat(category,"']"));maxGradeCell.innerHTML=relatedCategoryAggregationRow.querySelector(".column-range").innerHTML}}else toggleElement.setAttribute("aria-expanded","true"),toggleElement.dataset.target=".".concat(category,"[data-hidden='false']"),maxGradeCell&&(maxGradeCell.innerHTML="");storeCollapsedState&&((category,courseId,userId,isCollapsing)=>{const currentStoredCollapsedCategories=_localstorage.default.get("core_grade_collapsedgradecategories_".concat(courseId,"_").concat(userId));let collapsedCategories=currentStoredCollapsedCategories?JSON.parse(currentStoredCollapsedCategories):[];isCollapsing?collapsedCategories.push(category):collapsedCategories=collapsedCategories.filter((cat=>cat!==category)),_localstorage.default.set("core_grade_collapsedgradecategories_".concat(courseId,"_").concat(userId),JSON.stringify(collapsedCategories))})(category,courseId,userId,isCollapsing),targetRows.forEach((row=>{isCollapsing?(row.dataset.hidden="true",row.dataset.hiddenBy=category):(row.dataset.hidden="false",row.dataset.hiddenBy="")})),updateParentCategoryRowspans(toggleElement,targetRows.length)},updateParentCategoryRowspans=(toggleElement,num)=>{const gradebookSetup=toggleElement.closest(SELECTORS_GRADEBOOK_SETUP_TABLE);toggleElement.closest("tr").classList.forEach((className=>{const parentCategoryToggleElement=gradebookSetup.querySelector('[data-target=".'.concat(className,"[data-hidden='false']\""));if(parentCategoryToggleElement){const categoryRowSpanElement=parentCategoryToggleElement.closest("tr").nextElementSibling.querySelector("[rowspan]");"true"===toggleElement.getAttribute("aria-expanded")?categoryRowSpanElement.rowSpan=categoryRowSpanElement.rowSpan+num:categoryRowSpanElement.rowSpan=categoryRowSpanElement.rowSpan-num}}))};_exports.init=(courseId,userId)=>{const pendingPromise=new _pending.default,gradebookSetupBox=document.querySelector(SELECTORS_GRADEBOOK_SETUP_BOX);(0,_loadingicon.addIconToContainer)(gradebookSetupBox).then((loader=>{setTimeout((()=>{((courseId,userId)=>{const gradebookSetup=document.querySelector(SELECTORS_GRADEBOOK_SETUP_TABLE),storedCollapsedCategories=_localstorage.default.get("core_grade_collapsedgradecategories_".concat(courseId,"_").concat(userId));storedCollapsedCategories&&JSON.parse(storedCollapsedCategories).forEach((category=>{const categoryToggleElement=gradebookSetup.querySelector("".concat(SELECTORS_CATEGORY_TOGGLE,'[data-category="').concat(category,'"'));categoryToggleElement&&toggleCategory(categoryToggleElement,courseId,userId,!1)}))})(courseId,userId),loader.remove(),document.querySelector(SELECTORS_GRADEBOOK_SETUP_WRAPPER).classList.remove("d-none"),pendingPromise.resolve()}),150)})).fail(_notification.default.exception),((courseId,userId)=>{document.addEventListener("change",(e=>{e.target.matches(SELECTORS_WEIGHT_OVERRIDE_CHECKBOX)&&toggleWeightInput(e.target),e.target.matches(SELECTORS_BULK_MOVE_SELECT)&&submitBulkMoveForm(e.target)})),document.querySelector(SELECTORS_GRADEBOOK_SETUP_TABLE).addEventListener("click",(e=>{const toggle=e.target.closest(SELECTORS_CATEGORY_TOGGLE);toggle&&(e.preventDefault(),toggleCategory(toggle,courseId,userId,!0))}))})(courseId,userId)}})); //# sourceMappingURL=edittree_index.min.js.map amd/build/gradebooksetup_forms.min.js.map 0000604 00000014240 15062070556 0014527 0 ustar 00 {"version":3,"file":"gradebooksetup_forms.min.js","sources":["../src/gradebooksetup_forms.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Prints the add item gradebook form\n *\n * @module core_grades\n * @copyright 2023 Mathew May <mathew.solutions>\n * @license http://www.gnu.org/copyleft/gpl.html GNU Public License\n */\n\nimport ModalForm from 'core_form/modalform';\nimport {getString} from 'core/str';\nimport Notification from 'core/notification';\nimport * as FormChangeChecker from 'core_form/changechecker';\n\nconst Selectors = {\n advancedFormLink: 'a.showadvancedform'\n};\n\n/**\n * Initialize module\n */\nexport const init = () => {\n // Sometimes the trigger does not exist, so lets conditionally add it.\n document.addEventListener('click', event => {\n const args = {};\n\n let formClass = null;\n let title = null;\n let trigger = null;\n if (event.target.closest('[data-trigger=\"add-item-form\"]')) {\n event.preventDefault();\n trigger = event.target.closest('[data-trigger=\"add-item-form\"]');\n formClass = 'core_grades\\\\form\\\\add_item';\n title = trigger.getAttribute('data-itemid') === '-1' ?\n getString('newitem', 'core_grades') : getString('itemsedit', 'core_grades');\n args.itemid = trigger.getAttribute('data-itemid');\n } else if (event.target.closest('[data-trigger=\"add-category-form\"]')) {\n event.preventDefault();\n trigger = event.target.closest('[data-trigger=\"add-category-form\"]');\n formClass = 'core_grades\\\\form\\\\add_category';\n title = trigger.getAttribute('data-category') === '-1' ?\n getString('newcategory', 'core_grades') : getString('categoryedit', 'core_grades');\n args.category = trigger.getAttribute('data-category');\n } else if (event.target.closest('[data-trigger=\"add-outcome-form\"]')) {\n event.preventDefault();\n trigger = event.target.closest('[data-trigger=\"add-outcome-form\"]');\n formClass = 'core_grades\\\\form\\\\add_outcome';\n title = trigger.getAttribute('data-itemid') === '-1' ?\n getString('newoutcomeitem', 'core_grades') : getString('outcomeitemsedit', 'core_grades');\n args.itemid = trigger.getAttribute('data-itemid');\n }\n\n if (trigger) {\n args.courseid = trigger.getAttribute('data-courseid');\n args.gpr_plugin = trigger.getAttribute('data-gprplugin');\n\n const modalForm = new ModalForm({\n modalConfig: {\n title: title,\n },\n formClass: formClass,\n args: args,\n saveButtonText: getString('save', 'core'),\n returnFocus: trigger,\n });\n\n // Show a toast notification when the form is submitted.\n modalForm.addEventListener(modalForm.events.FORM_SUBMITTED, event => {\n if (event.detail.result) {\n window.location.assign(event.detail.url);\n } else {\n Notification.addNotification({\n type: 'error',\n message: getString('saving_failed', 'core_grades')\n });\n }\n });\n\n modalForm.show();\n }\n\n const showAdvancedForm = event.target.closest(Selectors.advancedFormLink);\n if (showAdvancedForm) { // Navigate to the advanced form page and cary over any entered data.\n event.preventDefault();\n const form = event.target.closest('form');\n form.action = showAdvancedForm.href;\n // Disable the form change checker as we are going to carry over the data to the advanced form.\n FormChangeChecker.disableAllChecks();\n form.submit();\n }\n });\n};\n"],"names":["Selectors","document","addEventListener","event","args","formClass","title","trigger","target","closest","preventDefault","getAttribute","itemid","category","courseid","gpr_plugin","modalForm","ModalForm","modalConfig","saveButtonText","returnFocus","events","FORM_SUBMITTED","detail","result","window","location","assign","url","addNotification","type","message","show","showAdvancedForm","form","action","href","FormChangeChecker","disableAllChecks","submit"],"mappings":";;;;;;;42BA4BMA,2BACgB,mCAMF,KAEhBC,SAASC,iBAAiB,SAASC,cACzBC,KAAO,OAETC,UAAY,KACZC,MAAQ,KACRC,QAAU,QACVJ,MAAMK,OAAOC,QAAQ,mCACrBN,MAAMO,iBACNH,QAAUJ,MAAMK,OAAOC,QAAQ,kCAC/BJ,UAAY,8BACZC,MAAgD,OAAxCC,QAAQI,aAAa,gBACzB,kBAAU,UAAW,gBAAiB,kBAAU,YAAa,eACjEP,KAAKQ,OAASL,QAAQI,aAAa,gBAC5BR,MAAMK,OAAOC,QAAQ,uCAC5BN,MAAMO,iBACNH,QAAUJ,MAAMK,OAAOC,QAAQ,sCAC/BJ,UAAY,kCACZC,MAAkD,OAA1CC,QAAQI,aAAa,kBACzB,kBAAU,cAAe,gBAAiB,kBAAU,eAAgB,eACxEP,KAAKS,SAAWN,QAAQI,aAAa,kBAC9BR,MAAMK,OAAOC,QAAQ,uCAC5BN,MAAMO,iBACNH,QAAUJ,MAAMK,OAAOC,QAAQ,qCAC/BJ,UAAY,iCACZC,MAAgD,OAAxCC,QAAQI,aAAa,gBACzB,kBAAU,iBAAkB,gBAAiB,kBAAU,mBAAoB,eAC/EP,KAAKQ,OAASL,QAAQI,aAAa,gBAGnCJ,QAAS,CACTH,KAAKU,SAAWP,QAAQI,aAAa,iBACrCP,KAAKW,WAAaR,QAAQI,aAAa,wBAEjCK,UAAY,IAAIC,mBAAU,CAC5BC,YAAa,CACTZ,MAAOA,OAEXD,UAAWA,UACXD,KAAMA,KACNe,gBAAgB,kBAAU,OAAQ,QAClCC,YAAab,UAIjBS,UAAUd,iBAAiBc,UAAUK,OAAOC,gBAAgBnB,QACpDA,MAAMoB,OAAOC,OACbC,OAAOC,SAASC,OAAOxB,MAAMoB,OAAOK,2BAEvBC,gBAAgB,CACzBC,KAAM,QACNC,SAAS,kBAAU,gBAAiB,oBAKhDf,UAAUgB,aAGRC,iBAAmB9B,MAAMK,OAAOC,QAAQT,+BAC1CiC,iBAAkB,CAClB9B,MAAMO,uBACAwB,KAAO/B,MAAMK,OAAOC,QAAQ,QAClCyB,KAAKC,OAASF,iBAAiBG,KAE/BC,kBAAkBC,mBAClBJ,KAAKK"} amd/build/searchwidget/selectors.min.js 0000604 00000001507 15062070556 0014205 0 ustar 00 define("core_grades/searchwidget/selectors",["exports"],(function(_exports){Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.default=void 0;return _exports.default={regions:{searchResults:'[data-region="search-results-container-widget"]',unsearchableContent:'[data-region="unsearchable-content-container-widget"]'},actions:{search:'[data-action="search"]',clearSearch:'[data-action="clearsearch"]'},elements:{getSearchWidgetSelector:searchtype=>'.search-widget[data-searchtype="'.concat(searchtype,'"]'),getSearchWidgetDropdownSelector:searchtype=>'.search-widget[data-searchtype="'.concat(searchtype,'"] .dropdown-menu'),getSearchWidgetSelectOption:searchInput=>"#".concat(searchInput.getAttribute("aria-controls"),' [role="option"][aria-selected="true"]')}},_exports.default})); //# sourceMappingURL=selectors.min.js.map amd/build/searchwidget/repository.min.js.map 0000604 00000004733 15062070556 0015201 0 ustar 00 {"version":3,"file":"repository.min.js","sources":["../../src/searchwidget/repository.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * A repo for the search widget.\n *\n * @module core_grades/searchwidget/repository\n * @copyright 2022 Mathew May <mathew.solutions>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport ajax from 'core/ajax';\n\n/**\n * Given a course ID, we want to fetch the gradable items, so we may fetch reports based on activity items.\n * Note: This will be worked upon in the single view issue.\n *\n * @method gradeitemFetch\n * @param {int} courseid ID of the course to fetch the users of.\n * @return {object} jQuery promise\n */\nexport const gradeitemFetch = (courseid) => {\n const request = {\n methodname: 'gradereport_singleview_get_grade_items_for_search_widget',\n args: {\n courseid: courseid,\n },\n };\n return ajax.call([request])[0];\n};\n\n/**\n * Given a course ID, we want to fetch the enrolled learners, so we may fetch their reports.\n *\n * @method userFetch\n * @param {int} courseid ID of the course to fetch the users of.\n * @param {int} groupId ID of the group to fetch the users of.\n * @return {object} jQuery promise\n */\nexport const userFetch = (courseid, groupId) => {\n const request = {\n methodname: 'core_grades_get_enrolled_users_for_selector',\n args: {\n courseid: courseid,\n groupid: groupId,\n },\n };\n return ajax.call([request])[0];\n};\n"],"names":["courseid","request","methodname","args","ajax","call","groupId","groupid"],"mappings":";;;;;;;2LAiC+BA,iBACrBC,QAAU,CACZC,WAAY,2DACZC,KAAM,CACFH,SAAUA,kBAGXI,cAAKC,KAAK,CAACJ,UAAU,uBAWP,CAACD,SAAUM,iBAC1BL,QAAU,CACZC,WAAY,8CACZC,KAAM,CACFH,SAAUA,SACVO,QAASD,iBAGVF,cAAKC,KAAK,CAACJ,UAAU"} amd/build/searchwidget/selectors.min.js.map 0000604 00000004236 15062070556 0014763 0 ustar 00 {"version":3,"file":"selectors.min.js","sources":["../../src/searchwidget/selectors.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Selectors for the search widget.\n *\n * @module core_grades/searchwidget/selectors\n * @copyright 2022 Mihail Geshoski <mihail@moodle.com>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nexport default {\n regions: {\n searchResults: '[data-region=\"search-results-container-widget\"]',\n unsearchableContent: '[data-region=\"unsearchable-content-container-widget\"]',\n },\n actions: {\n search: '[data-action=\"search\"]',\n clearSearch: '[data-action=\"clearsearch\"]',\n },\n elements: {\n getSearchWidgetSelector: searchtype => `.search-widget[data-searchtype=\"${searchtype}\"]`,\n getSearchWidgetDropdownSelector: searchtype => `.search-widget[data-searchtype=\"${searchtype}\"] .dropdown-menu`,\n getSearchWidgetSelectOption:\n searchInput => `#${searchInput.getAttribute('aria-controls')} [role=\"option\"][aria-selected=\"true\"]`,\n },\n};\n"],"names":["regions","searchResults","unsearchableContent","actions","search","clearSearch","elements","getSearchWidgetSelector","searchtype","getSearchWidgetDropdownSelector","getSearchWidgetSelectOption","searchInput","getAttribute"],"mappings":"oLAuBe,CACXA,QAAS,CACLC,cAAe,kDACfC,oBAAqB,yDAEzBC,QAAS,CACLC,OAAQ,yBACRC,YAAa,+BAEjBC,SAAU,CACNC,wBAAyBC,sDAAiDA,iBAC1EC,gCAAiCD,sDAAiDA,gCAClFE,4BACIC,wBAAmBA,YAAYC,aAAa"} amd/build/searchwidget/basewidget.min.js.map 0000604 00000034323 15062070556 0015076 0 ustar 00 {"version":3,"file":"basewidget.min.js","sources":["../../src/searchwidget/basewidget.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * A widget to search users or grade items within the gradebook.\n *\n * @module core_grades/searchwidget/basewidget\n * @copyright 2022 Mathew May <mathew.solutions>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\nimport {debounce} from 'core/utils';\nimport * as Templates from 'core/templates';\nimport * as Selectors from 'core_grades/searchwidget/selectors';\nimport Notification from 'core/notification';\nimport Log from 'core/log';\n\n/**\n * Build the base searching widget.\n *\n * @method init\n * @param {HTMLElement} widgetContentContainer The selector for the widget container element.\n * @param {Promise} bodyPromise The promise from the callee of the contents to place in the widget container.\n * @param {Array} data An array of all the data generated by the callee.\n * @param {Function} searchFunc Partially applied function we need to manage search the passed dataset.\n * @param {string|null} unsearchableContent The content rendered in a non-searchable area.\n * @param {Function|null} afterSelect Callback executed after an item is selected.\n */\nexport const init = async(\n widgetContentContainer,\n bodyPromise,\n data,\n searchFunc,\n unsearchableContent = null,\n afterSelect = null,\n) => {\n Log.debug('The core_grades/searchwidget/basewidget component is deprecated. Please refer to core/search_combobox() instead.');\n bodyPromise.then(async(bodyContent) => {\n // Render the body content.\n widgetContentContainer.innerHTML = bodyContent;\n\n // Render the unsearchable content if defined.\n if (unsearchableContent) {\n const unsearchableContentContainer = widgetContentContainer.querySelector(Selectors.regions.unsearchableContent);\n unsearchableContentContainer.innerHTML += unsearchableContent;\n }\n\n const searchResultsContainer = widgetContentContainer.querySelector(Selectors.regions.searchResults);\n // Display a loader until the search results are rendered.\n await showLoader(searchResultsContainer);\n // Render the search results.\n await renderSearchResults(searchResultsContainer, data);\n\n registerListenerEvents(widgetContentContainer, data, searchFunc, afterSelect);\n\n }).catch(Notification.exception);\n};\n\n/**\n * Register the event listeners for the search widget.\n *\n * @method registerListenerEvents\n * @param {HTMLElement} widgetContentContainer The selector for the widget container element.\n * @param {Array} data An array of all the data generated by the callee.\n * @param {Function} searchFunc Partially applied function we need to manage search the passed dataset.\n * @param {Function|null} afterSelect Callback executed after an item is selected.\n */\nexport const registerListenerEvents = (widgetContentContainer, data, searchFunc, afterSelect = null) => {\n const searchResultsContainer = widgetContentContainer.querySelector(Selectors.regions.searchResults);\n const searchInput = widgetContentContainer.querySelector(Selectors.actions.search);\n\n if (!searchInput) {\n // Too late. The widget is already closed and its content is empty.\n return;\n }\n\n // We want to focus on the first known user interable element within the dropdown.\n searchInput.focus();\n const clearSearchButton = widgetContentContainer.querySelector(Selectors.actions.clearSearch);\n\n // The search input is triggered.\n searchInput.addEventListener('input', debounce(async() => {\n // If search query is present display the 'clear search' button, otherwise hide it.\n if (searchInput.value.length > 0) {\n clearSearchButton.classList.remove('d-none');\n } else {\n clearSearchButton.classList.add('d-none');\n }\n // Remove aria-activedescendant when the available options change.\n searchInput.removeAttribute('aria-activedescendant');\n // Display the search results.\n await renderSearchResults(\n searchResultsContainer,\n debounceCallee(\n searchInput.value,\n data,\n searchFunc()\n )\n );\n }, 300));\n\n // Clear search is triggered.\n clearSearchButton.addEventListener('click', async(e) => {\n e.stopPropagation();\n // Clear the entered search query in the search bar.\n searchInput.value = \"\";\n searchInput.focus();\n clearSearchButton.classList.add('d-none');\n\n // Remove aria-activedescendant when the available options change.\n searchInput.removeAttribute('aria-activedescendant');\n\n // Display all results.\n await renderSearchResults(\n searchResultsContainer,\n debounceCallee(\n searchInput.value,\n data,\n searchFunc()\n )\n );\n });\n\n const inputElement = document.getElementById(searchInput.dataset.inputElement);\n if (inputElement && afterSelect) {\n inputElement.addEventListener('change', e => {\n const selectedOption = widgetContentContainer.querySelector(\n Selectors.elements.getSearchWidgetSelectOption(searchInput),\n );\n\n if (selectedOption) {\n afterSelect(e.target.value);\n }\n });\n }\n\n // Backward compatibility. Handle the click event for the following cases:\n // - When we have <li> tags without an afterSelect callback function being provided (old js).\n // - When we have <a> tags without href (old template).\n widgetContentContainer.addEventListener('click', e => {\n const deprecatedOption = e.target.closest(\n 'a.dropdown-item[role=\"menuitem\"]:not([href]), .dropdown-item[role=\"option\"]:not([href])'\n );\n if (deprecatedOption) {\n // We are in one of these situations:\n // - We have <li> tags without an afterSelect callback function being provided.\n // - We have <a> tags without href.\n if (inputElement && afterSelect) {\n afterSelect(deprecatedOption.dataset.value);\n } else {\n const url = (data.find(object => object.id == deprecatedOption.dataset.value) || {url: ''}).url;\n location.href = url;\n }\n }\n });\n\n // Backward compatibility. Handle the keydown event for the following cases:\n // - When we have <li> tags without an afterSelect callback function being provided (old js).\n // - When we have <a> tags without href (old template).\n widgetContentContainer.addEventListener('keydown', e => {\n const deprecatedOption = e.target.closest(\n 'a.dropdown-item[role=\"menuitem\"]:not([href]), .dropdown-item[role=\"option\"]:not([href])'\n );\n if (deprecatedOption && (e.key === ' ' || e.key === 'Enter')) {\n // We are in one of these situations:\n // - We have <li> tags without an afterSelect callback function being provided.\n // - We have <a> tags without href.\n e.preventDefault();\n if (inputElement && afterSelect) {\n afterSelect(deprecatedOption.dataset.value);\n } else {\n const url = (data.find(object => object.id == deprecatedOption.dataset.value) || {url: ''}).url;\n location.href = url;\n }\n }\n });\n};\n\n/**\n * Renders the loading placeholder for the search widget.\n *\n * @method showLoader\n * @param {HTMLElement} container The DOM node where we'll render the loading placeholder.\n */\nexport const showLoader = async(container) => {\n container.innerHTML = '';\n const {html, js} = await Templates.renderForPromise('core_grades/searchwidget/loading', {});\n Templates.replaceNodeContents(container, html, js);\n};\n\n/**\n * We have a small helper that'll call the curried search function allowing callers to filter\n * the data set however we want rather than defining how data must be filtered.\n *\n * @method debounceCallee\n * @param {String} searchValue The input from the user that we'll search against.\n * @param {Array} data An array of all the data generated by the callee.\n * @param {Function} searchFunction Partially applied function we need to manage search the passed dataset.\n * @return {Array} The filtered subset of the provided data that we'll then render into the results.\n */\nconst debounceCallee = (searchValue, data, searchFunction) => {\n if (searchValue.length > 0) { // Search query is present.\n return searchFunction(data, searchValue);\n }\n return data;\n};\n\n/**\n * Given the output of the callers' search function, render out the results into the search results container.\n *\n * @method renderSearchResults\n * @param {HTMLElement} searchResultsContainer The DOM node of the widget where we'll render the provided results.\n * @param {Array} searchResultsData The filtered subset of the provided data that we'll then render into the results.\n */\nconst renderSearchResults = async(searchResultsContainer, searchResultsData) => {\n const templateData = {\n 'searchresults': searchResultsData,\n };\n // Build up the html & js ready to place into the help section.\n const {html, js} = await Templates.renderForPromise('core_grades/searchwidget/searchresults', templateData);\n await Templates.replaceNodeContents(searchResultsContainer, html, js);\n\n // Backward compatibility.\n if (searchResultsContainer.getAttribute('role') !== 'listbox') {\n const deprecatedOptions = searchResultsContainer.querySelectorAll(\n 'a.dropdown-item[role=\"menuitem\"][href=\"\"], .dropdown-item[role=\"option\"]:not([href])'\n );\n for (const option of deprecatedOptions) {\n option.tabIndex = 0;\n option.removeAttribute('href');\n }\n }\n};\n\n/**\n * We want to create the basic promises and hooks that the caller will implement, so we can build the search widget\n * ahead of time and allow the caller to resolve their promises once complete.\n *\n * @method promisesAndResolvers\n * @returns {{bodyPromise: Promise, bodyPromiseResolver}}\n */\nexport const promisesAndResolvers = () => {\n // We want to show the widget instantly but loading whilst waiting for our data.\n let bodyPromiseResolver;\n const bodyPromise = new Promise(resolve => {\n bodyPromiseResolver = resolve;\n });\n\n return {bodyPromiseResolver, bodyPromise};\n};\n"],"names":["async","widgetContentContainer","bodyPromise","data","searchFunc","unsearchableContent","afterSelect","debug","then","innerHTML","bodyContent","querySelector","Selectors","regions","searchResultsContainer","searchResults","showLoader","renderSearchResults","registerListenerEvents","catch","Notification","exception","searchInput","actions","search","focus","clearSearchButton","clearSearch","addEventListener","value","length","classList","remove","add","removeAttribute","debounceCallee","e","stopPropagation","inputElement","document","getElementById","dataset","elements","getSearchWidgetSelectOption","target","deprecatedOption","closest","url","find","object","id","location","href","key","preventDefault","container","html","js","Templates","renderForPromise","replaceNodeContents","searchValue","searchFunction","searchResultsData","templateData","getAttribute","deprecatedOptions","querySelectorAll","option","tabIndex","bodyPromiseResolver","Promise","resolve"],"mappings":";;;;;;;kWAuCoBA,eAChBC,uBACAC,YACAC,KACAC,gBACAC,2EAAsB,KACtBC,mEAAc,kBAEVC,MAAM,oHACVL,YAAYM,MAAKR,MAAAA,iBAEbC,uBAAuBQ,UAAYC,YAG/BL,oBAAqB,CACgBJ,uBAAuBU,cAAcC,UAAUC,QAAQR,qBAC/DI,WAAaJ,0BAGxCS,uBAAyBb,uBAAuBU,cAAcC,UAAUC,QAAQE,qBAEhFC,WAAWF,8BAEXG,oBAAoBH,uBAAwBX,MAElDe,uBAAuBjB,uBAAwBE,KAAMC,WAAYE,gBAElEa,MAAMC,sBAAaC,kBAYbH,uBAAyB,SAACjB,uBAAwBE,KAAMC,gBAAYE,mEAAc,WACrFQ,uBAAyBb,uBAAuBU,cAAcC,UAAUC,QAAQE,eAChFO,YAAcrB,uBAAuBU,cAAcC,UAAUW,QAAQC,YAEtEF,mBAMLA,YAAYG,cACNC,kBAAoBzB,uBAAuBU,cAAcC,UAAUW,QAAQI,aAGjFL,YAAYM,iBAAiB,SAAS,oBAAS5B,UAEvCsB,YAAYO,MAAMC,OAAS,EAC3BJ,kBAAkBK,UAAUC,OAAO,UAEnCN,kBAAkBK,UAAUE,IAAI,UAGpCX,YAAYY,gBAAgB,+BAEtBjB,oBACFH,uBACAqB,eACIb,YAAYO,MACZ1B,KACAC,iBAGT,MAGHsB,kBAAkBE,iBAAiB,SAAS5B,MAAAA,IACxCoC,EAAEC,kBAEFf,YAAYO,MAAQ,GACpBP,YAAYG,QACZC,kBAAkBK,UAAUE,IAAI,UAGhCX,YAAYY,gBAAgB,+BAGtBjB,oBACFH,uBACAqB,eACIb,YAAYO,MACZ1B,KACAC,wBAKNkC,aAAeC,SAASC,eAAelB,YAAYmB,QAAQH,cAC7DA,cAAgBhC,aAChBgC,aAAaV,iBAAiB,UAAUQ,IACbnC,uBAAuBU,cAC1CC,UAAU8B,SAASC,4BAA4BrB,eAI/ChB,YAAY8B,EAAEQ,OAAOf,UAQjC5B,uBAAuB2B,iBAAiB,SAASQ,UACvCS,iBAAmBT,EAAEQ,OAAOE,QAC9B,8FAEAD,oBAIIP,cAAgBhC,YAChBA,YAAYuC,iBAAiBJ,QAAQZ,WAClC,OACGkB,KAAO5C,KAAK6C,MAAKC,QAAUA,OAAOC,IAAML,iBAAiBJ,QAAQZ,SAAU,CAACkB,IAAK,KAAKA,IAC5FI,SAASC,KAAOL,QAQ5B9C,uBAAuB2B,iBAAiB,WAAWQ,UACzCS,iBAAmBT,EAAEQ,OAAOE,QAC9B,8FAEAD,mBAA+B,MAAVT,EAAEiB,KAAyB,UAAVjB,EAAEiB,QAIxCjB,EAAEkB,iBACEhB,cAAgBhC,YAChBA,YAAYuC,iBAAiBJ,QAAQZ,WAClC,OACGkB,KAAO5C,KAAK6C,MAAKC,QAAUA,OAAOC,IAAML,iBAAiBJ,QAAQZ,SAAU,CAACkB,IAAK,KAAKA,IAC5FI,SAASC,KAAOL,sEAYnB/B,WAAahB,MAAAA,YACtBuD,UAAU9C,UAAY,SAChB+C,KAACA,KAADC,GAAOA,UAAYC,UAAUC,iBAAiB,mCAAoC,IACxFD,UAAUE,oBAAoBL,UAAWC,KAAMC,0CAa7CtB,eAAiB,CAAC0B,YAAa1D,KAAM2D,iBACnCD,YAAY/B,OAAS,EACdgC,eAAe3D,KAAM0D,aAEzB1D,KAULc,oBAAsBjB,MAAMc,uBAAwBiD,2BAChDC,aAAe,eACAD,oBAGfP,KAACA,KAADC,GAAOA,UAAYC,UAAUC,iBAAiB,yCAA0CK,uBACxFN,UAAUE,oBAAoB9C,uBAAwB0C,KAAMC,IAGd,YAAhD3C,uBAAuBmD,aAAa,QAAuB,OACrDC,kBAAoBpD,uBAAuBqD,iBAC7C,4FAEC,MAAMC,UAAUF,kBACjBE,OAAOC,SAAW,EAClBD,OAAOlC,gBAAgB,wCAYC,SAE5BoC,0BACEpE,YAAc,IAAIqE,SAAQC,UAC5BF,oBAAsBE,iBAGnB,CAACF,oBAAAA,oBAAqBpE,YAAAA"} amd/build/searchwidget/initials.min.js.map 0000604 00000023642 15062070556 0014576 0 ustar 00 {"version":3,"file":"initials.min.js","sources":["../../src/searchwidget/initials.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * A small dropdown to filter users within the gradebook.\n *\n * @module core_grades/searchwidget/initials\n * @copyright 2022 Mathew May <mathew.solutions>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport Pending from 'core/pending';\nimport * as Url from 'core/url';\nimport CustomEvents from \"core/custom_interaction_events\";\nimport $ from 'jquery';\n\n/**\n * Whether the event listener has already been registered for this module.\n *\n * @type {boolean}\n */\nlet registered = false;\n\n// Contain our selectors within this file until they could be of use elsewhere.\nconst selectors = {\n pageListItem: 'page-item',\n pageClickableItem: '.page-link',\n activeItem: 'active',\n formDropdown: '.initialsdropdownform',\n parentDomNode: '.initials-selector',\n firstInitial: 'firstinitial',\n lastInitial: 'lastinitial',\n initialBars: '.initialbar', // Both first and last name use this class.\n targetButton: 'initialswidget',\n formItems: {\n type: 'submit',\n save: 'save',\n cancel: 'cancel'\n }\n};\n\n/**\n * Our initial hook into the module which will eventually allow us to handle the dropdown initials bar form.\n *\n * @param {String} callingLink The link to redirect upon form submission.\n * @param {Null|Number} userid The user id to filter by.\n * @param {Null|String} searchvalue The search value to filter by.\n */\nexport const init = (callingLink, userid = null, searchvalue = null) => {\n if (registered) {\n return;\n }\n const pendingPromise = new Pending();\n registerListenerEvents(callingLink, userid, searchvalue);\n // BS events always bubble so, we need to listen for the event higher up the chain.\n $(selectors.parentDomNode).on('shown.bs.dropdown', () => {\n document.querySelector(selectors.pageClickableItem).focus({preventScroll: true});\n });\n pendingPromise.resolve();\n registered = true;\n};\n\n/**\n * Register event listeners.\n *\n * @param {String} callingLink The link to redirect upon form submission.\n * @param {Null|Number} userid The user id to filter by.\n * @param {Null|String} searchvalue The search value to filter by.\n */\nconst registerListenerEvents = (callingLink, userid = null, searchvalue = null) => {\n const events = [\n 'click',\n CustomEvents.events.activate,\n CustomEvents.events.keyboardActivate\n ];\n CustomEvents.define(document, events);\n\n // Register events.\n events.forEach((event) => {\n document.addEventListener(event, (e) => {\n // Always fetch the latest information when we click as state is a fickle thing.\n let {firstActive, lastActive, sifirst, silast} = onClickVariables();\n let itemToReset = '';\n\n // Prevent the usual form behaviour.\n if (e.target.closest(selectors.formDropdown)) {\n e.preventDefault();\n }\n\n // Handle the state of active initials before form submission.\n if (e.target.closest(`${selectors.formDropdown} .${selectors.pageListItem}`)) {\n // Ensure the li items don't cause weird clicking emptying out the form.\n if (e.target.classList.contains(selectors.pageListItem)) {\n return;\n }\n\n const initialsBar = e.target.closest(selectors.initialBars); // Find out which initial bar we are in.\n\n // We want to find the current active item in the menu area the user selected.\n // We also want to fetch the raw item out of the array for instant manipulation.\n if (initialsBar.classList.contains(selectors.firstInitial)) {\n sifirst = e.target;\n itemToReset = firstActive;\n } else {\n silast = e.target;\n itemToReset = lastActive;\n }\n swapActiveItems(itemToReset, e);\n }\n\n // Handle form submissions.\n if (e.target.closest(`${selectors.formDropdown}`) && e.target.type === selectors.formItems.type) {\n if (e.target.dataset.action === selectors.formItems.save) {\n // Ensure we strip out the value (All) as it messes with the PHP side of the initials bar.\n // Then we will redirect the user back onto the page with new filters applied.\n const params = {\n 'id': e.target.closest(selectors.formDropdown).dataset.courseid,\n 'searchvalue': searchvalue !== null ? searchvalue : '',\n 'sifirst': sifirst.parentElement.classList.contains('initialbarall') ? '' : sifirst.value,\n 'silast': silast.parentElement.classList.contains('initialbarall') ? '' : silast.value,\n };\n if (userid !== null) {\n params.userid = userid;\n }\n window.location = Url.relativeUrl(callingLink, params);\n }\n if (e.target.dataset.action === selectors.formItems.cancel) {\n $(`.${selectors.targetButton}`).dropdown('toggle');\n }\n }\n });\n });\n};\n\n/**\n * A small abstracted helper function which allows us to ensure we have up-to-date lists of nodes.\n *\n * @returns {{firstActive: HTMLElement, lastActive: HTMLElement, sifirst: ?String, silast: ?String}}\n */\nconst onClickVariables = () => {\n // Ensure we have an up-to-date initials bar.\n const firstItems = [...document.querySelectorAll(`.${selectors.firstInitial} li`)];\n const lastItems = [...document.querySelectorAll(`.${selectors.lastInitial} li`)];\n const firstActive = firstItems.filter((item) => item.classList.contains(selectors.activeItem))[0];\n const lastActive = lastItems.filter((item) => item.classList.contains(selectors.activeItem))[0];\n // Ensure we retain both of the selections from a previous instance.\n let sifirst = firstActive.querySelector(selectors.pageClickableItem);\n let silast = lastActive.querySelector(selectors.pageClickableItem);\n return {firstActive, lastActive, sifirst, silast};\n};\n\n/**\n * Given we are provided the old li and current click event, swap around the active properties.\n *\n * @param {HTMLElement} itemToReset\n * @param {Event} e\n */\nconst swapActiveItems = (itemToReset, e) => {\n itemToReset.classList.remove(selectors.activeItem);\n itemToReset.querySelector(selectors.pageClickableItem).ariaCurrent = false;\n\n // Set the select item as the current item.\n const itemToSetActive = e.target.parentElement;\n itemToSetActive.classList.add(selectors.activeItem);\n e.target.ariaCurrent = true;\n};\n"],"names":["registered","selectors","type","save","cancel","callingLink","userid","searchvalue","pendingPromise","Pending","registerListenerEvents","on","document","querySelector","focus","preventScroll","resolve","events","CustomEvents","activate","keyboardActivate","define","forEach","event","addEventListener","e","firstActive","lastActive","sifirst","silast","onClickVariables","itemToReset","target","closest","preventDefault","classList","contains","swapActiveItems","dataset","action","params","courseid","parentElement","value","window","location","Url","relativeUrl","dropdown","firstItems","querySelectorAll","lastItems","filter","item","remove","ariaCurrent","add"],"mappings":";;;;;;;44BAiCIA,YAAa,QAGXC,uBACY,YADZA,4BAEiB,aAFjBA,qBAGU,SAHVA,uBAIY,wBAJZA,wBAKa,qBALbA,uBAMY,eANZA,sBAOW,cAPXA,sBAQW,cARXA,uBASY,iBATZA,oBAUS,CACPC,KAAM,SACNC,KAAM,OACNC,OAAQ,wBAWI,SAACC,iBAAaC,8DAAS,KAAMC,mEAAc,QACvDP,wBAGEQ,eAAiB,IAAIC,iBAC3BC,uBAAuBL,YAAaC,OAAQC,iCAE1CN,yBAAyBU,GAAG,qBAAqB,KAC/CC,SAASC,cAAcZ,6BAA6Ba,MAAM,CAACC,eAAe,OAE9EP,eAAeQ,UACfhB,YAAa,SAUXU,uBAAyB,SAACL,iBAAaC,8DAAS,KAAMC,mEAAc,WAChEU,OAAS,CACX,QACAC,mCAAaD,OAAOE,SACpBD,mCAAaD,OAAOG,qDAEXC,OAAOT,SAAUK,QAG9BA,OAAOK,SAASC,QACZX,SAASY,iBAAiBD,OAAQE,QAE1BC,YAACA,YAADC,WAAcA,WAAdC,QAA0BA,QAA1BC,OAAmCA,QAAUC,mBAC7CC,YAAc,MAGdN,EAAEO,OAAOC,QAAQhC,yBACjBwB,EAAES,iBAIFT,EAAEO,OAAOC,kBAAWhC,oCAA2BA,yBAA2B,IAEtEwB,EAAEO,OAAOG,UAAUC,SAASnC,+BAIZwB,EAAEO,OAAOC,QAAQhC,uBAIrBkC,UAAUC,SAASnC,yBAC/B2B,QAAUH,EAAEO,OACZD,YAAcL,cAEdG,OAASJ,EAAEO,OACXD,YAAcJ,YAElBU,gBAAgBN,YAAaN,MAI7BA,EAAEO,OAAOC,kBAAWhC,0BAA6BwB,EAAEO,OAAO9B,OAASD,oBAAoBC,KAAM,IACzFuB,EAAEO,OAAOM,QAAQC,SAAWtC,oBAAoBE,KAAM,OAGhDqC,OAAS,IACLf,EAAEO,OAAOC,QAAQhC,wBAAwBqC,QAAQG,qBACxB,OAAhBlC,YAAuBA,YAAc,WACzCqB,QAAQc,cAAcP,UAAUC,SAAS,iBAAmB,GAAKR,QAAQe,aAC1Ed,OAAOa,cAAcP,UAAUC,SAAS,iBAAmB,GAAKP,OAAOc,OAEtE,OAAXrC,SACAkC,OAAOlC,OAASA,QAEpBsC,OAAOC,SAAWC,IAAIC,YAAY1C,YAAamC,QAE/Cf,EAAEO,OAAOM,QAAQC,SAAWtC,oBAAoBG,uCAC1CH,yBAA0B+C,SAAS,kBAYvDlB,iBAAmB,WAEfmB,WAAa,IAAIrC,SAASsC,4BAAqBjD,gCAC/CkD,UAAY,IAAIvC,SAASsC,4BAAqBjD,+BAC9CyB,YAAcuB,WAAWG,QAAQC,MAASA,KAAKlB,UAAUC,SAASnC,wBAAuB,GACzF0B,WAAawB,UAAUC,QAAQC,MAASA,KAAKlB,UAAUC,SAASnC,wBAAuB,OAEzF2B,QAAUF,YAAYb,cAAcZ,6BACpC4B,OAASF,WAAWd,cAAcZ,mCAC/B,CAACyB,YAAAA,YAAaC,WAAAA,WAAYC,QAAAA,QAASC,OAAAA,SASxCQ,gBAAkB,CAACN,YAAaN,KAClCM,YAAYI,UAAUmB,OAAOrD,sBAC7B8B,YAAYlB,cAAcZ,6BAA6BsD,aAAc,EAG7C9B,EAAEO,OAAOU,cACjBP,UAAUqB,IAAIvD,sBAC9BwB,EAAEO,OAAOuB,aAAc"} amd/build/searchwidget/initials.min.js 0000604 00000012011 15062070556 0014006 0 ustar 00 define("core_grades/searchwidget/initials",["exports","core/pending","core/url","core/custom_interaction_events","jquery"],(function(_exports,_pending,Url,_custom_interaction_events,_jquery){function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}} /** * A small dropdown to filter users within the gradebook. * * @module core_grades/searchwidget/initials * @copyright 2022 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.init=void 0,_pending=_interopRequireDefault(_pending),Url=function(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}newObj.default=obj,cache&&cache.set(obj,newObj);return newObj}(Url),_custom_interaction_events=_interopRequireDefault(_custom_interaction_events),_jquery=_interopRequireDefault(_jquery);let registered=!1;const selectors_pageListItem="page-item",selectors_pageClickableItem=".page-link",selectors_activeItem="active",selectors_formDropdown=".initialsdropdownform",selectors_parentDomNode=".initials-selector",selectors_firstInitial="firstinitial",selectors_lastInitial="lastinitial",selectors_initialBars=".initialbar",selectors_targetButton="initialswidget",selectors_formItems={type:"submit",save:"save",cancel:"cancel"};_exports.init=function(callingLink){let userid=arguments.length>1&&void 0!==arguments[1]?arguments[1]:null,searchvalue=arguments.length>2&&void 0!==arguments[2]?arguments[2]:null;if(registered)return;const pendingPromise=new _pending.default;registerListenerEvents(callingLink,userid,searchvalue),(0,_jquery.default)(selectors_parentDomNode).on("shown.bs.dropdown",(()=>{document.querySelector(selectors_pageClickableItem).focus({preventScroll:!0})})),pendingPromise.resolve(),registered=!0};const registerListenerEvents=function(callingLink){let userid=arguments.length>1&&void 0!==arguments[1]?arguments[1]:null,searchvalue=arguments.length>2&&void 0!==arguments[2]?arguments[2]:null;const events=["click",_custom_interaction_events.default.events.activate,_custom_interaction_events.default.events.keyboardActivate];_custom_interaction_events.default.define(document,events),events.forEach((event=>{document.addEventListener(event,(e=>{let{firstActive:firstActive,lastActive:lastActive,sifirst:sifirst,silast:silast}=onClickVariables(),itemToReset="";if(e.target.closest(selectors_formDropdown)&&e.preventDefault(),e.target.closest("".concat(selectors_formDropdown," .").concat(selectors_pageListItem))){if(e.target.classList.contains(selectors_pageListItem))return;e.target.closest(selectors_initialBars).classList.contains(selectors_firstInitial)?(sifirst=e.target,itemToReset=firstActive):(silast=e.target,itemToReset=lastActive),swapActiveItems(itemToReset,e)}if(e.target.closest("".concat(selectors_formDropdown))&&e.target.type===selectors_formItems.type){if(e.target.dataset.action===selectors_formItems.save){const params={id:e.target.closest(selectors_formDropdown).dataset.courseid,searchvalue:null!==searchvalue?searchvalue:"",sifirst:sifirst.parentElement.classList.contains("initialbarall")?"":sifirst.value,silast:silast.parentElement.classList.contains("initialbarall")?"":silast.value};null!==userid&&(params.userid=userid),window.location=Url.relativeUrl(callingLink,params)}e.target.dataset.action===selectors_formItems.cancel&&(0,_jquery.default)(".".concat(selectors_targetButton)).dropdown("toggle")}}))}))},onClickVariables=()=>{const firstItems=[...document.querySelectorAll(".".concat(selectors_firstInitial," li"))],lastItems=[...document.querySelectorAll(".".concat(selectors_lastInitial," li"))],firstActive=firstItems.filter((item=>item.classList.contains(selectors_activeItem)))[0],lastActive=lastItems.filter((item=>item.classList.contains(selectors_activeItem)))[0];let sifirst=firstActive.querySelector(selectors_pageClickableItem),silast=lastActive.querySelector(selectors_pageClickableItem);return{firstActive:firstActive,lastActive:lastActive,sifirst:sifirst,silast:silast}},swapActiveItems=(itemToReset,e)=>{itemToReset.classList.remove(selectors_activeItem),itemToReset.querySelector(selectors_pageClickableItem).ariaCurrent=!1;e.target.parentElement.classList.add(selectors_activeItem),e.target.ariaCurrent=!0}})); //# sourceMappingURL=initials.min.js.map amd/build/searchwidget/basewidget.min.js 0000604 00000014140 15062070556 0014315 0 ustar 00 define("core_grades/searchwidget/basewidget",["exports","core/utils","core/templates","core_grades/searchwidget/selectors","core/notification","core/log"],(function(_exports,_utils,Templates,Selectors,_notification,_log){function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}}function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}function _interopRequireWildcard(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}return newObj.default=obj,cache&&cache.set(obj,newObj),newObj} /** * A widget to search users or grade items within the gradebook. * * @module core_grades/searchwidget/basewidget * @copyright 2022 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.showLoader=_exports.registerListenerEvents=_exports.promisesAndResolvers=_exports.init=void 0,Templates=_interopRequireWildcard(Templates),Selectors=_interopRequireWildcard(Selectors),_notification=_interopRequireDefault(_notification),_log=_interopRequireDefault(_log);_exports.init=async function(widgetContentContainer,bodyPromise,data,searchFunc){let unsearchableContent=arguments.length>4&&void 0!==arguments[4]?arguments[4]:null,afterSelect=arguments.length>5&&void 0!==arguments[5]?arguments[5]:null;_log.default.debug("The core_grades/searchwidget/basewidget component is deprecated. Please refer to core/search_combobox() instead."),bodyPromise.then((async bodyContent=>{if(widgetContentContainer.innerHTML=bodyContent,unsearchableContent){widgetContentContainer.querySelector(Selectors.regions.unsearchableContent).innerHTML+=unsearchableContent}const searchResultsContainer=widgetContentContainer.querySelector(Selectors.regions.searchResults);await showLoader(searchResultsContainer),await renderSearchResults(searchResultsContainer,data),registerListenerEvents(widgetContentContainer,data,searchFunc,afterSelect)})).catch(_notification.default.exception)};const registerListenerEvents=function(widgetContentContainer,data,searchFunc){let afterSelect=arguments.length>3&&void 0!==arguments[3]?arguments[3]:null;const searchResultsContainer=widgetContentContainer.querySelector(Selectors.regions.searchResults),searchInput=widgetContentContainer.querySelector(Selectors.actions.search);if(!searchInput)return;searchInput.focus();const clearSearchButton=widgetContentContainer.querySelector(Selectors.actions.clearSearch);searchInput.addEventListener("input",(0,_utils.debounce)((async()=>{searchInput.value.length>0?clearSearchButton.classList.remove("d-none"):clearSearchButton.classList.add("d-none"),searchInput.removeAttribute("aria-activedescendant"),await renderSearchResults(searchResultsContainer,debounceCallee(searchInput.value,data,searchFunc()))}),300)),clearSearchButton.addEventListener("click",(async e=>{e.stopPropagation(),searchInput.value="",searchInput.focus(),clearSearchButton.classList.add("d-none"),searchInput.removeAttribute("aria-activedescendant"),await renderSearchResults(searchResultsContainer,debounceCallee(searchInput.value,data,searchFunc()))}));const inputElement=document.getElementById(searchInput.dataset.inputElement);inputElement&&afterSelect&&inputElement.addEventListener("change",(e=>{widgetContentContainer.querySelector(Selectors.elements.getSearchWidgetSelectOption(searchInput))&&afterSelect(e.target.value)})),widgetContentContainer.addEventListener("click",(e=>{const deprecatedOption=e.target.closest('a.dropdown-item[role="menuitem"]:not([href]), .dropdown-item[role="option"]:not([href])');if(deprecatedOption)if(inputElement&&afterSelect)afterSelect(deprecatedOption.dataset.value);else{const url=(data.find((object=>object.id==deprecatedOption.dataset.value))||{url:""}).url;location.href=url}})),widgetContentContainer.addEventListener("keydown",(e=>{const deprecatedOption=e.target.closest('a.dropdown-item[role="menuitem"]:not([href]), .dropdown-item[role="option"]:not([href])');if(deprecatedOption&&(" "===e.key||"Enter"===e.key))if(e.preventDefault(),inputElement&&afterSelect)afterSelect(deprecatedOption.dataset.value);else{const url=(data.find((object=>object.id==deprecatedOption.dataset.value))||{url:""}).url;location.href=url}}))};_exports.registerListenerEvents=registerListenerEvents;const showLoader=async container=>{container.innerHTML="";const{html:html,js:js}=await Templates.renderForPromise("core_grades/searchwidget/loading",{});Templates.replaceNodeContents(container,html,js)};_exports.showLoader=showLoader;const debounceCallee=(searchValue,data,searchFunction)=>searchValue.length>0?searchFunction(data,searchValue):data,renderSearchResults=async(searchResultsContainer,searchResultsData)=>{const templateData={searchresults:searchResultsData},{html:html,js:js}=await Templates.renderForPromise("core_grades/searchwidget/searchresults",templateData);if(await Templates.replaceNodeContents(searchResultsContainer,html,js),"listbox"!==searchResultsContainer.getAttribute("role")){const deprecatedOptions=searchResultsContainer.querySelectorAll('a.dropdown-item[role="menuitem"][href=""], .dropdown-item[role="option"]:not([href])');for(const option of deprecatedOptions)option.tabIndex=0,option.removeAttribute("href")}};_exports.promisesAndResolvers=()=>{let bodyPromiseResolver;const bodyPromise=new Promise((resolve=>{bodyPromiseResolver=resolve}));return{bodyPromiseResolver:bodyPromiseResolver,bodyPromise:bodyPromise}}})); //# sourceMappingURL=basewidget.min.js.map amd/build/searchwidget/repository.min.js 0000604 00000001624 15062070556 0014421 0 ustar 00 define("core_grades/searchwidget/repository",["exports","core/ajax"],(function(_exports,_ajax){var obj; /** * A repo for the search widget. * * @module core_grades/searchwidget/repository * @copyright 2022 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.userFetch=_exports.gradeitemFetch=void 0,_ajax=(obj=_ajax)&&obj.__esModule?obj:{default:obj};_exports.gradeitemFetch=courseid=>{const request={methodname:"gradereport_singleview_get_grade_items_for_search_widget",args:{courseid:courseid}};return _ajax.default.call([request])[0]};_exports.userFetch=(courseid,groupId)=>{const request={methodname:"core_grades_get_enrolled_users_for_selector",args:{courseid:courseid,groupid:groupId}};return _ajax.default.call([request])[0]}})); //# sourceMappingURL=repository.min.js.map amd/build/edittree_weights.min.js.map 0000604 00000045403 15062070556 0013647 0 ustar 00 {"version":3,"file":"edittree_weights.min.js","sources":["../src/edittree_weights.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * This module provides functionality for managing weight calculations and adjustments for grade items.\n *\n * @module core_grades/edittree_weight\n * @copyright 2023 Shamim Rezaie <shamim@moodle.com>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport {getString} from 'core/str';\nimport {prefetchStrings} from 'core/prefetch';\n\n/**\n * Selectors.\n *\n * @type {Object}\n */\nconst selectors = {\n weightOverrideCheckbox: 'input[type=\"checkbox\"][name^=\"weightoverride_\"]',\n weightOverrideInput: 'input[type=\"text\"][name^=\"weight_\"]',\n aggregationForCategory: category => `[data-aggregationforcategory='${category}']`,\n childrenByCategory: category => `tr[data-parent-category=\"${category}\"]`,\n categoryByIdentifier: identifier => `tr.category[data-category=\"${identifier}\"]`,\n};\n\n/**\n * An object representing grading-related constants.\n * The same as what's defined in lib/grade/constants.php.\n *\n * @type {Object}\n * @property {Object} aggregation Aggregation settings.\n * @property {number} aggregation.sum Aggregation method: sum.\n * @property {Object} type Grade type settings.\n * @property {number} type.none Grade type: none.\n * @property {number} type.value Grade type: value.\n * @property {number} type.scale Grade type: scale.\n */\nconst grade = {\n aggregation: {\n sum: 13,\n },\n};\n\n/**\n * The character used as the decimal separator for number formatting.\n *\n * @type {string}\n */\nlet decimalSeparator;\n\n/**\n * This setting indicates if we should use algorithm prior to MDL-49257 fix for calculating extra credit weights.\n * Even though the old algorithm has bugs in it, we need to preserve existing grades.\n *\n * @type {boolean}\n */\nlet oldExtraCreditCalculation;\n\n/**\n * Recalculates the natural weights for grade items within a given category.\n *\n * @param {HTMLElement} categoryElement The DOM element representing the category.\n */\n// Suppress 'complexity' linting rule to keep this function as close to grade_category::auto_update_weights.\n// eslint-disable-next-line complexity\nconst recalculateNaturalWeights = (categoryElement) => {\n const childElements = document.querySelectorAll(selectors.childrenByCategory(categoryElement.dataset.category));\n\n // Calculate the sum of the grademax's of all the items within this category.\n let totalGradeMax = 0;\n\n // Out of 100, how much weight has been manually overridden by a user?\n let totalOverriddenWeight = 0;\n let totalOverriddenGradeMax = 0;\n\n // Has every assessment in this category been overridden?\n let automaticGradeItemsPresent = false;\n // Does the grade item require normalising?\n let requiresNormalising = false;\n\n // Is there an error in the weight calculations?\n let erroneous = false;\n\n // This array keeps track of the id and weight of every grade item that has been overridden.\n const overrideArray = {};\n\n for (const childElement of childElements) {\n const weightInput = childElement.querySelector(selectors.weightOverrideInput);\n const weightCheckbox = childElement.querySelector(selectors.weightOverrideCheckbox);\n\n // There are cases where a grade item should be excluded from calculations:\n // - If the item's grade type is 'text' or 'none'.\n // - If the grade item is an outcome item and the settings are set to not aggregate outcome items.\n // - If the item's grade type is 'scale' and the settings are set to ignore scales in aggregations.\n // All these cases are already taken care of in the backend, and no 'weight' input element is rendered on the page\n // if a grade item should not have a weight.\n if (!weightInput) {\n continue;\n }\n\n const itemWeight = parseWeight(weightInput.value);\n const itemAggregationCoefficient = parseInt(childElement.dataset.aggregationcoef);\n const itemGradeMax = parseFloat(childElement.dataset.grademax);\n\n // Record the ID and the weight for this grade item.\n overrideArray[childElement.dataset.itemid] = {\n extraCredit: itemAggregationCoefficient,\n weight: itemWeight,\n weightOverride: weightCheckbox.checked,\n };\n // If this item has had its weight overridden then set the flag to true, but\n // only if all previous items were also overridden. Note that extra credit items\n // are counted as overridden grade items.\n if (!weightCheckbox.checked && itemAggregationCoefficient === 0) {\n automaticGradeItemsPresent = true;\n }\n\n if (itemAggregationCoefficient > 0) {\n // An extra credit grade item doesn't contribute to totalOverriddenGradeMax.\n continue;\n } else if (weightCheckbox.checked && itemWeight <= 0) {\n // An overridden item that defines a weight of 0 does not contribute to totalOverriddenGradeMax.\n continue;\n }\n\n totalGradeMax += itemGradeMax;\n if (weightCheckbox.checked) {\n totalOverriddenWeight += itemWeight;\n totalOverriddenGradeMax += itemGradeMax;\n }\n }\n\n // Initialise this variable (used to keep track of the weight override total).\n let normaliseTotal = 0;\n // Keep a record of how much the override total is to see if it is above 100. If it is then we need to set the\n // other weights to zero and normalise the others.\n let overriddenTotal = 0;\n // Total up all the weights.\n for (const gradeItemDetail of Object.values(overrideArray)) {\n // Exclude grade items with extra credit or negative weights (which will be set to zero later).\n if (!gradeItemDetail.extraCredit && gradeItemDetail.weight > 0) {\n normaliseTotal += gradeItemDetail.weight;\n }\n // The overridden total includes items that are marked as overridden, not extra credit, and have a positive weight.\n if (gradeItemDetail.weightOverride && !gradeItemDetail.extraCredit && gradeItemDetail.weight > 0) {\n // Add overridden weights up to see if they are greater than 1.\n overriddenTotal += gradeItemDetail.weight;\n }\n }\n if (overriddenTotal > 100) {\n // Make sure that this category of weights gets normalised.\n requiresNormalising = true;\n // The normalised weights are only the overridden weights, so we just use the total of those.\n normaliseTotal = overriddenTotal;\n }\n\n const totalNonOverriddenGradeMax = totalGradeMax - totalOverriddenGradeMax;\n\n for (const childElement of childElements) {\n const weightInput = childElement.querySelector(selectors.weightOverrideInput);\n const weightCheckbox = childElement.querySelector(selectors.weightOverrideCheckbox);\n const itemAggregationCoefficient = parseInt(childElement.dataset.aggregationcoef);\n const itemGradeMax = parseFloat(childElement.dataset.grademax);\n\n if (!weightInput) {\n continue;\n } else if (!oldExtraCreditCalculation && itemAggregationCoefficient > 0 && weightCheckbox.checked) {\n // For an item with extra credit ignore other weights and overrides but do not change anything at all\n // if its weight was already overridden.\n continue;\n }\n\n // Remove any error messages and classes.\n weightInput.classList.remove('is-invalid');\n const errorArea = weightInput.closest('td').querySelector('.invalid-feedback');\n errorArea.textContent = '';\n\n if (!oldExtraCreditCalculation && itemAggregationCoefficient > 0 && !weightCheckbox.checked) {\n // For an item with extra credit ignore other weights and overrides.\n weightInput.value = totalGradeMax ? formatFloat(itemGradeMax * 100 / totalGradeMax) : 0;\n } else if (!weightCheckbox.checked) {\n // Calculations with a grade maximum of zero will cause problems. Just set the weight to zero.\n if (totalOverriddenWeight >= 100 || totalNonOverriddenGradeMax === 0 || itemGradeMax === 0) {\n // There is no more weight to distribute.\n weightInput.value = formatFloat(0);\n } else {\n // Calculate this item's weight as a percentage of the non-overridden total grade maxes\n // then convert it to a proportion of the available non-overridden weight.\n weightInput.value = formatFloat((itemGradeMax / totalNonOverriddenGradeMax) * (100 - totalOverriddenWeight));\n }\n } else if ((!automaticGradeItemsPresent && normaliseTotal !== 100) || requiresNormalising ||\n overrideArray[childElement.dataset.itemid].weight < 0) {\n if (overrideArray[childElement.dataset.itemid].weight < 0) {\n weightInput.value = formatFloat(0);\n }\n\n // Zero is a special case. If the total is zero then we need to set the weight of the parent category to zero.\n if (normaliseTotal !== 0) {\n erroneous = true;\n const error = normaliseTotal > 100 ? 'erroroverweight' : 'errorunderweight';\n // eslint-disable-next-line promise/always-return,promise/catch-or-return\n getString(error, 'core_grades').then((errorString) => {\n errorArea.textContent = errorString;\n });\n weightInput.classList.add('is-invalid');\n }\n }\n }\n\n if (!erroneous) {\n const categoryGradeMax = parseFloat(categoryElement.dataset.grademax);\n if (categoryGradeMax !== totalGradeMax) {\n // The category grade max is not the same as the total grade max, so we need to update the category grade max.\n categoryElement.dataset.grademax = totalGradeMax;\n const relatedCategoryAggregationRow = document.querySelector(\n selectors.aggregationForCategory(categoryElement.dataset.category)\n );\n relatedCategoryAggregationRow.querySelector('.column-range').innerHTML = formatFloat(totalGradeMax, 2, 2);\n\n const parentCategory = document.querySelector(selectors.categoryByIdentifier(categoryElement.dataset.parentCategory));\n if (parentCategory && (parseInt(parentCategory.dataset.aggregation) === grade.aggregation.sum)) {\n recalculateNaturalWeights(parentCategory);\n }\n }\n }\n};\n\n/**\n * Formats a floating-point number as a string with the specified number of decimal places.\n * Unnecessary trailing zeros are removed up to the specified minimum number of decimal places.\n *\n * @param {number} number The float value to be formatted.\n * @param {number} [decimalPoints=3] The number of decimal places to use.\n * @param {number} [minDecimals=1] The minimum number of decimal places to use.\n * @returns {string} The formatted weight value with the specified decimal places.\n */\nconst formatFloat = (number, decimalPoints = 3, minDecimals = 1) => {\n return number.toFixed(decimalPoints)\n .replace(new RegExp(`0{0,${decimalPoints - minDecimals}}$`), '')\n .replace('.', decimalSeparator);\n};\n\n/**\n * Parses a weight string and returns a normalized float value.\n *\n * @param {string} weightString The weight as a string, possibly with localized formatting.\n * @returns {number} The parsed weight as a float. If parsing fails, returns 0.\n */\nconst parseWeight = (weightString) => {\n const normalizedWeightString = weightString.replace(decimalSeparator, '.');\n return isNaN(Number(normalizedWeightString)) ? 0 : parseFloat(normalizedWeightString || 0);\n};\n\n/**\n * Initializes the weight management module with optional configuration.\n *\n * @param {string} decSep The character used as the decimal separator for number formatting.\n * @param {boolean} oldCalculation A flag indicating whether to use the old (pre MDL-49257) extra credit calculation.\n */\nexport const init = (decSep, oldCalculation) => {\n decimalSeparator = decSep;\n oldExtraCreditCalculation = oldCalculation;\n prefetchStrings('core_grades', ['erroroverweight', 'errorunderweight']);\n\n document.addEventListener('change', e => {\n // Update the weights of all grade items in the category when the weight of any grade item in the category is changed.\n if (e.target.matches(selectors.weightOverrideInput) || e.target.matches(selectors.weightOverrideCheckbox)) {\n // The following is named gradeItemRow, but it may also be a row that's representing a grade category.\n // It's ok because it serves as the categories associated grade item in our calculations.\n const gradeItemRow = e.target.closest('tr');\n const categoryElement = document.querySelector(selectors.categoryByIdentifier(gradeItemRow.dataset.parentCategory));\n\n // This is only required if we are using natural weights.\n if (parseInt(categoryElement.dataset.aggregation) === grade.aggregation.sum) {\n const weightElement = gradeItemRow.querySelector(selectors.weightOverrideInput);\n weightElement.value = formatFloat(Math.max(0, parseWeight(weightElement.value)));\n recalculateNaturalWeights(categoryElement);\n }\n }\n });\n\n document.addEventListener('submit', e => {\n // If the form is being submitted, then we need to ensure that the weight input fields are all set to\n // a valid value.\n if (e.target.matches('#gradetreeform')) {\n const firstInvalidWeightInput = e.target.querySelector('input.is-invalid');\n if (firstInvalidWeightInput) {\n const firstFocusableInvalidWeightInput = e.target.querySelector('input.is-invalid:enabled');\n if (firstFocusableInvalidWeightInput) {\n firstFocusableInvalidWeightInput.focus();\n } else {\n firstInvalidWeightInput.scrollIntoView({block: 'center'});\n }\n e.preventDefault();\n }\n }\n });\n};\n"],"names":["selectors","category","identifier","grade","sum","decimalSeparator","oldExtraCreditCalculation","recalculateNaturalWeights","categoryElement","childElements","document","querySelectorAll","dataset","totalGradeMax","totalOverriddenWeight","totalOverriddenGradeMax","automaticGradeItemsPresent","requiresNormalising","erroneous","overrideArray","childElement","weightInput","querySelector","weightCheckbox","itemWeight","parseWeight","value","itemAggregationCoefficient","parseInt","aggregationcoef","itemGradeMax","parseFloat","grademax","itemid","extraCredit","weight","weightOverride","checked","normaliseTotal","overriddenTotal","gradeItemDetail","Object","values","totalNonOverriddenGradeMax","classList","remove","errorArea","closest","textContent","formatFloat","error","then","errorString","add","innerHTML","parentCategory","aggregation","number","decimalPoints","minDecimals","toFixed","replace","RegExp","weightString","normalizedWeightString","isNaN","Number","decSep","oldCalculation","addEventListener","e","target","matches","gradeItemRow","weightElement","Math","max","firstInvalidWeightInput","firstFocusableInvalidWeightInput","focus","scrollIntoView","block","preventDefault"],"mappings":";;;;;;;;MA+BMA,iCACsB,kDADtBA,8BAEmB,sCAFnBA,iCAGsBC,kDAA6CA,eAHnED,6BAIkBC,6CAAwCA,eAJ1DD,+BAKoBE,iDAA4CA,iBAehEC,kBACW,CACTC,IAAK,QASTC,iBAQAC,gCASEC,0BAA6BC,wBACzBC,cAAgBC,SAASC,iBAAiBX,6BAA6BQ,gBAAgBI,QAAQX,eAGjGY,cAAgB,EAGhBC,sBAAwB,EACxBC,wBAA0B,EAG1BC,4BAA6B,EAE7BC,qBAAsB,EAGtBC,WAAY,QAGVC,cAAgB,OAEjB,MAAMC,gBAAgBX,cAAe,OAChCY,YAAcD,aAAaE,cAActB,+BACzCuB,eAAiBH,aAAaE,cAActB,sCAQ7CqB,2BAICG,WAAaC,YAAYJ,YAAYK,OACrCC,2BAA6BC,SAASR,aAAaR,QAAQiB,iBAC3DC,aAAeC,WAAWX,aAAaR,QAAQoB,UAGrDb,cAAcC,aAAaR,QAAQqB,QAAU,CACzCC,YAAaP,2BACbQ,OAAQX,WACRY,eAAgBb,eAAec,SAK9Bd,eAAec,SAA0C,IAA/BV,6BAC3BX,4BAA6B,GAG7BW,2BAA6B,IAGtBJ,eAAec,SAAWb,YAAc,IAKnDX,eAAiBiB,aACbP,eAAec,UACfvB,uBAAyBU,WACzBT,yBAA2Be,oBAK/BQ,eAAiB,EAGjBC,gBAAkB,MAEjB,MAAMC,mBAAmBC,OAAOC,OAAOvB,gBAEnCqB,gBAAgBN,aAAeM,gBAAgBL,OAAS,IACzDG,gBAAkBE,gBAAgBL,QAGlCK,gBAAgBJ,iBAAmBI,gBAAgBN,aAAeM,gBAAgBL,OAAS,IAE3FI,iBAAmBC,gBAAgBL,QAGvCI,gBAAkB,MAElBtB,qBAAsB,EAEtBqB,eAAiBC,uBAGfI,2BAA6B9B,cAAgBE,4BAE9C,MAAMK,gBAAgBX,cAAe,OAChCY,YAAcD,aAAaE,cAActB,+BACzCuB,eAAiBH,aAAaE,cAActB,kCAC5C2B,2BAA6BC,SAASR,aAAaR,QAAQiB,iBAC3DC,aAAeC,WAAWX,aAAaR,QAAQoB,cAEhDX,qBAEE,IAAKf,2BAA6BqB,2BAA6B,GAAKJ,eAAec,iBAO1FhB,YAAYuB,UAAUC,OAAO,oBACvBC,UAAYzB,YAAY0B,QAAQ,MAAMzB,cAAc,wBAC1DwB,UAAUE,YAAc,IAEnB1C,2BAA6BqB,2BAA6B,IAAMJ,eAAec,QAEhFhB,YAAYK,MAAQb,cAAgBoC,YAA2B,IAAfnB,aAAqBjB,eAAiB,OACnF,GAAKU,eAAec,SAUpB,KAAMrB,4BAAiD,MAAnBsB,gBAA2BrB,qBAC9DE,cAAcC,aAAaR,QAAQqB,QAAQE,OAAS,KACpDhB,cAAcC,aAAaR,QAAQqB,QAAQE,OAAS,IACpDd,YAAYK,MAAQuB,YAAY,IAIb,IAAnBX,gBAAsB,CACtBpB,WAAY,QACNgC,MAAQZ,eAAiB,IAAM,kBAAoB,sCAE/CY,MAAO,eAAeC,MAAMC,cAClCN,UAAUE,YAAcI,eAE5B/B,YAAYuB,UAAUS,IAAI,oBApB1BhC,YAAYK,MAAQuB,YAFpBnC,uBAAyB,KAAsC,IAA/B6B,4BAAqD,IAAjBb,aAEpC,EAICA,aAAea,4BAA+B,IAAM7B,4BAqB5FI,UAAW,IACaa,WAAWvB,gBAAgBI,QAAQoB,YACnCnB,cAAe,CAEpCL,gBAAgBI,QAAQoB,SAAWnB,cACGH,SAASY,cAC3CtB,iCAAiCQ,gBAAgBI,QAAQX,WAE/BqB,cAAc,iBAAiBgC,UAAYL,YAAYpC,cAAe,EAAG,SAEjG0C,eAAiB7C,SAASY,cAActB,+BAA+BQ,gBAAgBI,QAAQ2C,iBACjGA,gBAAmB3B,SAAS2B,eAAe3C,QAAQ4C,eAAiBrD,kBAAkBC,KACtFG,0BAA0BgD,mBAepCN,YAAc,SAACQ,YAAQC,qEAAgB,EAAGC,mEAAc,SACnDF,OAAOG,QAAQF,eACjBG,QAAQ,IAAIC,qBAAcJ,cAAgBC,mBAAkB,IAC5DE,QAAQ,IAAKxD,mBAShBoB,YAAesC,qBACXC,uBAAyBD,aAAaF,QAAQxD,iBAAkB,YAC/D4D,MAAMC,OAAOF,yBAA2B,EAAIjC,WAAWiC,wBAA0B,kBASxE,CAACG,OAAQC,kBACzB/D,iBAAmB8D,OACnB7D,0BAA4B8D,6CACZ,cAAe,CAAC,kBAAmB,qBAEnD1D,SAAS2D,iBAAiB,UAAUC,OAE5BA,EAAEC,OAAOC,QAAQxE,gCAAkCsE,EAAEC,OAAOC,QAAQxE,kCAAmC,OAGjGyE,aAAeH,EAAEC,OAAOxB,QAAQ,MAChCvC,gBAAkBE,SAASY,cAActB,+BAA+ByE,aAAa7D,QAAQ2C,oBAG/F3B,SAASpB,gBAAgBI,QAAQ4C,eAAiBrD,kBAAkBC,IAAK,OACnEsE,cAAgBD,aAAanD,cAActB,+BACjD0E,cAAchD,MAAQuB,YAAY0B,KAAKC,IAAI,EAAGnD,YAAYiD,cAAchD,SACxEnB,0BAA0BC,sBAKtCE,SAAS2D,iBAAiB,UAAUC,OAG5BA,EAAEC,OAAOC,QAAQ,kBAAmB,OAC9BK,wBAA0BP,EAAEC,OAAOjD,cAAc,uBACnDuD,wBAAyB,OACnBC,iCAAmCR,EAAEC,OAAOjD,cAAc,4BAC5DwD,iCACAA,iCAAiCC,QAEjCF,wBAAwBG,eAAe,CAACC,MAAO,WAEnDX,EAAEY"} amd/build/edittree_index.min.js.map 0000604 00000037103 15062070556 0013302 0 ustar 00 {"version":3,"file":"edittree_index.min.js","sources":["../src/edittree_index.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Enhance the gradebook tree setup with various facilities.\n *\n * @module core_grades/edittree_index\n * @copyright 2016 Andrew Nicols <andrew@nicols.co.uk>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport storage from 'core/localstorage';\nimport {addIconToContainer} from 'core/loadingicon';\nimport Notification from 'core/notification';\nimport Pending from 'core/pending';\n\nconst SELECTORS = {\n CATEGORY_TOGGLE: '.toggle-category',\n GRADEBOOK_SETUP_TABLE: '.setup-grades',\n WEIGHT_OVERRIDE_CHECKBOX: '.weightoverride',\n BULK_MOVE_SELECT: '#menumoveafter',\n BULK_MOVE_INPUT: '#bulkmoveinput',\n GRADEBOOK_SETUP_WRAPPER: '.gradetree-wrapper',\n GRADEBOOK_SETUP_BOX: '.gradetreebox'\n};\n\n/**\n * Register related event listeners.\n *\n * @method registerListenerEvents\n * @param {int} courseId The ID of course.\n * @param {int} userId The ID of the current logged user.\n */\nconst registerListenerEvents = (courseId, userId) => {\n\n document.addEventListener('change', e => {\n // Toggle the availability of the weight input field based on the changed state (checked/unchecked) of the\n // related checkbox element.\n if (e.target.matches(SELECTORS.WEIGHT_OVERRIDE_CHECKBOX)) {\n toggleWeightInput(e.target);\n }\n // Submit the bulk move form when the selected option in the bulk move select element has been changed.\n if (e.target.matches(SELECTORS.BULK_MOVE_SELECT)) {\n submitBulkMoveForm(e.target);\n }\n });\n\n const gradebookSetup = document.querySelector(SELECTORS.GRADEBOOK_SETUP_TABLE);\n gradebookSetup.addEventListener('click', e => {\n const toggle = e.target.closest(SELECTORS.CATEGORY_TOGGLE);\n // Collapse or expand the grade category when the visibility toggle button is activated.\n if (toggle) {\n e.preventDefault();\n toggleCategory(toggle, courseId, userId, true);\n }\n });\n};\n\n/**\n * Toggle the weight input field based on its checkbox.\n *\n * @method toggleWeightInput\n * @param {object} weightOverrideCheckbox The weight override checkbox element.\n */\nconst toggleWeightInput = (weightOverrideCheckbox) => {\n const row = weightOverrideCheckbox.closest('tr');\n const itemId = row.dataset.itemid;\n const weightOverrideInput = row.querySelector(`input[name=\"weight_${itemId}\"]`);\n weightOverrideInput.disabled = !weightOverrideCheckbox.checked;\n};\n\n/**\n * Submit the bulk move form.\n *\n * @method toggleWeightInput\n * @param {object} bulkMoveSelect The bulk move select element.\n */\nconst submitBulkMoveForm = (bulkMoveSelect) => {\n const form = bulkMoveSelect.closest('form');\n const bulkMoveInput = form.querySelector(SELECTORS.BULK_MOVE_INPUT);\n bulkMoveInput.value = 1;\n form.submit();\n};\n\n/**\n * Method that collapses all relevant grade categories based on the locally stored state of collapsed grade categories\n * for a given user.\n *\n * @method collapseGradeCategories\n * @param {int} courseId The ID of course.\n * @param {int} userId The ID of the current logged user.\n */\nconst collapseGradeCategories = (courseId, userId) => {\n const gradebookSetup = document.querySelector(SELECTORS.GRADEBOOK_SETUP_TABLE);\n const storedCollapsedCategories = storage.get(`core_grade_collapsedgradecategories_${courseId}_${userId}`);\n\n if (storedCollapsedCategories) {\n // Fetch all grade categories that are locally stored as collapsed and re-apply the collapse action.\n const collapsedCategories = JSON.parse(storedCollapsedCategories);\n\n collapsedCategories.forEach((category) => {\n const categoryToggleElement =\n gradebookSetup.querySelector(`${SELECTORS.CATEGORY_TOGGLE}[data-category=\"${category}\"`);\n if (categoryToggleElement) {\n toggleCategory(categoryToggleElement, courseId, userId, false);\n }\n });\n }\n};\n\n/**\n * Method that updates the locally stored state of collapsed grade categories based on a performed toggle action on a\n * given grade category.\n *\n * @method updateCollapsedCategoriesStoredState\n * @param {string} category The category to be added or removed from the collapsed grade categories local storage.\n * @param {int} courseId The ID of course.\n * @param {int} userId The ID of the current logged user.\n * @param {boolean} isCollapsing Whether the category is being collapsed or not.\n */\nconst updateCollapsedCategoriesStoredState = (category, courseId, userId, isCollapsing) => {\n const currentStoredCollapsedCategories = storage.get(`core_grade_collapsedgradecategories_${courseId}_${userId}`);\n let collapsedCategories = currentStoredCollapsedCategories ?\n JSON.parse(currentStoredCollapsedCategories) : [];\n\n if (isCollapsing) {\n collapsedCategories.push(category);\n } else {\n collapsedCategories = collapsedCategories.filter(cat => cat !== category);\n }\n storage.set(`core_grade_collapsedgradecategories_${courseId}_${userId}`, JSON.stringify(collapsedCategories));\n};\n\n/**\n * Method that handles the grade category toggle action.\n *\n * @method toggleCategory\n * @param {object} toggleElement The category toggle node that was clicked.\n * @param {int} courseId The ID of course.\n * @param {int} userId The ID of the current logged user.\n * @param {boolean} storeCollapsedState Whether to store (local storage) the state of collapsed grade categories.\n */\nconst toggleCategory = (toggleElement, courseId, userId, storeCollapsedState) => {\n const target = toggleElement.dataset.target;\n const category = toggleElement.dataset.category;\n // Whether the toggle action is collapsing the category or not.\n const isCollapsing = toggleElement.getAttribute('aria-expanded') === \"true\";\n const gradebookSetup = toggleElement.closest(SELECTORS.GRADEBOOK_SETUP_TABLE);\n // Find all targeted 'children' rows of the toggled category.\n const targetRows = gradebookSetup.querySelectorAll(target);\n // Find the maximum grade cell in the grade category that is being collapsed/expanded.\n const toggleElementRow = toggleElement.closest('tr');\n const maxGradeCell = toggleElementRow.querySelector('.column-range');\n\n if (isCollapsing) {\n toggleElement.setAttribute('aria-expanded', 'false');\n // Update the 'data-target' of the toggle category node to make sure that when we perform another toggle action\n // to expand this category we only target rows which have been hidden by this category toggle action.\n toggleElement.dataset.target = `[data-hidden-by='${category}']`;\n if (maxGradeCell) {\n const relatedCategoryAggregationRow = gradebookSetup.querySelector(`[data-aggregationforcategory='${category}']`);\n maxGradeCell.innerHTML = relatedCategoryAggregationRow.querySelector('.column-range').innerHTML;\n }\n } else {\n toggleElement.setAttribute('aria-expanded', 'true');\n // Update the 'data-target' of the toggle category node to make sure that when we perform another toggle action\n // to collapse this category we only target rows which are children of this category and are not currently hidden.\n toggleElement.dataset.target = `.${category}[data-hidden='false']`;\n if (maxGradeCell) {\n maxGradeCell.innerHTML = '';\n }\n }\n // If explicitly instructed, update accordingly the locally stored state of collapsed categories based on the\n // toggle action performed on the given grade category.\n if (storeCollapsedState) {\n updateCollapsedCategoriesStoredState(category, courseId, userId, isCollapsing);\n }\n\n // Loop through all targeted child row elements and update the required data attributes to either hide or show\n // them depending on the toggle action (collapsing or expanding).\n targetRows.forEach((row) => {\n if (isCollapsing) {\n row.dataset.hidden = 'true';\n row.dataset.hiddenBy = category;\n } else {\n row.dataset.hidden = 'false';\n row.dataset.hiddenBy = '';\n }\n });\n\n // Since the user report is presented in an HTML table, rowspans are used under each category to create a visual\n // hierarchy between categories and grading items. When expanding or collapsing a category we need to also update\n // (subtract or add) the rowspan values associated to each parent category row to preserve the correct visual\n // hierarchy in the table.\n updateParentCategoryRowspans(toggleElement, targetRows.length);\n};\n\n/**\n * Method that updates the rowspan value of all 'parent' category rows of a given category node.\n *\n * @method updateParentCategoryRowspans\n * @param {object} toggleElement The category toggle node that was clicked.\n * @param {int} num The number we want to add or subtract from the rowspan value of the 'parent' category row elements.\n */\nconst updateParentCategoryRowspans = (toggleElement, num) => {\n const gradebookSetup = toggleElement.closest(SELECTORS.GRADEBOOK_SETUP_TABLE);\n // Get the row element which contains the category toggle node.\n const rowElement = toggleElement.closest('tr');\n\n // Loop through the class list of the toggle category row element.\n // The list contains classes which identify all parent categories of the toggled category.\n rowElement.classList.forEach((className) => {\n // Find the toggle node of the 'parent' category that is identified by the given class name.\n const parentCategoryToggleElement = gradebookSetup.querySelector(`[data-target=\".${className}[data-hidden='false']\"`);\n if (parentCategoryToggleElement) {\n // Get the row element which contains the parent category toggle node.\n const categoryRowElement = parentCategoryToggleElement.closest('tr');\n // Find the rowspan element associated to this parent category.\n const categoryRowSpanElement = categoryRowElement.nextElementSibling.querySelector('[rowspan]');\n\n // Depending on whether the toggle action has expanded or collapsed the category, either add or\n // subtract from the 'parent' category rowspan.\n if (toggleElement.getAttribute('aria-expanded') === \"true\") {\n categoryRowSpanElement.rowSpan = categoryRowSpanElement.rowSpan + num;\n } else { // The category has been collapsed.\n categoryRowSpanElement.rowSpan = categoryRowSpanElement.rowSpan - num;\n }\n }\n });\n};\n\n/**\n * Initialize module.\n *\n * @method init\n * @param {int} courseId The ID of course.\n * @param {int} userId The ID of the current logged user.\n */\nexport const init = (courseId, userId) => {\n const pendingPromise = new Pending();\n const gradebookSetupBox = document.querySelector(SELECTORS.GRADEBOOK_SETUP_BOX);\n // Display a loader while the relevant grade categories are being re-collapsed on page load (based on the locally\n // stored state for the given user).\n addIconToContainer(gradebookSetupBox).then((loader) => {\n setTimeout(() => {\n collapseGradeCategories(courseId, userId);\n // Once the grade categories have been re-collapsed, remove the loader and display the Gradebook setup content.\n loader.remove();\n document.querySelector(SELECTORS.GRADEBOOK_SETUP_WRAPPER).classList.remove('d-none');\n pendingPromise.resolve();\n }, 150);\n return;\n }).fail(Notification.exception);\n\n registerListenerEvents(courseId, userId);\n};\n"],"names":["SELECTORS","toggleWeightInput","weightOverrideCheckbox","row","closest","itemId","dataset","itemid","querySelector","disabled","checked","submitBulkMoveForm","bulkMoveSelect","form","value","submit","toggleCategory","toggleElement","courseId","userId","storeCollapsedState","target","category","isCollapsing","getAttribute","gradebookSetup","targetRows","querySelectorAll","maxGradeCell","setAttribute","relatedCategoryAggregationRow","innerHTML","currentStoredCollapsedCategories","storage","get","collapsedCategories","JSON","parse","push","filter","cat","set","stringify","updateCollapsedCategoriesStoredState","forEach","hidden","hiddenBy","updateParentCategoryRowspans","length","num","classList","className","parentCategoryToggleElement","categoryRowSpanElement","nextElementSibling","rowSpan","pendingPromise","Pending","gradebookSetupBox","document","then","loader","setTimeout","storedCollapsedCategories","categoryToggleElement","collapseGradeCategories","remove","resolve","fail","Notification","exception","addEventListener","e","matches","toggle","preventDefault","registerListenerEvents"],"mappings":";;;;;;;0OA4BMA,0BACe,mBADfA,gCAEqB,gBAFrBA,mCAGwB,kBAHxBA,2BAIgB,iBAJhBA,0BAKe,iBALfA,kCAMuB,qBANvBA,8BAOmB,gBAyCnBC,kBAAqBC,+BACjBC,IAAMD,uBAAuBE,QAAQ,MACrCC,OAASF,IAAIG,QAAQC,OACCJ,IAAIK,2CAAoCH,cAChDI,UAAYP,uBAAuBQ,SASrDC,mBAAsBC,uBAClBC,KAAOD,eAAeR,QAAQ,QACdS,KAAKL,cAAcR,2BAC3Bc,MAAQ,EACtBD,KAAKE,UA6DHC,eAAiB,CAACC,cAAeC,SAAUC,OAAQC,6BAC/CC,OAASJ,cAAcX,QAAQe,OAC/BC,SAAWL,cAAcX,QAAQgB,SAEjCC,aAA+D,SAAhDN,cAAcO,aAAa,iBAC1CC,eAAiBR,cAAcb,QAAQJ,iCAEvC0B,WAAaD,eAAeE,iBAAiBN,QAG7CO,aADmBX,cAAcb,QAAQ,MACTI,cAAc,oBAEhDe,iBACAN,cAAcY,aAAa,gBAAiB,SAG5CZ,cAAcX,QAAQe,kCAA6BC,eAC/CM,aAAc,OACRE,8BAAgCL,eAAejB,sDAA+Cc,gBACpGM,aAAaG,UAAYD,8BAA8BtB,cAAc,iBAAiBuB,gBAG1Fd,cAAcY,aAAa,gBAAiB,QAG5CZ,cAAcX,QAAQe,kBAAaC,kCAC/BM,eACAA,aAAaG,UAAY,IAK7BX,qBAtDqC,EAACE,SAAUJ,SAAUC,OAAQI,sBAChES,iCAAmCC,sBAAQC,kDAA2ChB,qBAAYC,aACpGgB,oBAAsBH,iCACtBI,KAAKC,MAAML,kCAAoC,GAE/CT,aACAY,oBAAoBG,KAAKhB,UAEzBa,oBAAsBA,oBAAoBI,QAAOC,KAAOA,MAAQlB,iCAE5DmB,kDAA2CvB,qBAAYC,QAAUiB,KAAKM,UAAUP,uBA6CpFQ,CAAqCrB,SAAUJ,SAAUC,OAAQI,cAKrEG,WAAWkB,SAASzC,MACZoB,cACApB,IAAIG,QAAQuC,OAAS,OACrB1C,IAAIG,QAAQwC,SAAWxB,WAEvBnB,IAAIG,QAAQuC,OAAS,QACrB1C,IAAIG,QAAQwC,SAAW,OAQ/BC,6BAA6B9B,cAAeS,WAAWsB,SAUrDD,6BAA+B,CAAC9B,cAAegC,aAC3CxB,eAAiBR,cAAcb,QAAQJ,iCAE1BiB,cAAcb,QAAQ,MAI9B8C,UAAUN,SAASO,kBAEpBC,4BAA8B3B,eAAejB,uCAAgC2C,yCAC/EC,4BAA6B,OAIvBC,uBAFqBD,4BAA4BhD,QAAQ,MAEbkD,mBAAmB9C,cAAc,aAI/B,SAAhDS,cAAcO,aAAa,iBAC3B6B,uBAAuBE,QAAUF,uBAAuBE,QAAUN,IAElEI,uBAAuBE,QAAUF,uBAAuBE,QAAUN,uBAa9D,CAAC/B,SAAUC,gBACrBqC,eAAiB,IAAIC,iBACrBC,kBAAoBC,SAASnD,cAAcR,mEAG9B0D,mBAAmBE,MAAMC,SACxCC,YAAW,KAxJa,EAAC5C,SAAUC,gBACjCM,eAAiBkC,SAASnD,cAAcR,iCACxC+D,0BAA4B9B,sBAAQC,kDAA2ChB,qBAAYC,SAE7F4C,2BAE4B3B,KAAKC,MAAM0B,2BAEnBnB,SAAStB,iBACnB0C,sBACFvC,eAAejB,wBAAiBR,qDAA4CsB,eAC5E0C,uBACAhD,eAAegD,sBAAuB9C,SAAUC,QAAQ,OA6I5D8C,CAAwB/C,SAAUC,QAElC0C,OAAOK,SACPP,SAASnD,cAAcR,mCAAmCkD,UAAUgB,OAAO,UAC3EV,eAAeW,YAChB,QAEJC,KAAKC,sBAAaC,WA3NM,EAACpD,SAAUC,UAEtCwC,SAASY,iBAAiB,UAAUC,IAG5BA,EAAEnD,OAAOoD,QAAQzE,qCACjBC,kBAAkBuE,EAAEnD,QAGpBmD,EAAEnD,OAAOoD,QAAQzE,6BACjBW,mBAAmB6D,EAAEnD,WAINsC,SAASnD,cAAcR,iCAC/BuE,iBAAiB,SAASC,UAC/BE,OAASF,EAAEnD,OAAOjB,QAAQJ,2BAE5B0E,SACAF,EAAEG,iBACF3D,eAAe0D,OAAQxD,SAAUC,QAAQ,QAyMjDyD,CAAuB1D,SAAUC"} report/outcomes/lang/en/gradereport_outcomes.php 0000604 00000002566 15062070556 0016220 0 ustar 00 <?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/>. /** * Strings for component 'gradereport_outcomes', language 'en' * * @package gradereport_outcomes * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ $string['addoutcome'] = 'Add an outcome'; $string['courseoutcomes'] = 'Course outcomes'; $string['coursespecoutcome'] = 'Course outcomes'; $string['eventgradereportviewed'] = 'Grade outcomes report viewed'; $string['pluginname'] = 'Outcomes report'; $string['privacy:metadata'] = 'The Grade outcomes report only shows data stored in other locations.'; $string['outcomes:view'] = 'View outcomes report'; $string['usedgradeitem'] = 'Number of grade items'; report/outcomes/classes/privacy/provider.php 0000604 00000003013 15062070556 0015371 0 ustar 00 <?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/>. /** * Privacy Subsystem implementation for gradereport_outcomes. * * @package gradereport_outcomes * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_outcomes\privacy; defined('MOODLE_INTERNAL') || die(); /** * Privacy Subsystem for gradereport_outcomes implementing null_provider. * * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class provider implements \core_privacy\local\metadata\null_provider { /** * Get the language string identifier with the component's language * file to explain why this plugin stores no data. * * @return string */ public static function get_reason() : string { return 'privacy:metadata'; } } report/outcomes/classes/event/grade_report_viewed.php 0000604 00000002730 15062070556 0017230 0 ustar 00 <?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/>. /** * Outcomes report viewed event. * * @package gradereport_outcomes * @copyright 2014 Adrian Greeve <adrian@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_outcomes\event; defined('MOODLE_INTERNAL') || die(); /** * Outcomes report viewed event class. * * @package gradereport_outcomes * @since Moodle 2.8 * @copyright 2014 Adrian Greeve <adrian@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class grade_report_viewed extends \core\event\grade_report_viewed { /** * Returns localised general event name. * * @return string */ public static function get_name() { return get_string('eventgradereportviewed', 'gradereport_outcomes'); } } report/outcomes/db/access.php 0000604 00000002364 15062070556 0012263 0 ustar 00 <?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/>. /** * Defines capabilities for the outcomes report * * @package gradereport_outcomes * @copyright 2007 Petr Skoda * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); $capabilities = array( 'gradereport/outcomes:view' => array( 'riskbitmask' => RISK_PERSONAL, 'captype' => 'read', 'contextlevel' => CONTEXT_COURSE, 'archetypes' => array( 'teacher' => CAP_ALLOW, 'editingteacher' => CAP_ALLOW, 'manager' => CAP_ALLOW ) ) ); report/outcomes/index.php 0000604 00000016372 15062070556 0011550 0 ustar 00 <?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/>. /** * The gradebook outcomes report * * @package gradereport_outcomes * @copyright 2007 Nicolas Connault * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ include_once('../../../config.php'); require_once($CFG->libdir . '/gradelib.php'); require_once $CFG->dirroot.'/grade/lib.php'; $courseid = required_param('id', PARAM_INT); // course id $PAGE->set_url('/grade/report/outcomes/index.php', array('id'=>$courseid)); if (!$course = $DB->get_record('course', array('id' => $courseid))) { throw new \moodle_exception('invalidcourseid'); } require_login($course); $context = context_course::instance($course->id); require_capability('gradereport/outcomes:view', $context); if (empty($CFG->enableoutcomes)) { redirect(course_get_url($course), get_string('outcomesdisabled', 'core_grades')); } // First make sure we have proper final grades. grade_regrade_final_grades_if_required($course); // Grab all outcomes used in course. $report_info = array(); $outcomes = grade_outcome::fetch_all_available($courseid); // Will exclude grades of suspended users if required. $defaultgradeshowactiveenrol = !empty($CFG->grade_report_showonlyactiveenrol); $showonlyactiveenrol = get_user_preferences('grade_report_showonlyactiveenrol', $defaultgradeshowactiveenrol); $showonlyactiveenrol = $showonlyactiveenrol || !has_capability('moodle/course:viewsuspendedusers', $context); if ($showonlyactiveenrol) { $suspendedusers = get_suspended_userids($context); } // Get grade_items that use each outcome. foreach ($outcomes as $outcomeid => $outcome) { $report_info[$outcomeid]['items'] = $DB->get_records_select('grade_items', "outcomeid = ? AND courseid = ?", array($outcomeid, $courseid)); $report_info[$outcomeid]['outcome'] = $outcome; // Get average grades for each item. if (is_array($report_info[$outcomeid]['items'])) { foreach ($report_info[$outcomeid]['items'] as $itemid => $item) { $params = array(); $hidesuspendedsql = ''; if ($showonlyactiveenrol && !empty($suspendedusers)) { list($notinusers, $params) = $DB->get_in_or_equal($suspendedusers, SQL_PARAMS_QM, null, false); $hidesuspendedsql = ' AND userid ' . $notinusers; } $params = array_merge(array($itemid), $params); $sql = "SELECT itemid, AVG(finalgrade) AS avg, COUNT(finalgrade) AS count FROM {grade_grades} WHERE itemid = ?". $hidesuspendedsql. " GROUP BY itemid"; $info = $DB->get_records_sql($sql, $params); if (!$info) { unset($report_info[$outcomeid]['items'][$itemid]); continue; } else { $info = reset($info); $avg = round($info->avg, 2); $count = $info->count; } $report_info[$outcomeid]['items'][$itemid]->avg = $avg; $report_info[$outcomeid]['items'][$itemid]->count = $count; } } } $html = '<table class="generaltable boxaligncenter" width="90%" cellspacing="1" cellpadding="5" summary="Outcomes Report">' . "\n"; $html .= '<tr><th class="header c0" scope="col">' . get_string('outcomeshortname', 'grades') . '</th>'; $html .= '<th class="header c1" scope="col">' . get_string('courseavg', 'grades') . '</th>'; $html .= '<th class="header c2" scope="col">' . get_string('sitewide', 'grades') . '</th>'; $html .= '<th class="header c3" scope="col">' . get_string('activities', 'grades') . '</th>'; $html .= '<th class="header c4" scope="col">' . get_string('average', 'grades') . '</th>'; $html .= '<th class="header c5" scope="col">' . get_string('numberofgrades', 'grades') . '</th></tr>' . "\n"; $row = 0; foreach ($report_info as $outcomeid => $outcomedata) { $rowspan = count($outcomedata['items']); // If there are no items for this outcome, rowspan will equal 0, which is not good. if ($rowspan == 0) { $rowspan = 1; } $shortname_html = '<tr class="r' . $row . '"><td class="cell c0" rowspan="' . $rowspan . '">' . $outcomedata['outcome']->shortname . "</td>\n"; $sitewide = get_string('no'); if (empty($outcomedata['outcome']->courseid)) { $sitewide = get_string('yes'); } $sitewide_html = '<td class="cell c2" rowspan="' . $rowspan . '">' . $sitewide . "</td>\n"; $outcomedata['outcome']->sum = 0; $scale = new grade_scale(array('id' => $outcomedata['outcome']->scaleid), false); $print_tr = false; $items_html = ''; if (!empty($outcomedata['items'])) { foreach ($outcomedata['items'] as $itemid => $item) { if ($print_tr) { $row++; $items_html .= "<tr class=\"r$row\">\n"; } $grade_item = new grade_item($item, false); if ($item->itemtype == 'mod') { $cm = get_coursemodule_from_instance($item->itemmodule, $item->iteminstance, $item->courseid); $itemname = '<a href="'.$CFG->wwwroot.'/mod/'.$item->itemmodule.'/view.php?id='.$cm->id.'">'.format_string($cm->name, true, $cm->course).'</a>'; } else { $itemname = $grade_item->get_name(); } $outcomedata['outcome']->sum += $item->avg; $gradehtml = $scale->get_nearest_item($item->avg); $items_html .= "<td class=\"cell c3\">$itemname</td>" . "<td class=\"cell c4\">$gradehtml ($item->avg)</td>" . "<td class=\"cell c5\">$item->count</td></tr>\n"; $print_tr = true; } } else { $items_html .= "<td class=\"cell c3\"> - </td><td class=\"cell c4\"> - </td><td class=\"cell c5\"> 0 </td></tr>\n"; } // Calculate outcome average. if (is_array($outcomedata['items'])) { $count = count($outcomedata['items']); if ($count > 0) { $avg = $outcomedata['outcome']->sum / $count; } else { $avg = $outcomedata['outcome']->sum; } $avg_html = $scale->get_nearest_item($avg) . " (" . round($avg, 2) . ")\n"; } else { $avg_html = ' - '; } $outcomeavg_html = '<td class="cell c1" rowspan="' . $rowspan . '">' . $avg_html . "</td>\n"; $html .= $shortname_html . $outcomeavg_html . $sitewide_html . $items_html; $row++; } $html .= '</table>'; print_grade_page_head($courseid, 'report', 'outcomes'); echo $html; $event = \gradereport_outcomes\event\grade_report_viewed::create( array( 'context' => $context, 'courseid' => $courseid, ) ); $event->trigger(); echo $OUTPUT->footer(); report/outcomes/version.php 0000604 00000002301 15062070556 0012111 0 ustar 00 <?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/>. /** * Version details for the outcomes report * * @package gradereport_outcomes * @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); $plugin->version = 2023100900; // The current plugin version (Date: YYYYMMDDXX). $plugin->requires = 2023100400; // Requires this Moodle version. $plugin->component = 'gradereport_outcomes'; // Full name of the plugin (used for diagnostics) report/upgrade.txt 0000604 00000012006 15062070556 0010250 0 ustar 00 This files describes API changes in /grade/report/*, information provided here is intended especially for developers. === 4.3 === * The load_users() method in the gradereport_singleview\local\screen class has been deprecated. Please use get_gradable_users() instead. * The \gradereport_singleview\local\screen\select has been deprecated. This class generates the output for the initial view to select the single view item type (user or grade item) which is no longer actively used as we do not provide direct links to it. * The following reports now use the combobox search PHP & JS rather than defining their own: - gradereport_grader - gradereport_singleview - gradereport_user Each of these reports extend the base user, grade or group JS class in either core or core_grades so that they can define how their clickable links are generated. Any special handling of the search dropdowns should be done in the JS class "closest" to your plugin rather than in core_grades or the base search class itself. === 4.2 === * 'Show calculations' setting has been removed from grader report (link is moved to grade action menu) * 'Show activity icons' setting has been removed from grader report * The grade_report_grader:get_icons(), grade_report_grader:get_left_icons_row() and grade_report_grader:get_right_icons_row() functions have been deprecated and are not used anymore. * 'Show grade analysis icon' setting has been removed from grader report (link is moved to grade action menu) * 'Show locks' setting has been removed from grader report (link is moved to grade action menu) * 'Show show/hide icons' setting has been removed from grader report (link is moved to grade action menu) * 'Enable AJAX' interface has been deprecated for grader report * 'Quick feedback' interface has been deprecated for grader report * A new method grade_report::get_additional_context() is created to obtain links to other grade plugins report pages. It loops through all installed grade report plugins and checks if callback function gradereport_*_get_report_link is implemented in for given grade report plugin in the corresponding lib.php * The setting $CFG->grade_report_studentsperpage has been completely removed because it's not required anymore. This setting was used to set the default number of students displayed per page in the grader report. Now the default is set to 20. * The get_grade_item_id() function in behat_gradereport_grader.php has been deprecated. Please use behat_grades::get_grade_item_id() instead. * The grade_report::get_lang_string() has been deprecated. Please use get_string() instead. === 3.6 === * External function gradereport_user_external::get_grade_items now return the following information (only for course managers). - locked: Whether the grade item is locked. - gradeislocked: Whether the user grade is locked. - gradeisoverridden: Whether the user grade is overridden. === 3.2 === * External function gradereport_user_external::get_grades_table now has an optional groupid parameter. Is recommended to use this parameter in courses with separate groups or when the user requesting the report is in more than one group. === 2.9 === * Deprecating grade_report_grader:get_collapsing_icon. * A new web service function gradereport_user_get_grades_table has been added which will allow external system to retrieve grade information ready to be formatted as a table similar to the gradebook user report one. === 2.8.2 === * gradereport_singleview::__construct doesn't need groupid parameter anymore, so it was renamed to $unused. === 2.6.5, 2.7.2 === * The callback function grade_report_*_profilereport now takes one more parameter $viewasuser. This parameter is set to true when the report must be viewed as the user whose grades are being displayed. For instance, when a mentor/parent is viewing the report, they should see the same grades, not more, not less. When the setting is set to false (default), the capability checks, visibility and access levels are using the currently logged in user. === 2.6 === * grade_report_grader::get_toggles_html() and grade_report_grader::print_toggle() can not be used any more * class grade_report get_numusers($groups = true, $users = false) An extra parameter has been added to restrict count to those users being displayed * class grade_report_grader get_left_rows($displayaverages) A parameter has been added to indicate whether averages are applicable and should be displayed on the report * class grade_report_grader get_right_rows($displayaverages) A parameter has been added to indicate whether averages are applicable and should be displayed on the report * class grade_report_grader get_grade_table($displayaverages = false) A parameter has been added to indicate whether averages are applicable and should be displayed on the report === 2.3.5, 2.4.2 === * class_grade_report::showtotalsifcontainhidden has been switched from a single integer value to an array. The array keys are course IDs while the array values are the value of the course setting "report_overview_showtotalsifcontainhidden". report/lib.php 0000604 00000113700 15062070556 0007342 0 ustar 00 <?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; // 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 * @var stdClass $user */ public $user; /** * show course/category totals if they contain hidden items * @var array $showtotalsifcontainhidden */ public $showtotalsifcontainhidden = []; /** * To store a link to preferences page * @var string $preferences_page */ protected $preferences_page; /** * If the user is wanting to search for a particular user within searchable fields their needle will be placed here. * @var string $usersearch */ protected string $usersearch = ''; /** * If the user is wanting to show only one particular user their id will be placed here. * @var int $userid */ protected int $userid = -1; /** * Constructor. Sets local copies of user preferences and initialises grade_tree. * @param int $courseid * @param object $gpr grade plugin return tracking object * @param string $context * @param int $page The current page being viewed (when report is paged) */ public function __construct($courseid, $gpr, $context, $page=null) { global $CFG, $COURSE, $DB; if (empty($CFG->gradebookroles)) { throw new \moodle_exception('norolesdefined', 'grades'); } $this->courseid = $courseid; if ($this->courseid == $COURSE->id) { $this->course = $COURSE; } else { $this->course = $DB->get_record('course', array('id' => $this->courseid)); } $this->gpr = $gpr; $this->context = $context; $this->page = $page; // roles to be displayed in the gradebook $this->gradebookroles = $CFG->gradebookroles; // Set up link to preferences page $this->preferences_page = $CFG->wwwroot.'/grade/report/grader/preferences.php?id='.$courseid; // init gtree in child class // Set any url params. $this->usersearch = optional_param('searchvalue', '', PARAM_NOTAGS); $this->userid = optional_param('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 * @param context_course $context Course context * @param int $courseid Course ID * @param array $element An array representing an element in the grade_tree * @param grade_plugin_return $gpr A grade_plugin_return object * @param string $mode Mode (user or grade item) * @param stdClass $templatecontext Template context * @param bool $otherplugins If we need to insert links to other plugins * @return ?stdClass Updated template context */ public static function get_additional_context(context_course $context, int $courseid, array $element, grade_plugin_return $gpr, string $mode, stdClass $templatecontext, bool $otherplugins = false): ?stdClass { if (!$otherplugins) { $component = 'gradereport_' . $gpr->plugin; $params = [$context, $courseid, $element, $gpr, $mode, $templatecontext]; return component_callback($component, 'get_report_link', $params); } else { // Loop through all installed grade reports. foreach (core_component::get_plugin_list('gradereport') as $plugin => $plugindir) { $params = [$context, $courseid, $element, $gpr, $mode, $templatecontext]; $component = 'gradereport_' . $plugin; $templatecontextupdated = component_callback($component, 'get_report_link', $params); if ($templatecontextupdated) { $templatecontext = $templatecontextupdated; } } return $templatecontext; } } /** * First checks the cached language strings, then returns match if found, or uses get_string() * to get it from the DB, caches it then returns it. * * @deprecated since 4.2 * @todo MDL-77307 This will be deleted in Moodle 4.6. * @param string $strcode * @param string $section Optional language section * @return string */ public function get_lang_string($strcode, $section=null) { debugging('grade_report::get_lang_string() is deprecated, please use' . ' get_string() instead.', DEBUG_DEVELOPER); if (empty($this->lang_strings[$strcode])) { $this->lang_strings[$strcode] = get_string($strcode, $section); } return $this->lang_strings[$strcode]; } /** * Fetches and returns a count of all the users that will be shown on this page. * @param boolean $groups include groups limit * @param boolean $users include users limit - default false, used for searching purposes * @return int Count of users */ public function get_numusers($groups = true, $users = false) { global $CFG, $DB; $userwheresql = ""; $groupsql = ""; $groupwheresql = ""; // Limit to users with a gradeable role. list($gradebookrolessql, $gradebookrolesparams) = $DB->get_in_or_equal(explode(',', $this->gradebookroles), SQL_PARAMS_NAMED, 'grbr0'); // 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'); $params = array_merge($gradebookrolesparams, $enrolledparams, $relatedctxparams); 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) { $this->userwheresql .= " AND u.id = :uid"; $this->userwheresql_params['uid'] = $this->userid; } // A user wants to return a subset of learners that match their search criteria. if ($this->usersearch !== '' && $this->userid === -1) { // Get the fields for all contexts because there is a special case later where it allows // matches of fields you can't access if they are on your own account. $userfields = fields::for_identity(null, false)->with_userpic(); ['mappings' => $mappings] = (array)$userfields->get_sql('u', true); [ 'where' => $keywordswhere, 'params' => $keywordsparams, ] = $this->get_users_search_sql($mappings, (array)$userfields); $this->userwheresql .= " AND $keywordswhere"; $this->userwheresql_params = array_merge($this->userwheresql_params, $keywordsparams); } } /** * Prepare SQL where clause and associated parameters for any user searching being performed. * This mostly came from core_user\table\participants_search with some slight modifications four our use case. * * @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. * @return array SQL query data in the format ['where' => '', 'params' => []]. */ protected function get_users_search_sql(array $mappings, array $userfields): array { global $DB, $USER; $canviewfullnames = has_capability('moodle/site:viewfullnames', $this->context); $params = []; $searchkey1 = 'search01'; $searchkey2 = 'search02'; $searchkey3 = 'search03'; $conditions = []; // Search by fullname. [$fullname, $fullnameparams] = fields::get_sql_fullname('u', $canviewfullnames); $conditions[] = $DB->sql_like($fullname, ':' . $searchkey1, false, false); $params = array_merge($params, $fullnameparams); // Search by email. $email = $DB->sql_like('email', ':' . $searchkey2, false, false); if (!in_array('email', $userfields)) { $maildisplay = 'maildisplay0'; $userid1 = 'userid01'; // Prevent users who hide their email address from being found by others // who aren't allowed to see hidden email addresses. $email = "(". $email ." AND (" . "u.maildisplay <> :$maildisplay " . "OR u.id = :$userid1". // Users can always find themselves. "))"; $params[$maildisplay] = core_user::MAILDISPLAY_HIDE; $params[$userid1] = $USER->id; } $conditions[] = $email; // Search by idnumber. $idnumber = $DB->sql_like('idnumber', ':' . $searchkey3, false, false); if (!in_array('idnumber', $userfields)) { $userid2 = 'userid02'; // Users who aren't allowed to see idnumbers should at most find themselves // when searching for an idnumber. $idnumber = "(". $idnumber . " AND u.id = :$userid2)"; $params[$userid2] = $USER->id; } $conditions[] = $idnumber; // Search all user identify fields. $extrasearchfields = fields::get_identity_fields(null, false); foreach ($extrasearchfields as $fieldindex => $extrasearchfield) { if (in_array($extrasearchfield, ['email', 'idnumber', 'country'])) { // Already covered above. continue; } // The param must be short (max 32 characters) so don't include field name. $param = $searchkey3 . '_ident' . $fieldindex; $fieldsql = $mappings[$extrasearchfield]; $condition = $DB->sql_like($fieldsql, ':' . $param, false, false); $params[$param] = "%$this->usersearch%"; if (!in_array($extrasearchfield, $userfields)) { // User cannot see this field, but allow match if their own account. $userid3 = 'userid03_ident' . $fieldindex; $condition = "(". $condition . " AND u.id = :$userid3)"; $params[$userid3] = $USER->id; } $conditions[] = $condition; } $where = "(". implode(" OR ", $conditions) .") "; $params[$searchkey1] = "%$this->usersearch%"; $params[$searchkey2] = "%$this->usersearch%"; $params[$searchkey3] = "%$this->usersearch%"; return [ 'where' => $where, 'params' => $params, ]; } /** * Returns an arrow icon inside an <a> tag, for the purpose of sorting a column. * @param string $direction * @param moodle_url|null $sortlink */ protected function get_sort_arrow(string $direction = 'down', ?moodle_url $sortlink = null) { global $OUTPUT; $pix = ['up' => 't/sort_desc', 'down' => 't/sort_asc']; $matrix = ['up' => 'desc', 'down' => 'asc']; $strsort = get_string($matrix[$direction], 'moodle'); $arrow = $OUTPUT->pix_icon($pix[$direction], '', '', ['class' => 'sorticon']); if (!empty($sortlink)) { $sortlink->param('sort', ($direction == 'up' ? 'asc' : 'desc')); } return html_writer::link($sortlink, $arrow, ['title' => $strsort, 'aria-label' => $strsort, 'data-collapse' => 'sort', 'class' => 'arrow_link py-1']); } /** * Optionally blank out course/category totals if they contain any hidden items * @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' */ protected function blank_hidden_total_and_adjust_bounds($courseid, $course_item, $finalgrade) { global $CFG, $DB; static $hiding_affected = null;//array of items in this course affected by hiding // If we're dealing with multiple users we need to know when we've moved on to a new user. static $previous_userid = null; // If we're dealing with multiple courses we need to know when we've moved on to a new course. static $previous_courseid = null; $coursegradegrade = grade_grade::fetch(array('userid'=>$this->user->id, 'itemid'=>$course_item->id)); $grademin = $course_item->grademin; $grademax = $course_item->grademax; if ($coursegradegrade) { $grademin = $coursegradegrade->get_grade_min(); $grademax = $coursegradegrade->get_grade_max(); } else { $coursegradegrade = new grade_grade(array('userid'=>$this->user->id, 'itemid'=>$course_item->id), false); } $hint = $coursegradegrade->get_aggregation_hint(); $aggregationstatus = $hint['status']; $aggregationweight = $hint['weight']; if (!is_array($this->showtotalsifcontainhidden)) { debugging('showtotalsifcontainhidden should be an array', DEBUG_DEVELOPER); $this->showtotalsifcontainhidden = array($courseid => $this->showtotalsifcontainhidden); } if ($this->showtotalsifcontainhidden[$courseid] == GRADE_REPORT_SHOW_REAL_TOTAL_IF_CONTAINS_HIDDEN) { return array('grade' => $finalgrade, 'grademin' => $grademin, 'grademax' => $grademax, 'aggregationstatus' => $aggregationstatus, 'aggregationweight' => $aggregationweight); } // If we've moved on to another course or user, reload the grades. if ($previous_userid != $this->user->id || $previous_courseid != $courseid) { $hiding_affected = null; $previous_userid = $this->user->id; $previous_courseid = $courseid; } if (!$hiding_affected) { $items = grade_item::fetch_all(array('courseid'=>$courseid)); $grades = array(); $sql = "SELECT g.* FROM {grade_grades} g JOIN {grade_items} gi ON gi.id = g.itemid WHERE g.userid = {$this->user->id} AND gi.courseid = {$courseid}"; if ($gradesrecords = $DB->get_records_sql($sql)) { foreach ($gradesrecords as $grade) { $grades[$grade->itemid] = new grade_grade($grade, false); } unset($gradesrecords); } foreach ($items as $itemid => $unused) { if (!isset($grades[$itemid])) { $grade_grade = new grade_grade(); $grade_grade->userid = $this->user->id; $grade_grade->itemid = $items[$itemid]->id; $grades[$itemid] = $grade_grade; } $grades[$itemid]->grade_item =& $items[$itemid]; } $hiding_affected = grade_grade::get_hiding_affected($grades, $items); } //if the item definitely depends on a hidden item if (array_key_exists($course_item->id, $hiding_affected['altered']) || array_key_exists($course_item->id, $hiding_affected['alteredgrademin']) || array_key_exists($course_item->id, $hiding_affected['alteredgrademax']) || array_key_exists($course_item->id, $hiding_affected['alteredaggregationstatus']) || array_key_exists($course_item->id, $hiding_affected['alteredaggregationweight'])) { if (!$this->showtotalsifcontainhidden[$courseid] && array_key_exists($course_item->id, $hiding_affected['altered'])) { // Hide the grade, but only when it has changed. $finalgrade = null; } else { //use reprocessed marks that exclude hidden items if (array_key_exists($course_item->id, $hiding_affected['altered'])) { $finalgrade = $hiding_affected['altered'][$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]; } 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; } } report/user/lib.php 0000604 00000026167 15062070556 0010332 0 ustar 00 <?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/>. /** * Definition of the grade_user_report class is defined * * @package gradereport_user * @copyright 2007 Nicolas Connault * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ use core_user\output\myprofile\tree; require_once($CFG->dirroot . '/grade/report/lib.php'); require_once($CFG->libdir.'/tablelib.php'); define("GRADE_REPORT_USER_HIDE_HIDDEN", 0); define("GRADE_REPORT_USER_HIDE_UNTIL", 1); define("GRADE_REPORT_USER_SHOW_HIDDEN", 2); define("GRADE_REPORT_USER_VIEW_SELF", 1); define("GRADE_REPORT_USER_VIEW_USER", 2); function grade_report_user_settings_definition(&$mform) { global $CFG; $options = [ -1 => get_string('default', 'grades'), 0 => get_string('hide'), 1 => get_string('show') ]; if (empty($CFG->grade_report_user_showrank)) { $options[-1] = get_string('defaultprev', 'grades', $options[0]); } else { $options[-1] = get_string('defaultprev', 'grades', $options[1]); } $mform->addElement('select', 'report_user_showrank', get_string('showrank', 'grades'), $options); $mform->addHelpButton('report_user_showrank', 'showrank', 'grades'); if (empty($CFG->grade_report_user_showpercentage)) { $options[-1] = get_string('defaultprev', 'grades', $options[0]); } else { $options[-1] = get_string('defaultprev', 'grades', $options[1]); } $mform->addElement('select', 'report_user_showpercentage', get_string('showpercentage', 'grades'), $options); $mform->addHelpButton('report_user_showpercentage', 'showpercentage', 'grades'); if (empty($CFG->grade_report_user_showgrade)) { $options[-1] = get_string('defaultprev', 'grades', $options[0]); } else { $options[-1] = get_string('defaultprev', 'grades', $options[1]); } $mform->addElement('select', 'report_user_showgrade', get_string('showgrade', 'grades'), $options); if (empty($CFG->grade_report_user_showfeedback)) { $options[-1] = get_string('defaultprev', 'grades', $options[0]); } else { $options[-1] = get_string('defaultprev', 'grades', $options[1]); } $mform->addElement('select', 'report_user_showfeedback', get_string('showfeedback', 'grades'), $options); if (empty($CFG->grade_report_user_showweight)) { $options[-1] = get_string('defaultprev', 'grades', $options[0]); } else { $options[-1] = get_string('defaultprev', 'grades', $options[1]); } $mform->addElement('select', 'report_user_showweight', get_string('showweight', 'grades'), $options); if (empty($CFG->grade_report_user_showaverage)) { $options[-1] = get_string('defaultprev', 'grades', $options[0]); } else { $options[-1] = get_string('defaultprev', 'grades', $options[1]); } $mform->addElement('select', 'report_user_showaverage', get_string('showaverage', 'grades'), $options); $mform->addHelpButton('report_user_showaverage', 'showaverage', 'grades'); if (empty($CFG->grade_report_user_showlettergrade)) { $options[-1] = get_string('defaultprev', 'grades', $options[0]); } else { $options[-1] = get_string('defaultprev', 'grades', $options[1]); } $mform->addElement('select', 'report_user_showlettergrade', get_string('showlettergrade', 'grades'), $options); if (empty($CFG->grade_report_user_showcontributiontocoursetotal)) { $options[-1] = get_string('defaultprev', 'grades', $options[0]); } else { $options[-1] = get_string('defaultprev', 'grades', $options[$CFG->grade_report_user_showcontributiontocoursetotal]); } $mform->addElement('select', 'report_user_showcontributiontocoursetotal', get_string('showcontributiontocoursetotal', 'grades'), $options); $mform->addHelpButton('report_user_showcontributiontocoursetotal', 'showcontributiontocoursetotal', 'grades'); if (empty($CFG->grade_report_user_showrange)) { $options[-1] = get_string('defaultprev', 'grades', $options[0]); } else { $options[-1] = get_string('defaultprev', 'grades', $options[1]); } $mform->addElement('select', 'report_user_showrange', get_string('showrange', 'grades'), $options); $options = [ 0 => 0, 1 => 1, 2 => 2, 3 => 3, 4 => 4, 5 => 5 ]; if (!empty($CFG->grade_report_user_rangedecimals)) { $options[-1] = $options[$CFG->grade_report_user_rangedecimals]; } $mform->addElement('select', 'report_user_rangedecimals', get_string('rangedecimals', 'grades'), $options); $options = [ -1 => get_string('default', 'grades'), 0 => get_string('shownohidden', 'grades'), 1 => get_string('showhiddenuntilonly', 'grades'), 2 => get_string('showallhidden', 'grades') ]; if (empty($CFG->grade_report_user_showhiddenitems)) { $options[-1] = get_string('defaultprev', 'grades', $options[0]); } else { $options[-1] = get_string('defaultprev', 'grades', $options[$CFG->grade_report_user_showhiddenitems]); } $mform->addElement('select', 'report_user_showhiddenitems', get_string('showhiddenitems', 'grades'), $options); $mform->addHelpButton('report_user_showhiddenitems', 'showhiddenitems', 'grades'); $options = [ -1 => get_string('default', 'grades'), GRADE_REPORT_HIDE_TOTAL_IF_CONTAINS_HIDDEN => get_string('hide'), GRADE_REPORT_SHOW_TOTAL_IF_CONTAINS_HIDDEN => get_string('hidetotalshowexhiddenitems', 'grades'), GRADE_REPORT_SHOW_REAL_TOTAL_IF_CONTAINS_HIDDEN => get_string('hidetotalshowinchiddenitems', 'grades') ]; if (empty($CFG->grade_report_user_showtotalsifcontainhidden)) { $options[-1] = get_string('defaultprev', 'grades', $options[0]); } else { $options[-1] = get_string('defaultprev', 'grades', $options[$CFG->grade_report_user_showtotalsifcontainhidden]); } $mform->addElement('select', 'report_user_showtotalsifcontainhidden', get_string('hidetotalifhiddenitems', 'grades'), $options); $mform->addHelpButton('report_user_showtotalsifcontainhidden', 'hidetotalifhiddenitems', 'grades'); } /** * Profile report callback. * * @param object $course The course. * @param object $user The user. * @param boolean $viewasuser True when we are viewing this as the targetted user sees it. */ function grade_report_user_profilereport(object $course, object $user, bool $viewasuser = false) { if (!empty($course->showgrades)) { $context = context_course::instance($course->id); // Fetch the return tracking object. $gpr = new grade_plugin_return( ['type' => 'report', 'plugin' => 'user', 'courseid' => $course->id, 'userid' => $user->id] ); // Create a report instance. $report = new gradereport_user\report\user($course->id, $gpr, $context, $user->id, $viewasuser); // Print the page. // A css fix to share styles with real report page. echo '<div class="grade-report-user">'; if ($report->fill_table()) { echo $report->print_table(true); } echo '</div>'; } } /** * Add nodes to myprofile page. * * @param tree $tree Tree object * @param stdClass $user user object * @param bool $iscurrentuser * @param null|stdClass $course Course object */ function gradereport_user_myprofile_navigation(tree $tree, stdClass $user, bool $iscurrentuser, ?stdClass $course) { if (empty($course)) { // We want to display these reports under the site context. $course = get_fast_modinfo(SITEID)->get_course(); } $usercontext = context_user::instance($user->id); $anyreport = has_capability('moodle/user:viewuseractivitiesreport', $usercontext); // Start capability checks. if ($anyreport || $iscurrentuser) { // Add grade hardcoded grade report if necessary. $gradeaccess = false; $coursecontext = context_course::instance($course->id); if (has_capability('moodle/grade:viewall', $coursecontext)) { // Can view all course grades. $gradeaccess = true; } else if ($course->showgrades) { if ($iscurrentuser && has_capability('moodle/grade:view', $coursecontext)) { // Can view own grades. $gradeaccess = true; } else if (has_capability('moodle/grade:viewall', $usercontext)) { // Can view grades of this user - parent most probably. $gradeaccess = true; } else if ($anyreport) { // Can view grades of this user - parent most probably. $gradeaccess = true; } } if ($gradeaccess) { $url = new moodle_url('/course/user.php', array('mode' => 'grade', 'id' => $course->id, 'user' => $user->id)); $node = new core_user\output\myprofile\node('reports', 'grade', get_string('grades'), null, $url); $tree->add_node($node); } } } /** * Returns link to user report for the current element * * @param context_course $context Course context * @param int $courseid Course ID * @param array $element An array representing an element in the grade_tree * @param grade_plugin_return $gpr A grade_plugin_return object * @param string $mode Mode - gradeitem or user * @param ?stdClass $templatecontext Template context * @return stdClass|null */ function gradereport_user_get_report_link(context_course $context, int $courseid, array $element, grade_plugin_return $gpr, string $mode, ?stdClass $templatecontext): ?stdClass { global $CFG; if ($mode == 'user') { $reportstring = get_string('userreport_' . $mode, 'gradereport_user'); if (!isset($templatecontext)) { $templatecontext = new stdClass(); } // FIXME: MDL-52678 This get_capability_info is hacky and we should have an API for inserting grade row links instead. $canseeuserreport = false; if (get_capability_info('gradereport/' . $CFG->grade_profilereport . ':view')) { $canseeuserreport = has_capability('gradereport/' . $CFG->grade_profilereport . ':view', $context); } if ($canseeuserreport) { $url = new moodle_url('/grade/report/' . $CFG->grade_profilereport . '/index.php', ['userid' => $element['userid'], 'id' => $courseid]); $gpr->add_url_params($url); $templatecontext->reporturl1 = html_writer::link($url, $reportstring, ['class' => 'dropdown-item', 'aria-label' => $reportstring, 'role' => 'menuitem']); return $templatecontext; } } return null; } report/user/templates/view_mode_selector.mustache 0000604 00000004030 15062070556 0016443 0 ustar 00 {{! 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/>. }} {{! @template gradereport_user/view_mode_selector The view mode selector. Context variables required for this template: * name - name of the form element * value - value of the form element * baseid - id of the dropdown element and to be used to generate id for other elements used internally * label - Element label * labelattributes - Label attributes. * selectedoption - Text of the selected option * options - Array of options for the select with value, name, selected, isgroup and id properites. Example context (json): { "name": "menuname", "value": "opt2", "baseid": "select-menu56789", "label": "View report as", "labelattributes": [], "selectedoption": "Myself", "options": [ { "name": "User", "value": "opt1", "id": "select-menu-option1", "selected": false }, { "name": "Myself", "value": "opt2", "id": "select-menu-option2", "selected": true } ] } }} <div class="view-user-selector"> {{>core/select_menu}} </div> {{#js}} document.querySelector('#{{baseid}}').addEventListener('change', function(e) { window.location.href = e.target.value; }); {{/js}} report/user/templates/all_users_item.mustache 0000604 00000002114 15062070556 0015575 0 ustar 00 {{! 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/>. }} {{! @template gradereport_user/all_users_item Search result line items. Example context (json): { "id": "0", "name": "All users(10)", "url": "http://foo.bar/gradereport/?userid=0&id=2" } }} <a id="item-{{id}}" href="{{url}}" class="dropdown-item d-flex px-2 py-1"> <span class="pull-left result-cell text-truncate mr-2"> {{name}} </span> </a> report/user/templates/zero_state.mustache 0000604 00000002323 15062070556 0014747 0 ustar 00 {{! 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/>. }} {{! @template gradereport_user/zero_state The zero state of the user report that contains the image and trigger for the search widget. Example context (json): { "imglink": "http://foo.bar/gradereport/?userid=25" } }} <div class="zero-state mx-auto w-50 text-center my-6"> <img src="{{imglink}}" alt="{{#str}}userreports, gradereport_user{{/str}}" aria-hidden="true" class="my-5"> <h3>{{#str}}userreports, gradereport_user{{/str}}</h3> <p>{{#str}}userreportdesc, gradereport_user{{/str}}</p> </div> report/user/templates/user_report_category_content.mustache 0000604 00000003512 15062070556 0020571 0 ustar 00 {{! 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/>. }} {{! @template gradereport_user/user_report_category_content Template for the content of a category cell in the user report table. Context variables required for this template: * categoryid - The grade category ID * categoryname - The grade category name Example context (json): { "categoryid": "2", "categoryname": "Grade category 1" } }} <div class="d-flex category-content"> <a aria-expanded="true" role="button" data-categoryid={{categoryid}} data-target=".cat_{{categoryid}}[data-hidden='false']" class="btn btn-icon mr-1 toggle-category" href="#"> <span class="collapsed text-nowrap" title="{{#str}} collapse, core {{/str}}"> <i class="icon fa fa-chevron-down fa-fw" title="{{#str}} collapse, core {{/str}}" role="img" aria-label="{{#str}} collapse, core {{/str}}"></i> </span> <span class="expanded text-nowrap" title="{{#str}} expand, core {{/str}}"> <i class="icon fa fa-chevron-{{arrow}} fa-fw" title="{{#str}} expand, core {{/str}}" role="img" aria-label="{{#str}} expand, core {{/str}}"></i> </span> </a> <span>{{{categoryname}}}</span> </div> report/user/templates/user_navigation.mustache 0000604 00000004454 15062070556 0015774 0 ustar 00 {{! 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/>. }} {{! @template gradereport_user/user_navigation The previous/next user navigation for the user report view. Context variables required for this template: * previoususer - (optional) The object containing information about the previous user. * name - The name of the previous user. * url - The URL to the previous user report. * nextuser - (optional) The object containing information about the next user. * name - The name of the next user. * url - The URL to the next user report. Example context (json): { "previoususer": { "name": "John Smith", "url": "https://example.com/grade/report/user/index.php?id=2&userid=3" }, "previoususer": { "name": "Jane Doe", "url": "https://example.com/grade/report/user/index.php?id=2&userid=5" } } }} <div class="user-navigation w-100"> <div class="container w-100 d-flex"> {{#previoususer}} <div class="previous d-flex"> <a href="{{url}}" aria-label="{{#str}} gotopreviousreport, gradereport_user {{/str}}"> <i class="fa fa-caret-{{previousarrow}} fa-lg pr-1"></i> {{name}} </a> </div> {{/previoususer}} {{#nextuser}} <div class="next d-flex ml-auto"> <a href="{{url}}" aria-label="{{#str}} gotonextreport, gradereport_user {{/str}}"> {{name}} <i class="fa fa-caret-{{nextarrow}} fa-lg pl-1"></i> </a> </div> {{/nextuser}} </div> </div> report/user/templates/action_bar.mustache 0000604 00000010044 15062070556 0014670 0 ustar 00 {{! 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/>. }} {{! @template gradereport_user/action_bar Actions bar for the grade user report. Context variables required for this template: * generalnavselector - The data object containing the required properties to render the general navigation selector. * groupselector - (optional) HTML that outputs the group selector * userselector - (optional) The data object containing the required properties to render the user selector * viewasselector - (optional) HTML that outputs the 'view report as' selector Example context (json): { "generalnavselector": { "name": "Gradebook tertiary navigation selector", "value": "opt2", "baseid": "select-menu56789", "selectedoption": "Gradebook setup", "options": [ { "selected": false, "isgroup": { "name": "View", "id": "select-menu-group1", "options": [ { "name": "Grader report", "value": "opt1", "id": "select-menu-option1", "selected": false } ] } }, { "selected": false, "isgroup": { "name": "Setup", "id": "select-menu-group2", "options": [ { "name": "Gradebook setup", "value": "opt2", "id": "select-menu-option2", "selected": true } ] } } ] }, "groupselector": "<div class='group-selector'></div>", "userselector": { "content": "<div class='user-selector'></div>", "courseid": 25 }, "viewasselector": "<div class='view-user-selector'></div>" } }} <div class="container-fluid tertiary-navigation full-width-bottom-border"> <div class="row"> {{#generalnavselector}} <div class="navitem"> {{>core/tertiary_navigation_selector}} </div> <div class="navitem-divider"></div> {{/generalnavselector}} {{#groupselector}} <div class="navitem"> {{{groupselector}}} </div> <div class="navitem-divider"></div> {{/groupselector}} {{#userselector}} <span class="d-none" data-region="courseid" data-courseid="{{courseid}}" aria-hidden="true"></span> <div class="navitem flex-column"> {{#content}} {{{.}}} {{/content}} </div> <div class="navitem-divider"></div> {{/userselector}} <div class="d-flex ml-sm-auto"> {{#viewasselector}} <div class="navitem-divider"></div> <div class="navitem"> {{{viewasselector}}} </div> <div class="navitem-divider"></div> {{/viewasselector}} </div> </div> </div> report/user/classes/external/user.php 0000604 00000061017 15062070556 0014012 0 ustar 00 <?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/>. namespace gradereport_user\external; use context_course; use core_user; use core_external\external_api; use core_external\external_description; use core_external\external_format_value; use core_external\external_function_parameters; use core_external\external_multiple_structure; use core_external\external_single_structure; use core_external\external_value; use core_external\external_warnings; use grade_plugin_return; use graded_users_iterator; use moodle_exception; use stdClass; use gradereport_user\report\user as user_report; require_once($CFG->dirroot.'/grade/lib.php'); /** * External grade report API implementation * * @package gradereport_user * @copyright 2015 Juan Leyva <juan@moodle.com> * @category external * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class user extends external_api { /** * Validate access permissions to the report * * @param int $courseid the courseid * @param int $userid the user id to retrieve data from * @param int $groupid the group id * @return array with the parameters cleaned and other required information * @since Moodle 3.2 */ protected static function check_report_access(int $courseid, int $userid, int $groupid = 0): array { global $USER; // Validate the parameter. $params = self::validate_parameters(self::get_grades_table_parameters(), [ 'courseid' => $courseid, 'userid' => $userid, 'groupid' => $groupid, ] ); // Compact/extract functions are not recommended. $courseid = $params['courseid']; $userid = $params['userid']; $groupid = $params['groupid']; // Function get_course internally throws an exception if the course doesn't exist. $course = get_course($courseid); $context = context_course::instance($courseid); self::validate_context($context); // Specific capabilities. require_capability('gradereport/user:view', $context); $user = null; if (empty($userid)) { require_capability('moodle/grade:viewall', $context); } else { $user = core_user::get_user($userid, '*', MUST_EXIST); core_user::require_active_user($user); // Check if we can view the user group (if any). // When userid == 0, we are retrieving all the users, we'll check then if a groupid is required. if (!groups_user_groups_visible($course, $user->id)) { throw new moodle_exception('notingroup'); } } $access = false; if (has_capability('moodle/grade:viewall', $context)) { // Can view all course grades. $access = true; } else if ($userid == $USER->id && has_capability('moodle/grade:view', $context) && $course->showgrades) { // View own grades. $access = true; } if (!$access) { throw new moodle_exception('nopermissiontoviewgrades', 'error'); } if (!empty($groupid)) { // Determine is the group is visible to user. if (!groups_group_visible($groupid, $course)) { throw new moodle_exception('notingroup'); } } else { // Check to see if groups are being used here. if ($groupmode = groups_get_course_groupmode($course)) { $groupid = groups_get_course_group($course); // Determine is the group is visible to user (this is particullary for the group 0). if (!groups_group_visible($groupid, $course)) { throw new moodle_exception('notingroup'); } } else { $groupid = 0; } } return [$params, $course, $context, $user, $groupid]; } /** * Get the report data * @param stdClass $course course object * @param stdClass $context context object * @param null|stdClass $user user object (it can be null for all the users) * @param int $userid the user to retrieve data from, 0 for all * @param int $groupid the group id to filter * @param bool $tabledata whether to get the table data (true) or the gradeitemdata * @return array data and possible warnings * @since Moodle 3.2 */ protected static function get_report_data( stdClass $course, stdClass $context, ?stdClass $user, int $userid, int $groupid, bool $tabledata = true ): array { global $CFG; $warnings = []; // Require files here to save some memory in case validation fails. require_once($CFG->dirroot . '/group/lib.php'); require_once($CFG->libdir . '/gradelib.php'); require_once($CFG->dirroot . '/grade/lib.php'); require_once($CFG->dirroot . '/grade/report/user/lib.php'); // Force regrade to update items marked as 'needupdate'. grade_regrade_final_grades($course->id); $gpr = new grade_plugin_return( [ 'type' => 'report', 'plugin' => 'user', 'courseid' => $course->id, 'courseidnumber' => $course->idnumber, 'userid' => $userid ] ); $reportdata = []; // Just one user. if ($user) { $report = new user_report($course->id, $gpr, $context, $userid); $report->fill_table(); $gradeuserdata = [ 'courseid' => $course->id, 'courseidnumber' => $course->idnumber, 'userid' => $user->id, 'userfullname' => fullname($user), 'useridnumber' => $user->idnumber, 'maxdepth' => $report->maxdepth, ]; if ($tabledata) { $gradeuserdata['tabledata'] = $report->tabledata; } else { $gradeuserdata['gradeitems'] = $report->gradeitemsdata; } $reportdata[] = $gradeuserdata; } else { $defaultgradeshowactiveenrol = !empty($CFG->grade_report_showonlyactiveenrol); $showonlyactiveenrol = get_user_preferences('grade_report_showonlyactiveenrol', $defaultgradeshowactiveenrol); $showonlyactiveenrol = $showonlyactiveenrol || !has_capability('moodle/course:viewsuspendedusers', $context); $gui = new graded_users_iterator($course, null, $groupid); $gui->require_active_enrolment($showonlyactiveenrol); $gui->init(); while ($userdata = $gui->next_user()) { $currentuser = $userdata->user; $report = new user_report($course->id, $gpr, $context, $currentuser->id); $report->fill_table(); $gradeuserdata = [ 'courseid' => $course->id, 'courseidnumber' => $course->idnumber, 'userid' => $currentuser->id, 'userfullname' => fullname($currentuser), 'useridnumber' => $currentuser->idnumber, 'maxdepth' => $report->maxdepth, ]; if ($tabledata) { $gradeuserdata['tabledata'] = $report->tabledata; } else { $gradeuserdata['gradeitems'] = $report->gradeitemsdata; } $reportdata[] = $gradeuserdata; } $gui->close(); } return [$reportdata, $warnings]; } /** * Describes the parameters for get_grades_table. * * @return external_function_parameters * @since Moodle 2.9 */ public static function get_grades_table_parameters(): external_function_parameters { return new external_function_parameters ( [ 'courseid' => new external_value(PARAM_INT, 'Course Id', VALUE_REQUIRED), 'userid' => new external_value(PARAM_INT, 'Return grades only for this user (optional)', VALUE_DEFAULT, 0), 'groupid' => new external_value(PARAM_INT, 'Get users from this group only', VALUE_DEFAULT, 0) ] ); } /** * Returns a list of grades tables for users in a course. * * @param int $courseid Course Id * @param int $userid Only this user (optional) * @param int $groupid Get users from this group only * * @return array the grades tables * @since Moodle 2.9 */ public static function get_grades_table(int $courseid, int $userid = 0, int $groupid = 0): array { list($params, $course, $context, $user, $groupid) = self::check_report_access($courseid, $userid, $groupid); $userid = $params['userid']; // We pass userid because it can be still 0. list($tables, $warnings) = self::get_report_data($course, $context, $user, $userid, $groupid); return [ 'tables' => $tables, 'warnings' => $warnings ]; } /** * Creates a table column structure * * @return array * @since Moodle 2.9 */ private static function grades_table_column(): array { return [ 'class' => new external_value(PARAM_RAW, 'class'), 'content' => new external_value(PARAM_RAW, 'cell content'), 'headers' => new external_value(PARAM_RAW, 'headers') ]; } /** * Describes tget_grades_table return value. * * @return external_single_structure * @since Moodle 2.9 */ public static function get_grades_table_returns(): external_single_structure { return new external_single_structure( [ 'tables' => new external_multiple_structure( new external_single_structure( [ 'courseid' => new external_value(PARAM_INT, 'course id'), 'userid' => new external_value(PARAM_INT, 'user id'), 'userfullname' => new external_value(PARAM_TEXT, 'user fullname'), 'maxdepth' => new external_value(PARAM_INT, 'table max depth (needed for printing it)'), 'tabledata' => new external_multiple_structure( new external_single_structure( [ 'itemname' => new external_single_structure( [ 'class' => new external_value(PARAM_RAW, 'class'), 'colspan' => new external_value(PARAM_INT, 'col span'), 'content' => new external_value(PARAM_RAW, 'cell content'), 'id' => new external_value(PARAM_ALPHANUMEXT, 'id') ], 'The item returned data', VALUE_OPTIONAL ), 'leader' => new external_single_structure( [ 'class' => new external_value(PARAM_RAW, 'class'), 'rowspan' => new external_value(PARAM_INT, 'row span') ], 'The item returned data', VALUE_OPTIONAL ), 'weight' => new external_single_structure( self::grades_table_column(), 'weight column', VALUE_OPTIONAL ), 'grade' => new external_single_structure( self::grades_table_column(), 'grade column', VALUE_OPTIONAL ), 'range' => new external_single_structure( self::grades_table_column(), 'range column', VALUE_OPTIONAL ), 'percentage' => new external_single_structure( self::grades_table_column(), 'percentage column', VALUE_OPTIONAL ), 'lettergrade' => new external_single_structure( self::grades_table_column(), 'lettergrade column', VALUE_OPTIONAL ), 'rank' => new external_single_structure( self::grades_table_column(), 'rank column', VALUE_OPTIONAL ), 'average' => new external_single_structure( self::grades_table_column(), 'average column', VALUE_OPTIONAL ), 'feedback' => new external_single_structure( self::grades_table_column(), 'feedback column', VALUE_OPTIONAL ), 'contributiontocoursetotal' => new external_single_structure( self::grades_table_column(), 'contributiontocoursetotal column', VALUE_OPTIONAL ), 'parentcategories' => new external_multiple_structure( new external_value(PARAM_INT, 'Parent grade category ID.') ), ], 'table' ) ) ] ) ), 'warnings' => new external_warnings() ] ); } /** * Returns description of method parameters * * @return external_function_parameters * @since Moodle 2.9 */ public static function view_grade_report_parameters(): external_function_parameters { return new external_function_parameters( [ 'courseid' => new external_value(PARAM_INT, 'id of the course'), 'userid' => new external_value(PARAM_INT, 'id of the user, 0 means current user', VALUE_DEFAULT, 0), ] ); } /** * Trigger the user report events, do the same that the web interface view of the report * * @param int $courseid id of course * @param int $userid id of the user the report belongs to * @return array of warnings and status result * @since Moodle 2.9 * @throws moodle_exception */ public static function view_grade_report(int $courseid, int $userid = 0): array { global $CFG, $USER; require_once($CFG->dirroot . "/grade/lib.php"); require_once($CFG->dirroot . "/grade/report/user/lib.php"); $params = self::validate_parameters(self::view_grade_report_parameters(), [ 'courseid' => $courseid, 'userid' => $userid ]); $warnings = []; $course = get_course($params['courseid']); $context = context_course::instance($course->id); self::validate_context($context); $userid = $params['userid']; if (empty($userid)) { $userid = $USER->id; } else { $user = core_user::get_user($userid, '*', MUST_EXIST); core_user::require_active_user($user); } $access = false; if (has_capability('moodle/grade:viewall', $context)) { // Can view all course grades (any user). $access = true; } else if ($userid == $USER->id && has_capability('moodle/grade:view', $context) && $course->showgrades) { // View own grades. $access = true; } if (!$access) { throw new moodle_exception('nopermissiontoviewgrades', 'error'); } // Create a report instance. We don't need the gpr second parameter. $report = new user_report($course->id, null, $context, $userid); $report->viewed(); return [ 'status' => true, 'warnings' => $warnings ]; } /** * Returns description of method result value * * @return external_description * @since Moodle 2.9 */ public static function view_grade_report_returns(): external_description { return new external_single_structure( [ 'status' => new external_value(PARAM_BOOL, 'status: true if success'), 'warnings' => new external_warnings() ] ); } /** * Describes the parameters for get_grade_items. * * @return external_function_parameters * @since Moodle 3.2 */ public static function get_grade_items_parameters(): external_function_parameters { return self::get_grades_table_parameters(); } /** * Returns the complete list of grade items for users in a course. * * @param int $courseid Course Id * @param int $userid Only this user (optional) * @param int $groupid Get users from this group only * * @return array the grades tables * @since Moodle 3.2 */ public static function get_grade_items(int $courseid, int $userid = 0, int $groupid = 0): array { list($params, $course, $context, $user, $groupid) = self::check_report_access($courseid, $userid, $groupid); $userid = $params['userid']; // We pass userid because it can be still 0. list($gradeitems, $warnings) = self::get_report_data($course, $context, $user, $userid, $groupid, false); foreach ($gradeitems as $gradeitem) { if (isset($gradeitem['feedback']) && isset($gradeitem['feedbackformat'])) { list($gradeitem['feedback'], $gradeitem['feedbackformat']) = \core_external\util::format_text($gradeitem['feedback'], $gradeitem['feedbackformat'], $context->id); } } return [ 'usergrades' => $gradeitems, 'warnings' => $warnings ]; } /** * Describes tget_grade_items return value. * * @return external_single_structure * @since Moodle 3.2 */ public static function get_grade_items_returns(): external_single_structure { return new external_single_structure( [ 'usergrades' => new external_multiple_structure( new external_single_structure( [ 'courseid' => new external_value(PARAM_INT, 'course id'), 'courseidnumber' => new external_value(PARAM_TEXT, 'course idnumber'), 'userid' => new external_value(PARAM_INT, 'user id'), 'userfullname' => new external_value(PARAM_TEXT, 'user fullname'), 'useridnumber' => new external_value( core_user::get_property_type('idnumber'), 'user idnumber'), 'maxdepth' => new external_value(PARAM_INT, 'table max depth (needed for printing it)'), 'gradeitems' => new external_multiple_structure( new external_single_structure( [ 'id' => new external_value(PARAM_INT, 'Grade item id'), 'itemname' => new external_value(PARAM_CLEANHTML, 'Grade item name'), 'itemtype' => new external_value(PARAM_ALPHA, 'Grade item type'), 'itemmodule' => new external_value(PARAM_PLUGIN, 'Grade item module'), 'iteminstance' => new external_value(PARAM_INT, 'Grade item instance'), 'itemnumber' => new external_value(PARAM_INT, 'Grade item item number'), 'idnumber' => new external_value(PARAM_TEXT, 'Grade item idnumber'), 'categoryid' => new external_value(PARAM_INT, 'Grade item category id'), 'outcomeid' => new external_value(PARAM_INT, 'Outcome id'), 'scaleid' => new external_value(PARAM_INT, 'Scale id'), 'locked' => new external_value(PARAM_BOOL, 'Grade item for user locked?', VALUE_OPTIONAL), 'cmid' => new external_value(PARAM_INT, 'Course module id (if type mod)', VALUE_OPTIONAL), 'weightraw' => new external_value(PARAM_FLOAT, 'Weight raw', VALUE_OPTIONAL), 'weightformatted' => new external_value(PARAM_NOTAGS, 'Weight', VALUE_OPTIONAL), 'status' => new external_value(PARAM_ALPHA, 'Status', VALUE_OPTIONAL), 'graderaw' => new external_value(PARAM_FLOAT, 'Grade raw', VALUE_OPTIONAL), 'gradedatesubmitted' => new external_value(PARAM_INT, 'Grade submit date', VALUE_OPTIONAL), 'gradedategraded' => new external_value(PARAM_INT, 'Grade graded date', VALUE_OPTIONAL), 'gradehiddenbydate' => new external_value(PARAM_BOOL, 'Grade hidden by date?', VALUE_OPTIONAL), 'gradeneedsupdate' => new external_value(PARAM_BOOL, 'Grade needs update?', VALUE_OPTIONAL), 'gradeishidden' => new external_value(PARAM_BOOL, 'Grade is hidden?', VALUE_OPTIONAL), 'gradeislocked' => new external_value(PARAM_BOOL, 'Grade is locked?', VALUE_OPTIONAL), 'gradeisoverridden' => new external_value(PARAM_BOOL, 'Grade overridden?', VALUE_OPTIONAL), 'gradeformatted' => new external_value(PARAM_RAW, 'The grade formatted', VALUE_OPTIONAL), 'grademin' => new external_value(PARAM_FLOAT, 'Grade min', VALUE_OPTIONAL), 'grademax' => new external_value(PARAM_FLOAT, 'Grade max', VALUE_OPTIONAL), 'rangeformatted' => new external_value(PARAM_NOTAGS, 'Range formatted', VALUE_OPTIONAL), 'percentageformatted' => new external_value(PARAM_NOTAGS, 'Percentage', VALUE_OPTIONAL), 'lettergradeformatted' => new external_value(PARAM_NOTAGS, 'Letter grade', VALUE_OPTIONAL), 'rank' => new external_value(PARAM_INT, 'Rank in the course', VALUE_OPTIONAL), 'numusers' => new external_value(PARAM_INT, 'Num users in course', VALUE_OPTIONAL), 'averageformatted' => new external_value(PARAM_NOTAGS, 'Grade average', VALUE_OPTIONAL), 'feedback' => new external_value(PARAM_RAW, 'Grade feedback', VALUE_OPTIONAL), 'feedbackformat' => new external_format_value('feedback', VALUE_OPTIONAL), ], 'Grade items' ) ) ] ) ), 'warnings' => new external_warnings() ] ); } } report/user/classes/external/get_access_information.php 0000604 00000006251 15062070556 0017540 0 ustar 00 <?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/>. namespace gradereport_user\external; use context_course; use core_external\external_api; use core_external\external_function_parameters; use core_external\external_single_structure; use core_external\external_value; use core_external\external_warnings; use stdClass; /** * External grade report API implementation * * @package gradereport_user * @copyright 2023 Juan Leyva <juan@moodle.com> * @category external * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class get_access_information extends external_api { /** * Returns description of method parameters. * * @return external_function_parameters. * @since Moodle 4.2 */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters( [ 'courseid' => new external_value(PARAM_INT, 'Course to check.'), ] ); } /** * Convenience function to retrieve some permissions information for the given course grade report. * * @param int $courseid Course to check, empty for site. * @return array The access information * @since Moodle 4.2 */ public static function execute(int $courseid): array { $params = self::validate_parameters(self::execute_parameters(), ['courseid' => $courseid]); $context = context_course::instance($params['courseid']); self::validate_context($context); return [ 'canviewusergradereport' => has_capability('gradereport/user:view', $context), 'canviewmygrades' => has_capability('moodle/grade:view', $context), 'canviewallgrades' => has_capability('moodle/grade:viewall', $context), 'warnings' => [], ]; } /** * Returns description of method result value. * * @return external_single_structure. * @since Moodle 4.2 */ public static function execute_returns(): external_single_structure { return new external_single_structure( [ 'canviewusergradereport' => new external_value(PARAM_BOOL, 'Whether the user can view the user grade report.'), 'canviewmygrades' => new external_value(PARAM_BOOL, 'Whether the user can view his grades in the course.'), 'canviewallgrades' => new external_value(PARAM_BOOL, 'Whether the user can view all users grades in the course.'), 'warnings' => new external_warnings(), ] ); } } report/user/classes/report/user.php 0000604 00000155115 15062070556 0013506 0 ustar 00 <?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/>. namespace gradereport_user\report; use context_course; use course_modinfo; use grade_grade; use grade_helper; use grade_report; use grade_tree; use html_writer; use moodle_url; defined('MOODLE_INTERNAL') || die; global $CFG; require_once($CFG->dirroot.'/grade/report/lib.php'); require_once($CFG->dirroot.'/grade/lib.php'); /** * Class providing an API for the user report building and displaying. * @uses grade_report * @package gradereport_user */ class user extends grade_report { /** * A flexitable to hold the data. * @var object $table */ public $table; /** * An array of table headers * @var array */ public $tableheaders = []; /** * An array of table columns * @var array */ public $tablecolumns = []; /** * An array containing rows of data for the table. * @var array */ public $tabledata = []; /** * An array containing the grade items data for external usage (web services, ajax, etc...) * @var array */ public $gradeitemsdata = []; /** * The grade tree structure * @var grade_tree */ public $gtree; /** * Flat structure similar to grade tree * @var void */ public $gseq; /** * show student ranks * @var void */ public $showrank; /** * show grade percentages * @var void */ public $showpercentage; /** * Show range * @var bool */ public $showrange = true; /** * Show grades in the report, default true * @var bool */ public $showgrade = true; /** * Decimal points to use for values in the report, default 2 * @var int */ public $decimals = 2; /** * The number of decimal places to round range to, default 0 * @var int */ public $rangedecimals = 0; /** * Show grade feedback in the report, default true * @var bool */ public $showfeedback = true; /** * Show grade weighting in the report, default true. * @var bool */ public $showweight = true; /** * Show letter grades in the report, default false * @var bool */ public $showlettergrade = false; /** * Show the calculated contribution to the course total column. * @var bool */ public $showcontributiontocoursetotal = true; /** * Show average grades in the report, default false. * @var false */ public $showaverage = false; /** * @var int */ public $maxdepth; /** * @var void */ public $evenodd; /** * @var bool */ public $canviewhidden; /** * @var string|null */ public $switch; /** * Show hidden items even when user does not have required cap * @var void */ public $showhiddenitems; /** * @var string */ public $baseurl; /** * @var string */ public $pbarurl; /** * The modinfo object to be used. * * @var course_modinfo */ protected $modinfo = null; /** * View as user. * * When this is set to true, the visibility checks, and capability checks will be * applied to the user whose grades are being displayed. This is very useful when * a mentor/parent is viewing the report of their mentee because they need to have * access to the same information, but not more, not less. * * @var boolean */ protected $viewasuser = false; /** * An array that collects the aggregationhints for every * grade_item. The hints contain grade, grademin, grademax * status, weight and parent. * * @var array */ protected $aggregationhints = []; /** * Constructor. Sets local copies of user preferences and initialises grade_tree. * @param int $courseid * @param null|object $gpr grade plugin return tracking object * @param object $context * @param int $userid The id of the user * @param bool $viewasuser Set this to true when the current user is a mentor/parent of the targetted user. */ public function __construct(int $courseid, ?object $gpr, object $context, int $userid, bool $viewasuser = null) { global $DB, $CFG; parent::__construct($courseid, $gpr, $context); $this->showrank = grade_get_setting($this->courseid, 'report_user_showrank', $CFG->grade_report_user_showrank); $this->showpercentage = grade_get_setting( $this->courseid, 'report_user_showpercentage', $CFG->grade_report_user_showpercentage ); $this->showhiddenitems = grade_get_setting( $this->courseid, 'report_user_showhiddenitems', $CFG->grade_report_user_showhiddenitems ); $this->showtotalsifcontainhidden = [$this->courseid => grade_get_setting( $this->courseid, 'report_user_showtotalsifcontainhidden', $CFG->grade_report_user_showtotalsifcontainhidden )]; $this->showgrade = grade_get_setting( $this->courseid, 'report_user_showgrade', !empty($CFG->grade_report_user_showgrade) ); $this->showrange = grade_get_setting( $this->courseid, 'report_user_showrange', !empty($CFG->grade_report_user_showrange) ); $this->showfeedback = grade_get_setting( $this->courseid, 'report_user_showfeedback', !empty($CFG->grade_report_user_showfeedback) ); $this->showweight = grade_get_setting($this->courseid, 'report_user_showweight', !empty($CFG->grade_report_user_showweight)); $this->showcontributiontocoursetotal = grade_get_setting($this->courseid, 'report_user_showcontributiontocoursetotal', !empty($CFG->grade_report_user_showcontributiontocoursetotal)); $this->showlettergrade = grade_get_setting( $this->courseid, 'report_user_showlettergrade', !empty($CFG->grade_report_user_showlettergrade) ); $this->showaverage = grade_get_setting( $this->courseid, 'report_user_showaverage', !empty($CFG->grade_report_user_showaverage) ); $this->viewasuser = $viewasuser; // The default grade decimals is 2. $defaultdecimals = 2; if (property_exists($CFG, 'grade_decimalpoints')) { $defaultdecimals = $CFG->grade_decimalpoints; } $this->decimals = grade_get_setting($this->courseid, 'decimalpoints', $defaultdecimals); // The default range decimals is 0. $defaultrangedecimals = 0; if (property_exists($CFG, 'grade_report_user_rangedecimals')) { $defaultrangedecimals = $CFG->grade_report_user_rangedecimals; } $this->rangedecimals = grade_get_setting($this->courseid, 'report_user_rangedecimals', $defaultrangedecimals); $this->switch = grade_get_setting($this->courseid, 'aggregationposition', $CFG->grade_aggregationposition); // Grab the grade_tree for this course. $this->gtree = new grade_tree($this->courseid, false, $this->switch, null, !$CFG->enableoutcomes); // Get the user (for full name). $this->user = $DB->get_record('user', ['id' => $userid]); // What user are we viewing this as? $coursecontext = context_course::instance($this->courseid); if ($viewasuser) { $this->modinfo = new course_modinfo($this->course, $this->user->id); $this->canviewhidden = has_capability('moodle/grade:viewhidden', $coursecontext, $this->user->id); } else { $this->modinfo = $this->gtree->modinfo; $this->canviewhidden = has_capability('moodle/grade:viewhidden', $coursecontext); } // Determine the number of rows and indentation. $this->maxdepth = 1; $this->inject_rowspans($this->gtree->top_element); $this->maxdepth++; // Need to account for the lead column that spans all children. for ($i = 1; $i <= $this->maxdepth; $i++) { $this->evenodd[$i] = 0; } $this->tabledata = []; // The base url for sorting by first/last name. $this->baseurl = new \moodle_url('/grade/report', ['id' => $courseid, 'userid' => $userid]); $this->pbarurl = $this->baseurl; // There no groups on this report - rank is from all course users. $this->setup_table(); // Optionally calculate grade item averages. $this->calculate_averages(); } /** * Recurse through a tree of elements setting the rowspan property on each element * * @param array $element Either the top element or, during recursion, the current element * @return int The number of elements processed */ public function inject_rowspans(array &$element): int { if ($element['depth'] > $this->maxdepth) { $this->maxdepth = $element['depth']; } if (empty($element['children'])) { return 1; } $count = 1; foreach ($element['children'] as $key => $child) { // If category is hidden then do not include it in the rowspan. if ($child['type'] == 'category' && $child['object']->is_hidden() && !$this->canviewhidden && ($this->showhiddenitems == GRADE_REPORT_USER_HIDE_HIDDEN || ($this->showhiddenitems == GRADE_REPORT_USER_HIDE_UNTIL && !$child['object']->is_hiddenuntil()))) { // Just calculate the rowspans for children of this category, don't add them to the count. $this->inject_rowspans($element['children'][$key]); } else { $count += $this->inject_rowspans($element['children'][$key]); // Take into consideration the addition of a new row (where the rowspan is defined) right after a category row. if ($child['type'] == 'category') { $count += 1; } } } $element['rowspan'] = $count; return $count; } /** * Prepares the headers and attributes of the flexitable. */ public function setup_table() { /* * Table has 1-8 columns *| All columns except for itemname/description are optional */ // Setting up table headers. $this->tablecolumns = ['itemname']; $this->tableheaders = [get_string('gradeitem', 'grades')]; if ($this->showweight) { $this->tablecolumns[] = 'weight'; $this->tableheaders[] = get_string('weightuc', 'grades'); } if ($this->showgrade) { $this->tablecolumns[] = 'grade'; $this->tableheaders[] = get_string('grade', 'grades'); } if ($this->showrange) { $this->tablecolumns[] = 'range'; $this->tableheaders[] = get_string('range', 'grades'); } if ($this->showpercentage) { $this->tablecolumns[] = 'percentage'; $this->tableheaders[] = get_string('percentage', 'grades'); } if ($this->showlettergrade) { $this->tablecolumns[] = 'lettergrade'; $this->tableheaders[] = get_string('lettergrade', 'grades'); } if ($this->showrank) { $this->tablecolumns[] = 'rank'; $this->tableheaders[] = get_string('rank', 'grades'); } if ($this->showaverage) { $this->tablecolumns[] = 'average'; $this->tableheaders[] = get_string('average', 'grades'); } if ($this->showfeedback) { $this->tablecolumns[] = 'feedback'; $this->tableheaders[] = get_string('feedback', 'grades'); } if ($this->showcontributiontocoursetotal) { $this->tablecolumns[] = 'contributiontocoursetotal'; $this->tableheaders[] = get_string('contributiontocoursetotal', 'grades'); } } /** * Provide an entry point to build the table. * * @return bool */ public function fill_table():bool { $this->fill_table_recursive($this->gtree->top_element); return true; } /** * Fill the table with data. * * @param array $element - The table data for the current row. */ private function fill_table_recursive(array &$element) { global $DB, $CFG, $OUTPUT; $type = $element['type']; $depth = $element['depth']; $gradeobject = $element['object']; $eid = $gradeobject->id; $element['userid'] = $userid = $this->user->id; $fullname = $this->gtree->get_element_header($element, true, false, true, false, true); $data = []; $gradeitemdata = []; $hidden = ''; $excluded = ''; $itemlevel = ($type == 'categoryitem' || $type == 'category' || $type == 'courseitem') ? $depth : ($depth + 1); $class = 'level' . $itemlevel; $classfeedback = ''; $rowspandata = []; // If this is a hidden grade category, hide it completely from the user. if ($type == 'category' && $gradeobject->is_hidden() && !$this->canviewhidden && ( $this->showhiddenitems == GRADE_REPORT_USER_HIDE_HIDDEN || ($this->showhiddenitems == GRADE_REPORT_USER_HIDE_UNTIL && !$gradeobject->is_hiddenuntil()))) { return false; } // Process those items that have scores associated. if ($type == 'item' || $type == 'categoryitem' || $type == 'courseitem') { $headerrow = "row_{$eid}_{$this->user->id}"; $headercat = "cat_{$gradeobject->categoryid}_{$this->user->id}"; if (! $gradegrade = grade_grade::fetch(['itemid' => $gradeobject->id, 'userid' => $this->user->id])) { $gradegrade = new grade_grade(); $gradegrade->userid = $this->user->id; $gradegrade->itemid = $gradeobject->id; } $gradegrade->load_grade_item(); // Hidden Items. if ($gradegrade->grade_item->is_hidden()) { $hidden = ' dimmed_text'; } $hide = false; // If this is a hidden grade item, hide it completely from the user. if ($gradegrade->is_hidden() && !$this->canviewhidden && ( $this->showhiddenitems == GRADE_REPORT_USER_HIDE_HIDDEN || ($this->showhiddenitems == GRADE_REPORT_USER_HIDE_UNTIL && !$gradegrade->is_hiddenuntil()))) { $hide = true; } else if (!empty($gradeobject->itemmodule) && !empty($gradeobject->iteminstance)) { // The grade object can be marked visible but still be hidden if // the student cannot see the activity due to conditional access // and it's set to be hidden entirely. $instances = $this->modinfo->get_instances_of($gradeobject->itemmodule); if (!empty($instances[$gradeobject->iteminstance])) { $cm = $instances[$gradeobject->iteminstance]; $gradeitemdata['cmid'] = $cm->id; if (!$cm->uservisible) { // If there is 'availableinfo' text then it is only greyed // out and not entirely hidden. if (!$cm->availableinfo) { $hide = true; } } } } // Actual Grade - We need to calculate this whether the row is hidden or not. $gradeval = $gradegrade->finalgrade; $hint = $gradegrade->get_aggregation_hint(); if (!$this->canviewhidden) { // Virtual Grade (may be calculated excluding hidden items etc). $adjustedgrade = $this->blank_hidden_total_and_adjust_bounds($this->courseid, $gradegrade->grade_item, $gradeval); $gradeval = $adjustedgrade['grade']; // We temporarily adjust the view of this grade item - because the min and // max are affected by the hidden values in the aggregation. $gradegrade->grade_item->grademax = $adjustedgrade['grademax']; $gradegrade->grade_item->grademin = $adjustedgrade['grademin']; $hint['status'] = $adjustedgrade['aggregationstatus']; $hint['weight'] = $adjustedgrade['aggregationweight']; } else { // The max and min for an aggregation may be different to the grade_item. if (!is_null($gradeval)) { $gradegrade->grade_item->grademax = $gradegrade->get_grade_max(); $gradegrade->grade_item->grademin = $gradegrade->get_grade_min(); } } if (!$hide) { $canviewall = has_capability('moodle/grade:viewall', $this->context); // Other class information. $class .= $hidden . $excluded; // Alter style based on whether aggregation is first or last. if ($this->switch) { $class .= ($type == 'categoryitem' || $type == 'courseitem') ? " d$depth baggt b2b" : " item b1b"; } else { $class .= ($type == 'categoryitem' || $type == 'courseitem') ? " d$depth baggb" : " item b1b"; } $itemicon = \html_writer::div($this->gtree->get_element_icon($element), 'mr-1'); $elementtype = $this->gtree->get_element_type_string($element); $itemtype = \html_writer::span($elementtype, 'd-block text-uppercase small dimmed_text', ['title' => $elementtype]); if ($type == 'categoryitem' || $type == 'courseitem') { $headercat = "cat_{$gradeobject->iteminstance}_{$this->user->id}"; } // Generate the content for a cell that represents a grade item. // If a behat test site is running avoid outputting the information about the type of the grade item. // This additional information causes issues in behat particularly with the existing xpath used to // interact with table elements. if (!defined('BEHAT_SITE_RUNNING')) { $content = \html_writer::div($itemtype . $fullname); } else { $content = \html_writer::div($fullname); } // Name. $data['itemname']['content'] = \html_writer::div($itemicon . $content, "{$type} d-flex align-items-center"); $data['itemname']['class'] = $class; $data['itemname']['colspan'] = ($this->maxdepth - $depth); $data['itemname']['id'] = $headerrow; // Basic grade item information. $gradeitemdata['id'] = $gradeobject->id; $gradeitemdata['itemname'] = $gradeobject->itemname; $gradeitemdata['itemtype'] = $gradeobject->itemtype; $gradeitemdata['itemmodule'] = $gradeobject->itemmodule; $gradeitemdata['iteminstance'] = $gradeobject->iteminstance; $gradeitemdata['itemnumber'] = $gradeobject->itemnumber; $gradeitemdata['idnumber'] = $gradeobject->idnumber; $gradeitemdata['categoryid'] = $gradeobject->categoryid; $gradeitemdata['outcomeid'] = $gradeobject->outcomeid; $gradeitemdata['scaleid'] = $gradeobject->outcomeid; $gradeitemdata['locked'] = $canviewall ? $gradegrade->grade_item->is_locked() : null; if ($this->showfeedback) { // Copy $class before appending itemcenter as feedback should not be centered. $classfeedback = $class; } $class .= " itemcenter "; if ($this->showweight) { $data['weight']['class'] = $class; $data['weight']['content'] = '-'; $data['weight']['headers'] = "$headercat $headerrow weight$userid"; // Has a weight assigned, might be extra credit. // This obliterates the weight because it provides a more informative description. if (is_numeric($hint['weight'])) { $data['weight']['content'] = format_float($hint['weight'] * 100.0, 2) . ' %'; $gradeitemdata['weightraw'] = $hint['weight']; $gradeitemdata['weightformatted'] = $data['weight']['content']; } if ($hint['status'] != 'used' && $hint['status'] != 'unknown') { $data['weight']['content'] .= '<br>' . get_string('aggregationhint' . $hint['status'], 'grades'); $gradeitemdata['status'] = $hint['status']; } } if ($this->showgrade) { $gradestatus = ''; // We only show status icons for a teacher if he views report as himself. if (isset($this->viewasuser) && !$this->viewasuser) { $context = [ 'hidden' => $gradegrade->is_hidden(), 'locked' => $gradegrade->is_locked(), 'overridden' => $gradegrade->is_overridden(), 'excluded' => $gradegrade->is_excluded() ]; if (in_array(true, $context)) { $context['classes'] = 'gradestatus'; $gradestatus = $OUTPUT->render_from_template('core_grades/status_icons', $context); } } $gradeitemdata['graderaw'] = null; $gradeitemdata['gradehiddenbydate'] = false; $gradeitemdata['gradeneedsupdate'] = $gradegrade->grade_item->needsupdate; $gradeitemdata['gradeishidden'] = $gradegrade->is_hidden(); $gradeitemdata['gradedatesubmitted'] = $gradegrade->get_datesubmitted(); $gradeitemdata['gradedategraded'] = $gradegrade->get_dategraded(); $gradeitemdata['gradeislocked'] = $canviewall ? $gradegrade->is_locked() : null; $gradeitemdata['gradeisoverridden'] = $canviewall ? $gradegrade->is_overridden() : null; if ($gradegrade->grade_item->needsupdate) { $data['grade']['class'] = $class.' gradingerror'; $data['grade']['content'] = get_string('error'); } else if ( !empty($CFG->grade_hiddenasdate) && $gradegrade->get_datesubmitted() && !$this->canviewhidden && $gradegrade->is_hidden() && !$gradegrade->grade_item->is_category_item() && !$gradegrade->grade_item->is_course_item() ) { // 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. $class .= ' datesubmitted'; $data['grade']['class'] = $class; $data['grade']['content'] = get_string( 'submittedon', 'grades', userdate( $gradegrade->get_datesubmitted(), get_string('strftimedatetimeshort') ) . $gradestatus ); $gradeitemdata['gradehiddenbydate'] = true; } else if ($gradegrade->is_hidden()) { $data['grade']['class'] = $class.' dimmed_text'; $data['grade']['content'] = '-'; if ($this->canviewhidden) { $gradeitemdata['graderaw'] = $gradeval; $data['grade']['content'] = grade_format_gradevalue($gradeval, $gradegrade->grade_item, true) . $gradestatus; } } else { $gradestatusclass = ''; $gradepassicon = ''; $ispassinggrade = $gradegrade->is_passed($gradegrade->grade_item); if (!is_null($ispassinggrade)) { $gradestatusclass = $ispassinggrade ? 'gradepass' : 'gradefail'; if ($ispassinggrade) { $gradepassicon = $OUTPUT->pix_icon( 'i/valid', get_string('pass', 'grades'), null, ['class' => 'inline'] ); } else { $gradepassicon = $OUTPUT->pix_icon( 'i/invalid', get_string('fail', 'grades'), null, ['class' => 'inline'] ); } } $data['grade']['class'] = "{$class} {$gradestatusclass}"; $data['grade']['content'] = $gradepassicon . grade_format_gradevalue($gradeval, $gradegrade->grade_item, true) . $gradestatus; $gradeitemdata['graderaw'] = $gradeval; } $data['grade']['headers'] = "$headercat $headerrow grade$userid"; $gradeitemdata['gradeformatted'] = $data['grade']['content']; } // Range. if ($this->showrange) { $data['range']['class'] = $class; $data['range']['content'] = $gradegrade->grade_item->get_formatted_range( GRADE_DISPLAY_TYPE_REAL, $this->rangedecimals ); $data['range']['headers'] = "$headercat $headerrow range$userid"; $gradeitemdata['rangeformatted'] = $data['range']['content']; $gradeitemdata['grademin'] = $gradegrade->grade_item->grademin; $gradeitemdata['grademax'] = $gradegrade->grade_item->grademax; } // Percentage. if ($this->showpercentage) { if ($gradegrade->grade_item->needsupdate) { $data['percentage']['class'] = $class.' gradingerror'; $data['percentage']['content'] = get_string('error'); } else if ($gradegrade->is_hidden()) { $data['percentage']['class'] = $class.' dimmed_text'; $data['percentage']['content'] = '-'; if ($this->canviewhidden) { $data['percentage']['content'] = grade_format_gradevalue( $gradeval, $gradegrade->grade_item, true, GRADE_DISPLAY_TYPE_PERCENTAGE ); } } else { $data['percentage']['class'] = $class; $data['percentage']['content'] = grade_format_gradevalue( $gradeval, $gradegrade->grade_item, true, GRADE_DISPLAY_TYPE_PERCENTAGE ); } $data['percentage']['headers'] = "$headercat $headerrow percentage$userid"; $gradeitemdata['percentageformatted'] = $data['percentage']['content']; } // Lettergrade. if ($this->showlettergrade) { if ($gradegrade->grade_item->needsupdate) { $data['lettergrade']['class'] = $class.' gradingerror'; $data['lettergrade']['content'] = get_string('error'); } else if ($gradegrade->is_hidden()) { $data['lettergrade']['class'] = $class.' dimmed_text'; if (!$this->canviewhidden) { $data['lettergrade']['content'] = '-'; } else { $data['lettergrade']['content'] = grade_format_gradevalue( $gradeval, $gradegrade->grade_item, true, GRADE_DISPLAY_TYPE_LETTER ); } } else { $data['lettergrade']['class'] = $class; $data['lettergrade']['content'] = grade_format_gradevalue( $gradeval, $gradegrade->grade_item, true, GRADE_DISPLAY_TYPE_LETTER ); } $data['lettergrade']['headers'] = "$headercat $headerrow lettergrade$userid"; $gradeitemdata['lettergradeformatted'] = $data['lettergrade']['content']; } // Rank. if ($this->showrank) { $gradeitemdata['rank'] = 0; if ($gradegrade->grade_item->needsupdate) { $data['rank']['class'] = $class.' gradingerror'; $data['rank']['content'] = get_string('error'); } else if ($gradegrade->is_hidden()) { $data['rank']['class'] = $class.' dimmed_text'; $data['rank']['content'] = '-'; } else if (is_null($gradeval)) { // No grade, o rank. $data['rank']['class'] = $class; $data['rank']['content'] = '-'; } else { // Find the number of users with a higher grade. $sql = "SELECT COUNT(DISTINCT(userid)) FROM {grade_grades} WHERE finalgrade > ? AND itemid = ? AND hidden = 0"; $rank = $DB->count_records_sql($sql, [$gradegrade->finalgrade, $gradegrade->grade_item->id]) + 1; $data['rank']['class'] = $class; $numusers = $this->get_numusers(false); $data['rank']['content'] = "$rank/$numusers"; // Total course users. $gradeitemdata['rank'] = $rank; $gradeitemdata['numusers'] = $numusers; } $data['rank']['headers'] = "$headercat $headerrow rank$userid"; } // Average. if ($this->showaverage) { $gradeitemdata['averageformatted'] = ''; $data['average']['class'] = $class; if (!empty($this->gtree->items[$eid]->avg)) { $data['average']['content'] = $this->gtree->items[$eid]->avg; $gradeitemdata['averageformatted'] = $this->gtree->items[$eid]->avg; } else { $data['average']['content'] = '-'; } $data['average']['headers'] = "$headercat $headerrow average$userid"; } // Feedback. if ($this->showfeedback) { $gradeitemdata['feedback'] = ''; $gradeitemdata['feedbackformat'] = $gradegrade->feedbackformat; if ($gradegrade->feedback) { $gradegrade->feedback = file_rewrite_pluginfile_urls( $gradegrade->feedback, 'pluginfile.php', $gradegrade->get_context()->id, GRADE_FILE_COMPONENT, GRADE_FEEDBACK_FILEAREA, $gradegrade->id ); } $data['feedback']['class'] = $classfeedback.' feedbacktext'; if (empty($gradegrade->feedback) || (!$this->canviewhidden && $gradegrade->is_hidden())) { $data['feedback']['content'] = ' '; } else { $data['feedback']['content'] = format_text($gradegrade->feedback, $gradegrade->feedbackformat, ['context' => $gradegrade->get_context()]); $gradeitemdata['feedback'] = $gradegrade->feedback; } $data['feedback']['headers'] = "$headercat $headerrow feedback$userid"; } // Contribution to the course total column. if ($this->showcontributiontocoursetotal) { $data['contributiontocoursetotal']['class'] = $class; $data['contributiontocoursetotal']['content'] = '-'; $data['contributiontocoursetotal']['headers'] = "$headercat $headerrow contributiontocoursetotal$userid"; } $this->gradeitemsdata[] = $gradeitemdata; } $parent = $gradeobject->load_parent_category(); if ($gradeobject->is_category_item()) { $parent = $parent->load_parent_category(); } // We collect the aggregation hints whether they are hidden or not. if ($this->showcontributiontocoursetotal) { $hint['grademax'] = $gradegrade->grade_item->grademax; $hint['grademin'] = $gradegrade->grade_item->grademin; $hint['grade'] = $gradeval; $hint['parent'] = $parent->load_grade_item()->id; $this->aggregationhints[$gradegrade->itemid] = $hint; } // Get the IDs of all parent categories of this grading item. $data['parentcategories'] = array_filter(explode('/', $gradeobject->parent_category->path)); } // Category. if ($type == 'category') { // Determine directionality so that icons can be modified to suit language. $arrow = right_to_left() ? 'left' : 'right'; // Alter style based on whether aggregation is first or last. if ($this->switch) { $data['itemname']['class'] = $class . ' ' . "d$depth b1b b1t category"; } else { $data['itemname']['class'] = $class . ' ' . "d$depth b2t category"; } $data['itemname']['colspan'] = ($this->maxdepth - $depth + count($this->tablecolumns)); $data['itemname']['content'] = $OUTPUT->render_from_template('gradereport_user/user_report_category_content', ['categoryid' => $gradeobject->id, 'categoryname' => $fullname, 'arrow' => $arrow]); $data['itemname']['id'] = "cat_{$gradeobject->id}_{$this->user->id}"; // Get the IDs of all parent categories of this grade category. $data['parentcategories'] = array_diff(array_filter(explode('/', $gradeobject->path)), [$gradeobject->id]); $rowspandata['leader']['class'] = $class . " d$depth b1t b2b b1l"; $rowspandata['leader']['rowspan'] = $element['rowspan']; $rowspandata['parentcategories'] = array_filter(explode('/', $gradeobject->path)); $rowspandata['spacer'] = true; } // Add this row to the overall system. foreach ($data as $key => $celldata) { if (isset($celldata['class'])) { $data[$key]['class'] .= ' column-' . $key; } } $this->tabledata[] = $data; if (!empty($rowspandata)) { $this->tabledata[] = $rowspandata; } // Recursively iterate through all child elements. if (isset($element['children'])) { foreach ($element['children'] as $key => $child) { $this->fill_table_recursive($element['children'][$key]); } } // Check we are showing this column, and we are looking at the root of the table. // This should be the very last thing this fill_table_recursive function does. if ($this->showcontributiontocoursetotal && ($type == 'category' && $depth == 1)) { // We should have collected all the hints by now - walk the tree again and build the contributions column. $this->fill_contributions_column($element); } } /** * This function is called after the table has been built and the aggregationhints * have been collected. We need this info to walk up the list of parents of each * grade_item. * * @param array $element - An array containing the table data for the current row. */ public function fill_contributions_column(array $element) { // Recursively iterate through all child elements. if (isset($element['children'])) { foreach ($element['children'] as $key => $child) { $this->fill_contributions_column($element['children'][$key]); } } else if ($element['type'] == 'item') { // This is a grade item (We don't do this for categories or we would double count). $gradeobject = $element['object']; $itemid = $gradeobject->id; // Ignore anything with no hint - e.g. a hidden row. if (isset($this->aggregationhints[$itemid])) { // Normalise the gradeval. $gradecat = $gradeobject->load_parent_category(); if ($gradecat->aggregation == GRADE_AGGREGATE_SUM) { // Natural aggregation/Sum of grades does not consider the mingrade, cannot traditionnally normalise it. $graderange = $this->aggregationhints[$itemid]['grademax']; if ($graderange != 0) { $gradeval = $this->aggregationhints[$itemid]['grade'] / $graderange; } else { $gradeval = 0; } } else { $gradeval = grade_grade::standardise_score( $this->aggregationhints[$itemid]['grade'], $this->aggregationhints[$itemid]['grademin'], $this->aggregationhints[$itemid]['grademax'], 0, 1 ); } // Multiply the normalised value by the weight // of all the categories higher in the tree. $parent = null; do { if (!is_null($this->aggregationhints[$itemid]['weight'])) { $gradeval *= $this->aggregationhints[$itemid]['weight']; } else if (empty($parent)) { // If we are in the first loop, and the weight is null, then we cannot calculate the contribution. $gradeval = null; break; } // The second part of this if is to prevent infinite loops // in case of crazy data. if (isset($this->aggregationhints[$itemid]['parent']) && $this->aggregationhints[$itemid]['parent'] != $itemid) { $parent = $this->aggregationhints[$itemid]['parent']; $itemid = $parent; } else { // We are at the top of the tree. $parent = false; } } while ($parent); // Finally multiply by the course grademax. if (!is_null($gradeval)) { // Convert to percent. $gradeval *= 100; } // Now we need to loop through the "built" table data and update the // contributions column for the current row. $headerrow = "row_{$gradeobject->id}_{$this->user->id}"; foreach ($this->tabledata as $key => $row) { if (isset($row['itemname']) && ($row['itemname']['id'] == $headerrow)) { // Found it - update the column. $content = '-'; if (!is_null($gradeval)) { $decimals = $gradeobject->get_decimals(); $content = format_float($gradeval, $decimals, true) . ' %'; } $this->tabledata[$key]['contributiontocoursetotal']['content'] = $content; break; } } } } } /** * Prints or returns the HTML from the flexitable. * * @param bool $return Whether or not to return the data instead of printing it directly. * @return string|void */ public function print_table(bool $return = false) { global $PAGE; $table = new \html_table(); $table->attributes = [ 'summary' => s(get_string('tablesummary', 'gradereport_user')), 'class' => 'generaltable boxaligncenter user-grade', ]; // Set the table headings. $userid = $this->user->id; foreach ($this->tableheaders as $index => $heading) { $headingcell = new \html_table_cell($heading); $headingcell->attributes['id'] = $this->tablecolumns[$index] . $userid; $headingcell->attributes['class'] = "header column-{$this->tablecolumns[$index]}"; if ($index == 0) { $headingcell->colspan = $this->maxdepth; } $table->head[] = $headingcell; } // Set the table body data. foreach ($this->tabledata as $rowdata) { $rowcells = []; // Set a rowspan cell, if applicable. if (isset($rowdata['leader'])) { $rowspancell = new \html_table_cell(''); $rowspancell->attributes['class'] = $rowdata['leader']['class']; $rowspancell->rowspan = $rowdata['leader']['rowspan']; $rowcells[] = $rowspancell; } // Set the row cells. foreach ($this->tablecolumns as $tablecolumn) { $content = $rowdata[$tablecolumn]['content'] ?? null; if (!is_null($content)) { $rowcell = new \html_table_cell($content); // Grade item names and cateogry names are referenced in the `headers` attribute of table cells. // These table cells should be set to <th> tags. if ($tablecolumn === 'itemname') { $rowcell->header = true; } if (isset($rowdata[$tablecolumn]['class'])) { $rowcell->attributes['class'] = $rowdata[$tablecolumn]['class']; } if (isset($rowdata[$tablecolumn]['colspan'])) { $rowcell->colspan = $rowdata[$tablecolumn]['colspan']; } if (isset($rowdata[$tablecolumn]['id'])) { $rowcell->id = $rowdata[$tablecolumn]['id']; } if (isset($rowdata[$tablecolumn]['headers'])) { $rowcell->attributes['headers'] = $rowdata[$tablecolumn]['headers']; } $rowcells[] = $rowcell; } } $tablerow = new \html_table_row($rowcells); // Generate classes which will be attributed to the current row and will be used to identify all parent // categories of this grading item or a category (e.g. 'cat_2 cat_5'). These classes are utilized by the // category toggle (expand/collapse) functionality. $classes = implode(" ", array_map(function($parentcategoryid) { return "cat_{$parentcategoryid}"; }, $rowdata['parentcategories'])); $classes .= isset($rowdata['spacer']) && $rowdata['spacer'] ? ' spacer' : ''; $tablerow->attributes = ['class' => $classes, 'data-hidden' => 'false']; $table->data[] = $tablerow; } $userreporttable = \html_writer::table($table); $PAGE->requires->js_call_amd('gradereport_user/gradecategorytoggle', 'init', ["user-report-{$this->user->id}"]); if ($return) { return \html_writer::div($userreporttable, 'user-report-container', ['id' => "user-report-{$this->user->id}"]); } echo \html_writer::div($userreporttable, 'user-report-container', ['id' => "user-report-{$this->user->id}"]); } /** * Processes the data sent by the form (grades and feedbacks). * * @param array $data Take in some data to provide to the base function. * @return void Success or Failure (array of errors). */ public function process_data($data): void { } /** * Stub function. * * @param string $target * @param string $action * @return void */ public function process_action($target, $action): void { } /** * Builds the grade item averages. */ private function calculate_averages() { global $USER, $DB, $CFG; if ($this->showaverage) { // This settings are actually grader report settings (not user report) // however we're using them as having two separate but identical settings the // user would have to keep in sync would be annoying. $averagesdisplaytype = $this->get_pref('averagesdisplaytype'); $averagesdecimalpoints = $this->get_pref('averagesdecimalpoints'); $meanselection = $this->get_pref('meanselection'); $shownumberofgrades = $this->get_pref('shownumberofgrades'); $avghtml = ''; $groupsql = $this->groupsql; $groupwheresql = $this->groupwheresql; $totalcount = $this->get_numusers(false); // 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. $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); list($enrolledsql, $enrolledparams) = get_enrolled_sql($this->context, '', 0, $showonlyactiveenrol); $params = array_merge($this->groupwheresql_params, $gradebookrolesparams, $enrolledparams, $relatedctxparams); $params['courseid'] = $this->courseid; // Find the 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 $groupsql WHERE gi.courseid = :courseid AND u.deleted = 0 AND gg.finalgrade IS NOT NULL AND gg.hidden = 0 $groupwheresql GROUP BY gg.itemid"; $sumarray = []; $sums = $DB->get_recordset_sql($sql, $params); foreach ($sums as $itemid => $csum) { $sumarray[$itemid] = $csum->sum; } $sums->close(); $columncount = 0; // 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. // This will include 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) $groupsql WHERE gi.courseid = :courseid AND gg.finalgrade IS NULL $groupwheresql GROUP BY gi.id"; $ungradedcounts = $DB->get_records_sql($sql, $params); foreach ($this->gtree->items as $itemid => $unused) { if (!empty($this->gtree->items[$itemid]->avg)) { continue; } $item = $this->gtree->items[$itemid]; if ($item->needsupdate) { $avghtml .= '<td class="cell c' . $columncount++.'">' . '<span class="gradingerror">'.get_string('error').'</span></td>'; continue; } if (empty($sumarray[$item->id])) { $sumarray[$item->id] = 0; } if (empty($ungradedcounts[$itemid])) { $ungradedcount = 0; } else { $ungradedcount = $ungradedcounts[$itemid]->count; } // Do they want the averages to include all grade items. if ($meanselection == GRADE_REPORT_MEAN_GRADED) { $meancount = $totalcount - $ungradedcount; } else { // Bump up the sum by the number of ungraded items * grademin. $sumarray[$item->id] += ($ungradedcount * $item->grademin); $meancount = $totalcount; } // Determine which display type to use for this average. if (isset($USER->editing) && $USER->editing) { $displaytype = GRADE_DISPLAY_TYPE_REAL; } else if ($averagesdisplaytype == GRADE_REPORT_PREFERENCE_INHERIT) { // No ==0 here, please resave the report and user preferences. $displaytype = $item->get_displaytype(); } else { $displaytype = $averagesdisplaytype; } // Override grade_item setting if a display preference (not inherit) was set for the averages. if ($averagesdecimalpoints == GRADE_REPORT_PREFERENCE_INHERIT) { $decimalpoints = $item->get_decimals(); } else { $decimalpoints = $averagesdecimalpoints; } if (empty($sumarray[$item->id]) || $meancount == 0) { $this->gtree->items[$itemid]->avg = '-'; } else { $sum = $sumarray[$item->id]; $avgradeval = $sum / $meancount; $gradehtml = grade_format_gradevalue($avgradeval, $item, true, $displaytype, $decimalpoints); $numberofgrades = ''; if ($shownumberofgrades) { $numberofgrades = " ($meancount)"; } $this->gtree->items[$itemid]->avg = $gradehtml.$numberofgrades; } } } } /** * Build the html for the zero state of the user report. * @return string HTML to display */ public function output_report_zerostate(): string { global $OUTPUT; $context = [ 'imglink' => $OUTPUT->image_url('zero_state', 'gradereport_user'), ]; return $OUTPUT->render_from_template('gradereport_user/zero_state', $context); } /** * Trigger the grade_report_viewed event * * @since Moodle 2.9 */ public function viewed() { $event = \gradereport_user\event\grade_report_viewed::create( [ 'context' => $this->context, 'courseid' => $this->courseid, 'relateduserid' => $this->user->id, ] ); $event->trigger(); } } report/user/classes/event/grade_report_viewed.php 0000604 00000003735 15062070556 0016356 0 ustar 00 <?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/>. /** * User report viewed event. * * @package gradereport_user * @copyright 2014 Adrian Greeve <adrian@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_user\event; defined('MOODLE_INTERNAL') || die(); /** * User report viewed event class. * * @package gradereport_user * @since Moodle 2.8 * @copyright 2014 Adrian Greeve <adrian@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class grade_report_viewed extends \core\event\grade_report_viewed { /** * Initialise the event data. * @return void */ protected function init(): void { parent::init(); $this->data['edulevel'] = self::LEVEL_PARTICIPATING; } /** * Returns localised general event name. * * @return string */ public static function get_name(): string { return get_string('eventgradereportviewed', 'gradereport_user'); } /** * Custom validation. * * Throw \coding_exception notice in case of any problems. */ protected function validate_data() { parent::validate_data(); if (!isset($this->relateduserid)) { throw new \coding_exception('The \'relateduserid\' value must be set.'); } } } report/user/classes/output/action_bar.php 0000604 00000007501 15062070556 0014651 0 ustar 00 <?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/>. namespace gradereport_user\output; use moodle_url; use core_grades\output\general_action_bar; /** * Renderable class for the action bar elements in the user report page. * * @package gradereport_user * @copyright 2022 Mihail Geshoski <mihail@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class action_bar extends \core_grades\output\action_bar { /** @var int|null $userid The user ID. */ protected $userid; /** @var int $userview The user report view mode. */ protected $userview; /** @var int|null $currentgroupid The user report view mode. */ protected $currentgroupid; /** * The class constructor. * * @param \context $context The context object. * @param int $userview The user report view mode. * @param int|null $userid The user ID or 0 if displaying all users. * @param int|null $currentgroupid The ID of the current group. */ public function __construct(\context $context, int $userview, ?int $userid = null, ?int $currentgroupid = null) { parent::__construct($context); $this->userview = $userview; $this->userid = $userid; $this->currentgroupid = $currentgroupid; } /** * Returns the template for the action bar. * * @return string */ public function get_template(): string { return 'gradereport_user/action_bar'; } /** * Export the data for the mustache template. * * @param \renderer_base $output renderer to be used to render the action bar elements. * @return array */ public function export_for_template(\renderer_base $output): array { global $PAGE, $USER; // If in the course context, we should display the general navigation selector in gradebook. $courseid = $this->context->instanceid; // Get the data used to output the general navigation selector. $generalnavselector = new general_action_bar($this->context, new moodle_url('/grade/report/user/index.php', ['id' => $courseid]), 'gradereport', 'user'); $data = $generalnavselector->export_for_template($output); // If the user has the capability to view all grades, display the group selector (if applicable), the user selector // and the view mode selector (if applicable). if (has_capability('moodle/grade:viewall', $this->context)) { $userreportrenderer = $PAGE->get_renderer('gradereport_user'); $data['groupselector'] = $PAGE->get_renderer('core_grades')->group_selector(get_course($courseid)); $data['userselector'] = [ 'courseid' => $courseid, 'content' => $userreportrenderer->users_selector(get_course($courseid), $this->userid, $this->currentgroupid) ]; // Do not output the 'view mode' selector when in zero state or when the current user is viewing its own report. if (!is_null($this->userid) && $USER->id != $this->userid) { $data['viewasselector'] = $userreportrenderer->view_mode_selector($this->userid, $this->userview, $courseid); } } return $data; } } report/user/classes/privacy/provider.php 0000604 00000005267 15062070556 0014526 0 ustar 00 <?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/>. /** * Privacy Subsystem implementation for gradereport_user. * * @package gradereport_user * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_user\privacy; defined('MOODLE_INTERNAL') || die(); use \core_privacy\local\metadata\collection; use \core_privacy\local\request\transform; use \core_privacy\local\request\writer; require_once $CFG->libdir.'/grade/constants.php'; /** * Privacy Subsystem for gradereport_user implementing null_provider. * * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class provider implements \core_privacy\local\metadata\provider, \core_privacy\local\request\user_preference_provider { /** * Returns meta data about this system. * * @param collection $itemcollection The initialised item collection to add items to. * @return collection A listing of user data stored through this system. */ public static function get_metadata(collection $items) : collection { // User preferences (shared between different courses). $items->add_user_preference('gradereport_user_view_user', 'privacy:metadata:preference:gradereport_user_view_user'); return $items; } /** * Store all user preferences for the plugin. * * @param int $userid The userid of the user whose data is to be exported. */ public static function export_user_preferences(int $userid) { $prefvalue = get_user_preferences('gradereport_user_view_user', null, $userid); if ($prefvalue !== null) { $transformedvalue = transform::yesno($prefvalue); writer::export_user_preference( 'gradereport_user', 'gradereport_user_view_user', $transformedvalue, get_string('privacy:metadata:preference:gradereport_user_view_user', 'gradereport_user') ); } } } report/user/db/upgrade.php 0000604 00000003016 15062070556 0011564 0 ustar 00 <?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/>. /** * Gradereport user plugin upgrade code * * @package gradereport_user * @copyright 2014 Zachary Durber * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); /** * @param int $oldversion the version we are upgrading from * @return bool result */ function xmldb_gradereport_user_upgrade($oldversion) { global $CFG; // Automatically generated Moodle v3.9.0 release upgrade line. // Put any upgrade step following this. // Automatically generated Moodle v4.0.0 release upgrade line. // Put any upgrade step following this. // Automatically generated Moodle v4.1.0 release upgrade line. // Put any upgrade step following this. // Automatically generated Moodle v4.2.0 release upgrade line. // Put any upgrade step following this. return true; } report/user/db/services.php 0000604 00000004541 15062070556 0011764 0 ustar 00 <?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/>. /** * User grade report external functions and service definitions. * * @package gradereport_user * @copyright 2015 Juan Leyva <juan@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die; $functions = [ 'gradereport_user_get_grades_table' => [ 'classname' => 'gradereport_user\\external\\user', 'methodname' => 'get_grades_table', 'description' => 'Get the user/s report grades table for a course', 'type' => 'read', 'capabilities' => 'gradereport/user:view', 'services' => [MOODLE_OFFICIAL_MOBILE_SERVICE], ], 'gradereport_user_view_grade_report' => [ 'classname' => 'gradereport_user\\external\\user', 'methodname' => 'view_grade_report', 'description' => 'Trigger the report view event', 'type' => 'write', 'capabilities' => 'gradereport/user:view', 'services' => [MOODLE_OFFICIAL_MOBILE_SERVICE], ], 'gradereport_user_get_grade_items' => [ 'classname' => 'gradereport_user\\external\\user', 'methodname' => 'get_grade_items', 'description' => 'Returns the complete list of grade items for users in a course', 'type' => 'read', 'capabilities' => 'gradereport/user:view', 'services' => [MOODLE_OFFICIAL_MOBILE_SERVICE], ], 'gradereport_user_get_access_information' => [ 'classname' => 'gradereport_user\external\get_access_information', 'methodname' => 'execute', 'description' => 'Returns user access information for the user grade report.', 'type' => 'read', 'services' => [MOODLE_OFFICIAL_MOBILE_SERVICE], ], ]; report/user/db/access.php 0000604 00000002441 15062070556 0011377 0 ustar 00 <?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/>. /** * Defines capabilities for the user report * * @package gradereport_user * @copyright 2007 onwards Martin Dougiamas (http://dougiamas.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); $capabilities = [ 'gradereport/user:view' => [ 'riskbitmask' => RISK_PERSONAL, 'captype' => 'read', 'contextlevel' => CONTEXT_COURSE, 'archetypes' => [ 'student' => CAP_ALLOW, 'teacher' => CAP_ALLOW, 'editingteacher' => CAP_ALLOW, 'manager' => CAP_ALLOW ] ], ]; report/user/amd/src/group.js 0000604 00000003554 15062070556 0012070 0 ustar 00 // 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/>. /** * Allow the user to search for groups within the user report. * * @module gradereport_user/group * @copyright 2023 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import GroupSearch from 'core_group/comboboxsearch/group'; import Url from 'core/url'; export default class Group extends GroupSearch { courseID; constructor() { super(); // Define our standard lookups. this.selectors = {...this.selectors, courseid: '[data-region="courseid"]', }; const component = document.querySelector(this.componentSelector()); this.courseID = component.querySelector(this.selectors.courseid).dataset.courseid; } static init() { return new Group(); } /** * Build up the view all link that is dedicated to a particular result. * * @param {Number} groupID The ID of the group selected. * @returns {string|*} */ selectOneLink(groupID) { return Url.relativeUrl('/grade/report/user/index.php', { id: this.courseID, groupsearchvalue: this.getSearchTerm(), group: groupID, }, false); } } report/user/amd/src/gradecategorytoggle.js 0000604 00000014030 15062070556 0014745 0 ustar 00 // 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/>. /** * Javascript module for toggling the visibility of the grade categories in the user report. * * @module gradereport_user/gradecategorytoggle * @copyright 2022 Mihail Geshoski <mihail@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ const SELECTORS = { CATEGORY_TOGGLE: '.toggle-category', USER_REPORT_TABLE: '.user-grade' }; /** * Register related event listeners. * * @method registerListenerEvents * @param {string} userReportId The ID of the user report container element. */ const registerListenerEvents = (userReportId) => { const reportContainer = document.querySelector('#' + userReportId); const userReport = reportContainer.querySelector(SELECTORS.USER_REPORT_TABLE); userReport.addEventListener('click', e => { const toggle = e.target.closest(SELECTORS.CATEGORY_TOGGLE); if (toggle) { e.preventDefault(); toggleCategory(toggle); } }); }; /** * Method that handles the category toggle action. * * @method toggleCategory * @param {object} toggleElement The category toggle node that was clicked. */ const toggleCategory = (toggleElement) => { const target = toggleElement.dataset.target; const categoryId = toggleElement.dataset.categoryid; // Whether the toggle action is collapsing the category or not. const isCollapsing = toggleElement.getAttribute('aria-expanded') === "true"; const userReport = toggleElement.closest(SELECTORS.USER_REPORT_TABLE); // Find all targeted 'children' rows of the toggled category. const targetRows = userReport.querySelectorAll(target); if (isCollapsing) { toggleElement.setAttribute('aria-expanded', 'false'); // Update the 'data-target' of the toggle category node to make sure that when we perform another toggle action // to expand this category we only target rows which have been hidden by this category toggle action. toggleElement.dataset.target = `[data-hidden-by='${categoryId}']`; } else { toggleElement.setAttribute('aria-expanded', 'true'); // Update the 'data-target' of the toggle category node to make sure that when we perform another toggle action // to collapse this category we only target rows which are children of this category and are not currently hidden. toggleElement.dataset.target = `.cat_${categoryId}[data-hidden='false']`; } // Loop through all targeted children row elements and update the required data attributes to either hide or show // them depending on the toggle action (collapsing or expanding). targetRows.forEach((row) => { if (isCollapsing) { row.dataset.hidden = 'true'; row.dataset.hiddenBy = categoryId; } else { row.dataset.hidden = 'false'; row.dataset.hiddenBy = ''; } }); // Since the user report is presented in an HTML table, rowspans are used under each category to create a visual // hierarchy between categories and grading items. When expanding or collapsing a category we need to also update // (subtract or add) the rowspan values associated to each parent category row to preserve the correct visual // hierarchy in the table. updateParentCategoryRowspans(toggleElement, targetRows.length); }; /** * Method that updates the rowspan value of all 'parent' category rows of a given category node. * * @method updateParentCategoryRowspans * @param {object} toggleElement The category toggle node that was clicked. * @param {int} num The number we want to add or subtract from the rowspan value of the 'parent' category row elements. */ const updateParentCategoryRowspans = (toggleElement, num) => { const userReport = toggleElement.closest(SELECTORS.USER_REPORT_TABLE); // Get the row element which contains the category toggle node. const rowElement = toggleElement.closest('tr'); // Loop through the class list of the toggle category row element. // The list contains classes which identify all parent categories of the toggled category. rowElement.classList.forEach((className) => { // Find the toggle node of the 'parent' category that is identified by the given class name. const parentCategoryToggleElement = userReport.querySelector(`[data-target=".${className}[data-hidden='false']"`); if (parentCategoryToggleElement) { // Get the row element which contains the parent category toggle node. const categoryRowElement = parentCategoryToggleElement.closest('tr'); // Find the rowspan element associated to this parent category. const categoryRowSpanElement = categoryRowElement.nextElementSibling.querySelector('[rowspan]'); // Depending on whether the toggle action has expanded or collapsed the category, either add or // subtract from the 'parent' category rowspan. if (toggleElement.getAttribute('aria-expanded') === "true") { categoryRowSpanElement.rowSpan = categoryRowSpanElement.rowSpan + num; } else { // The category has been collapsed. categoryRowSpanElement.rowSpan = categoryRowSpanElement.rowSpan - num; } } }); }; /** * Init method. * * @param {string} userReportId The ID of the user report container element. */ export const init = (userReportId) => { registerListenerEvents(userReportId); }; report/user/amd/src/user.js 0000604 00000005635 15062070556 0011714 0 ustar 00 // 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/>. /** * Allow the user to search for learners within the user report. * * @module gradereport_user/user * @copyright 2023 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import UserSearch from 'core_user/comboboxsearch/user'; import Url from 'core/url'; import {renderForPromise, replaceNodeContents} from 'core/templates'; import * as Repository from 'core_grades/searchwidget/repository'; export default class User extends UserSearch { constructor() { super(); } static init() { return new User(); } /** * Build the content then replace the node. */ async renderDropdown() { const {html, js} = await renderForPromise('core_user/comboboxsearch/resultset', { users: this.getMatchedResults().slice(0, 5), hasresults: this.getMatchedResults().length > 0, matches: this.getDatasetSize(), searchterm: this.getSearchTerm(), selectall: this.selectAllResultsLink(), }); replaceNodeContents(this.getHTMLElements().searchDropdown, html, js); } /** * Build up the view all link. * * @returns {string|*} */ selectAllResultsLink() { return Url.relativeUrl('/grade/report/user/index.php', { id: this.courseID, userid: 0, searchvalue: this.getSearchTerm() }, false); } /** * Build up the view all link that is dedicated to a particular result. * * @param {Number} userID The ID of the user selected. * @returns {string|*} */ selectOneLink(userID) { return Url.relativeUrl('/grade/report/user/index.php', { id: this.courseID, searchvalue: this.getSearchTerm(), userid: userID, }, false); } /** * Get the data we will be searching against in this component. * * @returns {Promise<*>} */ fetchDataset() { // Small typing checks as sometimes groups don't exist therefore the element returns a empty string. const gts = typeof (this.groupID) === "string" && this.groupID === '' ? 0 : this.groupID; return Repository.userFetch(this.courseID, gts).then((r) => r.users); } } report/user/amd/build/group.min.js 0000604 00000002060 15062070556 0013151 0 ustar 00 define("gradereport_user/group",["exports","core_group/comboboxsearch/group","core/url"],(function(_exports,_group,_url){function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}}Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.default=void 0,_group=_interopRequireDefault(_group),_url=_interopRequireDefault(_url);class Group extends _group.default{constructor(){var obj,key,value;super(),value=void 0,(key="courseID")in(obj=this)?Object.defineProperty(obj,key,{value:value,enumerable:!0,configurable:!0,writable:!0}):obj[key]=value,this.selectors={...this.selectors,courseid:'[data-region="courseid"]'};const component=document.querySelector(this.componentSelector());this.courseID=component.querySelector(this.selectors.courseid).dataset.courseid}static init(){return new Group}selectOneLink(groupID){return _url.default.relativeUrl("/grade/report/user/index.php",{id:this.courseID,groupsearchvalue:this.getSearchTerm(),group:groupID},!1)}}return _exports.default=Group,_exports.default})); //# sourceMappingURL=group.min.js.map report/user/amd/build/user.min.js.map 0000604 00000010034 15062070556 0013547 0 ustar 00 {"version":3,"file":"user.min.js","sources":["../src/user.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Allow the user to search for learners within the user report.\n *\n * @module gradereport_user/user\n * @copyright 2023 Mathew May <mathew.solutions>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\nimport UserSearch from 'core_user/comboboxsearch/user';\nimport Url from 'core/url';\nimport {renderForPromise, replaceNodeContents} from 'core/templates';\nimport * as Repository from 'core_grades/searchwidget/repository';\n\nexport default class User extends UserSearch {\n\n constructor() {\n super();\n }\n\n static init() {\n return new User();\n }\n\n /**\n * Build the content then replace the node.\n */\n async renderDropdown() {\n const {html, js} = await renderForPromise('core_user/comboboxsearch/resultset', {\n users: this.getMatchedResults().slice(0, 5),\n hasresults: this.getMatchedResults().length > 0,\n matches: this.getDatasetSize(),\n searchterm: this.getSearchTerm(),\n selectall: this.selectAllResultsLink(),\n });\n replaceNodeContents(this.getHTMLElements().searchDropdown, html, js);\n }\n\n /**\n * Build up the view all link.\n *\n * @returns {string|*}\n */\n selectAllResultsLink() {\n return Url.relativeUrl('/grade/report/user/index.php', {\n id: this.courseID,\n userid: 0,\n searchvalue: this.getSearchTerm()\n }, false);\n }\n\n /**\n * Build up the view all link that is dedicated to a particular result.\n *\n * @param {Number} userID The ID of the user selected.\n * @returns {string|*}\n */\n selectOneLink(userID) {\n return Url.relativeUrl('/grade/report/user/index.php', {\n id: this.courseID,\n searchvalue: this.getSearchTerm(),\n userid: userID,\n }, false);\n }\n\n /**\n * Get the data we will be searching against in this component.\n *\n * @returns {Promise<*>}\n */\n fetchDataset() {\n // Small typing checks as sometimes groups don't exist therefore the element returns a empty string.\n const gts = typeof (this.groupID) === \"string\" && this.groupID === '' ? 0 : this.groupID;\n return Repository.userFetch(this.courseID, gts).then((r) => r.users);\n }\n}\n"],"names":["User","UserSearch","constructor","html","js","users","this","getMatchedResults","slice","hasresults","length","matches","getDatasetSize","searchterm","getSearchTerm","selectall","selectAllResultsLink","getHTMLElements","searchDropdown","Url","relativeUrl","id","courseID","userid","searchvalue","selectOneLink","userID","fetchDataset","gts","groupID","Repository","userFetch","then","r"],"mappings":";;;;;;;q0BA2BqBA,aAAaC,cAE9BC,2CAKW,IAAIF,kCAOLG,KAACA,KAADC,GAAOA,UAAY,+BAAiB,qCAAsC,CAC5EC,MAAOC,KAAKC,oBAAoBC,MAAM,EAAG,GACzCC,WAAYH,KAAKC,oBAAoBG,OAAS,EAC9CC,QAASL,KAAKM,iBACdC,WAAYP,KAAKQ,gBACjBC,UAAWT,KAAKU,4DAEAV,KAAKW,kBAAkBC,eAAgBf,KAAMC,IAQrEY,8BACWG,aAAIC,YAAY,+BAAgC,CACnDC,GAAIf,KAAKgB,SACTC,OAAQ,EACRC,YAAalB,KAAKQ,kBACnB,GASPW,cAAcC,eACHP,aAAIC,YAAY,+BAAgC,CACnDC,GAAIf,KAAKgB,SACTE,YAAalB,KAAKQ,gBAClBS,OAAQG,SACT,GAQPC,qBAEUC,IAAgC,iBAAlBtB,KAAKuB,SAA0C,KAAjBvB,KAAKuB,QAAiB,EAAIvB,KAAKuB,eAC1EC,WAAWC,UAAUzB,KAAKgB,SAAUM,KAAKI,MAAMC,GAAMA,EAAE5B"} report/user/amd/build/user.min.js 0000604 00000005127 15062070556 0013002 0 ustar 00 define("gradereport_user/user",["exports","core_user/comboboxsearch/user","core/url","core/templates","core_grades/searchwidget/repository"],(function(_exports,_user,_url,_templates,Repository){function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}} /** * Allow the user to search for learners within the user report. * * @module gradereport_user/user * @copyright 2023 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.default=void 0,_user=_interopRequireDefault(_user),_url=_interopRequireDefault(_url),Repository=function(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}newObj.default=obj,cache&&cache.set(obj,newObj);return newObj}(Repository);class User extends _user.default{constructor(){super()}static init(){return new User}async renderDropdown(){const{html:html,js:js}=await(0,_templates.renderForPromise)("core_user/comboboxsearch/resultset",{users:this.getMatchedResults().slice(0,5),hasresults:this.getMatchedResults().length>0,matches:this.getDatasetSize(),searchterm:this.getSearchTerm(),selectall:this.selectAllResultsLink()});(0,_templates.replaceNodeContents)(this.getHTMLElements().searchDropdown,html,js)}selectAllResultsLink(){return _url.default.relativeUrl("/grade/report/user/index.php",{id:this.courseID,userid:0,searchvalue:this.getSearchTerm()},!1)}selectOneLink(userID){return _url.default.relativeUrl("/grade/report/user/index.php",{id:this.courseID,searchvalue:this.getSearchTerm(),userid:userID},!1)}fetchDataset(){const gts="string"==typeof this.groupID&&""===this.groupID?0:this.groupID;return Repository.userFetch(this.courseID,gts).then((r=>r.users))}}return _exports.default=User,_exports.default})); //# sourceMappingURL=user.min.js.map report/user/amd/build/group.min.js.map 0000604 00000004775 15062070556 0013744 0 ustar 00 {"version":3,"file":"group.min.js","sources":["../src/group.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Allow the user to search for groups within the user report.\n *\n * @module gradereport_user/group\n * @copyright 2023 Mathew May <mathew.solutions>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\nimport GroupSearch from 'core_group/comboboxsearch/group';\nimport Url from 'core/url';\n\nexport default class Group extends GroupSearch {\n\n courseID;\n\n constructor() {\n super();\n\n // Define our standard lookups.\n this.selectors = {...this.selectors,\n courseid: '[data-region=\"courseid\"]',\n };\n const component = document.querySelector(this.componentSelector());\n this.courseID = component.querySelector(this.selectors.courseid).dataset.courseid;\n }\n\n static init() {\n return new Group();\n }\n\n /**\n * Build up the view all link that is dedicated to a particular result.\n *\n * @param {Number} groupID The ID of the group selected.\n * @returns {string|*}\n */\n selectOneLink(groupID) {\n return Url.relativeUrl('/grade/report/user/index.php', {\n id: this.courseID,\n groupsearchvalue: this.getSearchTerm(),\n group: groupID,\n }, false);\n }\n}\n"],"names":["Group","GroupSearch","constructor","selectors","this","courseid","component","document","querySelector","componentSelector","courseID","dataset","selectOneLink","groupID","Url","relativeUrl","id","groupsearchvalue","getSearchTerm","group"],"mappings":"yWAyBqBA,cAAcC,eAI/BC,6LAISC,UAAY,IAAIC,KAAKD,UACtBE,SAAU,kCAERC,UAAYC,SAASC,cAAcJ,KAAKK,0BACzCC,SAAWJ,UAAUE,cAAcJ,KAAKD,UAAUE,UAAUM,QAAQN,8BAIlE,IAAIL,MASfY,cAAcC,gBACHC,aAAIC,YAAY,+BAAgC,CACnDC,GAAIZ,KAAKM,SACTO,iBAAkBb,KAAKc,gBACvBC,MAAON,UACR"} report/user/amd/build/gradecategorytoggle.min.js.map 0000604 00000017217 15062070556 0016625 0 ustar 00 {"version":3,"file":"gradecategorytoggle.min.js","sources":["../src/gradecategorytoggle.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Javascript module for toggling the visibility of the grade categories in the user report.\n *\n * @module gradereport_user/gradecategorytoggle\n * @copyright 2022 Mihail Geshoski <mihail@moodle.com>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nconst SELECTORS = {\n CATEGORY_TOGGLE: '.toggle-category',\n USER_REPORT_TABLE: '.user-grade'\n};\n\n/**\n * Register related event listeners.\n *\n * @method registerListenerEvents\n * @param {string} userReportId The ID of the user report container element.\n */\nconst registerListenerEvents = (userReportId) => {\n const reportContainer = document.querySelector('#' + userReportId);\n const userReport = reportContainer.querySelector(SELECTORS.USER_REPORT_TABLE);\n\n userReport.addEventListener('click', e => {\n const toggle = e.target.closest(SELECTORS.CATEGORY_TOGGLE);\n\n if (toggle) {\n e.preventDefault();\n toggleCategory(toggle);\n }\n });\n};\n\n/**\n * Method that handles the category toggle action.\n *\n * @method toggleCategory\n * @param {object} toggleElement The category toggle node that was clicked.\n */\nconst toggleCategory = (toggleElement) => {\n const target = toggleElement.dataset.target;\n const categoryId = toggleElement.dataset.categoryid;\n // Whether the toggle action is collapsing the category or not.\n const isCollapsing = toggleElement.getAttribute('aria-expanded') === \"true\";\n const userReport = toggleElement.closest(SELECTORS.USER_REPORT_TABLE);\n\n // Find all targeted 'children' rows of the toggled category.\n const targetRows = userReport.querySelectorAll(target);\n\n if (isCollapsing) {\n toggleElement.setAttribute('aria-expanded', 'false');\n // Update the 'data-target' of the toggle category node to make sure that when we perform another toggle action\n // to expand this category we only target rows which have been hidden by this category toggle action.\n toggleElement.dataset.target = `[data-hidden-by='${categoryId}']`;\n } else {\n toggleElement.setAttribute('aria-expanded', 'true');\n // Update the 'data-target' of the toggle category node to make sure that when we perform another toggle action\n // to collapse this category we only target rows which are children of this category and are not currently hidden.\n toggleElement.dataset.target = `.cat_${categoryId}[data-hidden='false']`;\n }\n\n // Loop through all targeted children row elements and update the required data attributes to either hide or show\n // them depending on the toggle action (collapsing or expanding).\n targetRows.forEach((row) => {\n if (isCollapsing) {\n row.dataset.hidden = 'true';\n row.dataset.hiddenBy = categoryId;\n } else {\n row.dataset.hidden = 'false';\n row.dataset.hiddenBy = '';\n }\n });\n\n // Since the user report is presented in an HTML table, rowspans are used under each category to create a visual\n // hierarchy between categories and grading items. When expanding or collapsing a category we need to also update\n // (subtract or add) the rowspan values associated to each parent category row to preserve the correct visual\n // hierarchy in the table.\n updateParentCategoryRowspans(toggleElement, targetRows.length);\n};\n\n/**\n * Method that updates the rowspan value of all 'parent' category rows of a given category node.\n *\n * @method updateParentCategoryRowspans\n * @param {object} toggleElement The category toggle node that was clicked.\n * @param {int} num The number we want to add or subtract from the rowspan value of the 'parent' category row elements.\n */\nconst updateParentCategoryRowspans = (toggleElement, num) => {\n const userReport = toggleElement.closest(SELECTORS.USER_REPORT_TABLE);\n // Get the row element which contains the category toggle node.\n const rowElement = toggleElement.closest('tr');\n\n // Loop through the class list of the toggle category row element.\n // The list contains classes which identify all parent categories of the toggled category.\n rowElement.classList.forEach((className) => {\n // Find the toggle node of the 'parent' category that is identified by the given class name.\n const parentCategoryToggleElement = userReport.querySelector(`[data-target=\".${className}[data-hidden='false']\"`);\n if (parentCategoryToggleElement) {\n // Get the row element which contains the parent category toggle node.\n const categoryRowElement = parentCategoryToggleElement.closest('tr');\n // Find the rowspan element associated to this parent category.\n const categoryRowSpanElement = categoryRowElement.nextElementSibling.querySelector('[rowspan]');\n\n // Depending on whether the toggle action has expanded or collapsed the category, either add or\n // subtract from the 'parent' category rowspan.\n if (toggleElement.getAttribute('aria-expanded') === \"true\") {\n categoryRowSpanElement.rowSpan = categoryRowSpanElement.rowSpan + num;\n } else { // The category has been collapsed.\n categoryRowSpanElement.rowSpan = categoryRowSpanElement.rowSpan - num;\n }\n }\n });\n};\n\n/**\n * Init method.\n *\n * @param {string} userReportId The ID of the user report container element.\n */\nexport const init = (userReportId) => {\n registerListenerEvents(userReportId);\n};\n"],"names":["SELECTORS","toggleCategory","toggleElement","target","dataset","categoryId","categoryid","isCollapsing","getAttribute","targetRows","closest","querySelectorAll","setAttribute","forEach","row","hidden","hiddenBy","updateParentCategoryRowspans","length","num","userReport","classList","className","parentCategoryToggleElement","querySelector","categoryRowSpanElement","nextElementSibling","rowSpan","userReportId","document","addEventListener","e","toggle","preventDefault","registerListenerEvents"],"mappings":";;;;;;;;MAuBMA,0BACe,mBADfA,4BAEiB,cA6BjBC,eAAkBC,sBACdC,OAASD,cAAcE,QAAQD,OAC/BE,WAAaH,cAAcE,QAAQE,WAEnCC,aAA+D,SAAhDL,cAAcM,aAAa,iBAI1CC,WAHaP,cAAcQ,QAAQV,6BAGXW,iBAAiBR,QAE3CI,cACAL,cAAcU,aAAa,gBAAiB,SAG5CV,cAAcE,QAAQD,kCAA6BE,mBAEnDH,cAAcU,aAAa,gBAAiB,QAG5CV,cAAcE,QAAQD,sBAAiBE,qCAK3CI,WAAWI,SAASC,MACZP,cACAO,IAAIV,QAAQW,OAAS,OACrBD,IAAIV,QAAQY,SAAWX,aAEvBS,IAAIV,QAAQW,OAAS,QACrBD,IAAIV,QAAQY,SAAW,OAQ/BC,6BAA6Bf,cAAeO,WAAWS,SAUrDD,6BAA+B,CAACf,cAAeiB,aAC3CC,WAAalB,cAAcQ,QAAQV,6BAEtBE,cAAcQ,QAAQ,MAI9BW,UAAUR,SAASS,kBAEpBC,4BAA8BH,WAAWI,uCAAgCF,yCAC3EC,4BAA6B,OAIvBE,uBAFqBF,4BAA4Bb,QAAQ,MAEbgB,mBAAmBF,cAAc,aAI/B,SAAhDtB,cAAcM,aAAa,iBAC3BiB,uBAAuBE,QAAUF,uBAAuBE,QAAUR,IAElEM,uBAAuBE,QAAUF,uBAAuBE,QAAUR,uBAW7DS,eApGWA,CAAAA,eACJC,SAASL,cAAc,IAAMI,cAClBJ,cAAcxB,6BAEtC8B,iBAAiB,SAASC,UAC3BC,OAASD,EAAE5B,OAAOO,QAAQV,2BAE5BgC,SACAD,EAAEE,iBACFhC,eAAe+B,aA4FvBE,CAAuBN"} report/user/amd/build/gradecategorytoggle.min.js 0000604 00000004356 15062070556 0016051 0 ustar 00 define("gradereport_user/gradecategorytoggle",["exports"],(function(_exports){Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.init=void 0; /** * Javascript module for toggling the visibility of the grade categories in the user report. * * @module gradereport_user/gradecategorytoggle * @copyright 2022 Mihail Geshoski <mihail@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ const SELECTORS_CATEGORY_TOGGLE=".toggle-category",SELECTORS_USER_REPORT_TABLE=".user-grade",toggleCategory=toggleElement=>{const target=toggleElement.dataset.target,categoryId=toggleElement.dataset.categoryid,isCollapsing="true"===toggleElement.getAttribute("aria-expanded"),targetRows=toggleElement.closest(SELECTORS_USER_REPORT_TABLE).querySelectorAll(target);isCollapsing?(toggleElement.setAttribute("aria-expanded","false"),toggleElement.dataset.target="[data-hidden-by='".concat(categoryId,"']")):(toggleElement.setAttribute("aria-expanded","true"),toggleElement.dataset.target=".cat_".concat(categoryId,"[data-hidden='false']")),targetRows.forEach((row=>{isCollapsing?(row.dataset.hidden="true",row.dataset.hiddenBy=categoryId):(row.dataset.hidden="false",row.dataset.hiddenBy="")})),updateParentCategoryRowspans(toggleElement,targetRows.length)},updateParentCategoryRowspans=(toggleElement,num)=>{const userReport=toggleElement.closest(SELECTORS_USER_REPORT_TABLE);toggleElement.closest("tr").classList.forEach((className=>{const parentCategoryToggleElement=userReport.querySelector('[data-target=".'.concat(className,"[data-hidden='false']\""));if(parentCategoryToggleElement){const categoryRowSpanElement=parentCategoryToggleElement.closest("tr").nextElementSibling.querySelector("[rowspan]");"true"===toggleElement.getAttribute("aria-expanded")?categoryRowSpanElement.rowSpan=categoryRowSpanElement.rowSpan+num:categoryRowSpanElement.rowSpan=categoryRowSpanElement.rowSpan-num}}))};_exports.init=userReportId=>{(userReportId=>{document.querySelector("#"+userReportId).querySelector(SELECTORS_USER_REPORT_TABLE).addEventListener("click",(e=>{const toggle=e.target.closest(SELECTORS_CATEGORY_TOGGLE);toggle&&(e.preventDefault(),toggleCategory(toggle))}))})(userReportId)}})); //# sourceMappingURL=gradecategorytoggle.min.js.map report/user/tests/externallib_test.php 0000604 00000050233 15062070556 0014265 0 ustar 00 <?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/>. namespace gradereport_user; use core_external\external_api; use externallib_advanced_testcase; use gradereport_user\external\user as user_external; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once($CFG->dirroot . '/webservice/tests/helpers.php'); /** * User grade report functions unit tests * * @package gradereport_user * @category external * @copyright 2015 Juan Leyva <juan@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class externallib_test extends externallib_advanced_testcase { /** * Loads some data to be used by the different tests * @param int $s1grade Student 1 grade * @param int $s2grade Student 2 grade * @return array Course and users instances */ private function load_data(int $s1grade, int $s2grade): array { global $DB; $course = $this->getDataGenerator()->create_course(['groupmode' => SEPARATEGROUPS, 'groupmodeforce' => 1]); $studentrole = $DB->get_record('role', ['shortname' => 'student']); $student1 = $this->getDataGenerator()->create_user(['idnumber' => 'testidnumber']); $this->getDataGenerator()->enrol_user($student1->id, $course->id, $studentrole->id); $student2 = $this->getDataGenerator()->create_user(); $this->getDataGenerator()->enrol_user($student2->id, $course->id, $studentrole->id); $teacherrole = $DB->get_record('role', ['shortname' => 'teacher']); $teacher = $this->getDataGenerator()->create_user(); $this->getDataGenerator()->enrol_user($teacher->id, $course->id, $teacherrole->id); $context = \context_course::instance($course->id); assign_capability('moodle/site:accessallgroups', CAP_PROHIBIT, $teacherrole->id, $context); accesslib_clear_all_caches_for_unit_testing(); $group1 = $this->getDataGenerator()->create_group(['courseid' => $course->id]); $group2 = $this->getDataGenerator()->create_group(['courseid' => $course->id]); groups_add_member($group1->id, $student1->id); groups_add_member($group1->id, $teacher->id); groups_add_member($group2->id, $student2->id); $assignment = $this->getDataGenerator()->create_module('assign', ['name' => "Test assign", 'course' => $course->id]); $modcontext = get_coursemodule_from_instance('assign', $assignment->id, $course->id); $assignment->cmidnumber = $modcontext->id; $student1grade = ['userid' => $student1->id, 'rawgrade' => $s1grade, 'idnumber' => 'testidnumber1']; $student2grade = ['userid' => $student2->id, 'rawgrade' => $s2grade, 'idnumber' => 'testidnumber2']; $studentgrades = [$student1->id => $student1grade, $student2->id => $student2grade]; assign_grade_item_update($assignment, $studentgrades); return [ $course, $teacher, $student1, $student2, $assignment ]; } /** * Test get_grades_table function case teacher */ public function test_get_grades_table_teacher() { $this->resetAfterTest(true); $s1grade = 80; $s2grade = 60; list($course, $teacher, $student1, $student2, $assignment) = $this->load_data($s1grade, $s2grade); // A teacher must see all student grades (in their group only). $this->setUser($teacher); $studentgrades = user_external::get_grades_table($course->id); $studentgrades = external_api::clean_returnvalue(user_external::get_grades_table_returns(), $studentgrades); // No warnings returned. $this->assertCount(0, $studentgrades['warnings']); // Check that only grades for the student in the teacher group are returned. $this->assertCount(1, $studentgrades['tables']); // Read returned grades. $studentreturnedgrades = []; $studentreturnedgrades[$studentgrades['tables'][0]['userid']] = (int) $studentgrades['tables'][0]['tabledata'][2]['grade']['content']; $this->assertEquals($s1grade, $studentreturnedgrades[$student1->id]); } /** * Test get_grades_table function case student */ public function test_get_grades_table_student() { global $CFG, $DB; $this->resetAfterTest(true); $s1grade = 80; $s2grade = 60; list($course, $teacher, $student1, $student2, $assignment) = $this->load_data($s1grade, $s2grade); // A user can see his own grades. $this->setUser($student1); $studentgrade = user_external::get_grades_table($course->id, $student1->id); $studentgrade = external_api::clean_returnvalue(user_external::get_grades_table_returns(), $studentgrade); // No warnings returned. $this->assertTrue(count($studentgrade['warnings']) == 0); $this->assertTrue(count($studentgrade['tables']) == 1); $student1returnedgrade = (int) $studentgrade['tables'][0]['tabledata'][2]['grade']['content']; $this->assertEquals($s1grade, $student1returnedgrade); } /** * Test get_grades_table function case incorrect permissions */ public function test_get_grades_table_permissions() { global $CFG, $DB; $this->resetAfterTest(true); $s1grade = 80; $s2grade = 60; list($course, $teacher, $student1, $student2, $assignment) = $this->load_data($s1grade, $s2grade); $this->setUser($student2); try { $studentgrade = user_external::get_grades_table($course->id, $student1->id); $this->fail('Exception expected due to not perissions to view other user grades.'); } catch (\moodle_exception $e) { $this->assertEquals('notingroup', $e->errorcode); } } /** * Test view_grade_report function */ public function test_view_grade_report() { global $USER; $this->resetAfterTest(true); $s1grade = 80; $s2grade = 60; list($course, $teacher, $student1, $student2, $assignment) = $this->load_data($s1grade, $s2grade); // Redirect events to the sink, so we can recover them later. $sink = $this->redirectEvents(); $this->setUser($student1); $result = user_external::view_grade_report($course->id); $result = external_api::clean_returnvalue(user_external::view_grade_report_returns(), $result); $events = $sink->get_events(); $this->assertCount(1, $events); $event = reset($events); // Check the event details are correct. $this->assertInstanceOf('\gradereport_user\event\grade_report_viewed', $event); $this->assertEquals(\context_course::instance($course->id), $event->get_context()); $this->assertEquals($USER->id, $event->get_data()['relateduserid']); $this->setUser($teacher); $result = user_external::view_grade_report($course->id, $student1->id); $result = external_api::clean_returnvalue(user_external::view_grade_report_returns(), $result); $events = $sink->get_events(); $event = reset($events); $sink->close(); // Check the event details are correct. $this->assertInstanceOf('\gradereport_user\event\grade_report_viewed', $event); $this->assertEquals(\context_course::instance($course->id), $event->get_context()); $this->assertEquals($student1->id, $event->get_data()['relateduserid']); $this->setUser($student2); try { $studentgrade = user_external::view_grade_report($course->id, $student1->id); $this->fail('Exception expected due to not permissions to view other user grades.'); } catch (\moodle_exception $e) { $this->assertEquals('nopermissiontoviewgrades', $e->errorcode); } } /** * Test get_grades_items function case teacher */ public function test_get_grade_items_teacher() { $this->resetAfterTest(true); $s1grade = 80; $s2grade = 60; list($course, $teacher, $student1, $student2, $assignment) = $this->load_data($s1grade, $s2grade); // A teacher must see all student grades (in their group only). $this->setUser($teacher); grade_set_setting($course->id, 'report_user_showrank', 1); grade_set_setting($course->id, 'report_user_showpercentage', 1); grade_set_setting($course->id, 'report_user_showhiddenitems', 1); grade_set_setting($course->id, 'report_user_showgrade', 1); grade_set_setting($course->id, 'report_user_showfeedback', 1); grade_set_setting($course->id, 'report_user_showweight', 1); grade_set_setting($course->id, 'report_user_showcontributiontocoursetotal', 1); grade_set_setting($course->id, 'report_user_showlettergrade', 1); grade_set_setting($course->id, 'report_user_showaverage', 1); $studentgrades = user_external::get_grade_items($course->id); $studentgrades = external_api::clean_returnvalue(user_external::get_grade_items_returns(), $studentgrades); // No warnings returned. $this->assertCount(0, $studentgrades['warnings']); // Check that only grades for the student in the teacher group are returned. $this->assertCount(1, $studentgrades['usergrades']); $this->assertCount(2, $studentgrades['usergrades'][0]['gradeitems']); $this->assertEquals($course->id, $studentgrades['usergrades'][0]['courseid']); $this->assertEquals($student1->id, $studentgrades['usergrades'][0]['userid']); // Module grades. $this->assertEquals($assignment->name, $studentgrades['usergrades'][0]['gradeitems'][0]['itemname']); $this->assertEquals('mod', $studentgrades['usergrades'][0]['gradeitems'][0]['itemtype']); $this->assertEquals('assign', $studentgrades['usergrades'][0]['gradeitems'][0]['itemmodule']); $this->assertEquals($assignment->id, $studentgrades['usergrades'][0]['gradeitems'][0]['iteminstance']); $this->assertFalse($studentgrades['usergrades'][0]['gradeitems'][0]['locked']); $this->assertEquals($assignment->cmidnumber, $studentgrades['usergrades'][0]['gradeitems'][0]['cmid']); $this->assertEquals(0, $studentgrades['usergrades'][0]['gradeitems'][0]['itemnumber']); $this->assertEmpty($studentgrades['usergrades'][0]['gradeitems'][0]['outcomeid']); $this->assertEmpty($studentgrades['usergrades'][0]['gradeitems'][0]['scaleid']); $this->assertEquals(80, $studentgrades['usergrades'][0]['gradeitems'][0]['graderaw']); $this->assertEquals('80.00', $studentgrades['usergrades'][0]['gradeitems'][0]['gradeformatted']); $this->assertEquals(0, $studentgrades['usergrades'][0]['gradeitems'][0]['grademin']); $this->assertEquals(100, $studentgrades['usergrades'][0]['gradeitems'][0]['grademax']); $this->assertEquals('0–100', $studentgrades['usergrades'][0]['gradeitems'][0]['rangeformatted']); $this->assertEquals('80.00 %', $studentgrades['usergrades'][0]['gradeitems'][0]['percentageformatted']); $this->assertEmpty($studentgrades['usergrades'][0]['gradeitems'][0]['feedback']); $this->assertFalse($studentgrades['usergrades'][0]['gradeitems'][0]['gradehiddenbydate']); $this->assertFalse($studentgrades['usergrades'][0]['gradeitems'][0]['gradeneedsupdate']); $this->assertFalse($studentgrades['usergrades'][0]['gradeitems'][0]['gradeishidden']); $this->assertFalse($studentgrades['usergrades'][0]['gradeitems'][0]['gradeislocked']); $this->assertFalse($studentgrades['usergrades'][0]['gradeitems'][0]['gradeisoverridden']); $this->assertEquals('B-', $studentgrades['usergrades'][0]['gradeitems'][0]['lettergradeformatted']); $this->assertEquals(1, $studentgrades['usergrades'][0]['gradeitems'][0]['rank']); $this->assertEquals(2, $studentgrades['usergrades'][0]['gradeitems'][0]['numusers']); $this->assertEquals(70, $studentgrades['usergrades'][0]['gradeitems'][0]['averageformatted']); // Course grades. $this->assertEquals('course', $studentgrades['usergrades'][0]['gradeitems'][1]['itemtype']); $this->assertEquals(80, $studentgrades['usergrades'][0]['gradeitems'][1]['graderaw']); $this->assertEquals('80.00', $studentgrades['usergrades'][0]['gradeitems'][1]['gradeformatted']); $this->assertEquals(0, $studentgrades['usergrades'][0]['gradeitems'][1]['grademin']); $this->assertEquals(100, $studentgrades['usergrades'][0]['gradeitems'][1]['grademax']); $this->assertFalse($studentgrades['usergrades'][0]['gradeitems'][1]['locked']); $this->assertEquals('0–100', $studentgrades['usergrades'][0]['gradeitems'][1]['rangeformatted']); $this->assertEquals('80.00 %', $studentgrades['usergrades'][0]['gradeitems'][1]['percentageformatted']); $this->assertEmpty($studentgrades['usergrades'][0]['gradeitems'][1]['feedback']); $this->assertFalse($studentgrades['usergrades'][0]['gradeitems'][1]['gradehiddenbydate']); $this->assertFalse($studentgrades['usergrades'][0]['gradeitems'][1]['gradeneedsupdate']); $this->assertFalse($studentgrades['usergrades'][0]['gradeitems'][1]['gradeishidden']); $this->assertFalse($studentgrades['usergrades'][0]['gradeitems'][1]['gradeislocked']); $this->assertFalse($studentgrades['usergrades'][0]['gradeitems'][1]['gradeisoverridden']); $this->assertEquals('B-', $studentgrades['usergrades'][0]['gradeitems'][1]['lettergradeformatted']); $this->assertEquals(1, $studentgrades['usergrades'][0]['gradeitems'][1]['rank']); $this->assertEquals(2, $studentgrades['usergrades'][0]['gradeitems'][1]['numusers']); $this->assertEquals(70, $studentgrades['usergrades'][0]['gradeitems'][1]['averageformatted']); // Now, override and lock a grade. $gradegrade = \grade_grade::fetch(['itemid' => $studentgrades['usergrades'][0]['gradeitems'][0]['id'], 'userid' => $studentgrades['usergrades'][0]['userid']]); $gradegrade->set_overridden(true); $gradegrade->set_locked(1); $studentgrades = user_external::get_grade_items($course->id); $studentgrades = external_api::clean_returnvalue(user_external::get_grade_items_returns(), $studentgrades); // No warnings returned. $this->assertCount(0, $studentgrades['warnings']); // Module grades. $this->assertTrue($studentgrades['usergrades'][0]['gradeitems'][0]['gradeislocked']); $this->assertTrue($studentgrades['usergrades'][0]['gradeitems'][0]['gradeisoverridden']); } /** * Test get_grades_items function case student */ public function test_get_grade_items_student() { $this->resetAfterTest(true); $s1grade = 80; $s2grade = 60; list($course, $teacher, $student1, $student2, $assignment) = $this->load_data($s1grade, $s2grade); grade_set_setting($course->id, 'report_user_showrank', 1); grade_set_setting($course->id, 'report_user_showpercentage', 1); grade_set_setting($course->id, 'report_user_showgrade', 1); grade_set_setting($course->id, 'report_user_showfeedback', 1); grade_set_setting($course->id, 'report_user_showweight', 1); grade_set_setting($course->id, 'report_user_showcontributiontocoursetotal', 1); grade_set_setting($course->id, 'report_user_showlettergrade', 1); grade_set_setting($course->id, 'report_user_showaverage', 1); $this->setUser($student1); $studentgrades = user_external::get_grade_items($course->id, $student1->id); $studentgrades = external_api::clean_returnvalue(user_external::get_grade_items_returns(), $studentgrades); // No warnings returned. $this->assertCount(0, $studentgrades['warnings']); // Check that only grades for the student in the teacher group are returned. $this->assertCount(1, $studentgrades['usergrades']); $this->assertCount(2, $studentgrades['usergrades'][0]['gradeitems']); $this->assertEquals($course->id, $studentgrades['usergrades'][0]['courseid']); $this->assertEquals($student1->id, $studentgrades['usergrades'][0]['userid']); $this->assertEquals($student1->idnumber, $studentgrades['usergrades'][0]['useridnumber']); $this->assertEquals($assignment->name, $studentgrades['usergrades'][0]['gradeitems'][0]['itemname']); $this->assertEquals('mod', $studentgrades['usergrades'][0]['gradeitems'][0]['itemtype']); $this->assertEquals('assign', $studentgrades['usergrades'][0]['gradeitems'][0]['itemmodule']); $this->assertEquals($assignment->id, $studentgrades['usergrades'][0]['gradeitems'][0]['iteminstance']); $this->assertNull($studentgrades['usergrades'][0]['gradeitems'][0]['locked']); $this->assertEquals($assignment->cmidnumber, $studentgrades['usergrades'][0]['gradeitems'][0]['cmid']); $this->assertEquals(0, $studentgrades['usergrades'][0]['gradeitems'][0]['itemnumber']); $this->assertEmpty($studentgrades['usergrades'][0]['gradeitems'][0]['outcomeid']); $this->assertEmpty($studentgrades['usergrades'][0]['gradeitems'][0]['scaleid']); $this->assertEquals(80, $studentgrades['usergrades'][0]['gradeitems'][0]['graderaw']); $this->assertEquals('80.00', $studentgrades['usergrades'][0]['gradeitems'][0]['gradeformatted']); $this->assertEquals(0, $studentgrades['usergrades'][0]['gradeitems'][0]['grademin']); $this->assertEquals(100, $studentgrades['usergrades'][0]['gradeitems'][0]['grademax']); $this->assertEquals('0–100', $studentgrades['usergrades'][0]['gradeitems'][0]['rangeformatted']); $this->assertEquals('80.00 %', $studentgrades['usergrades'][0]['gradeitems'][0]['percentageformatted']); $this->assertEmpty($studentgrades['usergrades'][0]['gradeitems'][0]['feedback']); $this->assertFalse($studentgrades['usergrades'][0]['gradeitems'][0]['gradehiddenbydate']); $this->assertFalse($studentgrades['usergrades'][0]['gradeitems'][0]['gradeneedsupdate']); $this->assertFalse($studentgrades['usergrades'][0]['gradeitems'][0]['gradeishidden']); $this->assertNull($studentgrades['usergrades'][0]['gradeitems'][0]['gradeislocked']); $this->assertNull($studentgrades['usergrades'][0]['gradeitems'][0]['gradeisoverridden']); $this->assertEquals('B-', $studentgrades['usergrades'][0]['gradeitems'][0]['lettergradeformatted']); $this->assertEquals(1, $studentgrades['usergrades'][0]['gradeitems'][0]['rank']); $this->assertEquals(2, $studentgrades['usergrades'][0]['gradeitems'][0]['numusers']); $this->assertEquals(70, $studentgrades['usergrades'][0]['gradeitems'][0]['averageformatted']); // Check that the idnumber for assignment grades is equal to the cmid. $this->assertEquals((string) $studentgrades['usergrades'][0]['gradeitems'][0]['cmid'], $studentgrades['usergrades'][0]['gradeitems'][0]['idnumber']); // Hide one grade for the user. $gradegrade = new \grade_grade([ 'userid' => $student1->id, 'itemid' => $studentgrades['usergrades'][0]['gradeitems'][0]['id'] ], true); $gradegrade->set_hidden(1); $studentgrades = user_external::get_grade_items($course->id, $student1->id); $studentgrades = external_api::clean_returnvalue(user_external::get_grade_items_returns(), $studentgrades); // Check we get only the course final grade. $this->assertCount(1, $studentgrades['usergrades']); $this->assertCount(1, $studentgrades['usergrades'][0]['gradeitems']); $this->assertEquals('course', $studentgrades['usergrades'][0]['gradeitems'][0]['itemtype']); } } report/user/tests/privacy/provider_test.php 0000604 00000005753 15062070556 0015272 0 ustar 00 <?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/>. /** * Unit tests for the gradereport_user implementation of the privacy API. * * @package gradereport_user * @category test * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_user\privacy; defined('MOODLE_INTERNAL') || die(); use core_privacy\local\request\writer; /** * Unit tests for the gradereport_user implementation of the privacy API. * * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class provider_test extends \core_privacy\tests\provider_testcase { /** * Basic setup for these tests. */ public function setUp(): void { $this->resetAfterTest(true); } /** * Ensure that export_user_preferences returns no data if the user has no data. */ public function test_export_user_preferences_not_defined() { $user = \core_user::get_user_by_username('admin'); provider::export_user_preferences($user->id); $writer = writer::with_context(\context_system::instance()); $this->assertFalse($writer->has_any_data()); } /** * Ensure that export_user_preferences returns single preferences. * These preferences can be set on each course, but the value is shared in the whole site. */ public function test_export_user_preferences_single() { // Define a user preference. $user = $this->getDataGenerator()->create_user(); $this->setUser($user); set_user_preference('gradereport_user_view_user', 1, $user); // Validate exported data. provider::export_user_preferences($user->id); $context = \context_user::instance($user->id); /** @var \core_privacy\tests\request\content_writer $writer */ $writer = writer::with_context($context); $this->assertTrue($writer->has_any_data()); $prefs = $writer->get_user_preferences('gradereport_user'); $this->assertCount(1, (array) $prefs); $this->assertEquals( get_string('privacy:metadata:preference:gradereport_user_view_user', 'gradereport_user'), $prefs->gradereport_user_view_user->description ); $this->assertEquals(get_string('yes'), $prefs->gradereport_user_view_user->value); } } report/user/tests/lib_test.php 0000604 00000005705 15062070556 0012526 0 ustar 00 <?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/>. /** * Tests for gradereport_user library functions. * * @package gradereport_user * @copyright 2015 onwards Ankit agarwal <ankit.agrr@gmail.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later. */ namespace gradereport_user; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once($CFG->dirroot . '/grade/report/user/lib.php'); /** * Class gradereport_user_lib_testcase. * * @package gradereport_user * @copyright 2015 onwards Ankit agarwal <ankit.agrr@gmail.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later. */ class lib_test extends \advanced_testcase { /** * @var stdClass The user. */ private $user; /** * @var stdClass The course. */ private $course; /** * @var \core_user\output\myprofile\tree The navigation tree. */ private $tree; public function setUp(): void { $this->user = $this->getDataGenerator()->create_user(); $this->course = $this->getDataGenerator()->create_course(); $this->tree = new \core_user\output\myprofile\tree(); $this->resetAfterTest(); } /** * Tests the gradereport_user_myprofile_navigation() function. */ public function test_gradereport_user_myprofile_navigation() { $this->setAdminUser(); $iscurrentuser = false; gradereport_user_myprofile_navigation($this->tree, $this->user, $iscurrentuser, $this->course); $reflector = new \ReflectionObject($this->tree); $nodes = $reflector->getProperty('nodes'); $nodes->setAccessible(true); $this->assertArrayHasKey('grade', $nodes->getValue($this->tree)); } /** * Tests the gradereport_user_myprofile_navigation() function for a user * without permission to view the grade node. */ public function test_gradereport_user_myprofile_navigation_without_permission() { $this->setUser($this->user); $iscurrentuser = true; gradereport_user_myprofile_navigation($this->tree, $this->user, $iscurrentuser, $this->course); $reflector = new \ReflectionObject($this->tree); $nodes = $reflector->getProperty('nodes'); $nodes->setAccessible(true); $this->assertArrayNotHasKey('grade', $nodes->getValue($this->tree)); } } report/user/tests/behat/user_view.feature 0000604 00000037561 15062070556 0014665 0 ustar 00 @core @core_grades @gradereport_user @javascript Feature: View the user report as the student will see it In order to know what grades students will see As a teacher I need to be able to view the user report as that other user Background: Given the following "courses" exist: | fullname | shortname | category | groupmode | | <span class="multilang" lang="en">Course</span><span class="multilang" lang="de">Kurs</span> 1 & '" | C1 | 0 | 1 | And the following "users" exist: | username | firstname | lastname | email | idnumber | | teacher1 | Teacher | 1 | teacher1@example.com | t1 | | student1 | Student | 1 | student1@example.com | s1 | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | And the following "grade categories" exist: | fullname | course | | Sub category 1 | C1 | | Sub category 2 | C1 | And the following "activities" exist: | activity | course | idnumber | name | intro | gradecategory | grade | gradepass | | assign | C1 | a1 | Test assignment one | Submit something! | Sub category 1 | 100 | 50 | | assign | C1 | a2 | Test assignment two | Submit something! | Sub category 1 | 100 | 50 | | assign | C1 | a3 | Test assignment three | Submit something! | Sub category 2 | 100 | | | assign | C1 | a4 | Test assignment four | Submit something! | Sub category 2 | 100 | | And the following "activities" exist: | activity | course | idnumber | name | intro | grade | | assign | C1 | a5 | Test assignment five | Submit something! | 100 | | assign | C1 | a6 | Test assignment six | Submit something! | 100 | And the "multilang" filter is "on" And the "multilang" filter applies to "content and headings" When I am on the "C1" "grades > gradebook setup" page logged in as "teacher1" And I hide the grade item "Test assignment six" of type "gradeitem" on "setup" page And I hide the grade item "Sub category 2" of type "category" on "setup" page And I navigate to "View > Grader report" in the course gradebook And I turn editing mode on And I change window size to "large" And I give the grade "80.00" to the user "Student 1" for the grade item "Test assignment one" And I give the grade "35.00" to the user "Student 1" for the grade item "Test assignment two" And I give the grade "100.00" to the user "Student 1" for the grade item "Test assignment three" And I give the grade "50.00" to the user "Student 1" for the grade item "Test assignment four" And I give the grade "21.00" to the user "Student 1" for the grade item "Test assignment five" And I give the grade "97.00" to the user "Student 1" for the grade item "Test assignment six" And I press "Save changes" And I change window size to "medium" Scenario: View the report as the teacher themselves When I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget And I should see "Course 1 & '\"" And I should not see "Course 1 & '\"" And I set the field "View report as" to "Myself" Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | Test assignment one | 50.00 % | 80.00 | 0–100 | 80.00 % | 13.33 % | | Test assignment two | 50.00 % | 35.00 | 0–100 | 35.00 % | 5.83 % | | Sub category 1 total | 33.33 % | 115.00 | 0–200 | 57.50 % | - | | Test assignment three | 50.00 % | 100.00 | 0–100 | 100.00 % | 16.67 % | | Test assignment four | 50.00 % | 50.00 | 0–100 | 50.00 % | 8.33 % | | Sub category 2 total | 33.33 % | 150.00 | 0–200 | 75.00 % | - | | Test assignment five | 16.67 % | 21.00 | 0–100 | 21.00 % | 3.50 % | | Test assignment six | 16.67 % | 97.00 | 0–100 | 97.00 % | 16.17 % | | Course total | - | 383.00 | 0–600 | 63.83 % | - | Scenario: View the report as the student from both the teachers and students perspective When I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget And I set the field "View report as" to "User" Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | Test assignment one | - | 80.00 | 0–100 | 80.00 % | - | | Test assignment two | - | 35.00 | 0–100 | 35.00 % | - | | Sub category 1 total | 33.33 % | - | 0–200 | - | - | | Test assignment five | - | 21.00 | 0–100 | 21.00 % | - | | Course total | - | - | 0–600 | - | - | And "//i[@aria-label='Pass']" "xpath_element" should exist in the "Test assignment one" "table_row" And "//i[@aria-label='Fail']" "xpath_element" should exist in the "Test assignment two" "table_row" And the following should not exist in the "user-grade" table: | Grade item | | Test assignment three | | Test assignment four | | Sub category 2 total | | Test assignment six | And I log out And I am on the "C1" "Course" page logged in as "student1" And I navigate to "User report" in the course gradebook Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | Test assignment one | - | 80.00 | 0–100 | 80.00 % | - | | Test assignment two | - | 35.00 | 0–100 | 35.00 % | - | | Sub category 1 total | 33.33 % | - | 0–200 | - | - | | Test assignment five | - | 21.00 | 0–100 | 21.00 % | - | | Course total | - | - | 0–600 | - | - | And "//i[@aria-label='Pass']" "xpath_element" should exist in the "Test assignment one" "table_row" And "//i[@aria-label='Fail']" "xpath_element" should exist in the "Test assignment two" "table_row" And the following should not exist in the "user-grade" table: | Grade item | | Test assignment three | | Test assignment four | | Sub category 2 total | | Test assignment six | Scenario: View the report as the student from both the teachers and students perspective with totals excluding hidden Given I navigate to "Setup > Course grade settings" in the course gradebook And I set the field with xpath "//select[@name='report_user_showtotalsifcontainhidden']" to "Show totals excluding hidden items" And I press "Save changes" And I navigate to "View > User report" in the course gradebook When I click on "Student 1" in the "user" search widget And I set the field "View report as" to "User" Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | Test assignment one | 50.00 % | 80.00 | 0–100 | 80.00 % | 26.67 % | | Test assignment two | 50.00 % | 35.00 | 0–100 | 35.00 % | 11.67 % | | Sub category 1 total | 66.67 % | 115.00 | 0–200 | 57.50 | - | | Test assignment five | 33.33 % | 21.00 | 0–100 | 21.00 % | 7.00 % | | Course total | - | 136.00 | 0–300 | 45.33 % | - | And the following should not exist in the "user-grade" table: | Grade item | | Test assignment three | | Test assignment four | | Sub category 2 total | | Test assignment six | And I log out And I am on the "C1" "Course" page logged in as "student1" And I navigate to "User report" in the course gradebook Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | Test assignment one | 50.00 % | 80.00 | 0–100 | 80.00 % | 26.67 % | | Test assignment two | 50.00 % | 35.00 | 0–100 | 35.00 % | 11.67 % | | Sub category 1 total | 66.67 % | 115.00 | 0–200 | 57.50 | - | | Test assignment five | 33.33 % | 21.00 | 0–100 | 21.00 % | 7.00 % | | Course total | - | 136.00 | 0–300 | 45.33 % | - | And the following should not exist in the "user-grade" table: | Grade item | | Test assignment three | | Test assignment four | | Sub category 2 total | | Test assignment six | Scenario: View the report as the student from both the teachers and students perspective with totals including hidden Given I navigate to "Setup > Course grade settings" in the course gradebook And I set the field with xpath "//select[@name='report_user_showtotalsifcontainhidden']" to "Show totals including hidden items" And I press "Save changes" And I navigate to "View > User report" in the course gradebook When I click on "Student 1" in the "user" search widget And I set the field "View report as" to "User" Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | Test assignment one | 50.00 % | 80.00 | 0–100 | 80.00 % | 13.33 % | | Test assignment two | 50.00 % | 35.00 | 0–100 | 35.00 % | 5.83 % | | Sub category 1 total | 33.33 % | 115.00 | 0–200 | 57.50 % | - | | Test assignment five | 16.67 % | 21.00 | 0–100 | 21.00 % | 3.50 % | | Course total | - | 383.00 | 0–600 | 63.83 % | - | And the following should not exist in the "user-grade" table: | Grade item | | Test assignment three | | Test assignment four | | Sub category 2 total | | Test assignment six | And I log out And I am on the "C1" "Course" page logged in as "student1" And I navigate to "User report" in the course gradebook Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | Test assignment one | 50.00 % | 80.00 | 0–100 | 80.00 % | 13.33 % | | Test assignment two | 50.00 % | 35.00 | 0–100 | 35.00 % | 5.83 % | | Sub category 1 total | 33.33 % | 115.00 | 0–200 | 57.50 % | - | | Test assignment five | 16.67 % | 21.00 | 0–100 | 21.00 % | 3.50 % | | Course total | - | 383.00 | 0–600 | 63.83 % | - | And the following should not exist in the "user-grade" table: | Grade item | | Test assignment three | | Test assignment four | | Sub category 2 total | | Test assignment six | Scenario: View the report as the student from both the teachers and students perspective when the student can view hidden Given the following "role capability" exists: | role | student | | moodle/grade:viewhidden | allow | And I am on the "C1" "Course" page logged in as "teacher1" And I navigate to "Setup > Course grade settings" in the course gradebook And I set the field with xpath "//select[@name='report_user_showtotalsifcontainhidden']" to "Show totals excluding hidden items" And I press "Save changes" And I navigate to "View > User report" in the course gradebook When I click on "Student 1" in the "user" search widget And I set the field "View report as" to "User" Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | Test assignment one | 50.00 % | 80.00 | 0–100 | 80.00 % | 13.33 % | | Test assignment two | 50.00 % | 35.00 | 0–100 | 35.00 % | 5.83 % | | Sub category 1 total | 33.33 % | 115.00 | 0–200 | 57.50 % | - | | Test assignment three | 50.00 % | 100.00 | 0–100 | 100.00 % | 16.67 % | | Test assignment four | 50.00 % | 50.00 | 0–100 | 50.00 % | 8.33 % | | Sub category 2 total | 33.33 % | 150.00 | 0–200 | 75.00 % | - | | Test assignment five | 16.67 % | 21.00 | 0–100 | 21.00 % | 3.50 % | | Test assignment six | 16.67 % | 97.00 | 0–100 | 97.00 % | 16.17 % | | Course total | - | 383.00 | 0–600 | 63.83 % | - | And I log out And I log in as "student1" And I am on "C1" course homepage And I navigate to "User report" in the course gradebook Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | Test assignment one | 50.00 % | 80.00 | 0–100 | 80.00 % | 13.33 % | | Test assignment two | 50.00 % | 35.00 | 0–100 | 35.00 % | 5.83 % | | Sub category 1 total | 33.33 % | 115.00 | 0–200 | 57.50 % | - | | Test assignment three | 50.00 % | 100.00 | 0–100 | 100.00 % | 16.67 % | | Test assignment four | 50.00 % | 50.00 | 0–100 | 50.00 % | 8.33 % | | Sub category 2 total | 33.33 % | 150.00 | 0–200 | 75.00 % | - | | Test assignment five | 16.67 % | 21.00 | 0–100 | 21.00 % | 3.50 % | | Test assignment six | 16.67 % | 97.00 | 0–100 | 97.00 % | 16.17 % | | Course total | - | 383.00 | 0–600 | 63.83 % | - | report/user/tests/behat/usersearch.feature 0000604 00000035717 15062070556 0015022 0 ustar 00 @core @core_grades @gradereport_user @javascript Feature: Within the User report, a teacher can search for users. Background: Given the following "courses" exist: | fullname | shortname | category | groupmode | | Course 1 | C1 | 0 | 1 | | Course 2 | C2 | 0 | 0 | And the following "users" exist: | username | firstname | lastname | email | idnumber | phone1 | phone2 | department | institution | city | country | | teacher1 | Teacher | 1 | teacher1@example.com | t1 | 1234567892 | 1234567893 | ABC1 | ABCD | Perth | AU | | student1 | Student | 1 | student1@example.com | s1 | 3213078612 | 8974325612 | ABC1 | ABCD | Hanoi | VN | | student2 | Dummy | User | student2@example.com | s2 | 4365899871 | 7654789012 | ABC2 | ABCD | Tokyo | JP | | student3 | User | Example | student3@example.com | s3 | 3243249087 | 0875421745 | ABC2 | ABCD | Olney | GB | | student4 | User | Test | student4@example.com | s4 | 0987532523 | 2149871323 | ABC3 | ABCD | Tokyo | JP | | student5 | Turtle | Manatee | student5@example.com | s5 | 1239087780 | 9873623589 | ABC3 | ABCD | Perth | AU | # Note: Add groups etc so we can test that the search ignores those filters as well if we go down the filter dataset path. And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | teacher1 | C2 | editingteacher | | student1 | C1 | student | | student2 | C1 | student | | student3 | C1 | student | | student4 | C1 | student | | student5 | C1 | student | And the following "activities" exist: | activity | course | idnumber | name | | assign | C1 | a1 | Test assignment one | And the following config values are set as admin: | showuseridentity | idnumber,email,city,country,phone1,phone2,department,institution | And I change window size to "large" And I am on the "Course 1" "grades > User report > View" page logged in as "teacher1" Scenario: A teacher can view and trigger the user search # Check the placeholder text Given I should see "Search users" # Confirm the search is currently inactive and results are unfiltered. And the following should exist in the "user-grades" table: | -1- | | Turtle Manatee | | Student 1 | | User Example | | User Test | | Dummy User | And the following should not exist in the "user-grades" table: | -1- | | Teacher 1 | When I set the field "Search users" to "Turtle" And "View all results (5)" "option_role" should exist And I confirm "Turtle Manatee" in "user" search within the gradebook widget exists And I confirm "User Example" in "user" search within the gradebook widget does not exist And I click on "Turtle Manatee" "list_item" # Business case: This will trigger a page reload and can not dynamically update the table. And I wait until the page is ready Then the following should exist in the "user-grades" table: | -1- | | Turtle Manatee | And the following should not exist in the "user-grades" table: | -1- | | Teacher 1 | | Student 1 | | User Example | | User Test | | Dummy User | And I set the field "Search users" to "Turt" And "View all results (5)" "option_role" should exist And I click on "Clear search input" "button" in the ".user-search" "css_element" And "View all results (5)" "option_role" should not be visible Scenario: A teacher can search the user report to find specified users # Case: Standard search. Given I click on "Dummy" in the "user" search widget And the following should exist in the "user-grades" table: | -1- | | Turtle Manatee | And the following should not exist in the "user-grades" table: | -1- | | Teacher 1 | | Student 1 | | User Example | | User Test | | Dummy User | # Case: No users found. When I set the field "Search users" to "Plagiarism" And I should see "No results for \"Plagiarism\"" # Table remains unchanged as the user had no results to select from the dropdown. And the following should exist in the "user-grades" table: | -1- | | Turtle Manatee | And the following should not exist in the "user-grades" table: | -1- | | Teacher 1 | | Student 1 | | User Example | | User Test | | Dummy User | # Case: Multiple users found and select only one result. Then I set the field "Search users" to "User" And "View all results (5)" "option_role" should exist And I confirm "Dummy User" in "user" search within the gradebook widget exists And I confirm "User Example" in "user" search within the gradebook widget exists And I confirm "User Test" in "user" search within the gradebook widget exists And I confirm "Turtle Manatee" in "user" search within the gradebook widget does not exist # Check if the matched field names (by lines) includes some identifiable info to help differentiate similar users. And I confirm "User (student2@example.com)" in "user" search within the gradebook widget exists And I confirm "User (student3@example.com)" in "user" search within the gradebook widget exists And I confirm "User (student4@example.com)" in "user" search within the gradebook widget exists And I click on "Dummy User" "list_item" And I wait until the page is ready And the following should exist in the "user-grades" table: | -1- | | Dummy User | And the following should not exist in the "user-grades" table: | -1- | | Teacher 1 | | Student 1 | | User Example | | User Test | | Turtle Manatee | # Business case: When searching with multiple partial matches, show the matches in the dropdown + a "View all results for (Bob)" # Business case cont. When pressing enter with multiple partial matches, behave like when you select the "View all results for (Bob)" # Case: Multiple users found and select all partial matches. And I set the field "Search users" to "User" And "View all results (5)" "option_role" should exist And I click on "View all results (5)" "option_role" And I wait until the page is ready And the following should exist in the "user-grades" table: | -1- | | Dummy User | | User Example | | User Test | And the following should not exist in the "user-grades" table: | -1- | | Teacher 1 | | Student 1 | | Turtle Manatee | And I click on "Clear" "link" in the ".user-search" "css_element" And I wait until the page is ready And the following should exist in the "user-grades" table: | -1- | | Turtle Manatee | | Student 1 | | User Example | | User Test | | Dummy User | # Case: No users enrolled. And I am on the "Course 2" "grades > User report > View" page And I set the field "Search users" to "a" And I should see "No results for \"a\"" Scenario: A teacher can quickly tell that a search is active on the current table Given I click on "Turtle" in the "user" search widget # The search input remains in the field on reload this is in keeping with other search implementations. When the field "Search users" matches value "Turtle" And I wait until "View all results (5)" "link" does not exist # Test if we can then further retain the turtle result set and further filter from there. Then I set the field "Search users" to "Turtle plagiarism" And "Turtle Manatee" "list_item" should not exist And I should see "No results for \"Turtle plagiarism\"" Scenario: A teacher can search for values besides the users' name Given I set the field "Search users" to "student5@example.com" And "View all results (5)" "option_role" should exist And "Turtle Manatee" "list_item" should exist And I set the field "Search users" to "@example.com" And "View all results (5)" "option_role" should exist # Note: All learners match this email & showing emails is current default. And I confirm "Dummy User" in "user" search within the gradebook widget exists And I confirm "User Example" in "user" search within the gradebook widget exists And I confirm "User Test" in "user" search within the gradebook widget exists And I confirm "Student 1" in "user" search within the gradebook widget exists And I confirm "Turtle Manatee" in "user" search within the gradebook widget exists # Search on the country field. When I set the field "Search users" to "JP" And "View all results (5)" "option_role" should exist And I wait until "Turtle Manatee" "list_item" does not exist And I confirm "Dummy User" in "user" search within the gradebook widget exists And I confirm "User Test" in "user" search within the gradebook widget exists # Search on the city field. And I set the field "Search users" to "Hanoi" And I wait until "User Test" "list_item" does not exist Then I confirm "Student 1" in "user" search within the gradebook widget exists # Search on the institution field. And I set the field "Search users" to "ABCD" And "Dummy User" "list_item" should exist And I confirm "User Example" in "user" search within the gradebook widget exists And I confirm "User Test" in "user" search within the gradebook widget exists And I confirm "Student 1" in "user" search within the gradebook widget exists And I confirm "Turtle Manatee" in "user" search within the gradebook widget exists # Search on the department field. And I set the field "Search users" to "ABC3" And I wait until "User Example" "list_item" does not exist And I confirm "User Test" in "user" search within the gradebook widget exists And I confirm "Turtle Manatee" in "user" search within the gradebook widget exists # Search on the phone1 field. And I set the field "Search users" to "4365899871" And I wait until "User Test" "list_item" does not exist And I confirm "Dummy User" in "user" search within the gradebook widget exists # Search on the phone2 field. And I set the field "Search users" to "2149871323" And I wait until "Dummy User" "list_item" does not exist And I confirm "User Test" in "user" search within the gradebook widget exists # Search on the institution field then press enter to show the record set. And I set the field "Search users" to "ABC" And "Turtle Manatee" "list_item" should exist And I confirm "Dummy User" in "user" search within the gradebook widget exists And I confirm "User Example" in "user" search within the gradebook widget exists And I confirm "User Test" in "user" search within the gradebook widget exists And I confirm "Student 1" in "user" search within the gradebook widget exists And I press the enter key And I wait until the page is ready And the following should exist in the "user-grades" table: | -1- | | Student 1 | | User Example | | User Test | | Dummy User | | Turtle Manatee | And the following should not exist in the "user-grades" table: | -1- | | Teacher 1 | @accessibility Scenario: A teacher can set focus and search using the input are with a keyboard Given I set the field "Search users" to "ABC" # Basic tests for the page. And the page should meet accessibility standards And the page should meet "wcag131, wcag141, wcag412" accessibility standards And the page should meet accessibility standards with "wcag131, wcag141, wcag412" extra tests # Move onto general keyboard navigation testing. When "Turtle Manatee" "option_role" should exist And I press the down key And the focused element is "Student 1" "option_role" And I press the end key And the focused element is "View all results (5)" "option_role" And I press the home key And the focused element is "Student 1" "option_role" And I press the up key And the focused element is "View all results (5)" "option_role" And I press the down key And the focused element is "Student 1" "option_role" And I press the escape key And the focused element is "Search users" "field" Then I set the field "Search users" to "Goodmeme" And I press the down key And the focused element is "Search users" "field" And I navigate to "View > User report" in the course gradebook And I set the field "Search users" to "ABC" And "Turtle Manatee" "option_role" should exist And I press the down key And the focused element is "Student 1" "option_role" # Lets check the tabbing order. And I set the field "Search users" to "ABC" And "View all results (5)" "option_role" should exist And I press the tab key And the focused element is "Clear search input" "button" in the ".user-search" "css_element" And I press the tab key And the focused element is "View all results (5)" "option_role" And I press the tab key And ".groupsearchwidget" "css_element" should exist # Ensure we can interact with the input & clear search options with the keyboard. # Space & Enter have the same handling for triggering the two functionalities. And I set the field "Search users" to "User" And I press the enter key And I wait to be redirected And the following should exist in the "user-grades" table: | -1- | | Dummy User | | User Example | | User Test | And the following should not exist in the "user-grades" table: | -1- | | Teacher 1 | | Student 1 | | Turtle Manatee | # Sometimes with behat we get unattached nodes causing spurious failures. And I wait "1" seconds And I set the field "Search users" to "ABC" And "Turtle Manatee" "option_role" should exist And I press the tab key And the focused element is "Clear search input" "button" in the ".user-search" "css_element" And I press the enter key And I wait until the page is ready And I confirm "Turtle Manatee" in "user" search within the gradebook widget does not exist report/user/tests/behat/groupsearch.feature 0000604 00000014546 15062070556 0015175 0 ustar 00 @core @core_grades @gradereport_user @javascript Feature: Group searching functionality within the user report. Background: Given the following "courses" exist: | fullname | shortname | category | groupmode | | Course 1 | C1 | 0 | 1 | And the following "users" exist: | username | firstname | lastname | email | idnumber | | teacher1 | Teacher | 1 | teacher1@example.com | t1 | | student1 | Student | 1 | student1@example.com | s1 | | student2 | Student | 2 | student2@example.com | s2 | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | | student2 | C1 | student | And the following "groups" exist: | name | course | idnumber | | Default <span class="multilang" lang="de">Gruppe</span><span class="multilang" lang="en">group</span> | C1 | dg | | Tutor <span class="multilang" lang="de">Gruppe</span><span class="multilang" lang="en">group</span> | C1 | tg | | Marker <span class="multilang" lang="de">Gruppe</span><span class="multilang" lang="en">group</span> | C1 | mg | And the following "group members" exist: | user | group | | student1 | dg | And the "multilang" filter is "on" And the "multilang" filter applies to "content and headings" And I am on the "Course 1" "grades > User report > View" page logged in as "teacher1" Scenario: A teacher can see the 'group' search widget only when group mode is enabled in the course Given ".groupsearchwidget" "css_element" should exist And I am on "Course 1" course homepage And I navigate to "Settings" in current page administration And I set the following fields to these values: | id_groupmode | No groups | And I press "Save and display" When I navigate to "View > User report" in the course gradebook Then ".groupsearchwidget" "css_element" should not exist Scenario: A teacher can search for and find a group to find a user in Given I confirm "Tutor group" in "group" search within the gradebook widget exists And I confirm "Marker group" in "group" search within the gradebook widget exists When I set the field "Search groups" to "tutor" And I wait "1" seconds Then I confirm "Tutor group" in "group" search within the gradebook widget exists And I confirm "Marker group" in "group" search within the gradebook widget does not exist And I click on "Tutor group" in the "group" search widget # The search input remains in the field on reload this is in keeping with other search implementations. And I click on ".groupsearchwidget" "css_element" And the field "Search groups" matches value "tutor" Then I set the field "Search groups" to "Turtle" And I should see "No results for \"Turtle\"" Scenario: A teacher can only see the group members in the 'user' search widget after selecting a group option # Confirm that all users are initially displayed in the 'user' search widget. Given I set the field "Search users" to "Student" And I confirm "Student 1" in "user" search within the gradebook widget exists And I confirm "Student 2" in "user" search within the gradebook widget exists # Select a particular group from the 'group' search widget. When I click on "Default group" in the "group" search widget # Confirm that only users which are members of the selected group are displayed in the 'user' search widget. And I set the field "Search users" to "Student" Then I confirm "Student 1" in "user" search within the gradebook widget exists And I confirm "Student 2" in "user" search within the gradebook widget does not exist And I click on "Tutor group" in the "group" search widget And I set the field "Search users" to "Student" And I confirm "Student 1" in "user" search within the gradebook widget does not exist And I confirm "Student 2" in "user" search within the gradebook widget does not exist And I click on "All participants" in the "group" search widget And I set the field "Search users" to "Student" And I confirm "Student 1" in "user" search within the gradebook widget exists And I confirm "Student 2" in "user" search within the gradebook widget exists @accessibility Scenario: A teacher can set focus and search using the input with a keyboard # Basic tests for the page. Given I click on ".groupsearchwidget" "css_element" And the page should meet accessibility standards And the page should meet "wcag131, wcag141, wcag412" accessibility standards And the page should meet accessibility standards with "wcag131, wcag141, wcag412" extra tests # Move onto general keyboard navigation testing. And I click on "Search groups" "field" And I wait until "Default group" "option_role" exists And I press the down key And the focused element is "All participants" "option_role" And I press the end key And the focused element is "Tutor group" "option_role" And I press the home key And the focused element is "All participants" "option_role" And I press the up key And the focused element is "Tutor group" "option_role" And I press the down key And the focused element is "All participants" "option_role" And I press the escape key And the focused element is "Search groups" "field" Then I set the field "Search groups" to "Goodmeme" And I wait until "Tutor group" "option_role" does not exist And I press the down key And the focused element is "Search groups" "field" And I navigate to "View > User report" in the course gradebook And I click on ".groupsearchwidget" "css_element" And I set the field "Search groups" to "Tutor" And I wait until "All participants" "option_role" does not exist And I press the down key And the focused element is "Tutor group" "option_role" # Lets check the tabbing order. And I set the field "Search groups" to "Marker" And I wait until "Marker group" "option_role" exists And I press the tab key And the focused element is "Clear search input" "button" And I press the enter key And I wait until the page is ready And ".groupsearchwidget" "css_element" should exist report/user/tests/behat/view_usereport.feature 0000604 00000013454 15062070556 0015732 0 ustar 00 @core @core_grades @gradereport_user @javascript Feature: We can use the user report As a user I browse to the User report Background: Given the following "courses" exist: | fullname | shortname | category | groupmode | | Course 1 | C1 | 0 | 1 | Scenario: Verify we can view a user grade report with no users enrolled. When I am on the "Course 1" "grades > User report > View" page logged in as "admin" Then I should see "There are no students enrolled in this course." Scenario: Teacher sees his last viewed user report when navigating back to the gradebook user report. Given the following "users" exist: | username | firstname | lastname | email | | teacher1 | Teacher | 1 | teacher1@example.com | | teacher2 | Teacher | 2 | teacher2@example.com | | student1 | Student | 1 | student1@example.com | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | teacher2 | C1 | editingteacher | | student1 | C1 | student | And I am on the "Course 1" "grades > User report > View" page logged in as "teacher1" And I should see "Search for a user to view their report" in the "region-main" "region" And I click on "Student 1" in the "user" search widget And I should see "Student 1" in the "region-main" "region" When I am on the "Course 1" "grades > User report > View" page Then I should not see "Search for a user to view their report" in the "region-main" "region" And I should see "Student 1" in the "region-main" "region" And I am on the "Course 1" "grades > User report > View" page logged in as "teacher2" And I should see "Search for a user to view their report" in the "region-main" "region" Scenario: Teacher sees his last viewed user report if the user is a part of the the current group. Given the following "groups" exist: | name | course | idnumber | participation | | Group 1 | C1 | G1 | 1 | And the following "users" exist: | username | firstname | lastname | email | | teacher1 | Teacher | 1 | teacher1@example.com | | student1 | Student | 1 | student1@example.com | | student2 | Student | 2 | student2@example.com | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | | student2 | C1 | student | And the following "group members" exist: | user | group | | student2 | G1 | And I am on the "Course 1" "grades > User report > View" page logged in as "teacher1" And I click on "Student 2" in the "user" search widget And I navigate to "View > Grader report" in the course gradebook And I click on "Group 1" in the "group" search widget When I navigate to "View > User report" in the course gradebook Then I should see "Student 2" in the "region-main" "region" And I should not see "Search for a user to view their report" in the "region-main" "region" Scenario: Teacher does not see the last viewed user if the user is not a part of the the current group. Given the following "groups" exist: | name | course | idnumber | participation | | Group 1 | C1 | G1 | 1 | And the following "users" exist: | username | firstname | lastname | email | | teacher1 | Teacher | 1 | teacher1@example.com | | student1 | Student | 1 | student1@example.com | | student2 | Student | 2 | student2@example.com | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | | student2 | C1 | student | And the following "group members" exist: | user | group | | student2 | G1 | And I am on the "Course 1" "grades > User report > View" page logged in as "teacher1" And I click on "Student 1" in the "user" search widget And I navigate to "View > Grader report" in the course gradebook And I click on "Group 1" in the "group" search widget When I navigate to "View > User report" in the course gradebook Then I should see "Search for a user to view their report" in the "region-main" "region" And I should not see "Student 1" in the "region-main" "region" Scenario: Teacher does not see his last viewed user report if the user is no longer enrolled in the course. Given the following "users" exist: | username | firstname | lastname | email | | teacher1 | Teacher | 1 | teacher1@example.com | | student1 | Student | 1 | student1@example.com | | student2 | Student | 2 | student2@example.com | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | | student2 | C1 | student | And I am on the "Course 1" "grades > User report > View" page logged in as "teacher1" And I click on "Student 1" in the "user" search widget And I should see "Student 1" in the "region-main" "region" And I navigate to course participants And I click on "Unenrol" "icon" in the "Student 1" "table_row" And I click on "Unenrol" "button" in the "Unenrol" "dialogue" And I am on "Course 1" course homepage When I navigate to "View > User report" in the course gradebook Then I should see "Search for a user to view their report" in the "region-main" "region" And I should not see "Student 1" in the "region-main" "region" report/user/tests/behat/toggle_grade_categories.feature 0000604 00000006172 15062070556 0017477 0 ustar 00 @core @core_grades @gradereport_user @javascript Feature: User can toggle the visibility of the grade categories within the user grade report. In order to focus only on the information that I am interested in As a teacher I need to be able to easily toggle the visibility of grade categories in the user grade report Background: Given the following "courses" exist: | fullname | shortname | category | | Course | C1 | 0 | And the following "users" exist: | username | firstname | lastname | email | idnumber | | teacher1 | Teacher | 1 | teacher1@example.com | t1 | | student1 | Student | 1 | student1@example.com | s1 | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | And the following "grade categories" exist: | fullname | course | | Category 1 | C1 | And the following "activities" exist: | activity | course | idnumber | name | intro | grade | | assign | C1 | a1 | Test assignment one | Submit something! | 300 | And the following "activities" exist: | activity | course | idnumber | name | gradecategory | grade | gradepass | | assign | C1 | a2 | Test assignment two | Category 1 | 100 | 50 | Scenario: A teacher can search for and find a user to view Given I am on the "Course" "grades > User report > View" page logged in as "teacher1" And I click on "Student 1" in the "user" search widget And I should see "Test assignment one" in the "user-grade" "table" And I should see "Test assignment two" in the "user-grade" "table" And I should see "Category 1 total" in the "user-grade" "table" And I should see "Course total" in the "user-grade" "table" # Hide the grade category 'Category 1'. When I click on ".toggle-category" "css_element" in the "Category 1" "table_row" Then I should not see "Test assignment two" in the "user-grade" "table" And I should not see "Category 1 total" in the "user-grade" "table" And I should see "Test assignment one" in the "user-grade" "table" And I should see "Course total" in the "user-grade" "table" # Show the grade category 'Category 1'. And I click on ".toggle-category" "css_element" in the "Category 1" "table_row" And I should see "Test assignment two" in the "user-grade" "table" And I should see "Category 1 total" in the "user-grade" "table" And I should see "Test assignment one" in the "user-grade" "table" And I should see "Course total" in the "user-grade" "table" # Hide the grade category 'Course'. And I click on ".toggle-category" "css_element" in the "Course" "table_row" And I should not see "Test assignment two" in the "user-grade" "table" And I should not see "Category 1 total" in the "user-grade" "table" And I should not see "Test assignment one" in the "user-grade" "table" And I should not see "Course total" in the "user-grade" "table" report/user/tests/behat/user_report_navigation.feature 0000604 00000007423 15062070556 0017437 0 ustar 00 @core @core_grades @gradereport_user @javascript Feature: Teacher can navigate to the previous or next user report. In order to get go the previous or next user report As a teacher I need to click on the previous/next navigation links Background: Given the following "courses" exist: | fullname | shortname | category | | Course | C1 | 0 | And the following "users" exist: | username | firstname | lastname | email | idnumber | | teacher1 | Teacher | 1 | teacher1@example.com | t1 | | student1 | Student | 1 | student1@example.com | s1 | | student2 | Student | 2 | student2@example.com | s2 | | student3 | Student | 3 | student3@example.com | s3 | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | | student2 | C1 | student | | student3 | C1 | student | And the following "activities" exist: | activity | course | idnumber | name | grade | | assign | C1 | a1 | Test assignment one | 300 | And I am on the "Course" "grades > User report > View" page logged in as "teacher1" Scenario: A teacher can navigate to the next user report Given I click on "Student 1" in the "user" search widget And I should see "Student 1" in the ".user-heading" "css_element" And ".previous" "css_element" should not exist in the ".user-navigation" "css_element" And ".next" "css_element" should exist in the ".user-navigation" "css_element" And I should see "Student 2" in the ".next" "css_element" When I click on "Student 2" "link" in the ".next" "css_element" Then I should see "Student 2" in the ".user-heading" "css_element" And ".previous" "css_element" should exist in the ".user-navigation" "css_element" And I should see "Student 1" in the ".previous" "css_element" And ".next" "css_element" should exist in the ".user-navigation" "css_element" And I should see "Student 3" in the ".next" "css_element" And I click on "Student 3" "link" in the ".next" "css_element" And I should see "Student 3" in the ".user-heading" "css_element" And ".previous" "css_element" should exist in the ".user-navigation" "css_element" And I should see "Student 2" in the ".previous" "css_element" And ".next" "css_element" should not exist in the ".user-navigation" "css_element" Scenario: A teacher can navigate to the previous user report Given I click on "Student 3" in the "user" search widget And I should see "Student 3" in the ".user-heading" "css_element" And ".previous" "css_element" should exist in the ".user-navigation" "css_element" And I should see "Student 2" in the ".previous" "css_element" And ".next" "css_element" should not exist in the ".user-navigation" "css_element" When I click on "Student 2" "link" in the ".previous" "css_element" Then I should see "Student 2" in the ".user-heading" "css_element" And ".previous" "css_element" should exist in the ".user-navigation" "css_element" And I should see "Student 1" in the ".previous" "css_element" And ".next" "css_element" should exist in the ".user-navigation" "css_element" And I should see "Student 3" in the ".next" "css_element" And I click on "Student 1" "link" in the ".previous" "css_element" And I should see "Student 1" in the ".user-heading" "css_element" And ".previous" "css_element" should not exist in the ".user-navigation" "css_element" And ".next" "css_element" should exist in the ".user-navigation" "css_element" And I should see "Student 2" in the ".next" "css_element" report/user/settings.php 0000604 00000011122 15062070556 0011405 0 ustar 00 <?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/>. /** * Defines site settings for the user gradebook report * * @package gradereport_user * @copyright 2007 Petr Skoda * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die; if ($ADMIN->fulltree) { $settings->add( new admin_setting_configcheckbox( 'grade_report_user_showrank', get_string('showrank', 'grades'), get_string('showrank_help', 'grades'), 0 ) ); $settings->add( new admin_setting_configcheckbox( 'grade_report_user_showpercentage', get_string('showpercentage', 'grades'), get_string('showpercentage_help', 'grades'), 1 ) ); $settings->add( new admin_setting_configcheckbox( 'grade_report_user_showgrade', get_string('showgrade', 'grades'), get_string('showgrade_help', 'grades'), 1 ) ); $settings->add( new admin_setting_configcheckbox( 'grade_report_user_showfeedback', get_string('showfeedback', 'grades'), get_string('showfeedback_help', 'grades'), 1 ) ); $settings->add( new admin_setting_configcheckbox( 'grade_report_user_showrange', get_string('showrange', 'grades'), get_string('showrange_help', 'grades'), 1 ) ); $settings->add( new admin_setting_configcheckbox( 'grade_report_user_showweight', get_string('showweight', 'grades'), get_string('showweight_help', 'grades'), 1 ) ); $settings->add( new admin_setting_configcheckbox( 'grade_report_user_showaverage', get_string('showaverage', 'grades'), get_string('showaverage_help', 'grades'), 0 ) ); $settings->add( new admin_setting_configcheckbox( 'grade_report_user_showlettergrade', get_string('showlettergrade', 'grades'), get_string('showlettergrade_help', 'grades'), 0 ) ); $settings->add( new admin_setting_configselect( 'grade_report_user_rangedecimals', get_string('rangedecimals', 'grades'), get_string('rangedecimals_help', 'grades'), 0, [ 0 => 0, 1 => 1, 2 => 2, 3 => 3, 4 => 4, 5 => 5 ] ) ); $options = [ 0 => get_string('shownohidden', 'grades'), 1 => get_string('showhiddenuntilonly', 'grades'), 2 => get_string('showallhidden', 'grades') ]; $settings->add( new admin_setting_configselect( 'grade_report_user_showhiddenitems', get_string('showhiddenitems', 'grades'), get_string('showhiddenitems_help', 'grades'), 1, $options ) ); $settings->add( new admin_setting_configselect( 'grade_report_user_showtotalsifcontainhidden', get_string('hidetotalifhiddenitems', 'grades'), get_string('hidetotalifhiddenitems_help', 'grades'), GRADE_REPORT_HIDE_TOTAL_IF_CONTAINS_HIDDEN, [ GRADE_REPORT_HIDE_TOTAL_IF_CONTAINS_HIDDEN => get_string('hide'), GRADE_REPORT_SHOW_TOTAL_IF_CONTAINS_HIDDEN => get_string('hidetotalshowexhiddenitems', 'grades'), GRADE_REPORT_SHOW_REAL_TOTAL_IF_CONTAINS_HIDDEN => get_string('hidetotalshowinchiddenitems', 'grades') ] ) ); $settings->add( new admin_setting_configcheckbox( 'grade_report_user_showcontributiontocoursetotal', get_string('showcontributiontocoursetotal', 'grades'), get_string('showcontributiontocoursetotal_help', 'grades'), 1 ) ); } report/user/pix/zero_state.svg 0000604 00000022452 15062070556 0012544 0 ustar 00 <svg width="128" height="119" viewBox="0 0 128 119" fill="none" xmlns="http://www.w3.org/2000/svg" preserveAspectRatio="xMinYMid meet"> <path d="M54.48 108.96C84.5685 108.96 108.96 84.5685 108.96 54.48C108.96 24.3915 84.5685 0 54.48 0C24.3915 0 0 24.3915 0 54.48C0 84.5685 24.3915 108.96 54.48 108.96Z" fill="#C4E5FF"/> <path d="M73.6898 29.0098H33.5398C30.4856 29.0098 28.0098 31.4856 28.0098 34.5398V34.5498C28.0098 37.6039 30.4856 40.0798 33.5398 40.0798H73.6898C76.7439 40.0798 79.2198 37.6039 79.2198 34.5498V34.5398C79.2198 31.4856 76.7439 29.0098 73.6898 29.0098Z" fill="#85CAFF"/> <path d="M73.6898 72.4297H33.5398C30.4856 72.4297 28.0098 74.9056 28.0098 77.9597V77.9697C28.0098 81.0238 30.4856 83.4997 33.5398 83.4997H73.6898C76.7439 83.4997 79.2198 81.0238 79.2198 77.9697V77.9597C79.2198 74.9056 76.7439 72.4297 73.6898 72.4297Z" fill="#85CAFF"/> <path d="M96.6497 47.9404H36.3297C31.7347 47.9404 28.0098 51.6632 28.0098 56.2554C28.0098 60.8477 31.7347 64.5704 36.3297 64.5704H96.6497C101.245 64.5704 104.97 60.8477 104.97 56.2554C104.97 51.6632 101.245 47.9404 96.6497 47.9404Z" fill="#85CAFF" stroke="#0056B2" stroke-width="2" stroke-miterlimit="10"/> <path d="M40.9306 59.9601C40.9276 59.9169 40.9276 59.8734 40.9306 59.8301V59.7101L40.8706 59.5801L40.8106 59.4702C40.7654 59.4004 40.7116 59.3366 40.6506 59.2802L40.5606 59.2001L40.3607 59.0601L40.2506 59.0001C39.9335 58.8481 39.597 58.7404 39.2506 58.6801C38.9327 58.6107 38.6324 58.4774 38.3676 58.2883C38.1029 58.0992 37.8794 57.8583 37.7107 57.5801C37.6981 57.4198 37.7211 57.2586 37.7782 57.1082C37.8352 56.9577 37.9248 56.8218 38.0406 56.7101L38.1306 56.6002C38.3931 56.251 38.565 55.8421 38.6306 55.4102C38.6306 55.4102 38.6306 55.3401 38.6306 55.3101C38.7701 54.6878 38.7701 54.0424 38.6306 53.4201C38.5121 53.014 38.2743 52.6528 37.948 52.3835C37.6216 52.1143 37.2219 51.9494 36.8006 51.9102H36.5106H36.2207H36.1606C35.7394 51.9494 35.3396 52.1143 35.0133 52.3835C34.6869 52.6528 34.4491 53.014 34.3307 53.4201C34.1959 54.0429 34.1959 54.6873 34.3307 55.3101C34.326 55.3433 34.326 55.377 34.3307 55.4102C34.387 55.8446 34.5598 56.2558 34.8307 56.6002C34.854 56.6391 34.8807 56.6759 34.9106 56.7101C35.0264 56.8218 35.1161 56.9577 35.1732 57.1082C35.2302 57.2586 35.2533 57.4198 35.2407 57.5801C35.0726 57.8569 34.8505 58.0969 34.5876 58.2859C34.3247 58.4749 34.0265 58.6089 33.7107 58.6801C33.3644 58.7412 33.028 58.8489 32.7107 59.0001L32.6107 59.0601C32.5433 59.1011 32.4797 59.1479 32.4206 59.2001L32.3407 59.2802C32.2859 59.3395 32.2357 59.4031 32.1906 59.4702L32.1306 59.5801L32.0706 59.7101C32.0667 59.75 32.0667 59.7902 32.0706 59.8301C32.065 59.8733 32.065 59.917 32.0706 59.9601C32.0741 59.9867 32.0741 60.0135 32.0706 60.0401C32.6082 60.766 33.3084 61.3558 34.1151 61.7622C34.9217 62.1686 35.8124 62.3803 36.7157 62.3803C37.6189 62.3803 38.5096 62.1686 39.3163 61.7622C40.1229 61.3558 40.8231 60.766 41.3607 60.0401C41.3607 60.0401 41.3607 59.9801 41.3607 59.9601H40.9306Z" fill="white"/> <path d="M122.86 83.0704C122.534 82.7264 122.14 82.4544 121.702 82.2719C121.265 82.0893 120.794 82.0003 120.32 82.0104C119.858 82.001 119.398 82.0846 118.969 82.2564C118.539 82.4282 118.149 82.6846 117.82 83.0104C117.483 83.3324 117.215 83.7206 117.034 84.1508C116.854 84.581 116.764 85.0438 116.77 85.5104V86.5104H115.77V82.5104C115.774 81.6779 115.492 80.8694 114.97 80.2204C114.483 79.5632 113.771 79.1077 112.97 78.9404C112.729 78.8998 112.485 78.8797 112.24 78.8804C111.3 78.8804 110.399 79.253 109.733 79.9166C109.068 80.5802 108.693 81.4806 108.69 82.4203V86.4203H107.69V82.5604C107.712 81.5268 107.357 80.5207 106.69 79.7303C106.368 79.3381 105.969 79.0147 105.519 78.7794C105.069 78.544 104.576 78.4015 104.07 78.3604C103.934 78.3477 103.797 78.3477 103.66 78.3604C103.126 78.3526 102.596 78.4542 102.102 78.6589C101.609 78.8635 101.162 79.1669 100.79 79.5504C100.407 79.9199 100.104 80.3648 99.9011 80.857C99.698 81.3492 99.599 81.8781 99.6102 82.4104V86.4104H98.6102V73.6404V59.4404C98.6211 58.6568 98.3751 57.8912 97.9101 57.2604C97.8107 57.1158 97.6969 56.9817 97.5702 56.8604C96.967 56.2522 96.156 55.8949 95.3001 55.8604H94.8202C93.9643 55.8949 93.1533 56.2522 92.5501 56.8604C92.4262 56.9843 92.3126 57.1181 92.2102 57.2604C91.7452 57.8912 91.4992 58.6568 91.5101 59.4404V83.4404C91.5139 83.497 91.5139 83.5537 91.5101 83.6104V97.1804L90.5101 96.2303V90.7903C90.5224 90.3155 90.4403 89.843 90.2686 89.4001C90.097 88.9573 89.8392 88.5529 89.5101 88.2104C89.1829 87.8679 88.7883 87.5969 88.3512 87.4144C87.914 87.232 87.4438 87.1421 86.9702 87.1504C86.5045 87.1498 86.0433 87.2423 85.614 87.4227C85.1846 87.603 84.7958 87.8674 84.4702 88.2004C84.1335 88.5231 83.8666 88.9115 83.686 89.3415C83.5054 89.7715 83.4149 90.234 83.4201 90.7004V97.7903C83.4174 98.2751 83.5146 98.7553 83.7055 99.2009C83.8965 99.6465 84.1772 100.048 84.5301 100.38L94.3801 109.74C94.795 110.164 95.119 110.669 95.3322 111.222C95.5455 111.776 95.6434 112.368 95.6201 112.96C95.6212 113.225 95.6748 113.487 95.7778 113.731C95.8808 113.974 96.0312 114.195 96.2202 114.38C96.4037 114.574 96.6257 114.728 96.8719 114.831C97.1181 114.934 97.3831 114.985 97.6501 114.98H117.95C118.481 114.98 118.989 114.77 119.364 114.395C119.739 114.02 119.95 113.511 119.95 112.98V112.07C119.943 111.247 120.047 110.426 120.26 109.63L123.67 95.8404C123.886 95.0452 123.994 94.2244 123.99 93.4004V85.6204C123.982 85.1414 123.877 84.6691 123.683 84.2311C123.489 83.7932 123.209 83.3985 122.86 83.0704Z" fill="white"/> <path d="M127.94 85.6397C127.955 84.6323 127.765 83.6323 127.382 82.7006C126.999 81.7688 126.43 80.9248 125.71 80.2197C124.773 79.2918 123.613 78.6205 122.342 78.2703C121.07 77.92 119.73 77.9026 118.45 78.2197C117.345 76.6425 115.685 75.5419 113.802 75.1393C111.919 74.7368 109.953 75.062 108.3 76.0497C106.946 75.0067 105.279 74.4502 103.57 74.4697C103.236 74.4696 102.902 74.4896 102.57 74.5297V59.4397C102.586 58.4331 102.397 57.4337 102.016 56.5021C101.634 55.5704 101.068 54.7259 100.35 54.0197C99.3935 53.0386 98.1809 52.3457 96.85 52.0197H96.7C96.5251 51.98 96.3482 51.9499 96.17 51.9297H95.85C95.59 51.9297 95.32 51.9297 95.04 51.9297H94.9C94.63 51.9297 94.36 51.9297 94.09 51.9297H93.78C93.6017 51.9491 93.4246 51.9792 93.2499 52.0197H93.09C91.7613 52.3439 90.5514 53.0372 89.6 54.0197C88.8812 54.7254 88.3129 55.5696 87.9296 56.5012C87.5463 57.4328 87.3559 58.4324 87.3699 59.4397V83.0697C87.2069 83.0556 87.043 83.0556 86.8799 83.0697C84.8667 83.075 82.9372 83.8757 81.5118 85.2974C80.0863 86.7191 79.2805 88.6465 79.2699 90.6597V97.7497C79.2589 98.7902 79.4689 99.8213 79.886 100.775C80.3032 101.728 80.9181 102.582 81.69 103.28L91.47 112.64C91.4322 114.308 92.0455 115.926 93.18 117.15C93.736 117.752 94.4147 118.228 95.1703 118.545C95.9259 118.862 96.7408 119.014 97.56 118.99H117.86C118.662 119.002 119.459 118.853 120.202 118.552C120.946 118.251 121.622 117.803 122.19 117.237C122.757 116.67 123.206 115.995 123.508 115.251C123.811 114.508 123.961 113.712 123.95 112.91C123.926 112.155 123.99 111.4 124.14 110.66L127.58 96.8697C127.842 95.7483 127.98 94.6013 127.99 93.4497L127.94 85.6397ZM123.57 95.8697L120.18 109.66C119.967 110.455 119.862 111.276 119.87 112.1V112.89C119.87 113.42 119.659 113.929 119.284 114.304C118.909 114.679 118.4 114.89 117.87 114.89H97.57C97.303 114.895 97.0379 114.844 96.7917 114.74C96.5454 114.637 96.3235 114.484 96.1399 114.29C95.951 114.104 95.8007 113.884 95.6977 113.64C95.5947 113.396 95.5411 113.134 95.54 112.87C95.5632 112.277 95.4653 111.686 95.2521 111.132C95.0389 110.578 94.7149 110.074 94.3 109.65L84.45 100.29C84.097 99.9573 83.8163 99.5559 83.6253 99.1103C83.4343 98.6647 83.3373 98.1845 83.34 97.6997V90.6097C83.3348 90.1433 83.4252 89.6809 83.6058 89.2509C83.7864 88.8208 84.0533 88.4324 84.3899 88.1097C84.7155 87.7767 85.1045 87.5123 85.5339 87.332C85.9632 87.1516 86.4243 87.0591 86.8899 87.0597C87.3636 87.0514 87.8338 87.1414 88.2709 87.3238C88.7081 87.5062 89.1027 87.7772 89.43 88.1197C89.7591 88.4622 90.0169 88.8666 90.1885 89.3095C90.3602 89.7524 90.4423 90.2249 90.43 90.6997V96.1397L91.43 97.0897V83.5597C91.4337 83.5031 91.4337 83.4463 91.43 83.3897V59.3897C91.4191 58.6061 91.6649 57.8405 92.1299 57.2097C92.2323 57.0675 92.3461 56.9337 92.47 56.8097C93.0732 56.2016 93.8842 55.8443 94.74 55.8097H95.22C96.0758 55.8443 96.8869 56.2016 97.49 56.8097C97.6167 56.9311 97.7306 57.0651 97.83 57.2097C98.295 57.8405 98.5408 58.6061 98.53 59.3897V73.5897V86.5397H99.53V82.5397C99.5188 82.0074 99.6178 81.4785 99.8209 80.9863C100.024 80.4941 100.327 80.0492 100.71 79.6797C101.082 79.2962 101.528 78.9928 102.022 78.7882C102.516 78.5836 103.046 78.482 103.58 78.4897C103.716 78.477 103.854 78.477 103.99 78.4897C104.496 78.5308 104.989 78.6733 105.439 78.9087C105.889 79.144 106.287 79.4674 106.61 79.8597C107.276 80.65 107.632 81.6561 107.61 82.6897V86.5497H108.61V82.5497C108.613 81.6099 108.988 80.7096 109.653 80.046C110.319 79.3824 111.22 79.0097 112.16 79.0097C112.405 79.0091 112.649 79.0291 112.89 79.0697C113.691 79.237 114.403 79.6925 114.89 80.3497C115.411 80.9987 115.694 81.8072 115.69 82.6397V86.6397H116.69V85.6397C116.684 85.1732 116.773 84.7103 116.954 84.2802C117.135 83.85 117.402 83.4617 117.74 83.1397C118.068 82.8139 118.459 82.5575 118.888 82.3857C119.318 82.214 119.778 82.1303 120.24 82.1397C120.714 82.1296 121.185 82.2186 121.622 82.4012C122.059 82.5837 122.454 82.8557 122.78 83.1997C123.109 83.5422 123.367 83.9466 123.539 84.3895C123.71 84.8323 123.792 85.3049 123.78 85.7797V93.5597C123.808 94.3355 123.738 95.1117 123.57 95.8697Z" fill="#0056B2"/> </svg> report/user/renderer.php 0000604 00000017265 15062070556 0011371 0 ustar 00 <?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/>. /** * Renderer for the grade user report * * @package gradereport_user * @copyright 2010 Sam Hemelryk * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ use core\output\comboboxsearch; /** * Custom renderer for the user grade report * * To get an instance of this use the following code: * $renderer = $PAGE->get_renderer('gradereport_user'); * * @copyright 2010 Sam Hemelryk * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class gradereport_user_renderer extends plugin_renderer_base { /** * Small rendering function that helps with outputting the relevant user selector. * * @param string $report * @param stdClass $course * @param int $userid * @param null|int $groupid * @param bool $includeall * @return string The raw HTML to render. * @throws coding_exception */ public function graded_users_selector(string $report, stdClass $course, int $userid, ?int $groupid, bool $includeall): string { $select = grade_get_graded_users_select($report, $course, $userid, $groupid, $includeall); $output = html_writer::tag('div', $this->output->render($select), ['id' => 'graded_users_selector']); $output .= html_writer::tag('p', '', ['style' => 'page-break-after: always;']); return $output; } /** * Creates and renders the single select box for the user view. * * @param int $userid The selected userid * @param int $userview The current view user setting constant * @return string */ public function view_user_selector(int $userid, int $userview): string { global $USER; $url = $this->page->url; if ($userid != $USER->id) { $url->param('userid', $userid); } $options = [ GRADE_REPORT_USER_VIEW_USER => get_string('otheruser', 'grades'), GRADE_REPORT_USER_VIEW_SELF => get_string('myself', 'grades') ]; $select = new single_select($url, 'userview', $options, $userview, null); $select->label = get_string('viewas', 'grades'); $output = html_writer::tag('div', $this->output->render($select), ['class' => 'view_users_selector']); return $output; } /** * Renders the user selector trigger element. * * @param object $course The course object. * @param int|null $userid The user ID. * @param int|null $groupid The group ID. * @return string The raw HTML to render. * @throws coding_exception */ public function users_selector(object $course, ?int $userid = null, ?int $groupid = null): string { $resetlink = new moodle_url('/grade/report/user/index.php', ['id' => $course->id, 'group' => 0]); $data = [ 'currentvalue' => optional_param('searchvalue', '', PARAM_NOTAGS), 'resetlink' => $resetlink->out(false), 'name' => 'userid', 'courseid' => $course->id, 'groupid' => $groupid ?? 0, ]; $searchdropdown = new comboboxsearch( true, $this->render_from_template('core_user/comboboxsearch/user_selector', $data), null, 'user-search dropdown d-flex', null, 'usersearchdropdown overflow-auto', null, false, ); $this->page->requires->js_call_amd('gradereport_user/user', 'init'); return $this->render_from_template($searchdropdown->get_template(), $searchdropdown->export_for_template($this)); } /** * Creates and renders previous/next user navigation. * * @param graded_users_iterator $gui Objects that is used to iterate over a list of gradable users in the course. * @param int $userid The ID of the current user. * @param int $courseid The course ID. * @return string The raw HTML to render. */ public function user_navigation(graded_users_iterator $gui, int $userid, int $courseid): string { $navigationdata = []; $users = []; while ($userdata = $gui->next_user()) { $users[$userdata->user->id] = $userdata->user; } $gui->close(); $arraykeys = array_keys($users); $keynumber = array_search($userid, $arraykeys); // Without a valid user or users list, there's nothing to render. if ($keynumber === false) { return ''; } // Determine directionality so that icons can be modified to suit language. $previousarrow = right_to_left() ? 'right' : 'left'; $nextarrow = right_to_left() ? 'left' : 'right'; // If the current user is not the first one in the list, find and render the previous user. if ($keynumber !== 0) { $previoususer = $users[$arraykeys[$keynumber - 1]]; $navigationdata['previoususer'] = [ 'name' => fullname($previoususer), 'url' => (new moodle_url('/grade/report/user/index.php', ['id' => $courseid, 'userid' => $previoususer->id])) ->out(false), 'previousarrow' => $previousarrow ]; } // If the current user is not the last one in the list, find and render the last user. if ($keynumber < count($users) - 1) { $nextuser = $users[$arraykeys[$keynumber + 1]]; $navigationdata['nextuser'] = [ 'name' => fullname($nextuser), 'url' => (new moodle_url('/grade/report/user/index.php', ['id' => $courseid, 'userid' => $nextuser->id])) ->out(false), 'nextarrow' => $nextarrow ]; } return $this->render_from_template('gradereport_user/user_navigation', $navigationdata); } /** * Creates and renders 'view report as' selector element. * * @param int $userid The selected userid * @param int $userview The current view user setting constant * @param int $courseid The course ID. * @return string The raw HTML to render. */ public function view_mode_selector(int $userid, int $userview, int $courseid): string { $viewasotheruser = new moodle_url('/grade/report/user/index.php', ['id' => $courseid, 'userid' => $userid, 'userview' => GRADE_REPORT_USER_VIEW_USER]); $viewasmyself = new moodle_url('/grade/report/user/index.php', ['id' => $courseid, 'userid' => $userid, 'userview' => GRADE_REPORT_USER_VIEW_SELF]); $selectoroptions = [ $viewasotheruser->out(false) => get_string('otheruser', 'core_grades'), $viewasmyself->out(false) => get_string('myself', 'core_grades') ]; $selectoractiveurl = $userview === GRADE_REPORT_USER_VIEW_USER ? $viewasotheruser : $viewasmyself; $viewasselect = new \core\output\select_menu('viewas', $selectoroptions, $selectoractiveurl->out(false)); $viewasselect->set_label(get_string('viewas', 'core_grades')); return $this->render_from_template('gradereport_user/view_mode_selector', $viewasselect->export_for_template($this)); } } report/user/version.php 0000604 00000002277 15062070556 0011245 0 ustar 00 <?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/>. /** * Version details for the user gradebook report * * @package gradereport_user * @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); $plugin->version = 2023100900; // The current plugin version (Date: YYYYMMDDXX). $plugin->requires = 2023100400; // Requires this Moodle version. $plugin->component = 'gradereport_user'; // Full name of the plugin (used for diagnostics) report/user/styles.css 0000604 00000012052 15062070556 0011074 0 ustar 00 .path-grade-report-user #graded_users_selector { float: right; margin-bottom: 5px; } .path-grade-report-user .view_users_selector { clear: both; float: right; margin-bottom: 5px; } .path-grade-report-user #graded_users_selector .singleselect label, .path-grade-report-user .view_users_selector .singleselect label { display: inline-block; } .path-grade-report-user .user-grade, .grade-report-user .user-grade { width: 100%; } .path-grade-report-user .user-grade thead th, .grade-report-user .user-grade thead th { vertical-align: bottom; border: none; text-align: left; background-color: #f8f9fa; } .path-grade-report-user .user-grade td, .grade-report-user .user-grade td { min-width: 4.5em; background-color: #f8f9fa; border: none; vertical-align: middle; } .path-grade-report-user .user-grade .b1l, .grade-report-user .user-grade .b1l { padding: 0; width: 24px; min-width: 24px; } .path-grade-report-user .user-grade tbody .column-itemname, .grade-report-user .user-grade tbody .column-itemname { padding-left: 24px; padding-right: 8px; } .path-grade-report-user .user-grade .column-itemname.baggt, .path-grade-report-user .user-grade .column-itemname.baggb, .grade-report-user .user-grade .column-itemname.baggt, .grade-report-user .user-grade .column-itemname.baggb { padding-left: 0; } .path-grade-report-user .user-grade .column-itemname .itemicon, .grade-report-user .user-grade .column-itemname .itemicon { font-size: 18px; width: 18px; height: 18px; } .path-grade-report-user .user-grade .baggt, .path-grade-report-user .user-grade .baggb, .grade-report-user .user-grade .baggt, .grade-report-user .user-grade .baggb { font-weight: bold; background-color: #f8f9fa; border: none; } .path-grade-report-user .user-report-container, .grade-report-user .user-report-container { margin: 20px 0 30px 0; padding: 10px 10px; background-color: #f8f9fa; } .path-grade-report-user .user-grade tbody tr, .grade-report-user .user-grade tbody tr { background-color: #f8f9fa; } .path-grade-report-user .user-grade tbody tr:hover, .grade-report-user .user-grade tbody tr:hover { color: inherit; background-color: #f8f9fa; } .path-grade-report-user .user-grade tbody tr.spacer, .grade-report-user .user-grade tbody tr.spacer { height: 0.5rem; } .path-grade-report-user .user-grade td.item, .grade-report-user .user-grade td.item { background-color: white; border-top: 1px solid #dee2e6; border-bottom: 1px solid #dee2e6; } .path-grade-report-user .user-grade th.column-itemname:not(.header,.category,.baggt,.baggb), .grade-report-user .user-grade th.column-itemname:not(.header,.category,.baggt,.baggb) { background-color: white; font-weight: normal; border-bottom: 1px solid #dee2e6; } .path-grade-report-user .user-grade th.category, .grade-report-user .user-grade th.category { background-color: white; border: 1px solid #dee2e6; padding-left: 10px; font-weight: bold; } .path-grade-report-user .user-grade th.category a[aria-expanded="true"] .expanded, .path-grade-report-user .user-grade th.category a[aria-expanded="false"] .collapsed, .grade-report-user .user-grade th.category a[aria-expanded="true"] .expanded, .grade-report-user .user-grade th.category a[aria-expanded="false"] .collapsed { display: none; } .path-grade-report-user .user-grade th.category a.toggle-category, .grade-report-user .user-grade th.category a.toggle-category { height: 24px; width: 24px; font-size: 12px; line-height: 24px; margin-right: 3px; } .path-grade-report-user .user-grade th.category a.toggle-category i, .grade-report-user .user-grade th.category a.toggle-category i { font-size: 12px; width: 12px; height: 12px; color: #1d2125; margin: 0; } .path-grade-report-user .user-grade .column-itemname .small, .grade-report-user .user-grade .column-itemname .small { font-size: 70%; } .path-grade-report-user .user-grade tr[data-hidden="true"], .grade-report-user .user-grade tr[data-hidden="true"] { display: none; } .path-grade-report-user .user-grade .category div, .grade-report-user .user-grade .category div { min-height: 30px; align-items: center; } .path-grade-report-user .search-widget[data-searchtype="user"] .userinitials { width: 40px; height: 40px; } .path-grade-report-user .user-navigation .container { max-width: 767px; } .path-grade-report-user .view-user-selector label { display: block; font-size: 80%; margin: 0; } .path-grade-report-user .view-user-selector .dropdown-toggle { padding: 0; font-weight: bold; } .path-grade-report-user .zero-state img { width: 185px; } @media print { .path-grade-report-user .user-grade th.category, .grade-report-user .user-grade th.category { border-left: none; border-right: none; } .path-grade-report-user .user-grade th.category a.toggle-category, .grade-report-user .user-grade th.category a.toggle-category .path-grade-report-user #page-footer { display: none; } } report/user/lang/en/gradereport_user.php 0000604 00000003433 15062070556 0014452 0 ustar 00 <?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/>. /** * Strings for component 'gradereport_user', language 'en' * * @package gradereport_user * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); $string['allusersnum'] = 'All users ({$a})'; $string['eventgradereportviewed'] = 'Grade user report viewed'; $string['gotonextreport'] = 'Go to next user report'; $string['gotopreviousreport'] = 'Go to previous user report'; $string['pluginname'] = 'User report'; $string['user:view'] = 'View user report'; $string['userreportdesc'] = 'User reports include a user’s grades, feedback and the course total.'; $string['userreports'] = 'Search for a user to view their report'; $string['privacy:metadata:preference:gradereport_user_view_user'] = 'Whether to view report as current user or another user in the gradebook reports'; $string['tablesummary'] = 'The table is arranged as a list of graded items including categories of graded items. When items are in a category they will be indicated as such.'; $string['userreport_user'] = 'User report'; report/user/index.php 0000604 00000021063 15062070556 0010661 0 ustar 00 <?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/>. /** * The gradebook user report * * @package gradereport_user * @copyright 2007 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once '../../../config.php'; require_once $CFG->libdir.'/gradelib.php'; require_once $CFG->dirroot.'/grade/lib.php'; require_once $CFG->dirroot.'/grade/report/user/lib.php'; $courseid = required_param('id', PARAM_INT); $userid = optional_param('userid', null, PARAM_INT); $userview = optional_param('userview', 0, PARAM_INT); $PAGE->set_url(new moodle_url('/grade/report/user/index.php', ['id' => $courseid])); if ($userview == 0) { $userview = get_user_preferences('gradereport_user_view_user', GRADE_REPORT_USER_VIEW_USER); } else { set_user_preference('gradereport_user_view_user', $userview); } // Basic access checks. if (!$course = $DB->get_record('course', ['id' => $courseid])) { throw new \moodle_exception('invalidcourseid'); } require_login($course); $PAGE->set_pagelayout('report'); $context = context_course::instance($course->id); require_capability('gradereport/user:view', $context); if ($userid === 0) { require_capability('moodle/grade:viewall', $context); } else if ($userid) { if (!$DB->get_record('user', ['id' => $userid, 'deleted' => 0]) || isguestuser($userid)) { throw new \moodle_exception('invaliduser'); } } $access = false; if (has_capability('moodle/grade:viewall', $context)) { // User can view all course grades. $access = true; } else if (($userid == $USER->id || is_null($userid)) && has_capability('moodle/grade:view', $context) && $course->showgrades) { // User can view own grades. $access = true; } else if (has_capability('moodle/grade:viewall', context_user::instance($userid)) && $course->showgrades) { // User can view grades of this user, The user is an parent most probably. $access = true; } if (!$access) { // The user has no access to grades. throw new \moodle_exception('nopermissiontoviewgrades', 'error', $CFG->wwwroot.'/course/view.php?id='.$courseid); } // Initialise the grade tracking object. $gpr = new grade_plugin_return(['type' => 'report', 'plugin' => 'user', 'courseid' => $courseid, 'userid' => $userid]); // Infer the users previously selected report via session tracking. if (!isset($USER->grade_last_report)) { $USER->grade_last_report = []; } $USER->grade_last_report[$course->id] = 'user'; // First make sure we have proper final grades. grade_regrade_final_grades_if_required($course); $gradesrenderer = $PAGE->get_renderer('core_grades'); // Teachers will see all student reports. if (has_capability('moodle/grade:viewall', $context)) { // Verify if we are using groups or not. $groupmode = groups_get_course_groupmode($course); $currentgroup = $gpr->groupid; // Conditionally add the group JS if we have groups enabled. if ($groupmode) { $PAGE->requires->js_call_amd('gradereport_user/group', 'init'); } // To make some other functions work better later. if (!$currentgroup) { $currentgroup = null; } $isseparategroups = ($course->groupmode == SEPARATEGROUPS && !has_capability('moodle/site:accessallgroups', $context)); if ($isseparategroups && (!$currentgroup)) { // No separate group access, The user can view only themselves. $userid = $USER->id; } // If there is a stored (last viewed) user in a session variable, bypass the user select zero state and display the // report for that user. $lastvieweduserid = $SESSION->gradereport_user["useritem-{$context->id}"] ?? null; if (is_null($userid) && !is_null($lastvieweduserid)) { $userid = $lastvieweduserid; } $gradableusers = get_gradable_users($courseid, $currentgroup); // Validate whether the requested user is a valid gradable user in this course. If, not display the user select // zero state. if (empty($gradableusers) || ($userid && !array_key_exists($userid, $gradableusers))) { $userid = null; } $defaultgradeshowactiveenrol = !empty($CFG->grade_report_showonlyactiveenrol); $showonlyactiveenrol = get_user_preferences('grade_report_showonlyactiveenrol', $defaultgradeshowactiveenrol); $showonlyactiveenrol = $showonlyactiveenrol || !has_capability('moodle/course:viewsuspendedusers', $context); if ($userview == GRADE_REPORT_USER_VIEW_USER) { $viewasuser = true; } else { $viewasuser = false; } $gui = new graded_users_iterator($course, null, $currentgroup); $gui->require_active_enrolment($showonlyactiveenrol); $gui->init(); if (is_null($userid)) { // Zero state. $actionbar = new \gradereport_user\output\action_bar($context, $userview, null, $currentgroup); // Print header. print_grade_page_head($courseid, 'report', 'user', false, false, null, true, null, null, null, $actionbar); if (empty($gradableusers)) { // There are no available gradable users, display a notification. $message = $currentgroup ? get_string('nostudentsingroup') : get_string('nostudentsyet'); echo $OUTPUT->notification($message, 'warning', false); } else { // Otherwise, display the zero state template. $report = new gradereport_user\report\user($courseid, $gpr, $context, $USER->id, $viewasuser); echo $report->output_report_zerostate(); } } else if ($userid == 0) { // Show all reports. // Store the id of the current user item in a session variable which represents the last viewed item. $SESSION->gradereport_user["useritem-{$context->id}"] = $userid; $actionbar = new \gradereport_user\output\action_bar($context, $userview, 0, $currentgroup); print_grade_page_head($courseid, 'report', 'user', false, false, null, true, null, null, null, $actionbar); while ($userdata = $gui->next_user()) { $user = $userdata->user; $report = new gradereport_user\report\user($courseid, $gpr, $context, $user->id, $viewasuser); $userheading = $gradesrenderer->user_heading($report->user, $courseid, false); echo $userheading; if ($report->fill_table()) { echo $report->print_table(true); } } $gui->close(); } else { // Show one user's report. // Store the id of the current user item in a session variable which represents the last viewed item. $SESSION->gradereport_user["useritem-{$context->id}"] = $userid; $report = new gradereport_user\report\user($courseid, $gpr, $context, $userid, $viewasuser); $actionbar = new \gradereport_user\output\action_bar($context, $userview, $report->user->id, $currentgroup); print_grade_page_head($courseid, 'report', 'user', false, false, false, true, null, null, $report->user, $actionbar); if ($currentgroup && !groups_is_member($currentgroup, $userid)) { echo $OUTPUT->notification(get_string('groupusernotmember', 'error')); } else { if ($report->fill_table()) { echo $report->print_table(true); } } $userreportrenderer = $PAGE->get_renderer('gradereport_user'); // Render the user report (previous/next) navigation in a sticky footer. $stickyfooter = new core\output\sticky_footer($userreportrenderer->user_navigation($gui, $userid, $courseid)); echo $OUTPUT->render($stickyfooter); } } else { // Students will see just their own report. // Create a report instance. $report = new gradereport_user\report\user($courseid, $gpr, $context, $userid ?? $USER->id); // Print the page. print_grade_page_head($courseid, 'report', 'user', false, false, false, true, null, null, $report->user); if ($report->fill_table()) { echo $report->print_table(true); } } if (isset($report)) { // Trigger report viewed event. $report->viewed(); } echo $OUTPUT->footer(); report/user/README.txt 0000604 00000000122 15062070556 0010530 0 ustar 00 The default gradebook interface for students, showing just the user's own grades. report/index.php 0000604 00000004535 15062070556 0007710 0 ustar 00 <?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/>. /** * Redirects the user to the default grade report * * @package core_grades * @copyright 2007 Petr Skoda * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once '../../config.php'; $courseid = required_param('id', PARAM_INT); $PAGE->set_url('/grade/report/index.php', array('id'=>$courseid)); /// basic access checks if (!$course = $DB->get_record('course', array('id' => $courseid))) { throw new \moodle_exception('invalidcourseid'); } require_login($course); $context = context_course::instance($course->id); /// find all accessible reports $reports = core_component::get_plugin_list('gradereport'); // Get all installed reports foreach ($reports as $plugin => $plugindir) { // Remove ones we can't see if (!has_capability('gradereport/'.$plugin.':view', $context)) { unset($reports[$plugin]); } } if (empty($reports)) { throw new \moodle_exception('noreports', 'debug', $CFG->wwwroot.'/course/view.php?id='.$course->id); } if (!isset($USER->grade_last_report)) { $USER->grade_last_report = array(); } if (!empty($USER->grade_last_report[$course->id])) { $last = $USER->grade_last_report[$course->id]; } else { $last = null; } if (!array_key_exists($last, $reports)) { $last = null; } if (empty($last)) { if (array_key_exists('grader', $reports)) { $last = 'grader'; } else if (array_key_exists($CFG->grade_profilereport, $reports)) { $last = $CFG->grade_profilereport; } else { reset($reports); $last = key($reports); } } //redirect to last or guessed report redirect($CFG->wwwroot.'/grade/report/'.$last.'/index.php?id='.$course->id); report/summary/index.php 0000604 00000003560 15062070556 0011402 0 ustar 00 <?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/>. /** * Grade summary. * * @package gradereport_summary * @copyright 2022 Ilya Tregubov <ilya@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once(__DIR__ . '/../../../config.php'); require_once("{$CFG->libdir}/adminlib.php"); require_once($CFG->dirroot.'/grade/lib.php'); use core_reportbuilder\system_report_factory; use gradereport_summary\local\systemreports\summary; $courseid = required_param('id', PARAM_INT); if (!$course = $DB->get_record('course', ['id' => $courseid])) { throw new \moodle_exception('invalidcourseid'); } require_login($course); $context = context_course::instance($course->id); $PAGE->set_url('/grade/report/summary/index.php', ['id' => $courseid]); $PAGE->set_context($context); $PAGE->set_pagelayout('report'); $PAGE->add_body_class('limitedwidth'); require_capability('gradereport/summary:view', $context); require_capability('moodle/grade:viewall', $context); print_grade_page_head($courseid, 'report', 'summary', false, false, false, true, null, null, null, null); $report = system_report_factory::create(summary::class, context_course::instance($courseid)); echo $report->output(); echo $OUTPUT->footer(); report/summary/db/access.php 0000604 00000002364 15062070556 0012122 0 ustar 00 <?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/>. /** * The gradebook summary view - Database file * * @package gradereport_summary * @copyright 2022 Ilya Tregubov <ilya@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); $capabilities = [ 'gradereport/summary:view' => [ 'riskbitmask' => RISK_PERSONAL, 'captype' => 'read', 'contextlevel' => CONTEXT_COURSE, 'archetypes' => [ 'editingteacher' => CAP_ALLOW, 'teacher' => CAP_ALLOW, 'manager' => CAP_ALLOW, ] ] ]; report/summary/version.php 0000604 00000002071 15062070556 0011754 0 ustar 00 <?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/>. /** * Standard version file * * @package gradereport_summary * @copyright 2022 Ilya Tregubov <ilya@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); $plugin->component = 'gradereport_summary'; // Full name of the plugin (used for diagnostics). $plugin->version = 2023100900; $plugin->requires = 2023100400; report/summary/lang/en/gradereport_summary.php 0000604 00000002120 15062070556 0015700 0 ustar 00 <?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/>. /** * Strings for Summary view * * @package gradereport_summary * @copyright 2022 Ilya Tregubov <ilya@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ // General Strings. $string['pluginname'] = 'Grade summary'; $string['summary:view'] = 'View grade summary report'; $string['privacy:metadata'] = 'The Grade summary report only shows data stored in other locations.'; report/summary/lib.php 0000604 00000004551 15062070556 0011042 0 ustar 00 <?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/>. defined('MOODLE_INTERNAL') || die; /** * Definition of the summary report class * * @package gradereport_summary * @copyright 2022 Ilya Tregubov <ilya@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once($CFG->dirroot . '/grade/report/lib.php'); /** * Class providing an API for the summary report building. * * @package gradereport_summary * @uses grade_report * @copyright 2022 Ilya Tregubov <ilya@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class grade_report_summary extends grade_report { /** * Capability check caching * * @var boolean $canviewhidden */ public $canviewhidden; /** * Constructor. Sets local copies of user preferences and initialises grade_tree. * * @param int $courseid * @param object $gpr grade plugin return tracking object * @param context_course $context */ public function __construct($courseid, $gpr, $context) { parent::__construct($courseid, $gpr, $context); $this->canviewhidden = has_capability('moodle/grade:viewhidden', $context); $this->setup_groups(); } /** * Processes a single action against a category, grade_item or grade. Not used in summary report. * * @param string $target eid ({type}{id}, e.g. c4 for category4) * @param string $action Which action to take (edit, delete etc...) */ public function process_action($target, $action) { } /** * Handles form data sent by this report for this report. Not used in summary report. * * @param array $data */ public function process_data($data) { } } report/summary/classes/local/entities/grade_items.php 0000604 00000024103 15062070556 0017125 0 ustar 00 <?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/>. namespace gradereport_summary\local\entities; use core_reportbuilder\local\filters\select; use grade_item; use grade_plugin_return; use grade_report_summary; use lang_string; use stdClass; use core_reportbuilder\local\entities\base; use core_reportbuilder\local\report\column; use core_reportbuilder\local\report\filter; defined('MOODLE_INTERNAL') || die; require_once($CFG->dirroot . '/grade/report/summary/lib.php'); require_once($CFG->dirroot . '/grade/lib.php'); /** * Grade summary entity class implementation * * @package gradereport_summary * @copyright 2022 Ilya Tregubov <ilya@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class grade_items extends base { /** @var stdClass Course */ public $course; /** @var grade_report_summary Grade report. */ public $report; /** @var array Ungraded grade items counts with sql info. */ public $ungradedcounts; /** * Entity constructor * * @param stdClass $course */ public function __construct(stdClass $course) { $this->course = $course; } /** * Database tables that this entity uses and their default aliases * * @return array */ protected function get_default_table_aliases(): array { return ['grade_items' => 'gi']; } /** * The default title for this entity in the list of columns/conditions/filters in the report builder * * @return lang_string */ protected function get_default_entity_title(): lang_string { return new lang_string('gradeitem', 'grades'); } /** * Initialise the entity * * @return base */ public function initialise(): base { $context = \context_course::instance($this->course->id); $gpr = new grade_plugin_return( [ 'type' => 'report', 'plugin' => 'summary', 'course' => $this->course, ] ); $this->report = new grade_report_summary($this->course->id, $gpr, $context); $this->ungradedcounts = $this->report->ungraded_counts(); $columns = $this->get_all_columns(); foreach ($columns as $column) { $this->add_column($column); } $filters = $this->get_all_filters(); foreach ($filters as $filter) { $this->add_filter($filter); } return $this; } /** * Returns list of all available columns * * @return column[] */ protected function get_all_columns(): array { $tablealias = $this->get_table_alias('grade_items'); $selectsql = "$tablealias.id, $tablealias.itemname, $tablealias.iteminstance, $tablealias.calculation, $tablealias.itemnumber, $tablealias.itemmodule, $tablealias.hidden, $tablealias.courseid"; // Grade item name column. $columns[] = (new column( 'name', null, $this->get_entity_name() )) ->add_joins($this->get_joins()) ->set_type(column::TYPE_TEXT) ->add_fields($selectsql) ->add_callback(static function($value, $row): string { global $PAGE, $CFG; $renderer = new \core_renderer($PAGE, RENDERER_TARGET_GENERAL); if ($row->itemmodule) { $modinfo = get_fast_modinfo($row->courseid); $instances = $modinfo->get_instances(); $cm = $instances[$row->itemmodule][$row->iteminstance]; if (file_exists($CFG->dirroot . '/mod/' . $row->itemmodule . '/grade.php')) { $args = ['id' => $cm->id, 'itemnumber' => $row->itemnumber]; $url = new \moodle_url('/mod/' . $row->itemmodule . '/grade.php', $args); } else { $url = new \moodle_url('/mod/' . $row->itemmodule . '/view.php', ['id' => $cm->id]); } $imagedata = $renderer->pix_icon('monologo', '', $row->itemmodule, ['class' => 'activityicon']); $purposeclass = plugin_supports('mod', $row->itemmodule, FEATURE_MOD_PURPOSE); $purposeclass .= ' activityiconcontainer'; $purposeclass .= ' modicon_' . $row->itemmodule; $imagedata = \html_writer::tag('div', $imagedata, ['class' => $purposeclass]); $dimmed = ''; if ($row->hidden) { $dimmed = ' dimmed_text'; } $html = \html_writer::start_div('page-context-header' . $dimmed); // Image data. $html .= \html_writer::div($imagedata, 'page-header-image mr-2'); $prefix = \html_writer::div(get_string('pluginname', "mod_{$row->itemmodule}"), 'text-muted text-uppercase small line-height-3'); $name = $prefix . \html_writer::link($url, format_string($cm->name, true)); $html .= \html_writer::tag('div', $name, ['class' => 'page-header-headings']); } else { // Manual grade item. $gradeitem = grade_item::fetch(['id' => $row->id, 'courseid' => $row->courseid]); if ($row->calculation) { $imagedata = $renderer->pix_icon('i/agg_sum', ''); } else { $imagedata = $renderer->pix_icon('i/manual_item', ''); } $imagedata = \html_writer::tag('div', $imagedata); $html = \html_writer::start_div('page-context-header'); // Image data. $html .= \html_writer::div($imagedata, 'page-header-image mr-2'); $html .= \html_writer::tag('div', $gradeitem->get_name(), ['class' => 'page-header-headings']); } return $html; }); $report = [ 'report' => $this->report, 'ungradedcounts' => $this->ungradedcounts ]; // Average column. $columns[] = (new column( 'average', new lang_string('average', 'grades'), $this->get_entity_name() )) ->add_joins($this->get_joins()) ->set_type(column::TYPE_TEXT) ->add_field("$tablealias.id") ->add_callback(static function($value) use ($report): string { $gradeitem = grade_item::fetch(['id' => $value]); if (!empty($gradeitem->avg)) { $averageformatted = '-'; } if ($gradeitem->needsupdate) { $averageformatted = get_string('error'); } if (empty($averageformatted)) { $ungradedcounts = $report['ungradedcounts']; $aggr = $report['report']->calculate_average($gradeitem, $ungradedcounts); if (empty($aggr['average'])) { $averageformatted = '-'; } else { $averagesdisplaytype = $ungradedcounts['report']['averagesdisplaytype']; $averagesdecimalpoints = $ungradedcounts['report']['averagesdecimalpoints']; $shownumberofgrades = $ungradedcounts['report']['shownumberofgrades']; // Determine which display type to use for this average. // No ==0 here, please resave the report and user preferences. if ($averagesdisplaytype == GRADE_REPORT_PREFERENCE_INHERIT) { $displaytype = $gradeitem->get_displaytype(); } else { $displaytype = $averagesdisplaytype; } // Override grade_item setting if a display preference (not inherit) was set for the averages. if ($averagesdecimalpoints == GRADE_REPORT_PREFERENCE_INHERIT) { $decimalpoints = $gradeitem->get_decimals(); } else { $decimalpoints = $averagesdecimalpoints; } $gradehtml = grade_format_gradevalue($aggr['average'], $gradeitem, true, $displaytype, $decimalpoints); if ($shownumberofgrades) { $numberofgrades = $aggr['meancount']; $gradehtml .= " (" . $numberofgrades . ")"; } $averageformatted = $gradehtml; } } return $averageformatted; }); return $columns; } /** * Return list of all available filters * * @return filter[] */ protected function get_all_filters(): array { $tablealias = $this->get_table_alias('grade_items'); // Activity type filter (for performance only load options on demand). $filters[] = (new filter( select::class, 'name', new lang_string('activitytype', 'format_singleactivity'), $this->get_entity_name(), "coalesce({$tablealias}.itemmodule,{$tablealias}.itemtype)" )) ->add_joins($this->get_joins()) ->set_options_callback([$this->report, 'item_types']); return $filters; } } report/summary/classes/local/systemreports/summary.php 0000604 00000007426 15062070556 0017467 0 ustar 00 <?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/>. namespace gradereport_summary\local\systemreports; use gradereport_summary\local\entities\grade_items; use core_reportbuilder\local\helpers\database; use core_reportbuilder\system_report; /** * Grade summary system report class implementation * * @package gradereport_summary * @copyright 2022 Ilya Tregubov <ilya@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class summary extends system_report { /** * Initialise report, we need to set the main table, load our entities and set columns/filters */ protected function initialise(): void { global $PAGE; // We need to ensure page context is always set, as required by output and string formatting. $course = get_course($this->get_context()->instanceid); $PAGE->set_context($this->get_context()); // Our main entity, it contains all of the column definitions that we need. $entitymain = new grade_items($course); $entitymainalias = $entitymain->get_table_alias('grade_items'); $this->set_main_table('grade_items', $entitymainalias); $this->add_entity($entitymain); $param1 = database::generate_param_name(); $param2 = database::generate_param_name(); $param3 = database::generate_param_name(); // Exclude grade categories. // For now exclude course total as well. $wheresql = "$entitymainalias.courseid = :$param1"; $wheresql .= " AND $entitymainalias.itemtype <> 'course'"; // Not showing category items. $wheresql .= " AND $entitymainalias.itemtype <> 'category'"; // Only value and scale grade types may be aggregated. $wheresql .= " AND ($entitymainalias.gradetype = :$param2 OR $entitymainalias.gradetype = :$param3)"; $this->add_base_condition_sql($wheresql, [$param1 => $course->id, $param2 => GRADE_TYPE_VALUE, $param3 => GRADE_TYPE_SCALE]); // Now we can call our helper methods to add the content we want to include in the report. $this->add_columns(); $this->add_filters(); } /** * Validates access to view this report * * @return bool */ protected function can_view(): bool { return has_capability('gradereport/summary:view', $this->get_context()); } /** * Adds the columns we want to display in the report * * They are all provided by the entities we previously added in the {@see initialise} method, referencing each by their * unique identifier */ public function add_columns(): void { $columns = [ 'grade_items:name', 'grade_items:average', ]; $this->add_columns_from_entities($columns); } /** * Adds the filters we want to display in the report * * They are all provided by the entities we previously added in the {@see initialise} method, referencing each by their * unique identifier */ protected function add_filters(): void { $filters = [ 'grade_items:name', ]; $this->add_filters_from_entities($filters); } } report/summary/classes/privacy/provider.php 0000604 00000002745 15062070556 0015243 0 ustar 00 <?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/>. /** * Privacy Subsystem implementation for gradereport_summary. * * @package gradereport_summary * @copyright 2022 Ilya Tregubov <ilya@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_summary\privacy; /** * Privacy Subsystem for gradereport_summary implementing null_provider. * * @copyright 2022 Ilya Tregubov <ilya@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class provider implements \core_privacy\local\metadata\null_provider { /** * Get the language string identifier with the component's language * file to explain why this plugin stores no data. * * @return string */ public static function get_reason() : string { return 'privacy:metadata'; } } report/history/users_ajax.php 0000604 00000005214 15062070556 0012441 0 ustar 00 <?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/>. /** * User searching requests. * * @package gradereport_history * @copyright 2013 NetSpot Pty Ltd (https://www.netspot.com.au) * @author Adam Olley <adam.olley@netspot.com.au> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ define('AJAX_SCRIPT', true); require_once(__DIR__ . '/../../../config.php'); $id = required_param('id', PARAM_INT); // Course id. $search = optional_param('search', '', PARAM_RAW); $page = optional_param('page', 0, PARAM_INT); $course = $DB->get_record('course', array('id' => $id), '*', MUST_EXIST); $context = context_course::instance($course->id, MUST_EXIST); if ($course->id == SITEID) { throw new moodle_exception('invalidcourse'); } require_sesskey(); require_login($course); require_capability('gradereport/history:view', $context); require_capability('moodle/grade:viewall', $context); $outcome = new stdClass(); $outcome->success = true; $outcome->error = ''; $users = \gradereport_history\helper::get_users($context, $search, $page, 25); $outcome->response = array('users' => array()); $outcome->response['totalusers'] = \gradereport_history\helper::get_users_count($context, $search);; $userfieldsapi = \core_user\fields::for_identity($context)->with_userpic(); $extrafields = $userfieldsapi->get_required_fields([\core_user\fields::PURPOSE_IDENTITY]); $useroptions = array('link' => false, 'visibletoscreenreaders' => false); // Format the user record. foreach ($users as $user) { $newuser = new stdClass(); $newuser->userid = $user->id; $newuser->picture = $OUTPUT->user_picture($user, $useroptions); $newuser->fullname = fullname($user); $fieldvalues = []; foreach ($extrafields as $field) { if ($user->{$field}) { $fieldvalues[] = $user->{$field}; } } $newuser->extrafields = implode(', ', $fieldvalues); $outcome->response['users'][] = $newuser; } $outcome->success = true; echo $OUTPUT->header(); echo json_encode($outcome); echo $OUTPUT->footer(); report/history/classes/privacy/provider.php 0000604 00000003007 15062070556 0015237 0 ustar 00 <?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/>. /** * Privacy Subsystem implementation for gradereport_history. * * @package gradereport_history * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_history\privacy; defined('MOODLE_INTERNAL') || die(); /** * Privacy Subsystem for gradereport_history implementing null_provider. * * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class provider implements \core_privacy\local\metadata\null_provider { /** * Get the language string identifier with the component's language * file to explain why this plugin stores no data. * * @return string */ public static function get_reason() : string { return 'privacy:metadata'; } } report/history/classes/output/renderer.php 0000604 00000004204 15062070556 0015076 0 ustar 00 <?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/>. /** * Renderer for history grade report. * * @package gradereport_history * @copyright 2013 NetSpot Pty Ltd (https://www.netspot.com.au) * @author Adam Olley <adam.olley@netspot.com.au> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_history\output; defined('MOODLE_INTERNAL') || die; /** * Renderer for history grade report. * * @since Moodle 2.8 * @package gradereport_history * @copyright 2013 NetSpot Pty Ltd (https://www.netspot.com.au) * @author Adam Olley <adam.olley@netspot.com.au> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class renderer extends \plugin_renderer_base { /** * Render for the select user button. * * @param user_button $button instance of gradereport_history_user_button to render * * @return string HTML to display */ protected function render_user_button(user_button $button) { $data = $button->export_for_template($this); return $this->render_from_template('gradereport_history/user_button', $data); } /** * Get the html for the table. * * @param tablelog $tablelog table object. * * @return string table html */ protected function render_tablelog(tablelog $tablelog) { $o = ''; ob_start(); $tablelog->out($tablelog->pagesize, false); $o = ob_get_contents(); ob_end_clean(); return $o; } } report/history/classes/output/tablelog.php 0000604 00000051474 15062070556 0015074 0 ustar 00 <?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/>. /** * Renderable class for gradehistory report. * * @package gradereport_history * @copyright 2014 onwards Ankit Agarwal <ankit.agrr@gmail.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_history\output; defined('MOODLE_INTERNAL') || die; require_once($CFG->libdir . '/tablelib.php'); require_once($CFG->dirroot . '/user/lib.php'); /** * Renderable class for gradehistory report. * * @since Moodle 2.8 * @package gradereport_history * @copyright 2014 onwards Ankit Agarwal <ankit.agrr@gmail.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class tablelog extends \table_sql implements \renderable { /** * @var int course id. */ protected $courseid; /** * @var \context context of the page to be rendered. */ protected $context; /** * @var \stdClass A list of filters to be applied to the sql query. */ protected $filters; /** * @var \stdClass[] List of users included in the report (if userids are specified as filters) */ protected $users = []; /** * @var array A list of grade items present in the course. */ protected $gradeitems = array(); /** * @var \course_modinfo|null A list of cm instances in course. */ protected $cms; /** * @var int The default number of decimal points to use in this course * when a grade item does not itself define the number of decimal points. */ protected $defaultdecimalpoints; /** * Sets up the table_log parameters. * * @param string $uniqueid unique id of table. * @param \context_course $context Context of the report. * @param \moodle_url $url url of the page where this table would be displayed. * @param array $filters options are: * userids : limit to specific users (default: none) * itemid : limit to specific grade item (default: all) * grader : limit to specific graders (default: all) * datefrom : start of date range * datetill : end of date range * revisedonly : only show revised grades (default: false) * format : page | csv | excel (default: page) * @param string $download Represents download format, pass '' no download at this time. * @param int $page The current page being displayed. * @param int $perpage Number of rules to display per page. */ public function __construct($uniqueid, \context_course $context, $url, $filters = array(), $download = '', $page = 0, $perpage = 100) { global $CFG; parent::__construct($uniqueid); $this->set_attribute('class', 'gradereport_history generaltable generalbox'); // Set protected properties. $this->context = $context; $this->courseid = $this->context->instanceid; $this->pagesize = $perpage; $this->currpage = $page; $this->gradeitems = \grade_item::fetch_all(array('courseid' => $this->courseid)); $this->cms = get_fast_modinfo($this->courseid); $this->useridfield = 'userid'; $this->defaultdecimalpoints = grade_get_setting($this->courseid, 'decimalpoints', $CFG->grade_decimalpoints); // Define columns in the table. $this->define_table_columns(); // Define filters. $this->define_table_filters((object) $filters); // Define configs. $this->define_table_configs($url); // Set download status. $this->is_downloading($download, get_string('exportfilename', 'gradereport_history')); } /** * Define table configs. * * @param \moodle_url $url url of the page where this table would be displayed. */ protected function define_table_configs(\moodle_url $url) { // Set table url. $urlparams = (array)$this->filters; unset($urlparams['submitbutton']); unset($urlparams['userfullnames']); $url->params($urlparams); $this->define_baseurl($url); // Set table configs. $this->collapsible(true); $this->sortable(true, 'timemodified', SORT_DESC); $this->pageable(true); $this->no_sorting('grader'); } /** * Define table filters * * @param \stdClass $filters */ protected function define_table_filters(\stdClass $filters): void { global $DB; $this->filters = $filters; if (!empty($this->filters->userids)) { $course = get_course($this->courseid); // Retrieve userids that are part of the filters object, and ensure user can access each of them. [$userselect, $userparams] = $DB->get_in_or_equal(explode(',', $this->filters->userids), SQL_PARAMS_NAMED); [$usersort] = users_order_by_sql(); $this->users = array_filter( $DB->get_records_select('user', "id {$userselect}", $userparams, $usersort), static function(\stdClass $user) use ($course): bool { return user_can_view_profile($user, $course); } ); // Reset userids to the filtered array of users. $this->filters->userids = implode(',', array_keys($this->users)); } } /** * Setup the headers for the html table. */ protected function define_table_columns() { $extrafields = \core_user\fields::get_identity_fields($this->context); // Define headers and columns. $cols = array( 'timemodified' => get_string('datetime', 'gradereport_history'), 'fullname' => get_string('name') ); // Add headers for extra user fields. foreach ($extrafields as $field) { if (get_string_manager()->string_exists($field, 'moodle')) { $cols[$field] = get_string($field); } else { $cols[$field] = \core_user\fields::get_display_name($field); } } // Add remaining headers. $cols = array_merge($cols, array( 'itemname' => get_string('gradeitem', 'grades'), 'prevgrade' => get_string('gradeold', 'gradereport_history'), 'finalgrade' => get_string('gradenew', 'gradereport_history'), 'grader' => get_string('grader', 'gradereport_history'), 'source' => get_string('source', 'gradereport_history'), 'overridden' => get_string('overridden', 'grades'), 'locked' => get_string('locked', 'grades'), 'excluded' => get_string('excluded', 'gradereport_history'), 'feedback' => get_string('feedbacktext', 'gradereport_history') ) ); $this->define_columns(array_keys($cols)); $this->define_headers(array_values($cols)); } /** * Method to display the final grade. * * @param \stdClass $history an entry of history record. * * @return string HTML to display */ public function col_finalgrade(\stdClass $history) { if (!empty($this->gradeitems[$history->itemid])) { $decimalpoints = $this->gradeitems[$history->itemid]->get_decimals(); } else { $decimalpoints = $this->defaultdecimalpoints; } return format_float($history->finalgrade, $decimalpoints); } /** * Method to display the previous grade. * * @param \stdClass $history an entry of history record. * * @return string HTML to display */ public function col_prevgrade(\stdClass $history) { if (!empty($this->gradeitems[$history->itemid])) { $decimalpoints = $this->gradeitems[$history->itemid]->get_decimals(); } else { $decimalpoints = $this->defaultdecimalpoints; } return format_float($history->prevgrade, $decimalpoints); } /** * Method to display column timemodifed. * * @param \stdClass $history an entry of history record. * * @return string HTML to display */ public function col_timemodified(\stdClass $history) { return userdate($history->timemodified); } /** * Method to display column itemname. * * @param \stdClass $history an entry of history record. * * @return string HTML to display */ public function col_itemname(\stdClass $history) { // Make sure grade item is still present and link it to the module if possible. $itemid = $history->itemid; if (!empty($this->gradeitems[$itemid])) { if ($history->itemtype === 'mod' && !$this->is_downloading()) { if (!empty($this->cms->instances[$history->itemmodule][$history->iteminstance])) { $cm = $this->cms->instances[$history->itemmodule][$history->iteminstance]; $url = new \moodle_url('/mod/' . $history->itemmodule . '/view.php', array('id' => $cm->id)); return \html_writer::link($url, $this->gradeitems[$itemid]->get_name()); } } return $this->gradeitems[$itemid]->get_name(); } return get_string('deleteditemid', 'gradereport_history', $history->itemid); } /** * Method to display column grader. * * @param \stdClass $history an entry of history record. * * @return string HTML to display */ public function col_grader(\stdClass $history) { if (empty($history->usermodified)) { // Not every row has a valid usermodified. return ''; } $grader = new \stdClass(); $grader = username_load_fields_from_object($grader, $history, 'grader'); $name = fullname($grader); if ($this->download) { return $name; } $userid = $history->usermodified; $profileurl = new \moodle_url('/user/view.php', array('id' => $userid, 'course' => $this->courseid)); return \html_writer::link($profileurl, $name); } /** * Method to display column overridden. * * @param \stdClass $history an entry of history record. * * @return string HTML to display */ public function col_overridden(\stdClass $history) { return $history->overridden ? get_string('yes') : get_string('no'); } /** * Method to display column locked. * * @param \stdClass $history an entry of history record. * * @return string HTML to display */ public function col_locked(\stdClass $history) { return $history->locked ? get_string('yes') : get_string('no'); } /** * Method to display column excluded. * * @param \stdClass $history an entry of history record. * * @return string HTML to display */ public function col_excluded(\stdClass $history) { return $history->excluded ? get_string('yes') : get_string('no'); } /** * Method to display column feedback. * * @param \stdClass $history an entry of history record. * * @return string HTML to display */ public function col_feedback(\stdClass $history) { if ($this->is_downloading()) { return $history->feedback; } else { // We need the activity context, not the course context. $gradeitem = $this->gradeitems[$history->itemid]; $context = $gradeitem->get_context(); $feedback = file_rewrite_pluginfile_urls( $history->feedback, 'pluginfile.php', $context->id, GRADE_FILE_COMPONENT, GRADE_HISTORY_FEEDBACK_FILEAREA, $history->id ); return format_text($feedback, $history->feedbackformat, array('context' => $context)); } } /** * Builds the sql and param list needed, based on the user selected filters. * * @return array containing sql to use and an array of params. */ protected function get_filters_sql_and_params() { global $DB, $USER; $coursecontext = $this->context; $filter = 'gi.courseid = :courseid'; $params = array( 'courseid' => $coursecontext->instanceid, ); if (!empty($this->filters->itemid)) { $filter .= ' AND ggh.itemid = :itemid'; $params['itemid'] = $this->filters->itemid; } if (!empty($this->filters->userids)) { $list = explode(',', $this->filters->userids); list($insql, $plist) = $DB->get_in_or_equal($list, SQL_PARAMS_NAMED); $filter .= " AND ggh.userid $insql"; $params += $plist; } if (!empty($this->filters->datefrom)) { $filter .= " AND ggh.timemodified >= :datefrom"; $params += array('datefrom' => $this->filters->datefrom); } if (!empty($this->filters->datetill)) { $filter .= " AND ggh.timemodified <= :datetill"; $params += array('datetill' => $this->filters->datetill); } if (!empty($this->filters->grader)) { $filter .= " AND ggh.usermodified = :grader"; $params += array('grader' => $this->filters->grader); } // If the course is separate group mode and the current user is not allowed to see all groups make sure // that we display only users from the same groups as current user. $groupmode = get_course($coursecontext->instanceid)->groupmode; if ($groupmode == SEPARATEGROUPS && !has_capability('moodle/site:accessallgroups', $coursecontext)) { $groupids = array_column(groups_get_all_groups($coursecontext->instanceid, $USER->id, 0, 'g.id'), 'id'); list($gsql, $gparams) = $DB->get_in_or_equal($groupids, SQL_PARAMS_NAMED, 'gmuparam', true, 0); $filter .= " AND EXISTS (SELECT 1 FROM {groups_members} gmu WHERE gmu.userid=ggh.userid AND gmu.groupid $gsql)"; $params += $gparams; } return array($filter, $params); } /** * Builds the complete sql with all the joins to get the grade history data. * * @param bool $count setting this to true, returns an sql to get count only instead of the complete data records. * * @return array containing sql to use and an array of params. */ protected function get_sql_and_params($count = false) { $fields = 'ggh.id, ggh.timemodified, ggh.itemid, ggh.userid, ggh.finalgrade, ggh.usermodified, ggh.source, ggh.overridden, ggh.locked, ggh.excluded, ggh.feedback, ggh.feedbackformat, gi.itemtype, gi.itemmodule, gi.iteminstance, gi.itemnumber, '; $userfieldsapi = \core_user\fields::for_identity($this->context); $userfieldssql = $userfieldsapi->get_sql('u', true, '', '', true); $userfieldsselects = ''; $userfieldsjoins = ''; $userfieldsparams = []; if (!$count) { $userfieldsselects = $userfieldssql->selects; $userfieldsjoins = $userfieldssql->joins; $userfieldsparams = $userfieldssql->params; } // Add extra user fields that we need for the graded user. $extrafields = []; foreach ($userfieldsapi->get_required_fields([\core_user\fields::PURPOSE_IDENTITY]) as $field) { $extrafields[$field] = $userfieldssql->mappings[$field]; } $userfieldsapi = \core_user\fields::for_name(); $fields .= $userfieldsapi->get_sql('u', false, '', '', false)->selects . ', '; $groupby = $fields; // Add extra user fields that we need for the grader user. $fields .= $userfieldsapi->get_sql('ug', false, 'grader', '', false)->selects; $groupby .= $userfieldsapi->get_sql('ug', false, '', '', false)->selects; // Filtering on revised grades only. $revisedonly = !empty($this->filters->revisedonly); if ($count && !$revisedonly) { // We can only directly use count when not using the filter revised only. $select = "COUNT(1)"; } else { // Fetching the previous grade. We use MAX() to ensure that we only get one result if // more than one histories happened at the same second. $prevgrade = "SELECT MAX(finalgrade) FROM {grade_grades_history} h WHERE h.itemid = ggh.itemid AND h.userid = ggh.userid AND h.timemodified < ggh.timemodified AND NOT EXISTS ( SELECT 1 FROM {grade_grades_history} h2 WHERE h2.itemid = ggh.itemid AND h2.userid = ggh.userid AND h2.timemodified < ggh.timemodified AND h.timemodified < h2.timemodified)"; $select = "$fields, ($prevgrade) AS prevgrade, CASE WHEN gi.itemname IS NULL THEN gi.itemtype ELSE gi.itemname END AS itemname"; } list($where, $params) = $this->get_filters_sql_and_params(); $sql = " SELECT $select $userfieldsselects FROM {grade_grades_history} ggh JOIN {grade_items} gi ON gi.id = ggh.itemid JOIN {user} u ON u.id = ggh.userid $userfieldsjoins LEFT JOIN {user} ug ON ug.id = ggh.usermodified WHERE $where"; $params = array_merge($userfieldsparams, $params); // As prevgrade is a dynamic field, we need to wrap the query. This is the only filtering // that should be defined outside the method self::get_filters_sql_and_params(). if ($revisedonly) { $allorcount = $count ? 'COUNT(1)' : '*'; $sql = "SELECT $allorcount FROM ($sql) pg WHERE pg.finalgrade != pg.prevgrade OR (pg.prevgrade IS NULL AND pg.finalgrade IS NOT NULL) OR (pg.prevgrade IS NOT NULL AND pg.finalgrade IS NULL)"; } // Add order by if needed. if (!$count && $sqlsort = $this->get_sql_sort()) { $sql .= " ORDER BY " . $sqlsort; } return array($sql, $params); } /** * Get the SQL fragment to sort by. * * This is overridden to sort by timemodified and ID by default. Many items happen at the same time * and a second sorting by ID is valuable to distinguish the order in which the history happened. * * @return string SQL fragment. */ public function get_sql_sort() { $columns = $this->get_sort_columns(); if (count($columns) == 1 && isset($columns['timemodified']) && $columns['timemodified'] == SORT_DESC) { // Add the 'id' column when we are using the default sorting. $columns['id'] = SORT_DESC; return self::construct_order_by($columns); } return parent::get_sql_sort(); } /** * Query the reader. Store results in the object for use by build_table. * * @param int $pagesize size of page for paginated displayed table. * @param bool $useinitialsbar do you want to use the initials bar. */ public function query_db($pagesize, $useinitialsbar = true) { global $DB; list($countsql, $countparams) = $this->get_sql_and_params(true); list($sql, $params) = $this->get_sql_and_params(); $total = $DB->count_records_sql($countsql, $countparams); $this->pagesize($pagesize, $total); if ($this->is_downloading()) { $histories = $DB->get_records_sql($sql, $params); } else { $histories = $DB->get_records_sql($sql, $params, $this->pagesize * $this->currpage, $this->pagesize); } foreach ($histories as $history) { $this->rawdata[] = $history; } // Set initial bars. if ($useinitialsbar) { $this->initialbars($total > $pagesize); } } /** * Returns a list of selected users. * * @return \stdClass[] List of user objects */ public function get_selected_users(): array { return $this->users; } } report/history/classes/output/user_button.php 0000604 00000003626 15062070556 0015650 0 ustar 00 <?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/>. /** * User button. Adapted from core_select_user_button. * * @package gradereport_history * @copyright 2013 NetSpot Pty Ltd (https://www.netspot.com.au) * @author Adam Olley <adam.olley@netspot.com.au> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_history\output; defined('MOODLE_INTERNAL') || die; /** * A button that is used to select users for a form. * * @since Moodle 2.8 * @package gradereport_history * @copyright 2013 NetSpot Pty Ltd (https://www.netspot.com.au) * @author Adam Olley <adam.olley@netspot.com.au> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class user_button extends \single_button implements \renderable { /** * Initialises the new select_user_button. * * @param \moodle_url $url * @param string $label The text to display in the button * @param string $method Either post or get */ public function __construct(\moodle_url $url, $label, $method = 'post') { parent::__construct($url, $label, $method); $this->class = 'singlebutton selectusersbutton gradereport_history_plugin'; $this->formid = \html_writer::random_id('selectusersbutton'); } } report/history/classes/filter_form.php 0000604 00000006354 15062070556 0014250 0 ustar 00 <?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/>. /** * Form for grade history filters * * @package gradereport_history * @copyright 2013 NetSpot Pty Ltd (https://www.netspot.com.au) * @author Adam Olley <adam.olley@netspot.com.au> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_history; defined('MOODLE_INTERNAL') || die; require_once($CFG->libdir.'/formslib.php'); /** * Form for grade history filters * * @since Moodle 2.8 * @package gradereport_history * @copyright 2013 NetSpot Pty Ltd (https://www.netspot.com.au) * @author Adam Olley <adam.olley@netspot.com.au> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class filter_form extends \moodleform { /** * Definition of the Mform for filters displayed in the report. */ public function definition() { $mform = $this->_form; $course = $this->_customdata['course']; $itemids = $this->_customdata['itemids']; $graders = $this->_customdata['graders']; $userbutton = $this->_customdata['userbutton']; $userfullnames = $this->_customdata['userfullnames']; $names = \html_writer::span($userfullnames, 'selectednames'); $mform->addElement('static', 'userselect', get_string('selectusers', 'gradereport_history'), $userbutton); $mform->addElement('static', 'selectednames', get_string('selectedusers', 'gradereport_history'), $names); $mform->addElement('select', 'itemid', get_string('gradeitem', 'grades'), $itemids); $mform->setType('itemid', PARAM_INT); $mform->addElement('select', 'grader', get_string('grader', 'gradereport_history'), $graders); $mform->setType('grader', PARAM_INT); $mform->addElement('date_selector', 'datefrom', get_string('datefrom', 'gradereport_history'), array('optional' => true)); $mform->addElement('date_selector', 'datetill', get_string('dateto', 'gradereport_history'), array('optional' => true)); $mform->addElement('checkbox', 'revisedonly', get_string('revisedonly', 'gradereport_history')); $mform->addHelpButton('revisedonly', 'revisedonly', 'gradereport_history'); $mform->addElement('hidden', 'id', $course->id); $mform->setType('id', PARAM_INT); $mform->addElement('hidden', 'userids'); $mform->setType('userids', PARAM_SEQUENCE); $mform->addElement('hidden', 'userfullnames'); $mform->setType('userfullnames', PARAM_TEXT); // Add a submit button. $mform->addElement('submit', 'submitbutton', get_string('submit')); } } report/history/classes/event/grade_report_viewed.php 0000604 00000002730 15062070556 0017073 0 ustar 00 <?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/>. /** * Grade history report viewed event. * * @package gradereport_history * @copyright 2014 Mark Nelson <markn@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_history\event; defined('MOODLE_INTERNAL') || die(); /** * Grade history report viewed event class. * * @package gradereport_history * @since Moodle 2.8 * @copyright 2014 Mark Nelson <markn@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class grade_report_viewed extends \core\event\grade_report_viewed { /** * Returns localised general event name. * * @return string */ public static function get_name() { return get_string('eventgradereportviewed', 'gradereport_history'); } } report/history/classes/helper.php 0000604 00000021615 15062070556 0013214 0 ustar 00 <?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/>. /** * Helper class for gradehistory report. * * @package gradereport_history * @copyright 2014 onwards Ankit Agarwal <ankit.agrr@gmail.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_history; defined('MOODLE_INTERNAL') || die; /** * Helper class for gradehistory report. * * @since Moodle 2.8 * @package gradereport_history * @copyright 2014 onwards Ankit Agarwal <ankit.agrr@gmail.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class helper { /** * Initialise the js to handle the user selection {@link gradereport_history_user_button}. * * @param int $courseid course id. * @param array $currentusers List of currently selected users. * * @return output\user_button the user select button. */ public static function init_js($courseid, array $currentusers = null) { global $PAGE; // Load the strings for js. $PAGE->requires->strings_for_js(array( 'errajaxsearch', 'finishselectingusers', 'foundoneuser', 'foundnusers', 'loadmoreusers', 'selectusers', ), 'gradereport_history'); $PAGE->requires->strings_for_js(array( 'loading' ), 'admin'); $PAGE->requires->strings_for_js(array( 'noresults', 'search' ), 'moodle'); $arguments = array( 'courseid' => $courseid, 'ajaxurl' => '/grade/report/history/users_ajax.php', 'url' => $PAGE->url->out(false), 'selectedUsers' => $currentusers, ); // Load the yui module. $PAGE->requires->yui_module( 'moodle-gradereport_history-userselector', 'Y.M.gradereport_history.UserSelector.init', array($arguments) ); } /** * Retrieve a list of users. * * We're interested in anyone that had a grade history in this course. This api returns a list of such users based on various * criteria passed. * * @param \context $context Context of the page where the results would be shown. * @param string $search the text to search for (empty string = find all). * @param int $page page number, defaults to 0. * @param int $perpage Number of entries to display per page, defaults to 0. * * @return array list of users. */ public static function get_users($context, $search = '', $page = 0, $perpage = 25) { global $DB; list($sql, $params) = self::get_users_sql_and_params($context, $search); $limitfrom = $page * $perpage; $limitto = $limitfrom + $perpage; $users = $DB->get_records_sql($sql, $params, $limitfrom, $limitto); return $users; } /** * Get total number of users present for the given search criteria. * * @param \context $context Context of the page where the results would be shown. * @param string $search the text to search for (empty string = find all). * * @return int number of users found. */ public static function get_users_count($context, $search = '') { global $DB; list($sql, $params) = self::get_users_sql_and_params($context, $search, true); return $DB->count_records_sql($sql, $params); } /** * Get sql and params to use to get list of users. * * @param \context $context Context of the page where the results would be shown. * @param string $search the text to search for (empty string = find all). * @param bool $count setting this to true, returns an sql to get count only instead of the complete data records. * * @return array sql and params list */ protected static function get_users_sql_and_params($context, $search = '', $count = false) { global $DB, $USER; $userfieldsapi = \core_user\fields::for_identity($context)->with_userpic()->including('username'); $userfieldssql = $userfieldsapi->get_sql('u', true, '', '', false); // Fields we need from the user table. $extrafields = []; foreach ($userfieldsapi->get_required_fields([\core_user\fields::PURPOSE_IDENTITY]) as $field) { $extrafields[$field] = $userfieldssql->mappings[$field]; } $params = array(); if (!empty($search)) { list($filtersql, $params) = users_search_sql($search, 'u', USER_SEARCH_CONTAINS, $extrafields); $filtersql .= ' AND '; } else { $filtersql = ''; } $userfieldjoinssql = $userfieldssql->joins; if ($count) { $select = "SELECT COUNT(DISTINCT u.id) "; $orderby = ""; } else { $select = "SELECT DISTINCT $userfieldssql->selects "; $orderby = " ORDER BY u.lastname ASC, u.firstname ASC"; } $groupjoinsql = ''; $groupwheresql = ''; $courseid = $context->instanceid; $groupmode = groups_get_course_groupmode(get_course($courseid)); // We're only interested in separate groups mode because it's the only group mode that requires the user to be a member of // specific group(s), except when they have the 'moodle/site:accessallgroups' capability. if ($groupmode == SEPARATEGROUPS && !has_capability('moodle/site:accessallgroups', $context)) { // Fetch the groups that the user can see. $groups = groups_get_all_groups($courseid, $USER->id, 0, 'g.id'); // Add join condition to include users that only belong to the same group as the user. list($insql, $inparams) = $DB->get_in_or_equal(array_keys($groups), SQL_PARAMS_NAMED, 'gid', true, 0); $groupjoinsql = " JOIN {groups_members} gm ON gm.userid = u.id "; $groupwheresql = " AND gm.groupid $insql "; $params = array_merge($params, $inparams); } $sql = "$select FROM {user} u JOIN {grade_grades_history} ggh ON u.id = ggh.userid JOIN {grade_items} gi ON gi.id = ggh.itemid $userfieldjoinssql $groupjoinsql WHERE $filtersql gi.courseid = :courseid $groupwheresql"; $sql .= $orderby; $params['courseid'] = $courseid; $params = array_merge($userfieldssql->params, $params); return array($sql, $params); } /** * Get a list of graders. * * @param int $courseid Id of course for which we need to fetch graders. * * @return array list of graders. */ public static function get_graders($courseid) { global $DB, $USER; $groupjoinsql = $groupwheresql = ''; $inparams = []; $groupmode = groups_get_course_groupmode(get_course($courseid)); if ($groupmode == SEPARATEGROUPS && !has_capability('moodle/site:accessallgroups', \context_course::instance($courseid))) { // Fetch the groups that the user can see. $groups = groups_get_all_groups($courseid, $USER->id, 0, 'g.id'); // Add join condition to include users that only belong to the same group as the user. list($insql, $inparams) = $DB->get_in_or_equal(array_keys($groups), SQL_PARAMS_NAMED, 'gid', true, 0); $groupjoinsql = " JOIN {groups_members} gm ON gm.userid = u.id "; $groupwheresql = " AND gm.groupid $insql "; } $userfieldsapi = \core_user\fields::for_name(); $ufields = $userfieldsapi->get_sql('u', false, '', '', false)->selects; $sql = "SELECT u.id, $ufields FROM {user} u JOIN {grade_grades_history} ggh ON ggh.usermodified = u.id JOIN {grade_items} gi ON gi.id = ggh.itemid $groupjoinsql WHERE gi.courseid = :courseid $groupwheresql GROUP BY u.id, $ufields ORDER BY u.lastname ASC, u.firstname ASC"; $graders = $DB->get_records_sql($sql, array('courseid' => $courseid) + $inparams); $return = array(0 => get_string('allgraders', 'gradereport_history')); foreach ($graders as $grader) { $return[$grader->id] = fullname($grader); } return $return; } } report/history/lang/en/gradereport_history.php 0000604 00000005172 15062070556 0015722 0 ustar 00 <?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/>. /** * Strings for component 'gradereport_history', language 'en' * * @package gradereport_history * @copyright 2013 NetSpot Pty Ltd (https://www.netspot.com.au) * @author Adam Olley <adam.olley@netspot.com.au> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ $string['allgradeitems'] = 'All grade items'; $string['allgraders'] = 'All graders'; $string['datefrom'] = 'Date from'; $string['dateto'] = 'Date to'; $string['datetime'] = 'Date and time'; $string['deleteditemid'] = 'Delete item with id {$a}'; $string['errajaxsearch'] = 'Error when searching users'; $string['eventgradereportviewed'] = 'Grade history report viewed'; $string['excluded'] = 'Excluded from calculations'; $string['exportfilename'] = 'grade_history'; $string['foundoneuser'] = '1 user found'; $string['foundnusers'] = '{$a} users found'; $string['feedbacktext'] = 'Feedback text'; $string['finishselectingusers'] = 'Finish selecting users'; $string['gradenew'] = 'Revised grade'; $string['gradeold'] = 'Original grade'; $string['grader'] = 'Grader'; $string['history:view'] = 'View grade history'; $string['historyperpage'] = 'History entries per page'; $string['historyperpage_help'] = 'This setting determines the number of history entries displayed per page in the history report.'; $string['loadmoreusers'] = 'Load more users...'; $string['pluginname'] = 'Grade history'; $string['preferences'] = 'Grade history preferences'; $string['privacy:metadata'] = 'The Grade history report only shows data stored in other locations.'; $string['revisedonly'] = 'Revised grades only'; $string['revisedonly_help'] = 'Only show grades which have been revised. This means only entries which result in the grade changing are listed.'; $string['selectuser'] = 'Select user'; $string['selectusers'] = 'Select users'; $string['selectedusers'] = 'Selected users'; $string['source'] = 'Source'; $string['useractivitygrade'] = '{$a} grade'; $string['useractivityfeedback'] = '{$a} feedback'; report/history/templates/user_button.mustache 0000604 00000004051 15062070556 0015664 0 ustar 00 {{! 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/>. }} {{! @template gradereport_history/user_button Template which defines a forum post for sending in a single-post HTML email. Classes required for JS: * none Data attributes required for JS: * none Example context (json): { "name": "showreport", "label": "Select users", "value": "1", "classes": "singlebutton selectusersbutton gradereport_history_plugin", "method": "get", "url": "/grade/report/history/index.php", "formid": "selectusersbutton{generated}", "params": "true", "id": "single_button{generated}", "tooltip": "Select users", "disabled": "" } }} <div class="{{classes}}"> <div method="{{method}}" action="{{url}}" id="{{formid}}"> {{#params}} <input type="hidden" name="{{name}}" value="{{value}}"> {{/params}} <input type="button" class="btn btn-secondary selectortrigger" id="{{id}}" title="{{tooltip}}" value="{{label}}" {{#disabled}}disabled{{/disabled}}> </div> </div> {{#hasactions}} {{#js}} require(['core/yui'], function(Y) { {{#actions}} Y.on('{{event}}', {{{jsfunction}}}, '#{{id}}', null{{#jsfunctionargs}}, {{{jsfunctionargs}}}{{/jsfunctionargs}}); {{/actions}} }); {{/js}} {{/hasactions}} report/history/styles.css 0000604 00000003763 15062070556 0011630 0 ustar 00 /* History */ .path-grade-report-history div.gradeparent { overflow-x: scroll; } .path-grade-report-history .singlebutton div, .path-grade-report-history .singlebutton div input[type="button"] { margin: 0; } /* User Selector */ .yui3-gradereport_history_usp-hidden { display: none; } .gradereport_history_usp .usp-content { position: relative; } .gradereport_history_usp .usp-ajax-content { overflow: auto; border-top: 1px solid #ccc; border-bottom: 1px solid #ccc; } .gradereport_history_usp .usp-ajax-content, .gradereport_history_usp .usp-loading-lightbox { height: 375px; } .gradereport_history_usp .usp-loading-lightbox { background-color: #fff; opacity: .5; position: absolute; text-align: center; width: 100%; top: 0; left: 0; } .gradereport_history_usp .usp-loading-lightbox img { margin-top: 100px; opacity: 1; } .gradereport_history_usp .usp-search { text-align: center; } .gradereport_history_usp .usp-user { width: 100%; text-align: left; border-top: 1px solid #eee; } .gradereport_history_usp .usp-user:nth-child(odd) { background-color: #f9f9f9; } .gradereport_history_usp .usp-first-added { border-top: 1px solid #bbb; } .gradereport_history_usp .usp-checkbox { text-align: center; float: left; padding: 11px 6px 0 6px; } .gradereport_history_usp .usp-checkbox input[type=checkbox] { margin: 0; } .gradereport_history_usp .usp-picture { margin: 6px 3px 0 3px; float: left; } .gradereport_history_usp .usp-userpicture { cursor: pointer; } .gradereport_history_usp .usp-user .details { margin-left: 67px; padding: 3px 6px 0 6px; word-wrap: break-word; } .gradereport_history_usp .usp-user .details label { margin: 0; } .gradereport_history_usp .usp-more-results { padding: 5px; border-top: 1px solid #bbb; } .gradereport_history_usp .usp-finish { padding-top: 1em; text-align: center; } .gradereport_history_usp .usp-finish input { margin: 0; } history/yui/build/moodle-gradereport_history-userselector/moodle-gradereport_history-userselector.js0000604 00000063234 15062070556 0032140 0 ustar 00 report YUI.add('moodle-gradereport_history-userselector', function (Y, NAME) { // 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/>. /** * The User Selector for the grade history report. * * @module moodle-gradereport_history-userselector * @package gradereport_history * @copyright 2013 NetSpot Pty Ltd (https://www.netspot.com.au) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * @main moodle-gradereport_history-userselector */ /** * @module moodle-gradereport_history-userselector */ var COMPONENT = 'gradereport_history'; var USP = { AJAXURL: 'ajaxurl', BASE: 'base', CHECKBOX_NAME_PREFIX: 'usp-u', COURSEID: 'courseid', DIALOGUE_PREFIX: 'moodle-dialogue', NAME: 'gradereport_history_usp', PAGE: 'page', PARAMS: 'params', PERPAGE: 'perPage', SEARCH: 'search', SEARCHBTN: 'searchbtn', SELECTEDUSERS: 'selectedUsers', URL: 'url', USERCOUNT: 'userCount' }; var CSS = { ACCESSHIDE: 'accesshide', AJAXCONTENT: 'usp-ajax-content', CHECKBOX: 'usp-checkbox', CLOSE: 'close', CLOSEBTN: 'usp-finish', CONTENT: 'usp-content', DETAILS: 'details', EXTRAFIELDS: 'extrafields', FIRSTADDED: 'usp-first-added', FULLNAME: 'fullname', HEADER: 'usp-header', HIDDEN: 'hidden', LIGHTBOX: 'usp-loading-lightbox', LOADINGICON: 'loading-icon', MORERESULTS: 'usp-more-results', OPTIONS: 'options', PICTURE: 'usp-picture', RESULTSCOUNT: 'usp-results-count', SEARCH: 'usp-search', SEARCHBTN: 'usp-search-btn', SEARCHFIELD: 'usp-search-field', SEARCHRESULTS: 'usp-search-results', SELECTED: 'selected', USER: 'usp-user', USERS: 'usp-users', WRAP: 'usp-wrap' }; var SELECTORS = { AJAXCONTENT: '.' + CSS.AJAXCONTENT, FINISHBTN: '.' + CSS.CLOSEBTN + ' input', FIRSTADDED: '.' + CSS.FIRSTADDED, FULLNAME: '.' + CSS.FULLNAME + ' label', LIGHTBOX: '.' + CSS.LIGHTBOX, MORERESULTS: '.' + CSS.MORERESULTS, OPTIONS: '.' + CSS.OPTIONS, PICTURE: '.' + CSS.USER + ' .userpicture', RESULTSCOUNT: '.' + CSS.RESULTSCOUNT, RESULTSUSERS: '.' + CSS.SEARCHRESULTS + ' .' + CSS.USERS, SEARCHBTN: '.' + CSS.SEARCHBTN, SEARCHFIELD: '.' + CSS.SEARCHFIELD, SELECTEDNAMES: '.felement .selectednames', TRIGGER: '.gradereport_history_plugin input.selectortrigger', USER: '.' + CSS.USER, USERFULLNAMES: 'input[name="userfullnames"]', USERIDS: 'input[name="userids"]', USERSELECT: '.' + CSS.CHECKBOX + ' input[type=checkbox]' }; /** * User Selector. * * @namespace M.gradereport_history * @class UserSelector * @constructor */ var USERSELECTOR = function() { USERSELECTOR.superclass.constructor.apply(this, arguments); }; Y.namespace('M.gradereport_history').UserSelector = Y.extend(USERSELECTOR, M.core.dialogue, { /** * Whether or not this is the first time the user displays the dialogue within that request. * * @property _firstDisplay * @type Boolean * @private */ _firstDisplay: true, /** * The list of all the users selected while the dialogue is open. * * @type Object * @property _usersBufferList * @private */ _usersBufferList: null, /** * The Node on which the focus is set. * * @property _userTabFocus * @type Node * @private */ _userTabFocus: null, /** * Compiled template function for a user node. * * @property _userTemplate * @type Function * @private */ _userTemplate: null, initializer: function() { var bb = this.get('boundingBox'), content, params, tpl; tpl = Y.Handlebars.compile( '<div class="{{CSS.WRAP}}">' + '<div class="{{CSS.HEADER}}">' + '<div class="{{CSS.SEARCH}}" role="search">' + '<form>' + '<input type="text" class="{{CSS.SEARCHFIELD}}" ' + 'aria-label="{{get_string "search" "moodle"}}" value="" />' + '<input type="submit" class="{{CSS.SEARCHBTN}}"' + 'value="{{get_string "search" "moodle"}}">' + '</form>' + '<div aria-live="polite" class="{{CSS.RESULTSCOUNT}}">{{get_string "loading" "admin"}}</div>' + '</div>' + '</div>' + '<div class="{{CSS.CONTENT}}">' + '<form>' + '<div class="{{CSS.AJAXCONTENT}}" aria-live="polite"></div>' + '<div class="{{CSS.LIGHTBOX}} {{CSS.HIDDEN}}">' + '<img class="{{CSS.LOADINGICON}}" alt="{{get_string "loading" "admin"}}"' + 'src="{{{loadingIcon}}}">' + '</div>' + '<div class="{{CSS.CLOSEBTN}}">' + '<input type="submit" value="{{get_string "finishselectingusers" COMPONENT}}">' + '</div>' + '</form>' + '</div>' + '</div>'); content = Y.Node.create( tpl({ COMPONENT: COMPONENT, CSS: CSS, loadingIcon: M.util.image_url('i/loading', 'moodle') }) ); // Set the title and content. this.getStdModNode(Y.WidgetStdMod.HEADER).prepend(Y.Node.create('<h1>' + this.get('title') + '</h1>')); this.setStdModContent(Y.WidgetStdMod.BODY, content, Y.WidgetStdMod.REPLACE); // Use standard dialogue class name. This removes the default styling of the footer. this.get('boundingBox').one('.moodle-dialogue-wrap').addClass('moodle-dialogue-content'); // Add the event on the button that opens the dialogue. Y.one(SELECTORS.TRIGGER).on('click', this.show, this); // The button to finalize the selection. bb.one(SELECTORS.FINISHBTN).on('click', this.finishSelectingUsers, this); // Delegate the keyboard navigation in the users list. bb.delegate('key', this.userKeyboardNavigation, 'down:38,40', SELECTORS.AJAXCONTENT, this); // Delegate the action to select a user. Y.delegate('click', this.selectUser, SELECTORS.AJAXCONTENT, SELECTORS.USERSELECT, this); Y.delegate('click', this.selectUser, SELECTORS.AJAXCONTENT, SELECTORS.PICTURE, this); params = this.get(USP.PARAMS); params.id = this.get(USP.COURSEID); this.set(USP.PARAMS, params); bb.one(SELECTORS.SEARCHBTN).on('click', this.search, this, false); }, /** * Display the dialogue. * * @method show */ show: function(e) { var bb; this._usersBufferList = Y.clone(this.get(USP.SELECTEDUSERS)); if (this._firstDisplay) { // Load the default list of users when the dialogue is loaded for the first time. this._firstDisplay = false; this.search(e, false); } else { // Leave the content as is, but reset the selection. bb = this.get('boundingBox'); // Remove all the selected users. bb.all(SELECTORS.USER).each(function(node) { this.markUserNode(node, false); }, this); // Select the users. Y.Object.each(this._usersBufferList, function(v, k) { var user = bb.one(SELECTORS.USER + '[data-userid="' + k + '"]'); if (user) { this.markUserNode(user, true); } }, this); // Reset the tab focus. this.setUserTabFocus(bb.one(SELECTORS.USER)); } return Y.namespace('M.gradereport_history.UserSelector').superclass.show.call(this); }, /** * Search for users. * * @method search * @param {EventFacade} e The event. * @param {Boolean} append Whether we want to append the results to the current results or not. */ search: function(e, append) { if (e) { e.preventDefault(); } var params; if (append) { this.set(USP.PAGE, this.get(USP.PAGE) + 1); } else { this.set(USP.USERCOUNT, 0); this.set(USP.PAGE, 0); } params = this.get(USP.PARAMS); params.sesskey = M.cfg.sesskey; params.action = 'searchusers'; params.search = this.get('boundingBox').one(SELECTORS.SEARCHFIELD).get('value'); params.page = this.get(USP.PAGE); params.perpage = this.get(USP.PERPAGE); Y.io(M.cfg.wwwroot + this.get(USP.AJAXURL), { method: 'POST', data: window.build_querystring(params), on: { start: this.preSearch, complete: this.processSearchResults, end: this.postSearch }, context: this, "arguments": { // Quoted because this is a reserved keyword. append: append } }); }, /** * Pre search callback. * * @method preSearch * @param {String} transactionId The transaction ID. * @param {Object} args The arguments passed from YUI.io() */ preSearch: function(unused, args) { var bb = this.get('boundingBox'); // Display the lightbox. bb.one(SELECTORS.LIGHTBOX).removeClass(CSS.HIDDEN); // Set the number of results to 'loading...'. if (!args.append) { bb.one(SELECTORS.RESULTSCOUNT).setHTML(M.util.get_string('loading', 'admin')); } }, /** * Post search callback. * * @method postSearch * @param {String} transactionId The transaction ID. * @param {Object} args The arguments passed from YUI.io() */ postSearch: function(transactionId, args) { var bb = this.get('boundingBox'), firstAdded = bb.one(SELECTORS.FIRSTADDED), firstUser; // Hide the lightbox. bb.one(SELECTORS.LIGHTBOX).addClass(CSS.HIDDEN); if (args.append && firstAdded) { // Sets the focus on the newly added user if we are appending results. this.setUserTabFocus(firstAdded); firstAdded.one(SELECTORS.USERSELECT).focus(); } else { // New search result, set the tab focus on the first user returned. firstUser = bb.one(SELECTORS.USER); if (firstUser) { this.setUserTabFocus(firstUser); } } }, /** * Process and display the search results. * * @method processSearchResults * @param {String} tid The transaction ID. * @param {Object} outcome The response object. * @param {Object} args The arguments passed from YUI.io(). */ processSearchResults: function(tid, outcome, args) { var result = false, error = false, bb = this.get('boundingBox'), users, userTemplate, count, selected, i, firstAdded = true, node, content, fetchmore, totalUsers; // Decodes the result. try { result = Y.JSON.parse(outcome.responseText); if (!result.success || result.error) { error = true; } } catch (e) { error = true; } // There was an error. if (error) { this.setContent(''); bb.one(SELECTORS.RESULTSCOUNT).setHTML(M.util.get_string('errajaxsearch', COMPONENT)); return; } // Create the div containing the users when it is a fresh search. if (!args.append) { users = Y.Node.create('<div role="listbox" aria-activedescendant="" aria-multiselectable="true" class="' + CSS.USERS + '"></div>'); } else { users = bb.one(SELECTORS.RESULTSUSERS); } // Compile the template for each user node. if (!this._userTemplate) { this._userTemplate = Y.Handlebars.compile( '<div role="option" aria-selected="false" class="{{CSS.USER}} clearfix" ' + 'data-userid="{{userId}}">' + '<div class="{{CSS.CHECKBOX}}">' + '<input name="{{USP.CHECKBOX_NAME_PREFIX}}{{userId}}" type="checkbox" tabindex="-1"' + 'id="{{checkboxId}}" aria-describedby="{{checkboxId}} {{extraFieldsId}}"/>' + '</div>' + '<div class="{{CSS.PICTURE}}">{{{picture}}}</div>' + '<div class="{{CSS.DETAILS}}">' + '<div class="{{CSS.FULLNAME}}">' + '<label for="{{checkboxId}}">{{fullname}}</label>' + '</div>' + '<div id="{{extraFieldsId}}" class="{{CSS.EXTRAFIELDS}}">{{{extrafields}}}</div>' + '</div>' + '</div>' ); } userTemplate = this._userTemplate; // Append the users one by one. count = this.get(USP.USERCOUNT); selected = ''; var user; for (i in result.response.users) { count++; user = result.response.users[i]; // If already selected. if (Y.Object.hasKey(this._usersBufferList, user.userid)) { selected = true; } else { selected = false; } node = Y.Node.create(userTemplate({ checkboxId: Y.guid(), COMPONENT: COMPONENT, count: count, CSS: CSS, extrafields: user.extrafields, extraFieldsId: Y.guid(), fullname: user.fullname, picture: user.picture, userId: user.userid, USP: USP })); this.markUserNode(node, selected); // Noting the first user that was when adding more results. if (args.append && firstAdded) { users.all(SELECTORS.FIRSTADDED).removeClass(CSS.FIRSTADDED); node.addClass(CSS.FIRSTADDED); firstAdded = false; } users.append(node); } this.set(USP.USERCOUNT, count); // Update the count of users, and add a button to load more if need be. totalUsers = parseInt(result.response.totalusers, 10); if (!args.append) { if (totalUsers === 0) { bb.one(SELECTORS.RESULTSCOUNT).setHTML(M.util.get_string('noresults', 'moodle')); content = ''; } else { if (totalUsers === 1) { bb.one(SELECTORS.RESULTSCOUNT).setHTML(M.util.get_string('foundoneuser', COMPONENT)); } else { bb.one(SELECTORS.RESULTSCOUNT).setHTML(M.util.get_string('foundnusers', COMPONENT, totalUsers)); } content = Y.Node.create('<div class="' + CSS.SEARCHRESULTS + '"></div>') .append(users); if (result.response.totalusers > (this.get(USP.PAGE) + 1) * this.get(USP.PERPAGE)) { fetchmore = Y.Node.create('<div class="' + CSS.MORERESULTS + '">' + '<a href="#" role="button">' + M.util.get_string('loadmoreusers', COMPONENT) + '</a></div>'); fetchmore.one('a').on('click', this.search, this, true); fetchmore.one('a').on('key', this.search, 'space', this, true); content.append(fetchmore); } } this.setContent(content); } else { if (totalUsers <= (this.get(USP.PAGE) + 1) * this.get(USP.PERPAGE)) { bb.one(SELECTORS.MORERESULTS).remove(); } } }, /** * When the user has finished selecting users. * * @method finishSelectingUsers * @param {EventFacade} e The event. */ finishSelectingUsers: function(e) { e.preventDefault(); this.applySelection(); this.hide(); }, /** * Apply the selection made. * * @method applySelection * @param {EventFacade} e The event. */ applySelection: function() { var userIds = Y.Object.keys(this._usersBufferList); this.set(USP.SELECTEDUSERS, Y.clone(this._usersBufferList)) .setNameDisplay(); Y.one(SELECTORS.USERIDS).set('value', userIds.join()); }, /** * Select a user. * * @method SelectUser * @param {EventFacade} e The event. */ selectUser: function(e) { var user = e.currentTarget.ancestor(SELECTORS.USER), checkbox = user.one(SELECTORS.USERSELECT), fullname = user.one(SELECTORS.FULLNAME).get('innerHTML'), checked = checkbox.get('checked'), userId = user.getData('userid'); if (e.currentTarget !== checkbox) { // We triggered the selection from another node, so we need to change the checkbox value. checked = !checked; } if (checked) { // Selecting the user. this._usersBufferList[userId] = fullname; } else { // De-selecting the user. delete this._usersBufferList[userId]; delete this._usersBufferList[parseInt(userId, 10)]; // Also remove numbered keys. } this.markUserNode(user, checked); }, /** * Mark a user node as selected or not. * * This only takes care of the DOM side of things, not the internal mechanism * storing what users have been selected or not. * * @param {Node} node The user node. * @param {Boolean} selected True to mark as selected. * @chainable */ markUserNode: function(node, selected) { if (selected) { node.addClass(CSS.SELECTED) .set('aria-selected', true) .one(SELECTORS.USERSELECT) .set('checked', true); } else { node.removeClass(CSS.SELECTED) .set('aria-selected', false) .one(SELECTORS.USERSELECT) .set('checked', false); } return this; }, /** * Set the content of the dialogue. * * @method setContent * @param {String} content The content. * @chainable */ setContent: function(content) { this.get('boundingBox').one(SELECTORS.AJAXCONTENT).setHTML(content); return this; }, /** * Display the names of the selected users in the form. * * @method setNameDisplay */ setNameDisplay: function() { var namelist = Y.Object.values(this.get(USP.SELECTEDUSERS)); Y.one(SELECTORS.SELECTEDNAMES).set('innerHTML', namelist.join(', ')); Y.one(SELECTORS.USERFULLNAMES).set('value', namelist.join()); }, /** * User keyboard navigation. * * @method userKeyboardNavigation */ userKeyboardNavigation: function(e) { var bb = this.get('boundingBox'), users = bb.all(SELECTORS.USER), direction = 1, user, current = e.target.ancestor(SELECTORS.USER, true); if (e.keyCode === 38) { direction = -1; } user = this.findFocusableUser(users, current, direction); if (user) { e.preventDefault(); user.one(SELECTORS.USERSELECT).focus(); this.setUserTabFocus(user); } }, /** * Find the next or previous focusable node. * * @param {NodeList} users The list of users. * @param {Node} user The user to start with. * @param {Number} direction The direction in which to go. * @return {Node|null} A user node, or null if not found. * @method findFocusableUser */ findFocusableUser: function(users, user, direction) { var index = users.indexOf(user); if (users.size() < 1) { return null; } if (index < 0) { return users.item(0); } index += direction; // Wrap the navigation when reaching the top of the bottom. if (index < 0) { index = users.size() - 1; } else if (index >= users.size()) { index = 0; } return users.item(index); }, /** * Set the user tab focus. * * @param {Node} user The user node. * @method setUserTabFocus */ setUserTabFocus: function(user) { if (this._userTabFocus) { this._userTabFocus.setAttribute('tabindex', '-1'); } if (!user) { // We were not passed a user, there is apparently none in the dialogue. Nothing to do here \\\o/. return; } this._userTabFocus = user.one(SELECTORS.USERSELECT); this._userTabFocus.setAttribute('tabindex', '0'); this.get('boundingBox').one(SELECTORS.RESULTSUSERS).setAttribute('aria-activedescendant', this._userTabFocus.generateID()); } }, { NAME: USP.NAME, CSS_PREFIX: USP.CSS_PREFIX, ATTRS: { /** * The header. * * @attribute title * @default selectusers language string. * @type String */ title: { validator: Y.Lang.isString, valueFn: function() { return M.util.get_string('selectusers', COMPONENT); } }, /** * The current page URL. * * @attribute url * @default null * @type String */ url: { validator: Y.Lang.isString, value: null }, /** * The URL to the Ajax file. * * @attribute ajaxurl * @default null * @type String */ ajaxurl: { validator: Y.Lang.isString, value: null }, /** * The names of the selected users. * * The keys are the user IDs, the values are their fullname. * * @attribute selectedUsers * @default null * @type Object */ selectedUsers: { validator: Y.Lang.isObject, value: null, getter: function(v) { if (v === null) { return {}; } return v; } }, /** * The course ID. * * @attribute courseid * @default null * @type Number */ courseid: { value: null }, /** * Array of parameters. * * @attribute params * @default [] * @type Array */ params: { validator: Y.Lang.isArray, value: [] }, /** * The page we are on. * * @attribute page * @default 0 * @type Number */ page: { validator: Y.Lang.isNumber, value: 0 }, /** * The number of users displayed. * * @attribute userCount * @default 0 * @type Number */ userCount: { value: 0, validator: Y.Lang.isNumber }, /** * The number of results per page. * * @attribute perPage * @default 25 * @type Number */ perPage: { value: 25, Validator: Y.Lang.isNumber } } }); Y.Base.modifyAttrs(Y.namespace('M.gradereport_history.UserSelector'), { /** * List of extra classes. * * @attribute extraClasses * @default ['gradereport_history_usp'] * @type Array */ extraClasses: { value: [ 'gradereport_history_usp' ] }, /** * Whether to focus on the target that caused the Widget to be shown. * * @attribute focusOnPreviousTargetAfterHide * @default true * @type Node */ focusOnPreviousTargetAfterHide: { value: true }, /** * * Width. * * @attribute width * @default '500px' * @type String|Number */ width: { value: '500px' }, /** * Boolean indicating whether or not the Widget is visible. * * @attribute visible * @default false * @type Boolean */ visible: { value: false }, /** * Whether the widget should be modal or not. * * @attribute modal * @type Boolean * @default true */ modal: { value: true }, /** * Whether the widget should be draggable or not. * * @attribute draggable * @type Boolean * @default true */ draggable: { value: true } }); Y.namespace('M.gradereport_history.UserSelector').init = function(cfg) { return new USERSELECTOR(cfg); }; }, '@VERSION@', { "requires": [ "escape", "event-delegate", "event-key", "handlebars", "io-base", "json-parse", "moodle-core-notification-dialogue" ] }); yui/build/moodle-gradereport_history-userselector/moodle-gradereport_history-userselector-min.js 0000604 00000023201 15062070556 0032707 0 ustar 00 report/history YUI.add("moodle-gradereport_history-userselector",function(T,e){var g="gradereport_history",p={AJAXURL:"ajaxurl",BASE:"base",CHECKBOX_NAME_PREFIX:"usp-u",COURSEID:"courseid",DIALOGUE_PREFIX:"moodle-dialogue",NAME:"gradereport_history_usp",PAGE:"page",PARAMS:"params",PERPAGE:"perPage",SEARCH:"search",SEARCHBTN:"searchbtn",SELECTEDUSERS:"selectedUsers",URL:"url",USERCOUNT:"userCount"},R={ACCESSHIDE:"accesshide",AJAXCONTENT:"usp-ajax-content",CHECKBOX:"usp-checkbox",CLOSE:"close",CLOSEBTN:"usp-finish",CONTENT:"usp-content",DETAILS:"details",EXTRAFIELDS:"extrafields",FIRSTADDED:"usp-first-added",FULLNAME:"fullname",HEADER:"usp-header",HIDDEN:"hidden",LIGHTBOX:"usp-loading-lightbox",LOADINGICON:"loading-icon",MORERESULTS:"usp-more-results",OPTIONS:"options",PICTURE:"usp-picture",RESULTSCOUNT:"usp-results-count",SEARCH:"usp-search",SEARCHBTN:"usp-search-btn",SEARCHFIELD:"usp-search-field",SEARCHRESULTS:"usp-search-results",SELECTED:"selected",USER:"usp-user",USERS:"usp-users",WRAP:"usp-wrap"},C={AJAXCONTENT:"."+R.AJAXCONTENT,FINISHBTN:"."+R.CLOSEBTN+" input",FIRSTADDED:"."+R.FIRSTADDED,FULLNAME:"."+R.FULLNAME+" label",LIGHTBOX:"."+R.LIGHTBOX,MORERESULTS:"."+R.MORERESULTS,OPTIONS:"."+R.OPTIONS,PICTURE:"."+R.USER+" .userpicture",RESULTSCOUNT:"."+R.RESULTSCOUNT,RESULTSUSERS:"."+R.SEARCHRESULTS+" ."+R.USERS,SEARCHBTN:"."+R.SEARCHBTN,SEARCHFIELD:"."+R.SEARCHFIELD,SELECTEDNAMES:".felement .selectednames",TRIGGER:".gradereport_history_plugin input.selectortrigger",USER:"."+R.USER,USERFULLNAMES:'input[name="userfullnames"]',USERIDS:'input[name="userids"]',USERSELECT:"."+R.CHECKBOX+" input[type=checkbox]"},s=function(){s.superclass.constructor.apply(this,arguments)};T.namespace("M.gradereport_history").UserSelector=T.extend(s,M.core.dialogue,{_firstDisplay:!0,_usersBufferList:null,_userTabFocus:null,_userTemplate:null,initializer:function(){var e=this.get("boundingBox"),s=T.Handlebars.compile('<div class="{{CSS.WRAP}}"><div class="{{CSS.HEADER}}"><div class="{{CSS.SEARCH}}" role="search"><form><input type="text" class="{{CSS.SEARCHFIELD}}" aria-label="{{get_string "search" "moodle"}}" value="" /><input type="submit" class="{{CSS.SEARCHBTN}}"value="{{get_string "search" "moodle"}}"></form><div aria-live="polite" class="{{CSS.RESULTSCOUNT}}">{{get_string "loading" "admin"}}</div></div></div><div class="{{CSS.CONTENT}}"><form><div class="{{CSS.AJAXCONTENT}}" aria-live="polite"></div><div class="{{CSS.LIGHTBOX}} {{CSS.HIDDEN}}"><img class="{{CSS.LOADINGICON}}" alt="{{get_string "loading" "admin"}}"src="{{{loadingIcon}}}"></div><div class="{{CSS.CLOSEBTN}}"><input type="submit" value="{{get_string "finishselectingusers" COMPONENT}}"></div></form></div></div>'),s=T.Node.create(s({COMPONENT:g,CSS:R,loadingIcon:M.util.image_url("i/loading","moodle")}));this.getStdModNode(T.WidgetStdMod.HEADER).prepend(T.Node.create("<h1>"+this.get("title")+"</h1>")),this.setStdModContent(T.WidgetStdMod.BODY,s,T.WidgetStdMod.REPLACE),this.get("boundingBox").one(".moodle-dialogue-wrap").addClass("moodle-dialogue-content"),T.one(C.TRIGGER).on("click",this.show,this),e.one(C.FINISHBTN).on("click",this.finishSelectingUsers,this),e.delegate("key",this.userKeyboardNavigation,"down:38,40",C.AJAXCONTENT,this),T.delegate("click",this.selectUser,C.AJAXCONTENT,C.USERSELECT,this),T.delegate("click",this.selectUser,C.AJAXCONTENT,C.PICTURE,this),(s=this.get(p.PARAMS)).id=this.get(p.COURSEID),this.set(p.PARAMS,s),e.one(C.SEARCHBTN).on("click",this.search,this,!1)},show:function(e){var t;return this._usersBufferList=T.clone(this.get(p.SELECTEDUSERS)),this._firstDisplay?(this._firstDisplay=!1,this.search(e,!1)):((t=this.get("boundingBox")).all(C.USER).each(function(e){this.markUserNode(e,!1)},this),T.Object.each(this._usersBufferList,function(e,s){s=t.one(C.USER+'[data-userid="'+s+'"]');s&&this.markUserNode(s,!0)},this),this.setUserTabFocus(t.one(C.USER))),T.namespace("M.gradereport_history.UserSelector").superclass.show.call(this)},search:function(e,s){e&&e.preventDefault(),s?this.set(p.PAGE,this.get(p.PAGE)+1):(this.set(p.USERCOUNT,0),this.set(p.PAGE,0)),(e=this.get(p.PARAMS)).sesskey=M.cfg.sesskey,e.action="searchusers",e.search=this.get("boundingBox").one(C.SEARCHFIELD).get("value"),e.page=this.get(p.PAGE),e.perpage=this.get(p.PERPAGE),T.io(M.cfg.wwwroot+this.get(p.AJAXURL),{method:"POST",data:window.build_querystring(e),on:{start:this.preSearch,complete:this.processSearchResults,end:this.postSearch},context:this,arguments:{append:s}})},preSearch:function(e,s){var t=this.get("boundingBox");t.one(C.LIGHTBOX).removeClass(R.HIDDEN),s.append||t.one(C.RESULTSCOUNT).setHTML(M.util.get_string("loading","admin"))},postSearch:function(e,s){var t=this.get("boundingBox"),i=t.one(C.FIRSTADDED);t.one(C.LIGHTBOX).addClass(R.HIDDEN),s.append&&i?(this.setUserTabFocus(i),i.one(C.USERSELECT).focus()):(s=t.one(C.USER))&&this.setUserTabFocus(s)},processSearchResults:function(S,e,s){var t,d,i,r,E,a,n,o=!1,u=!1,l=this.get("boundingBox"),c=!0;try{(o=T.JSON.parse(e.responseText)).success&&!o.error||(u=!0)}catch(h){u=!0}if(u)return this.setContent(""),void l.one(C.RESULTSCOUNT).setHTML(M.util.get_string("errajaxsearch",g));for(E in t=s.append?l.one(C.RESULTSUSERS):T.Node.create('<div role="listbox" aria-activedescendant="" aria-multiselectable="true" class="'+R.USERS+'"></div>'),this._userTemplate||(this._userTemplate=T.Handlebars.compile('<div role="option" aria-selected="false" class="{{CSS.USER}} clearfix" data-userid="{{userId}}"><div class="{{CSS.CHECKBOX}}"><input name="{{USP.CHECKBOX_NAME_PREFIX}}{{userId}}" type="checkbox" tabindex="-1"id="{{checkboxId}}" aria-describedby="{{checkboxId}} {{extraFieldsId}}"/></div><div class="{{CSS.PICTURE}}">{{{picture}}}</div><div class="{{CSS.DETAILS}}"><div class="{{CSS.FULLNAME}}"><label for="{{checkboxId}}">{{fullname}}</label></div><div id="{{extraFieldsId}}" class="{{CSS.EXTRAFIELDS}}">{{{extrafields}}}</div></div></div>')),d=this._userTemplate,i=this.get(p.USERCOUNT),r="",o.response.users)i++,n=o.response.users[E], r=!!T.Object.hasKey(this._usersBufferList,n.userid),n=T.Node.create(d({checkboxId:T.guid(),COMPONENT:g,count:i,CSS:R,extrafields:n.extrafields,extraFieldsId:T.guid(),fullname:n.fullname,picture:n.picture,userId:n.userid,USP:p})),this.markUserNode(n,r),s.append&&c&&(t.all(C.FIRSTADDED).removeClass(R.FIRSTADDED),n.addClass(R.FIRSTADDED),c=!1),t.append(n);this.set(p.USERCOUNT,i),e=parseInt(o.response.totalusers,10),s.append?e<=(this.get(p.PAGE)+1)*this.get(p.PERPAGE)&&l.one(C.MORERESULTS).remove():(0===e?(l.one(C.RESULTSCOUNT).setHTML(M.util.get_string("noresults","moodle")),a=""):(1===e?l.one(C.RESULTSCOUNT).setHTML(M.util.get_string("foundoneuser",g)):l.one(C.RESULTSCOUNT).setHTML(M.util.get_string("foundnusers",g,e)),a=T.Node.create('<div class="'+R.SEARCHRESULTS+'"></div>').append(t),o.response.totalusers>(this.get(p.PAGE)+1)*this.get(p.PERPAGE)&&((u=T.Node.create('<div class="'+R.MORERESULTS+'"><a href="#" role="button">'+M.util.get_string("loadmoreusers",g)+"</a></div>")).one("a").on("click",this.search,this,!0),u.one("a").on("key",this.search,"space",this,!0),a.append(u))),this.setContent(a))},finishSelectingUsers:function(e){e.preventDefault(),this.applySelection(),this.hide()},applySelection:function(){var e=T.Object.keys(this._usersBufferList);this.set(p.SELECTEDUSERS,T.clone(this._usersBufferList)).setNameDisplay(),T.one(C.USERIDS).set("value",e.join())},selectUser:function(e){var s=e.currentTarget.ancestor(C.USER),t=s.one(C.USERSELECT),i=s.one(C.FULLNAME).get("innerHTML"),r=t.get("checked"),a=s.getData("userid");(r=e.currentTarget!==t?!r:r)?this._usersBufferList[a]=i:(delete this._usersBufferList[a],delete this._usersBufferList[parseInt(a,10)]),this.markUserNode(s,r)},markUserNode:function(e,s){return s?e.addClass(R.SELECTED).set("aria-selected",!0).one(C.USERSELECT).set("checked",!0):e.removeClass(R.SELECTED).set("aria-selected",!1).one(C.USERSELECT).set("checked",!1),this},setContent:function(e){return this.get("boundingBox").one(C.AJAXCONTENT).setHTML(e),this},setNameDisplay:function(){var e=T.Object.values(this.get(p.SELECTEDUSERS));T.one(C.SELECTEDNAMES).set("innerHTML",e.join(", ")),T.one(C.USERFULLNAMES).set("value",e.join())},userKeyboardNavigation:function(e){var s=this.get("boundingBox").all(C.USER),t=1,i=e.target.ancestor(C.USER,!0);38===e.keyCode&&(t=-1),(s=this.findFocusableUser(s,i,t))&&(e.preventDefault(),s.one(C.USERSELECT).focus(),this.setUserTabFocus(s))},findFocusableUser:function(e,s,t){s=e.indexOf(s);return e.size()<1?null:s<0?e.item(0):((s+=t)<0?s=e.size()-1:s>=e.size()&&(s=0),e.item(s))},setUserTabFocus:function(e){this._userTabFocus&&this._userTabFocus.setAttribute("tabindex","-1"),e&&(this._userTabFocus=e.one(C.USERSELECT),this._userTabFocus.setAttribute("tabindex","0"),this.get("boundingBox").one(C.RESULTSUSERS).setAttribute("aria-activedescendant",this._userTabFocus.generateID()))}},{NAME:p.NAME,CSS_PREFIX:p.CSS_PREFIX,ATTRS:{title:{validator:T.Lang.isString,valueFn:function(){return M.util.get_string("selectusers",g)}},url:{validator:T.Lang.isString,value:null},ajaxurl:{validator:T.Lang.isString,value:null},selectedUsers:{validator:T.Lang.isObject,value:null,getter:function(e){return null===e?{}:e}},courseid:{value:null},params:{validator:T.Lang.isArray,value:[]},page:{validator:T.Lang.isNumber,value:0},userCount:{value:0,validator:T.Lang.isNumber},perPage:{value:25,Validator:T.Lang.isNumber}}}),T.Base.modifyAttrs(T.namespace("M.gradereport_history.UserSelector"),{extraClasses:{value:["gradereport_history_usp"]},focusOnPreviousTargetAfterHide:{value:!0},width:{value:"500px"},visible:{value:!1},modal:{value:!0},draggable:{value:!0}}),T.namespace("M.gradereport_history.UserSelector").init=function(e){return new s(e)}},"@VERSION@",{requires:["escape","event-delegate","event-key","handlebars","io-base","json-parse","moodle-core-notification-dialogue"]}); yui/build/moodle-gradereport_history-userselector/moodle-gradereport_history-userselector-debug.js 0000604 00000063465 15062070556 0033232 0 ustar 00 report/history YUI.add('moodle-gradereport_history-userselector', function (Y, NAME) { // 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/>. /** * The User Selector for the grade history report. * * @module moodle-gradereport_history-userselector * @package gradereport_history * @copyright 2013 NetSpot Pty Ltd (https://www.netspot.com.au) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * @main moodle-gradereport_history-userselector */ /** * @module moodle-gradereport_history-userselector */ var COMPONENT = 'gradereport_history'; var USP = { AJAXURL: 'ajaxurl', BASE: 'base', CHECKBOX_NAME_PREFIX: 'usp-u', COURSEID: 'courseid', DIALOGUE_PREFIX: 'moodle-dialogue', NAME: 'gradereport_history_usp', PAGE: 'page', PARAMS: 'params', PERPAGE: 'perPage', SEARCH: 'search', SEARCHBTN: 'searchbtn', SELECTEDUSERS: 'selectedUsers', URL: 'url', USERCOUNT: 'userCount' }; var CSS = { ACCESSHIDE: 'accesshide', AJAXCONTENT: 'usp-ajax-content', CHECKBOX: 'usp-checkbox', CLOSE: 'close', CLOSEBTN: 'usp-finish', CONTENT: 'usp-content', DETAILS: 'details', EXTRAFIELDS: 'extrafields', FIRSTADDED: 'usp-first-added', FULLNAME: 'fullname', HEADER: 'usp-header', HIDDEN: 'hidden', LIGHTBOX: 'usp-loading-lightbox', LOADINGICON: 'loading-icon', MORERESULTS: 'usp-more-results', OPTIONS: 'options', PICTURE: 'usp-picture', RESULTSCOUNT: 'usp-results-count', SEARCH: 'usp-search', SEARCHBTN: 'usp-search-btn', SEARCHFIELD: 'usp-search-field', SEARCHRESULTS: 'usp-search-results', SELECTED: 'selected', USER: 'usp-user', USERS: 'usp-users', WRAP: 'usp-wrap' }; var SELECTORS = { AJAXCONTENT: '.' + CSS.AJAXCONTENT, FINISHBTN: '.' + CSS.CLOSEBTN + ' input', FIRSTADDED: '.' + CSS.FIRSTADDED, FULLNAME: '.' + CSS.FULLNAME + ' label', LIGHTBOX: '.' + CSS.LIGHTBOX, MORERESULTS: '.' + CSS.MORERESULTS, OPTIONS: '.' + CSS.OPTIONS, PICTURE: '.' + CSS.USER + ' .userpicture', RESULTSCOUNT: '.' + CSS.RESULTSCOUNT, RESULTSUSERS: '.' + CSS.SEARCHRESULTS + ' .' + CSS.USERS, SEARCHBTN: '.' + CSS.SEARCHBTN, SEARCHFIELD: '.' + CSS.SEARCHFIELD, SELECTEDNAMES: '.felement .selectednames', TRIGGER: '.gradereport_history_plugin input.selectortrigger', USER: '.' + CSS.USER, USERFULLNAMES: 'input[name="userfullnames"]', USERIDS: 'input[name="userids"]', USERSELECT: '.' + CSS.CHECKBOX + ' input[type=checkbox]' }; /** * User Selector. * * @namespace M.gradereport_history * @class UserSelector * @constructor */ var USERSELECTOR = function() { USERSELECTOR.superclass.constructor.apply(this, arguments); }; Y.namespace('M.gradereport_history').UserSelector = Y.extend(USERSELECTOR, M.core.dialogue, { /** * Whether or not this is the first time the user displays the dialogue within that request. * * @property _firstDisplay * @type Boolean * @private */ _firstDisplay: true, /** * The list of all the users selected while the dialogue is open. * * @type Object * @property _usersBufferList * @private */ _usersBufferList: null, /** * The Node on which the focus is set. * * @property _userTabFocus * @type Node * @private */ _userTabFocus: null, /** * Compiled template function for a user node. * * @property _userTemplate * @type Function * @private */ _userTemplate: null, initializer: function() { var bb = this.get('boundingBox'), content, params, tpl; tpl = Y.Handlebars.compile( '<div class="{{CSS.WRAP}}">' + '<div class="{{CSS.HEADER}}">' + '<div class="{{CSS.SEARCH}}" role="search">' + '<form>' + '<input type="text" class="{{CSS.SEARCHFIELD}}" ' + 'aria-label="{{get_string "search" "moodle"}}" value="" />' + '<input type="submit" class="{{CSS.SEARCHBTN}}"' + 'value="{{get_string "search" "moodle"}}">' + '</form>' + '<div aria-live="polite" class="{{CSS.RESULTSCOUNT}}">{{get_string "loading" "admin"}}</div>' + '</div>' + '</div>' + '<div class="{{CSS.CONTENT}}">' + '<form>' + '<div class="{{CSS.AJAXCONTENT}}" aria-live="polite"></div>' + '<div class="{{CSS.LIGHTBOX}} {{CSS.HIDDEN}}">' + '<img class="{{CSS.LOADINGICON}}" alt="{{get_string "loading" "admin"}}"' + 'src="{{{loadingIcon}}}">' + '</div>' + '<div class="{{CSS.CLOSEBTN}}">' + '<input type="submit" value="{{get_string "finishselectingusers" COMPONENT}}">' + '</div>' + '</form>' + '</div>' + '</div>'); content = Y.Node.create( tpl({ COMPONENT: COMPONENT, CSS: CSS, loadingIcon: M.util.image_url('i/loading', 'moodle') }) ); // Set the title and content. this.getStdModNode(Y.WidgetStdMod.HEADER).prepend(Y.Node.create('<h1>' + this.get('title') + '</h1>')); this.setStdModContent(Y.WidgetStdMod.BODY, content, Y.WidgetStdMod.REPLACE); // Use standard dialogue class name. This removes the default styling of the footer. this.get('boundingBox').one('.moodle-dialogue-wrap').addClass('moodle-dialogue-content'); // Add the event on the button that opens the dialogue. Y.one(SELECTORS.TRIGGER).on('click', this.show, this); // The button to finalize the selection. bb.one(SELECTORS.FINISHBTN).on('click', this.finishSelectingUsers, this); // Delegate the keyboard navigation in the users list. bb.delegate('key', this.userKeyboardNavigation, 'down:38,40', SELECTORS.AJAXCONTENT, this); // Delegate the action to select a user. Y.delegate('click', this.selectUser, SELECTORS.AJAXCONTENT, SELECTORS.USERSELECT, this); Y.delegate('click', this.selectUser, SELECTORS.AJAXCONTENT, SELECTORS.PICTURE, this); params = this.get(USP.PARAMS); params.id = this.get(USP.COURSEID); this.set(USP.PARAMS, params); bb.one(SELECTORS.SEARCHBTN).on('click', this.search, this, false); }, /** * Display the dialogue. * * @method show */ show: function(e) { var bb; this._usersBufferList = Y.clone(this.get(USP.SELECTEDUSERS)); if (this._firstDisplay) { // Load the default list of users when the dialogue is loaded for the first time. this._firstDisplay = false; this.search(e, false); } else { // Leave the content as is, but reset the selection. bb = this.get('boundingBox'); // Remove all the selected users. bb.all(SELECTORS.USER).each(function(node) { this.markUserNode(node, false); }, this); // Select the users. Y.Object.each(this._usersBufferList, function(v, k) { var user = bb.one(SELECTORS.USER + '[data-userid="' + k + '"]'); if (user) { this.markUserNode(user, true); } }, this); // Reset the tab focus. this.setUserTabFocus(bb.one(SELECTORS.USER)); } return Y.namespace('M.gradereport_history.UserSelector').superclass.show.call(this); }, /** * Search for users. * * @method search * @param {EventFacade} e The event. * @param {Boolean} append Whether we want to append the results to the current results or not. */ search: function(e, append) { if (e) { e.preventDefault(); } var params; if (append) { this.set(USP.PAGE, this.get(USP.PAGE) + 1); } else { this.set(USP.USERCOUNT, 0); this.set(USP.PAGE, 0); } params = this.get(USP.PARAMS); params.sesskey = M.cfg.sesskey; params.action = 'searchusers'; params.search = this.get('boundingBox').one(SELECTORS.SEARCHFIELD).get('value'); params.page = this.get(USP.PAGE); params.perpage = this.get(USP.PERPAGE); Y.io(M.cfg.wwwroot + this.get(USP.AJAXURL), { method: 'POST', data: window.build_querystring(params), on: { start: this.preSearch, complete: this.processSearchResults, end: this.postSearch }, context: this, "arguments": { // Quoted because this is a reserved keyword. append: append } }); }, /** * Pre search callback. * * @method preSearch * @param {String} transactionId The transaction ID. * @param {Object} args The arguments passed from YUI.io() */ preSearch: function(unused, args) { var bb = this.get('boundingBox'); // Display the lightbox. bb.one(SELECTORS.LIGHTBOX).removeClass(CSS.HIDDEN); // Set the number of results to 'loading...'. if (!args.append) { bb.one(SELECTORS.RESULTSCOUNT).setHTML(M.util.get_string('loading', 'admin')); } }, /** * Post search callback. * * @method postSearch * @param {String} transactionId The transaction ID. * @param {Object} args The arguments passed from YUI.io() */ postSearch: function(transactionId, args) { var bb = this.get('boundingBox'), firstAdded = bb.one(SELECTORS.FIRSTADDED), firstUser; // Hide the lightbox. bb.one(SELECTORS.LIGHTBOX).addClass(CSS.HIDDEN); if (args.append && firstAdded) { // Sets the focus on the newly added user if we are appending results. this.setUserTabFocus(firstAdded); firstAdded.one(SELECTORS.USERSELECT).focus(); } else { // New search result, set the tab focus on the first user returned. firstUser = bb.one(SELECTORS.USER); if (firstUser) { this.setUserTabFocus(firstUser); } } }, /** * Process and display the search results. * * @method processSearchResults * @param {String} tid The transaction ID. * @param {Object} outcome The response object. * @param {Object} args The arguments passed from YUI.io(). */ processSearchResults: function(tid, outcome, args) { var result = false, error = false, bb = this.get('boundingBox'), users, userTemplate, count, selected, i, firstAdded = true, node, content, fetchmore, totalUsers; // Decodes the result. try { result = Y.JSON.parse(outcome.responseText); if (!result.success || result.error) { error = true; } } catch (e) { error = true; } // There was an error. if (error) { this.setContent(''); bb.one(SELECTORS.RESULTSCOUNT).setHTML(M.util.get_string('errajaxsearch', COMPONENT)); return; } // Create the div containing the users when it is a fresh search. if (!args.append) { users = Y.Node.create('<div role="listbox" aria-activedescendant="" aria-multiselectable="true" class="' + CSS.USERS + '"></div>'); } else { users = bb.one(SELECTORS.RESULTSUSERS); } // Compile the template for each user node. if (!this._userTemplate) { this._userTemplate = Y.Handlebars.compile( '<div role="option" aria-selected="false" class="{{CSS.USER}} clearfix" ' + 'data-userid="{{userId}}">' + '<div class="{{CSS.CHECKBOX}}">' + '<input name="{{USP.CHECKBOX_NAME_PREFIX}}{{userId}}" type="checkbox" tabindex="-1"' + 'id="{{checkboxId}}" aria-describedby="{{checkboxId}} {{extraFieldsId}}"/>' + '</div>' + '<div class="{{CSS.PICTURE}}">{{{picture}}}</div>' + '<div class="{{CSS.DETAILS}}">' + '<div class="{{CSS.FULLNAME}}">' + '<label for="{{checkboxId}}">{{fullname}}</label>' + '</div>' + '<div id="{{extraFieldsId}}" class="{{CSS.EXTRAFIELDS}}">{{{extrafields}}}</div>' + '</div>' + '</div>' ); } userTemplate = this._userTemplate; // Append the users one by one. count = this.get(USP.USERCOUNT); selected = ''; var user; for (i in result.response.users) { count++; user = result.response.users[i]; // If already selected. if (Y.Object.hasKey(this._usersBufferList, user.userid)) { selected = true; } else { selected = false; } node = Y.Node.create(userTemplate({ checkboxId: Y.guid(), COMPONENT: COMPONENT, count: count, CSS: CSS, extrafields: user.extrafields, extraFieldsId: Y.guid(), fullname: user.fullname, picture: user.picture, userId: user.userid, USP: USP })); this.markUserNode(node, selected); // Noting the first user that was when adding more results. if (args.append && firstAdded) { users.all(SELECTORS.FIRSTADDED).removeClass(CSS.FIRSTADDED); node.addClass(CSS.FIRSTADDED); firstAdded = false; } users.append(node); } this.set(USP.USERCOUNT, count); // Update the count of users, and add a button to load more if need be. totalUsers = parseInt(result.response.totalusers, 10); if (!args.append) { if (totalUsers === 0) { bb.one(SELECTORS.RESULTSCOUNT).setHTML(M.util.get_string('noresults', 'moodle')); content = ''; } else { if (totalUsers === 1) { bb.one(SELECTORS.RESULTSCOUNT).setHTML(M.util.get_string('foundoneuser', COMPONENT)); } else { bb.one(SELECTORS.RESULTSCOUNT).setHTML(M.util.get_string('foundnusers', COMPONENT, totalUsers)); } content = Y.Node.create('<div class="' + CSS.SEARCHRESULTS + '"></div>') .append(users); if (result.response.totalusers > (this.get(USP.PAGE) + 1) * this.get(USP.PERPAGE)) { fetchmore = Y.Node.create('<div class="' + CSS.MORERESULTS + '">' + '<a href="#" role="button">' + M.util.get_string('loadmoreusers', COMPONENT) + '</a></div>'); fetchmore.one('a').on('click', this.search, this, true); fetchmore.one('a').on('key', this.search, 'space', this, true); content.append(fetchmore); } } this.setContent(content); } else { if (totalUsers <= (this.get(USP.PAGE) + 1) * this.get(USP.PERPAGE)) { bb.one(SELECTORS.MORERESULTS).remove(); } } }, /** * When the user has finished selecting users. * * @method finishSelectingUsers * @param {EventFacade} e The event. */ finishSelectingUsers: function(e) { e.preventDefault(); this.applySelection(); this.hide(); }, /** * Apply the selection made. * * @method applySelection * @param {EventFacade} e The event. */ applySelection: function() { var userIds = Y.Object.keys(this._usersBufferList); this.set(USP.SELECTEDUSERS, Y.clone(this._usersBufferList)) .setNameDisplay(); Y.one(SELECTORS.USERIDS).set('value', userIds.join()); }, /** * Select a user. * * @method SelectUser * @param {EventFacade} e The event. */ selectUser: function(e) { var user = e.currentTarget.ancestor(SELECTORS.USER), checkbox = user.one(SELECTORS.USERSELECT), fullname = user.one(SELECTORS.FULLNAME).get('innerHTML'), checked = checkbox.get('checked'), userId = user.getData('userid'); if (e.currentTarget !== checkbox) { // We triggered the selection from another node, so we need to change the checkbox value. checked = !checked; } if (checked) { // Selecting the user. this._usersBufferList[userId] = fullname; } else { // De-selecting the user. delete this._usersBufferList[userId]; delete this._usersBufferList[parseInt(userId, 10)]; // Also remove numbered keys. } this.markUserNode(user, checked); }, /** * Mark a user node as selected or not. * * This only takes care of the DOM side of things, not the internal mechanism * storing what users have been selected or not. * * @param {Node} node The user node. * @param {Boolean} selected True to mark as selected. * @chainable */ markUserNode: function(node, selected) { if (selected) { node.addClass(CSS.SELECTED) .set('aria-selected', true) .one(SELECTORS.USERSELECT) .set('checked', true); } else { node.removeClass(CSS.SELECTED) .set('aria-selected', false) .one(SELECTORS.USERSELECT) .set('checked', false); } return this; }, /** * Set the content of the dialogue. * * @method setContent * @param {String} content The content. * @chainable */ setContent: function(content) { this.get('boundingBox').one(SELECTORS.AJAXCONTENT).setHTML(content); return this; }, /** * Display the names of the selected users in the form. * * @method setNameDisplay */ setNameDisplay: function() { var namelist = Y.Object.values(this.get(USP.SELECTEDUSERS)); Y.one(SELECTORS.SELECTEDNAMES).set('innerHTML', namelist.join(', ')); Y.one(SELECTORS.USERFULLNAMES).set('value', namelist.join()); }, /** * User keyboard navigation. * * @method userKeyboardNavigation */ userKeyboardNavigation: function(e) { var bb = this.get('boundingBox'), users = bb.all(SELECTORS.USER), direction = 1, user, current = e.target.ancestor(SELECTORS.USER, true); if (e.keyCode === 38) { direction = -1; } user = this.findFocusableUser(users, current, direction); if (user) { e.preventDefault(); user.one(SELECTORS.USERSELECT).focus(); this.setUserTabFocus(user); } }, /** * Find the next or previous focusable node. * * @param {NodeList} users The list of users. * @param {Node} user The user to start with. * @param {Number} direction The direction in which to go. * @return {Node|null} A user node, or null if not found. * @method findFocusableUser */ findFocusableUser: function(users, user, direction) { var index = users.indexOf(user); if (users.size() < 1) { Y.log('The users list is empty', 'debug', COMPONENT); return null; } if (index < 0) { Y.log('Unable to find the user in the list of users', 'debug', COMPONENT); return users.item(0); } index += direction; // Wrap the navigation when reaching the top of the bottom. if (index < 0) { index = users.size() - 1; } else if (index >= users.size()) { index = 0; } return users.item(index); }, /** * Set the user tab focus. * * @param {Node} user The user node. * @method setUserTabFocus */ setUserTabFocus: function(user) { if (this._userTabFocus) { this._userTabFocus.setAttribute('tabindex', '-1'); } if (!user) { // We were not passed a user, there is apparently none in the dialogue. Nothing to do here \\\o/. return; } this._userTabFocus = user.one(SELECTORS.USERSELECT); this._userTabFocus.setAttribute('tabindex', '0'); this.get('boundingBox').one(SELECTORS.RESULTSUSERS).setAttribute('aria-activedescendant', this._userTabFocus.generateID()); } }, { NAME: USP.NAME, CSS_PREFIX: USP.CSS_PREFIX, ATTRS: { /** * The header. * * @attribute title * @default selectusers language string. * @type String */ title: { validator: Y.Lang.isString, valueFn: function() { return M.util.get_string('selectusers', COMPONENT); } }, /** * The current page URL. * * @attribute url * @default null * @type String */ url: { validator: Y.Lang.isString, value: null }, /** * The URL to the Ajax file. * * @attribute ajaxurl * @default null * @type String */ ajaxurl: { validator: Y.Lang.isString, value: null }, /** * The names of the selected users. * * The keys are the user IDs, the values are their fullname. * * @attribute selectedUsers * @default null * @type Object */ selectedUsers: { validator: Y.Lang.isObject, value: null, getter: function(v) { if (v === null) { return {}; } return v; } }, /** * The course ID. * * @attribute courseid * @default null * @type Number */ courseid: { value: null }, /** * Array of parameters. * * @attribute params * @default [] * @type Array */ params: { validator: Y.Lang.isArray, value: [] }, /** * The page we are on. * * @attribute page * @default 0 * @type Number */ page: { validator: Y.Lang.isNumber, value: 0 }, /** * The number of users displayed. * * @attribute userCount * @default 0 * @type Number */ userCount: { value: 0, validator: Y.Lang.isNumber }, /** * The number of results per page. * * @attribute perPage * @default 25 * @type Number */ perPage: { value: 25, Validator: Y.Lang.isNumber } } }); Y.Base.modifyAttrs(Y.namespace('M.gradereport_history.UserSelector'), { /** * List of extra classes. * * @attribute extraClasses * @default ['gradereport_history_usp'] * @type Array */ extraClasses: { value: [ 'gradereport_history_usp' ] }, /** * Whether to focus on the target that caused the Widget to be shown. * * @attribute focusOnPreviousTargetAfterHide * @default true * @type Node */ focusOnPreviousTargetAfterHide: { value: true }, /** * * Width. * * @attribute width * @default '500px' * @type String|Number */ width: { value: '500px' }, /** * Boolean indicating whether or not the Widget is visible. * * @attribute visible * @default false * @type Boolean */ visible: { value: false }, /** * Whether the widget should be modal or not. * * @attribute modal * @type Boolean * @default true */ modal: { value: true }, /** * Whether the widget should be draggable or not. * * @attribute draggable * @type Boolean * @default true */ draggable: { value: true } }); Y.namespace('M.gradereport_history.UserSelector').init = function(cfg) { return new USERSELECTOR(cfg); }; }, '@VERSION@', { "requires": [ "escape", "event-delegate", "event-key", "handlebars", "io-base", "json-parse", "moodle-core-notification-dialogue" ] }); report/history/yui/src/userselector/js/userselector.js 0000604 00000063020 15062070556 0017370 0 ustar 00 // 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/>. /** * The User Selector for the grade history report. * * @module moodle-gradereport_history-userselector * @package gradereport_history * @copyright 2013 NetSpot Pty Ltd (https://www.netspot.com.au) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * @main moodle-gradereport_history-userselector */ /** * @module moodle-gradereport_history-userselector */ var COMPONENT = 'gradereport_history'; var USP = { AJAXURL: 'ajaxurl', BASE: 'base', CHECKBOX_NAME_PREFIX: 'usp-u', COURSEID: 'courseid', DIALOGUE_PREFIX: 'moodle-dialogue', NAME: 'gradereport_history_usp', PAGE: 'page', PARAMS: 'params', PERPAGE: 'perPage', SEARCH: 'search', SEARCHBTN: 'searchbtn', SELECTEDUSERS: 'selectedUsers', URL: 'url', USERCOUNT: 'userCount' }; var CSS = { ACCESSHIDE: 'accesshide', AJAXCONTENT: 'usp-ajax-content', CHECKBOX: 'usp-checkbox', CLOSE: 'close', CLOSEBTN: 'usp-finish', CONTENT: 'usp-content', DETAILS: 'details', EXTRAFIELDS: 'extrafields', FIRSTADDED: 'usp-first-added', FULLNAME: 'fullname', HEADER: 'usp-header', HIDDEN: 'hidden', LIGHTBOX: 'usp-loading-lightbox', LOADINGICON: 'loading-icon', MORERESULTS: 'usp-more-results', OPTIONS: 'options', PICTURE: 'usp-picture', RESULTSCOUNT: 'usp-results-count', SEARCH: 'usp-search', SEARCHBTN: 'usp-search-btn', SEARCHFIELD: 'usp-search-field', SEARCHRESULTS: 'usp-search-results', SELECTED: 'selected', USER: 'usp-user', USERS: 'usp-users', WRAP: 'usp-wrap' }; var SELECTORS = { AJAXCONTENT: '.' + CSS.AJAXCONTENT, FINISHBTN: '.' + CSS.CLOSEBTN + ' input', FIRSTADDED: '.' + CSS.FIRSTADDED, FULLNAME: '.' + CSS.FULLNAME + ' label', LIGHTBOX: '.' + CSS.LIGHTBOX, MORERESULTS: '.' + CSS.MORERESULTS, OPTIONS: '.' + CSS.OPTIONS, PICTURE: '.' + CSS.USER + ' .userpicture', RESULTSCOUNT: '.' + CSS.RESULTSCOUNT, RESULTSUSERS: '.' + CSS.SEARCHRESULTS + ' .' + CSS.USERS, SEARCHBTN: '.' + CSS.SEARCHBTN, SEARCHFIELD: '.' + CSS.SEARCHFIELD, SELECTEDNAMES: '.felement .selectednames', TRIGGER: '.gradereport_history_plugin input.selectortrigger', USER: '.' + CSS.USER, USERFULLNAMES: 'input[name="userfullnames"]', USERIDS: 'input[name="userids"]', USERSELECT: '.' + CSS.CHECKBOX + ' input[type=checkbox]' }; /** * User Selector. * * @namespace M.gradereport_history * @class UserSelector * @constructor */ var USERSELECTOR = function() { USERSELECTOR.superclass.constructor.apply(this, arguments); }; Y.namespace('M.gradereport_history').UserSelector = Y.extend(USERSELECTOR, M.core.dialogue, { /** * Whether or not this is the first time the user displays the dialogue within that request. * * @property _firstDisplay * @type Boolean * @private */ _firstDisplay: true, /** * The list of all the users selected while the dialogue is open. * * @type Object * @property _usersBufferList * @private */ _usersBufferList: null, /** * The Node on which the focus is set. * * @property _userTabFocus * @type Node * @private */ _userTabFocus: null, /** * Compiled template function for a user node. * * @property _userTemplate * @type Function * @private */ _userTemplate: null, initializer: function() { var bb = this.get('boundingBox'), content, params, tpl; tpl = Y.Handlebars.compile( '<div class="{{CSS.WRAP}}">' + '<div class="{{CSS.HEADER}}">' + '<div class="{{CSS.SEARCH}}" role="search">' + '<form>' + '<input type="text" class="{{CSS.SEARCHFIELD}}" ' + 'aria-label="{{get_string "search" "moodle"}}" value="" />' + '<input type="submit" class="{{CSS.SEARCHBTN}}"' + 'value="{{get_string "search" "moodle"}}">' + '</form>' + '<div aria-live="polite" class="{{CSS.RESULTSCOUNT}}">{{get_string "loading" "admin"}}</div>' + '</div>' + '</div>' + '<div class="{{CSS.CONTENT}}">' + '<form>' + '<div class="{{CSS.AJAXCONTENT}}" aria-live="polite"></div>' + '<div class="{{CSS.LIGHTBOX}} {{CSS.HIDDEN}}">' + '<img class="{{CSS.LOADINGICON}}" alt="{{get_string "loading" "admin"}}"' + 'src="{{{loadingIcon}}}">' + '</div>' + '<div class="{{CSS.CLOSEBTN}}">' + '<input type="submit" value="{{get_string "finishselectingusers" COMPONENT}}">' + '</div>' + '</form>' + '</div>' + '</div>'); content = Y.Node.create( tpl({ COMPONENT: COMPONENT, CSS: CSS, loadingIcon: M.util.image_url('i/loading', 'moodle') }) ); // Set the title and content. this.getStdModNode(Y.WidgetStdMod.HEADER).prepend(Y.Node.create('<h1>' + this.get('title') + '</h1>')); this.setStdModContent(Y.WidgetStdMod.BODY, content, Y.WidgetStdMod.REPLACE); // Use standard dialogue class name. This removes the default styling of the footer. this.get('boundingBox').one('.moodle-dialogue-wrap').addClass('moodle-dialogue-content'); // Add the event on the button that opens the dialogue. Y.one(SELECTORS.TRIGGER).on('click', this.show, this); // The button to finalize the selection. bb.one(SELECTORS.FINISHBTN).on('click', this.finishSelectingUsers, this); // Delegate the keyboard navigation in the users list. bb.delegate('key', this.userKeyboardNavigation, 'down:38,40', SELECTORS.AJAXCONTENT, this); // Delegate the action to select a user. Y.delegate('click', this.selectUser, SELECTORS.AJAXCONTENT, SELECTORS.USERSELECT, this); Y.delegate('click', this.selectUser, SELECTORS.AJAXCONTENT, SELECTORS.PICTURE, this); params = this.get(USP.PARAMS); params.id = this.get(USP.COURSEID); this.set(USP.PARAMS, params); bb.one(SELECTORS.SEARCHBTN).on('click', this.search, this, false); }, /** * Display the dialogue. * * @method show */ show: function(e) { var bb; this._usersBufferList = Y.clone(this.get(USP.SELECTEDUSERS)); if (this._firstDisplay) { // Load the default list of users when the dialogue is loaded for the first time. this._firstDisplay = false; this.search(e, false); } else { // Leave the content as is, but reset the selection. bb = this.get('boundingBox'); // Remove all the selected users. bb.all(SELECTORS.USER).each(function(node) { this.markUserNode(node, false); }, this); // Select the users. Y.Object.each(this._usersBufferList, function(v, k) { var user = bb.one(SELECTORS.USER + '[data-userid="' + k + '"]'); if (user) { this.markUserNode(user, true); } }, this); // Reset the tab focus. this.setUserTabFocus(bb.one(SELECTORS.USER)); } return Y.namespace('M.gradereport_history.UserSelector').superclass.show.call(this); }, /** * Search for users. * * @method search * @param {EventFacade} e The event. * @param {Boolean} append Whether we want to append the results to the current results or not. */ search: function(e, append) { if (e) { e.preventDefault(); } var params; if (append) { this.set(USP.PAGE, this.get(USP.PAGE) + 1); } else { this.set(USP.USERCOUNT, 0); this.set(USP.PAGE, 0); } params = this.get(USP.PARAMS); params.sesskey = M.cfg.sesskey; params.action = 'searchusers'; params.search = this.get('boundingBox').one(SELECTORS.SEARCHFIELD).get('value'); params.page = this.get(USP.PAGE); params.perpage = this.get(USP.PERPAGE); Y.io(M.cfg.wwwroot + this.get(USP.AJAXURL), { method: 'POST', data: window.build_querystring(params), on: { start: this.preSearch, complete: this.processSearchResults, end: this.postSearch }, context: this, "arguments": { // Quoted because this is a reserved keyword. append: append } }); }, /** * Pre search callback. * * @method preSearch * @param {String} transactionId The transaction ID. * @param {Object} args The arguments passed from YUI.io() */ preSearch: function(unused, args) { var bb = this.get('boundingBox'); // Display the lightbox. bb.one(SELECTORS.LIGHTBOX).removeClass(CSS.HIDDEN); // Set the number of results to 'loading...'. if (!args.append) { bb.one(SELECTORS.RESULTSCOUNT).setHTML(M.util.get_string('loading', 'admin')); } }, /** * Post search callback. * * @method postSearch * @param {String} transactionId The transaction ID. * @param {Object} args The arguments passed from YUI.io() */ postSearch: function(transactionId, args) { var bb = this.get('boundingBox'), firstAdded = bb.one(SELECTORS.FIRSTADDED), firstUser; // Hide the lightbox. bb.one(SELECTORS.LIGHTBOX).addClass(CSS.HIDDEN); if (args.append && firstAdded) { // Sets the focus on the newly added user if we are appending results. this.setUserTabFocus(firstAdded); firstAdded.one(SELECTORS.USERSELECT).focus(); } else { // New search result, set the tab focus on the first user returned. firstUser = bb.one(SELECTORS.USER); if (firstUser) { this.setUserTabFocus(firstUser); } } }, /** * Process and display the search results. * * @method processSearchResults * @param {String} tid The transaction ID. * @param {Object} outcome The response object. * @param {Object} args The arguments passed from YUI.io(). */ processSearchResults: function(tid, outcome, args) { var result = false, error = false, bb = this.get('boundingBox'), users, userTemplate, count, selected, i, firstAdded = true, node, content, fetchmore, totalUsers; // Decodes the result. try { result = Y.JSON.parse(outcome.responseText); if (!result.success || result.error) { error = true; } } catch (e) { error = true; } // There was an error. if (error) { this.setContent(''); bb.one(SELECTORS.RESULTSCOUNT).setHTML(M.util.get_string('errajaxsearch', COMPONENT)); return; } // Create the div containing the users when it is a fresh search. if (!args.append) { users = Y.Node.create('<div role="listbox" aria-activedescendant="" aria-multiselectable="true" class="' + CSS.USERS + '"></div>'); } else { users = bb.one(SELECTORS.RESULTSUSERS); } // Compile the template for each user node. if (!this._userTemplate) { this._userTemplate = Y.Handlebars.compile( '<div role="option" aria-selected="false" class="{{CSS.USER}} clearfix" ' + 'data-userid="{{userId}}">' + '<div class="{{CSS.CHECKBOX}}">' + '<input name="{{USP.CHECKBOX_NAME_PREFIX}}{{userId}}" type="checkbox" tabindex="-1"' + 'id="{{checkboxId}}" aria-describedby="{{checkboxId}} {{extraFieldsId}}"/>' + '</div>' + '<div class="{{CSS.PICTURE}}">{{{picture}}}</div>' + '<div class="{{CSS.DETAILS}}">' + '<div class="{{CSS.FULLNAME}}">' + '<label for="{{checkboxId}}">{{fullname}}</label>' + '</div>' + '<div id="{{extraFieldsId}}" class="{{CSS.EXTRAFIELDS}}">{{{extrafields}}}</div>' + '</div>' + '</div>' ); } userTemplate = this._userTemplate; // Append the users one by one. count = this.get(USP.USERCOUNT); selected = ''; var user; for (i in result.response.users) { count++; user = result.response.users[i]; // If already selected. if (Y.Object.hasKey(this._usersBufferList, user.userid)) { selected = true; } else { selected = false; } node = Y.Node.create(userTemplate({ checkboxId: Y.guid(), COMPONENT: COMPONENT, count: count, CSS: CSS, extrafields: user.extrafields, extraFieldsId: Y.guid(), fullname: user.fullname, picture: user.picture, userId: user.userid, USP: USP })); this.markUserNode(node, selected); // Noting the first user that was when adding more results. if (args.append && firstAdded) { users.all(SELECTORS.FIRSTADDED).removeClass(CSS.FIRSTADDED); node.addClass(CSS.FIRSTADDED); firstAdded = false; } users.append(node); } this.set(USP.USERCOUNT, count); // Update the count of users, and add a button to load more if need be. totalUsers = parseInt(result.response.totalusers, 10); if (!args.append) { if (totalUsers === 0) { bb.one(SELECTORS.RESULTSCOUNT).setHTML(M.util.get_string('noresults', 'moodle')); content = ''; } else { if (totalUsers === 1) { bb.one(SELECTORS.RESULTSCOUNT).setHTML(M.util.get_string('foundoneuser', COMPONENT)); } else { bb.one(SELECTORS.RESULTSCOUNT).setHTML(M.util.get_string('foundnusers', COMPONENT, totalUsers)); } content = Y.Node.create('<div class="' + CSS.SEARCHRESULTS + '"></div>') .append(users); if (result.response.totalusers > (this.get(USP.PAGE) + 1) * this.get(USP.PERPAGE)) { fetchmore = Y.Node.create('<div class="' + CSS.MORERESULTS + '">' + '<a href="#" role="button">' + M.util.get_string('loadmoreusers', COMPONENT) + '</a></div>'); fetchmore.one('a').on('click', this.search, this, true); fetchmore.one('a').on('key', this.search, 'space', this, true); content.append(fetchmore); } } this.setContent(content); } else { if (totalUsers <= (this.get(USP.PAGE) + 1) * this.get(USP.PERPAGE)) { bb.one(SELECTORS.MORERESULTS).remove(); } } }, /** * When the user has finished selecting users. * * @method finishSelectingUsers * @param {EventFacade} e The event. */ finishSelectingUsers: function(e) { e.preventDefault(); this.applySelection(); this.hide(); }, /** * Apply the selection made. * * @method applySelection * @param {EventFacade} e The event. */ applySelection: function() { var userIds = Y.Object.keys(this._usersBufferList); this.set(USP.SELECTEDUSERS, Y.clone(this._usersBufferList)) .setNameDisplay(); Y.one(SELECTORS.USERIDS).set('value', userIds.join()); }, /** * Select a user. * * @method SelectUser * @param {EventFacade} e The event. */ selectUser: function(e) { var user = e.currentTarget.ancestor(SELECTORS.USER), checkbox = user.one(SELECTORS.USERSELECT), fullname = user.one(SELECTORS.FULLNAME).get('innerHTML'), checked = checkbox.get('checked'), userId = user.getData('userid'); if (e.currentTarget !== checkbox) { // We triggered the selection from another node, so we need to change the checkbox value. checked = !checked; } if (checked) { // Selecting the user. this._usersBufferList[userId] = fullname; } else { // De-selecting the user. delete this._usersBufferList[userId]; delete this._usersBufferList[parseInt(userId, 10)]; // Also remove numbered keys. } this.markUserNode(user, checked); }, /** * Mark a user node as selected or not. * * This only takes care of the DOM side of things, not the internal mechanism * storing what users have been selected or not. * * @param {Node} node The user node. * @param {Boolean} selected True to mark as selected. * @chainable */ markUserNode: function(node, selected) { if (selected) { node.addClass(CSS.SELECTED) .set('aria-selected', true) .one(SELECTORS.USERSELECT) .set('checked', true); } else { node.removeClass(CSS.SELECTED) .set('aria-selected', false) .one(SELECTORS.USERSELECT) .set('checked', false); } return this; }, /** * Set the content of the dialogue. * * @method setContent * @param {String} content The content. * @chainable */ setContent: function(content) { this.get('boundingBox').one(SELECTORS.AJAXCONTENT).setHTML(content); return this; }, /** * Display the names of the selected users in the form. * * @method setNameDisplay */ setNameDisplay: function() { var namelist = Y.Object.values(this.get(USP.SELECTEDUSERS)); Y.one(SELECTORS.SELECTEDNAMES).set('innerHTML', namelist.join(', ')); Y.one(SELECTORS.USERFULLNAMES).set('value', namelist.join()); }, /** * User keyboard navigation. * * @method userKeyboardNavigation */ userKeyboardNavigation: function(e) { var bb = this.get('boundingBox'), users = bb.all(SELECTORS.USER), direction = 1, user, current = e.target.ancestor(SELECTORS.USER, true); if (e.keyCode === 38) { direction = -1; } user = this.findFocusableUser(users, current, direction); if (user) { e.preventDefault(); user.one(SELECTORS.USERSELECT).focus(); this.setUserTabFocus(user); } }, /** * Find the next or previous focusable node. * * @param {NodeList} users The list of users. * @param {Node} user The user to start with. * @param {Number} direction The direction in which to go. * @return {Node|null} A user node, or null if not found. * @method findFocusableUser */ findFocusableUser: function(users, user, direction) { var index = users.indexOf(user); if (users.size() < 1) { Y.log('The users list is empty', 'debug', COMPONENT); return null; } if (index < 0) { Y.log('Unable to find the user in the list of users', 'debug', COMPONENT); return users.item(0); } index += direction; // Wrap the navigation when reaching the top of the bottom. if (index < 0) { index = users.size() - 1; } else if (index >= users.size()) { index = 0; } return users.item(index); }, /** * Set the user tab focus. * * @param {Node} user The user node. * @method setUserTabFocus */ setUserTabFocus: function(user) { if (this._userTabFocus) { this._userTabFocus.setAttribute('tabindex', '-1'); } if (!user) { // We were not passed a user, there is apparently none in the dialogue. Nothing to do here \\\o/. return; } this._userTabFocus = user.one(SELECTORS.USERSELECT); this._userTabFocus.setAttribute('tabindex', '0'); this.get('boundingBox').one(SELECTORS.RESULTSUSERS).setAttribute('aria-activedescendant', this._userTabFocus.generateID()); } }, { NAME: USP.NAME, CSS_PREFIX: USP.CSS_PREFIX, ATTRS: { /** * The header. * * @attribute title * @default selectusers language string. * @type String */ title: { validator: Y.Lang.isString, valueFn: function() { return M.util.get_string('selectusers', COMPONENT); } }, /** * The current page URL. * * @attribute url * @default null * @type String */ url: { validator: Y.Lang.isString, value: null }, /** * The URL to the Ajax file. * * @attribute ajaxurl * @default null * @type String */ ajaxurl: { validator: Y.Lang.isString, value: null }, /** * The names of the selected users. * * The keys are the user IDs, the values are their fullname. * * @attribute selectedUsers * @default null * @type Object */ selectedUsers: { validator: Y.Lang.isObject, value: null, getter: function(v) { if (v === null) { return {}; } return v; } }, /** * The course ID. * * @attribute courseid * @default null * @type Number */ courseid: { value: null }, /** * Array of parameters. * * @attribute params * @default [] * @type Array */ params: { validator: Y.Lang.isArray, value: [] }, /** * The page we are on. * * @attribute page * @default 0 * @type Number */ page: { validator: Y.Lang.isNumber, value: 0 }, /** * The number of users displayed. * * @attribute userCount * @default 0 * @type Number */ userCount: { value: 0, validator: Y.Lang.isNumber }, /** * The number of results per page. * * @attribute perPage * @default 25 * @type Number */ perPage: { value: 25, Validator: Y.Lang.isNumber } } }); Y.Base.modifyAttrs(Y.namespace('M.gradereport_history.UserSelector'), { /** * List of extra classes. * * @attribute extraClasses * @default ['gradereport_history_usp'] * @type Array */ extraClasses: { value: [ 'gradereport_history_usp' ] }, /** * Whether to focus on the target that caused the Widget to be shown. * * @attribute focusOnPreviousTargetAfterHide * @default true * @type Node */ focusOnPreviousTargetAfterHide: { value: true }, /** * * Width. * * @attribute width * @default '500px' * @type String|Number */ width: { value: '500px' }, /** * Boolean indicating whether or not the Widget is visible. * * @attribute visible * @default false * @type Boolean */ visible: { value: false }, /** * Whether the widget should be modal or not. * * @attribute modal * @type Boolean * @default true */ modal: { value: true }, /** * Whether the widget should be draggable or not. * * @attribute draggable * @type Boolean * @default true */ draggable: { value: true } }); Y.namespace('M.gradereport_history.UserSelector').init = function(cfg) { return new USERSELECTOR(cfg); }; report/history/yui/src/userselector/build.json 0000604 00000000331 15062070556 0015665 0 ustar 00 { "name": "moodle-gradereport_history-userselector", "builds": { "moodle-gradereport_history-userselector": { "jsfiles": [ "userselector.js" ] } } } report/history/yui/src/userselector/meta/userselector.json 0000604 00000000443 15062070556 0020237 0 ustar 00 { "moodle-gradereport_history-userselector": { "requires": [ "escape", "event-delegate", "event-key", "handlebars", "io-base", "json-parse", "moodle-core-notification-dialogue" ] } } report/history/tests/report_test.php 0000604 00000107747 15062070556 0014027 0 ustar 00 <?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/>. namespace gradereport_history; defined('MOODLE_INTERNAL') || die(); /** * Grade history report test class. * * @package gradereport_history * @copyright 2014 Frédéric Massart - FMCorz.net * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class report_test extends \advanced_testcase { /** * Create some grades. */ public function test_query_db() { $this->resetAfterTest(); // Making the setup. $c1 = $this->getDataGenerator()->create_course(); $c2 = $this->getDataGenerator()->create_course(); $c1ctx = \context_course::instance($c1->id); $c2ctx = \context_course::instance($c2->id); // Users. $u1 = $this->getDataGenerator()->create_user(); $u2 = $this->getDataGenerator()->create_user(); $u3 = $this->getDataGenerator()->create_user(); $u4 = $this->getDataGenerator()->create_user(); $u5 = $this->getDataGenerator()->create_user(); $grader1 = $this->getDataGenerator()->create_user(); $grader2 = $this->getDataGenerator()->create_user(); self::getDataGenerator()->enrol_user($grader1->id, $c1->id, 'teacher'); self::getDataGenerator()->enrol_user($grader2->id, $c1->id, 'teacher'); self::getDataGenerator()->enrol_user($u2->id, $c1->id, 'student'); self::getDataGenerator()->enrol_user($u3->id, $c1->id, 'student'); self::getDataGenerator()->enrol_user($u4->id, $c1->id, 'student'); self::getDataGenerator()->enrol_user($u5->id, $c1->id, 'student'); self::getDataGenerator()->enrol_user($grader1->id, $c2->id, 'teacher'); self::getDataGenerator()->enrol_user($u5->id, $c2->id, 'student'); // Modules. $c1m1 = $this->getDataGenerator()->create_module('assign', array('course' => $c1)); $c1m2 = $this->getDataGenerator()->create_module('assign', array('course' => $c1)); $c1m3 = $this->getDataGenerator()->create_module('assign', array('course' => $c1)); $c2m1 = $this->getDataGenerator()->create_module('assign', array('course' => $c2)); $c2m2 = $this->getDataGenerator()->create_module('assign', array('course' => $c2)); // Creating fake history data. $giparams = array('itemtype' => 'mod', 'itemmodule' => 'assign'); $grades = array(); $this->setUser($grader1); $gi = \grade_item::fetch($giparams + array('iteminstance' => $c1m1->id)); $grades['c1m1u1'] = $this->create_grade_history(array('itemid' => $gi->id, 'userid' => $u1->id, 'timemodified' => time() - 3600)); $grades['c1m1u2'] = $this->create_grade_history(array('itemid' => $gi->id, 'userid' => $u2->id, 'timemodified' => time() + 3600)); $grades['c1m1u3'] = $this->create_grade_history(array('itemid' => $gi->id, 'userid' => $u3->id)); $grades['c1m1u4'] = $this->create_grade_history(array('itemid' => $gi->id, 'userid' => $u4->id)); $grades['c1m1u5'] = $this->create_grade_history(array('itemid' => $gi->id, 'userid' => $u5->id)); $gi = \grade_item::fetch($giparams + array('iteminstance' => $c1m2->id)); $grades['c1m2u1'] = $this->create_grade_history(array('itemid' => $gi->id, 'userid' => $u1->id)); $grades['c1m2u2'] = $this->create_grade_history(array('itemid' => $gi->id, 'userid' => $u2->id)); $gi = \grade_item::fetch($giparams + array('iteminstance' => $c1m3->id)); $grades['c1m3u1'] = $this->create_grade_history(array('itemid' => $gi->id, 'userid' => $u1->id)); $gi = \grade_item::fetch($giparams + array('iteminstance' => $c2m1->id)); $grades['c2m1u1'] = $this->create_grade_history(array('itemid' => $gi->id, 'userid' => $u1->id, 'usermodified' => $grader1->id)); $grades['c2m1u2'] = $this->create_grade_history(array('itemid' => $gi->id, 'userid' => $u2->id, 'usermodified' => $grader1->id)); $grades['c2m1u3'] = $this->create_grade_history(array('itemid' => $gi->id, 'userid' => $u3->id, 'usermodified' => $grader1->id)); $grades['c2m1u4'] = $this->create_grade_history(array('itemid' => $gi->id, 'userid' => $u4->id, 'usermodified' => $grader2->id)); // Histories where grades have not been revised.. $grades['c2m1u5a'] = $this->create_grade_history(array('itemid' => $gi->id, 'userid' => $u5->id, 'timemodified' => time() - 60)); $grades['c2m1u5b'] = $this->create_grade_history(array('itemid' => $gi->id, 'userid' => $u5->id, 'timemodified' => time())); $grades['c2m1u5c'] = $this->create_grade_history(array('itemid' => $gi->id, 'userid' => $u5->id, 'timemodified' => time() + 60)); // Histories where grades have been revised and not revised. $now = time(); $gi = \grade_item::fetch($giparams + array('iteminstance' => $c2m2->id)); $grades['c2m2u1a'] = $this->create_grade_history(array('itemid' => $gi->id, 'userid' => $u1->id, 'timemodified' => $now - 60, 'finalgrade' => 50)); $grades['c2m2u1b'] = $this->create_grade_history(array('itemid' => $gi->id, 'userid' => $u1->id, 'timemodified' => $now - 50, 'finalgrade' => 50)); // Not revised. $grades['c2m2u1c'] = $this->create_grade_history(array('itemid' => $gi->id, 'userid' => $u1->id, 'timemodified' => $now, 'finalgrade' => 75)); $grades['c2m2u1d'] = $this->create_grade_history(array('itemid' => $gi->id, 'userid' => $u1->id, 'timemodified' => $now + 10, 'finalgrade' => 75)); // Not revised. $grades['c2m2u1e'] = $this->create_grade_history(array('itemid' => $gi->id, 'userid' => $u1->id, 'timemodified' => $now + 60, 'finalgrade' => 25)); $grades['c2m2u1f'] = $this->create_grade_history(array('itemid' => $gi->id, 'userid' => $u1->id, 'timemodified' => $now + 70, 'finalgrade' => 25)); // Not revised. // TODO MDL-46736 Handle deleted/non-existing grade items. // Histories with missing grade items, considered as deleted. // $grades['c2x1u5'] = $this->create_grade_history($giparams + array('itemid' => -1, 'userid' => $u5->id, 'courseid' => $c1->id)); // $grades['c2x2u5'] = $this->create_grade_history($giparams + array('itemid' => 999999, 'userid' => $u5->id, 'courseid' => $c1->id)); // Basic filtering based on course id. $this->assertEquals(8, $this->get_tablelog_results($c1ctx, array(), true)); $this->assertEquals(13, $this->get_tablelog_results($c2ctx, array(), true)); // Filtering on 1 user the current user cannot access should return all records. $this->assertEquals(8, $this->get_tablelog_results($c1ctx, array('userids' => $u1->id), true)); // Filtering on 2 users, only one of whom the current user can access. $this->assertEquals(1, $this->get_tablelog_results($c1ctx, ['userids' => "$u1->id,$u3->id"], true)); $results = $this->get_tablelog_results($c1ctx, ['userids' => "$u1->id,$u3->id"]); $this->assertGradeHistoryIds([$grades['c1m1u3']->id], $results); // Filtering on 2 users, both of whom the current user can access. $this->assertEquals(3, $this->get_tablelog_results($c1ctx, ['userids' => "$u2->id,$u3->id"], true)); $results = $this->get_tablelog_results($c1ctx, ['userids' => "$u2->id,$u3->id"]); $this->assertGradeHistoryIds([$grades['c1m1u2']->id, $grades['c1m1u3']->id, $grades['c1m2u2']->id], $results); // Filtering based on one grade item. $gi = \grade_item::fetch($giparams + array('iteminstance' => $c1m1->id)); $this->assertEquals(5, $this->get_tablelog_results($c1ctx, array('itemid' => $gi->id), true)); $gi = \grade_item::fetch($giparams + array('iteminstance' => $c1m3->id)); $this->assertEquals(1, $this->get_tablelog_results($c1ctx, array('itemid' => $gi->id), true)); // Filtering based on the grader. $this->assertEquals(3, $this->get_tablelog_results($c2ctx, array('grader' => $grader1->id), true)); $this->assertEquals(1, $this->get_tablelog_results($c2ctx, array('grader' => $grader2->id), true)); // Filtering based on date. $results = $this->get_tablelog_results($c1ctx, array('datefrom' => time() + 1800)); $this->assertGradeHistoryIds(array($grades['c1m1u2']->id), $results); $results = $this->get_tablelog_results($c1ctx, array('datetill' => time() - 1800)); $this->assertGradeHistoryIds(array($grades['c1m1u1']->id), $results); $results = $this->get_tablelog_results($c1ctx, array('datefrom' => time() - 1800, 'datetill' => time() + 1800)); $this->assertGradeHistoryIds(array($grades['c1m1u3']->id, $grades['c1m1u4']->id, $grades['c1m1u5']->id, $grades['c1m2u1']->id, $grades['c1m2u2']->id, $grades['c1m3u1']->id), $results); // Filtering based on revised only. $this->assertEquals(3, $this->get_tablelog_results($c2ctx, array('userids' => $u5->id), true)); $this->assertEquals(1, $this->get_tablelog_results($c2ctx, array('userids' => $u5->id, 'revisedonly' => true), true)); // More filtering based on revised only. $gi = \grade_item::fetch($giparams + array('iteminstance' => $c2m2->id)); $this->assertEquals(6, $this->get_tablelog_results($c2ctx, array('userids' => $u1->id, 'itemid' => $gi->id), true)); $results = $this->get_tablelog_results($c2ctx, array('userids' => $u1->id, 'itemid' => $gi->id, 'revisedonly' => true)); $this->assertGradeHistoryIds(array($grades['c2m2u1a']->id, $grades['c2m2u1c']->id, $grades['c2m2u1e']->id), $results); // Checking the value of the previous grade. $this->assertEquals(null, $results[$grades['c2m2u1a']->id]->prevgrade); $this->assertEquals($grades['c2m2u1a']->finalgrade, $results[$grades['c2m2u1c']->id]->prevgrade); $this->assertEquals($grades['c2m2u1c']->finalgrade, $results[$grades['c2m2u1e']->id]->prevgrade); // Put course in separate groups mode, add grader1 and two students to the same group. $c1->groupmode = SEPARATEGROUPS; update_course($c1); $this->assertFalse(has_capability('moodle/site:accessallgroups', \context_course::instance($c1->id))); $g1 = self::getDataGenerator()->create_group(['courseid' => $c1->id, 'name' => 'g1']); self::getDataGenerator()->create_group_member(['groupid' => $g1->id, 'userid' => $grader1->id]); self::getDataGenerator()->create_group_member(['groupid' => $g1->id, 'userid' => $u1->id]); self::getDataGenerator()->create_group_member(['groupid' => $g1->id, 'userid' => $u2->id]); $this->assertEquals(2, $this->get_tablelog_results($c1ctx, array(), true)); // Grader2 is not in any groups. $this->setUser($grader2); $this->assertEquals(0, $this->get_tablelog_results($c1ctx, array(), true)); } /** * Test the get users helper method. */ public function test_get_users() { $this->resetAfterTest(); // Making the setup. $c1 = $this->getDataGenerator()->create_course(); $c2 = $this->getDataGenerator()->create_course(); $c1ctx = \context_course::instance($c1->id); $c2ctx = \context_course::instance($c2->id); $c1m1 = $this->getDataGenerator()->create_module('assign', array('course' => $c1)); $c2m1 = $this->getDataGenerator()->create_module('assign', array('course' => $c2)); // Users. $u1 = $this->getDataGenerator()->create_user(array('firstname' => 'Eric', 'lastname' => 'Cartman')); $u2 = $this->getDataGenerator()->create_user(array('firstname' => 'Stan', 'lastname' => 'Marsh')); $u3 = $this->getDataGenerator()->create_user(array('firstname' => 'Kyle', 'lastname' => 'Broflovski')); $u4 = $this->getDataGenerator()->create_user(array('firstname' => 'Kenny', 'lastname' => 'McCormick')); // Creating grade history for some users. $gi = \grade_item::fetch(array('iteminstance' => $c1m1->id, 'itemtype' => 'mod', 'itemmodule' => 'assign')); $this->create_grade_history(array('itemid' => $gi->id, 'userid' => $u1->id)); $this->create_grade_history(array('itemid' => $gi->id, 'userid' => $u2->id)); $this->create_grade_history(array('itemid' => $gi->id, 'userid' => $u3->id)); $gi = \grade_item::fetch(array('iteminstance' => $c2m1->id, 'itemtype' => 'mod', 'itemmodule' => 'assign')); $this->create_grade_history(array('itemid' => $gi->id, 'userid' => $u4->id)); // Checking fetching some users. $users = \gradereport_history\helper::get_users($c1ctx); $this->assertCount(3, $users); $this->assertArrayHasKey($u3->id, $users); $users = \gradereport_history\helper::get_users($c2ctx); $this->assertCount(1, $users); $this->assertArrayHasKey($u4->id, $users); $users = \gradereport_history\helper::get_users($c1ctx, 'c'); $this->assertCount(1, $users); $this->assertArrayHasKey($u1->id, $users); $users = \gradereport_history\helper::get_users($c1ctx, '', 0, 2); $this->assertCount(2, $users); $this->assertArrayHasKey($u3->id, $users); $this->assertArrayHasKey($u1->id, $users); $users = \gradereport_history\helper::get_users($c1ctx, '', 1, 2); $this->assertCount(1, $users); $this->assertArrayHasKey($u2->id, $users); // Checking the count of users. $this->assertEquals(3, \gradereport_history\helper::get_users_count($c1ctx)); $this->assertEquals(1, \gradereport_history\helper::get_users_count($c2ctx)); $this->assertEquals(1, \gradereport_history\helper::get_users_count($c1ctx, 'c')); } /** * Data provider for \gradereport_history_report_testcase::test_get_users_with_profile_fields() * Testing get_users() and get_users_count() test cases. * * @return array List of data sets (test cases) */ public function get_users_with_profile_fields_provider(): array { return [ // User identity check boxes, 'email', 'profile_field_lang' and 'profile_field_height' are checked. 'show email,lang and height;search for all users' => ['email,profile_field_lang,profile_field_height', '', ['u1', 'u2', 'u3', 'u4']], 'show email,lang and height;search for users on .org ' => ['email,profile_field_lang,profile_field_height', '.org', ['u1', 'u2', 'u4']], 'show email,lang and height;search for users on .com ' => ['email,profile_field_lang,profile_field_height', '.com', []], 'show email,lang and height;search for users on .uk ' => ['email,profile_field_lang,profile_field_height', '.uk', ['u3']], 'show email,lang and height,search for Spanish speakers' => ['email,profile_field_lang,profile_field_height', 'spanish', ['u1', 'u4']], 'show email,lang and height,search for Spanish speakers' => ['email,profile_field_lang,profile_field_height', 'spa', ['u1', 'u4']], 'show email,lang and height,search for German speakers' => ['email,profile_field_lang,profile_field_height', 'german', ['u2']], 'show email,lang and height,search for German speakers' => ['email,profile_field_lang,profile_field_height', 'ger', ['u2']], 'show email,lang and height,search for English speakers' => ['email,profile_field_lang,profile_field_height', 'english', ['u3']], 'show email,lang and height,search for English speakers' => ['email,profile_field_lang,profile_field_height', 'eng', ['u3']], 'show email,lang and height,search for English speakers' => ['email,profile_field_lang,profile_field_height', 'ish', ['u3']], 'show email,lang and height,search for users with height 180cm' => ['email,profile_field_lang,profile_field_height', '180cm', ['u2', 'u3', 'u4']], 'show email,lang and height,search for users with height 180cm' => ['email,profile_field_lang,profile_field_height', '180', ['u2', 'u3', 'u4']], 'show email,lang and height,search for users with height 170cm' => ['email,profile_field_lang,profile_field_height', '170cm', ['u1']], 'show email,lang and height,search for users with height 170cm' => ['email,profile_field_lang,profile_field_height', '170', ['u1']], // User identity check boxes, 'email' and 'profile_field_height' are checked. 'show email and height;search for users on .org' => ['email,profile_field_height', '.org', ['u1', 'u2', 'u4']], 'show email and height;search for users on .com' => ['email,profile_field_height', '.com', []], 'show email and height;search for users on .co' => ['email,profile_field_height', '.co', ['u3']], 'show email and height,search for Spanish/German/English speakers' => ['email,profile_field_height', 'spanish', []], 'show email and height,search for Spanish/German/English speakers' => ['email,profile_field_height', 'german', []], 'show email and height,search for Spanish/German/English speakers' => ['email,profile_field_height', 'english', []], 'show email,lang and height,search for English speakers' => ['email,profile_field_height', 'english', []], 'show email and height,search for English speakers' => ['email,profile_field_height', 'eng', []], 'show email and height,search for English speakers' => ['email,profile_field_height', 'ish', []], 'show email and height,search for users with height 180cm' => ['email,profile_field_height', '180cm', ['u2', 'u3', 'u4']], 'show email,lang and height,search for users with height 180cm' => ['email,profile_field_height', '180', ['u2', 'u3', 'u4']], 'show email,lang and height,search for users with height 170cm' => ['email,profile_field_height', '170cm', ['u1']], 'show email,lang and height,search for users with height 170cm' => ['email,profile_field_height', '170', ['u1']], // User identity check boxes, only 'email' is checked. 'show email only;search for users on .org' => ['email', '.org', ['u1', 'u2', 'u4']], 'show email only;search for users on .com' => ['email', '.com', []], 'show email only;search for users on .co.uk' => ['email', 'co.uk', ['u3']], 'show email only;search for users on .uk' => ['email', '.uk', ['u3']], 'show email only;search for users on .co' => ['email', '.co', ['u3']], 'show email only;search for Spanish speakers' => ['email', 'spanish', []], 'show email only;search for German speakers' => ['email', 'german', []], 'show email only;search for English speakers' => ['email', 'english', []], 'show email only;search for users with height 180cm' => ['email', '180cm', []], 'show email only;search for users with height 180cm' => ['email', '180', []], 'show email only;search for users with height 170cm' => ['email', '170cm', []], 'show email only;search for users with height 170cm' => ['email', '170', []], ]; } /** * Testing the search functionality on get_users() and get_users_count() and their inner methods. * * @dataProvider get_users_with_profile_fields_provider * * @param string $showuseridentity, list of user identities to be shown. * @param string $searchstring, the string to be searched. * @param array $expectedusernames, a list of expected usernames. * @return void */ public function test_get_users_with_profile_fields(string $showuseridentity, string $searchstring, array $expectedusernames): void { global $CFG, $DB; require_once($CFG->dirroot . '/user/profile/lib.php'); $this->resetAfterTest(); // Create a couple of custom profile fields, which are in user identity. $generator = $this->getDataGenerator(); $generator->create_custom_profile_field(['datatype' => 'text', 'shortname' => 'lang', 'name' => 'Language']); $generator->create_custom_profile_field(['datatype' => 'text', 'shortname' => 'height', 'name' => 'Height']); // Create a couple of test users. $u1 = $generator->create_user(['firstname' => 'Eduardo', 'lastname' => 'Gomes', 'username' => 'u1', 'email' => 'u1@x.org', 'profile_field_lang' => 'Spanish', 'profile_field_height' => '170cm']); $u2 = $generator->create_user(['firstname' => 'Dieter', 'lastname' => 'Schmitt', 'username' => 'u2', 'email' => 'u2@x.org', 'profile_field_lang' => 'German', 'profile_field_height' => '180cm']); $u3 = $generator->create_user(['firstname' => 'Peter', 'lastname' => 'Jones', 'username' => 'u3', 'email' => 'u3@x.co.uk', 'profile_field_lang' => 'English', 'profile_field_height' => '180cm']); $u4 = $generator->create_user(['firstname' => 'Pedro', 'lastname' => 'Gomes', 'username' => 'u4', 'email' => 'u3@x.org', 'profile_field_lang' => 'Spanish', 'profile_field_height' => '180cm']); // Do this as admin user. $this->setAdminUser(); // Making the setup. $c1 = $this->getDataGenerator()->create_course(); $c1ctx = \context_course::instance($c1->id); $c1m1 = $this->getDataGenerator()->create_module('assign', array('course' => $c1)); // Creating grade history for some users. $gi = \grade_item::fetch(array('iteminstance' => $c1m1->id, 'itemtype' => 'mod', 'itemmodule' => 'assign')); $this->create_grade_history(array('itemid' => $gi->id, 'userid' => $u1->id)); $this->create_grade_history(array('itemid' => $gi->id, 'userid' => $u2->id)); $this->create_grade_history(array('itemid' => $gi->id, 'userid' => $u3->id)); $this->create_grade_history(array('itemid' => $gi->id, 'userid' => $u4->id)); // Checking fetching some users with this config settings. set_config('showuseridentity', $showuseridentity); $numberofexpectedusers = count($expectedusernames); $users = \gradereport_history\helper::get_users($c1ctx, $searchstring); $userscount = \gradereport_history\helper::get_users_count($c1ctx, $searchstring); $this->assertEquals($numberofexpectedusers, $userscount); $this->assertCount($numberofexpectedusers, $users); foreach ($users as $user) { if (in_array($user->username, $expectedusernames)) { $this->assertArrayHasKey($user->id, $users); } else { $this->assertArrayNotHasKey($user->id, $users); } } } /** * Data provider method for \gradereport_history_report_testcase::test_get_users_with_groups() */ public function get_users_provider() { return [ 'Visible groups, non-editing teacher, not in any group' => [ VISIBLEGROUPS, 'teacher', ['g1', 'g2'], ['s1', 's2', 's3', 's4', 's5'] ], 'Visible groups, non-editing teacher' => [ VISIBLEGROUPS, 'teacher', [], ['s1', 's2', 's3', 's4', 's5'] ], 'Visible groups, editing teacher' => [ VISIBLEGROUPS, 'editingteacher', ['g1', 'g2'], ['s1', 's2', 's3', 's4', 's5'] ], 'Separate groups, non-editing teacher' => [ SEPARATEGROUPS, 'teacher', ['g1', 'g2'], ['s1', 's2'] ], 'Separate groups, non-editing teacher, not in any group' => [ SEPARATEGROUPS, 'teacher', [], [] ], 'Separate groups, non-editing teacher and student share two groups' => [ SEPARATEGROUPS, 'teacher', ['g4', 'g5'], ['s5'] ], 'Separate groups, editing teacher' => [ SEPARATEGROUPS, 'editingteacher', ['g1', 'g2'], ['s1', 's2', 's3', 's4', 's5'] ], ]; } /** * Test for helper::get_users() with course group mode set. * * @dataProvider get_users_provider * @param $groupmode * @param $teacherrole * @param $teachergroups * @param $expectedusers */ public function test_get_users_with_groups($groupmode, $teacherrole, $teachergroups, $expectedusers) { global $DB; $this->resetAfterTest(); $generator = $this->getDataGenerator(); // Create a test course. $course = $generator->create_course(['groupmode' => $groupmode]); // Create an assignment module. $assign = $generator->create_module('assign', ['course' => $course]); // Fetch roles. $role = $DB->get_record('role', ['shortname' => $teacherrole], '*', MUST_EXIST); $studentrole = $DB->get_record('role', ['shortname' => 'student'], '*', MUST_EXIST); // Create users. $t1 = $generator->create_user(['username' => 't1', 'email' => 't1@example.com']); $s1 = $generator->create_user(['username' => 's1', 'email' => 's1@example.com']); $s2 = $generator->create_user(['username' => 's2', 'email' => 's2@example.com']); $s3 = $generator->create_user(['username' => 's3', 'email' => 's3@example.com']); $s4 = $generator->create_user(['username' => 's4', 'email' => 's4@example.com']); $s5 = $generator->create_user(['username' => 's5', 'email' => 's5@example.com']); // Enrol users. $generator->enrol_user($t1->id, $course->id, $role->id); $generator->enrol_user($s1->id, $course->id, $studentrole->id); $generator->enrol_user($s2->id, $course->id, $studentrole->id); $generator->enrol_user($s3->id, $course->id, $studentrole->id); $generator->enrol_user($s4->id, $course->id, $studentrole->id); $generator->enrol_user($s5->id, $course->id, $studentrole->id); // Create groups. $groups = []; $groups['g1'] = $generator->create_group(['courseid' => $course->id, 'name' => 'g1']); $groups['g2'] = $generator->create_group(['courseid' => $course->id, 'name' => 'g2']); $groups['g3'] = $generator->create_group(['courseid' => $course->id, 'name' => 'g3']); $groups['g4'] = $generator->create_group(['courseid' => $course->id, 'name' => 'g4']); $groups['g5'] = $generator->create_group(['courseid' => $course->id, 'name' => 'g5']); // Add teacher to the assigned groups. foreach ($teachergroups as $groupname) { $group = $groups[$groupname]; $generator->create_group_member(['groupid' => $group->id, 'userid' => $t1->id]); } // Add students to groups. $generator->create_group_member(['groupid' => $groups['g1']->id, 'userid' => $s1->id]); $generator->create_group_member(['groupid' => $groups['g2']->id, 'userid' => $s2->id]); $generator->create_group_member(['groupid' => $groups['g3']->id, 'userid' => $s3->id]); $generator->create_group_member(['groupid' => $groups['g4']->id, 'userid' => $s5->id]); $generator->create_group_member(['groupid' => $groups['g5']->id, 'userid' => $s5->id]); // Creating grade history for the students. $gi = \grade_item::fetch(['iteminstance' => $assign->id, 'itemtype' => 'mod', 'itemmodule' => 'assign']); $this->create_grade_history(['itemid' => $gi->id, 'userid' => $s1->id]); $this->create_grade_history(['itemid' => $gi->id, 'userid' => $s2->id]); $this->create_grade_history(['itemid' => $gi->id, 'userid' => $s3->id]); $this->create_grade_history(['itemid' => $gi->id, 'userid' => $s4->id]); $this->create_grade_history(['itemid' => $gi->id, 'userid' => $s5->id]); // Log in as the teacher. $this->setUser($t1); // Fetch the users. $users = \gradereport_history\helper::get_users(\context_course::instance($course->id)); // Confirm that the number of users fetched is the same as the count of expected users. $this->assertCount(count($expectedusers), $users); foreach ($users as $user) { // Confirm that each user returned is in the list of expected users. $this->assertTrue(in_array($user->username, $expectedusers)); } } /** * Test the get graders helper method. */ public function test_graders() { $this->resetAfterTest(); // Making the setup. $c1 = $this->getDataGenerator()->create_course(); $c2 = $this->getDataGenerator()->create_course(); $c3 = $this->getDataGenerator()->create_course(['groupmode' => SEPARATEGROUPS]); $c1m1 = $this->getDataGenerator()->create_module('assign', array('course' => $c1)); $c2m1 = $this->getDataGenerator()->create_module('assign', array('course' => $c2)); $c3m1 = $this->getDataGenerator()->create_module('assign', array('course' => $c3)); // Users. $u1 = $this->getDataGenerator()->create_user(array('firstname' => 'Eric', 'lastname' => 'Cartman')); $u2 = $this->getDataGenerator()->create_user(array('firstname' => 'Stan', 'lastname' => 'Marsh')); $u3 = $this->getDataGenerator()->create_user(array('firstname' => 'Kyle', 'lastname' => 'Broflovski')); $u4 = $this->getDataGenerator()->create_user(array('firstname' => 'Kenny', 'lastname' => 'McCormick')); foreach ([$c1, $c2, $c3] as $course) { foreach ([$u1, $u2, $u3, $u4] as $user) { self::getDataGenerator()->enrol_user($user->id, $course->id, 'student'); } } // Creating grade history for some users. $gi = \grade_item::fetch(array('iteminstance' => $c1m1->id, 'itemtype' => 'mod', 'itemmodule' => 'assign')); $this->create_grade_history(array('itemid' => $gi->id, 'userid' => $u1->id, 'usermodified' => $u1->id)); $this->create_grade_history(array('itemid' => $gi->id, 'userid' => $u1->id, 'usermodified' => $u2->id)); $this->create_grade_history(array('itemid' => $gi->id, 'userid' => $u1->id, 'usermodified' => $u3->id)); $gi = \grade_item::fetch(array('iteminstance' => $c2m1->id, 'itemtype' => 'mod', 'itemmodule' => 'assign')); $this->create_grade_history(array('itemid' => $gi->id, 'userid' => $u1->id, 'usermodified' => $u4->id)); $gi = \grade_item::fetch(array('iteminstance' => $c3m1->id, 'itemtype' => 'mod', 'itemmodule' => 'assign')); $this->create_grade_history(array('itemid' => $gi->id, 'userid' => $u1->id, 'usermodified' => $u1->id)); $this->create_grade_history(array('itemid' => $gi->id, 'userid' => $u2->id, 'usermodified' => $u2->id)); // Checking fetching some users. $graders = \gradereport_history\helper::get_graders($c1->id); $this->assertCount(4, $graders); // Including "all graders" . $this->assertArrayHasKey($u1->id, $graders); $this->assertArrayHasKey($u2->id, $graders); $this->assertArrayHasKey($u3->id, $graders); $graders = \gradereport_history\helper::get_graders($c2->id); $this->assertCount(2, $graders); // Including "all graders" . $this->assertArrayHasKey($u4->id, $graders); // Third course is in separate groups mode. Only graders from the same group will be returned. $g = self::getDataGenerator()->create_group(['courseid' => $course->id, 'name' => 'g1']); self::getDataGenerator()->create_group_member(['groupid' => $g->id, 'userid' => $u1->id]); self::getDataGenerator()->create_group_member(['groupid' => $g->id, 'userid' => $u2->id]); $this->setUser($u1); $graders = \gradereport_history\helper::get_graders($c3->id); $this->assertCount(3, $graders); // Including "all graders" . $this->setUser($u3); $graders = \gradereport_history\helper::get_graders($c3->id); $this->assertCount(1, $graders); // Including "all graders" . } /** * Asserts that the array of grade objects contains exactly the right IDs. * * @param array $expectedids Array of expected IDs. * @param array $objects Array of objects returned by the table. */ protected function assertGradeHistoryIds(array $expectedids, array $objects) { $this->assertCount(count($expectedids), $objects); $expectedids = array_flip($expectedids); foreach ($objects as $object) { $this->assertArrayHasKey($object->id, $expectedids); unset($expectedids[$object->id]); } $this->assertCount(0, $expectedids); } /** * Create a new grade history entry. * * @param array $params Of values. * @return object The grade object. */ protected function create_grade_history($params) { global $DB; $params = (array) $params; if (!isset($params['itemid'])) { throw new \coding_exception('Missing itemid key.'); } if (!isset($params['userid'])) { throw new \coding_exception('Missing userid key.'); } // Default object. $grade = new \stdClass(); $grade->itemid = 0; $grade->userid = 0; $grade->oldid = 123; $grade->rawgrade = 50; $grade->finalgrade = 50; $grade->timecreated = time(); $grade->timemodified = time(); $grade->information = ''; $grade->informationformat = FORMAT_PLAIN; $grade->feedback = ''; $grade->feedbackformat = FORMAT_PLAIN; $grade->usermodified = 2; // Merge with data passed. $grade = (object) array_merge((array) $grade, $params); // Insert record. $grade->id = $DB->insert_record('grade_grades_history', $grade); return $grade; } /** * Returns a table log object. * * @param context_course $coursecontext The course context. * @param array $filters An array of filters. * @param boolean $count When true, returns a count rather than an array of objects. * @return mixed Count or array of objects. */ protected function get_tablelog_results($coursecontext, $filters = array(), $count = false) { $table = new gradereport_history_tests_tablelog('something', $coursecontext, new \moodle_url(''), $filters); return $table->get_test_results($count); } } /** * Extended table log class. */ class gradereport_history_tests_tablelog extends \gradereport_history\output\tablelog { /** * Get the test results. * * @param boolean $count Whether or not we want the count. * @return mixed Count or array of objects. */ public function get_test_results($count = false) { global $DB; if ($count) { list($sql, $params) = $this->get_sql_and_params(true); return $DB->count_records_sql($sql, $params); } else { $this->setup(); list($sql, $params) = $this->get_sql_and_params(); return $DB->get_records_sql($sql, $params); } } } report/history/tests/behat/basic_functionality.feature 0000604 00000020543 15062070556 0017421 0 ustar 00 @gradereport @gradereport_history @_bug_phantomjs Feature: A teacher checks the grade history report in a course In order to check the history of the grades As a teacher I need to check that the history report is correctly displaying changes @javascript Scenario: Check the history report displays results correctly Given the following "courses" exist: | fullname | shortname | category | groupmode | | Course 1 | C1 | 0 | 1 | And the following "custom profile fields" exist: | datatype | shortname | name | | text | food | Favourite food | And the following "users" exist: | username | firstname | lastname | email | profile_field_food | | teacher1 | Teacher | 1 | teacher1@example.com | | | teacher2 | Teacher | 2 | teacher2@example.com | | | student1 | Student | 1 | student1@example.com | apple | | student2 | Student | 2 | student2@example.com | orange | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | teacher2 | C1 | editingteacher | | student1 | C1 | student | | student2 | C1 | student | And the following "activities" exist: | activity | course | name | | assign | C1 | The greatest assignment ever | | assign | C1 | Rewarding assignment | Given the following config values are set as admin: | showuseridentity | email,profile_field_food | And I am on the "Course 1" "grades > Grader report > View" page logged in as "teacher1" And I should see "apple" in the "student1" "table_row" And I should see "orange" in the "student2" "table_row" And I turn editing mode on And I give the grade "50.00" to the user "Student 1" for the grade item "The greatest assignment ever" And I give the grade "60.00" to the user "Student 1" for the grade item "Rewarding assignment" And I give the grade "50.00" to the user "Student 2" for the grade item "The greatest assignment ever" And I give the grade "60.00" to the user "Student 2" for the grade item "Rewarding assignment" And I press "Save changes" And I am on the "Course 1" "grades > Grader report > View" page logged in as "teacher2" And I should see "apple" in the "student1" "table_row" And I should see "orange" in the "student2" "table_row" And I turn editing mode on And I give the grade "70.00" to the user "Student 1" for the grade item "The greatest assignment ever" And I give the grade "80.00" to the user "Student 1" for the grade item "Rewarding assignment" And I give the grade "70.00" to the user "Student 2" for the grade item "The greatest assignment ever" And I give the grade "80.00" to the user "Student 2" for the grade item "Rewarding assignment" And I press "Save changes" And I navigate to "View > Grade history" in the course gradebook When I press "Submit" Then the following should exist in the "gradereport_history" table: | First name/Last name | Email address | Favourite food | Grade item | Original grade | Revised grade | Grader | | Student 1 | student1@example.com | apple | The greatest assignment ever | | 50.00 | Teacher 1 | | Student 1 | student1@example.com | apple | Rewarding assignment | | 60.00 | Teacher 1 | | Student 2 | student2@example.com | orange | The greatest assignment ever | | 50.00 | Teacher 1 | | Student 2 | student2@example.com | orange | Rewarding assignment | | 60.00 | Teacher 1 | | Student 1 | student1@example.com | apple | The greatest assignment ever | 50.00 | 70.00 | Teacher 2 | | Student 1 | student1@example.com | apple | Rewarding assignment | 60.00 | 80.00 | Teacher 2 | | Student 2 | student2@example.com | orange | The greatest assignment ever | 50.00 | 70.00 | Teacher 2 | | Student 2 | student2@example.com | orange | Rewarding assignment | 60.00 | 80.00 | Teacher 2 | # Test filtering by student - display of several users. And I press "Select users" And I click on "Student 1" "checkbox" And I click on "Student 2" "checkbox" And I press "Finish selecting users" And I should see "Student 1, Student 2" And I press "Submit" And I should see "Student 1, Student 2" # Test filtering by student. And I press "Select users" And I set the field with xpath "//form/input[@class='usp-search-field']" to "Student 2" And I click on "Search" "button" in the "Select users" "dialogue" And I should see "Student 2" in the "Select users" "dialogue" And I should not see "Student 1" in the "Select users" "dialogue" # Deselect. And I click on "Student 2" "checkbox" And I press "Finish selecting users" And I press "Submit" And the following should exist in the "gradereport_history" table: | First name/Last name | Grade item | Original grade | Revised grade | Grader | | Student 1 | The greatest assignment ever | | 50.00 | Teacher 1 | | Student 1 | Rewarding assignment | | 60.00 | Teacher 1 | | Student 1 | The greatest assignment ever | 50.00 | 70.00 | Teacher 2 | | Student 1 | Rewarding assignment | 60.00 | 80.00 | Teacher 2 | # Test for seeing custom fields contents in the rows. And I should see "apple" in the "student1" "table_row" And I should not see "orange" And the following should not exist in the "gradereport_history" table: | Student 2 | The greatest assignment ever | | 50.00 | Teacher 1 | | Student 2 | Rewarding assignment | | 60.00 | Teacher 1 | | Student 2 | The greatest assignment ever | 50.00 | 70.00 | Teacher 2 | | Student 2 | Rewarding assignment | 60.00 | 80.00 | Teacher 2 | # Test filtering by assignment. And I set the field "Grade item" to "The greatest assignment ever" And I press "Submit" And the following should exist in the "gradereport_history" table: | First name/Last name | Grade item | Original grade | Revised grade | Grader | | Student 1 | The greatest assignment ever | | 50.00 | Teacher 1 | | Student 1 | The greatest assignment ever | 50.00 | 70.00 | Teacher 2 | And the following should not exist in the "gradereport_history" table: | Student 1 | Rewarding assignment | | 60.00 | Teacher 1 | | Student 1 | Rewarding assignment | 60.00 | 80.00 | Teacher 2 | # Test filtering by grader. And I set the field "Grader" to "Teacher 1" And I press "Submit" And the following should exist in the "gradereport_history" table: | First name/Last name | Email address | Favourite food | Grade item | Original grade | Revised grade | Grader | | Student 1 | student1@example.com | apple | The greatest assignment ever | | 50.00 | Teacher 1 | And the following should not exist in the "gradereport_history" table: | Student 1 | The greatest assignment ever | 50.00 | 70.00 | Teacher 2 | # Test filtering by revised grades. And I click on "id_revisedonly" "checkbox" And I press "Submit" And the following should exist in the "gradereport_history" table: | First name/Last name | Email address | Favourite food | Grade item | Original grade | Revised grade | Grader | | Student 1 | student1@example.com | apple | The greatest assignment ever | | 50.00 | Teacher 1 | report/history/version.php 0000604 00000002135 15062070556 0011761 0 ustar 00 <?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/>. /** * Version details for the grade history * * @package gradereport_history * @copyright 2013 NetSpot Pty Ltd (https://www.netspot.com.au) * @author Adam Olley <adam.olley@netspot.com.au> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); $plugin->version = 2023100900; $plugin->requires = 2023100400; $plugin->component = 'gradereport_history'; report/history/index.php 0000604 00000011722 15062070556 0011405 0 ustar 00 <?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/>. /** * The gradebook grade history report * * @package gradereport_history * @copyright 2013 NetSpot Pty Ltd (https://www.netspot.com.au) * @author Adam Olley <adam.olley@netspot.com.au> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once(__DIR__ . '/../../../config.php'); require_once($CFG->libdir.'/gradelib.php'); require_once($CFG->dirroot.'/grade/lib.php'); $download = optional_param('download', '', PARAM_ALPHA); $courseid = required_param('id', PARAM_INT); // Course id. $page = optional_param('page', 0, PARAM_INT); // Active page. $showreport = optional_param('showreport', 0, PARAM_INT); $PAGE->set_pagelayout('report'); $url = new moodle_url('/grade/report/history/index.php', array('id' => $courseid, 'showreport' => 1)); $PAGE->set_url($url); $course = $DB->get_record('course', array('id' => $courseid), '*', MUST_EXIST); require_login($course); $context = context_course::instance($course->id); require_capability('gradereport/history:view', $context); require_capability('moodle/grade:viewall', $context); // Last selected report session tracking. if (!isset($USER->grade_last_report)) { $USER->grade_last_report = array(); } $USER->grade_last_report[$course->id] = 'history'; $select = "itemtype <> 'course' AND courseid = :courseid AND " . $DB->sql_isnotempty('grade_items', 'itemname', true, true); $itemids = $DB->get_records_select_menu('grade_items', $select, array('courseid' => $course->id), 'itemname ASC', 'id, itemname'); foreach ($itemids as $itemid => $itemname) { $itemids[$itemid] = format_string($itemname, false, array("context" => $context)); } $itemids = array(0 => get_string('allgradeitems', 'gradereport_history')) + $itemids; $output = $PAGE->get_renderer('gradereport_history'); $graders = \gradereport_history\helper::get_graders($course->id); $params = ['course' => $course, 'itemids' => $itemids, 'graders' => $graders, 'userbutton' => null, 'userfullnames' => '']; $mform = new \gradereport_history\filter_form(null, $params); $filters = array(); if ($data = $mform->get_data()) { $filters = (array)$data; if (!empty($filters['datetill'])) { $filters['datetill'] += DAYSECS - 1; // Set to end of the chosen day. } } else { $filters = array( 'id' => $courseid, 'userids' => optional_param('userids', '', PARAM_SEQUENCE), 'itemid' => optional_param('itemid', 0, PARAM_INT), 'grader' => optional_param('grader', 0, PARAM_INT), 'datefrom' => optional_param('datefrom', 0, PARAM_INT), 'datetill' => optional_param('datetill', 0, PARAM_INT), 'revisedonly' => optional_param('revisedonly', 0, PARAM_INT), ); } $table = new \gradereport_history\output\tablelog('gradereport_history', $context, $url, $filters, $download, $page); $names = array(); foreach ($table->get_selected_users() as $key => $user) { $names[$key] = fullname($user); } $userfullnames = implode(', ', $names); // Set up js. \gradereport_history\helper::init_js($course->id, $names); // Now that we have the names, reinitialise the button so its able to control them. $button = new \gradereport_history\output\user_button($PAGE->url, get_string('selectusers', 'gradereport_history'), 'get'); $userbutton = $output->render($button); $params = ['course' => $course, 'itemids' => $itemids, 'graders' => $graders, 'userbutton' => $userbutton, 'userfullnames' => $userfullnames]; $mform = new \gradereport_history\filter_form(null, $params); $mform->set_data($filters); if ($table->is_downloading()) { // Download file and exit. \core\session\manager::write_close(); echo $output->render($table); die(); } // Print header. $actionbar = new \core_grades\output\general_action_bar($context, new moodle_url('/grade/report/history/index.php', ['id' => $courseid]), 'report', 'history'); print_grade_page_head($COURSE->id, 'report', 'history', false, false, false, true, null, null, null, $actionbar); $mform->display(); if ($showreport) { // Only display report after form has been submitted. echo $output->render($table); $event = \gradereport_history\event\grade_report_viewed::create( array( 'context' => $context, 'courseid' => $courseid ) ); $event->trigger(); } echo $OUTPUT->footer(); report/history/settings.php 0000604 00000002434 15062070556 0012136 0 ustar 00 <?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/>. /** * Defines site config settings for the grade history report * * @package gradereport_history * @copyright 2014 NetSpot Pty Ltd * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die; if ($ADMIN->fulltree) { // Add settings for this module to the $settings object (it's already defined). $settings->add(new admin_setting_configtext('grade_report_historyperpage', new lang_string('historyperpage', 'gradereport_history'), new lang_string('historyperpage_help', 'gradereport_history'), 50, PARAM_INT )); } report/history/db/access.php 0000604 00000002620 15062070556 0012121 0 ustar 00 <?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/>. /** * Capability definition for the gradebook grader report * * @package gradereport_history * @copyright 2013 NetSpot Pty Ltd (https://www.netspot.com.au) * @author Adam Olley <adam.olley@netspot.com.au> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); $capabilities = array( 'gradereport/history:view' => array( 'riskbitmask' => RISK_PERSONAL, 'captype' => 'read', 'contextlevel' => CONTEXT_COURSE, 'archetypes' => array( 'teacher' => CAP_ALLOW, 'editingteacher' => CAP_ALLOW, 'manager' => CAP_ALLOW ), 'clonepermissionsfrom' => 'gradereport/grader:view' ) ); report/history/db/upgrade.php 0000604 00000004050 15062070556 0012306 0 ustar 00 <?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/>. /** * Grade overview report upgrade steps. * * @package gradereport_history * @copyright 2020 Michael Hawkins <michaelh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); /** * Function to upgrade grade history report. * * @param int $oldversion the version we are upgrading from * @return bool result */ function xmldb_gradereport_history_upgrade($oldversion) { if ($oldversion < 2019111801) { $perpageconfig = get_config('moodle', 'grade_report_historyperpage'); // For existing installations with a non-integer 'per page' config, update the value to the default. if (!empty($perpageconfig) && filter_var($perpageconfig, FILTER_VALIDATE_INT) === false) { set_config('grade_report_historyperpage', 50); } upgrade_plugin_savepoint(true, 2019111801, 'gradereport', 'history'); } // Automatically generated Moodle v3.9.0 release upgrade line. // Put any upgrade step following this. // Automatically generated Moodle v4.0.0 release upgrade line. // Put any upgrade step following this. // Automatically generated Moodle v4.1.0 release upgrade line. // Put any upgrade step following this. // Automatically generated Moodle v4.2.0 release upgrade line. // Put any upgrade step following this. return true; } report/overview/index.php 0000604 00000020304 15062070556 0011546 0 ustar 00 <?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/>. /** * The gradebook overview report * * @package gradereport_overview * @copyright 2007 Nicolas Connault * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once '../../../config.php'; require_once $CFG->libdir.'/gradelib.php'; require_once $CFG->dirroot.'/grade/lib.php'; require_once $CFG->dirroot.'/grade/report/overview/lib.php'; $courseid = optional_param('id', SITEID, PARAM_INT); $userid = optional_param('userid', $USER->id, PARAM_INT); $PAGE->set_url(new moodle_url('/grade/report/overview/index.php', array('id' => $courseid, 'userid' => $userid))); if (!$course = $DB->get_record('course', array('id' => $courseid))) { throw new \moodle_exception('invalidcourseid'); } require_login(null, false); $PAGE->set_course($course); $context = context_course::instance($course->id); $systemcontext = context_system::instance(); $personalcontext = null; // If we are accessing the page from a site context then ignore this check. if ($courseid != SITEID) { require_capability('gradereport/overview:view', $context); } if (empty($userid)) { require_capability('moodle/grade:viewall', $context); } else { if (!$DB->get_record('user', array('id'=>$userid, 'deleted'=>0)) or isguestuser($userid)) { throw new \moodle_exception('invaliduserid'); } $personalcontext = context_user::instance($userid); } if (isset($personalcontext) && $courseid == SITEID) { $PAGE->set_context($personalcontext); } else { $PAGE->set_context($context); } if ($userid == $USER->id) { $settings = $PAGE->settingsnav->find('mygrades', null); $settings->make_active(); } else if ($courseid != SITEID && $userid) { // Show some other navbar thing. $user = $DB->get_record('user', array('id' => $userid), '*', MUST_EXIST); $PAGE->navigation->extend_for_user($user); } $access = grade_report_overview::check_access($systemcontext, $context, $personalcontext, $course, $userid); if (!$access) { // no access to grades! throw new \moodle_exception('nopermissiontoviewgrades', 'error', $CFG->wwwroot.'/course/view.php?id='.$courseid); } /// return tracking object $gpr = new grade_plugin_return(array('type'=>'report', 'plugin'=>'overview', 'courseid'=>$course->id, 'userid'=>$userid)); /// last selected report session tracking if (!isset($USER->grade_last_report)) { $USER->grade_last_report = array(); } $USER->grade_last_report[$course->id] = 'overview'; $actionbar = new \core_grades\output\general_action_bar($context, new moodle_url('/grade/report/overview/index.php', ['id' => $courseid]), 'report', 'overview'); if (has_capability('moodle/grade:viewall', $context) && $courseid != SITEID) { // Please note this would be extremely slow if we wanted to implement this properly for all teachers. $groupmode = groups_get_course_groupmode($course); // Groups are being used $currentgroup = $gpr->groupid; if (!$currentgroup) { // To make some other functions work better later $currentgroup = NULL; } $isseparategroups = ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)); if ($isseparategroups and (!$currentgroup)) { // no separate group access, can view only self $userid = $USER->id; $user_selector = false; } else { $user_selector = true; } if (empty($userid)) { print_grade_page_head($courseid, 'report', 'overview', false, false, false, true, null, null, null, $actionbar); groups_print_course_menu($course, $gpr->get_return_url('index.php?id='.$courseid, array('userid'=>0))); if ($user_selector) { $renderer = $PAGE->get_renderer('gradereport_overview'); echo $renderer->graded_users_selector('overview', $course, $userid, $currentgroup, false); } // do not list all users } else { // Only show one user's report $report = new grade_report_overview($userid, $gpr, $context); // Make sure we have proper final grades - this report shows grades from other courses, not just the // selected one, so we need to check and regrade all courses the user is enrolled in. $report->regrade_all_courses_if_needed(true); print_grade_page_head($courseid, 'report', 'overview', get_string('pluginname', 'gradereport_overview') . ' - ' . fullname($report->user), false, false, true, null, null, $report->user, $actionbar); groups_print_course_menu($course, $gpr->get_return_url('index.php?id='.$courseid, array('userid'=>0))); if ($user_selector) { $renderer = $PAGE->get_renderer('gradereport_overview'); echo $renderer->graded_users_selector('overview', $course, $userid, $currentgroup, false); } if ($currentgroup and !groups_is_member($currentgroup, $userid)) { echo $OUTPUT->notification(get_string('groupusernotmember', 'error')); } else { if ($report->fill_table()) { echo '<br />'.$report->print_table(true); } } } } else { // Non-admins and users viewing from the site context can just see their own report. // Create a report instance $report = new grade_report_overview($userid, $gpr, $context); if (!empty($report->studentcourseids)) { // If the course id matches the site id then we don't have a course context to work with. // Display a standard page. if ($courseid == SITEID) { $PAGE->set_pagelayout('standard'); $header = get_string('grades', 'grades') . ' - ' . fullname($report->user); $PAGE->set_title($header); $PAGE->set_heading(fullname($report->user)); if ($USER->id != $report->user->id) { $PAGE->navigation->extend_for_user($report->user); if ($node = $PAGE->settingsnav->get('userviewingsettings'.$report->user->id)) { $node->forceopen = true; } } else if ($node = $PAGE->settingsnav->get('usercurrentsettings', navigation_node::TYPE_CONTAINER)) { $node->forceopen = true; } echo $OUTPUT->header(); if ($report->fill_table(true, true)) { echo html_writer::tag('h3', get_string('coursesiamtaking', 'grades')); echo '<br />' . $report->print_table(true); } } else { // We have a course context. We must be navigating from the gradebook. print_grade_page_head($courseid, 'report', 'overview', get_string('pluginname', 'gradereport_overview') . ' - ' . fullname($report->user), false, false, true, null, null, $report->user, $actionbar); if ($report->fill_table()) { echo '<br />' . $report->print_table(true); } } } else { $PAGE->set_pagelayout('standard'); $header = get_string('grades', 'grades') . ' - ' . fullname($report->user); $PAGE->set_title($header); $PAGE->set_heading(fullname($report->user)); echo $OUTPUT->header(); } if (count($report->teachercourses)) { echo html_writer::tag('h3', get_string('coursesiamteaching', 'grades')); $report->print_teacher_table(); } if (empty($report->studentcourseids) && empty($report->teachercourses)) { // We have no report to show the user. Let them know something. echo $OUTPUT->notification(get_string('noreports', 'grades'), 'notifymessage'); } } grade_report_overview::viewed($context, $courseid, $userid); echo $OUTPUT->footer(); report/overview/classes/external.php 0000604 00000017477 15062070556 0013737 0 ustar 00 <?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/>. /** * External grade report overview API * * @package gradereport_overview * @copyright 2016 Juan Leyva <juan@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ use core_external\external_api; use core_external\external_function_parameters; use core_external\external_multiple_structure; use core_external\external_single_structure; use core_external\external_value; use core_external\external_warnings; defined('MOODLE_INTERNAL') || die; require_once($CFG->libdir . '/gradelib.php'); require_once($CFG->dirroot . '/grade/lib.php'); require_once($CFG->dirroot . '/grade/report/overview/lib.php'); /** * External grade overview report API implementation * * @package gradereport_overview * @copyright 2016 Juan Leyva <juan@moodle.com> * @category external * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class gradereport_overview_external extends external_api { /** * Describes the parameters for get_course_grades. * * @return external_function_parameters * @since Moodle 3.2 */ public static function get_course_grades_parameters() { return new external_function_parameters ( array( 'userid' => new external_value(PARAM_INT, 'Get grades for this user (optional, default current)', VALUE_DEFAULT, 0) ) ); } /** * Get the given user courses final grades * * @param int $userid get grades for this user (optional, default current) * * @return array the grades tables * @since Moodle 3.2 */ public static function get_course_grades($userid = 0) { global $USER; $warnings = array(); // Validate the parameter. $params = self::validate_parameters(self::get_course_grades_parameters(), array( 'userid' => $userid ) ); $userid = $params['userid']; if (empty($userid)) { $userid = $USER->id; } $systemcontext = context_system::instance(); self::validate_context($systemcontext); if ($USER->id != $userid) { // We must check if the current user can view other users grades. $user = core_user::get_user($userid, '*', MUST_EXIST); core_user::require_active_user($user); require_capability('moodle/grade:viewall', $systemcontext); } // We need the site course, and course context. $course = get_course(SITEID); $context = context_course::instance($course->id); // Get the course final grades now. $gpr = new grade_plugin_return(array('type' => 'report', 'plugin' => 'overview', 'courseid' => $course->id, 'userid' => $userid)); $report = new grade_report_overview($userid, $gpr, $context); // Force a regrade if required. As this is the overview report, we need to do all courses // the user is enrolled in, not just $course. $report->regrade_all_courses_if_needed(); $coursesgrades = $report->setup_courses_data(true); $grades = array(); foreach ($coursesgrades as $coursegrade) { $gradeinfo = array( 'courseid' => $coursegrade['course']->id, 'grade' => grade_format_gradevalue($coursegrade['finalgrade'], $coursegrade['courseitem'], true), 'rawgrade' => $coursegrade['finalgrade'], ); if (isset($coursegrade['rank'])) { $gradeinfo['rank'] = $coursegrade['rank']; } $grades[] = $gradeinfo; } $result = array(); $result['grades'] = $grades; $result['warnings'] = $warnings; return $result; } /** * Describes the get_course_grades return value. * * @return external_single_structure * @since Moodle 3.2 */ public static function get_course_grades_returns() { return new external_single_structure( array( 'grades' => new external_multiple_structure( new external_single_structure( array( 'courseid' => new external_value(PARAM_INT, 'Course id'), 'grade' => new external_value(PARAM_RAW, 'Grade formatted'), 'rawgrade' => new external_value(PARAM_RAW, 'Raw grade, not formatted'), 'rank' => new external_value(PARAM_INT, 'Your rank in the course', VALUE_OPTIONAL), ) ) ), 'warnings' => new external_warnings() ) ); } /** * Returns description of method parameters * * @return external_function_parameters * @since Moodle 3.2 */ public static function view_grade_report_parameters() { return new external_function_parameters( array( 'courseid' => new external_value(PARAM_INT, 'id of the course'), 'userid' => new external_value(PARAM_INT, 'id of the user, 0 means current user', VALUE_DEFAULT, 0) ) ); } /** * Trigger the user report events, do the same that the web interface view of the report * * @param int $courseid id of course * @param int $userid id of the user the report belongs to * @return array of warnings and status result * @since Moodle 3.2 * @throws moodle_exception */ public static function view_grade_report($courseid, $userid = 0) { global $USER; $params = self::validate_parameters(self::view_grade_report_parameters(), array( 'courseid' => $courseid, 'userid' => $userid ) ); $warnings = array(); $course = get_course($params['courseid']); $context = context_course::instance($course->id); self::validate_context($context); $userid = $params['userid']; if (empty($userid)) { $userid = $USER->id; } else { $user = core_user::get_user($userid, '*', MUST_EXIST); core_user::require_active_user($user); } $systemcontext = context_system::instance(); $personalcontext = context_user::instance($userid); $access = grade_report_overview::check_access($systemcontext, $context, $personalcontext, $course, $userid); if (!$access) { throw new moodle_exception('nopermissiontoviewgrades', 'error'); } grade_report_overview::viewed($context, $course->id, $userid); $result = array(); $result['status'] = true; $result['warnings'] = $warnings; return $result; } /** * Returns description of method result value * * @return \core_external\external_description * @since Moodle 3.2 */ public static function view_grade_report_returns() { return new external_single_structure( array( 'status' => new external_value(PARAM_BOOL, 'status: true if success'), 'warnings' => new external_warnings() ) ); } } report/overview/classes/event/grade_report_viewed.php 0000604 00000003747 15062070556 0017251 0 ustar 00 <?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/>. /** * Overview report viewed event. * * @package gradereport_overview * @copyright 2014 Adrian Greeve <adrian@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_overview\event; defined('MOODLE_INTERNAL') || die(); /** * Overview report viewed event class. * * @package gradereport_overview * @since Moodle 2.8 * @copyright 2014 Adrian Greeve <adrian@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class grade_report_viewed extends \core\event\grade_report_viewed { /** * Initialise the event data. * @return void */ protected function init() { parent::init(); $this->data['edulevel'] = self::LEVEL_PARTICIPATING; } /** * Returns localised general event name. * * @return string */ public static function get_name() { return get_string('eventgradereportviewed', 'gradereport_overview'); } /** * Custom validation. * * Throw \coding_exception notice in case of any problems. */ protected function validate_data() { parent::validate_data(); if (!isset($this->relateduserid)) { throw new \coding_exception('The \'relateduserid\' value must be set.'); } } } report/overview/classes/privacy/provider.php 0000604 00000003013 15062070556 0015401 0 ustar 00 <?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/>. /** * Privacy Subsystem implementation for gradereport_overview. * * @package gradereport_overview * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_overview\privacy; defined('MOODLE_INTERNAL') || die(); /** * Privacy Subsystem for gradereport_overview implementing null_provider. * * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class provider implements \core_privacy\local\metadata\null_provider { /** * Get the language string identifier with the component's language * file to explain why this plugin stores no data. * * @return string */ public static function get_reason() : string { return 'privacy:metadata'; } } report/overview/lib.php 0000604 00000046640 15062070556 0011220 0 ustar 00 <?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/>. /** * Definition of the grade_overview_report class * * @package gradereport_overview * @copyright 2007 Nicolas Connault * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once($CFG->dirroot . '/grade/report/lib.php'); require_once($CFG->libdir.'/tablelib.php'); /** * Class providing an API for the overview report building and displaying. * @uses grade_report * @package gradereport_overview */ class grade_report_overview extends grade_report { /** * The user's courses * @var array $courses */ public $courses; /** * A flexitable to hold the data. * @var object $table */ public $table; /** * Show student ranks within each course. * @var array $showrank */ public $showrank; /** * An array of course ids that the user is a student in. * @var array $studentcourseids */ public $studentcourseids; /** * An array of courses that the user is a teacher in. * @var array $teachercourses */ public $teachercourses; /** * Constructor. Sets local copies of user preferences and initialises grade_tree. * @param int $userid * @param object $gpr grade plugin return tracking object * @param string $context */ public function __construct($userid, $gpr, $context) { global $CFG, $COURSE, $DB; parent::__construct($COURSE->id, $gpr, $context); // Get the user (for full name). $this->user = $DB->get_record('user', array('id' => $userid)); // Load the user's courses. $this->courses = enrol_get_users_courses($this->user->id, false, 'id, shortname, showgrades'); $this->showrank = array(); $this->showrank['any'] = false; $this->showtotalsifcontainhidden = array(); $this->studentcourseids = array(); $this->teachercourses = array(); $roleids = explode(',', get_config('moodle', 'gradebookroles')); if ($this->courses) { foreach ($this->courses as $course) { $this->showrank[$course->id] = grade_get_setting($course->id, 'report_overview_showrank', !empty($CFG->grade_report_overview_showrank)); if ($this->showrank[$course->id]) { $this->showrank['any'] = true; } $this->showtotalsifcontainhidden[$course->id] = grade_get_setting($course->id, 'report_overview_showtotalsifcontainhidden', $CFG->grade_report_overview_showtotalsifcontainhidden); $coursecontext = context_course::instance($course->id); foreach ($roleids as $roleid) { if (user_has_role_assignment($userid, $roleid, $coursecontext->id)) { $this->studentcourseids[$course->id] = $course->id; // We only need to check if one of the roleids has been assigned. break; } } if (has_capability('moodle/grade:viewall', $coursecontext, $userid)) { $this->teachercourses[$course->id] = $course; } } } // base url for sorting by first/last name $this->baseurl = $CFG->wwwroot.'/grade/overview/index.php?id='.$userid; $this->pbarurl = $this->baseurl; $this->setup_table(); } /** * Regrades all courses if needed. * * If $frontend is true, this may show a progress bar and redirect back to the page (possibly * several times if multiple courses need it). Otherwise, it will not return until all the * courses have been updated. * * @param bool $frontend True if we are running front-end code and can safely redirect back */ public function regrade_all_courses_if_needed(bool $frontend = false): void { foreach ($this->courses as $course) { if ($frontend) { grade_regrade_final_grades_if_required($course); } else { grade_regrade_final_grades($course->id); } } } /** * Prepares the headers and attributes of the flexitable. */ public function setup_table() { /* * Table has 3 columns *| course | final grade | rank (optional) | */ // setting up table headers if ($this->showrank['any']) { $tablecolumns = array('coursename', 'grade', 'rank'); $tableheaders = array(get_string('coursename', 'grades'), get_string('gradenoun'), get_string('rank', 'grades')); } else { $tablecolumns = array('coursename', 'grade'); $tableheaders = array(get_string('coursename', 'grades'), get_string('gradenoun')); } $this->table = new flexible_table('grade-report-overview-'.$this->user->id); $this->table->define_columns($tablecolumns); $this->table->define_headers($tableheaders); $this->table->define_baseurl($this->baseurl); $this->table->set_attribute('cellspacing', '0'); $this->table->set_attribute('id', 'overview-grade'); $this->table->set_attribute('class', 'boxaligncenter generaltable'); $this->table->setup(); } /** * Set up the courses grades data for the report. * * @param bool $studentcoursesonly Only show courses that the user is a student of. * @return array of course grades information */ public function setup_courses_data($studentcoursesonly) { global $USER, $DB; $coursesdata = array(); $numusers = $this->get_numusers(false); foreach ($this->courses as $course) { if (!$course->showgrades) { continue; } // If we are only showing student courses and this course isn't part of the group, then move on. if ($studentcoursesonly && !isset($this->studentcourseids[$course->id])) { continue; } $coursecontext = context_course::instance($course->id); if (!$course->visible && !has_capability('moodle/course:viewhiddencourses', $coursecontext)) { // The course is hidden and the user isn't allowed to see it. continue; } if (!has_capability('moodle/user:viewuseractivitiesreport', context_user::instance($this->user->id)) && ((!has_capability('moodle/grade:view', $coursecontext) || $this->user->id != $USER->id) && !has_capability('moodle/grade:viewall', $coursecontext))) { continue; } $coursesdata[$course->id]['course'] = $course; $coursesdata[$course->id]['context'] = $coursecontext; $canviewhidden = has_capability('moodle/grade:viewhidden', $coursecontext); // Get course grade_item. $courseitem = grade_item::fetch_course_item($course->id); // Get the stored grade. $coursegrade = new grade_grade(array('itemid' => $courseitem->id, 'userid' => $this->user->id)); $coursegrade->grade_item =& $courseitem; $finalgrade = $coursegrade->finalgrade; if (!$canviewhidden and !is_null($finalgrade)) { if ($coursegrade->is_hidden()) { $finalgrade = null; } else { $adjustedgrade = $this->blank_hidden_total_and_adjust_bounds($course->id, $courseitem, $finalgrade); // We temporarily adjust the view of this grade item - because the min and // max are affected by the hidden values in the aggregation. $finalgrade = $adjustedgrade['grade']; $courseitem->grademax = $adjustedgrade['grademax']; $courseitem->grademin = $adjustedgrade['grademin']; } } else { // We must use the specific max/min because it can be different for // each grade_grade when items are excluded from sum of grades. if (!is_null($finalgrade)) { $courseitem->grademin = $coursegrade->get_grade_min(); $courseitem->grademax = $coursegrade->get_grade_max(); } } $coursesdata[$course->id]['finalgrade'] = $finalgrade; $coursesdata[$course->id]['courseitem'] = $courseitem; if ($this->showrank['any'] && $this->showrank[$course->id] && !is_null($finalgrade)) { // Find the number of users with a higher grade. // Please note this can not work if hidden grades involved :-( to be fixed in 2.0. $params = array($finalgrade, $courseitem->id); $sql = "SELECT COUNT(DISTINCT(userid)) FROM {grade_grades} WHERE finalgrade IS NOT NULL AND finalgrade > ? AND itemid = ?"; $rank = $DB->count_records_sql($sql, $params) + 1; $coursesdata[$course->id]['rank'] = $rank; $coursesdata[$course->id]['numusers'] = $numusers; } } return $coursesdata; } /** * Fill the table for displaying. * * @param bool $activitylink If this report link to the activity report or the user report. * @param bool $studentcoursesonly Only show courses that the user is a student of. */ public function fill_table($activitylink = false, $studentcoursesonly = false) { global $CFG, $DB, $OUTPUT, $USER; if ($studentcoursesonly && count($this->studentcourseids) == 0) { return false; } // Only show user's courses instead of all courses. if ($this->courses) { $coursesdata = $this->setup_courses_data($studentcoursesonly); // Check whether current user can view all grades of this user - parent most probably. $viewasuser = $this->course->showgrades && has_any_capability([ 'moodle/grade:viewall', 'moodle/user:viewuseractivitiesreport', ], context_user::instance($this->user->id)); foreach ($coursesdata as $coursedata) { $course = $coursedata['course']; $coursecontext = $coursedata['context']; $finalgrade = $coursedata['finalgrade']; $courseitem = $coursedata['courseitem']; $coursenamelink = format_string(get_course_display_name_for_list($course), true, ['context' => $coursecontext]); // Link to the course grade report pages (performing same capability checks as the pages themselves). if ($activitylink && (has_capability('gradereport/' . $CFG->grade_profilereport .':view', $coursecontext) || $viewasuser)) { $coursenamelink = html_writer::link(new moodle_url('/course/user.php', [ 'mode' => 'grade', 'id' => $course->id, 'user' => $this->user->id, ]), $coursenamelink); } else if (!$activitylink && (has_capability('gradereport/user:view', $coursecontext) || $viewasuser)) { $coursenamelink = html_writer::link(new moodle_url('/grade/report/user/index.php', [ 'id' => $course->id, 'userid' => $this->user->id, 'group' => $this->gpr->groupid, ]), $coursenamelink); } $data = [$coursenamelink, grade_format_gradevalue($finalgrade, $courseitem, true)]; if ($this->showrank['any']) { if ($this->showrank[$course->id] && !is_null($finalgrade)) { $rank = $coursedata['rank']; $numusers = $coursedata['numusers']; $data[] = "$rank/$numusers"; } else { // No grade, no rank. // Or this course wants rank hidden. $data[] = '-'; } } $this->table->add_data($data); } return true; } else { echo $OUTPUT->notification(get_string('notenrolled', 'grades'), 'notifymessage'); return false; } } /** * Prints or returns the HTML from the flexitable. * @param bool $return Whether or not to return the data instead of printing it directly. * @return string */ public function print_table($return=false) { ob_start(); $this->table->print_html(); $html = ob_get_clean(); if ($return) { return $html; } else { echo $html; } } /** * Print a table to show courses that the user is able to grade. */ public function print_teacher_table() { $table = new html_table(); $table->head = array(get_string('coursename', 'grades')); $table->data = null; foreach ($this->teachercourses as $courseid => $course) { $coursecontext = context_course::instance($course->id); $coursenamelink = format_string($course->fullname, true, ['context' => $coursecontext]); $url = new moodle_url('/grade/report/index.php', array('id' => $courseid)); $table->data[] = array(html_writer::link($url, $coursenamelink)); } echo html_writer::table($table); } /** * Processes the data sent by the form (grades and feedbacks). * @param array $data * @return bool Success or Failure (array of errors). */ function process_data($data) { } function process_action($target, $action) { } /** * This report supports being set as the 'grades' report. */ public static function supports_mygrades() { return true; } /** * Check if the user can access the report. * * @param stdClass $systemcontext system context * @param stdClass $context course context * @param stdClass $personalcontext personal context * @param stdClass $course course object * @param int $userid userid * @return bool true if the user can access the report * @since Moodle 3.2 */ public static function check_access($systemcontext, $context, $personalcontext, $course, $userid) { global $USER; $access = false; if (has_capability('moodle/grade:viewall', $systemcontext)) { // Ok - can view all course grades. $access = true; } else if (has_capability('moodle/grade:viewall', $context)) { // Ok - can view any grades in context. $access = true; } else if ($userid == $USER->id and ((has_capability('moodle/grade:view', $context) and $course->showgrades) || $course->id == SITEID)) { // Ok - can view own course grades. $access = true; } else if (has_capability('moodle/grade:viewall', $personalcontext) and $course->showgrades) { // Ok - can view grades of this user - parent most probably. $access = true; } else if (has_capability('moodle/user:viewuseractivitiesreport', $personalcontext) and $course->showgrades) { // Ok - can view grades of this user - parent most probably. $access = true; } return $access; } /** * Trigger the grade_report_viewed event * * @param stdClass $context course context * @param int $courseid course id * @param int $userid user id * @since Moodle 3.2 */ public static function viewed($context, $courseid, $userid) { $event = \gradereport_overview\event\grade_report_viewed::create( array( 'context' => $context, 'courseid' => $courseid, 'relateduserid' => $userid, ) ); $event->trigger(); } } function grade_report_overview_settings_definition(&$mform) { global $CFG; //show rank $options = array(-1 => get_string('default', 'grades'), 0 => get_string('hide'), 1 => get_string('show')); if (empty($CFG->grade_report_overview_showrank)) { $options[-1] = get_string('defaultprev', 'grades', $options[0]); } else { $options[-1] = get_string('defaultprev', 'grades', $options[1]); } $mform->addElement('select', 'report_overview_showrank', get_string('showrank', 'grades'), $options); $mform->addHelpButton('report_overview_showrank', 'showrank', 'grades'); //showtotalsifcontainhidden $options = array(-1 => get_string('default', 'grades'), GRADE_REPORT_HIDE_TOTAL_IF_CONTAINS_HIDDEN => get_string('hide'), GRADE_REPORT_SHOW_TOTAL_IF_CONTAINS_HIDDEN => get_string('hidetotalshowexhiddenitems', 'grades'), GRADE_REPORT_SHOW_REAL_TOTAL_IF_CONTAINS_HIDDEN => get_string('hidetotalshowinchiddenitems', 'grades') ); if (!array_key_exists($CFG->grade_report_overview_showtotalsifcontainhidden, $options)) { $options[-1] = get_string('defaultprev', 'grades', $options[0]); } else { $options[-1] = get_string('defaultprev', 'grades', $options[$CFG->grade_report_overview_showtotalsifcontainhidden]); } $mform->addElement('select', 'report_overview_showtotalsifcontainhidden', get_string('hidetotalifhiddenitems', 'grades'), $options); $mform->addHelpButton('report_overview_showtotalsifcontainhidden', 'hidetotalifhiddenitems', 'grades'); } /** * Add nodes to myprofile page. * * @param \core_user\output\myprofile\tree $tree Tree object * @param stdClass $user user object * @param bool $iscurrentuser * @param stdClass $course Course object */ function gradereport_overview_myprofile_navigation(core_user\output\myprofile\tree $tree, $user, $iscurrentuser, $course) { if (empty($course)) { // We want to display these reports under the site context. $course = get_fast_modinfo(SITEID)->get_course(); } $systemcontext = context_system::instance(); $usercontext = context_user::instance($user->id); $coursecontext = context_course::instance($course->id); if (grade_report_overview::check_access($systemcontext, $coursecontext, $usercontext, $course, $user->id)) { $url = new moodle_url('/grade/report/overview/index.php', array('userid' => $user->id, 'id' => $course->id)); $node = new core_user\output\myprofile\node('reports', 'grades', get_string('gradesoverview', 'gradereport_overview'), null, $url); $tree->add_node($node); } } report/overview/renderer.php 0000604 00000003224 15062070556 0012247 0 ustar 00 <?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/>. /** * Renderer for the gradebook overview report * * @package gradereport_overview * @copyright 2010 Sam Hemelryk * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ /** * Custom renderer for the user grade report * * To get an instance of this use the following code: * $renderer = $PAGE->get_renderer('gradereport_overview'); * * @copyright 2010 Sam Hemelryk * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class gradereport_overview_renderer extends plugin_renderer_base { public function graded_users_selector($report, $course, $userid, $groupid, $includeall) { global $USER; $select = grade_get_graded_users_select($report, $course, $userid, $groupid, $includeall); $output = html_writer::tag('div', $this->output->render($select), array('id'=>'graded_users_selector')); $output .= html_writer::tag('p', '', array('style'=>'page-break-after: always;')); return $output; } } report/overview/settings.php 0000604 00000003546 15062070556 0012310 0 ustar 00 <?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/>. /** * Defines site settings for the overview gradebook report * * @package gradereport_overview * @copyright 2007 Petr Skoda * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die; if ($ADMIN->fulltree) { $settings->add(new admin_setting_configcheckbox('grade_report_overview_showrank', get_string('showrank', 'grades'), get_string('showrank_help', 'grades'), 0)); $settings->add(new admin_setting_configselect('grade_report_overview_showtotalsifcontainhidden', get_string('hidetotalifhiddenitems', 'grades'), get_string('hidetotalifhiddenitems_help', 'grades'), GRADE_REPORT_HIDE_TOTAL_IF_CONTAINS_HIDDEN, array(GRADE_REPORT_HIDE_TOTAL_IF_CONTAINS_HIDDEN => get_string('hide'), GRADE_REPORT_SHOW_TOTAL_IF_CONTAINS_HIDDEN => get_string('hidetotalshowexhiddenitems', 'grades'), GRADE_REPORT_SHOW_REAL_TOTAL_IF_CONTAINS_HIDDEN => get_string('hidetotalshowinchiddenitems', 'grades') ))); } report/overview/version.php 0000604 00000002313 15062070556 0012124 0 ustar 00 <?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/>. /** * Version details for the overview gradebook report * * @package gradereport_overview * @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); $plugin->version = 2023100900; // The current plugin version (Date: YYYYMMDDXX). $plugin->requires = 2023100400; // Requires this Moodle version. $plugin->component = 'gradereport_overview'; // Full name of the plugin (used for diagnostics) report/overview/tests/externallib_test.php 0000604 00000025472 15062070556 0015164 0 ustar 00 <?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/>. namespace gradereport_overview; use core_external\external_api; use externallib_advanced_testcase; use gradereport_overview_external; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once($CFG->dirroot . '/webservice/tests/helpers.php'); /** * Overview grade report functions unit tests * * @package gradereport_overview * @category external * @copyright 2015 Juan Leyva <juan@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class externallib_test extends externallib_advanced_testcase { /** @var \stdClass Course 1 record. */ protected $course1; /** @var \stdClass Course 2 record. */ protected $course2; /** @var \stdClass To store student user record. */ protected $student1; /** @var \stdClass To store student user record. */ protected $student2; /** @var \stdClass To store Teacher user record. */ protected $teacher; /** @var array To store student 1 and the rawgrade 1. */ protected $student1grade1 = []; /** @var array To store student 1 and the rawgrade 2. */ protected $student1grade2 = []; /** @var array To store student 2 and the rawgrade. */ protected $student2grade = []; /** * Set up for every test */ public function setUp(): void { global $DB; $this->resetAfterTest(true); $s1grade1 = 80; $s1grade2 = 40; $s2grade = 60; $this->course1 = $this->getDataGenerator()->create_course(); $this->course2 = $this->getDataGenerator()->create_course(); $studentrole = $DB->get_record('role', array('shortname' => 'student')); $teacherrole = $DB->get_record('role', array('shortname' => 'editingteacher')); $this->student1 = $this->getDataGenerator()->create_user(); $this->teacher = $this->getDataGenerator()->create_user(); $this->getDataGenerator()->enrol_user($this->teacher->id, $this->course1->id, $teacherrole->id); $this->getDataGenerator()->enrol_user($this->student1->id, $this->course1->id, $studentrole->id); $this->getDataGenerator()->enrol_user($this->student1->id, $this->course2->id, $studentrole->id); $this->student2 = $this->getDataGenerator()->create_user(); $this->getDataGenerator()->enrol_user($this->student2->id, $this->course1->id, $studentrole->id); $this->getDataGenerator()->enrol_user($this->student2->id, $this->course2->id, $studentrole->id); $assignment1 = $this->getDataGenerator()->create_module('assign', array('name' => "Test assign", 'course' => $this->course1->id)); $assignment2 = $this->getDataGenerator()->create_module('assign', array('name' => "Test assign", 'course' => $this->course2->id)); $modcontext1 = get_coursemodule_from_instance('assign', $assignment1->id, $this->course1->id); $modcontext2 = get_coursemodule_from_instance('assign', $assignment2->id, $this->course2->id); $assignment1->cmidnumber = $modcontext1->id; $assignment2->cmidnumber = $modcontext2->id; $this->student1grade1 = array('userid' => $this->student1->id, 'rawgrade' => $s1grade1); $this->student1grade2 = array('userid' => $this->student1->id, 'rawgrade' => $s1grade2); $this->student2grade = array('userid' => $this->student2->id, 'rawgrade' => $s2grade); $studentgrades = array($this->student1->id => $this->student1grade1, $this->student2->id => $this->student2grade); assign_grade_item_update($assignment1, $studentgrades); $studentgrades = array($this->student1->id => $this->student1grade2); assign_grade_item_update($assignment2, $studentgrades); grade_get_setting($this->course1->id, 'report_overview_showrank', 1); } /** * Test get_course_grades function case student */ public function test_get_course_grades_student() { // A user can see his own grades in both courses. $this->setUser($this->student1); $studentgrades = gradereport_overview_external::get_course_grades(); $studentgrades = external_api::clean_returnvalue(gradereport_overview_external::get_course_grades_returns(), $studentgrades); $this->assertCount(0, $studentgrades['warnings']); $this->assertCount(2, $studentgrades['grades']); foreach ($studentgrades['grades'] as $grade) { if ($grade['courseid'] == $this->course1->id) { $this->assertEquals(80.00, $grade['grade']); $this->assertEquals(80.0000, $grade['rawgrade']); $this->assertEquals(1, $grade['rank']); } else { $this->assertEquals(40.00, $grade['grade']); $this->assertEquals(40.0000, $grade['rawgrade']); $this->assertArrayNotHasKey('rank', $grade); } } // Second student, no grade in one course. $this->setUser($this->student2); $studentgrades = gradereport_overview_external::get_course_grades(); $studentgrades = external_api::clean_returnvalue(gradereport_overview_external::get_course_grades_returns(), $studentgrades); $this->assertCount(0, $studentgrades['warnings']); $this->assertCount(2, $studentgrades['grades']); foreach ($studentgrades['grades'] as $grade) { if ($grade['courseid'] == $this->course1->id) { $this->assertEquals(60.00, $grade['grade']); $this->assertEquals(60.0000, $grade['rawgrade']); $this->assertEquals(2, $grade['rank']); } else { $this->assertEquals('-', $grade['grade']); $this->assertEmpty($grade['rawgrade']); $this->assertArrayNotHasKey('rank', $grade); } } } /** * Test get_course_grades function case admin */ public function test_get_course_grades_admin() { // A admin must see all student grades. $this->setAdminUser(); $studentgrades = gradereport_overview_external::get_course_grades($this->student1->id); $studentgrades = external_api::clean_returnvalue(gradereport_overview_external::get_course_grades_returns(), $studentgrades); $this->assertCount(0, $studentgrades['warnings']); $this->assertCount(2, $studentgrades['grades']); foreach ($studentgrades['grades'] as $grade) { if ($grade['courseid'] == $this->course1->id) { $this->assertEquals(80.00, $grade['grade']); $this->assertEquals(80.0000, $grade['rawgrade']); } else { $this->assertEquals(40.00, $grade['grade']); $this->assertEquals(40.0000, $grade['rawgrade']); } } $studentgrades = gradereport_overview_external::get_course_grades($this->student2->id); $studentgrades = external_api::clean_returnvalue(gradereport_overview_external::get_course_grades_returns(), $studentgrades); $this->assertCount(0, $studentgrades['warnings']); $this->assertCount(2, $studentgrades['grades']); // Admins don't see grades. $studentgrades = gradereport_overview_external::get_course_grades(); $studentgrades = external_api::clean_returnvalue(gradereport_overview_external::get_course_grades_returns(), $studentgrades); $this->assertCount(0, $studentgrades['warnings']); $this->assertCount(0, $studentgrades['grades']); } /** * Test get_course_grades function case teacher */ public function test_get_course_grades_teacher() { // Teachers don't see grades. $this->setUser($this->teacher); $studentgrades = gradereport_overview_external::get_course_grades(); $studentgrades = external_api::clean_returnvalue(gradereport_overview_external::get_course_grades_returns(), $studentgrades); $this->assertCount(0, $studentgrades['warnings']); $this->assertCount(0, $studentgrades['grades']); } /** * Test get_course_grades function case incorrect permissions */ public function test_get_course_grades_permissions() { // Student can't see other student grades. $this->setUser($this->student2); $this->expectException('required_capability_exception'); $studentgrade = gradereport_overview_external::get_course_grades($this->student1->id); } /** * Test view_grade_report function */ public function test_view_grade_report() { global $USER; // Redirect events to the sink, so we can recover them later. $sink = $this->redirectEvents(); $this->setUser($this->student1); $result = gradereport_overview_external::view_grade_report($this->course1->id); $result = external_api::clean_returnvalue(gradereport_overview_external::view_grade_report_returns(), $result); $events = $sink->get_events(); $this->assertCount(1, $events); $event = reset($events); // Check the event details are correct. $this->assertInstanceOf('\gradereport_overview\event\grade_report_viewed', $event); $this->assertEquals(\context_course::instance($this->course1->id), $event->get_context()); $this->assertEquals($USER->id, $event->get_data()['relateduserid']); $this->setUser($this->teacher); $result = gradereport_overview_external::view_grade_report($this->course1->id, $this->student1->id); $result = external_api::clean_returnvalue(gradereport_overview_external::view_grade_report_returns(), $result); $events = $sink->get_events(); $event = reset($events); $sink->close(); // Check the event details are correct. $this->assertInstanceOf('\gradereport_overview\event\grade_report_viewed', $event); $this->assertEquals(\context_course::instance($this->course1->id), $event->get_context()); $this->assertEquals($this->student1->id, $event->get_data()['relateduserid']); } /** * Test view_grade_report_permissions function */ public function test_view_grade_report_permissions() { $this->setUser($this->student2); $this->expectException('moodle_exception'); $studentgrade = gradereport_overview_external::view_grade_report($this->course1->id, $this->student1->id); } } report/overview/tests/lib_test.php 0000604 00000012147 15062070556 0013414 0 ustar 00 <?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/>. namespace gradereport_overview; /** * Overview grade report lib functions unit tests * * @package gradereport_overview * @copyright 2023 The Open University * @covers \grade_report_overview * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class lib_test extends \advanced_testcase { /** * Require the library file we're about to test, and other requirements. */ protected function setUp(): void { global $CFG; require_once($CFG->dirroot . '/grade/report/overview/lib.php'); require_once($CFG->dirroot . '/grade/querylib.php'); } /** * Data provider for true or false value. * * @return array Two options, one with true and one with false */ public function true_or_false(): array { return [ [true], [false] ]; } /** * Tests the regrade_all_courses_if_needed function, which is supposed to regrade all the * courses that the current user is enrolled on (if they need update). * * This is tested with both frontend and backend - the frontend option should not actually * do the progress bar/continue button (which can't be tested from here because it calls exit) * because these courses are small. * * @dataProvider true_or_false * @param bool $frontend True to use the front-end parameter to the function under test */ public function test_regrade_all_courses_if_needed(bool $frontend): void { global $DB; $this->resetAfterTest(true); $generator = $this->getDataGenerator(); // Create 3 courses and a test user. The test user belongs to 2 of them, while another user // belongs to the other course. $user = $generator->create_user(); $otheruser = $generator->create_user(); $course1 = $generator->create_course(); $generator->enrol_user($user->id, $course1->id, 'student'); $course2 = $generator->create_course(); $generator->enrol_user($otheruser->id, $course2->id, 'student'); $course3 = $generator->create_course(); $generator->enrol_user($user->id, $course3->id, 'student'); // We need permission to create grades (even though it's a data generator). $this->setAdminUser(); // Set up each course grade. foreach ([$course1, $course2, $course3] as $course) { // Create an assignment and get its grade item. $assign = $generator->create_module('assign', ['course' => $course->id]); $modinfo = get_fast_modinfo($course->id); $cm = $modinfo->get_cm($assign->cmid); $items = grade_get_grade_items_for_activity($cm, true); $item = reset($items); // Set a grade in the assignment, either for the normal test user or the other user // depending on course. if ($course === $course2) { $userid = $otheruser->id; } else { $userid = $user->id; } $generator->create_grade_grade([ 'itemid' => $item->id, 'userid' => $userid, 'teamsubmission' => false, 'attemptnumber' => 0, 'grade' => 50 ]); // Bodge the final grade so that it needs regrading and is set wrong. $course->gradeitemid = $DB->get_field('grade_items', 'id', ['courseid' => $course->id, 'itemtype' => 'course'], MUST_EXIST); $DB->set_field('grade_items', 'needsupdate', 1, ['id' => $course->gradeitemid]); $DB->set_field('grade_grades', 'finalgrade', 25.0, ['itemid' => $course->gradeitemid]); } // Construct the overview report and call regrade_all_courses_if_needed. $gpr = new \stdClass(); $report = new \grade_report_overview($user->id, $gpr, ''); $report->regrade_all_courses_if_needed($frontend); // This should have regraded courses 1 and 3, but not 2 (because the user doesn't belong). $this->assertEqualsWithDelta(50.0, $DB->get_field('grade_grades', 'finalgrade', ['itemid' => $course1->gradeitemid]), 1.0); $this->assertEqualsWithDelta(25.0, $DB->get_field('grade_grades', 'finalgrade', ['itemid' => $course2->gradeitemid]), 1.0); $this->assertEqualsWithDelta(50.0, $DB->get_field('grade_grades', 'finalgrade', ['itemid' => $course3->gradeitemid]), 1.0); } } report/overview/lang/en/gradereport_overview.php 0000604 00000002345 15062070556 0016233 0 ustar 00 <?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/>. /** * Strings for component 'gradereport_overview', language 'en' * * @package gradereport_overview * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ $string['eventgradereportviewed'] = 'Grade overview report viewed'; $string['gradesoverview'] = 'Grades overview'; $string['pluginname'] = 'Overview report'; $string['privacy:metadata'] = 'The Grade overview report only shows data stored in other locations.'; $string['overview:view'] = 'View overview report'; report/overview/db/services.php 0000604 00000003207 15062070556 0012652 0 ustar 00 <?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/>. /** * Overview grade report external functions and service definitions. * * @package gradereport_overview * @copyright 2016 Juan Leyva <juan@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); $functions = array( 'gradereport_overview_get_course_grades' => array( 'classname' => 'gradereport_overview_external', 'methodname' => 'get_course_grades', 'description' => 'Get the given user courses final grades', 'type' => 'read', 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE), ), 'gradereport_overview_view_grade_report' => array( 'classname' => 'gradereport_overview_external', 'methodname' => 'view_grade_report', 'description' => 'Trigger the report view event', 'type' => 'write', 'capabilities' => 'gradereport/overview:view', 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE), ) ); report/overview/db/access.php 0000604 00000002250 15062070556 0012265 0 ustar 00 <?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/>. /** * Defines capabilities for the overview report * * @package gradereport_overview * @copyright 2007 Nicolas Connault * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); $capabilities = array( 'gradereport/overview:view' => array( 'riskbitmask' => RISK_PERSONAL, 'captype' => 'read', 'contextlevel' => CONTEXT_COURSE, 'archetypes' => array( 'user' => CAP_ALLOW ) ) ); report/overview/db/upgrade.php 0000604 00000003107 15062070556 0012455 0 ustar 00 <?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/>. /** * Grade overview report upgrade steps. * * @package gradereport_overview * @copyright 2017 Simey Lameze <simey@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); /** * Function to upgrade grade overview report. * * @param int $oldversion the version we are upgrading from * @return bool result */ function xmldb_gradereport_overview_upgrade($oldversion) { // Automatically generated Moodle v3.9.0 release upgrade line. // Put any upgrade step following this. // Automatically generated Moodle v4.0.0 release upgrade line. // Put any upgrade step following this. // Automatically generated Moodle v4.1.0 release upgrade line. // Put any upgrade step following this. // Automatically generated Moodle v4.2.0 release upgrade line. // Put any upgrade step following this. return true; } report/singleview/styles.css 0000604 00000007301 15062070556 0012273 0 ustar 00 .path-grade-report-singleview div.reporttable { margin: 20px 0 30px 0; padding: 10px 10px; background-color: #f8f9fa; text-align: center; } .path-grade-report-singleview div.groupselector, .path-grade-report-singleview div.selectitems { display: block; text-align: right; clear: both; } .path-grade-report-singleview div.singleselect + div.singleselect select, .path-grade-report-singleview div.groupselector select { margin-right: 0; } .path-grade-report-singleview div.reporttable div.singleselect form div { text-align: center; } .path-grade-report-singleview div.reporttable table.reporttable { margin: 0 auto 15px auto; } .path-grade-report-singleview div.reporttable form div { text-align: left; } .path-grade-report-singleview div.reporttable h2 { text-align: left; } .path-grade-report-singleview .overrideexcludecheck { width: 14.75px; height: 12px; color: #2ca14f; } .path-grade-report-singleview .report-navigation .container { max-width: 1060px; margin-left: 0; } .path-grade-report-singleview .zero-state img { width: 185px; } .path-grade-report-singleview .reporttable thead th, .path-grade-report-singleview .reporttable thead td { white-space: nowrap; border: none; } .path-grade-report-singleview .reporttable tbody tr, .path-grade-report-singleview .reporttable tbody tr:nth-of-type(odd), .path-grade-report-singleview .reporttable tbody tr:hover { color: inherit; background-color: white; border-top: none; border-bottom: 1px solid #dee2e6; } .path-grade-report-singleview .reporttable tbody th, .path-grade-report-singleview .reporttable tbody td.range { white-space: nowrap; font-weight: normal; } .path-grade-report-singleview .reporttable tbody th > * { display: inline-block; vertical-align: middle; margin: 0 2px; } .path-grade-report-singleview .itemnav { font-size: small; display: inline; padding-bottom: 0.5em; } .path-grade-report-singleview .itemnav.previtem { float: left; } .path-grade-report-singleview div.nextitem { float: right; } .path-grade-report-singleview .reporttable { width: 100%; } .path-grade-report-singleview .reporttable .generaltable th, .path-grade-report-singleview .reporttable .generaltable td { text-align: left; vertical-align: middle; border: none; } .path-grade-report-singleview div.reporttable form div.singleview_bulk { display: inline-block; text-align: left; margin-bottom: 1em; } .path-grade-report-singleview .singleview_bulk div > *, .path-grade-report-singleview .singleview_bulk fieldset > * { display: inline-block; vertical-align: middle; margin: 0; } .path-grade-report-singleview .singleselect select, .path-grade-report-singleview div.reporttable form .singleview_bulk select, .path-grade-report-singleview div.reporttable form .singleview_bulk input { margin-left: 10px; margin-right: 10px; } #bulkinsertmodal { width: 181px; height: 39px; top: 309px; border-radius: 4px; } .path-grade-report-singleview .singleview_bulk > fieldset { display: block; } .path-grade-report-singleview div.reporttable form .singleview_bulk > div.enable { margin-bottom: 0.5em; text-align: left; } .searchresultitemscontainer { max-height: 150px; height: 150px; overflow: auto; } .path-grade-report-singleview .search-widget[data-searchtype="user"] .userinitials { width: 40px; height: 40px; } .path-grade-report-singleview .reporttable .gradeitem span.small { font-size: 70%; } .path-grade-report-singleview .reporttable div.categoryitem .gradeitemheader, .path-grade-report-singleview .reporttable div.courseitem .gradeitemheader { font-weight: bold; } report/singleview/lang/en/gradereport_singleview.php 0000604 00000010773 15062070556 0017053 0 ustar 00 <?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/>. /** * Strings for Single view * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); // General Strings. $string['all_grades'] = 'All grades'; $string['assessmentname'] = 'Grade item'; $string['blanks'] = 'Empty grades'; $string['bulkappliesto'] = 'For'; $string['bulkinsertvalue'] = 'Insert new grade'; $string['bulklegend'] = 'Bulk insert grades'; $string['bulkchoice'] = 'Bulk insert lets you replace multiple grades at once. Choose the grades you want to replace:'; $string['bulkperform'] = 'Perform bulk insert'; $string['bulkfor'] = 'Grades for {$a}'; $string['entrypage'] = 'Grade user or grade item'; $string['exclude'] = 'Exclude'; $string['excludeall'] = 'Exclude all grades'; $string['excludeallgrades'] = 'Exclude all'; $string['excludefor'] = 'Exclude for {$a}'; $string['excludenone'] = 'Do not exclude any grades'; $string['excludenonegrades'] = 'Exclude none'; $string['eventgradereportviewed'] = 'Grade single view report viewed.'; $string['feedbackfor'] = 'Feedback for {$a}'; $string['gradefor'] = 'Grade for {$a}'; $string['gradeitem'] = 'Grade item: {$a}'; $string['gradeuser'] = 'Grade user: {$a}'; $string['gotonextreport'] = 'Go to next user report'; $string['gotopreviousreport'] = 'Go to previous user report'; $string['noscreens'] = 'Could not find a suitable single view screen.'; $string['gradeitemcannotbeoverridden'] = 'This grade item cannot be overridden.'; $string['itemsperpage'] = 'Items per page'; $string['notvalid'] = 'Not a valid Single view screen: {$a}'; $string['override'] = 'Override'; $string['overrideall'] = 'Override all grades'; $string['overrideallgrades'] = 'Override all'; $string['overridefor'] = 'Override for {$a}'; $string['overridenone'] = 'Do not override any grades'; $string['overridenonegrades'] = 'Override none'; $string['overridenoneconfirm'] = 'This will remove all previously entered overridden grades on this page when you save changes.'; $string['pluginname'] = 'Single view'; $string['privacy:metadata'] = 'The Grade single view report only shows data stored in other locations.'; $string['removeoverride'] = 'Remove grade overrides'; $string['removeoverridesave'] = 'Remove overrides'; $string['savegrades'] = 'Saving grades'; $string['save'] = 'Save'; $string['savegradessuccess'] = 'Grades were set for {$a} items'; $string['singleview:view'] = 'View single view'; $string['singleviewreport_user'] = 'Single view for this user'; $string['singleviewreport_gradeitem'] = 'Single view for this item'; $string['summarygrade'] = 'A table of users, with columns for range, grade, feedback, and whether to override or exclude a particular grade.'; $string['summaryuser'] = 'A table of grade items, with columns for grade category, range, grade, feedback, and whether to override or exclude a particular grade.'; $string['unsavedataalert'] = 'If you have unsaved changes on the page, you will lose them if you proceed with bulk insert grades.'; $string['unsavedataconfirm'] = 'I understand that my unsaved changes will be lost.'; $string['userselect'] = 'Select activity'; $string['ariareporttype'] = 'Select a report type to view'; $string['viewby'] = 'View by'; $string['viewsingleuser'] = 'Search for a user to view all their grades'; $string['viewsinglegradeitem'] = 'Select a grade item above'; $string['selectagrade'] = 'Select a grade item'; $string['selectgradeitemlink'] = 'Select a grade item'; $string['singleviewdescription'] = 'In single view you can override or exclude selected grades and bulk insert grades.'; $string['unsaveddatawarning'] = 'Unsaved data warning'; // Deprecated since Moodle 4.1. $string['filtergrades'] = 'Show grades for {$a}.'; // Deprecated since Moodle 4.3. $string['viewsingleuserorgradeitem'] = 'View all the grades of a single user or grade item.'; report/singleview/lang/en/deprecated.txt 0000604 00000000125 15062070556 0014417 0 ustar 00 filtergrades,gradereport_singleview viewsingleuserorgradeitem,gradereport_singleview report/singleview/amd/build/user.min.js 0000604 00000004703 15062070556 0014177 0 ustar 00 define("gradereport_singleview/user",["exports","core_user/comboboxsearch/user","core/url","core/templates","core_grades/searchwidget/repository"],(function(_exports,_user,_url,_templates,Repository){function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}} /** * Allow the user to search for learners within the singleview report. * * @module gradereport_singleview/user * @copyright 2023 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.default=void 0,_user=_interopRequireDefault(_user),_url=_interopRequireDefault(_url),Repository=function(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}newObj.default=obj,cache&&cache.set(obj,newObj);return newObj}(Repository);class User extends _user.default{constructor(){super()}static init(){return new User}async renderDropdown(){const{html:html,js:js}=await(0,_templates.renderForPromise)("core_user/comboboxsearch/resultset",{users:this.getMatchedResults().slice(0,5),hasresults:this.getMatchedResults().length>0,searchterm:this.getSearchTerm()});(0,_templates.replaceNodeContents)(this.getHTMLElements().searchDropdown,html,js)}selectAllResultsLink(){return null}selectOneLink(userID){return _url.default.relativeUrl("/grade/report/singleview/index.php",{id:this.courseID,searchvalue:this.getSearchTerm(),item:"user",userid:userID},!1)}fetchDataset(){const gts="string"==typeof this.groupID&&""===this.groupID?0:this.groupID;return Repository.userFetch(this.courseID,gts).then((r=>r.users))}}return _exports.default=User,_exports.default})); //# sourceMappingURL=user.min.js.map report/singleview/amd/build/group.min.js.map 0000604 00000005676 15062070556 0015143 0 ustar 00 {"version":3,"file":"group.min.js","sources":["../src/group.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Allow the user to search for groups within the singleview report.\n *\n * @module gradereport_singleview/group\n * @copyright 2023 Mathew May <mathew.solutions>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\nimport GroupSearch from 'core_group/comboboxsearch/group';\nimport Url from 'core/url';\n\nexport default class Group extends GroupSearch {\n\n courseID;\n\n item = null;\n\n /**\n * Construct the class.\n *\n * @param {string} item The page type we are currently on.\n */\n constructor(item) {\n super();\n this.item = item;\n\n // Define our standard lookups.\n this.selectors = {...this.selectors,\n courseid: '[data-region=\"courseid\"]',\n };\n const component = document.querySelector(this.componentSelector());\n this.courseID = component.querySelector(this.selectors.courseid).dataset.courseid;\n }\n\n /**\n * Allow the class to be invoked via PHP.\n *\n * @param {string} item The page type we are currently on.\n * @returns {Group}\n */\n static init(item) {\n return new Group(item);\n }\n\n /**\n * Build up the view all link that is dedicated to a particular result.\n *\n * @param {Number} groupID The ID of the group selected.\n * @returns {string|*}\n */\n selectOneLink(groupID) {\n return Url.relativeUrl('/grade/report/singleview/index.php', {\n id: this.courseID,\n groupsearchvalue: this.getSearchTerm(),\n group: groupID,\n item: this.item\n }, false);\n }\n}\n"],"names":["Group","GroupSearch","constructor","item","selectors","this","courseid","component","document","querySelector","componentSelector","courseID","dataset","selectOneLink","groupID","Url","relativeUrl","id","groupsearchvalue","getSearchTerm","group"],"mappings":"mhBAyBqBA,cAAcC,eAW/BC,YAAYC,kFAPL,WASEA,KAAOA,UAGPC,UAAY,IAAIC,KAAKD,UACtBE,SAAU,kCAERC,UAAYC,SAASC,cAAcJ,KAAKK,0BACzCC,SAAWJ,UAAUE,cAAcJ,KAAKD,UAAUE,UAAUM,QAAQN,qBASjEH,aACD,IAAIH,MAAMG,MASrBU,cAAcC,gBACHC,aAAIC,YAAY,qCAAsC,CACzDC,GAAIZ,KAAKM,SACTO,iBAAkBb,KAAKc,gBACvBC,MAAON,QACPX,KAAME,KAAKF,OACZ"} report/singleview/amd/build/selectors.min.js.map 0000604 00000005065 15062070556 0016002 0 ustar 00 {"version":3,"file":"selectors.min.js","sources":["../src/selectors.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Define all of the selectors we will be using on the grading interface.\n *\n * @module gradereport_singleview/selectors\n * @copyright 2022 Ilya Tregubov <ilya@moodle.com>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\n/**\n * A small helper function to build queryable data selectors.\n * @method getDataSelector\n * @param {String} name\n * @param {String} value\n * @return {string}\n */\nconst getDataSelector = (name, value) => {\n return `[data-${name}=\"${value}\"]`;\n};\n\nexport default {\n actions: {\n bulkaction: getDataSelector('role', 'bulkaction'),\n },\n elements: {\n override: 'input[type=checkbox][name^=override]',\n exclude: 'input[type=checkbox][name^=exclude]',\n modalsave: '[data-action=\"save\"]',\n warningcheckbox: 'input[type=\"checkbox\"]',\n modalformdata: '.formdata',\n modalradio: 'input[type=\"radio\"]',\n modalinput: 'input[type=\"text\"]',\n modalradiochecked: 'input[type=\"radio\"]:checked',\n enablebulkinsert: 'input[type=\"checkbox\"][name^=bulk]',\n formradio: 'select[name^=bulk]',\n modalgrade: '.form-control',\n formgrade: 'input[type=\"text\"][name^=bulk]',\n formsave: 'input[type=\"submit\"]',\n },\n};\n"],"names":["name","value","actions","bulkaction","elements","override","exclude","modalsave","warningcheckbox","modalformdata","modalradio","modalinput","modalradiochecked","enablebulkinsert","formradio","modalgrade","formgrade","formsave"],"mappings":"8JA8ByBA,KAAMC,eAIhB,CACXC,QAAS,CACLC,YANiBH,KAMW,OANLC,MAMa,6BALxBD,kBAASC,cAOzBG,SAAU,CACNC,SAAU,uCACVC,QAAS,sCACTC,UAAW,uBACXC,gBAAiB,yBACjBC,cAAe,YACfC,WAAY,sBACZC,WAAY,qBACZC,kBAAmB,8BACnBC,iBAAkB,qCAClBC,UAAW,qBACXC,WAAY,gBACZC,UAAW,iCACXC,SAAU"} report/singleview/amd/build/user.min.js.map 0000604 00000007276 15062070556 0014763 0 ustar 00 {"version":3,"file":"user.min.js","sources":["../src/user.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Allow the user to search for learners within the singleview report.\n *\n * @module gradereport_singleview/user\n * @copyright 2023 Mathew May <mathew.solutions>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\nimport UserSearch from 'core_user/comboboxsearch/user';\nimport Url from 'core/url';\nimport {renderForPromise, replaceNodeContents} from 'core/templates';\nimport * as Repository from 'core_grades/searchwidget/repository';\n\nexport default class User extends UserSearch {\n\n constructor() {\n super();\n }\n\n static init() {\n return new User();\n }\n\n /**\n * Build the content then replace the node.\n */\n async renderDropdown() {\n const {html, js} = await renderForPromise('core_user/comboboxsearch/resultset', {\n users: this.getMatchedResults().slice(0, 5),\n hasresults: this.getMatchedResults().length > 0,\n searchterm: this.getSearchTerm(),\n });\n replaceNodeContents(this.getHTMLElements().searchDropdown, html, js);\n }\n\n /**\n * Stub out default required function unused here.\n * @returns {null}\n */\n selectAllResultsLink() {\n return null;\n }\n\n /**\n * Build up the view all link that is dedicated to a particular result.\n *\n * @param {Number} userID The ID of the user selected.\n * @returns {string|*}\n */\n selectOneLink(userID) {\n return Url.relativeUrl('/grade/report/singleview/index.php', {\n id: this.courseID,\n searchvalue: this.getSearchTerm(),\n item: 'user',\n userid: userID,\n }, false);\n }\n\n /**\n * Get the data we will be searching against in this component.\n *\n * @returns {Promise<*>}\n */\n fetchDataset() {\n // Small typing checks as sometimes groups don't exist therefore the element returns a empty string.\n const gts = typeof (this.groupID) === \"string\" && this.groupID === '' ? 0 : this.groupID;\n return Repository.userFetch(this.courseID, gts).then((r) => r.users);\n }\n}\n"],"names":["User","UserSearch","constructor","html","js","users","this","getMatchedResults","slice","hasresults","length","searchterm","getSearchTerm","getHTMLElements","searchDropdown","selectAllResultsLink","selectOneLink","userID","Url","relativeUrl","id","courseID","searchvalue","item","userid","fetchDataset","gts","groupID","Repository","userFetch","then","r"],"mappings":";;;;;;;q0BA2BqBA,aAAaC,cAE9BC,2CAKW,IAAIF,kCAOLG,KAACA,KAADC,GAAOA,UAAY,+BAAiB,qCAAsC,CAC5EC,MAAOC,KAAKC,oBAAoBC,MAAM,EAAG,GACzCC,WAAYH,KAAKC,oBAAoBG,OAAS,EAC9CC,WAAYL,KAAKM,qDAEDN,KAAKO,kBAAkBC,eAAgBX,KAAMC,IAOrEW,8BACW,KASXC,cAAcC,eACHC,aAAIC,YAAY,qCAAsC,CACzDC,GAAId,KAAKe,SACTC,YAAahB,KAAKM,gBAClBW,KAAM,OACNC,OAAQP,SACT,GAQPQ,qBAEUC,IAAgC,iBAAlBpB,KAAKqB,SAA0C,KAAjBrB,KAAKqB,QAAiB,EAAIrB,KAAKqB,eAC1EC,WAAWC,UAAUvB,KAAKe,SAAUK,KAAKI,MAAMC,GAAMA,EAAE1B"} report/singleview/amd/build/grade.min.js.map 0000604 00000004752 15062070556 0015063 0 ustar 00 {"version":3,"file":"grade.min.js","sources":["../src/grade.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Allow the user to search for grades within the singleview report.\n *\n * @module gradereport_singleview/grade\n * @copyright 2023 Mathew May <mathew.solutions>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\nimport GradeItemSearch from 'core_grades/comboboxsearch/grade';\nimport Url from 'core/url';\n\n// Define our standard lookups.\nconst selectors = {\n component: '.grade-search',\n courseid: '[data-region=\"courseid\"]',\n};\nconst component = document.querySelector(selectors.component);\n\nexport default class GradeItems extends GradeItemSearch {\n\n courseID = component.querySelector(selectors.courseid).dataset.courseid;\n\n constructor() {\n super();\n }\n\n static init() {\n return new GradeItems();\n }\n\n /**\n * Build up the link that is dedicated to a particular result.\n *\n * @param {Number} gradeID The ID of the grade item selected.\n * @returns {string|*}\n */\n selectOneLink(gradeID) {\n return Url.relativeUrl('/grade/report/singleview/index.php', {\n id: this.courseID,\n gradesearchvalue: this.getSearchTerm(),\n item: 'grade',\n itemid: gradeID,\n }, false);\n }\n}\n"],"names":["selectors","component","document","querySelector","GradeItems","GradeItemSearch","constructor","dataset","courseid","selectOneLink","gradeID","Url","relativeUrl","id","this","courseID","gradesearchvalue","getSearchTerm","item","itemid"],"mappings":"gXA0BMA,oBACS,gBADTA,mBAEQ,2BAERC,UAAYC,SAASC,cAAcH,2BAEpBI,mBAAmBC,eAIpCC,sEAFWL,UAAUE,cAAcH,oBAAoBO,QAAQC,+IAOpD,IAAIJ,WASfK,cAAcC,gBACHC,aAAIC,YAAY,qCAAsC,CACzDC,GAAIC,KAAKC,SACTC,iBAAkBF,KAAKG,gBACvBC,KAAM,QACNC,OAAQT,UACT"} report/singleview/amd/build/bulkactions.min.js 0000604 00000013107 15062070556 0015535 0 ustar 00 define("gradereport_singleview/bulkactions",["exports","core/pending","core/custom_interaction_events","core/modal_save_cancel","core/templates","core/modal_events","core/str","core/notification","gradereport_singleview/selectors"],(function(_exports,_pending,_custom_interaction_events,_modal_save_cancel,_templates,_modal_events,Str,_notification,_selectors){function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}} /** * Javascript module for bulk actions. * * @module gradereport_singleview/bulkactions * @copyright 2022 Ilya Tregubov <ilya@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.init=void 0,_pending=_interopRequireDefault(_pending),_custom_interaction_events=_interopRequireDefault(_custom_interaction_events),_modal_save_cancel=_interopRequireDefault(_modal_save_cancel),_templates=_interopRequireDefault(_templates),_modal_events=_interopRequireDefault(_modal_events),Str=function(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}newObj.default=obj,cache&&cache.set(obj,newObj);return newObj}(Str),_notification=_interopRequireDefault(_notification),_selectors=_interopRequireDefault(_selectors);_exports.init=()=>{const pendingPromise=new _pending.default;registerListenerEvents(),pendingPromise.resolve()};const registerListenerEvents=()=>{const events=["click",_custom_interaction_events.default.events.activate,_custom_interaction_events.default.events.keyboardActivate];_custom_interaction_events.default.define(document,events),events.forEach((event=>{document.addEventListener(event,(async e=>{const trigger=e.target.closest(_selectors.default.actions.bulkaction);if(trigger)if("overrideallgrades"===trigger.dataset.action||"overridenonegrades"===trigger.dataset.action){const override=document.querySelectorAll(_selectors.default.elements.override);"overridenonegrades"===trigger.dataset.action?Str.get_strings([{key:"removeoverride",component:"gradereport_singleview"},{key:"overridenoneconfirm",component:"gradereport_singleview"},{key:"removeoverridesave",component:"gradereport_singleview"},{key:"cancel",component:"moodle"}]).then((strings=>_notification.default.confirm(strings[0],strings[1],strings[2],strings[3],(()=>{override.forEach((el=>{el.checked&&el.click()}))})))).catch(_notification.default.exception):override.forEach((el=>{el.checked||el.click()}))}else if("excludeallgrades"===trigger.dataset.action||"excludenonegrades"===trigger.dataset.action){const exclude=document.querySelectorAll(_selectors.default.elements.exclude),checked="excludeallgrades"===trigger.dataset.action;exclude.forEach((el=>{el.checked=checked}))}else"bulklegend"===trigger.dataset.action&&Str.get_strings([{key:"bulklegend",component:"gradereport_singleview"},{key:"save",component:"moodle"}]).then((strings=>_modal_save_cancel.default.create({body:_templates.default.render("gradereport_singleview/bulkinsert",{id:"bulkinsertmodal",name:"bulkinsertmodal"}),title:strings[0],buttons:{save:strings[1]},removeOnClose:!0,show:!0}))).then((modal=>(modal.getFooter().find(_selectors.default.elements.modalsave).attr("disabled",!0),modal.getRoot().on("change",_selectors.default.elements.warningcheckbox,(e=>{if(e.preventDefault(),e.target.checked){modal.getRoot().find(_selectors.default.elements.modalformdata).removeClass("dimmed_text"),modal.getRoot().find(_selectors.default.elements.modalradio).removeAttr("disabled"),modal.getRoot().find(_selectors.default.elements.modalinput).removeAttr("disabled");modal.getRoot().find(_selectors.default.elements.modalradiochecked).val()&&modal.getFooter().find(_selectors.default.elements.modalsave).removeAttr("disabled")}else modal.getRoot().find(_selectors.default.elements.modalformdata).addClass("dimmed_text"),modal.getRoot().find(_selectors.default.elements.modalradio).attr("disabled",!0),modal.getRoot().find(_selectors.default.elements.modalinput).attr("disabled",!0),modal.getFooter().find(_selectors.default.elements.modalsave).attr("disabled",!0)})),modal.getRoot().on("change",_selectors.default.elements.modalradio,(e=>{e.preventDefault(),modal.getFooter().find(_selectors.default.elements.modalsave).removeAttr("disabled")})),modal.getRoot().on(_modal_events.default.save,(()=>{document.querySelector(_selectors.default.elements.enablebulkinsert).checked=!0;const formRadioData=modal.getRoot().find(_selectors.default.elements.modalradiochecked).val();document.querySelector(_selectors.default.elements.formradio).value=formRadioData;const formData=modal.getRoot().find(_selectors.default.elements.modalgrade).val();document.querySelector(_selectors.default.elements.formgrade).value=formData,document.querySelector(_selectors.default.elements.formsave).click()})),modal))).catch(_notification.default.exception)}))}))}})); //# sourceMappingURL=bulkactions.min.js.map report/singleview/amd/build/group.min.js 0000604 00000002264 15062070556 0014355 0 ustar 00 define("gradereport_singleview/group",["exports","core_group/comboboxsearch/group","core/url"],(function(_exports,_group,_url){function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}}function _defineProperty(obj,key,value){return key in obj?Object.defineProperty(obj,key,{value:value,enumerable:!0,configurable:!0,writable:!0}):obj[key]=value,obj}Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.default=void 0,_group=_interopRequireDefault(_group),_url=_interopRequireDefault(_url);class Group extends _group.default{constructor(item){super(),_defineProperty(this,"courseID",void 0),_defineProperty(this,"item",null),this.item=item,this.selectors={...this.selectors,courseid:'[data-region="courseid"]'};const component=document.querySelector(this.componentSelector());this.courseID=component.querySelector(this.selectors.courseid).dataset.courseid}static init(item){return new Group(item)}selectOneLink(groupID){return _url.default.relativeUrl("/grade/report/singleview/index.php",{id:this.courseID,groupsearchvalue:this.getSearchTerm(),group:groupID,item:this.item},!1)}}return _exports.default=Group,_exports.default})); //# sourceMappingURL=group.min.js.map report/singleview/amd/build/grade.min.js 0000604 00000002114 15062070556 0014275 0 ustar 00 define("gradereport_singleview/grade",["exports","core_grades/comboboxsearch/grade","core/url"],(function(_exports,_grade,_url){function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}}Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.default=void 0,_grade=_interopRequireDefault(_grade),_url=_interopRequireDefault(_url);const selectors_component=".grade-search",selectors_courseid='[data-region="courseid"]',component=document.querySelector(selectors_component);class GradeItems extends _grade.default{constructor(){var obj,key,value;super(),obj=this,key="courseID",value=component.querySelector(selectors_courseid).dataset.courseid,key in obj?Object.defineProperty(obj,key,{value:value,enumerable:!0,configurable:!0,writable:!0}):obj[key]=value}static init(){return new GradeItems}selectOneLink(gradeID){return _url.default.relativeUrl("/grade/report/singleview/index.php",{id:this.courseID,gradesearchvalue:this.getSearchTerm(),item:"grade",itemid:gradeID},!1)}}return _exports.default=GradeItems,_exports.default})); //# sourceMappingURL=grade.min.js.map report/singleview/amd/build/bulkactions.min.js.map 0000604 00000027147 15062070556 0016322 0 ustar 00 {"version":3,"file":"bulkactions.min.js","sources":["../src/bulkactions.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Javascript module for bulk actions.\n *\n * @module gradereport_singleview/bulkactions\n * @copyright 2022 Ilya Tregubov <ilya@moodle.com>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport Pending from 'core/pending';\nimport CustomEvents from \"core/custom_interaction_events\";\nimport ModalSaveCancel from 'core/modal_save_cancel';\nimport Templates from 'core/templates';\nimport ModalEvents from 'core/modal_events';\nimport * as Str from 'core/str';\nimport Notification from 'core/notification';\nimport selectors from 'gradereport_singleview/selectors';\n\n/**\n * Initialize module.\n */\nexport const init = () => {\n const pendingPromise = new Pending();\n registerListenerEvents();\n pendingPromise.resolve();\n};\n\n/**\n * Register bulk actions related event listeners.\n *\n * @method registerListenerEvents\n */\nconst registerListenerEvents = () => {\n const events = [\n 'click',\n CustomEvents.events.activate,\n CustomEvents.events.keyboardActivate\n ];\n CustomEvents.define(document, events);\n\n // Register events.\n events.forEach((event) => {\n document.addEventListener(event, async(e) => {\n const trigger = e.target.closest(selectors.actions.bulkaction);\n\n if (!trigger) {\n return;\n }\n if ((trigger.dataset.action === 'overrideallgrades') || (trigger.dataset.action === 'overridenonegrades')) {\n const override = document.querySelectorAll(selectors.elements.override);\n\n if (trigger.dataset.action === 'overridenonegrades') {\n // Alert for removing all grade overrides on page.\n Str.get_strings([\n {key: 'removeoverride', component: 'gradereport_singleview'},\n {key: 'overridenoneconfirm', component: 'gradereport_singleview'},\n {key: 'removeoverridesave', component: 'gradereport_singleview'},\n {key: 'cancel', component: 'moodle'},\n ])\n .then((strings) => {\n return Notification.confirm(\n strings[0],\n strings[1],\n strings[2],\n strings[3],\n () => {\n // Uncheck each override checkbox - this will make grade and feedback input fields disabled.\n override.forEach((el) => {\n if (el.checked) {\n el.click();\n }\n });\n });\n })\n .catch(Notification.exception);\n\n } else {\n // Check each override checkbox - this will make grade and feedback input fields enabled.\n override.forEach((el) => {\n if (!el.checked) {\n el.click();\n }\n });\n }\n } else if ((trigger.dataset.action === 'excludeallgrades') || (trigger.dataset.action === 'excludenonegrades')) {\n const exclude = document.querySelectorAll(selectors.elements.exclude);\n const checked = (trigger.dataset.action === 'excludeallgrades');\n // Uncheck or check each exclude checkbox.\n exclude.forEach((el) => {\n el.checked = checked;\n });\n } else if (trigger.dataset.action === 'bulklegend') {\n // Modal for bulk insert grades.\n Str.get_strings([\n {key: 'bulklegend', component: 'gradereport_singleview'},\n {key: 'save', component: 'moodle'},\n ])\n .then((strings) => {\n return ModalSaveCancel.create({\n body: Templates.render('gradereport_singleview/bulkinsert', {\n id: 'bulkinsertmodal',\n name: 'bulkinsertmodal'\n }),\n title: strings[0],\n buttons: {\n save: strings[1],\n },\n removeOnClose: true,\n show: true,\n });\n })\n .then((modal) => {\n modal.getFooter().find(selectors.elements.modalsave).attr('disabled', true);\n\n // We need to acknowledge that we understand risks of loosing data.\n // Only when acknowledge checkbox is checked we allow selecting insert options.\n modal.getRoot().on('change', selectors.elements.warningcheckbox,\n (e) => {\n e.preventDefault();\n if (e.target.checked) {\n modal.getRoot().find(selectors.elements.modalformdata).removeClass('dimmed_text');\n modal.getRoot().find(selectors.elements.modalradio).removeAttr('disabled');\n modal.getRoot().find(selectors.elements.modalinput).removeAttr('disabled');\n\n const formRadioData = modal.getRoot().find(selectors.elements.modalradiochecked).val();\n // We allow saving grades only when all needed data present on form.\n if (formRadioData) {\n modal.getFooter().find(selectors.elements.modalsave).removeAttr('disabled');\n }\n } else {\n modal.getRoot().find(selectors.elements.modalformdata).addClass('dimmed_text');\n modal.getRoot().find(selectors.elements.modalradio).attr('disabled', true);\n modal.getRoot().find(selectors.elements.modalinput).attr('disabled', true);\n modal.getFooter().find(selectors.elements.modalsave).attr('disabled', true);\n }\n });\n\n // We allow saving grades only when all needed data present on form.\n modal.getRoot().on('change', selectors.elements.modalradio, (e) => {\n e.preventDefault();\n modal.getFooter().find(selectors.elements.modalsave).removeAttr('disabled');\n });\n\n modal.getRoot().on(ModalEvents.save, () => {\n // When save button is clicked in modal form we insert data from modal\n // into preexisted hidden bulk insert form and Save button for table form.\n document.querySelector(selectors.elements.enablebulkinsert).checked = true;\n const formRadioData = modal.getRoot().find(selectors.elements.modalradiochecked).val();\n const $select = document.querySelector(selectors.elements.formradio);\n $select.value = formRadioData;\n\n const formData = modal.getRoot().find(selectors.elements.modalgrade).val();\n document.querySelector(selectors.elements.formgrade).value = formData;\n document.querySelector(selectors.elements.formsave).click();\n });\n\n return modal;\n })\n .catch(Notification.exception);\n }\n });\n });\n};\n"],"names":["pendingPromise","Pending","registerListenerEvents","resolve","events","CustomEvents","activate","keyboardActivate","define","document","forEach","event","addEventListener","async","trigger","e","target","closest","selectors","actions","bulkaction","dataset","action","override","querySelectorAll","elements","Str","get_strings","key","component","then","strings","Notification","confirm","el","checked","click","catch","exception","exclude","ModalSaveCancel","create","body","Templates","render","id","name","title","buttons","save","removeOnClose","show","modal","getFooter","find","modalsave","attr","getRoot","on","warningcheckbox","preventDefault","modalformdata","removeClass","modalradio","removeAttr","modalinput","modalradiochecked","val","addClass","ModalEvents","querySelector","enablebulkinsert","formRadioData","formradio","value","formData","modalgrade","formgrade","formsave"],"mappings":";;;;;;;gnCAmCoB,WACVA,eAAiB,IAAIC,iBAC3BC,yBACAF,eAAeG,iBAQbD,uBAAyB,WACrBE,OAAS,CACX,QACAC,mCAAaD,OAAOE,SACpBD,mCAAaD,OAAOG,qDAEXC,OAAOC,SAAUL,QAG9BA,OAAOM,SAASC,QACZF,SAASG,iBAAiBD,OAAOE,MAAAA,UACvBC,QAAUC,EAAEC,OAAOC,QAAQC,mBAAUC,QAAQC,eAE9CN,WAG2B,sBAA3BA,QAAQO,QAAQC,QAA+D,uBAA3BR,QAAQO,QAAQC,OAAkC,OACjGC,SAAWd,SAASe,iBAAiBN,mBAAUO,SAASF,UAE/B,uBAA3BT,QAAQO,QAAQC,OAEhBI,IAAIC,YAAY,CACZ,CAACC,IAAK,iBAAkBC,UAAW,0BACnC,CAACD,IAAK,sBAAuBC,UAAW,0BACxC,CAACD,IAAK,qBAAsBC,UAAW,0BACvC,CAACD,IAAK,SAAUC,UAAW,YAE9BC,MAAMC,SACIC,sBAAaC,QAChBF,QAAQ,GACRA,QAAQ,GACRA,QAAQ,GACRA,QAAQ,IACR,KAEIR,SAASb,SAASwB,KACVA,GAAGC,SACHD,GAAGE,gBAKtBC,MAAML,sBAAaM,WAIpBf,SAASb,SAASwB,KACTA,GAAGC,SACJD,GAAGE,gBAIZ,GAAgC,qBAA3BtB,QAAQO,QAAQC,QAA8D,sBAA3BR,QAAQO,QAAQC,OAAiC,OACtGiB,QAAU9B,SAASe,iBAAiBN,mBAAUO,SAASc,SACvDJ,QAAsC,qBAA3BrB,QAAQO,QAAQC,OAEjCiB,QAAQ7B,SAASwB,KACbA,GAAGC,QAAUA,eAEiB,eAA3BrB,QAAQO,QAAQC,QAEvBI,IAAIC,YAAY,CACZ,CAACC,IAAK,aAAcC,UAAW,0BAC/B,CAACD,IAAK,OAAQC,UAAW,YAE5BC,MAAMC,SACIS,2BAAgBC,OAAO,CAC1BC,KAAMC,mBAAUC,OAAO,oCAAqC,CACxDC,GAAI,kBACJC,KAAM,oBAEVC,MAAOhB,QAAQ,GACfiB,QAAS,CACLC,KAAMlB,QAAQ,IAElBmB,eAAe,EACfC,MAAM,MAGbrB,MAAMsB,QACHA,MAAMC,YAAYC,KAAKpC,mBAAUO,SAAS8B,WAAWC,KAAK,YAAY,GAItEJ,MAAMK,UAAUC,GAAG,SAAUxC,mBAAUO,SAASkC,iBAC3C5C,OACGA,EAAE6C,iBACE7C,EAAEC,OAAOmB,QAAS,CAClBiB,MAAMK,UAAUH,KAAKpC,mBAAUO,SAASoC,eAAeC,YAAY,eACnEV,MAAMK,UAAUH,KAAKpC,mBAAUO,SAASsC,YAAYC,WAAW,YAC/DZ,MAAMK,UAAUH,KAAKpC,mBAAUO,SAASwC,YAAYD,WAAW,YAEzCZ,MAAMK,UAAUH,KAAKpC,mBAAUO,SAASyC,mBAAmBC,OAG7Ef,MAAMC,YAAYC,KAAKpC,mBAAUO,SAAS8B,WAAWS,WAAW,iBAGpEZ,MAAMK,UAAUH,KAAKpC,mBAAUO,SAASoC,eAAeO,SAAS,eAChEhB,MAAMK,UAAUH,KAAKpC,mBAAUO,SAASsC,YAAYP,KAAK,YAAY,GACrEJ,MAAMK,UAAUH,KAAKpC,mBAAUO,SAASwC,YAAYT,KAAK,YAAY,GACrEJ,MAAMC,YAAYC,KAAKpC,mBAAUO,SAAS8B,WAAWC,KAAK,YAAY,MAKlFJ,MAAMK,UAAUC,GAAG,SAAUxC,mBAAUO,SAASsC,YAAahD,IACrDA,EAAE6C,iBACFR,MAAMC,YAAYC,KAAKpC,mBAAUO,SAAS8B,WAAWS,WAAW,eAGxEZ,MAAMK,UAAUC,GAAGW,sBAAYpB,MAAM,KAGjCxC,SAAS6D,cAAcpD,mBAAUO,SAAS8C,kBAAkBpC,SAAU,QAChEqC,cAAgBpB,MAAMK,UAAUH,KAAKpC,mBAAUO,SAASyC,mBAAmBC,MACjE1D,SAAS6D,cAAcpD,mBAAUO,SAASgD,WAClDC,MAAQF,oBAEVG,SAAWvB,MAAMK,UAAUH,KAAKpC,mBAAUO,SAASmD,YAAYT,MACrE1D,SAAS6D,cAAcpD,mBAAUO,SAASoD,WAAWH,MAAQC,SAC7DlE,SAAS6D,cAAcpD,mBAAUO,SAASqD,UAAU1C,WAGjDgB,SAEVf,MAAML,sBAAaM"} report/singleview/amd/build/selectors.min.js 0000604 00000001561 15062070556 0015223 0 ustar 00 define("gradereport_singleview/selectors",["exports"],(function(_exports){Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.default=void 0;var name,value,_default={actions:{bulkaction:(name="role",value="bulkaction","[data-".concat(name,'="').concat(value,'"]'))},elements:{override:"input[type=checkbox][name^=override]",exclude:"input[type=checkbox][name^=exclude]",modalsave:'[data-action="save"]',warningcheckbox:'input[type="checkbox"]',modalformdata:".formdata",modalradio:'input[type="radio"]',modalinput:'input[type="text"]',modalradiochecked:'input[type="radio"]:checked',enablebulkinsert:'input[type="checkbox"][name^=bulk]',formradio:"select[name^=bulk]",modalgrade:".form-control",formgrade:'input[type="text"][name^=bulk]',formsave:'input[type="submit"]'}};return _exports.default=_default,_exports.default})); //# sourceMappingURL=selectors.min.js.map report/singleview/amd/src/user.js 0000604 00000005317 15062070556 0013107 0 ustar 00 // 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/>. /** * Allow the user to search for learners within the singleview report. * * @module gradereport_singleview/user * @copyright 2023 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import UserSearch from 'core_user/comboboxsearch/user'; import Url from 'core/url'; import {renderForPromise, replaceNodeContents} from 'core/templates'; import * as Repository from 'core_grades/searchwidget/repository'; export default class User extends UserSearch { constructor() { super(); } static init() { return new User(); } /** * Build the content then replace the node. */ async renderDropdown() { const {html, js} = await renderForPromise('core_user/comboboxsearch/resultset', { users: this.getMatchedResults().slice(0, 5), hasresults: this.getMatchedResults().length > 0, searchterm: this.getSearchTerm(), }); replaceNodeContents(this.getHTMLElements().searchDropdown, html, js); } /** * Stub out default required function unused here. * @returns {null} */ selectAllResultsLink() { return null; } /** * Build up the view all link that is dedicated to a particular result. * * @param {Number} userID The ID of the user selected. * @returns {string|*} */ selectOneLink(userID) { return Url.relativeUrl('/grade/report/singleview/index.php', { id: this.courseID, searchvalue: this.getSearchTerm(), item: 'user', userid: userID, }, false); } /** * Get the data we will be searching against in this component. * * @returns {Promise<*>} */ fetchDataset() { // Small typing checks as sometimes groups don't exist therefore the element returns a empty string. const gts = typeof (this.groupID) === "string" && this.groupID === '' ? 0 : this.groupID; return Repository.userFetch(this.courseID, gts).then((r) => r.users); } } report/singleview/amd/src/bulkactions.js 0000604 00000020363 15062070556 0014445 0 ustar 00 // 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/>. /** * Javascript module for bulk actions. * * @module gradereport_singleview/bulkactions * @copyright 2022 Ilya Tregubov <ilya@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import Pending from 'core/pending'; import CustomEvents from "core/custom_interaction_events"; import ModalSaveCancel from 'core/modal_save_cancel'; import Templates from 'core/templates'; import ModalEvents from 'core/modal_events'; import * as Str from 'core/str'; import Notification from 'core/notification'; import selectors from 'gradereport_singleview/selectors'; /** * Initialize module. */ export const init = () => { const pendingPromise = new Pending(); registerListenerEvents(); pendingPromise.resolve(); }; /** * Register bulk actions related event listeners. * * @method registerListenerEvents */ const registerListenerEvents = () => { const events = [ 'click', CustomEvents.events.activate, CustomEvents.events.keyboardActivate ]; CustomEvents.define(document, events); // Register events. events.forEach((event) => { document.addEventListener(event, async(e) => { const trigger = e.target.closest(selectors.actions.bulkaction); if (!trigger) { return; } if ((trigger.dataset.action === 'overrideallgrades') || (trigger.dataset.action === 'overridenonegrades')) { const override = document.querySelectorAll(selectors.elements.override); if (trigger.dataset.action === 'overridenonegrades') { // Alert for removing all grade overrides on page. Str.get_strings([ {key: 'removeoverride', component: 'gradereport_singleview'}, {key: 'overridenoneconfirm', component: 'gradereport_singleview'}, {key: 'removeoverridesave', component: 'gradereport_singleview'}, {key: 'cancel', component: 'moodle'}, ]) .then((strings) => { return Notification.confirm( strings[0], strings[1], strings[2], strings[3], () => { // Uncheck each override checkbox - this will make grade and feedback input fields disabled. override.forEach((el) => { if (el.checked) { el.click(); } }); }); }) .catch(Notification.exception); } else { // Check each override checkbox - this will make grade and feedback input fields enabled. override.forEach((el) => { if (!el.checked) { el.click(); } }); } } else if ((trigger.dataset.action === 'excludeallgrades') || (trigger.dataset.action === 'excludenonegrades')) { const exclude = document.querySelectorAll(selectors.elements.exclude); const checked = (trigger.dataset.action === 'excludeallgrades'); // Uncheck or check each exclude checkbox. exclude.forEach((el) => { el.checked = checked; }); } else if (trigger.dataset.action === 'bulklegend') { // Modal for bulk insert grades. Str.get_strings([ {key: 'bulklegend', component: 'gradereport_singleview'}, {key: 'save', component: 'moodle'}, ]) .then((strings) => { return ModalSaveCancel.create({ body: Templates.render('gradereport_singleview/bulkinsert', { id: 'bulkinsertmodal', name: 'bulkinsertmodal' }), title: strings[0], buttons: { save: strings[1], }, removeOnClose: true, show: true, }); }) .then((modal) => { modal.getFooter().find(selectors.elements.modalsave).attr('disabled', true); // We need to acknowledge that we understand risks of loosing data. // Only when acknowledge checkbox is checked we allow selecting insert options. modal.getRoot().on('change', selectors.elements.warningcheckbox, (e) => { e.preventDefault(); if (e.target.checked) { modal.getRoot().find(selectors.elements.modalformdata).removeClass('dimmed_text'); modal.getRoot().find(selectors.elements.modalradio).removeAttr('disabled'); modal.getRoot().find(selectors.elements.modalinput).removeAttr('disabled'); const formRadioData = modal.getRoot().find(selectors.elements.modalradiochecked).val(); // We allow saving grades only when all needed data present on form. if (formRadioData) { modal.getFooter().find(selectors.elements.modalsave).removeAttr('disabled'); } } else { modal.getRoot().find(selectors.elements.modalformdata).addClass('dimmed_text'); modal.getRoot().find(selectors.elements.modalradio).attr('disabled', true); modal.getRoot().find(selectors.elements.modalinput).attr('disabled', true); modal.getFooter().find(selectors.elements.modalsave).attr('disabled', true); } }); // We allow saving grades only when all needed data present on form. modal.getRoot().on('change', selectors.elements.modalradio, (e) => { e.preventDefault(); modal.getFooter().find(selectors.elements.modalsave).removeAttr('disabled'); }); modal.getRoot().on(ModalEvents.save, () => { // When save button is clicked in modal form we insert data from modal // into preexisted hidden bulk insert form and Save button for table form. document.querySelector(selectors.elements.enablebulkinsert).checked = true; const formRadioData = modal.getRoot().find(selectors.elements.modalradiochecked).val(); const $select = document.querySelector(selectors.elements.formradio); $select.value = formRadioData; const formData = modal.getRoot().find(selectors.elements.modalgrade).val(); document.querySelector(selectors.elements.formgrade).value = formData; document.querySelector(selectors.elements.formsave).click(); }); return modal; }) .catch(Notification.exception); } }); }); }; report/singleview/amd/src/grade.js 0000604 00000003557 15062070556 0013217 0 ustar 00 // 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/>. /** * Allow the user to search for grades within the singleview report. * * @module gradereport_singleview/grade * @copyright 2023 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import GradeItemSearch from 'core_grades/comboboxsearch/grade'; import Url from 'core/url'; // Define our standard lookups. const selectors = { component: '.grade-search', courseid: '[data-region="courseid"]', }; const component = document.querySelector(selectors.component); export default class GradeItems extends GradeItemSearch { courseID = component.querySelector(selectors.courseid).dataset.courseid; constructor() { super(); } static init() { return new GradeItems(); } /** * Build up the link that is dedicated to a particular result. * * @param {Number} gradeID The ID of the grade item selected. * @returns {string|*} */ selectOneLink(gradeID) { return Url.relativeUrl('/grade/report/singleview/index.php', { id: this.courseID, gradesearchvalue: this.getSearchTerm(), item: 'grade', itemid: gradeID, }, false); } } report/singleview/amd/src/group.js 0000604 00000004340 15062070556 0013260 0 ustar 00 // 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/>. /** * Allow the user to search for groups within the singleview report. * * @module gradereport_singleview/group * @copyright 2023 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import GroupSearch from 'core_group/comboboxsearch/group'; import Url from 'core/url'; export default class Group extends GroupSearch { courseID; item = null; /** * Construct the class. * * @param {string} item The page type we are currently on. */ constructor(item) { super(); this.item = item; // Define our standard lookups. this.selectors = {...this.selectors, courseid: '[data-region="courseid"]', }; const component = document.querySelector(this.componentSelector()); this.courseID = component.querySelector(this.selectors.courseid).dataset.courseid; } /** * Allow the class to be invoked via PHP. * * @param {string} item The page type we are currently on. * @returns {Group} */ static init(item) { return new Group(item); } /** * Build up the view all link that is dedicated to a particular result. * * @param {Number} groupID The ID of the group selected. * @returns {string|*} */ selectOneLink(groupID) { return Url.relativeUrl('/grade/report/singleview/index.php', { id: this.courseID, groupsearchvalue: this.getSearchTerm(), group: groupID, item: this.item }, false); } } report/singleview/amd/src/selectors.js 0000604 00000003627 15062070556 0014136 0 ustar 00 // 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/>. /** * Define all of the selectors we will be using on the grading interface. * * @module gradereport_singleview/selectors * @copyright 2022 Ilya Tregubov <ilya@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ /** * A small helper function to build queryable data selectors. * @method getDataSelector * @param {String} name * @param {String} value * @return {string} */ const getDataSelector = (name, value) => { return `[data-${name}="${value}"]`; }; export default { actions: { bulkaction: getDataSelector('role', 'bulkaction'), }, elements: { override: 'input[type=checkbox][name^=override]', exclude: 'input[type=checkbox][name^=exclude]', modalsave: '[data-action="save"]', warningcheckbox: 'input[type="checkbox"]', modalformdata: '.formdata', modalradio: 'input[type="radio"]', modalinput: 'input[type="text"]', modalradiochecked: 'input[type="radio"]:checked', enablebulkinsert: 'input[type="checkbox"][name^=bulk]', formradio: 'select[name^=bulk]', modalgrade: '.form-control', formgrade: 'input[type="text"][name^=bulk]', formsave: 'input[type="submit"]', }, }; report/singleview/version.php 0000604 00000002101 15062070556 0012425 0 ustar 00 <?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/>. /** * Standard version file * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); $plugin->component = 'gradereport_singleview'; // Full name of the plugin (used for diagnostics). $plugin->version = 2023100900; $plugin->requires = 2023100400; report/singleview/db/services.php 0000604 00000002610 15062070556 0013155 0 ustar 00 <?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/>. /** * singleview grade report external functions and service definitions. * * @package gradereport_singleview * @copyright 2022 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die; $functions = [ 'gradereport_singleview_get_grade_items_for_search_widget' => [ 'methodname' => 'get_grade_items_for_search_widget', 'classname' => 'gradereport_singleview\\external\\singleview', 'description' => 'Get the gradeitem/(s) for a course', 'type' => 'read', 'ajax' => true, 'capabilities' => 'gradereport/singleview:view', 'services' => [MOODLE_OFFICIAL_MOBILE_SERVICE], ], ]; report/singleview/db/access.php 0000604 00000002301 15062070556 0012570 0 ustar 00 <?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/>. /** * The gradebook simple view - Database file * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ $capabilities = array( 'gradereport/singleview:view' => array( 'riskbitmask' => RISK_PERSONAL, 'captype' => 'read', 'contextlevel' => CONTEXT_COURSE, 'archetypes' => array( 'editingteacher' => CAP_ALLOW, 'manager' => CAP_ALLOW, ) ) ); report/singleview/renderer.php 0000604 00000015140 15062070556 0012555 0 ustar 00 <?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/>. /** * Renderer for the grade single view report. * * @package gradereport_singleview * @copyright 2022 Mihail Geshoski <mihail@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ use core\output\comboboxsearch; use gradereport_singleview\report\singleview; /** * Custom renderer for the single view report. * * To get an instance of this use the following code: * $renderer = $PAGE->get_renderer('gradereport_singleview'); * * @copyright 2022 Mihail Geshoski <mihail@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class gradereport_singleview_renderer extends plugin_renderer_base { /** * Renders the user selector trigger element. * * @param object $course The course object. * @param int|null $userid The user ID. * @param int|null $groupid The group ID. * @return string The raw HTML to render. */ public function users_selector(object $course, ?int $userid = null, ?int $groupid = null): string { $resetlink = new moodle_url('/grade/report/singleview/index.php', ['id' => $course->id, 'group' => $groupid ?? 0]); $data = [ 'currentvalue' => optional_param('searchvalue', '', PARAM_NOTAGS), 'courseid' => $course->id, 'group' => $groupid ?? 0, 'resetlink' => $resetlink->out(false), 'userid' => $userid ?? 0 ]; $dropdown = new comboboxsearch( true, $this->render_from_template('core_user/comboboxsearch/user_selector', $data), null, 'user-search dropdown d-flex', null, 'usersearchdropdown overflow-auto', null, false, ); return $this->render_from_template($dropdown->get_template(), $dropdown->export_for_template($this)); } /** * Renders the grade items selector trigger element. * * @param object $course The course object. * @param int|null $gradeitemid The grade item ID. * @return string The raw HTML to render. */ public function grade_items_selector(object $course, ?int $gradeitemid = null): string { $data = [ 'name' => 'itemid', 'courseid' => $course->id, ]; // If a particular grade item option is selected (not in zero state). if ($gradeitemid) { $gradeitemname = grade_item::fetch(['id' => $gradeitemid])->get_name(true); $data['selectedoption'] = [ 'text' => $gradeitemname, ]; $data['itemid'] = $gradeitemid; } $sbody = $this->render_from_template('core/local/comboboxsearch/searchbody', [ 'courseid' => $course->id, 'currentvalue' => optional_param('gradesearchvalue', '', PARAM_NOTAGS), ]); $dropdown = new comboboxsearch( false, $this->render_from_template('gradereport_singleview/grade_item_selector', $data), $sbody, 'grade-search h-100', 'gradesearchwidget h-100', 'gradesearchdropdown overflow-auto w-100', ); return $this->render_from_template($dropdown->get_template(), $dropdown->export_for_template($this)); } /** * Creates and renders previous/next user/grade item navigation. * * @param object $gpr grade plugin return tracking object * @param int $courseid The course ID. * @param \context_course $context Context of the report. * @param singleview $report The single view report class. * @param int|null $groupid Group ID * @param string $itemtype User or Grade item type * @param int $itemid Either User ID or Grade item ID * @return string The raw HTML to render. * @throws moodle_exception */ public function report_navigation(object $gpr, int $courseid, \context_course $context, singleview $report, ?int $groupid, string $itemtype, int $itemid): string { $navigation = ''; $options = $report->screen->options(); $optionkeys = array_keys($options); $optionitemid = array_shift($optionkeys); $relreport = new gradereport_singleview\report\singleview( $courseid, $gpr, $context, $report->screen->item_type(), $optionitemid ); $reloptions = $relreport->screen->options(); $reloptionssorting = array_keys($relreport->screen->options()); $i = array_search($itemid, $reloptionssorting); $navparams = ['item' => $itemtype, 'id' => $courseid, 'group' => $groupid]; // Determine directionality so that icons can be modified to suit language. $previousarrow = right_to_left() ? 'right' : 'left'; $nextarrow = right_to_left() ? 'left' : 'right'; if ($i > 0) { $navparams['itemid'] = $reloptionssorting[$i - 1]; $link = (new moodle_url('/grade/report/singleview/index.php', $navparams)) ->out(false); $navigationdata['previoususer'] = [ 'name' => $reloptions[$navparams['itemid']], 'url' => $link, 'previousarrow' => $previousarrow ]; } if ($i < count($reloptionssorting) - 1) { $navparams['itemid'] = $reloptionssorting[$i + 1]; $link = (new moodle_url('/grade/report/singleview/index.php', $navparams)) ->out(false); $navigationdata['nextuser'] = [ 'name' => $reloptions[$navparams['itemid']], 'url' => $link, 'nextarrow' => $nextarrow ]; } if ($report->screen->supports_paging()) { $navigationdata['perpageselect'] = $report->screen->perpage_select(); } if (isset($navigationdata)) { $navigation = $this->render_from_template('gradereport_singleview/report_navigation', $navigationdata); } return $navigation; } } report/singleview/index.php 0000604 00000022753 15062070556 0012066 0 ustar 00 <?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/>. /** * Displays the Single view * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ define('NO_OUTPUT_BUFFERING', true); require_once('../../../config.php'); require_once($CFG->dirroot.'/lib/gradelib.php'); require_once($CFG->dirroot.'/grade/lib.php'); $courseid = required_param('id', PARAM_INT); $groupid = optional_param('group', null, PARAM_INT); // Making this work with profile reports. $userid = optional_param('userid', null, PARAM_INT); $itemid = optional_param('itemid', null, PARAM_INT); $itemtype = optional_param('item', null, PARAM_TEXT); $page = optional_param('page', 0, PARAM_INT); $perpage = optional_param('perpage', null, PARAM_INT); $edit = optional_param('edit', -1, PARAM_BOOL); // Sticky editing mode. $courseparams = ['id' => $courseid]; $PAGE->set_pagelayout('report'); $PAGE->set_other_editing_capability('moodle/grade:edit'); if (!$course = $DB->get_record('course', $courseparams)) { throw new \moodle_exception('invalidcourseid'); } require_login($course); $context = context_course::instance($course->id); // This is the normal requirements. require_capability('gradereport/singleview:view', $context); require_capability('moodle/grade:viewall', $context); require_capability('moodle/grade:edit', $context); $gpr = new grade_plugin_return([ 'type' => 'report', 'plugin' => 'singleview', 'courseid' => $courseid ]); // Last selected report session tracking. if (!isset($USER->grade_last_report)) { $USER->grade_last_report = []; } $USER->grade_last_report[$course->id] = 'singleview'; // If the item type is not explicitly defined or not valid, try to use the last viewed one (obtain in from the session) // or fallback to the user select (zero) state. if (!$itemtype || !in_array($itemtype, \gradereport_singleview\report\singleview::valid_screens())) { $itemtype = isset($SESSION->gradereport_singleview["itemtype-{$context->id}"]) ? $SESSION->gradereport_singleview["itemtype-{$context->id}"] : 'user_select'; } $currentgroup = $gpr->groupid; // To make some other functions work better later. if (!$currentgroup) { $currentgroup = null; } $lastvieweduseritemid = $SESSION->gradereport_singleview["useritem-{$context->id}"] ?? null; $lastviewedgradeitemid = $SESSION->gradereport_singleview["gradeitem-{$context->id}"] ?? null; switch ($itemtype) { case 'user_select': // If there is a stored user item (last viewed) in a session variable, bypass the user select zero state // and display this user item. Also, make sure that the stored last viewed user is part of the current // list of gradable users in this course. if ($lastvieweduseritemid && array_key_exists($lastvieweduseritemid, get_gradable_users($courseid, $currentgroup))) { $itemtype = 'user'; $itemid = $lastvieweduseritemid; } else { $itemid = null; } break; case 'user': if (is_null($itemid)) { $itemid = $userid ?? $lastvieweduseritemid; } // If the item id (user id) cannot be defined or the user id is not part of the list of gradable users, // display the user select zero state. if (is_null($itemid) || !array_key_exists($itemid, get_gradable_users($courseid, $currentgroup))) { $itemtype = 'user_select'; } break; case 'grade_select': // If there is a stored grade item (last viewed) in a session variable, bypass the grade item select zero state // and display this grade item. if ($lastviewedgradeitemid) { $itemtype = 'grade'; $itemid = $lastviewedgradeitemid; } else { $itemid = null; } break; case 'grade': // If there is a stored grade item (last viewed) in a session variable, use it. if (is_null($itemid) && $lastviewedgradeitemid) { $itemid = $lastviewedgradeitemid; } $gtree = new grade_tree($courseid, false, false, null, !$CFG->enableoutcomes); $gradeableitems = $gtree->get_items(); // The item id (grade item id) cannot be defined, display the grade select zero state. if (is_null($itemid) || !array_key_exists($itemid, $gtree->get_items())) { $itemtype = 'grade_select'; } break; } $report = new gradereport_singleview\report\singleview($courseid, $gpr, $context, $itemtype, $itemid); $pageparams = [ 'id' => $courseid, 'userid' => $userid, 'itemid' => $itemid, 'item' => $itemtype, 'page' => $page, 'perpage' => $perpage, ]; if (!is_null($groupid)) { $pageparams['group'] = $groupid; } $PAGE->set_url(new moodle_url('/grade/report/singleview/index.php', $pageparams)); // Build editing on/off button for themes that need it. $button = ''; if ($PAGE->user_allowed_editing() && !$PAGE->theme->haseditswitch) { if ($edit != - 1) { $USER->editing = $edit; } // Page params for the turn editing on button. $options = $gpr->get_options(); $button = $OUTPUT->edit_button(new moodle_url($PAGE->url, $options), 'get'); } $reportname = $report->screen->heading(); if ($itemtype == 'user' || $itemtype == 'user_select') { $PAGE->requires->js_call_amd('gradereport_singleview/user', 'init'); $actionbar = new \gradereport_singleview\output\action_bar($context, $report, 'user'); } else if ($itemtype == 'grade' || $itemtype == 'grade_select') { $PAGE->requires->js_call_amd('gradereport_singleview/grade', 'init'); $actionbar = new \gradereport_singleview\output\action_bar($context, $report, 'grade'); } else { $actionbar = new \core_grades\output\general_action_bar($context, new moodle_url('/grade/report/singleview/index.php', ['id' => $courseid]), 'report', 'singleview'); } if ($course->groupmode && $itemtype !== 'select') { $PAGE->requires->js_call_amd('gradereport_singleview/group', 'init', [$itemtype]); } if ($itemtype == 'user') { print_grade_page_head($course->id, 'report', 'singleview', $reportname, false, $button, true, null, null, $report->screen->item, $actionbar); } else { print_grade_page_head($course->id, 'report', 'singleview', $reportname, false, $button, true, null, null, null, $actionbar); } if ($data = data_submitted()) { // Must have a sesskey for all actions. require_sesskey(); $result = $report->process_data($data); // If result is not null (because somedata was processed), warnings and success message should be displayed. if (!is_null($result)) { if (!empty($result->warnings)) { foreach ($result->warnings as $warning) { \core\notification::add($warning); } } // And notify the user of the success result. \core\notification::add( get_string('savegradessuccess', 'gradereport_singleview', count((array) $result->changecount)), \core\notification::SUCCESS ); } } // Make sure we have proper final grades. grade_regrade_final_grades_if_required($course); // Save the screen state in a session variable as last viewed state. $SESSION->gradereport_singleview["itemtype-{$context->id}"] = $itemtype; if ($itemid) { $SESSION->gradereport_singleview["{$itemtype}item-{$context->id}"] = $itemid; } $stickyfooter = ''; if (($itemtype !== 'select') && ($itemtype !== 'grade_select') &&($itemtype !== 'user_select')) { $item = (isset($userid)) ? $userid : $itemid; $defaultgradeshowactiveenrol = !empty($CFG->grade_report_showonlyactiveenrol); $showonlyactiveenrol = get_user_preferences('grade_report_showonlyactiveenrol', $defaultgradeshowactiveenrol); $showonlyactiveenrol = $showonlyactiveenrol || !has_capability('moodle/course:viewsuspendedusers', $context); $gui = new graded_users_iterator($course, null, $currentgroup); $gui->require_active_enrolment($showonlyactiveenrol); $gui->init(); $userreportrenderer = $PAGE->get_renderer('gradereport_singleview'); // Add previous/next user navigation. $footercontent = $userreportrenderer->report_navigation($gpr, $courseid, $context, $report, $groupid, $itemtype, $itemid); $buttonhtml = implode(' ', $report->screen->buttons($report->screen->is_readonly())); $footercontent .= $report->screen->bulk_insert() . $buttonhtml; $stickyfooter = new core\output\sticky_footer($footercontent); $stickyfooter = $OUTPUT->render($stickyfooter); } echo $OUTPUT->render_from_template('gradereport_singleview/report', [ 'table' => $report->output(), 'stickyfooter' => $stickyfooter, 'sesskey' => sesskey() ]); $event = \gradereport_singleview\event\grade_report_viewed::create( [ 'context' => $context, 'courseid' => $courseid, 'relateduserid' => $USER->id, ] ); $event->trigger(); echo $OUTPUT->footer(); report/singleview/pix/zero_state.svg 0000604 00000022607 15062070556 0013744 0 ustar 00 <svg width="109" height="132" viewBox="0 0 109 132" fill="none" xmlns="http://www.w3.org/2000/svg" preserveAspectRatio="xMinYMid meet"> <path d="M54.54 2.29492e-05C43.7604 -0.00986828 33.22 3.17783 24.2524 9.15969C15.2847 15.1416 8.29284 23.6488 4.16124 33.6052C0.0296474 43.5617 -1.056 54.5199 1.04167 65.0935C3.13934 75.6671 8.32603 85.381 15.9456 93.0061C23.5652 100.631 33.2752 105.825 43.8473 107.931C54.4193 110.036 65.3783 108.958 75.3378 104.834C85.2973 100.71 93.8098 93.7242 99.7982 84.761C105.787 75.7978 108.982 65.2597 108.98 54.48C108.98 40.0379 103.246 26.1868 93.0373 15.971C82.829 5.75514 68.9821 0.0106265 54.54 2.29492e-05ZM54.54 92.24C47.0714 92.242 39.7699 90.0292 33.5589 85.8812C27.348 81.7333 22.5067 75.8366 19.6472 68.937C16.7877 62.0375 16.0385 54.4449 17.4944 47.1195C18.9502 39.7941 22.5457 33.0651 27.8262 27.7832C33.1066 22.5014 39.8347 18.9041 47.1597 17.4463C54.4847 15.9885 62.0775 16.7357 68.9778 19.5934C75.8782 22.4511 81.7761 27.2908 85.9256 33.5006C90.0752 39.7104 92.29 47.0114 92.29 54.48C92.2913 59.4382 91.3159 64.3483 89.4194 68.9295C87.5228 73.5107 84.7424 77.6734 81.2369 81.1798C77.7313 84.6863 73.5693 87.4678 68.9886 89.3655C64.4079 91.2632 59.4983 92.24 54.54 92.24Z" fill="#C4E5FF"/> <path d="M54.5391 0V16.72C64.5519 16.7226 74.1538 20.7021 81.233 27.7832C88.3122 34.8643 92.2891 44.4671 92.2891 54.48H108.979C108.979 40.0379 103.245 26.1868 93.0364 15.9709C82.828 5.75511 68.9811 0.0106036 54.5391 0Z" fill="#85CAFF"/> <path d="M18.8507 66.8201C16.886 61.1315 16.3092 55.0558 17.1681 49.0991C18.0271 43.1425 20.2971 37.4773 23.789 32.5756C27.2808 27.6739 31.8934 23.6776 37.2425 20.9196C42.5917 18.1616 48.5224 16.7217 54.5407 16.72V8.99755e-07C45.8564 -0.00157725 37.2975 2.07289 29.5776 6.05054C21.8578 10.0282 15.2006 15.7938 10.1613 22.8665C5.12197 29.9391 1.84642 38.114 0.607778 46.7096C-0.63086 55.3052 0.203305 64.0723 3.0407 72.28L18.8507 66.8201Z" fill="#0056B2"/> <path d="M38.7519 49.2401C43.7666 49.2401 47.8319 45.1748 47.8319 40.1601C47.8319 35.1453 43.7666 31.0801 38.7519 31.0801C33.7371 31.0801 29.6719 35.1453 29.6719 40.1601C29.6719 45.1748 33.7371 49.2401 38.7519 49.2401Z" fill="#85CAFF"/> <path d="M74.8719 55.3203H34.2119C31.7045 55.3203 29.6719 57.353 29.6719 59.8604C29.6719 62.3677 31.7045 64.4003 34.2119 64.4003H74.8719C77.3792 64.4003 79.4119 62.3677 79.4119 59.8604C79.4119 57.353 77.3792 55.3203 74.8719 55.3203Z" fill="#85CAFF"/> <path d="M74.8719 70.1504H34.2119C31.7045 70.1504 29.6719 72.183 29.6719 74.6904C29.6719 77.1977 31.7045 79.2304 34.2119 79.2304H74.8719C77.3792 79.2304 79.4119 77.1977 79.4119 74.6904C79.4119 72.183 77.3792 70.1504 74.8719 70.1504Z" fill="#C4E5FF"/> <path d="M76.9799 41.5205H55.7698C54.4278 41.5205 53.3398 42.6084 53.3398 43.9505V43.9605C53.3398 45.3026 54.4278 46.3905 55.7698 46.3905H76.9799C78.3219 46.3905 79.4099 45.3026 79.4099 43.9605V43.9505C79.4099 42.6084 78.3219 41.5205 76.9799 41.5205Z" fill="#85CAFF"/> <path d="M65.4499 33.5205H55.7698C54.4278 33.5205 53.3398 34.6084 53.3398 35.9505V35.9605C53.3398 37.3026 54.4278 38.3905 55.7698 38.3905H65.4499C66.7919 38.3905 67.8799 37.3026 67.8799 35.9605V35.9505C67.8799 34.6084 66.7919 33.5205 65.4499 33.5205Z" fill="#85CAFF"/> <path d="M90.2096 91.0605C89.8473 90.6761 89.408 90.3723 88.9204 90.1689C88.4328 89.9656 87.9078 89.8673 87.3797 89.8805C86.3275 89.8936 85.3228 90.3209 84.5835 91.0696C83.8441 91.8183 83.4296 92.8282 83.4297 93.8805V95.0005H82.2997V90.6005C82.3027 89.6738 81.9886 88.7741 81.4096 88.0505C80.8592 87.3125 80.0534 86.8062 79.1496 86.6305C78.8818 86.5869 78.611 86.5635 78.3396 86.5605C77.2891 86.5604 76.2806 86.9736 75.5322 87.7108C74.7838 88.448 74.3554 89.4501 74.3396 90.5005V95.0105H73.2096V90.7205C73.2276 89.5646 72.8181 88.4429 72.0597 87.5706C71.704 87.1312 71.2625 86.7689 70.7622 86.5059C70.2619 86.2428 69.7132 86.0845 69.1496 86.0405C68.9968 86.0228 68.8425 86.0228 68.6897 86.0405C67.4935 86.0405 66.3464 86.5157 65.5006 87.3615C64.6548 88.2072 64.1797 89.3544 64.1797 90.5505V95.0505H63.0497V80.6305V64.8304C63.062 63.957 62.788 63.1036 62.2696 62.4005C62.1514 62.2436 62.0245 62.0934 61.8896 61.9506C61.2202 61.2652 60.3165 60.858 59.3597 60.8105H58.8296C58.2565 60.8347 57.6968 60.9907 57.1938 61.2665C56.6909 61.5422 56.2583 61.9303 55.9297 62.4005C55.4113 63.1036 55.1373 63.957 55.1496 64.8304V91.4805C55.1541 91.5437 55.1541 91.6073 55.1496 91.6705V106.771L54.0196 105.771V99.7104C54.0306 99.1811 53.9364 98.6549 53.7424 98.1622C53.5484 97.6696 53.2586 97.2202 52.8896 96.8405C52.5246 96.4594 52.0849 96.158 51.5979 95.955C51.1109 95.7519 50.5872 95.6517 50.0597 95.6605C49.5401 95.6593 49.0254 95.7622 48.5462 95.9631C48.0671 96.1641 47.633 96.459 47.2696 96.8304C46.897 97.1903 46.6019 97.6226 46.4024 98.1007C46.203 98.5788 46.1033 99.0925 46.1097 99.6105V107.5C46.1104 108.041 46.2206 108.576 46.4338 109.073C46.6469 109.569 46.9584 110.018 47.3497 110.391L58.3497 120.791C58.8118 121.264 59.1726 121.826 59.4099 122.443C59.6472 123.061 59.756 123.72 59.7297 124.38C59.7449 124.974 59.9883 125.539 60.4091 125.958C60.8299 126.377 61.396 126.618 61.9897 126.63H84.5896C84.8847 126.632 85.177 126.574 85.4487 126.458C85.7204 126.343 85.9657 126.174 86.1697 125.96C86.3838 125.757 86.5539 125.512 86.6692 125.24C86.7844 124.968 86.8424 124.676 86.8396 124.38V123.5C86.835 122.582 86.9528 121.668 87.1897 120.781L90.9897 105.431C91.226 104.55 91.3437 103.642 91.3396 102.73V94.0706C91.3698 93.518 91.2849 92.9651 91.0904 92.447C90.8959 91.9289 90.596 91.4568 90.2096 91.0605Z" fill="white"/> <path d="M95.8601 93.9202C95.8729 92.8045 95.6597 91.6978 95.2335 90.6666C94.8073 89.6355 94.1769 88.7013 93.3801 87.9202C92.6096 87.1075 91.678 86.4644 90.6449 86.0322C89.6118 85.6 88.4998 85.3882 87.3801 85.4102C86.8867 85.6145 86.356 85.7131 85.8221 85.6996C85.2882 85.6861 84.763 85.5609 84.2806 85.3319C83.7981 85.1029 83.3691 84.7753 83.0211 84.3702C82.673 83.9652 82.4138 83.4916 82.2601 82.9801C81.0517 82.3394 79.7077 81.9966 78.3401 81.9801C76.8096 81.9761 75.3078 82.3949 74.0001 83.1902C72.4951 82.0277 70.6417 81.4075 68.7401 81.4302C68.366 81.4294 67.9921 81.4494 67.6201 81.4901V64.7301C67.6306 63.6147 67.4164 62.5087 66.9903 61.4779C66.5642 60.4471 65.935 59.5126 65.1401 58.7301C64.0823 57.6274 62.7335 56.8472 61.2501 56.4801H61.0801L60.4901 56.3801H60.1401C59.8378 56.3482 59.5341 56.3315 59.2301 56.3301H59.0801C58.7794 56.3312 58.4791 56.348 58.1801 56.3801H57.8301L57.2401 56.4801H57.0601C55.573 56.8449 54.2203 57.6253 53.1601 58.7301C52.3684 59.5144 51.7419 60.4496 51.3177 61.4801C50.8934 62.5106 50.6801 63.6157 50.6901 64.7301V91.0502C50.5071 91.0363 50.3231 91.0363 50.1401 91.0502C47.8978 91.0581 45.7496 91.9516 44.1631 93.5361C42.5767 95.1207 41.6806 97.2679 41.6701 99.5101V107.4C41.6624 108.557 41.8979 109.702 42.3613 110.761C42.8247 111.821 43.5057 112.771 44.3601 113.55L55.2401 123.96C55.2039 125.813 55.8928 127.607 57.1601 128.96C57.7745 129.635 58.5281 130.169 59.3689 130.525C60.2097 130.881 61.1176 131.05 62.0301 131.02H84.6201C85.5103 131.024 86.3924 130.852 87.2156 130.513C88.0387 130.174 88.7866 129.676 89.4161 129.046C90.0455 128.417 90.5441 127.669 90.8829 126.846C91.2217 126.022 91.394 125.14 91.3901 124.25C91.366 123.412 91.4364 122.573 91.6001 121.75L95.4301 106.4C95.7275 105.155 95.8818 103.88 95.8901 102.6L95.8601 93.9202ZM90.9801 105.29L87.1801 120.64C86.9432 121.527 86.8255 122.442 86.8301 123.36V124.24C86.8329 124.535 86.7749 124.828 86.6596 125.1C86.5443 125.372 86.3743 125.617 86.1601 125.82C85.9561 126.033 85.7108 126.203 85.4391 126.318C85.1675 126.433 84.8752 126.492 84.5801 126.49H61.9801C61.3864 126.477 60.8204 126.237 60.3995 125.818C59.9787 125.399 59.7354 124.834 59.7201 124.24C59.7464 123.579 59.6376 122.92 59.4003 122.303C59.163 121.686 58.8023 121.123 58.3401 120.65L47.3401 110.25C46.9489 109.877 46.6373 109.429 46.4242 108.932C46.2111 108.435 46.1008 107.901 46.1001 107.36V99.4701C46.0938 98.9521 46.1934 98.4384 46.3929 97.9603C46.5924 97.4823 46.8875 97.05 47.2601 96.6902C47.6235 96.3187 48.0575 96.0237 48.5367 95.8228C49.0159 95.6218 49.5305 95.5189 50.0501 95.5201C50.5777 95.5113 51.1013 95.6115 51.5883 95.8146C52.0753 96.0176 52.5151 96.3192 52.8801 96.7002C53.2491 97.08 53.5389 97.5292 53.7328 98.0219C53.9268 98.5145 54.0211 99.0408 54.0101 99.5702V105.63L55.1401 106.63V91.5302C55.1446 91.4669 55.1446 91.4033 55.1401 91.3401V64.6902C55.1278 63.8167 55.4017 62.9632 55.9201 62.2601C56.2487 61.79 56.6813 61.4019 57.1843 61.1261C57.6872 60.8503 58.247 60.6944 58.8201 60.6702H59.3501C60.307 60.7176 61.2107 61.1248 61.8801 61.8102C62.015 61.953 62.1419 62.1032 62.2601 62.2601C62.7785 62.9632 63.0524 63.8167 63.0401 64.6902V80.4901V94.9102H64.1701V90.4102C64.1701 89.214 64.6452 88.0669 65.491 87.2211C66.3368 86.3753 67.484 85.9001 68.6801 85.9001C68.8329 85.8825 68.9873 85.8825 69.1401 85.9001C69.7036 85.9441 70.2524 86.1024 70.7527 86.3655C71.253 86.6285 71.6945 86.9908 72.0501 87.4302C72.8085 88.3026 73.218 89.4242 73.2001 90.5801V94.8701H74.3301V90.3601C74.3458 89.3097 74.7743 88.3077 75.5227 87.5704C76.2711 86.8332 77.2795 86.42 78.3301 86.4202C78.6015 86.4231 78.8722 86.4465 79.1401 86.4901C80.0438 86.6658 80.8497 87.1721 81.4001 87.9102C81.9791 88.6337 82.2931 89.5334 82.2901 90.4601V94.8601H83.4201V93.7401C83.42 92.6879 83.8345 91.6779 84.5739 90.9292C85.3133 90.1805 86.3179 89.7533 87.3701 89.7401C87.8983 89.7269 88.4232 89.8252 88.9108 90.0286C89.3984 90.2319 89.8377 90.5357 90.2001 90.9202C90.569 91.2999 90.8589 91.7492 91.0529 92.2418C91.2468 92.7345 91.341 93.2608 91.3301 93.7902V102.45C91.3469 103.409 91.2291 104.365 90.9801 105.29Z" fill="#0056B2"/> </svg> report/singleview/pix/zero_state_user.svg 0000604 00000037301 15062070556 0014777 0 ustar 00 <svg width="147" height="122" viewBox="0 0 147 122" fill="none" xmlns="http://www.w3.org/2000/svg" preserveAspectRatio="xMinYMid meet"> <path d="M54.47 9.67969C43.6953 9.68167 33.1631 12.8785 24.2053 18.8661C15.2474 24.8536 8.26617 33.363 4.14424 43.3181C0.0223103 53.2731 -1.0552 64.2269 1.04805 74.7944C3.1513 85.3618 8.34084 95.0682 15.9604 102.686C23.58 110.305 33.2874 115.492 43.8552 117.594C54.423 119.695 65.3767 118.615 75.331 114.492C85.2853 110.368 93.7934 103.385 99.7793 94.4261C105.765 85.4672 108.96 74.9344 108.96 64.1597C108.96 57.0045 107.551 49.9192 104.812 43.3088C102.074 36.6983 98.0597 30.6921 92.9997 25.633C87.9397 20.5739 81.9327 16.5611 75.3217 13.8239C68.7108 11.0866 61.6253 9.67838 54.47 9.67969Z" fill="#C4E5FF"/> <path d="M38.0894 62.8701C46.9149 62.8701 54.0694 55.7156 54.0694 46.8901C54.0694 38.0646 46.9149 30.9102 38.0894 30.9102C29.2639 30.9102 22.1094 38.0646 22.1094 46.8901C22.1094 55.7156 29.2639 62.8701 38.0894 62.8701Z" fill="#85CAFF"/> <path d="M49.5087 56.3195C49.5087 56.2095 49.4387 56.0995 49.4087 55.9995V55.9295C49.4087 55.8295 49.3387 55.7295 49.2987 55.6395L49.1487 55.3295L48.9987 55.0795C48.8888 54.91 48.7614 54.7524 48.6187 54.6095L48.4187 54.4195C48.2671 54.2917 48.1066 54.1747 47.9386 54.0695C47.8578 54.01 47.7706 53.9597 47.6786 53.9195C46.8756 53.539 46.0245 53.2699 45.1487 53.1195C43.6387 52.8095 41.5886 51.3395 41.3586 50.4195C41.3259 50.025 41.3816 49.6282 41.5217 49.258C41.6619 48.8878 41.883 48.5535 42.1687 48.2795C42.2487 48.1795 42.3187 48.0895 42.3787 47.9995L42.4386 47.9195C43.0857 47.064 43.5087 46.0602 43.6687 44.9995C43.6687 44.9095 43.6687 44.8195 43.6687 44.7295C43.9683 43.1826 43.9273 41.589 43.5487 40.0595C43.2491 39.0602 42.6596 38.1723 41.855 37.5083C41.0503 36.8443 40.0667 36.434 39.0287 36.3295H38.8887C38.6522 36.3146 38.415 36.3146 38.1786 36.3295C37.9421 36.315 37.7051 36.315 37.4686 36.3295H37.2386C36.2002 36.4328 35.216 36.8425 34.4111 37.5067C33.6063 38.1709 33.0171 39.0595 32.7186 40.0595C32.3352 41.5883 32.2942 43.183 32.5986 44.7295C32.5986 44.8195 32.5986 44.9095 32.5986 44.9995C32.7635 46.0588 33.1858 47.0615 33.8286 47.9195L33.8887 47.9995L34.0986 48.2795C34.3861 48.5522 34.6083 48.8863 34.7485 49.2568C34.8888 49.6274 34.9436 50.0248 34.9087 50.4195C34.6887 51.3395 32.6387 52.8095 31.1187 53.1195C30.2457 53.2683 29.3976 53.5375 28.5986 53.9195C28.5078 53.9619 28.4208 54.0121 28.3386 54.0695C28.1706 54.1747 28.0102 54.2917 27.8586 54.4195L27.6587 54.6095C27.5189 54.755 27.3917 54.9123 27.2787 55.0795L27.1287 55.3295L26.9786 55.6395L26.8586 55.9295V55.9995C26.8194 56.1042 26.786 56.2111 26.7587 56.3195C26.7587 56.3795 26.3987 57.5795 26.3887 57.6495C27.882 59.2801 29.6982 60.5821 31.7219 61.4729C33.7456 62.3637 35.9326 62.8237 38.1437 62.8237C40.3548 62.8237 42.5416 62.3637 44.5653 61.4729C46.589 60.5821 48.4053 59.2801 49.8987 57.6495C49.8987 57.5895 49.5786 56.3495 49.5686 56.2895L49.5087 56.3195Z" fill="white"/> <path d="M38.0894 99.5498C46.9149 99.5498 54.0694 92.3953 54.0694 83.5698C54.0694 74.7443 46.9149 67.5898 38.0894 67.5898C29.2639 67.5898 22.1094 74.7443 22.1094 83.5698C22.1094 92.3953 29.2639 99.5498 38.0894 99.5498Z" fill="#85CAFF"/> <path d="M49.5087 92.9604C49.5087 92.8504 49.4387 92.7504 49.4087 92.6404V92.5704C49.4087 92.4704 49.3387 92.3704 49.2987 92.2804C49.2987 92.1804 49.1987 92.0704 49.1487 91.9804L48.9987 91.7304V91.6804C48.8888 91.5109 48.7614 91.3534 48.6187 91.2104C48.5569 91.1421 48.4901 91.0785 48.4187 91.0204C48.2673 90.8894 48.1068 90.7691 47.9386 90.6604L47.6786 90.5104C46.875 90.1335 46.024 89.8677 45.1487 89.7204C43.6387 89.4004 41.5886 87.9304 41.3586 87.0104C41.3273 86.616 41.3838 86.2196 41.5238 85.8496C41.6638 85.4796 41.8841 85.1452 42.1687 84.8704C42.245 84.782 42.3152 84.6885 42.3787 84.5904L42.4386 84.5204C43.0829 83.6595 43.5054 82.6533 43.6687 81.5904C43.6687 81.5104 43.6687 81.4104 43.6687 81.3204C43.9681 79.7701 43.9272 78.1733 43.5487 76.6404C43.2498 75.6416 42.6602 74.7545 41.8552 74.092C41.0502 73.4294 40.0663 73.0216 39.0287 72.9204H38.8887C38.6522 72.9054 38.415 72.9054 38.1786 72.9204C37.9421 72.9057 37.7051 72.9057 37.4686 72.9204H37.2386C36.2006 73.0203 35.216 73.4277 34.4108 74.0904C33.6056 74.7531 33.0163 75.641 32.7186 76.6404C32.3353 78.1727 32.2943 79.7705 32.5986 81.3204C32.5986 81.4104 32.5986 81.5104 32.5986 81.5904C32.7662 82.652 33.1882 83.6573 33.8286 84.5204L33.8887 84.5904L34.0986 84.8704C34.3855 85.1435 34.6073 85.4777 34.7476 85.8481C34.8878 86.2186 34.9429 86.6158 34.9087 87.0104C34.6887 87.9304 32.6387 89.4004 31.1187 89.7204C30.2462 89.8662 29.3981 90.132 28.5986 90.5104L28.3386 90.6604C28.1704 90.7691 28.01 90.8894 27.8586 91.0204L27.6587 91.2104C27.5189 91.356 27.3917 91.5132 27.2787 91.6804V91.7304L27.1287 91.9704C27.0787 92.0604 27.0286 92.1704 26.9786 92.2704L26.8586 92.5604V92.6304C26.8586 92.7404 26.7887 92.8404 26.7587 92.9504C26.7587 93.0104 26.3987 94.2104 26.3887 94.2704C27.8828 95.8996 29.6993 97.2004 31.7229 98.0903C33.7465 98.9802 35.9331 99.4397 38.1437 99.4397C40.3543 99.4397 42.5407 98.9802 44.5643 98.0903C46.5879 97.2004 48.4045 95.8996 49.8987 94.2704C49.8987 94.2104 49.5786 92.9704 49.5686 92.9104L49.5087 92.9604Z" fill="white"/> <path d="M74.4702 99.5498C83.2957 99.5498 90.4502 92.3953 90.4502 83.5698C90.4502 74.7443 83.2957 67.5898 74.4702 67.5898C65.6447 67.5898 58.4902 74.7443 58.4902 83.5698C58.4902 92.3953 65.6447 99.5498 74.4702 99.5498Z" fill="#85CAFF"/> <path d="M85.8801 92.9604C85.8801 92.8504 85.8202 92.7504 85.7802 92.6404V92.5704L85.6602 92.2804L85.5101 91.9804L85.3601 91.7304V91.6804C85.2471 91.5132 85.1199 91.356 84.9801 91.2104L84.7802 91.0204C84.6287 90.8894 84.4684 90.7691 84.3002 90.6604L84.0402 90.5104C83.2407 90.132 82.3926 89.8662 81.5201 89.7204C80.0001 89.4004 77.9501 87.9304 77.7301 87.0104C77.6959 86.6158 77.751 86.2186 77.8912 85.8481C78.0315 85.4777 78.2533 85.1435 78.5402 84.8704L78.7501 84.5904L78.8101 84.5204C79.4505 83.6573 79.8726 82.652 80.0402 81.5904C80.0402 81.5104 80.0402 81.4104 80.0402 81.3204C80.3445 79.7705 80.3035 78.1727 79.9202 76.6404C79.6225 75.641 79.0332 74.7531 78.228 74.0904C77.4228 73.4277 76.4382 73.0203 75.4001 72.9204H75.2401C75.0037 72.9057 74.7666 72.9057 74.5302 72.9204C74.2937 72.9054 74.0565 72.9054 73.8201 72.9204H73.6801C72.6424 73.0216 71.6585 73.4294 70.8535 74.092C70.0485 74.7545 69.4591 75.6416 69.1602 76.6404C68.7817 78.1733 68.7407 79.7701 69.0402 81.3204C69.0402 81.4104 69.0402 81.5104 69.0402 81.5904C69.2034 82.6533 69.6259 83.6595 70.2701 84.5204L70.3301 84.5904C70.3936 84.6885 70.4638 84.782 70.5402 84.8704C70.8248 85.1452 71.0449 85.4796 71.1849 85.8496C71.325 86.2196 71.3814 86.616 71.3501 87.0104C71.1201 87.9304 69.0701 89.4004 67.5601 89.7204C66.6848 89.8677 65.8337 90.1335 65.0302 90.5104L64.7701 90.6604C64.6019 90.7691 64.4416 90.8894 64.2902 91.0204C64.2187 91.0785 64.1518 91.1421 64.0901 91.2104C63.9473 91.3534 63.82 91.5109 63.7101 91.6804V91.7304L63.5601 91.9704L63.4102 92.2704C63.4102 92.3604 63.3402 92.4604 63.3002 92.5604V92.6304C63.3002 92.7404 63.2301 92.8404 63.2001 92.9504C63.2001 93.0104 62.8501 94.2104 62.8301 94.2704C64.3284 95.8945 66.1468 97.1906 68.1708 98.0771C70.1948 98.9636 72.3805 99.4214 74.5901 99.4214C76.7997 99.4214 78.9854 98.9636 81.0094 98.0771C83.0334 97.1906 84.8518 95.8945 86.3501 94.2704C86.3501 94.2104 86.0301 92.9704 86.0101 92.9104L85.8801 92.9604Z" fill="white"/> <path d="M86.9099 58.14C102.412 58.14 114.98 45.5726 114.98 30.07C114.98 14.5673 102.412 2 86.9099 2C71.4072 2 58.8398 14.5673 58.8398 30.07C58.8398 45.5726 71.4072 58.14 86.9099 58.14Z" fill="#85CAFF" stroke="#0056B2" stroke-width="3.37" stroke-miterlimit="10"/> <path d="M105.759 45.5699C105.759 45.3899 105.649 45.2199 105.589 45.0499C105.593 45.01 105.593 44.9698 105.589 44.9299C105.529 44.7599 105.469 44.5999 105.399 44.4499C105.319 44.2699 105.239 44.1099 105.149 43.9499L104.909 43.5399V43.47C104.726 43.189 104.515 42.9276 104.279 42.6899C104.176 42.5758 104.066 42.4689 103.949 42.3699C103.705 42.1512 103.441 41.9569 103.159 41.7899C103.021 41.7002 102.877 41.6201 102.729 41.5499C101.401 40.928 99.9949 40.4906 98.5488 40.2499C96.0588 39.7199 92.6688 37.3 92.2988 35.77C91.9788 34.43 92.8588 33.2699 93.6388 32.2399L93.9888 31.78L94.0787 31.66C95.1374 30.2418 95.8249 28.5814 96.0787 26.8299C96.0787 26.6899 96.1388 26.5299 96.1588 26.3799C96.1635 26.3602 96.1635 26.3397 96.1588 26.3199C96.6533 23.7664 96.5884 21.136 95.9688 18.6099C95.474 16.9586 94.4999 15.4915 93.1699 14.3948C91.84 13.298 90.2141 12.6211 88.4988 12.4499H88.2788C87.8907 12.402 87.4998 12.3786 87.1088 12.3799C86.7177 12.3789 86.3269 12.4023 85.9387 12.4499H85.7188C84.0048 12.6217 82.3805 13.299 81.0522 14.3958C79.724 15.4926 78.7517 16.9594 78.2588 18.6099C77.6358 21.1353 77.5675 23.7657 78.0587 26.3199C78.0587 26.3199 78.0587 26.3199 78.0587 26.3799C78.0587 26.5299 78.0588 26.6899 78.1388 26.8299C78.3963 28.5804 79.0834 30.2399 80.1388 31.66L80.2288 31.78L80.5687 32.2399C81.3487 33.2399 82.2388 34.43 81.9088 35.77C81.5488 37.3 78.1588 39.7699 75.6588 40.2499C74.2155 40.489 72.8122 40.9265 71.4888 41.5499C71.3402 41.6201 71.1964 41.7002 71.0587 41.7899C70.7787 41.9595 70.5144 42.1536 70.2688 42.3699L69.9387 42.6899C69.7087 42.9305 69.5011 43.1916 69.3187 43.47L69.2688 43.5399C69.1788 43.6699 69.0988 43.8099 69.0188 43.9499C68.9288 44.1099 68.8488 44.2699 68.7688 44.4499C68.7688 44.4499 68.6387 44.7599 68.5787 44.9299V45.0499C68.5187 45.2199 68.4588 45.3899 68.4088 45.5699C68.4131 45.5897 68.4131 45.6102 68.4088 45.6299C68.4088 45.7299 67.8288 47.7099 67.7988 47.8199C70.2631 50.5154 73.2607 52.6691 76.6016 54.1445C79.9424 55.6198 83.5535 56.3846 87.2056 56.3903C90.8577 56.3959 94.4711 55.6423 97.8165 54.1772C101.162 52.7122 104.166 50.5677 106.639 47.8799C106.639 47.7699 106.109 45.7299 106.079 45.6299L105.759 45.5699Z" fill="white"/> <path d="M139.788 75.3801C139.37 74.9357 138.862 74.5848 138.299 74.3505C137.735 74.1161 137.129 74.0035 136.518 74.0201C135.311 74.0253 134.154 74.5074 133.3 75.3615C132.446 76.2155 131.964 77.3723 131.958 78.5801V79.8901H130.648V74.8101C130.672 73.7246 130.318 72.6645 129.648 71.8101C129.006 70.9587 128.074 70.3719 127.028 70.1601C126.717 70.1139 126.403 70.0872 126.088 70.0801C124.881 70.0853 123.724 70.5674 122.87 71.4214C122.016 72.2755 121.534 73.4323 121.528 74.6401V79.86H120.238V74.86C120.258 73.5244 119.784 72.2285 118.908 71.2201C118.495 70.713 117.983 70.2948 117.404 69.9907C116.825 69.6865 116.191 69.5026 115.538 69.4501C115.363 69.4273 115.184 69.4273 115.008 69.4501C114.323 69.4488 113.645 69.5826 113.012 69.8438C112.378 70.105 111.803 70.4885 111.318 70.9725C110.833 71.4564 110.448 72.0312 110.186 72.664C109.924 73.2968 109.788 73.9751 109.788 74.6601V79.86H108.478V63.2501V44.98C108.49 43.9691 108.17 42.9822 107.568 42.17C107.439 41.9856 107.295 41.8117 107.138 41.6501C106.366 40.8579 105.323 40.3864 104.218 40.3301H103.598C102.494 40.3864 101.451 40.8579 100.678 41.6501C100.518 41.8116 100.371 41.9854 100.238 42.17C99.6394 42.9832 99.3232 43.9702 99.3384 44.98V75.79C99.3425 75.8633 99.3425 75.9368 99.3384 76.0101V93.4701L98.0385 92.2501V85.2501C98.0501 84.6376 97.9402 84.0289 97.7154 83.459C97.4905 82.8892 97.1551 82.3696 96.7284 81.9301C96.31 81.4857 95.8024 81.1348 95.2388 80.9005C94.6753 80.6661 94.0685 80.5535 93.4584 80.5701C92.2497 80.578 91.0929 81.0623 90.2392 81.9179C89.3854 82.7735 88.9037 83.9314 88.8985 85.1401V94.2501C88.8958 94.875 89.0213 95.4938 89.2673 96.0683C89.5132 96.6428 89.8744 97.1607 90.3284 97.5901L102.988 109.59C103.525 110.135 103.945 110.785 104.22 111.499C104.495 112.213 104.621 112.976 104.588 113.74C104.601 114.427 104.881 115.083 105.368 115.568C105.855 116.053 106.511 116.33 107.198 116.34H133.318C134.007 116.335 134.667 116.06 135.155 115.573C135.643 115.087 135.921 114.429 135.928 113.74V112.74C135.922 111.68 136.06 110.623 136.338 109.6L140.728 91.8501C141.002 90.8296 141.137 89.7767 141.128 88.7201V78.7201C141.141 78.1019 141.029 77.4874 140.799 76.9136C140.568 76.3397 140.225 75.8181 139.788 75.3801Z" fill="white"/> <path d="M146.319 78.6899C146.342 77.3901 146.101 76.0992 145.609 74.8958C145.118 73.6923 144.386 72.6016 143.459 71.6899C142.566 70.7528 141.488 70.0112 140.293 69.5121C139.099 69.0129 137.814 68.767 136.519 68.7899C135.708 68.7865 134.899 68.8805 134.109 69.0699C133.212 67.7686 132.006 66.7103 130.599 65.9899C129.198 65.2679 127.645 64.8908 126.069 64.8899C124.307 64.889 122.578 65.3696 121.069 66.2799C119.325 64.9495 117.183 64.245 114.989 64.2799C114.555 64.2807 114.121 64.3074 113.689 64.3599V44.9699C113.709 43.6706 113.466 42.3807 112.974 41.1777C112.483 39.9748 111.753 38.8837 110.829 37.9699C109.601 36.7005 108.042 35.7999 106.329 35.3699H106.129C105.899 35.3699 105.679 35.2799 105.449 35.2499C105.219 35.2199 105.179 35.2499 105.039 35.1899C104.707 35.1512 104.374 35.1312 104.039 35.1299H103.859C103.525 35.1318 103.191 35.1518 102.859 35.1899L102.459 35.2499C102.229 35.2499 101.999 35.3199 101.779 35.3699H101.579C99.8662 35.7999 98.3075 36.7005 97.0793 37.9699C96.1535 38.8823 95.4227 39.9732 94.9311 41.1765C94.4395 42.3797 94.1973 43.6703 94.2193 44.9699V75.3999C94.0062 75.3848 93.7923 75.3848 93.5793 75.3999C90.987 75.4078 88.503 76.4404 86.669 78.2725C84.835 80.1046 83.7999 82.5876 83.7894 85.1799V94.2999C83.7787 95.637 84.0502 96.9614 84.5861 98.1865C85.122 99.4117 85.9102 100.51 86.8993 101.41L99.4793 113.41C99.4345 115.559 100.231 117.64 101.699 119.21C102.413 119.986 103.285 120.6 104.256 121.01C105.227 121.421 106.275 121.618 107.329 121.59H133.449C134.479 121.594 135.499 121.394 136.45 121.002C137.402 120.61 138.267 120.033 138.995 119.305C139.723 118.577 140.299 117.713 140.691 116.761C141.083 115.809 141.283 114.789 141.279 113.76C141.252 112.791 141.332 111.821 141.519 110.87L145.949 93.1299C146.288 91.6874 146.466 90.2116 146.479 88.7299L146.319 78.6899ZM140.709 91.8399L136.319 109.59C136.041 110.613 135.903 111.669 135.909 112.73V113.73C135.902 114.419 135.624 115.077 135.136 115.563C134.647 116.049 133.988 116.325 133.299 116.33H107.179C106.492 116.32 105.836 116.043 105.349 115.558C104.862 115.073 104.582 114.417 104.569 113.73C104.601 112.965 104.476 112.203 104.201 111.489C103.925 110.775 103.506 110.125 102.969 109.58L90.3093 97.5799C89.8552 97.1505 89.4941 96.6326 89.2481 96.0581C89.0021 95.4836 88.8767 94.8648 88.8793 94.2399V85.1299C88.8827 84.2241 89.1546 83.3397 89.6606 82.5884C90.1666 81.8372 90.8839 81.2528 91.722 80.9092C92.5601 80.5656 93.4812 80.4782 94.369 80.6581C95.2567 80.838 96.0711 81.2771 96.7093 81.9199C97.136 82.3594 97.4715 82.8791 97.6963 83.4489C97.9212 84.0187 98.031 84.6274 98.0193 85.2399V92.2399L99.3193 93.4599V76.0099C99.3233 75.9366 99.3233 75.8631 99.3193 75.7899V44.9799C99.3041 43.97 99.6202 42.983 100.219 42.1699C100.352 41.9852 100.499 41.8114 100.659 41.6499C101.432 40.8577 102.474 40.3862 103.579 40.3299H104.199C105.304 40.3862 106.347 40.8577 107.119 41.6499C107.276 41.8115 107.42 41.9854 107.549 42.1699C108.151 42.9821 108.471 43.969 108.459 44.9799V63.2499V79.9099H109.769V74.7099C109.769 74.0249 109.904 73.3466 110.167 72.7138C110.429 72.081 110.814 71.5063 111.299 71.0223C111.784 70.5384 112.359 70.1549 112.992 69.8936C113.626 69.6324 114.304 69.4986 114.989 69.4999C115.165 69.4771 115.343 69.4771 115.519 69.4999C116.171 69.5524 116.806 69.7363 117.385 70.0405C117.964 70.3446 118.476 70.7628 118.889 71.2699C119.765 72.2783 120.239 73.5743 120.219 74.9099V79.9099H121.519V74.6899C121.525 73.4821 122.007 72.3253 122.861 71.4713C123.715 70.6173 124.872 70.1351 126.079 70.1299C126.394 70.137 126.708 70.1637 127.019 70.2099C128.065 70.4217 128.997 71.0085 129.639 71.8599C130.309 72.7143 130.663 73.7744 130.639 74.8599V79.9399H131.949V78.6299C131.957 77.4229 132.44 76.2677 133.294 75.4142C134.147 74.5607 135.302 74.0777 136.509 74.0699C137.119 74.0533 137.726 74.1659 138.29 74.4003C138.853 74.6347 139.361 74.9855 139.779 75.4299C140.208 75.8681 140.545 76.3875 140.769 76.9576C140.994 77.5278 141.103 78.1371 141.089 78.7499V88.7499C141.101 89.7922 140.973 90.8314 140.709 91.8399Z" fill="#0056B2"/> </svg> report/singleview/pix/zero_state_grade.svg 0000604 00000025145 15062070556 0015106 0 ustar 00 <svg width="130" height="143" viewBox="0 0 130 143" fill="none" xmlns="http://www.w3.org/2000/svg" preserveAspectRatio="xMinYMid meet"> <path d="M54.7321 109.464C84.9598 109.464 109.464 84.9599 109.464 54.7322C109.464 24.5045 84.9598 0 54.7321 0C24.5044 0 0 24.5045 0 54.7322C0 84.9599 24.5044 109.464 54.7321 109.464Z" fill="#C4E5FF"/> <path d="M50.7351 22.1533H28.602C27.9945 22.1533 27.502 22.6459 27.502 23.2534V53.4505C27.502 54.058 27.9945 54.5505 28.602 54.5505H50.7351C51.3427 54.5505 51.8352 54.058 51.8352 53.4505V23.2534C51.8352 22.6459 51.3427 22.1533 50.7351 22.1533Z" fill="white" stroke="#0056B2" stroke-width="0.75" stroke-miterlimit="10"/> <path d="M46.7692 30.3281H32.5689C31.6938 30.3281 30.9844 31.0376 30.9844 31.9127C30.9844 32.7878 31.6938 33.4972 32.5689 33.4972H46.7692C47.6443 33.4972 48.3537 32.7878 48.3537 31.9127C48.3537 31.0376 47.6443 30.3281 46.7692 30.3281Z" fill="#85CAFF"/> <path d="M46.7692 36.9902H32.5689C31.6938 36.9902 30.9844 37.6997 30.9844 38.5748C30.9844 39.4499 31.6938 40.1593 32.5689 40.1593H46.7692C47.6443 40.1593 48.3537 39.4499 48.3537 38.5748C48.3537 37.6997 47.6443 36.9902 46.7692 36.9902Z" fill="#C4E5FF"/> <path d="M46.7692 43.6504H32.5689C31.6938 43.6504 30.9844 44.3598 30.9844 45.2349C30.9844 46.1101 31.6938 46.8195 32.5689 46.8195H46.7692C47.6443 46.8195 48.3537 46.1101 48.3537 45.2349C48.3537 44.3598 47.6443 43.6504 46.7692 43.6504Z" fill="#C4E5FF"/> <path d="M81.0007 22.1533H58.8677C58.2601 22.1533 57.7676 22.6459 57.7676 23.2534V53.4505C57.7676 54.058 58.2601 54.5505 58.8677 54.5505H81.0007C81.6083 54.5505 82.1008 54.058 82.1008 53.4505V23.2534C82.1008 22.6459 81.6083 22.1533 81.0007 22.1533Z" fill="white" stroke="#0056B2" stroke-width="0.75" stroke-miterlimit="10"/> <path d="M77.0465 30.3281H62.8462C61.9711 30.3281 61.2617 31.0376 61.2617 31.9127C61.2617 32.7878 61.9711 33.4972 62.8462 33.4972H77.0465C77.9216 33.4972 78.6311 32.7878 78.6311 31.9127C78.6311 31.0376 77.9216 30.3281 77.0465 30.3281Z" fill="#85CAFF"/> <path d="M77.0465 36.9902H62.8462C61.9711 36.9902 61.2617 37.6997 61.2617 38.5748C61.2617 39.4499 61.9711 40.1593 62.8462 40.1593H77.0465C77.9216 40.1593 78.6311 39.4499 78.6311 38.5748C78.6311 37.6997 77.9216 36.9902 77.0465 36.9902Z" fill="#C4E5FF"/> <path d="M77.0465 43.6504H62.8462C61.9711 43.6504 61.2617 44.3598 61.2617 45.2349C61.2617 46.1101 61.9711 46.8195 62.8462 46.8195H77.0465C77.9216 46.8195 78.6311 46.1101 78.6311 45.2349C78.6311 44.3598 77.9216 43.6504 77.0465 43.6504Z" fill="#C4E5FF"/> <path d="M50.7351 60.3242H28.602C27.9945 60.3242 27.502 60.8167 27.502 61.4243V91.6214C27.502 92.2289 27.9945 92.7214 28.602 92.7214H50.7351C51.3427 92.7214 51.8352 92.2289 51.8352 91.6214V61.4243C51.8352 60.8167 51.3427 60.3242 50.7351 60.3242Z" fill="white" stroke="#0056B2" stroke-width="0.75" stroke-miterlimit="10"/> <path d="M46.7692 68.499H32.5689C31.6938 68.499 30.9844 69.2085 30.9844 70.0836C30.9844 70.9587 31.6938 71.6681 32.5689 71.6681H46.7692C47.6443 71.6681 48.3537 70.9587 48.3537 70.0836C48.3537 69.2085 47.6443 68.499 46.7692 68.499Z" fill="#85CAFF"/> <path d="M46.7692 75.1592H32.5689C31.6938 75.1592 30.9844 75.8686 30.9844 76.7437C30.9844 77.6188 31.6938 78.3282 32.5689 78.3282H46.7692C47.6443 78.3282 48.3537 77.6188 48.3537 76.7437C48.3537 75.8686 47.6443 75.1592 46.7692 75.1592Z" fill="#C4E5FF"/> <path d="M46.7692 81.8115H32.5689C31.6938 81.8115 30.9844 82.521 30.9844 83.3961C30.9844 84.2712 31.6938 84.9806 32.5689 84.9806H46.7692C47.6443 84.9806 48.3537 84.2712 48.3537 83.3961C48.3537 82.521 47.6443 81.8115 46.7692 81.8115Z" fill="#C4E5FF"/> <path d="M93.9605 59.9199H58.1923C57.2113 59.9199 56.416 60.7152 56.416 61.6962V110.494C56.416 111.475 57.2113 112.27 58.1923 112.27H93.9605C94.9415 112.27 95.7368 111.475 95.7368 110.494V61.6962C95.7368 60.7152 94.9415 59.9199 93.9605 59.9199Z" fill="white" stroke="#0056B2" stroke-width="1.22" stroke-miterlimit="10"/> <path d="M87.5509 75.7656H64.6104C63.1946 75.7656 62.0469 76.9133 62.0469 78.3291C62.0469 79.7449 63.1946 80.8927 64.6104 80.8927H87.5509C88.9667 80.8927 90.1144 79.7449 90.1144 78.3291C90.1144 76.9133 88.9667 75.7656 87.5509 75.7656Z" fill="#85CAFF"/> <path d="M87.5509 86.1006H64.6104C63.1946 86.1006 62.0469 87.2484 62.0469 88.6641C62.0469 90.0799 63.1946 91.2276 64.6104 91.2276H87.5509C88.9667 91.2276 90.1144 90.0799 90.1144 88.6641C90.1144 87.2484 88.9667 86.1006 87.5509 86.1006Z" fill="#C4E5FF"/> <path d="M87.5509 96.4346H64.6104C63.1946 96.4346 62.0469 97.5823 62.0469 98.9981C62.0469 100.414 63.1946 101.562 64.6104 101.562H87.5509C88.9667 101.562 90.1144 100.414 90.1144 98.9981C90.1144 97.5823 88.9667 96.4346 87.5509 96.4346Z" fill="#C4E5FF"/> <path d="M124.29 106.709C123.964 106.361 123.568 106.085 123.128 105.901C122.688 105.717 122.213 105.628 121.736 105.64C120.793 105.65 119.891 106.03 119.225 106.698C118.559 107.366 118.182 108.269 118.174 109.212V110.222H117.165V106.255C117.169 105.418 116.883 104.605 116.357 103.954C115.868 103.287 115.149 102.827 114.339 102.662C114.098 102.626 113.855 102.606 113.612 102.602C112.667 102.604 111.761 102.98 111.092 103.648C110.423 104.315 110.044 105.219 110.039 106.164V110.201H109.03V106.326C109.05 105.286 108.691 104.275 108.021 103.48C107.695 103.087 107.294 102.762 106.842 102.525C106.39 102.287 105.895 102.142 105.386 102.097C105.249 102.085 105.11 102.085 104.973 102.097C103.902 102.097 102.875 102.522 102.118 103.28C101.361 104.037 100.936 105.063 100.936 106.134V110.171H99.9264V97.1617V82.9716C99.9374 82.1808 99.6892 81.408 99.2199 80.7714C99.118 80.6295 99.0068 80.4946 98.8868 80.3677C98.2762 79.7627 97.4643 79.4035 96.6059 79.3584H96.1215C95.2631 79.4035 94.4512 79.7627 93.8405 80.3677C93.7178 80.4985 93.6033 80.6367 93.4974 80.7815C93.036 81.4183 92.7886 82.1852 92.7909 82.9716V107.022C92.7954 107.083 92.7954 107.143 92.7909 107.204V120.829L91.7816 119.88V114.41C91.7947 113.934 91.7121 113.46 91.5388 113.016C91.3654 112.572 91.1048 112.168 90.7724 111.826C90.4487 111.478 90.0544 111.202 89.6159 111.017C89.1773 110.833 88.7046 110.744 88.229 110.757C87.2856 110.764 86.383 111.142 85.715 111.808C85.0469 112.474 84.6668 113.376 84.6563 114.319V121.384C84.6535 121.873 84.7515 122.358 84.9442 122.808C85.137 123.257 85.4203 123.663 85.7766 123.998L95.6672 133.394C96.0839 133.821 96.4089 134.329 96.6224 134.886C96.8359 135.443 96.9332 136.038 96.9086 136.634C96.9058 136.9 96.9583 137.164 97.0625 137.409C97.1667 137.654 97.3205 137.874 97.5143 138.057C97.7012 138.248 97.9241 138.399 98.1701 138.503C98.4161 138.607 98.6803 138.661 98.9473 138.662H119.345C119.88 138.662 120.393 138.45 120.772 138.071C121.15 137.693 121.363 137.179 121.363 136.644V135.857C121.355 135.029 121.46 134.204 121.676 133.404L125.107 119.547C125.322 118.751 125.427 117.929 125.42 117.105V109.283C125.413 108.8 125.31 108.324 125.116 107.882C124.921 107.44 124.641 107.041 124.29 106.709Z" fill="white"/> <path d="M129.386 109.292C129.4 108.28 129.21 107.276 128.827 106.34C128.443 105.403 127.875 104.554 127.156 103.842C126.458 103.11 125.617 102.531 124.684 102.142C123.75 101.753 122.747 101.562 121.736 101.581C121.104 101.576 120.473 101.647 119.859 101.794C119.151 100.784 118.209 99.9597 117.115 99.3921C116.02 98.8245 114.804 98.5299 113.571 98.5335C112.19 98.5278 110.834 98.9052 109.655 99.6236C108.296 98.5703 106.621 98.0082 104.901 98.0289C104.558 98.0289 104.225 98.0289 103.892 98.0895V82.9506C103.902 81.94 103.709 80.9376 103.324 80.003C102.939 79.0685 102.371 78.221 101.652 77.5107C100.696 76.5185 99.4777 75.8185 98.1393 75.4922H97.9879C97.8114 75.4521 97.6328 75.4218 97.453 75.4014H97.1402C96.8677 75.4014 96.5951 75.4014 96.3226 75.4014H96.1813C95.9088 75.4014 95.6364 75.4014 95.3639 75.4014H95.0509C94.8711 75.4218 94.6925 75.4521 94.516 75.4922H94.3647C93.0263 75.8185 91.8081 76.5185 90.8524 77.5107C90.1315 78.2196 89.5614 79.067 89.1764 80.0018C88.7913 80.9366 88.5993 81.9396 88.6119 82.9506V106.709C88.4439 106.696 88.2752 106.696 88.1072 106.709C86.0853 106.711 84.1466 107.514 82.715 108.942C81.2834 110.37 80.4752 112.306 80.4672 114.328V121.454C80.4563 122.5 80.6675 123.537 81.0868 124.495C81.506 125.454 82.1239 126.313 82.8995 127.015L92.7196 136.411C92.6797 138.086 93.2994 139.71 94.4454 140.933C95.0018 141.541 95.6831 142.022 96.4426 142.342C97.2021 142.663 98.0218 142.815 98.8458 142.79H119.233C120.037 142.798 120.836 142.645 121.581 142.341C122.326 142.038 123.003 141.588 123.572 141.02C124.141 140.451 124.592 139.775 124.897 139.031C125.202 138.286 125.356 137.488 125.349 136.684C125.325 135.925 125.389 135.166 125.541 134.423L128.992 120.566C129.262 119.442 129.401 118.29 129.406 117.134L129.386 109.292ZM125.006 119.556L121.574 133.414C121.359 134.213 121.253 135.038 121.261 135.866V136.653C121.261 137.189 121.049 137.702 120.67 138.081C120.292 138.459 119.778 138.672 119.243 138.672H98.8458C98.5787 138.671 98.3145 138.617 98.0685 138.513C97.8225 138.409 97.5995 138.257 97.4126 138.066C97.2189 137.884 97.0651 137.663 96.9609 137.418C96.8567 137.173 96.8043 136.909 96.807 136.643C96.8317 136.047 96.7343 135.452 96.5208 134.895C96.3074 134.338 95.9823 133.83 95.5657 133.403L85.675 124.007C85.3188 123.672 85.0354 123.267 84.8427 122.817C84.6499 122.367 84.5518 121.883 84.5546 121.393V114.328C84.5652 113.385 84.9454 112.484 85.6134 111.817C86.2814 111.151 87.1841 110.774 88.1274 110.766C88.603 110.753 89.0758 110.842 89.5143 111.027C89.9528 111.211 90.3471 111.487 90.6708 111.836C91.0032 112.177 91.2639 112.581 91.4372 113.025C91.6106 113.469 91.6931 113.943 91.6801 114.419V119.91L92.6893 120.858V107.233C92.6938 107.173 92.6938 107.112 92.6893 107.052V82.9708C92.687 82.1844 92.9343 81.4175 93.3957 80.7807C93.5016 80.6359 93.6163 80.4976 93.739 80.3668C94.3497 79.7619 95.1615 79.4027 96.0199 79.3576H96.5043C97.3627 79.4027 98.1746 79.7619 98.7853 80.3668C98.9052 80.4938 99.0164 80.6287 99.1183 80.7706C99.5876 81.4072 99.8357 82.18 99.8247 82.9708V97.2316V110.241H100.834V106.204C100.834 105.133 101.259 104.106 102.016 103.349C102.774 102.592 103.8 102.167 104.871 102.167C105.009 102.155 105.147 102.155 105.285 102.167C105.793 102.212 106.288 102.357 106.74 102.595C107.192 102.832 107.593 103.157 107.919 103.55C108.589 104.345 108.948 105.356 108.928 106.396V110.271H109.938V106.234C109.943 105.289 110.321 104.385 110.991 103.717C111.66 103.05 112.565 102.674 113.51 102.672C113.754 102.676 113.996 102.696 114.237 102.732C115.047 102.896 115.767 103.357 116.255 104.024C116.782 104.675 117.067 105.488 117.063 106.325V110.291H118.072V109.282C118.08 108.339 118.458 107.436 119.124 106.768C119.79 106.1 120.691 105.72 121.635 105.709C122.112 105.697 122.586 105.787 123.026 105.971C123.466 106.155 123.862 106.431 124.188 106.779C124.518 107.122 124.778 107.527 124.951 107.97C125.124 108.414 125.208 108.887 125.198 109.363V117.185C125.238 117.98 125.173 118.778 125.006 119.556Z" fill="#0056B2"/> </svg> report/singleview/templates/zero_state_grade.mustache 0000604 00000002410 15062070556 0017304 0 ustar 00 {{! 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/>. }} {{! @template gradereport_singleview/zero_state_grade The zero state of the user report that contains the image and trigger for the search widget. Example context (json): { "imglink": "http://foo.bar/gradereport/?userid=25" } }} <div class="zero-state mx-auto w-50 text-center my-6"> <img src="{{imglink}}" alt="{{#str}}viewsinglegradeitem, gradereport_singleview{{/str}}" aria-hidden="true" class="my-5"> <h3>{{#str}}viewsinglegradeitem, gradereport_singleview{{/str}}</h3> <p>{{#str}}singleviewdescription, gradereport_singleview{{/str}}</p> </div> report/singleview/templates/report.mustache 0000604 00000003000 15062070556 0015272 0 ustar 00 {{! 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/>. }} {{! @template gradereport_singleview/report Report table and sticky footer. Context variables required for this template: * sesskey - string - The session key. * table - string - HTML content of the grade items or users table. * stickyfooter - string - HTML content of the sticky footer. Example context (json): { "sesskey": "fakesesskey", "table": "<div><div class='reporttable'><div class='tableresponsive'><table class='generaltable' id='singleview-grades'><thead> <tr><th>Name</th><th>User fullname</th><th>Grade</th><th>Actions</th> </tr></thead><tbody></tbody></table></div></div></div>", "stickyfooter": "<div id='sticky-footer'></div>" } }} <form method="post"> {{{table}}} {{{stickyfooter}}} <input type="hidden" name="sesskey" value="{{sesskey}}"> </form> report/singleview/templates/zero_state.mustache 0000604 00000002743 15062070556 0016153 0 ustar 00 {{! 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/>. }} {{! @template gradereport_singleview/zero_state The zero state of the user report that contains the image and trigger for the search widget. Example context (json): { "imglink": "http://foo.bar/gradereport/?userid=25", "userzerolink": "http://foo.bar/gradereport/?userid=25", "gradezerolink": "http://foo.bar/gradereport/?userid=25" } }} <div class="zero-state mx-auto w-50 text-center my-6"> <img src="{{imglink}}" alt="{{#str}}pluginname, gradereport_singleview{{/str}}" aria-hidden="true" class="my-5"> <h3>{{#str}}pluginname, gradereport_singleview{{/str}}</h3> <p>{{#str}}viewsingleuserorgradeitem, gradereport_singleview{{/str}}</p> <div class="justify-content-center d-flex"> {{>gradereport_singleview/page_toggler}} </div> </div> report/singleview/templates/perpage.mustache 0000604 00000003530 15062070556 0015412 0 ustar 00 {{! 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/>. }} {{! @template gradereport_grader/perpage The students per page dropdown element. Context variables required for this template: * baseurl - The base URL for the perpage action. * options - Choices Example context (json): { "baseurl": "http://example.com/grade/report/grader/index.php?id=2&report=grader", "options": [ {"name": "20", "value": "20"}, {"name": "100", "value": "100", "selected": true}, {"name": "All", "value": "0"} ] } }} <div class="col-auto"> <label> {{#str}}show{{/str}} <select name="perpage" class="mt-1 custom-select ignoredirty" id="{{uniqid}}"> {{#options}} <option value="{{value}}" {{#selected}}selected{{/selected}}>{{name}}</option> {{/options}} </select> </label> </div> {{#pagingbar}} <div class="col"> {{{pagingbar}}} </div> {{/pagingbar}} {{#js}} document.getElementById('{{uniqid}}').addEventListener('change', function(e) { var url = new URL('{{{baseurl}}}'); url.searchParams.set('perpage', e.target.value); window.location.href = url; }); {{/js}} report/singleview/templates/zero_state_user.mustache 0000604 00000002375 15062070556 0017212 0 ustar 00 {{! 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/>. }} {{! @template gradereport_singleview/zero_state_user The zero state of the user report that contains the image and trigger for the search widget. Example context (json): { "imglink": "http://foo.bar/gradereport/?userid=25" } }} <div class="zero-state mx-auto w-50 text-center my-6"> <img src="{{imglink}}" alt="{{#str}}viewsingleuser, gradereport_singleview{{/str}}" aria-hidden="true" class="my-5"> <h3>{{#str}}viewsingleuser, gradereport_singleview{{/str}}</h3> <p>{{#str}}singleviewdescription, gradereport_singleview{{/str}}</p> </div> report/singleview/templates/report_navigation.mustache 0000604 00000005260 15062070556 0017523 0 ustar 00 {{! 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/>. }} {{! @template gradereport_singleview/report_navigation The previous/next user/item navigation for the singleview report. Context variables required for this template: * previoususer - (optional) The object containing information about the previous user. * name - The name of the previous user/item. * url - The URL to the previous user/item report. * nextuser - (optional) The object containing information about the next user. * name - The name of the next user/item. * url - The URL to the next user/item report. Example context (json): { "previoususer": { "name": "John Smith", "url": "https://example.com/grade/report/singleview/index.php?id=2&itemid=3" }, "previoususer": { "name": "Jane Doe", "url": "https://example.com/grade/report/singleview/index.php?id=2&itemid=5" } } }} <div class="report-navigation w-100"> <div class="container w-100 d-flex"> {{#perpageselect}} <div class="d-flex report-paging"> {{{perpageselect}}} </div> {{/perpageselect}} <div class="d-flex ml-auto mt-2"> {{#previoususer}} <div class="previous d-flex"> <a href="{{url}}" aria-label="{{#str}} gotopreviousreport, gradereport_singleview {{/str}}"> <i class="fa fa-caret-{{previousarrow}} fa-lg pr-1"></i> {{name}} </a> </div> {{/previoususer}} </div> <div class="d-flex ml-auto mt-2"> {{#nextuser}} <div class="next d-flex ml-auto"> <a href="{{url}}" aria-label="{{#str}} gotonextreport, gradereport_singleview {{/str}}"> {{name}} <i class="fa fa-caret-{{nextarrow}} fa-lg pl-1"></i> </a> </div> {{/nextuser}} </div> </div> </div> report/singleview/templates/text_attribute.mustache 0000604 00000002411 15062070556 0017033 0 ustar 00 {{! 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/>. }} {{! @template gradereport_singleview/text_attribute Text attribute. Example context (json): { "name": "Awesome-report", "label": "Text label", "value": "Text information", "disabled": "true" } }} {{#readonly}} {{value}} {{/readonly}} {{^readonly}} {{#label}}<label for="{{name}}" class="accesshide">{{label}}</label>{{/label}} <input id="{{name}}" name="{{name}}" type="text" value="{{value}}" class="form-control" {{#disabled}}disabled{{/disabled}}> <input type="hidden" name="old{{name}}" value="{{value}}"> {{/readonly}} report/singleview/templates/dropdown_attribute.mustache 0000604 00000002572 15062070556 0017713 0 ustar 00 {{! 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/>. }} {{! @template gradereport_singleview/dropdown_attribute Dropdown attribute. Example context (json): { "name": "Awesome-test", "disabled": "true", "options": "true", "value": "1", "selected": "true" } }} {{#readonly}} {{text}} {{/readonly}} {{^readonly}} <label for="{{name}}" class="accesshide">{{label}}</label> <select id="{{name}}" name="{{name}}" class="custom-select" {{#disabled}}disabled{{/disabled}}> {{#options}} <option value="{{value}}" {{#selected}}selected{{/selected}}>{{name}}</option> {{/options}} </select> <input type="hidden" name="old{{name}}" value="{{value}}"> {{/readonly}} report/singleview/templates/button.mustache 0000604 00000001641 15062070556 0015303 0 ustar 00 {{! 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/>. }} {{! @template gradereport_singleview/button Button. Example context (json): { "type": "submit", "value": "Save" } }} <input type="{{type}}" value="{{value}}" {{disabled}} class="btn btn-primary"> report/singleview/templates/action_bar.mustache 0000604 00000010551 15062070556 0016071 0 ustar 00 {{! 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/>. }} {{! @template gradereport_singleview/action_bar Context variables required for this template: * generalnavselector - The data object containing the required properties to render the general navigation selector. * groupselector - (optional) HTML that outputs the group selector * itemselector - (optional) HTML that outputs the user or grade item selector * pagetoggler - (optional) HTML that outputs the user/grade item view toggler * bulkactions - (optional) HTML that outputs the bulk actione menu Example context (json): { "generalnavselector": { "name": "Gradebook tertiary navigation selector", "value": "opt2", "baseid": "select-menu56789", "selectedoption": "Gradebook setup", "options": [ { "selected": false, "isgroup": { "name": "View", "id": "select-menu-group1", "options": [ { "name": "Grader report", "value": "opt1", "id": "select-menu-option1", "selected": false } ] } }, { "selected": false, "isgroup": { "name": "Setup", "id": "select-menu-group2", "options": [ { "name": "Gradebook setup", "value": "opt2", "id": "select-menu-option2", "selected": true } ] } } ] }, "groupselector": "<div class='group-selector'></div>", "itemselector": "<div class='user-selector'></div>", "pagetoggler": "<div class='page-toggler'></div>", "bulkactions": "<div class='action-menu'></div>" } }} <div class="container-fluid tertiary-navigation full-width-bottom-border"> <div class="row"> {{#generalnavselector}} <div class="navitem order-1"> {{>core/tertiary_navigation_selector}} </div> <div class="navitem-divider d-none d-sm-flex order-1"></div> {{/generalnavselector}} {{#groupselector}} <div class="navitem order-2"> {{{.}}} </div> <div class="navitem-divider d-none d-sm-flex order-2"></div> {{/groupselector}} {{#itemselector}} <div class="navitem order-3"> {{{.}}} </div> <div class="navitem-divider d-none d-sm-flex order-3"></div> {{/itemselector}} {{#pagetoggler}} <div class="d-flex row ml-0 ml-sm-auto order-4 px-0"> {{#bulkactions}} <div class="d-flex navitem ml-0 ml-sm-auto mr-3">{{{bulkactions}}}</div> {{#js}} require(['gradereport_singleview/bulkactions'], function(bulkactions) { bulkactions.init(); }); {{/js}} <div class="navitem-divider d-none d-sm-flex"></div> {{/bulkactions}} <div class="d-flex navitem ml-0 mr-auto mr-sm-0 ml-sm-auto"> {{>gradereport_singleview/page_toggler}} </div> </div> {{/pagetoggler}} </div> </div> report/singleview/templates/grade_item_selector.mustache 0000604 00000004015 15062070556 0017766 0 ustar 00 {{! 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/>. }} {{! @template gradereport_singleview/grade_item_selector The grade item selector trigger element. Context variables required for this template: * itemid - The value of the grade item selector element (id of the preselected grade item) * courseid - The course ID. * selectedoption - (optional) Object containing information about the selected option. * text - The text of the selected option. Example context (json): { "itemid": "21", "courseid": "2", "selectedoption": { "text": "Grade item 1" } } }} <div class="align-items-center d-flex"> {{#selectedoption}} <div class="d-block pr-3 text-truncate"> <span class="d-block small"> {{#str}} selectagrade, gradereport_singleview {{/str}} </span> <span class="p-0 font-weight-bold"> {{text}} </span> </div> {{/selectedoption}} {{^selectedoption}} <div class="user-info d-block pr-3"> {{#str}} selectagrade, gradereport_singleview {{/str}} </div> {{/selectedoption}} </div> <span class="d-none" data-region="courseid" data-courseid="{{courseid}}" aria-hidden="true"></span> <span class="d-none" data-region="itemid" data-itemid="{{itemid}}" aria-hidden="true"></span> report/singleview/templates/page_toggler.mustache 0000604 00000004214 15062070556 0016426 0 ustar 00 {{! 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/>. }} {{! @template gradereport_singleview/page_toggler The small selector at the top right of the page to switch between zero states. Example context (json): { "displaylabel": true, "userzerolink": "http://foo.bar/gradereport/?userid=25", "userselectactive": "false", "gradepagepage": "http://foo.bar/gradereport/?userid=25", "gradeselectactive": "true" } }} <div class="page-toggler d-block d-sm-flex text-nowrap"> {{#displaylabel}} <p class="my-auto mr-3 text-uppercase">{{#str}}viewby, gradereport_singleview{{/str}}</p> {{/displaylabel}} <div class="btn-group align-items-center" role="group" aria-label="{{#str}}ariareporttype, gradereport_singleview{{/str}}"> <a href="{{userzerolink}}" role="button" class="btn btn-outline-primary {{#userselectactive}}active{{/userselectactive}}" {{#userselectactive}}aria-pressed="true"{{/userselectactive}} {{^userselectactive}}aria-pressed="false"{{/userselectactive}} > {{#str}}users{{/str}} </a> <a href="{{gradezerolink}}" role="button" class="btn btn-outline-primary {{#gradeselectactive}}active{{/gradeselectactive}}" {{#gradeselectactive}}aria-pressed="true"{{/gradeselectactive}} {{^gradeselectactive}}aria-pressed="false"{{/gradeselectactive}} > {{#str}}gradeitems, grades{{/str}} </a> </div> </div> report/singleview/templates/gradesearch_body.mustache 0000604 00000002744 15062070556 0017262 0 ustar 00 {{! 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/>. }} {{! @template gradereport_singleview/gradesearch_body The body of the grade item widget. Example context (json): {} }} {{< core/search_input_auto }} {{$label}}{{#str}} searchgrades, gradereport_singleview {{/str}}{{/label}} {{$placeholder}}{{#str}} searchgrades, gradereport_singleview {{/str}}{{/placeholder}} {{$additionalattributes}} role="combobox" aria-expanded="true" aria-controls="listbox-{{uniqid}}" aria-autocomplete="list" data-input-element="input-{{uniqid}}" {{/additionalattributes}} {{/ core/search_input_auto }} <input type="hidden" name="search" id="input-{{uniqid}}"/> <div role="listbox" id="listbox-{{uniqid}}" class="searchresultscontainer" data-region="search-results-container-widget"></div> report/singleview/templates/bulk_insert.mustache 0000604 00000003474 15062070556 0016317 0 ustar 00 {{! 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/>. }} {{! @template gradereport_singleview/bulk_insert Bulk insert attribute. Example context (json): { "applyname": "Apply-name", "applylabel": "Perform bulk insert", "label": "Bulk insert", "menuname": "Menu-name", "menulabel": "For", "menuoptions": "JSON object", "value": "all", "selected": "", "name": "All grades", "valuename": "Value-name", "valuelabel": "Insert value", "valuefield": "PARSED HTML" } }} <div class="enable"> <input type="checkbox" name="{{applyname}}" value="1" id="{{applyname}}" class="ml-0"> <label for="{{applyname}}">{{applylabel}}</label> </div> <fieldset class="form-inline"> <legend class="accesshide">{{label}}</legend> <label for="{{menuname}}">{{menulabel}}</label> <select name="{{menuname}}" id="{{menuname}}" class="form-control custom-select"> {{#menuoptions}} <option value="{{value}}" {{#selected}}selected{{/selected}}>{{name}}</option> {{/menuoptions}} </select> <label for="{{valuename}}">{{valuelabel}}</label> {{{valuefield}}} </fieldset> report/singleview/templates/bulkinsert.mustache 0000604 00000004601 15062070556 0016151 0 ustar 00 {{! 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/>. }} {{! @template gradereport_singleview/bulkinsert Template for the bulk insert grades modal. Example context (json): { "name": "bulksinsertmodal", "id": "bulksinsertmodal" } }} <form> <div class="alert alert-warning"> {{#str}}unsavedataalert, gradereport_singleview{{/str}} <span class="sr-only">{{#str}}unsaveddatawarning, gradereport_singleview{{/str}}</span> <div class="form-check form-check-inline"> <input class="form-check-input" type="checkbox" value="1" id="override"> <label class="form-check-label" for="override"> {{#str}}unsavedataconfirm, gradereport_singleview{{/str}} </label> </div> </div> <div class="formdata dimmed_text"> {{#str}}bulkchoice, gradereport_singleview{{/str}} <div class="pt-3 px-3" role="radiogroup"> <label class="form-check"> <input class="form-check-input" type="radio" name="bulkinsert" value="all" disabled/> {{#str}}all_grades, gradereport_singleview{{/str}} </label> <label class="form-check"> <input class="form-check-input" type="radio" name="bulkinsert" value="blanks" disabled/> {{#str}}blanks, gradereport_singleview{{/str}} </label> </div> <p class ="font-weight-bold"> {{#str}}bulkinsertvalue, gradereport_singleview{{/str}} </p> <label for="{{name}}" class="sr-only">{{#str}}bulkinsertvalue, gradereport_singleview{{/str}}</label> <input type="text" name="{{name}}" id="{{id}}" value="0" class="form-control text-ltr" disabled {{#readonly}}readonly{{/readonly}}> </div> </form> report/singleview/tests/fixtures/screen.php 0000604 00000003150 15062070556 0015237 0 ustar 00 <?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/>. /** * Fixtures for single view report screen class testing. * * @package gradereport_singleview * @copyright 2014 onwards Simey Lameze <simey@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); class gradereport_singleview_screen_testable extends \gradereport_singleview\local\screen\screen { /** * Wrapper to make protected method accessible during testing. * * @return array returns array of users. */ public function test_load_users(): array { return $this->load_users(); } /** * Return the HTML for the page. */ public function init($selfitemisempty = false) { } /** * Get the type of items on this screen, not valid so return false. */ public function item_type(): string { } /** * Return the HTML for the page. */ public function html(): string { } } report/singleview/tests/screen_test.php 0000604 00000011571 15062070556 0014433 0 ustar 00 <?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/>. namespace gradereport_singleview; use gradereport_singleview_screen_testable; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once(__DIR__ . '/fixtures/screen.php'); require_once($CFG->libdir . '/gradelib.php'); /** * Tests for screen class. * * @package gradereport_singleview * @category test * @copyright 2014 onwards Simey Lameze <simey@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class screen_test extends \advanced_testcase { /** * Test load_users method. */ public function test_load_users() { global $DB; $this->setAdminUser(); $this->resetAfterTest(true); $roleteacher = $DB->get_record('role', ['shortname' => 'teacher'], '*', MUST_EXIST); // Create a course, users and groups. $course = $this->getDataGenerator()->create_course(); $coursecontext = \context_course::instance($course->id); $group = $this->getDataGenerator()->create_group(['courseid' => $course->id]); $teacher = $this->getDataGenerator()->create_user(); $user1 = $this->getDataGenerator()->create_user(); $user2 = $this->getDataGenerator()->create_user(); $this->getDataGenerator()->enrol_user($teacher->id, $course->id, $roleteacher->id); $this->getDataGenerator()->enrol_user($user1->id, $course->id); $this->getDataGenerator()->enrol_user($user2->id, $course->id); $this->getDataGenerator()->create_group_member(['groupid' => $group->id, 'userid' => $teacher->id]); $this->getDataGenerator()->create_group_member(['groupid' => $group->id, 'userid' => $user1->id]); $this->getDataGenerator()->create_group_member(['groupid' => $group->id, 'userid' => $user2->id]); // Perform a regrade before creating the report. grade_regrade_final_grades($course->id); $screentest = new gradereport_singleview_screen_testable($course->id, 0, $group->id); $groupusers = $screentest->test_load_users(); $this->assertDebuggingCalled('The function load_users() is deprecated. Please use get_gradable_users() instead.'); $this->assertCount(2, $groupusers); // Now, let's suspend the enrolment of a user. Should return only one user. $this->getDataGenerator()->enrol_user($user2->id, $course->id, $roleteacher->id, 'manual', 0, 0, ENROL_USER_SUSPENDED); $users = $screentest->test_load_users(); $this->assertDebuggingCalled('The function load_users() is deprecated. Please use get_gradable_users() instead.'); $this->assertCount(1, $users); // Change the viewsuspendedusers capabilities and set the user preference to display suspended users. assign_capability('moodle/course:viewsuspendedusers', CAP_ALLOW, $roleteacher->id, $coursecontext, true); set_user_preference('grade_report_showonlyactiveenrol', false, $teacher); accesslib_clear_all_caches_for_unit_testing(); $this->setUser($teacher); $screentest = new gradereport_singleview_screen_testable($course->id, 0, $group->id); $users = $screentest->test_load_users(); $this->assertDebuggingCalled('The function load_users() is deprecated. Please use get_gradable_users() instead.'); $this->assertCount(2, $users); // Change the capability again, now the user can't see the suspended enrolments. assign_capability('moodle/course:viewsuspendedusers', CAP_PROHIBIT, $roleteacher->id, $coursecontext, true); set_user_preference('grade_report_showonlyactiveenrol', false, $teacher); accesslib_clear_all_caches_for_unit_testing(); $users = $screentest->test_load_users(); $this->assertDebuggingCalled('The function load_users() is deprecated. Please use get_gradable_users() instead.'); $this->assertCount(1, $users); // Now, activate the user enrolment again. We shall get 2 users now. $this->getDataGenerator()->enrol_user($user2->id, $course->id, $roleteacher->id, 'manual', 0, 0, ENROL_USER_ACTIVE); $users = $screentest->test_load_users(); $this->assertDebuggingCalled('The function load_users() is deprecated. Please use get_gradable_users() instead.'); $this->assertCount(2, $users); } } report/singleview/tests/behat/gradeitemsearch.feature 0000604 00000007645 15062070556 0017202 0 ustar 00 @core @core_grades @gradereport_singleview @javascript Feature: Given we have opted to search for a grade item, Lets find and search them. Background: Given the following "courses" exist: | fullname | shortname | category | groupmode | | Course 1 | C1 | 0 | 1 | And the following "users" exist: | username | firstname | lastname | email | idnumber | | teacher1 | Teacher | 1 | teacher1@example.com | t1 | | student1 | Student | 1 | student1@example.com | s1 | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | And the following "activities" exist: | activity | course | idnumber | name | | assign | C1 | a1 | Test assignment one | | assign | C1 | a2 | Test assignment two | And I am on the "Course 1" "grades > Single view > View" page logged in as "teacher1" And I change window size to "large" Scenario: A teacher can search for and find a grade item to view Given I click on "Grade items" "link" in the ".page-toggler" "css_element" And I click on ".gradesearchwidget" "css_element" When I confirm "Test assignment one" in "grade" search within the gradebook widget exists And I confirm "Test assignment two" in "grade" search within the gradebook widget exists Then I set the field "Search items" to "two" And I wait until "Test assignment one" "option_role" does not exist And I confirm "Test assignment one" in "grade" search within the gradebook widget does not exist And I confirm "Test assignment two" in "grade" search within the gradebook widget exists And I click on "Test assignment two" in the "grade" search widget # The search input remains in the field on reload this is in keeping with other search implementations. And I click on ".gradesearchwidget" "css_element" And the field "Search items" matches value "two" Then I set the field "Search items" to "Turtle" And I should see "No results for \"Turtle\"" @accessibility Scenario: A teacher can set focus and search using the input with a keyboard # Basic tests for the page. Given I click on "Grade items" "link" in the ".page-toggler" "css_element" And I click on ".gradesearchwidget" "css_element" And the page should meet accessibility standards And the page should meet "wcag131, wcag141, wcag412" accessibility standards And the page should meet accessibility standards with "wcag131, wcag141, wcag412" extra tests # Move onto general keyboard navigation testing. And I click on "Search items" "field" And I wait until "Test assignment one" "option_role" exists And I press the down key And the focused element is "Test assignment one" "option_role" And I press the end key And the focused element is "Course total" "option_role" And I press the home key And the focused element is "Test assignment one" "option_role" And I press the up key And the focused element is "Course total" "option_role" And I press the down key And the focused element is "Test assignment one" "option_role" And I press the escape key And the focused element is "Search items" "field" Then I set the field "Search items" to "Goodmeme" And I wait until "Test assignment one" "option_role" does not exist And I press the down key And the focused element is "Search items" "field" # Lets check the tabbing order. And I set the field "Search items" to "one" And I wait until "Test assignment one" "option_role" exists And I press the tab key And the focused element is "Clear search input" "button" in the ".grade-search" "css_element" And I press the enter key And I wait until the page is ready And ".gradesearchwidget" "css_element" should exist report/singleview/tests/behat/usersearch.feature 0000604 00000032230 15062070556 0016203 0 ustar 00 @core @core_grades @gradereport_singleview @javascript Feature: Within the singleview report, a teacher can search for users. Background: Given the following "courses" exist: | fullname | shortname | category | groupmode | | Course 1 | C1 | 0 | 1 | | Course 2 | C2 | 0 | 0 | And the following "users" exist: | username | firstname | lastname | email | idnumber | phone1 | phone2 | department | institution | city | country | | teacher1 | Teacher | 1 | teacher1@example.com | t1 | 1234567892 | 1234567893 | ABC1 | ABCD | Perth | AU | | student1 | Student | 1 | student1@example.com | s1 | 3213078612 | 8974325612 | ABC1 | ABCD | Hanoi | VN | | student2 | Dummy | User | student2@example.com | s2 | 4365899871 | 7654789012 | ABC2 | ABCD | Tokyo | JP | | student3 | User | Example | student3@example.com | s3 | 3243249087 | 0875421745 | ABC2 | ABCD | Olney | GB | | student4 | User | Test | student4@example.com | s4 | 0987532523 | 2149871323 | ABC3 | ABCD | Tokyo | JP | | student5 | Turtle | Manatee | student5@example.com | s5 | 1239087780 | 9873623589 | ABC3 | ABCD | Perth | AU | # Note: Add groups etc so we can test that the search ignores those filters as well if we go down the filter dataset path. And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | teacher1 | C2 | editingteacher | | student1 | C1 | student | | student2 | C1 | student | | student3 | C1 | student | | student4 | C1 | student | | student5 | C1 | student | And the following "activities" exist: | activity | course | idnumber | name | | assign | C1 | a1 | Test assignment one | And the following config values are set as admin: | showuseridentity | idnumber,email,city,country,phone1,phone2,department,institution | And I change window size to "large" And I am on the "Course 1" "grades > Single view > View" page logged in as "teacher1" And I click on "Users" "link" in the ".page-toggler" "css_element" Scenario: A teacher can view and trigger the user search # Check the placeholder text Given I should see "Search users" # Confirm the search is currently inactive and results are unfiltered. And the following should exist in the "user-grades" table: | -1- | | Turtle Manatee | | Student 1 | | User Example | | User Test | | Dummy User | And the following should not exist in the "user-grades" table: | -1- | | Teacher 1 | When I set the field "Search users" to "Turtle" And I confirm "Turtle Manatee" in "user" search within the gradebook widget exists And I confirm "User Example" in "user" search within the gradebook widget does not exist And I click on "Turtle Manatee" "list_item" # Business case: This will trigger a page reload and can not dynamically update the table. And I wait until the page is ready Then the following should exist in the "user-grades" table: | -1- | | Turtle Manatee | And the following should not exist in the "user-grades" table: | -1- | | Teacher 1 | | Student 1 | | User Example | | User Test | | Dummy User | And I set the field "Search users" to "Turt" And I wait until "Turtle Manatee" "option_role" exists And I click on "Clear search input" "button" in the ".user-search" "css_element" And "Turtle Manatee" "option_role" should not be visible Scenario: A teacher can search the single view report to find specified users # Case: Standard search. Given I click on "Dummy" in the "user" search widget And the following should exist in the "user-grades" table: | -1- | | Turtle Manatee | And the following should not exist in the "user-grades" table: | -1- | | Teacher 1 | | Student 1 | | User Example | | User Test | | Dummy User | # Case: No users found. When I set the field "Search users" to "Plagiarism" And I should see "No results for \"Plagiarism\"" # Table remains unchanged as the user had no results to select from the dropdown. And the following should exist in the "user-grades" table: | -1- | | Turtle Manatee | And the following should not exist in the "user-grades" table: | -1- | | Teacher 1 | | Student 1 | | User Example | | User Test | | Dummy User | # Case: Multiple users found and select only one result. Then I set the field "Search users" to "User" And I wait until "Dummy User" "option_role" exists And I confirm "Dummy User" in "user" search within the gradebook widget exists And I confirm "User Example" in "user" search within the gradebook widget exists And I confirm "User Test" in "user" search within the gradebook widget exists And I confirm "Turtle Manatee" in "user" search within the gradebook widget does not exist # Check if the matched field names (by lines) includes some identifiable info to help differentiate similar users. And I confirm "User (student2@example.com)" in "user" search within the gradebook widget exists And I confirm "User (student3@example.com)" in "user" search within the gradebook widget exists And I confirm "User (student4@example.com)" in "user" search within the gradebook widget exists And I click on "Dummy User" "list_item" And I wait until the page is ready And the following should exist in the "user-grades" table: | -1- | | Dummy User | And the following should not exist in the "user-grades" table: | -1- | | Teacher 1 | | Student 1 | | User Example | | User Test | | Turtle Manatee | # Case: No users enrolled. And I am on the "Course 2" "grades > Single view > View" page And I click on "Users" "link" in the ".page-toggler" "css_element" And I set the field "Search users" to "a" And I wait until "No results for \"a\"" "text" exists Scenario: A teacher can quickly tell that a search is active on the current table Given I click on "Turtle" in the "user" search widget And I wait until the page is ready # The search input remains in the field on reload this is in keeping with other search implementations. When the field "Search users" matches value "Turtle" And "Turtle Manatee" "option_role" should not exist # Test if we can then further retain the turtle result set and further filter from there. Then I set the field "Search users" to "Turtle plagiarism" And "Turtle Manatee" "list_item" should not exist And I should see "No results for \"Turtle plagiarism\"" Scenario: A teacher can search for values besides the users' name Given I set the field "Search users" to "student5@example.com" And I wait until "Turtle Manatee" "list_item" exists And I set the field "Search users" to "@example.com" And I wait until "Dummy User" "list_item" exists # Note: All learners match this email & showing emails is current default. And I confirm "Dummy User" in "user" search within the gradebook widget exists And I confirm "User Example" in "user" search within the gradebook widget exists And I confirm "User Test" in "user" search within the gradebook widget exists And I confirm "Student 1" in "user" search within the gradebook widget exists And I confirm "Turtle Manatee" in "user" search within the gradebook widget exists # Search on the country field. When I set the field "Search users" to "JP" And I wait until "Dummy User" "list_item" exists And I wait until "Turtle Manatee" "list_item" does not exist And I confirm "Dummy User" in "user" search within the gradebook widget exists And I confirm "User Test" in "user" search within the gradebook widget exists # Search on the city field. And I set the field "Search users" to "Hanoi" And I wait until "User Test" "list_item" does not exist Then I confirm "Student 1" in "user" search within the gradebook widget exists # Search on the institution field. And I set the field "Search users" to "ABCD" And I wait until "Dummy User" "list_item" exists And I confirm "User Example" in "user" search within the gradebook widget exists And I confirm "User Test" in "user" search within the gradebook widget exists And I confirm "Student 1" in "user" search within the gradebook widget exists And I confirm "Turtle Manatee" in "user" search within the gradebook widget exists # Search on the department field. And I set the field "Search users" to "ABC3" And I wait until "User Example" "list_item" does not exist And I confirm "User Test" in "user" search within the gradebook widget exists And I confirm "Turtle Manatee" in "user" search within the gradebook widget exists # Search on the phone1 field. And I set the field "Search users" to "4365899871" And I wait until "User Test" "list_item" does not exist And I confirm "Dummy User" in "user" search within the gradebook widget exists # Search on the phone2 field. And I set the field "Search users" to "2149871323" And I wait until "Dummy User" "list_item" does not exist And I confirm "User Test" in "user" search within the gradebook widget exists # Search on the institution field then press enter to show the record set. And I set the field "Search users" to "ABC" And I wait until "Turtle Manatee" "list_item" exists And I confirm "Dummy User" in "user" search within the gradebook widget exists And I confirm "User Example" in "user" search within the gradebook widget exists And I confirm "User Test" in "user" search within the gradebook widget exists And I confirm "Student 1" in "user" search within the gradebook widget exists And I press the enter key And I wait until the page is ready And the following should exist in the "user-grades" table: | -1- | | Student 1 | | User Example | | User Test | | Dummy User | | Turtle Manatee | And the following should not exist in the "user-grades" table: | -1- | | Teacher 1 | @accessibility Scenario: A teacher can set focus and search using the input are with a keyboard Given I set the field "Search users" to "ABC" # Basic tests for the page. And the page should meet accessibility standards And the page should meet "wcag131, wcag141, wcag412" accessibility standards And the page should meet accessibility standards with "wcag131, wcag141, wcag412" extra tests # Move onto general keyboard navigation testing. When I wait until "Turtle Manatee" "option_role" exists And I press the down key And the focused element is "Student 1" "option_role" And I press the end key And the focused element is "Dummy User" "option_role" And I press the home key And the focused element is "Student 1" "option_role" And I press the up key And the focused element is "Dummy User" "option_role" And I press the down key And the focused element is "Student 1" "option_role" And I press the escape key And the focused element is "Search users" "field" Then I set the field "Search users" to "Goodmeme" And I press the down key And the focused element is "Search users" "field" And I navigate to "View > Single view" in the course gradebook And I click on "Users" "link" in the ".page-toggler" "css_element" And I set the field "Search users" to "ABC" And I wait until "Turtle Manatee" "option_role" exists And I press the down key And the focused element is "Student 1" "option_role" # Lets check the tabbing order. And I set the field "Search users" to "ABC" And I wait until "Turtle Manatee" "option_role" exists And I press the tab key And the focused element is "Clear search input" "button" in the ".user-search" "css_element" And I press the tab key And the focused element is not "Search users" "field" # Ensure we can interact with the clear search with the keyboard. # Sometimes with behat we get unattached nodes causing spurious failures. And I set the field "Search users" to "ABC" And I wait "1" seconds And I press the tab key And the focused element is "Clear search input" "button" in the ".user-search" "css_element" And I press the enter key And I confirm "Turtle Manatee" in "user" search within the gradebook widget does not exist report/singleview/tests/behat/singleview.feature 0000604 00000035744 15062070556 0016230 0 ustar 00 @core @core_grades @gradereport_singleview @javascript Feature: We can use Single view As a teacher In order to view and edit grades For users and activities for a course. Background: Given the following "courses" exist: | fullname | shortname | category | | Course 1 | C1 | 0 | And the following "users" exist: | username | firstname | lastname | email | idnumber | middlename | alternatename | firstnamephonetic | lastnamephonetic | | teacher1 | Teacher | 1 | teacher1@example.com | t1 | | fred | | | | teacher2 | No edit | 1 | teacher2@example.com | t2 | | nick | | | | teacher3 | Teacher | 3 | teacher3@example.com | t3 | | jack | | | | student1 | Grainne | Beauchamp | student1@example.com | s1 | Ann | Jill | Gronya | Beecham | | student2 | Niamh | Cholmondely | student2@example.com | s2 | Jane | Nina | Nee | Chumlee | | student3 | Siobhan | Desforges | student3@example.com | s3 | Sarah | Sev | Shevon | De-forjay | | student4 | Student | 4 | student4@example.com | s4 | | zac | | | And the following "scales" exist: | name | scale | | Test Scale | Disappointing, Good, Very good, Excellent | And the following "grade items" exist: | itemname | course | gradetype | scale | | new grade item 1 | C1 | Scale | Test Scale | And the following "scales" exist: | name | scale | | Test Scale | Disappointing, Good, Very good, Excellent | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | teacher2 | C1 | teacher | | teacher3 | C1 | teacher | | student1 | C1 | student | | student2 | C1 | student | | student3 | C1 | student | | student4 | C1 | student | And the following "grade categories" exist: | fullname | course | | Sub category 1 | C1| | Sub category 2 | C1| And the following "activities" exist: | activity | course | idnumber | name | intro | grade | | assign | C1 | a1 | Test assignment one | Submit something! | 300 | | assign | C1 | a2 | Test assignment two | Submit something! | 100 | | assign | C1 | a3 | Test assignment three | Submit something! | 150 | | assign | C1 | a4 | Test assignment four | Submit nothing! | 150 | And the following "grade items" exist: | itemname | course | gradetype | | Test grade item | C1 | Scale | And the following "permission overrides" exist: | capability | permission | role | contextlevel | reference | | moodle/grade:edit | Allow | teacher | Course | C1 | | gradereport/singleview:view | Allow | teacher | Course | C1 | And the following config values are set as admin: | fullnamedisplay | firstnamephonetic,lastnamephonetic | | alternativefullnameformat | middlename, alternatename, firstname, lastname | And I am on the "Course 1" "grades > Grader report > View" page logged in as "teacher1" Scenario: I can update grades, add feedback and exclude grades. Given I navigate to "View > Single view" in the course gradebook And I click on "Users" "link" in the ".page-toggler" "css_element" And I click on "Student" in the "user" search widget And I turn editing mode on And I set the field "Override for Test assignment one" to "1" When I set the following fields to these values: | Grade for Test assignment one | 10.00 | | Feedback for Test assignment one | test data | And I set the field "Exclude for Test assignment four" to "1" And I press "Save" Then I should see "Grades were set for 2 items" And the field "Exclude for Test assignment four" matches value "1" And the field "Grade for Test assignment one" matches value "10.00" And I set the following fields to these values: | Test grade item | 45 | And I press "Save" Then I should see "Grades were set for 1 items" And the field "Grade for Test grade item" matches value "45.00" And the field "Grade for Course total" matches value "55.00" And I open the action menu in "Test assignment three" "table_row" And I choose "Show all grades" in the open action menu And I click on "Override for Ann, Jill, Grainne, Beauchamp" "checkbox" And I set the following fields to these values: | Grade for Ann, Jill, Grainne, Beauchamp | 12.05 | | Feedback for Ann, Jill, Grainne, Beauchamp | test data2 | And I set the field "Exclude for Jane, Nina, Niamh, Cholmondely" to "1" And I press "Save" Then I should see "Grades were set for 2 items" And the field "Grade for Ann, Jill, Grainne, Beauchamp" matches value "12.05" And the field "Exclude for Jane, Nina, Niamh, Cholmondely" matches value "1" And I click on "new grade item 1" in the "grade" search widget And I set the field "Grade for Ann, Jill, Grainne, Beauchamp" to "Very good" And I press "Save" Then I should see "Grades were set for 1 items" And the following should exist in the "generaltable" table: | First name (Alternate name) Last name | Grade | | Ann, Jill, Grainne, Beauchamp | Very good | And I am on the "Course 1" "grades > Single view > View" page logged in as "teacher2" And I click on "Users" "link" in the ".page-toggler" "css_element" And I click on "Student" in the "user" search widget And I turn editing mode on And the "Exclude for Test assignment one" "checkbox" should be disabled And the "Override for Test assignment one" "checkbox" should be enabled Scenario: Single view links work on grade report. Given I click on grade item menu "Test assignment one" of type "gradeitem" on "grader" page And I choose "Single view for this item" in the open action menu And I should see "Test assignment one" When I navigate to "View > Grader report" in the course gradebook And I click on user menu "Grainne Beauchamp" And I choose "Single view for this user" in the open action menu Then I should see "Gronya,Beecham" Scenario: I can bulk update grades. Given I click on user menu "Grainne Beauchamp" And I choose "Single view for this user" in the open action menu And I should see "Gronya,Beecham" When I turn editing mode on And I click on "Actions" "link" And I click on "Bulk insert" "link" And I click on "I understand that my unsaved changes will be lost." "checkbox" And I click on "All grades" "radio" And I set the field "Insert new grade" to "1.0" And I click on "Save" "button" in the ".modal-dialog" "css_element" Then I should see "Grades were set for 6 items" Scenario: I can bulk update grades with custom decimal separator Given the following "language customisations" exist: | component | stringid | value | | core_langconfig | decsep | # | And I click on user menu "Grainne Beauchamp" And I choose "Single view for this user" in the open action menu And I should see "Gronya,Beecham" When I turn editing mode on And I click on "Actions" "link" And I click on "Bulk insert" "link" And I click on "I understand that my unsaved changes will be lost." "checkbox" And I click on "All grades" "radio" And I set the field "Insert new grade" to "1#25" And I click on "Save" "button" in the ".modal-dialog" "css_element" Then I should see "Grades were set for 6 items" # Custom scale, cast to int And the field "Grade for new grade item 1" matches value "Disappointing" # Value grade, float with custom decsep. And the field "Grade for Test assignment one" matches value "1#25" # Numerical scale, cast to int, showing as float with custom decsep. And the field "Grade for Test grade item" matches value "1#00" Scenario: Navigation works in the Single view. Given I click on user menu "Grainne Beauchamp" And I choose "Single view for this user" in the open action menu Then I should see "Gronya,Beecham" And I follow "Nee,Chumlee" Then I should see "Nee,Chumlee" And I follow "Gronya,Beecham" Then I should see "Gronya,Beecham" And I open the action menu in "Test assignment four" "table_row" And I choose "Show all grades" in the open action menu Then I should see "Test assignment four" And I click on "Test assignment three" in the "grade" search widget Then I should see "Test assignment three" And I click on "Test assignment four" in the "grade" search widget Then I should see "Test assignment four" Scenario: Activities are clickable only when it has a valid activity page. Given I click on user menu "Grainne Beauchamp" And I choose "Single view for this user" in the open action menu And "new grade item 1" "link" should not exist in the "//tbody//tr[position()=1]//td[position()=2]" "xpath_element" Then "Category total" "link" should not exist in the "//tbody//tr[position()=2]//td[position()=2]" "xpath_element" And "Course total" "link" should not exist in the "//tbody//tr[position()=last()]//td[position()=2]" "xpath_element" Scenario: Teacher sees his last viewed singleview report type when navigating back to the gradebook singleview report. Given I navigate to "View > Single view" in the course gradebook And I should see "Search for a user to view all their grades" in the "region-main" "region" And I click on "Grade items" "link" And I should see "Select a grade item above" in the "region-main" "region" When I am on the "Course 1" "grades > Single view > View" page Then I should see "Select a grade item above" in the "region-main" "region" And I am on the "Course 1" "grades > Single view > View" page logged in as "teacher3" And I should see "Search for a user to view all their grades" in the "region-main" "region" Scenario: Teacher sees his last viewed user report when navigating back to the gradebook singleview report. Given I navigate to "View > Single view" in the course gradebook And I click on "Gronya,Beecham" in the "user" search widget And I should see "Gronya,Beecham" in the "region-main" "region" When I am on the "Course 1" "grades > Single view > View" page Then I should not see "Search for a user to view all their grades" in the "region-main" "region" And I should see "Gronya,Beecham" in the "region-main" "region" And I am on the "Course 1" "grades > Single view > View" page logged in as "teacher3" And I should see "Search for a user to view all their grades" in the "region-main" "region" Scenario: Teacher sees his last viewed grade item report when navigating back to the gradebook singleview report. Given I navigate to "View > Single view" in the course gradebook And I click on "Grade items" "link" And I click on "Test assignment one" in the "grade" search widget And I should see "Test assignment one" in the "region-main" "region" When I am on the "Course 1" "grades > Single view > View" page Then I should not see "Select a grade item above" in the "region-main" "region" And I should see "Test assignment one" in the "region-main" "region" And I am on the "Course 1" "grades > Single view > View" page logged in as "teacher3" And I should see "Search for a user to view all their grades" in the "region-main" "region" Scenario: Teacher sees his last viewed user report if the user is a part of the the current group. Given the following "groups" exist: | name | course | idnumber | participation | | Group 1 | C1 | G1 | 1 | And the following "group members" exist: | user | group | | student2 | G1 | And I am on the "Course 1" "course editing" page And I expand all fieldsets And I set the field "Group mode" to "Visible groups" And I press "Save and display" And I navigate to "View > Single view" in the course gradebook And I click on "Nee,Chumlee" in the "user" search widget And I navigate to "View > Grader report" in the course gradebook And I click on "Group 1" in the "group" search widget When I navigate to "View > Single view" in the course gradebook Then I should see "Nee,Chumlee" in the "region-main" "region" And I should not see "Search for a user to view all their grades" in the "region-main" "region" Scenario: Teacher does not see his last viewed user report if the user is not a part of the the current group. Given the following "groups" exist: | name | course | idnumber | participation | | Group 1 | C1 | G1 | 1 | And the following "group members" exist: | user | group | | student2 | G1 | And I am on the "Course 1" "course editing" page And I expand all fieldsets And I set the field "Group mode" to "Visible groups" And I press "Save and display" And I navigate to "View > Single view" in the course gradebook And I click on "Gronya,Beecham" in the "user" search widget And I navigate to "View > Grader report" in the course gradebook And I click on "Group 1" in the "group" search widget When I navigate to "View > Single view" in the course gradebook Then I should see "Search for a user to view all their grades" in the "region-main" "region" And I should not see "Gronya,Beecham" in the "region-main" "region" Scenario: Teacher does not see his last viewed user report if that user is no longer enrolled in the course. Given I navigate to "View > Single view" in the course gradebook And I click on "Gronya,Beecham" in the "user" search widget And I navigate to course participants And I click on "Unenrol" "icon" in the "Gronya,Beecham" "table_row" And I click on "Unenrol" "button" in the "Unenrol" "dialogue" When I am on the "Course 1" "grades > Single view > View" page Then I should see "Search for a user to view all their grades" in the "region-main" "region" And I should not see "Gronya,Beecham" in the "region-main" "region" Scenario: Teacher does not see his last viewed grade item report if the item no longer exists in the course. Given I navigate to "View > Single view" in the course gradebook And I click on "Grade items" "link" And I click on "Test assignment four" in the "grade" search widget And I am on "Course 1" course homepage with editing mode on And I delete "Test assignment four" activity And I run all adhoc tasks When I navigate to "View > Single view" in the course gradebook Then I should see "Select a grade item above" in the "region-main" "region" And I should not see "Test grade item" in the "region-main" "region" report/singleview/tests/behat/reportswitching.feature 0000604 00000002716 15062070556 0017300 0 ustar 00 @core @core_grades @gradereport_singleview @javascript Feature: Given we land on the index page, select what type of report we wish to view. Background: Given the following "courses" exist: | fullname | shortname | category | groupmode | | Course 1 | C1 | 0 | 1 | And the following "users" exist: | username | firstname | lastname | email | idnumber | | teacher1 | Teacher | 1 | teacher1@example.com | t1 | | student1 | Student | 1 | student1@example.com | s1 | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | And the following "activities" exist: | activity | course | idnumber | name | | assign | C1 | a1 | Test assignment one | Scenario: I switch between the two report types within singleview Given I am on the "Course 1" "grades > Single view > View" page logged in as "teacher1" And I click on "Grade items" "link" in the ".page-toggler" "css_element" And "Search users" "field" should not exist And I confirm "Test assignment one" in "grade" search within the gradebook widget exists When I click on "Users" "link" in the ".page-toggler" "css_element" Then "Search users" "field" should exist And "Select a grade item" "combobox" should not exist report/singleview/tests/behat/bulk_insert_grades.feature 0000604 00000020102 15062070556 0017700 0 ustar 00 @core @core_grades @gradereport_singleview @javascript Feature: We can bulk insert grades for students in a course As a teacher In order to quickly grade items I can bulk insert values for all or empty grades. Background: Given the following "courses" exist: | fullname | shortname | category | | Course 1 | C1 | 0 | And the following "users" exist: | username | firstname | lastname | email | idnumber | alternatename | | teacher1 | Teacher | 1 | teacher1@example.com | t1 | fred | | student1 | Student | 1 | student1@example.com | s1 | james | | student2 | Student | 2 | student1@example.com | s2 | holly | | student3 | Student | 3 | student1@example.com | s3 | anna | | student4 | Student | 4 | student1@example.com | s4 | zac | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | | student2 | C1 | student | | student3 | C1 | student | | student4 | C1 | student | And the following "activities" exist: | activity | course | idnumber | name | intro | | assign | C1 | a1 | Test assignment one | Submit something! | | assign | C1 | a2 | Test assignment two | Submit something! | | assign | C1 | a3 | Test assignment three | Submit something! | | assign | C1 | a4 | Test assignment four | Submit nothing! | And I am on the "Course 1" "Course" page logged in as "teacher1" And I turn editing mode on Scenario: I can not save bulk insert until I fill required form elements Given I navigate to "View > Grader report" in the course gradebook And I click on grade item menu "Test assignment one" of type "gradeitem" on "grader" page And I choose "Single view for this item" in the open action menu And I click on "Actions" "link" When I click on "Bulk insert" "link" And the "Empty grades" "radio" should be disabled And the "All grades" "radio" should be disabled And the "[name=bulkinsertmodal]" "css_element" should be disabled And the "[data-action=save]" "css_element" should be disabled And I click on "I understand that my unsaved changes will be lost." "checkbox" And the "Empty grades" "radio" should be enabled And the "All grades" "radio" should be enabled And the "[name=bulkinsertmodal]" "css_element" should be enabled And the "[data-action=save]" "css_element" should be disabled And I click on "Empty grades" "radio" And the "Empty grades" "radio" should be enabled And the "All grades" "radio" should be enabled And the "[name=bulkinsertmodal]" "css_element" should be enabled Then the "[data-action=save]" "css_element" should be enabled Scenario: I can bulk insert grades and check their override flags for grade view. Given I am on the "Test assignment one" "assign activity" page And I follow "View all submissions" And I click on "Grade" "link" in the "Student 1" "table_row" And I set the following fields to these values: | Grade out of 100 | 50 | And I press "Save changes" And I am on "Course 1" course homepage with editing mode on And I navigate to "View > Grader report" in the course gradebook And I click on grade item menu "Test assignment one" of type "gradeitem" on "grader" page And I choose "Single view for this item" in the open action menu And the field "Grade for Student 1" matches value "50.00" And the field "Override for Student 1" matches value "0" And I click on "Actions" "link" And I click on "Bulk insert" "link" And I click on "I understand that my unsaved changes will be lost." "checkbox" And I click on "Empty grades" "radio" And I set the field "Insert new grade" to "1.0" And I click on "Save" "button" in the ".modal-dialog" "css_element" And the field "Grade for Student 1" matches value "50.00" And the field "Override for Student 1" matches value "0" And the field "Grade for Student 2" matches value "1.00" And the field "Override for Student 2" matches value "1" And the field "Grade for Student 3" matches value "1.00" And the field "Override for Student 3" matches value "1" And the field "Grade for Student 4" matches value "1.00" And the field "Override for Student 4" matches value "1" And I click on "Actions" "link" When I click on "Bulk insert" "link" And I click on "I understand that my unsaved changes will be lost." "checkbox" And I click on "All grades" "radio" And I set the field "Insert new grade" to "2.0" And I click on "Save" "button" in the ".modal-dialog" "css_element" And the field "Grade for Student 1" matches value "2.00" And the field "Override for Student 1" matches value "1" And the field "Grade for Student 2" matches value "2.00" And the field "Override for Student 2" matches value "1" And the field "Grade for Student 3" matches value "2.00" And the field "Override for Student 3" matches value "1" And the field "Grade for Student 4" matches value "2.00" Then the field "Override for Student 4" matches value "1" Scenario: I can bulk insert grades and check their override flags for user view. Given I am on the "Test assignment two" "assign activity" page And I follow "View all submissions" And I click on "Grade" "link" in the "Student 1" "table_row" And I set the following fields to these values: | Grade out of 100 | 50 | And I press "Save changes" And I am on "Course 1" course homepage with editing mode on And I navigate to "View > Grader report" in the course gradebook And I click on user menu "Student 1" And I choose "Single view for this user" in the open action menu And the field "Grade for Test assignment two" matches value "50.00" And the field "Override for Test assignment two" matches value "0" And I click on "Actions" "link" When I click on "Bulk insert" "link" And I click on "I understand that my unsaved changes will be lost." "checkbox" And I click on "Empty grades" "radio" And I set the field "Insert new grade" to "1.0" And I click on "Save" "button" in the ".modal-dialog" "css_element" And the field "Grade for Test assignment two" matches value "50.00" And the field "Override for Test assignment two" matches value "0" And the field "Grade for Test assignment one" matches value "1.00" And the field "Override for Test assignment one" matches value "1" And the field "Grade for Test assignment three" matches value "1.00" And the field "Override for Test assignment three" matches value "1" And the field "Grade for Test assignment four" matches value "1.00" Then the field "Override for Test assignment four" matches value "1" Scenario: I can not update grades if the value is out of bounds. Given I navigate to "View > Grader report" in the course gradebook And I click on grade item menu "Test assignment one" of type "gradeitem" on "grader" page And I choose "Single view for this item" in the open action menu And I click on "Actions" "link" When I click on "Bulk insert" "link" And I click on "I understand that my unsaved changes will be lost." "checkbox" And I click on "Empty grades" "radio" And I set the field "Insert new grade" to "-1" And I click on "Save" "button" in the ".modal-dialog" "css_element" And I should see "The grade entered for Test assignment one for Student 1 is less than the minimum allowed" And I should see "The grade entered for Test assignment one for Student 2 is less than the minimum allowed" And I should see "The grade entered for Test assignment one for Student 3 is less than the minimum allowed" And I should see "The grade entered for Test assignment one for Student 4 is less than the minimum allowed" Then I should see "Grades were set for 0 items" report/singleview/tests/behat/pagination.feature 0000604 00000012035 15062070556 0016171 0 ustar 00 @gradereport @gradereport_singleview @javascript Feature: Singleview report pagination In order to consume the content of the report better As a teacher I need the report to be paginated Background: Given the following "courses" exist: | fullname | shortname | | Course 1 | C1 | And the following "users" exist: | username | firstname | lastname | email | | teacher1 | Teacher | 1 | teacher1@example.com | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | And the following "activities" exist: | activity | course | idnumber | name | intro | grade | | assign | C1 | a1 | Test assignment one | Submit something! | 300 | Scenario: Default is used when teachers have no preference yet on singleview report Given "41" "users" exist with the following data: | username | student[count] | | firstname | Student | | lastname | [count] | | email | student[count]@example.com | And "41" "course enrolments" exist with the following data: | user | student[count] | | course | C1 | | role |student | When I am on the "Course 1" "grades > Grader report > View" page logged in as "teacher1" And I click on grade item menu "Test assignment one" of type "gradeitem" on "grader" page And I choose "Single view for this item" in the open action menu Then the field "perpage" matches value "20" # There is also 1 header row. And I should see "21" node occurrences of type "tr" in the "singleview-grades" "table" And I should see "3" in the ".stickyfooter .pagination" "css_element" And I should not see "4" in the ".stickyfooter .pagination" "css_element" Scenario: Teachers can have their preference for the number of students on singleview report Given the following "courses" exist: | fullname | shortname | | Course 2 | C2 | And the following "course enrolments" exist: | user | course | role | | teacher1 | C2 | editingteacher | And the following "activities" exist: | activity | course | idnumber | name | intro | grade | | assign | C2 | a2 | Test assignment two | Submit something! | 300 | When I am on the "Course 1" "grades > Grader report > View" page logged in as "teacher1" And I click on grade item menu "Test assignment one" of type "gradeitem" on "grader" page And I choose "Single view for this item" in the open action menu And I set the field "perpage" to "100" And I am on the "Course 2" "grades > Grader report > View" page And I click on grade item menu "Test assignment two" of type "gradeitem" on "grader" page And I choose "Single view for this item" in the open action menu Then the field "perpage" matches value "100" Scenario: Teachers can change the number of students shown on singleview report Given "101" "users" exist with the following data: | username | student[count] | | firstname | Student | | lastname | [count] | | email | student[count]@example.com | And "101" "course enrolments" exist with the following data: | user | student[count] | | course | C1 | | role |student | When I am on the "Course 1" "grades > Grader report > View" page logged in as "teacher1" And I click on grade item menu "Test assignment one" of type "gradeitem" on "grader" page And I choose "Single view for this item" in the open action menu And I set the field "perpage" to "100" # There is also 1 header row. Then I should see "101" node occurrences of type "tr" in the "singleview-grades" "table" And I should see "2" in the ".stickyfooter .pagination" "css_element" And I should not see "3" in the ".stickyfooter .pagination" "css_element" @javascript Scenario: The pagination bar is only displayed when there is more than one page on singleview report Given "21" "users" exist with the following data: | username | student[count] | | firstname | Student | | lastname | [count] | | email | student[count]@example.com | And "21" "course enrolments" exist with the following data: | user | student[count] | | course | C1 | | role |student | When I am on the "Course 1" "grades > Grader report > View" page logged in as "teacher1" And I click on grade item menu "Test assignment one" of type "gradeitem" on "grader" page And I choose "Single view for this item" in the open action menu # By default, we have 20 students per page. And ".stickyfooter .pagination" "css_element" should exist And I set the field "perpage" to "100" Then ".stickyfooter .pagination" "css_element" should not exist report/singleview/js/singleview.js 0000604 00000007633 15062070556 0013374 0 ustar 00 M.gradereport_singleview = {}; M.gradereport_singleview.init = function(Y) { if (this.initialised) { return; } this.initialised = true; var getColumnIndex = function(cell) { var rowNode = cell.ancestor('tr'); if (!rowNode || !cell) { return; } var cells = rowNode.all('td, th'); return cells.indexOf(cell); }, getNextCell = function(cell) { var n = cell || document.activeElement, next = n.next('td.cell, th.cell'); if (!next) { return null; } // Continue on until we find a navigable cell if (!next || !Y.one(next).one('input:not([type="hidden"]):not([disabled="DISABLED"]), select, a')) { return getNextCell(next); } return next; }, getPrevCell = function(cell) { var n = cell || document.activeElement, next = n.previous('td.cell, th.cell'); if (!next) { return null; } // Continue on until we find a navigable cell if (!Y.one(next).one('input:not([type="hidden"]):not([disabled="DISABLED"]), select, a')) { return getPrevCell(next); } return next; }, getAboveCell = function(cell) { var n = cell || document.activeElement, tr = n.ancestor('tr').previous('tr'), columnIndex = getColumnIndex(n), next = null; if (tr) { next = tr.all('td, th').item(columnIndex); } else { return null; } // Continue on until we find a navigable cell if (!Y.one(next).one('input:not([type="hidden"]):not([disabled="DISABLED"]), select, a')) { return getAboveCell(next); } return next; }, getBelowCell = function(cell) { var n = cell || document.activeElement, tr = n.ancestor('tr').next('tr'), columnIndex = getColumnIndex(n), next = null; if (tr) { next = tr.all('td, th').item(columnIndex); } else { return null; } // Continue on until we find a navigable cell if (!Y.one(next).one('input:not([type="hidden"]):not([disabled="DISABLED"]), select, a')) { return getBelowCell(next); } return next; }; // Add ctrl+arrow controls for navigation Y.one(Y.config.doc.body).delegate('key', function(e) { e.preventDefault(); e.stopPropagation(); var next = null; switch (e.keyCode) { case 37: next = getPrevCell(this.ancestor('td, th')); break; case 38: next = getAboveCell(this.ancestor('td, th')); break; case 39: next = getNextCell(this.ancestor('td, th')); break; case 40: next = getBelowCell(this.ancestor('td, th')); break; } if (next) { Y.one(next).one('input:not([type="hidden"]):not([disabled="DISABLED"]), select, a').focus(); } return; }, 'down:37,38,39,40+ctrl', 'table input, table select, table a'); // Override Toggle. Y.all('input[name^=override_]').each(function(input) { input.on('change', function() { var checked = input.getDOMNode().checked; var names = input.getAttribute('name').split("_"); var itemid = names[1]; var userid = names[2]; var interest = '_' + itemid + '_' + userid; Y.all('input[name$=' + interest + ']').filter('input[type=text]').each(function(text) { text.getDOMNode().disabled = !checked; }); // deal with scales that are not text... UCSB Y.all('select[name$=' + interest + ']').each(function(select) { select.getDOMNode().disabled = !checked; }); }); }); }; report/singleview/classes/event/grade_report_viewed.php 0000604 00000003402 15062070556 0017543 0 ustar 00 <?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/>. /** * Single view report viewed event. * * @package gradereport_singleview * @copyright 2014 Damyon Wiese * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_singleview\event; defined('MOODLE_INTERNAL') || die(); /** * User report viewed event class. * * @package gradereport_singleview * @since Moodle 2.8 * @copyright 2014 Damyon Wiese * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class grade_report_viewed extends \core\event\grade_report_viewed { /** * Returns localised general event name. * * @return string */ public static function get_name() { return get_string('eventgradereportviewed', 'gradereport_singleview'); } /** * Custom validation. * * Throw \coding_exception notice in case of any problems. */ protected function validate_data() { parent::validate_data(); if (!isset($this->relateduserid)) { throw new \coding_exception('The \'relateduserid\' value must be set.'); } } } report/singleview/classes/privacy/provider.php 0000604 00000003023 15062070556 0015710 0 ustar 00 <?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/>. /** * Privacy Subsystem implementation for gradereport_singleview. * * @package gradereport_singleview * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_singleview\privacy; defined('MOODLE_INTERNAL') || die(); /** * Privacy Subsystem for gradereport_singleview implementing null_provider. * * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class provider implements \core_privacy\local\metadata\null_provider { /** * Get the language string identifier with the component's language * file to explain why this plugin stores no data. * * @return string */ public static function get_reason() : string { return 'privacy:metadata'; } } report/singleview/classes/report/singleview.php 0000604 00000015527 15062070556 0016104 0 ustar 00 <?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/>. namespace gradereport_singleview\report; use context_course; use grade_report; use moodle_url; use renderer_base; use stdClass; defined('MOODLE_INTERNAL') || die; require_once($CFG->dirroot . '/grade/report/lib.php'); /** * This class is the main class that must be implemented by a grade report plugin. * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class singleview extends grade_report { /** @var string|null $itemselector The raw HTML of the item selector based on the selected single view item type. */ public ?string $itemselector = null; /** @var \gradereport_singleview\local\screen\screen screen type. */ public $screen; /** * Return the list of valid screens, used to validate the input. * * @return array List of screens. */ public static function valid_screens(): array { // This is a list of all the known classes representing a screen in this plugin. return ['user', 'select', 'grade', 'user_select', 'grade_select']; } /** * Process data from a form submission. Delegated to the current screen. * * @param array $data The data from the form * @return array|object List of warnings */ public function process_data($data) { if (has_capability('moodle/grade:edit', $this->context)) { return $this->screen->process($data); } } /** * Unused - abstract function declared in the parent class. * * @param string $target * @param string $action */ public function process_action($target, $action) { } /** * Constructor for this report. Creates the appropriate screen class based on itemtype. * * @param int $courseid The course id. * @param object $gpr grade plugin return tracking object * @param context_course $context * @param string $itemtype Should be user, select or grade * @param int|null $itemid The id of the user or grade item * @param string|null $unused Used to be group id but that was removed and this is now unused. */ public function __construct( int $courseid, object $gpr, context_course $context, string $itemtype, ?int $itemid, ?string $unused = null ) { parent::__construct($courseid, $gpr, $context); $base = '/grade/report/singleview/index.php'; $idparams = ['id' => $courseid]; $this->baseurl = new moodle_url($base, $idparams); $this->pbarurl = new moodle_url($base, $idparams + [ 'item' => $itemtype, 'itemid' => $itemid ]); // The setup_group method is used to validate group mode and permissions and define the currentgroup value. $this->setup_groups(); if (($itemtype !== 'grade') && ($itemtype !== 'user')) { $itemid = null; } $this->setup_item_selector($itemtype, $itemid); $screenclass = "\\gradereport_singleview\\local\\screen\\{$itemtype}"; $this->screen = new $screenclass($courseid, $itemid, $this->currentgroup); // Load custom or predifined js. $this->screen->js(); } /** * Build the html for the screen. * @return string HTML to display */ public function output(): string { global $OUTPUT; return $OUTPUT->container($this->screen->html()); } protected function setup_groups() { parent::setup_groups(); $this->group_selector = static::groups_course_menu($this->course, $this->pbarurl); } /** * Ideally we should move this function to the base class and call it from the setup_groups in the base class, * so all reports would automatically use it. * * @param stdClass $course * @param moodle_url $urlroot * @return string */ protected static function groups_course_menu(stdClass $course, moodle_url $urlroot) { global $PAGE; $renderer = $PAGE->get_renderer('core_grades'); $params = $urlroot->params(); if ($params['item'] == 'user') { $params['item'] = 'user_select'; $urlroot->params($params); } return $renderer->group_selector($course, $urlroot->out()); } /** * Function used to set the appropriate item selector (raw HTML) based on the selected single view item type. * * @param string $itemtype The single view item type. * @param int|null $itemid The item ID. */ protected function setup_item_selector(string $itemtype, ?int $itemid) { global $PAGE; $renderer = $PAGE->get_renderer('gradereport_singleview'); if ($itemtype === 'user' || $itemtype === 'user_select' ) { $this->itemselector = $renderer->users_selector($this->course, $itemid, $this->currentgroup); } else if ($itemtype === 'grade' || $itemtype === 'grade_select' ) { $this->itemselector = $renderer->grade_items_selector($this->course, $itemid); } } /** * Adds bulk actions menu. * * @param renderer_base $output * @return string HTML to display */ public function bulk_actions_menu(renderer_base $output) : string { $options = [ 'overrideallgrades' => get_string('overrideallgrades', 'gradereport_singleview'), 'overridenonegrades' => get_string('overridenonegrades', 'gradereport_singleview'), 'excludeallgrades' => get_string('excludeallgrades', 'gradereport_singleview'), 'excludenonegrades' => get_string('excludenonegrades', 'gradereport_singleview'), 'bulklegend' => get_string('bulklegend', 'gradereport_singleview') ]; $menu = new \action_menu(); $menu->set_menu_trigger(get_string('actions'), 'text-dark'); foreach ($options as $type => $option) { $action = new \action_menu_link_secondary(new \moodle_url('#'), null, $option, ['data-action' => $type, 'data-role' => 'bulkaction']); $menu->add($action); } $menu->attributes['class'] .= ' float-left my-auto'; return $output->render($menu); } } report/singleview/classes/local/screen/grade_select.php 0000604 00000005365 15062070556 0017406 0 ustar 00 <?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/>. namespace gradereport_singleview\local\screen; /** * The grade search screen. * * @package gradereport_singleview * @copyright 2022 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class grade_select extends screen { public function init($selfitemisempty = false) { } /** * Return the HTML for the page. * * @return string */ public function html(): string { global $OUTPUT, $COURSE, $USER; $userlink = new \moodle_url('/grade/report/singleview/index.php', ['id' => $COURSE->id, 'item' => 'user_select']); $gradelink = new \moodle_url('/grade/report/singleview/index.php', ['id' => $COURSE->id, 'item' => 'grade_select']); $gpr = new \grade_plugin_return(['type' => 'report', 'plugin' => 'singleview', 'courseid' => $COURSE->id, 'userid' => $USER->id]); $context = [ 'courseid' => $gpr->courseid, 'imglink' => $OUTPUT->image_url('zero_state_grade', 'gradereport_singleview'), 'userzerolink' => $userlink->out(false), 'userselectactive' => false, 'gradezerolink' => $gradelink->out(false), 'gradeselectactive' => true, 'displaylabel' => true, 'groupmodeenabled' => $COURSE->groupmode, 'groupactionbaseurl' => 'index.php?item=grade_select', 'groupid' => $gpr->groupid ]; return $OUTPUT->render_from_template('gradereport_singleview/zero_state_grade', $context); } public function item_type(): ?string { return false; } /** * Should we show the base singlereport group selector? * @return bool */ public function display_group_selector(): bool { return false; } /** * Get the heading for the screen. * * @return string */ public function heading(): string { return ' '; } /** * Does this screen support paging? * * @return bool */ public function supports_paging(): bool { return false; } } report/singleview/classes/local/screen/user.php 0000604 00000033267 15062070556 0015745 0 ustar 00 <?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/>. /** * The user screen. * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_singleview\local\screen; use grade_seq; use gradereport_singleview; use moodle_url; use pix_icon; use html_writer; use gradereport_singleview\local\ui\range; use gradereport_singleview\local\ui\bulk_insert; use grade_item; use grade_grade; use stdClass; defined('MOODLE_INTERNAL') || die; /** * The user screen. * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class user extends tablelike implements selectable_items { /** @var array $categories A cache for grade_item categories */ private $categories = []; /** @var int $requirespaging Do we have more items than the paging limit? */ private $requirespaging = true; /** @var array get a valid user. */ public $item = []; /** * Get the label for the select box that chooses items for this page. * @return string */ public function select_label(): string { return get_string('selectgrade', 'gradereport_singleview'); } /** * Get the description for the screen. * * @return string */ public function description(): string { return get_string('gradeitems', 'grades'); } /** * Convert the list of items to a list of options. * * @return array */ public function options(): array { $result = []; foreach ($this->items as $itemid => $item) { $result[$itemid] = $item->get_name(); } return $result; } /** * Get the type of items on this screen. * * @return string */ public function item_type(): string { return 'grade'; } /** * Init the screen * * @param bool $selfitemisempty Have we selected an item yet? */ public function init($selfitemisempty = false) { if (!$selfitemisempty) { $validusers = get_gradable_users($this->courseid, $this->groupid); if (!isset($validusers[$this->itemid])) { // If the passed user id is not valid, show the first user from the list instead. $this->item = reset($validusers); $this->itemid = $this->item->id; } else { $this->item = $validusers[$this->itemid]; } } $seq = new grade_seq($this->courseid, true); $this->items = []; foreach ($seq->items as $itemid => $item) { if (grade::filter($item)) { $this->items[$itemid] = $item; } } // If we change perpage on pagination we might end up with a page that doesn't exist. if ($this->perpage) { $numpages = intval(count($this->items) / $this->perpage) + 1; if ($numpages <= $this->page) { $this->page = 0; } } else { $this->page = 0; } $this->requirespaging = count($this->items) > $this->perpage; $this->setup_structure(); $this->definition = [ 'finalgrade', 'feedback', 'override', 'exclude' ]; $this->set_headers($this->original_headers()); } /** * Get the list of headers for the table. * * @return array List of headers */ public function original_headers(): array { return [ get_string('assessmentname', 'gradereport_singleview'), '', // For filter icon. get_string('gradecategory', 'grades'), get_string('grade', 'grades'), get_string('range', 'grades'), get_string('feedback', 'grades'), get_string('override', 'gradereport_singleview'), get_string('exclude', 'gradereport_singleview'), ]; } /** * Format each row of the table. * * @param grade_item $item * @return array */ public function format_line($item): array { global $OUTPUT; $grade = $this->fetch_grade_or_default($item, $this->item->id); $gradestatus = ''; $context = [ 'hidden' => $grade->is_hidden(), 'locked' => $grade->is_locked(), ]; if (in_array(true, $context)) { $context['classes'] = 'gradestatus'; $gradestatus = $OUTPUT->render_from_template('core_grades/status_icons', $context); } // Create a fake gradetreeitem so we can call get_element_header(). // The type logic below is from grade_category->_get_children_recursion(). $gradetreeitem = []; $type = in_array($item->itemtype, ['course', 'category']) ? "{$item->itemtype}item" : 'item'; $gradetreeitem['type'] = $type; $gradetreeitem['object'] = $item; $gradetreeitem['userid'] = $this->item->id; $itemname = $this->structure->get_element_header($gradetreeitem, true, false, false, false, true); $grade->label = $item->get_name(); $formatteddefinition = $this->format_definition($grade); $itemicon = html_writer::div($this->format_icon($item), 'mr-1'); $itemtype = \html_writer::span($this->structure->get_element_type_string($gradetreeitem), 'd-block text-uppercase small dimmed_text'); // If a behat test site is running avoid outputting the information about the type of the grade item. // This additional information currently causes issues in behat particularly with the existing xpath used to // interact with table elements. if (!defined('BEHAT_SITE_RUNNING')) { $itemcontent = html_writer::div($itemtype . $itemname); } else { $itemcontent = html_writer::div($itemname); } $line = [ html_writer::div($itemicon . $itemcontent, "{$type} d-flex align-items-center"), $this->get_item_action_menu($item), $this->category($item), $formatteddefinition['finalgrade'] . $gradestatus, new range($item), $formatteddefinition['feedback'], $formatteddefinition['override'], $formatteddefinition['exclude'], ]; $lineclasses = [ 'gradeitem', 'action', 'category', 'grade', 'range', ]; $outputline = []; $i = 0; foreach ($line as $key => $value) { $cell = new \html_table_cell($value); if ($isheader = $i == 0) { $cell->header = $isheader; $cell->scope = "row"; } if (array_key_exists($key, $lineclasses)) { $cell->attributes['class'] = $lineclasses[$key]; } $outputline[] = $cell; $i++; } return $outputline; } /** * Helper to get the icon for an item. * * @param grade_item $item * @return string */ private function format_icon($item): string { $element = ['type' => 'item', 'object' => $item]; return $this->structure->get_element_icon($element); } /** * Return the action menu HTML for the grade item. * * @param grade_item $item * @return mixed */ private function get_item_action_menu(grade_item $item) { global $OUTPUT; $menuitems = []; $url = new moodle_url($this->format_link('grade', $item->id)); $title = get_string('showallgrades', 'core_grades'); $menuitems[] = new \action_menu_link_secondary($url, null, $title); $menu = new \action_menu($menuitems); $icon = $OUTPUT->pix_icon('i/moremenu', get_string('actions')); $extraclasses = 'btn btn-link btn-icon icon-size-3 d-flex align-items-center justify-content-center'; $menu->set_menu_trigger($icon, $extraclasses); $menu->set_menu_left(); $menu->set_boundary('window'); return $OUTPUT->render($menu); } /** * Helper to get the category for an item. * * @param grade_item $item * @return string */ private function category(grade_item $item): string { global $DB; if (empty($item->categoryid)) { if ($item->itemtype == 'course') { return $this->course->fullname; } $params = ['id' => $item->iteminstance]; $elem = $DB->get_record('grade_categories', $params); return $elem->fullname; } if (!isset($this->categories[$item->categoryid])) { $category = $item->get_parent_category(); $this->categories[$category->id] = $category; } return $this->categories[$item->categoryid]->get_name(); } /** * Get the heading for the page. * * @return string */ public function heading(): string { return get_string('gradeuser', 'gradereport_singleview', fullname($this->item)); } /** * Get the summary for this table. * * @return string */ public function summary(): string { return get_string('summaryuser', 'gradereport_singleview'); } /** * Default pager * * @return string */ public function pager(): string { global $OUTPUT; if (!$this->supports_paging()) { return ''; } return $OUTPUT->paging_bar( count($this->items), $this->page, $this->perpage, new moodle_url('/grade/report/singleview/index.php', [ 'perpage' => $this->perpage, 'id' => $this->courseid, 'group' => $this->groupid, 'itemid' => $this->itemid, 'item' => 'user' ]) ); } /** * Does this page require paging? * * @return bool */ public function supports_paging(): bool { return $this->requirespaging; } /** * Process the data from the form. * * @param array $data * @return stdClass of warnings */ public function process($data): stdClass { $bulk = new bulk_insert($this->item); // Bulk insert messages the data to be passed in // ie: for all grades of empty grades apply the specified value. if ($bulk->is_applied($data)) { $filter = $bulk->get_type($data); $insertvalue = $bulk->get_insert_value($data); $userid = $this->item->id; foreach ($this->items as $gradeitemid => $gradeitem) { $null = $gradeitem->gradetype == GRADE_TYPE_SCALE ? -1 : ''; $field = "finalgrade_{$gradeitem->id}_{$this->itemid}"; if (isset($data->$field)) { continue; } $oldfinalgradefield = "oldfinalgrade_{$gradeitem->id}_{$this->itemid}"; // Bulk grade changes for all grades need to be processed and shouldn't be skipped if they had a previous grade. if ($gradeitem->is_course_item() || ($filter != 'all' && !empty($data->$oldfinalgradefield))) { if ($gradeitem->is_course_item()) { // The course total should not be overridden. unset($data->$field); unset($data->oldfinalgradefield); $oldoverride = "oldoverride_{$gradeitem->id}_{$this->itemid}"; unset($data->$oldoverride); $oldfeedback = "oldfeedback_{$gradeitem->id}_{$this->itemid}"; unset($data->$oldfeedback); } continue; } $grade = grade_grade::fetch([ 'itemid' => $gradeitemid, 'userid' => $userid ]); $data->$field = empty($grade) ? $null : $grade->finalgrade; $data->{"old$field"} = $data->$field; } foreach ($data as $varname => $value) { if (preg_match('/^oldoverride_(\d+)_(\d+)/', $varname, $matches)) { // If we've selected overriding all grades. if ($filter == 'all') { $override = "override_{$matches[1]}_{$matches[2]}"; $data->$override = '1'; } } if (!preg_match('/^finalgrade_(\d+)_(\d+)/', $varname, $matches)) { continue; } $gradeitem = grade_item::fetch([ 'courseid' => $this->courseid, 'id' => $matches[1], ]); $isscale = ($gradeitem->gradetype == GRADE_TYPE_SCALE); $empties = (trim($value ?? '') === '' || ($isscale && $value == -1)); if ($filter == 'all' || $empties) { $data->$varname = ($isscale && empty($insertvalue)) ? -1 : $insertvalue; } } } return parent::process($data); } } report/singleview/classes/local/screen/grade.php 0000604 00000030273 15062070556 0016043 0 ustar 00 <?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/>. /** * The screen with a list of users. * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_singleview\local\screen; use gradereport_singleview\local\ui\range; use gradereport_singleview\local\ui\bulk_insert; use grade_grade; use grade_item; use moodle_url; use pix_icon; use html_writer; use gradereport_singleview; defined('MOODLE_INTERNAL') || die; /** * The screen with a list of users. * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class grade extends tablelike implements selectable_items, filterable_items { /** * Used for paging * @var int $totalitemcount */ private $totalitemcount = 0; /** * True if this is a manual grade item * @var bool $requiresextra */ private $requiresextra = false; /** * True if there are more users than our limit. * @var bool $requirepaging */ private $requirespaging = true; /** * To store UI element that generates a grade_item min/max range. * @var range; */ protected $range; /** * Returns a grade_item instance or false if none found. * @var grade_item|bool */ public $item; /** * True if $CFG->grade_overridecat is true * * @return bool */ public static function allowcategories(): bool { return get_config('moodle', 'grade_overridecat'); } /** * Filter the list excluding category items (if required)? * @param grade_item $item The grade item. * @return bool */ public static function filter($item): bool { return get_config('moodle', 'grade_overridecat') || !($item->is_course_item() || $item->is_category_item()); } /** * Get the label for the select box that chooses items for this page. * @return string */ public function select_label(): string { return get_string('selectuser', 'gradereport_singleview'); } /** * Get the description of this page * @return string */ public function description(): string { return get_string('users'); } /** * Convert this list of items into an options list * * @return array */ public function options(): array { $options = []; foreach ($this->items as $userid => $user) { $options[$userid] = fullname($user); } return $options; } /** * Return the type of the things in this list. * @return string */ public function item_type(): string { return 'user'; } /** * Get the original settings for this item * @return array */ public function original_definition(): array { return [ 'finalgrade', 'feedback', 'override', 'exclude' ]; } /** * Init this page * * @param bool $selfitemisempty True if we have not selected a user. */ public function init($selfitemisempty = false) { $this->items = get_gradable_users($this->courseid, $this->groupid); $this->totalitemcount = count($this->items); if ($selfitemisempty) { return; } // If we change perpage on pagination we might end up with a page that doesn't exist. if ($this->perpage) { $numpages = intval($this->totalitemcount / $this->perpage) + 1; if ($numpages <= $this->page) { $this->page = 0; } } else { $this->page = 0; } $params = [ 'id' => $this->itemid, 'courseid' => $this->courseid ]; $this->item = grade_item::fetch($params); if (!self::filter($this->item)) { $this->items = []; $this->set_init_error(get_string('gradeitemcannotbeoverridden', 'gradereport_singleview')); } $this->requiresextra = !$this->item->is_manual_item(); $this->setup_structure(); $this->set_definition($this->original_definition()); $this->set_headers($this->original_headers()); } /** * Get the table headers * * @return array */ public function original_headers() { return [ get_string('fullnameuser', 'core'), '', // For filter icon. get_string('grade', 'grades'), get_string('range', 'grades'), get_string('feedback', 'grades'), get_string('override', 'gradereport_singleview'), get_string('exclude', 'gradereport_singleview'), ]; } /** * Format a row in the table * * @param stdClass $item * @return array */ public function format_line($item): array { global $OUTPUT; $grade = $this->fetch_grade_or_default($this->item, $item->id); $gradestatus = ''; $context = [ 'hidden' => $grade->is_hidden(), 'locked' => $grade->is_locked(), ]; if (in_array(true, $context)) { $context['classes'] = 'gradestatus'; $gradestatus = $OUTPUT->render_from_template('core_grades/status_icons', $context); } if (has_capability('moodle/site:viewfullnames', \context_course::instance($this->courseid))) { $fullname = fullname($item, true); } else { $fullname = fullname($item); } $item->imagealt = $fullname; $url = new moodle_url("/user/view.php", ['id' => $item->id, 'course' => $this->courseid]); $grade->label = $fullname; $userpic = $OUTPUT->user_picture($item, ['link' => false, 'visibletoscreenreaders' => false]); $formatteddefinition = $this->format_definition($grade); $line = [ html_writer::link($url, $userpic . $fullname), $this->get_user_action_menu($item), $formatteddefinition['finalgrade'] . $gradestatus, $this->item_range(), $formatteddefinition['feedback'], $formatteddefinition['override'], $formatteddefinition['exclude'], ]; $lineclasses = [ 'user', 'action', 'grade', 'range', ]; $outputline = []; $i = 0; foreach ($line as $key => $value) { $cell = new \html_table_cell($value); if ($isheader = $i == 0) { $cell->header = $isheader; $cell->scope = "row"; } if (array_key_exists($key, $lineclasses)) { $cell->attributes['class'] = $lineclasses[$key]; } $outputline[] = $cell; $i++; } return $outputline; } /** * Get the range ui element for this grade_item * * @return element; */ public function item_range() { if (empty($this->range)) { $this->range = new range($this->item); } return $this->range; } /** * Does this page require paging? * * @return bool */ public function supports_paging(): bool { return $this->requirespaging; } /** * Get the pager for this page. * * @return string */ public function pager(): string { global $OUTPUT; return $OUTPUT->paging_bar( $this->totalitemcount, $this->page, $this->perpage, new moodle_url('/grade/report/singleview/index.php', [ 'perpage' => $this->perpage, 'id' => $this->courseid, 'group' => $this->groupid, 'itemid' => $this->itemid, 'item' => 'grade' ]) ); } /** * Get the heading for this page. * * @return string */ public function heading(): string { return get_string('gradeitem', 'gradereport_singleview', $this->item->get_name()); } /** * Get the summary for this table. * * @return string */ public function summary(): string { return get_string('summarygrade', 'gradereport_singleview'); } /** * Process the data from the form. * * @param array $data * @return \stdClass of warnings */ public function process($data): \stdClass { $bulk = new bulk_insert($this->item); // Bulk insert messages the data to be passed in // ie: for all grades of empty grades apply the specified value. if ($bulk->is_applied($data)) { $filter = $bulk->get_type($data); $insertvalue = $bulk->get_insert_value($data); // Appropriately massage data that may not exist. if ($this->supports_paging()) { $gradeitem = grade_item::fetch([ 'courseid' => $this->courseid, 'id' => $this->item->id ]); $null = $gradeitem->gradetype == GRADE_TYPE_SCALE ? -1 : ''; foreach ($this->items as $itemid => $item) { $field = "finalgrade_{$gradeitem->id}_{$itemid}"; if (isset($data->$field)) { continue; } $grade = grade_grade::fetch([ 'itemid' => $gradeitem->id, 'userid' => $itemid ]); $data->$field = empty($grade) ? $null : $grade->finalgrade; $data->{"old$field"} = $data->$field; } } foreach ($data as $varname => $value) { if (preg_match('/^oldoverride_(\d+)_(\d+)/', $varname, $matches)) { // If we've selected overriding all grades. if ($filter == 'all') { $override = "override_{$matches[1]}_{$matches[2]}"; $data->$override = '1'; } } if (!preg_match('/^finalgrade_(\d+)_/', $varname, $matches)) { continue; } $gradeitem = grade_item::fetch([ 'courseid' => $this->courseid, 'id' => $matches[1] ]); $isscale = ($gradeitem->gradetype == GRADE_TYPE_SCALE); $empties = (trim($value) === '' || ($isscale && $value == -1)); if ($filter == 'all' || $empties) { $data->$varname = ($isscale && empty($insertvalue)) ? -1 : $insertvalue; } } } return parent::process($data); } /** * Return the action menu HTML for the user item. * * @param \stdClass $user * @return mixed */ private function get_user_action_menu(\stdClass $user) { global $OUTPUT; $menuitems = []; $url = new moodle_url($this->format_link('user', $user->id)); $title = get_string('showallgrades', 'core_grades'); $menuitems[] = new \action_menu_link_secondary($url, null, $title); $menu = new \action_menu($menuitems); $icon = $OUTPUT->pix_icon('i/moremenu', get_string('actions')); $extraclasses = 'btn btn-link btn-icon icon-size-3 d-flex align-items-center justify-content-center'; $menu->set_menu_trigger($icon, $extraclasses); $menu->set_menu_left(); $menu->set_boundary('window'); return $OUTPUT->render($menu); } } report/singleview/classes/local/screen/filterable_items.php 0000604 00000002644 15062070556 0020274 0 ustar 00 <?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/>. /** * The gradebook interface for a filterable class. * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_singleview\local\screen; defined('MOODLE_INTERNAL') || die; /** * The gradebook interface for a filterable class. * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ interface filterable_items { /** * Return true/false if this item should be filtered. * @param mixed $item (user or grade_item) * @return bool */ public static function filter($item): bool; } report/singleview/classes/local/screen/user_select.php 0000604 00000005415 15062070556 0017276 0 ustar 00 <?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/>. namespace gradereport_singleview\local\screen; use gradereport_singleview; /** * The user search screen. * * @package gradereport_singleview * @copyright 2022 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class user_select extends screen { public function init($selfitemisempty = false) { } /** * Return the HTML for the page. * * @return string */ public function html(): string { global $OUTPUT, $COURSE, $USER; $userlink = new \moodle_url('/grade/report/singleview/index.php', ['id' => $COURSE->id, 'item' => 'user_select']); $gradelink = new \moodle_url('/grade/report/singleview/index.php', ['id' => $COURSE->id, 'item' => 'grade_select']); $gpr = new \grade_plugin_return(['type' => 'report', 'plugin' => 'singleview', 'courseid' => $COURSE->id, 'userid' => $USER->id]); $context = [ 'courseid' => $gpr->courseid, 'imglink' => $OUTPUT->image_url('zero_state_user', 'gradereport_singleview'), 'userzerolink' => $userlink->out(false), 'userselectactive' => true, 'gradezerolink' => $gradelink->out(false), 'gradeselectactive' => false, 'displaylabel' => true, 'groupmodeenabled' => $COURSE->groupmode, 'groupactionbaseurl' => 'index.php?item=user_select', 'groupid' => $gpr->groupid ]; return $OUTPUT->render_from_template('gradereport_singleview/zero_state_user', $context); } public function item_type(): ?string { return false; } /** * Should we show the base singlereport group selector? * @return bool */ public function display_group_selector(): bool { return false; } /** * Get the heading for the screen. * * @return string */ public function heading(): string { return ' '; } /** * Does this screen support paging? * * @return bool */ public function supports_paging(): bool { return false; } } report/singleview/classes/local/screen/tablelike.php 0000604 00000015364 15062070556 0016721 0 ustar 00 <?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/>. /** * The gradebook simple view - base class for the table * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_singleview\local\screen; use gradereport_singleview\local\ui\be_readonly; use html_table; use html_writer; use stdClass; use grade_grade; use gradereport_singleview\local\ui\bulk_insert; defined('MOODLE_INTERNAL') || die; /** * The gradebook simple view - base class for the table * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ abstract class tablelike extends screen implements be_readonly { /** * A list of table headers * @var array $headers */ protected $headers = []; /** * A list of errors that mean we should not show the table * @var array $initerrors */ protected $initerrors = []; /** * Describes the columns in the table * @var array $definition */ protected $definition = []; /** * Total items * @var int $total */ protected $total; /** * Table tab index * @var int $index */ protected $index; /** * The grade item or user. * @var mixed $item */ protected $item; /** * Format a row of the table * * @var mixed $item * @return array */ abstract public function format_line($item): array; /** * Get the summary for this table. * * @return string */ abstract public function summary(): string; /** * Get the table headers * * @return array */ public function headers(): array { return $this->headers; } /** * Set the table headers * * @param array $overwrite New headers * @return tablelike This */ public function set_headers(array $overwrite): tablelike { $this->headers = $overwrite; return $this; } /** * Get the list of errors * * @return array */ public function init_errors(): array { return $this->initerrors; } /** * Set an error detected while building the page. * * @param string $mesg */ public function set_init_error(string $mesg) { $this->initerrors[] = $mesg; } /** * Get the table definition * * @return array The definition. */ public function definition(): array { return $this->definition; } /** * Set the table definition * * @param array $overwrite New definition * @return tablelike This */ public function set_definition(array $overwrite): tablelike { $this->definition = $overwrite; return $this; } /** * Get a element to generate the HTML for this table row * @param grade_grade $grade The grade. * @return array */ public function format_definition(grade_grade $grade): array { $line = []; foreach ($this->definition() as $i => $field) { // Table tab index. $tab = ($i * $this->total) + $this->index; $classname = '\\gradereport_singleview\\local\\ui\\' . $field; $html = new $classname($grade, $tab); if ($field == 'finalgrade' and !empty($this->structure)) { $html .= $this->structure->get_grade_action_menu($grade); } // Singleview users without proper permissions should be presented // disabled checkboxes for the Exclude grade attribute. if ($field == 'exclude' && !has_capability('moodle/grade:manage', $this->context)) { $html->disabled = true; } $line[$field] = $html; } return $line; } /** * Get the HTML for the whole table * @return string */ public function html(): string { global $OUTPUT; if (!empty($this->initerrors)) { $warnings = ''; foreach ($this->initerrors as $mesg) { $warnings .= $OUTPUT->notification($mesg); } return $warnings; } $table = new html_table(); $table->id = 'singleview-grades'; $table->head = $this->headers(); $summary = $this->summary(); if (!empty($summary)) { $table->caption = $summary; $table->captionhide = true; } // To be used for extra formatting. $this->index = 0; $this->total = count($this->items); foreach ($this->items as $item) { if ($this->index >= ($this->perpage * $this->page) && $this->index < ($this->perpage * ($this->page + 1))) { $table->data[] = $this->format_line($item); } $this->index++; } $data = new stdClass(); $data->table = $table; $data->instance = $this; $html = html_writer::table($table); return html_writer::div($html, 'reporttable position-relative'); } /** * Get the HTML for the bulk insert form * * @return string */ public function bulk_insert() { return html_writer::tag( 'div', (new bulk_insert($this->item))->html(), ['class' => 'singleview_bulk', 'hidden' => 'hidden'] ); } /** * Return true if this is read-only. * * @return bool */ public function is_readonly(): bool { global $USER; return empty($USER->editing); } /** * Get the buttons for saving changes. * @param bool $disabled If button is disabled * * @return array */ public function buttons(bool $disabled = false): array { global $OUTPUT; $params = ['type' => 'submit', 'value' => get_string('save', 'gradereport_singleview')]; if ($disabled) { $params['disabled'] = 'disabled'; } return [$OUTPUT->render_from_template('gradereport_singleview/button', $params)]; } } report/singleview/classes/local/screen/screen.php 0000604 00000032441 15062070556 0016237 0 ustar 00 <?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/>. /** * Abstract class used as a base for the 3 screens. * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_singleview\local\screen; use context_course; use moodle_url; use html_writer; use grade_structure; use grade_grade; use grade_item; use stdClass; defined('MOODLE_INTERNAL') || die; /** * Abstract class used as a base for the 3 screens. * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ abstract class screen { /** * The id of the course * @var int $courseid */ protected $courseid; /** * Either a user id or a grade_item id * @var int|null $itemid */ protected $itemid; /** * The currently set groupid (if set) * @var int $groupid */ protected $groupid; /** * The course context * @var context_course $context */ protected $context; /** * The page number * @var int $page */ protected $page; /** * Results per page * @var int $perpage */ protected $perpage; /** * List of items on the page, they could be users or grade_items * @var array $items */ protected $items; /** @var int Maximum number of students that can be shown on one page */ protected static $maxperpage = 5000; /** * List of allowed values for 'perpage' setting * @var array $validperpage */ protected static $validperpage = [20, 100]; /** * To store course data * @var stdClass */ protected $course; /** * General structure representing grade items in course * @var grade_structure */ protected $structure; /** * Constructor * * @param int $courseid The course id * @param int|null $itemid The item id * @param int|null $groupid The group id */ public function __construct(int $courseid, ?int $itemid, ?int $groupid = null) { global $DB; $this->courseid = $courseid; $this->itemid = $itemid; $this->groupid = $groupid; $this->context = context_course::instance($this->courseid); $this->course = $DB->get_record('course', ['id' => $courseid]); $this->page = optional_param('page', 0, PARAM_INT); $cache = \cache::make_from_params(\cache_store::MODE_SESSION, 'gradereport_singleview', 'perpage'); $perpage = optional_param('perpage', null, PARAM_INT); if (!in_array($perpage, self::$validperpage) && ($perpage !== 0)) { // Get from cache. $perpage = $cache->get(get_class($this)); } else { // Save to cache. $cache->set(get_class($this), $perpage); } if (isset($perpage) && $perpage) { $this->perpage = $perpage; } else { // Get from cache. $perpage = $cache->get(get_class($this)); $this->perpage = ($perpage === 0) ? $perpage : min(self::$validperpage); } $this->init(empty($itemid)); } /** * Cache the grade_structure class */ public function setup_structure() { $this->structure = new grade_structure(); $this->structure->modinfo = get_fast_modinfo($this->course); } /** * Create a nice link from a thing (user or grade_item). * * @param string $screen * @param int $itemid * @param bool|null $display Should we wrap this in an anchor ? * @return string The link */ public function format_link(string $screen, int $itemid, bool $display = null): string { $url = new moodle_url('/grade/report/singleview/index.php', [ 'id' => $this->courseid, 'item' => $screen, 'itemid' => $itemid, 'group' => $this->groupid, ]); if ($display) { return html_writer::link($url, $display); } else { return $url; } } /** * Get the grade_grade * * @param grade_item $item The grade_item * @param int $userid The user id * @return grade_grade */ public function fetch_grade_or_default(grade_item $item, int $userid): grade_grade { $grade = grade_grade::fetch([ 'itemid' => $item->id, 'userid' => $userid ]); if (!$grade) { $default = new stdClass; $default->userid = $userid; $default->itemid = $item->id; $default->feedback = ''; $grade = new grade_grade($default, false); } $grade->grade_item = $item; return $grade; } /** * Get the default heading for the screen. * * @return string */ public function heading(): string { return get_string('entrypage', 'gradereport_singleview'); } /** * Override this to init the screen. * * @param boolean $selfitemisempty True if no item has been selected yet. */ abstract public function init(bool $selfitemisempty = false); /** * Get the type of items in the list. * * @return null|string */ abstract public function item_type(): ?string; /** * Get the entire screen as a string. * * @return string */ abstract public function html(): string; /** * Does this screen support paging? * * @return bool */ public function supports_paging(): bool { return true; } /** * Default pager * * @return string */ public function pager(): string { return ''; } /** * Initialise the js for this screen. */ public function js() { global $PAGE; $module = [ 'name' => 'gradereport_singleview', 'fullpath' => '/grade/report/singleview/js/singleview.js', 'requires' => ['base', 'dom', 'event', 'event-simulate', 'io-base'] ]; $PAGE->requires->strings_for_js(['overridenoneconfirm', 'removeoverride', 'removeoverridesave'], 'gradereport_singleview'); $PAGE->requires->js_init_call('M.gradereport_singleview.init', [], false, $module); } /** * Process the data from a form submission. * * @param array|object $data * @return stdClass of warnings */ public function process($data): stdClass { $warnings = []; $fields = $this->definition(); // Avoiding execution timeouts when updating // a large amount of grades. $progress = 0; $progressbar = new \core\progress\display_if_slow(); $progressbar->start_html(); $progressbar->start_progress(get_string('savegrades', 'gradereport_singleview'), count((array) $data) - 1); $changecount = []; // This array is used to determine if the override should be excluded from being counted as a change. $ignorevalues = []; foreach ($data as $varname => $throw) { $progressbar->progress($progress); $progress++; if (preg_match("/(\w+)_(\d+)_(\d+)/", $varname, $matches)) { $itemid = $matches[2]; $userid = $matches[3]; } else { continue; } $gradeitem = grade_item::fetch([ 'id' => $itemid, 'courseid' => $this->courseid ]); if (preg_match('/^old[oe]{1}/', $varname)) { $elementname = preg_replace('/^old/', '', $varname); if (!isset($data->$elementname)) { // Decrease the progress because we've increased the // size of the array we are iterating through. $progress--; $data->$elementname = false; } } if (!in_array($matches[1], $fields)) { continue; } if (!$gradeitem) { continue; } $grade = $this->fetch_grade_or_default($gradeitem, $userid); $classname = '\\gradereport_singleview\\local\\ui\\' . $matches[1]; $element = new $classname($grade); $name = $element->get_name(); $oldname = "old$name"; $posted = $data->$name; $format = $element->determine_format(); if ($format->is_textbox() and trim($data->$name) === '') { $data->$name = null; } // Same value; skip. if (isset($data->$oldname) && $data->$oldname == $posted) { continue; } // If the user submits Exclude grade elements without the proper. // permissions then we should refuse to update. if ($matches[1] === 'exclude' && !has_capability('moodle/grade:manage', $this->context)){ $warnings[] = get_string('nopermissions', 'error', get_string('grade:manage', 'role')); continue; } $msg = $element->set($posted); // Value to check against our list of matchelements to ignore. $check = explode('_', $varname, 2); // Optional type. if (!empty($msg)) { $warnings[] = $msg; if ($element instanceof \gradereport_singleview\local\ui\finalgrade) { // Add this value to this list so that the override object that is coming next will also be skipped. $ignorevalues[$check[1]] = $check[1]; // This item wasn't changed so don't add to the changecount. continue; } } // Check to see if this value has already been skipped. if (array_key_exists($check[1], $ignorevalues)) { continue; } if (preg_match('/_(\d+)_(\d+)/', $varname, $matchelement)) { $changecount[$matchelement[0]] = 1; } } // Some post-processing. $eventdata = new stdClass; $eventdata->warnings = $warnings; $eventdata->post_data = $data; $eventdata->instance = $this; $eventdata->changecount = $changecount; $progressbar->end_html(); return $eventdata; } /** * By default, there are no options. * @return array */ public function options(): array { return []; } /** * Should we show the group selector? * @return bool */ public function display_group_selector(): bool { return true; } /** * Should we show the next prev selector? * @return bool */ public function supports_next_prev(): bool { return true; } /** * Load a valid list of users for this gradebook as the screen "items". * * @deprecated since Moodle 4.3 * @return array A list of enroled users. */ protected function load_users(): array { debugging('The function ' . __FUNCTION__ . '() is deprecated. Please use get_gradable_users() instead.', DEBUG_DEVELOPER); return get_gradable_users($this->courseid, $this->groupid); } /** * Allow selection of number of items to display per page. * @return string */ public function perpage_select(): string { global $PAGE, $OUTPUT; $url = new moodle_url($PAGE->url); $numusers = count($this->items); // Print per-page dropdown. $pagingoptions = self::$validperpage; if ($this->perpage) { $pagingoptions[] = $this->perpage; // To make sure the current preference is within the options. } $pagingoptions = array_unique($pagingoptions); sort($pagingoptions); $pagingoptions = array_combine($pagingoptions, $pagingoptions); if ($numusers > self::$maxperpage) { $pagingoptions['0'] = self::$maxperpage; } else { $pagingoptions['0'] = get_string('all'); } $perpagedata = [ 'baseurl' => $url->out(false), 'options' => [] ]; foreach ($pagingoptions as $key => $name) { $perpagedata['options'][] = [ 'name' => $name, 'value' => $key, 'selected' => $key == $this->perpage, ]; } // The number of students per page is always limited even if it is claimed to be unlimited. $this->perpage = $this->perpage ?: self::$maxperpage; $perpagedata['pagingbar'] = $this->pager(); return $OUTPUT->render_from_template('gradereport_singleview/perpage', $perpagedata);; } } report/singleview/classes/local/screen/select.php 0000604 00000015722 15062070556 0016242 0 ustar 00 <?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/>. /** * The gradebook simple view - initial view to select your search options * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_singleview\local\screen; use gradereport_singleview; use moodle_url; defined('MOODLE_INTERNAL') || die; /** * The gradebook simple view - initial view to select your search options * * @deprecated since Moodle 4.3 * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class select extends screen { /** @var \stdClass course data. */ public $item; /** * Initialise this screen * * @deprecated since Moodle 4.3 * @param bool $selfitemisempty Has an item been selected (will be false) */ public function init($selfitemisempty = false) { global $DB; debugging('The function ' . __FUNCTION__ . '() is deprecated as part of the deprecation process of the ' . '\gradereport_singleview\local\screen\select class which is no longer used.', DEBUG_DEVELOPER); $roleids = explode(',', get_config('moodle', 'gradebookroles')); $this->items = []; foreach ($roleids as $roleid) { // Keeping the first user appearance. $this->items = $this->items + get_role_users( $roleid, $this->context, false, '', 'u.id, u.lastname, u.firstname', null, $this->groupid, $this->perpage * $this->page, $this->perpage ); } $this->item = $DB->get_record('course', ['id' => $this->courseid]); } /** * Get the type of items on this screen, not valid so return false. * * @deprecated since Moodle 4.3 * @return string|null */ public function item_type(): ?string { debugging('The function ' . __FUNCTION__ . '() is deprecated as part of the deprecation process of the ' . '\gradereport_singleview\local\screen\select class which is no longer used.', DEBUG_DEVELOPER); return false; } /** * Return the HTML for the page. * * @deprecated since Moodle 4.3 * @return string */ public function html(): string { global $OUTPUT, $COURSE; debugging('The function ' . __FUNCTION__ . '() is deprecated as part of the deprecation process of the ' . '\gradereport_singleview\local\screen\select class which is no longer used.', DEBUG_DEVELOPER); if ($this->itemid === null) { $userlink = new \moodle_url('/grade/report/singleview/index.php', ['id' => $COURSE->id, 'item' => 'user_select']); $gradelink = new \moodle_url('/grade/report/singleview/index.php', ['id' => $COURSE->id, 'item' => 'grade_select']); $context = [ 'courseid' => $COURSE->id, 'imglink' => $OUTPUT->image_url('zero_state', 'gradereport_singleview'), 'userzerolink' => $userlink->out(false), 'userselectactive' => false, 'gradezerolink' => $gradelink->out(false), 'gradeselectactive' => false, 'displaylabel' => false ]; return $OUTPUT->render_from_template('gradereport_singleview/zero_state', $context); } $html = ''; $types = gradereport_singleview\report\singleview::valid_screens(); foreach ($types as $type) { $classname = "gradereport_singleview\\local\\screen\\{$type}"; $screen = new $classname($this->courseid, null, $this->groupid); if (!$screen instanceof selectable_items) { continue; } $options = $screen->options(); if (empty($options)) { continue; } $params = [ 'id' => $this->courseid, 'item' => $screen->item_type(), 'group' => $this->groupid ]; $url = new moodle_url('/grade/report/singleview/index.php', $params); $select = new \single_select($url, 'itemid', $options, '', ['' => $screen->select_label()]); $select->set_label($screen->select_label(), ['class' => 'accesshide']); $html .= $OUTPUT->render($select); } $html = $OUTPUT->container($html, 'selectitems'); if (empty($html)) { $OUTPUT->notification(get_string('noscreens', 'gradereport_singleview')); } return $html; } /** * Should we show the next prev selector? * * @deprecated since Moodle 4.3 * @return bool */ public function supports_next_prev(): bool { debugging('The function ' . __FUNCTION__ . '() is deprecated as part of the deprecation process of the ' . '\gradereport_singleview\local\screen\select class which is no longer used.', DEBUG_DEVELOPER); return false; } /** * Should we show the base singlereport group selector? * * @deprecated since Moodle 4.3 * @return bool */ public function display_group_selector(): bool { debugging('The function ' . __FUNCTION__ . '() is deprecated as part of the deprecation process of the ' . '\gradereport_singleview\local\screen\select class which is no longer used.', DEBUG_DEVELOPER); if ($this->itemid === null) { return false; } return true; } /** * Get the heading for the screen. * * @deprecated since Moodle 4.3 * @return string */ public function heading(): string { debugging('The function ' . __FUNCTION__ . '() is deprecated as part of the deprecation process of the ' . '\gradereport_singleview\local\screen\select class which is no longer used.', DEBUG_DEVELOPER); return ' '; } /** * Does this screen support paging? * * @deprecated since Moodle 4.3 * @return bool */ public function supports_paging(): bool { debugging('The function ' . __FUNCTION__ . '() is deprecated as part of the deprecation process of the ' . '\gradereport_singleview\local\screen\select class which is no longer used.', DEBUG_DEVELOPER); return false; } } report/singleview/classes/local/screen/selectable_items.php 0000604 00000003360 15062070556 0020262 0 ustar 00 <?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/>. /** * Interface for a list of selectable things. * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_singleview\local\screen; defined('MOODLE_INTERNAL') || die; /** * Interface for a list of selectable things. * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ interface selectable_items { /** * Get the description of this list * @return string */ public function description(): string; /** * Get the label for the select box that chooses items for this page. * @return string */ public function select_label(): string; /** * Get the list of options to show. * @return array */ public function options(): array; /** * Get type of things in the list (gradeitem or user) * @return string */ public function item_type(): string; } report/singleview/classes/local/ui/attribute_format.php 0000604 00000003211 15062070556 0017462 0 ustar 00 <?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/>. /** * Class that builds an element tree that can be converted to a string * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_singleview\local\ui; defined('MOODLE_INTERNAL') || die; /** * Class that builds an element tree that can be converted to a string * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ abstract class attribute_format { /** * Used to convert this class to an "element" which can be converted to a string. * @return element */ abstract public function determine_format(): element; /** * Convert this to an element and then to a string * @return string */ public function __toString(): string { return $this->determine_format()->html(); } } report/singleview/classes/local/ui/be_readonly.php 0000604 00000002271 15062070556 0016377 0 ustar 00 <?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/>. /** * be_readonly interface. * * @package gradereport_singleview * @copyright 2022 Shamim Rezaie <shamim@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_singleview\local\ui; /** * Simple interface implemented to add behaviour that an element can be checked to see * if it should be read-only. */ interface be_readonly { /** * Return true if this is read-only. * * @return bool */ public function is_readonly(): bool; } report/singleview/classes/local/ui/text_attribute.php 0000604 00000005760 15062070556 0017171 0 ustar 00 <?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/>. /** * UI element for a text input field. * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_singleview\local\ui; defined('MOODLE_INTERNAL') || die; /** * UI element for a text input field. * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class text_attribute extends element { /** * Is this input disabled? * @var bool $isdisabled */ private $isdisabled; /** @var bool If this is a read-only input. */ private bool $isreadonly; /** * Constructor * * @param string $name The input name (the first bit) * @param string $value The input initial value. * @param string $label The label for this input field. * @param bool $isdisabled Is this input disabled. * @param bool $isreadonly If this is a read-only input. */ public function __construct(string $name, string $value, string $label, bool $isdisabled = false, bool $isreadonly = false) { $this->isdisabled = $isdisabled; $this->isreadonly = $isreadonly; parent::__construct($name, $value, $label); } /** * Nasty function allowing custom textbox behaviour outside the class. * @return bool Is this a textbox. */ public function is_textbox(): bool { return true; } /** * Render the html for this field. * @return string The HTML. */ public function html(): string { global $OUTPUT; $context = (object) [ 'id' => $this->name, 'name' => $this->name, 'value' => $this->value, 'disabled' => $this->isdisabled, 'readonly' => $this->isreadonly, ]; $context->label = ''; if (preg_match("/^feedback/", $this->name)) { $context->label = get_string('feedbackfor', 'gradereport_singleview', $this->label); } else if (preg_match("/^finalgrade/", $this->name)) { $context->label = get_string('gradefor', 'gradereport_singleview', $this->label); } return $OUTPUT->render_from_template('gradereport_singleview/text_attribute', $context); } } report/singleview/classes/local/ui/grade_attribute_format.php 0000604 00000004533 15062070556 0020634 0 ustar 00 <?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/>. /** * Abstract class for a form element representing something about a grade_grade. * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_singleview\local\ui; use grade_grade; defined('MOODLE_INTERNAL') || die; /** * Abstract class for a form element representing something about a grade_grade. * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ abstract class grade_attribute_format extends attribute_format implements unique_name { /** * The first part of the name attribute of the form input * @var string $name */ public $name; /** * The label of the input * @var null|string $label */ public $label; /** * The grade_grade of the input * @var grade_grade $grade */ public $grade; /** * Constructor * * @param grade_grade $grade The grade_grade we are editing. */ public function __construct($grade = 0) { $this->grade = $grade; } /** * Get a unique name for this form input * * @return string The form input name attribute. */ public function get_name(): string { return "{$this->name}_{$this->grade->itemid}_{$this->grade->userid}"; } /** * Should be overridden by the child class to save the value returned in this input. * * @param string $value The value from the form. * @return string Any error message */ abstract public function set($value); } report/singleview/classes/local/ui/feedback.php 0000604 00000007640 15062070557 0015646 0 ustar 00 <?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/>. /** * Class used to render a feedback input box. * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_singleview\local\ui; defined('MOODLE_INTERNAL') || die; /** * Class used to render a feedback input box. * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class feedback extends grade_attribute_format implements unique_value, be_disabled, be_readonly { /** * Name of this input * @var string $name */ public $name = 'feedback'; /** * Get the value for this input. * * @return string The value */ public function get_value(): ?string { return $this->grade->feedback ? $this->grade->feedback : ''; } /** * Get the string to use in the label for this input. * * @return string The label text */ public function get_label(): string { if (!isset($this->grade->label)) { $this->grade->label = ''; } return $this->grade->label; } /** * Determine if this input should be disabled based on the other settings. * * @return boolean Should this input be disabled when the page loads. */ public function is_disabled(): bool { $locked = 0; $gradeitemlocked = 0; $overridden = 0; /* Disable editing if grade item or grade score is locked * if any of these items are set, then we will disable editing * at some point, we might want to show the reason for the lock * this code could be simplified, but its more readable for steve's little mind */ if (!empty($this->grade->locked)) { $locked = 1; } if (!empty($this->grade->grade_item->locked)) { $gradeitemlocked = 1; } if ($this->grade->grade_item->is_overridable_item() and !$this->grade->is_overridden()) { $overridden = 1; } return ($locked || $gradeitemlocked || $overridden); } /** * Return true if this is read-only. * * @return bool */ public function is_readonly(): bool { global $USER; return empty($USER->editing); } /** * Create a text_attribute for this ui element. * * @return element */ public function determine_format(): element { return new text_attribute( $this->get_name(), $this->get_value(), $this->get_label(), $this->is_disabled(), $this->is_readonly() ); } /** * Update the value for this input. * * @param string $value The new feedback value. * @return null|string Any error message */ public function set($value) { $finalgrade = false; $trimmed = trim($value); if (empty($trimmed)) { $feedback = null; } else { $feedback = $value; } $this->grade->grade_item->update_final_grade( $this->grade->userid, $finalgrade, 'singleview', $feedback, FORMAT_MOODLE ); } } report/singleview/classes/local/ui/bulk_insert.php 0000604 00000007555 15062070557 0016450 0 ustar 00 <?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/>. /** * Checkbox element used for bulk inserting values in the gradebook. * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_singleview\local\ui; defined('MOODLE_INTERNAL') || die; /** * Checkbox element used for bulk inserting values in the gradebook. * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class bulk_insert extends element { /** @var string $applyname To store the "apply" suffix. */ protected $applyname; /** @var string $selectname To store the "type" suffix. */ protected $selectname; /** @var string $insertname To store the "value" suffix. */ protected $insertname; /** * Constructor * * @param mixed $item The grade item or user. */ public function __construct($item) { $this->name = 'bulk_' . $item->id; $this->applyname = $this->name_for('apply'); $this->selectname = $this->name_for('type'); $this->insertname = $this->name_for('value'); } /** * Is this checkbox checked? * * @param array|object $data The form data * @return bool */ public function is_applied($data): bool { return isset($data->{$this->applyname}); } /** * Get the type of this input (user or grade) * * @param array|object $data The form data * @return string */ public function get_type($data): string { return $data->{$this->selectname}; } /** * Get the value from either the user or grade. * * @param array|object $data The form data * @return string */ public function get_insert_value($data): string { return $data->{$this->insertname}; } /** * Generate the html for this form element. * * @return string HTML */ public function html(): string { global $OUTPUT; $text = new text_attribute($this->insertname, "0", 'bulk'); $context = (object) [ 'label' => get_string('bulklegend', 'gradereport_singleview'), 'applylabel' => get_string('bulkperform', 'gradereport_singleview'), 'applyname' => $this->applyname, 'menuname' => $this->selectname, 'menulabel' => get_string('bulkappliesto', 'gradereport_singleview'), 'menuoptions' => [ ['value' => 'all', 'name' => get_string('all_grades', 'gradereport_singleview')], ['value' => 'blanks', 'name' => get_string('blanks', 'gradereport_singleview'), 'selected' => true], ], 'valuename' => $this->insertname, 'valuefield' => $text->html() ]; return $OUTPUT->render_from_template('gradereport_singleview/bulk_insert', $context); } /** * This form element has 3 elements with different suffixes. * Generate the name with the suffix. * * @param string $extend The suffix. * @return string */ private function name_for($extend) { return "{$this->name}_$extend"; } } report/singleview/classes/local/ui/empty_element.php 0000604 00000003277 15062070557 0016773 0 ustar 00 <?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/>. /** * Element that just generates some text. * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_singleview\local\ui; defined('MOODLE_INTERNAL') || die; /** * Element that just generates some text. * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class empty_element extends element { /** @var string message text. */ private $text; /** * Constructor * * @param string|null $msg The text */ public function __construct(?string $msg = null) { if (is_null($msg)) { $this->text = ' '; } else { $this->text = $msg; } } /** * Generate the html (simple case) * * @return string HTML */ public function html(): string { return $this->text; } } report/singleview/classes/local/ui/checkbox_attribute.php 0000604 00000007237 15062070557 0017775 0 ustar 00 <?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/>. /** * A checkbox ui element. * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_singleview\local\ui; use html_writer; defined('MOODLE_INTERNAL') || die; /** * A checkbox ui element. * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class checkbox_attribute extends element { /** @var bool $ischecked Is it checked? */ private $ischecked; /** @var bool If this is a read-only input. */ private bool $isreadonly; /** @var int Is this element locked either 0 or a time. */ protected int $locked; /** * Constructor * * @param string $name The element name * @param string $label The label for the form element * @param bool $ischecked Is this thing on? * @param int $locked Is this element locked either 0 or a time. * @param bool $isreadonly If this is a read-only input. */ public function __construct(string $name, string $label, bool $ischecked = false, int $locked=0, bool $isreadonly = false) { $this->ischecked = $ischecked; $this->locked = $locked; $this->isreadonly = $isreadonly; parent::__construct($name, 1, $label); } /** * Nasty function allowing checkbox logic to escape the class. * @return bool */ public function is_checkbox(): bool { return true; } /** * Generate the HTML * * @return string */ public function html(): string { global $OUTPUT; $attributes = [ 'type' => 'checkbox', 'name' => $this->name, 'value' => 1, 'id' => $this->name ]; // UCSB fixed user should not be able to override locked grade. if ( $this->locked) { $attributes['disabled'] = 'DISABLED'; } $hidden = [ 'type' => 'hidden', 'name' => 'old' . $this->name ]; if ($this->ischecked) { $attributes['checked'] = 'CHECKED'; $hidden['value'] = 1; } $type = "override"; if (preg_match("/^exclude/", $this->name)) { $type = "exclude"; } if (!$this->isreadonly) { return ( html_writer::tag('label', get_string($type . 'for', 'gradereport_singleview', $this->label), ['for' => $this->name, 'class' => 'accesshide']) . html_writer::empty_tag('input', $attributes) . html_writer::empty_tag('input', $hidden) ); } else if ($this->ischecked) { return $OUTPUT->pix_icon('i/checked', get_string('selected', 'core_form'), 'moodle', ['class' => 'overrideexcludecheck']); } else { return ''; } } } report/singleview/classes/local/ui/be_checked.php 0000604 00000002435 15062070557 0016153 0 ustar 00 <?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/>. /** * Is this thing checked? * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_singleview\local\ui; defined('MOODLE_INTERNAL') || die; /** * Is this thing checked? * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ interface be_checked { /** * Return true if this is checked. * @return bool */ public function is_checked(): bool; } report/singleview/classes/local/ui/finalgrade.php 0000604 00000013622 15062070557 0016213 0 ustar 00 <?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/>. /** * UI element representing the finalgrade column. * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_singleview\local\ui; defined('MOODLE_INTERNAL') || die; use stdClass; /** * UI element representing the finalgrade column. * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class finalgrade extends grade_attribute_format implements unique_value, be_disabled, be_readonly { /** * Name of this input * @var string $name */ public $name = 'finalgrade'; /** * Get the value for this input. * * @return null|string The value based on the grade_grade. */ public function get_value(): ?string { $this->label = $this->grade->grade_item->itemname; $val = $this->grade->finalgrade; if ($this->grade->grade_item->scaleid) { return $val ? (int)$val : -1; } else { return $val ? format_float($val, $this->grade->grade_item->get_decimals()) : ''; } } /** * Get the label for this input. * * @return string The label for this form input. */ public function get_label(): string { if (!isset($this->grade->label)) { $this->grade->label = ''; } return $this->grade->label; } /** * Is this input field disabled. * * @return bool Set disabled on this input or not. */ public function is_disabled(): bool { $locked = 0; $gradeitemlocked = 0; $overridden = 0; // Disable editing if grade item or grade score is locked // if any of these items are set, then we will disable editing // at some point, we might want to show the reason for the lock // this code could be simplified, but its more readable for steve's little mind. if (!empty($this->grade->locked)) { $locked = 1; } if (!empty($this->grade->grade_item->locked)) { $gradeitemlocked = 1; } if ($this->grade->grade_item->is_overridable_item() and !$this->grade->is_overridden()) { $overridden = 1; } return ($locked || $gradeitemlocked || $overridden); } /** * Return true if this is read-only. * * @return bool */ public function is_readonly(): bool { global $USER; return empty($USER->editing); } /** * Create the element for this column. * * @return element */ public function determine_format(): element { if ($this->grade->grade_item->load_scale()) { $scale = $this->grade->grade_item->load_scale(); $options = [-1 => get_string('nograde')]; foreach ($scale->scale_items as $i => $name) { $options[$i + 1] = $name; } return new dropdown_attribute( $this->get_name(), $options, $this->get_label(), $this->get_value(), $this->is_disabled(), $this->is_readonly() ); } else { return new text_attribute( $this->get_name(), $this->get_value(), $this->get_label(), $this->is_disabled(), $this->is_readonly() ); } } /** * Save the altered value for this field. * * @param string $value The new value. * @return string Any error string */ public function set($value) { $userid = $this->grade->userid; $gradeitem = $this->grade->grade_item; $feedback = false; $feedbackformat = false; if ($gradeitem->gradetype == GRADE_TYPE_SCALE) { $value = (int)unformat_float($value); if ($value == -1) { $finalgrade = null; } else { $finalgrade = $value; } } else { $finalgrade = unformat_float($value); } $errorstr = ''; if ($finalgrade) { $bounded = $gradeitem->bounded_grade($finalgrade); if ($bounded > $finalgrade) { $errorstr = 'lessthanmin'; } else if ($bounded < $finalgrade) { $errorstr = 'morethanmax'; } } if ($errorstr) { $user = get_complete_user_data('id', $userid); $gradestr = new stdClass; if (has_capability('moodle/site:viewfullnames', \context_course::instance($gradeitem->courseid))) { $gradestr->username = fullname($user, true); } else { $gradestr->username = fullname($user); } $gradestr->itemname = $this->grade->grade_item->get_name(); $errorstr = get_string($errorstr, 'grades', $gradestr); return $errorstr; } // Only update grades if there are no errors. $gradeitem->update_final_grade($userid, $finalgrade, 'singleview', $feedback, FORMAT_MOODLE, null, null, true); return ''; } } report/singleview/classes/local/ui/be_disabled.php 0000604 00000002313 15062070557 0016327 0 ustar 00 <?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/>. /** * be_disabled interface. * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_singleview\local\ui; defined('MOODLE_INTERNAL') || die; /** * Simple interface implemented to add behaviour that an element can be checked to see * if it should be disabled. */ interface be_disabled { /** * Am I disabled ? * * @return bool */ public function is_disabled(): bool; } report/singleview/classes/local/ui/range.php 0000604 00000003571 15062070557 0015215 0 ustar 00 <?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/>. /** * UI element that generates a min/max range (text only). * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_singleview\local\ui; use grade_item; defined('MOODLE_INTERNAL') || die; /** * UI element that generates a grade_item min/max range (text only). * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class range extends attribute_format { /** @var grade_item To store the grade item. */ private grade_item $item; /** * Constructor * @param grade_item $item The grade item */ public function __construct(grade_item $item) { $this->item = $item; } /** * Build this UI element. * * @return element */ public function determine_format(): element { $decimals = $this->item->get_decimals(); $min = format_float($this->item->grademin, $decimals); $max = format_float($this->item->grademax, $decimals); return new empty_element("$min - $max"); } } report/singleview/classes/local/ui/override.php 0000604 00000006425 15062070557 0015741 0 ustar 00 <?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/>. /** * An override grade checkbox element * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_singleview\local\ui; defined('MOODLE_INTERNAL') || die; /** * An override grade checkbox element * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class override extends grade_attribute_format implements be_checked, be_disabled, be_readonly { /** * The name for this input * @var string $name */ public $name = 'override'; /** * Is this input checked * * @return bool */ public function is_checked(): bool { return $this->grade->is_overridden(); } /** * Is this input disabled * * @return bool */ public function is_disabled(): bool { $lockedgrade = $lockedgradeitem = 0; if (!empty($this->grade->locked)) { $lockedgrade = 1; } if (!empty($this->grade->grade_item->locked)) { $lockedgradeitem = 1; } return ($lockedgrade || $lockedgradeitem); } /** * Return true if this is read-only. * * @return bool */ public function is_readonly(): bool { global $USER; return empty($USER->editing); } /** * Get the label for this form element. * * @return string */ public function get_label(): string { if (!isset($this->grade->label)) { $this->grade->label = ''; } return $this->grade->label; } /** * Generate the element for this form input. * * @return element */ public function determine_format(): element { if (!$this->grade->grade_item->is_overridable_item()) { return new empty_element(); } return new checkbox_attribute( $this->get_name(), $this->get_label(), $this->is_checked(), $this->is_disabled(), $this->is_readonly() ); } /** * Save the modified value of this form element. * * @param string $value The new value to set * @return mixed string|false Any error message */ public function set($value) { if (empty($this->grade->id)) { return false; } $state = !($value == 0); $this->grade->set_overridden($state); $this->grade->grade_item->force_regrading(); return false; } } report/singleview/classes/local/ui/unique_name.php 0000604 00000002472 15062070557 0016426 0 ustar 00 <?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/>. /** * A form element with a name field. * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_singleview\local\ui; defined('MOODLE_INTERNAL') || die; /** * A form element with a name field. * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ interface unique_name { /** * Get the name for this form element * @return string */ public function get_name(): string; } report/singleview/classes/local/ui/element.php 0000604 00000004776 15062070557 0015562 0 ustar 00 <?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/>. /** * UI Element for an excluded grade_grade. * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_singleview\local\ui; defined('MOODLE_INTERNAL') || die; /** * UI Element for an excluded grade_grade. * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ abstract class element { /** * The first bit of the name for this input. * @var string $name */ public $name; /** * The value for this input. * @var string $value */ public $value; /** * The form label for this input. * @var string $label */ public $label; /** * Constructor * * @param string $name The first bit of the name for this input * @param string $value The value for this input * @param string $label The label for this form field */ public function __construct(string $name, string $value, string $label) { $this->name = $name; $this->value = $value; $this->label = $label; } /** * Nasty function used for spreading checkbox logic all around * @return bool */ public function is_checkbox(): bool { return false; } /** * Nasty function used for spreading textbox logic all around * @return bool */ public function is_textbox(): bool { return false; } /** * Nasty function used for spreading dropdown logic all around * @return bool */ public function is_dropdown(): bool { return false; } /** * Return the HTML * @return string */ abstract public function html(): string; } report/singleview/classes/local/ui/exclude.php 0000604 00000007207 15062070557 0015552 0 ustar 00 <?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/>. /** * Class that represents the exclude checkbox on a grade_grade. * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_singleview\local\ui; defined('MOODLE_INTERNAL') || die; use grade_grade; /** * Class that represents the exclude checkbox on a grade_grade. * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class exclude extends grade_attribute_format implements be_checked, be_disabled, be_readonly { /** * The name of the input * @var string $name */ public $name = 'exclude'; /** * Is the checkbox disabled? * @var bool $disabled */ public $disabled = false; /** * Is it checked? * * @return bool */ public function is_checked(): bool { return $this->grade->is_excluded(); } /** * Is it disabled? * * @return bool */ public function is_disabled(): bool { return $this->disabled; } /** * Return true if this is read-only. * * @return bool */ public function is_readonly(): bool { global $USER; return empty($USER->editing); } /** * Generate the element used to render the UI * * @return element */ public function determine_format(): element { return new checkbox_attribute( $this->get_name(), $this->get_label(), $this->is_checked(), $this->is_disabled(), $this->is_readonly() ); } /** * Get the label for the form input * * @return string */ public function get_label(): string { if (!isset($this->grade->label)) { $this->grade->label = ''; } return $this->grade->label; } /** * Set the value that was changed in the form. * * @param string $value The value to set. * @return mixed string|bool An error message or false. */ public function set($value) { if (empty($this->grade->id)) { if (empty($value)) { return false; } $gradeitem = $this->grade->grade_item; // Fill in arbitrary grade to be excluded. $gradeitem->update_final_grade( $this->grade->userid, null, 'singleview', null, FORMAT_MOODLE ); $gradeparams = [ 'userid' => $this->grade->userid, 'itemid' => $this->grade->itemid ]; $this->grade = grade_grade::fetch($gradeparams); $this->grade->grade_item = $gradeitem; } $state = !($value == 0); $this->grade->set_excluded($state); $this->grade->grade_item->get_parent_category()->force_regrading(); return false; } } report/singleview/classes/local/ui/unique_value.php 0000604 00000002511 15062070557 0016614 0 ustar 00 <?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/>. /** * The gradebook simple view - UI factory * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_singleview\local\ui; defined('MOODLE_INTERNAL') || die; /** * Simple interface for an item with a value. * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ interface unique_value { /** * Get the value for this item. * @return null|string */ public function get_value(): ?string; } report/singleview/classes/local/ui/dropdown_attribute.php 0000604 00000007000 15062070557 0020027 0 ustar 00 <?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/>. /** * Drop down list (select list) element * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_singleview\local\ui; defined('MOODLE_INTERNAL') || die; /** * Drop down list (select list) element * * @package gradereport_singleview * @copyright 2014 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class dropdown_attribute extends element { /** * Who is selected? * @var string $selected */ private $selected; /** * List of options * @var array $options */ private $options; /** * Is this input disabled. * @var bool $isdisabled */ private $isdisabled; /** @var bool If this is a read-only input. */ private bool $isreadonly; /** * Constructor * * @param string $name The first bit of the name of this input. * @param array $options The options list for this select. * @param string $label The form label for this input. * @param string $selected The name of the selected item in this input. * @param bool $isdisabled Are we disabled? * @param bool $isreadonly If this is a read-only input. */ public function __construct( string $name, array $options, string $label, string $selected = '', bool $isdisabled = false, bool $isreadonly = false ) { $this->selected = $selected; $this->options = $options; $this->isdisabled = $isdisabled; $this->isreadonly = $isreadonly; parent::__construct($name, $selected, $label); } /** * Nasty function spreading dropdown logic around. * * @return bool */ public function is_dropdown(): bool { return true; } /** * Render this element as html. * * @return string */ public function html(): string { global $OUTPUT; $options = $this->options; $selected = $this->selected; $context = [ 'name' => $this->name, 'value' => $this->selected, 'text' => $options[$selected], 'disabled' => !empty($this->isdisabled), 'readonly' => $this->isreadonly, 'options' => array_map(function($option) use ($options, $selected) { return [ 'name' => $options[$option], 'value' => $option, 'selected' => $selected == $option ]; }, array_keys($options)), 'label' => get_string('gradefor', 'gradereport_singleview', $this->label), ]; return $OUTPUT->render_from_template('gradereport_singleview/dropdown_attribute', $context); } } report/singleview/classes/output/action_bar.php 0000604 00000007114 15062070557 0016050 0 ustar 00 <?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/>. declare(strict_types=1); namespace gradereport_singleview\output; use moodle_url; use renderer_base; use gradereport_singleview\report\singleview; /** * Renderable class for the action bar elements in the single view report page. * * @package gradereport_singleview * @copyright 2022 Shamim Rezaie <shamim@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class action_bar extends \core_grades\output\action_bar { /** @var singleview $report The single view report class. */ protected singleview $report; /** @var string $itemtype The single view item type. */ protected string $itemtype; /** * The class constructor. * * @param \context $context The context object. * @param singleview $report The single view report class. * @param string $itemtype The single view item type. */ public function __construct(\context $context, singleview $report, string $itemtype) { parent::__construct($context); $this->report = $report; $this->itemtype = $itemtype; } /** * Returns the template for the action bar. * * @return string */ public function get_template(): string { return 'gradereport_singleview/action_bar'; } /** * Export the data for the mustache template. * * @param \renderer_base $output renderer to be used to render the action bar elements. * @return array */ public function export_for_template(renderer_base $output) { global $USER; $courseid = $this->context->instanceid; // Get the data used to output the general navigation selector. $generalnavselector = new \core_grades\output\general_action_bar( $this->context, new moodle_url('/grade/report/singleview/index.php', ['id' => $courseid]), 'report', 'singleview' ); $data = $generalnavselector->export_for_template($output); // The data required to output the page toggle element. $data['pagetoggler'] = [ 'displaylabel' => true, 'userselectactive' => $this->itemtype === 'user', 'gradeselectactive' => $this->itemtype === 'grade', 'gradezerolink' => (new moodle_url('/grade/report/singleview/index.php', ['id' => $courseid, 'item' => 'grade_select']))->out(false), 'userzerolink' => (new moodle_url('/grade/report/singleview/index.php', ['id' => $courseid, 'item' => 'user_select']))->out(false) ]; $data['groupselector'] = $this->report->group_selector; $data['itemselector'] = $this->report->itemselector; $data['pbarurl'] = $this->report->pbarurl->out(false); if (!empty($USER->editing) && isset($this->report->screen->item)) { $data['bulkactions'] = $this->report->bulk_actions_menu($output); } return $data; } } report/singleview/classes/external/singleview.php 0000604 00000007405 15062070557 0016410 0 ustar 00 <?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/>. namespace gradereport_singleview\external; use context_course; use core_course_external; use core_external\external_function_parameters; use core_external\external_multiple_structure; use core_external\external_single_structure; use core_external\external_value; use core_external\external_warnings; use grade_tree; defined('MOODLE_INTERNAL') || die; require_once($CFG->dirroot.'/course/externallib.php'); require_once($CFG->dirroot.'/grade/lib.php'); /** * External grade report singleview API * * @package gradereport_singleview * @copyright 2022 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class singleview extends core_course_external { /** * Describes the parameters for get_users_for_course. * * @return external_function_parameters */ public static function get_grade_items_for_search_widget_parameters(): external_function_parameters { return new external_function_parameters ( [ 'courseid' => new external_value(PARAM_INT, 'Course Id', VALUE_REQUIRED) ] ); } /** * Given a course ID find the * * @param int $courseid * @return array Users and warnings to pass back to the calling widget. * @throws coding_exception * @throws invalid_parameter_exception * @throws moodle_exception * @throws restricted_context_exception */ protected static function get_grade_items_for_search_widget(int $courseid): array { global $PAGE, $USER, $CFG; $params = self::validate_parameters( self::get_grade_items_for_search_widget_parameters(), [ 'courseid' => $courseid, ] ); $warnings = []; $coursecontext = context_course::instance($params['courseid']); parent::validate_context($coursecontext); $gtree = new grade_tree($params['courseid'], false, true, null, !$CFG->enableoutcomes); $gradeableitems = $gtree->get_items(); $gradeitems = array_map(function ($gradeitem) use ($PAGE, $USER, $params) { $item = new \stdClass(); $item->id = $gradeitem->id; $item->name = $gradeitem->get_name(true); return $item; }, $gradeableitems); return [ 'gradeitems' => $gradeitems, 'warnings' => $warnings, ]; } /** * Returns description of what the user search for the widget should return. * * @return external_single_structure */ public static function get_grade_items_for_search_widget_returns(): external_single_structure { return new external_single_structure([ 'gradeitems' => new external_multiple_structure( new external_single_structure([ 'id' => new external_value(PARAM_INT, 'ID of the grade item', VALUE_OPTIONAL), 'name' => new external_value(PARAM_TEXT, 'The full name of the grade item', VALUE_OPTIONAL) ]) ), 'warnings' => new external_warnings(), ]); } } report/singleview/lib.php 0000604 00000006657 15062070557 0011533 0 ustar 00 <?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/>. /** * Singleview report generic functions * * @package gradereport_singleview * @copyright 2023 Ilya Tregubov * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ /** * Returns link to singleview report for the current element * * @param context_course $context Course context * @param int $courseid Course ID * @param array $element An array representing an element in the grade_tree * @param grade_plugin_return $gpr A grade_plugin_return object * @param string $mode Mode - gradeitem or user * @param ?stdClass $templatecontext Template context * @return stdClass|null */ function gradereport_singleview_get_report_link(context_course $context, int $courseid, array $element, grade_plugin_return $gpr, string $mode, ?stdClass $templatecontext): ?stdClass { $reportstring = get_string('singleviewreport_' . $mode, 'gradereport_singleview'); if (!isset($templatecontext)) { $templatecontext = new stdClass(); } if ($mode == 'gradeitem') { // View all grades items. // FIXME: MDL-52678 This is extremely hacky we should have an API for inserting grade column links. if (get_capability_info('gradereport/singleview:view')) { if (has_all_capabilities(['gradereport/singleview:view', 'moodle/grade:viewall', 'moodle/grade:edit'], $context)) { $url = new moodle_url('/grade/report/singleview/index.php', [ 'id' => $courseid, 'item' => 'grade', 'itemid' => $element['object']->id ]); $gpr->add_url_params($url); $templatecontext->reporturl0 = html_writer::link($url, $reportstring, ['class' => 'dropdown-item', 'aria-label' => $reportstring, 'role' => 'menuitem']); return $templatecontext; } } } else if ($mode == 'user') { // FIXME: MDL-52678 This get_capability_info is hacky and we should have an API for inserting grade row links instead. $canseesingleview = false; if (get_capability_info('gradereport/singleview:view')) { $canseesingleview = has_all_capabilities(['gradereport/singleview:view', 'moodle/grade:viewall', 'moodle/grade:edit'], $context); } if ($canseesingleview) { $url = new moodle_url('/grade/report/singleview/index.php', ['id' => $courseid, 'itemid' => $element['userid'], 'item' => 'user']); $gpr->add_url_params($url); $templatecontext->reporturl0 = html_writer::link($url, $reportstring, ['class' => 'dropdown-item', 'aria-label' => $reportstring, 'role' => 'menuitem']); return $templatecontext; } } return null; } report/mygrades.php 0000604 00000002270 15062070557 0010407 0 ustar 00 <?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/>. /** * Redirects the user to the default grade report. * * @package core_grades * @copyright 2015 Adrian Greeve <adrian@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once('../../config.php'); require_once($CFG->dirroot . '/user/lib.php'); require_login(null, false); if (isguestuser()) { throw new require_login_exception('Guests are not allowed here.'); } // Get the url to redirect to. $url = user_mygrades_url(); // Redirect to that page. redirect($url); report/grader/amd/build/stickycolspan.min.js 0000604 00000004437 15062070557 0015204 0 ustar 00 define("gradereport_grader/stickycolspan",["exports","jquery","core/sticky-footer"],(function(_exports,_jquery,_stickyFooter){var obj; /** * Javascript module for fixing the position of sticky headers with multiple colspans * * @module gradereport_grader/stickycolspan * @copyright 2022 Bas Brands <bas@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.init=void 0,_jquery=(obj=_jquery)&&obj.__esModule?obj:{default:obj};const SELECTORS_GRADEPARENT=".gradeparent",SELECTORS_STUDENTHEADER="#studentheader",SELECTORS_TABLEHEADER="th.header",SELECTORS_BEHAT="body.behat-site",SELECTORS_USERDROPDOWN=".userrow th .dropdown",SELECTORS_AVERAGEROWHEADER=".lastrow th";_exports.init=()=>{if((0,_jquery.default)(SELECTORS_USERDROPDOWN).on("show.bs.dropdown hide.bs.dropdown",(e=>{e.target.closest(SELECTORS_TABLEHEADER).classList.toggle("actions-menu-active")})),defineAverageRowIntersectionObserver(!0),document.addEventListener(_stickyFooter.eventTypes.stickyFooterStateChanged,(e=>{defineAverageRowIntersectionObserver(e.detail.enabled)})),!document.querySelector(SELECTORS_BEHAT)){const grader=document.querySelector(SELECTORS_GRADEPARENT),tableHeaders=grader.querySelectorAll(SELECTORS_TABLEHEADER),studentHeader=grader.querySelector(SELECTORS_STUDENTHEADER),leftOffset=getComputedStyle(studentHeader).getPropertyValue("left"),rightOffset=getComputedStyle(studentHeader).getPropertyValue("right");tableHeaders.forEach((tableHeader=>{if(tableHeader.colSpan>1){const addOffset=tableHeader.offsetWidth-studentHeader.offsetWidth;window.right_to_left()?tableHeader.style.right="calc("+rightOffset+" - "+addOffset+"px )":tableHeader.style.left="calc("+leftOffset+" - "+addOffset+"px )"}}))}};const defineAverageRowIntersectionObserver=stickyFooterEnabled=>{const stickyFooterHeight=stickyFooterEnabled?document.querySelector(_stickyFooter.SELECTORS.STICKYFOOTER).offsetHeight:null;new IntersectionObserver((_ref=>{let[e]=_ref;return e.target.closest("tr").classList.toggle("pinned",e.intersectionRatio<1)}),{rootMargin:stickyFooterHeight?"0px 0px -".concat(stickyFooterHeight,"px 0px"):"0px",threshold:[1]}).observe(document.querySelector(SELECTORS_AVERAGEROWHEADER))}})); //# sourceMappingURL=stickycolspan.min.js.map report/grader/amd/build/collapse/repository.min.js.map 0000604 00000003252 15062070557 0017105 0 ustar 00 {"version":3,"file":"repository.min.js","sources":["../../src/collapse/repository.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * A repo for the collapsing in the grader report.\n *\n * @module gradereport_grader/collapse/repository\n * @copyright 2022 Mathew May <mathew.solutions>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport ajax from 'core/ajax';\n\n/**\n * Fetch all the information on gradeitems we'll need in the column collapser.\n *\n * @method gradeItems\n * @param {Number} courseid What course to fetch the gradeitems for\n * @return {object} jQuery promise\n */\nexport const gradeItems = (courseid) => {\n const request = {\n methodname: 'core_grades_get_gradeitems',\n args: {\n courseid: courseid,\n },\n };\n return ajax.call([request])[0];\n};\n"],"names":["courseid","request","methodname","args","ajax","call"],"mappings":";;;;;;;gKAgC2BA,iBACjBC,QAAU,CACZC,WAAY,6BACZC,KAAM,CACFH,SAAUA,kBAGXI,cAAKC,KAAK,CAACJ,UAAU"} report/grader/amd/build/collapse/repository.min.js 0000604 00000001260 15062070557 0016326 0 ustar 00 define("gradereport_grader/collapse/repository",["exports","core/ajax"],(function(_exports,_ajax){var obj; /** * A repo for the collapsing in the grader report. * * @module gradereport_grader/collapse/repository * @copyright 2022 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.gradeItems=void 0,_ajax=(obj=_ajax)&&obj.__esModule?obj:{default:obj};_exports.gradeItems=courseid=>{const request={methodname:"core_grades_get_gradeitems",args:{courseid:courseid}};return _ajax.default.call([request])[0]}})); //# sourceMappingURL=repository.min.js.map report/grader/amd/build/stickycolspan.min.js.map 0000604 00000014325 15062070557 0015755 0 ustar 00 {"version":3,"file":"stickycolspan.min.js","sources":["../src/stickycolspan.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Javascript module for fixing the position of sticky headers with multiple colspans\n *\n * @module gradereport_grader/stickycolspan\n * @copyright 2022 Bas Brands <bas@moodle.com>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport $ from 'jquery';\nimport {SELECTORS as stickyFooterSelectors, eventTypes as stickyFooterEvents} from 'core/sticky-footer';\n\nconst SELECTORS = {\n GRADEPARENT: '.gradeparent',\n STUDENTHEADER: '#studentheader',\n TABLEHEADER: 'th.header',\n BEHAT: 'body.behat-site',\n USERDROPDOWN: '.userrow th .dropdown',\n AVERAGEROWHEADER: '.lastrow th',\n};\n\n/**\n * Initialize module\n */\nexport const init = () => {\n // The sticky positioning attributed to the user column cells affects the stacking context and makes the dropdowns\n // within these cells to be cut off. To solve this problem, whenever one of these action menus (dropdowns) is opened\n // we need to manually bump up the z-index value of the parent container element and revert once closed.\n $(SELECTORS.USERDROPDOWN).on('show.bs.dropdown hide.bs.dropdown', (e) => {\n // The closest heading element has sticky positioning which affects the stacking context in this case.\n e.target.closest(SELECTORS.TABLEHEADER).classList.toggle('actions-menu-active');\n });\n\n defineAverageRowIntersectionObserver(true);\n // Add an event listener to the sticky footer toggled event to re-define the average row intersection observer\n // accordingly. This is needed as on narrow screens when scrolling vertically the sticky footer is enabled and\n // disabled dynamically.\n document.addEventListener(stickyFooterEvents.stickyFooterStateChanged, (e) => {\n defineAverageRowIntersectionObserver(e.detail.enabled);\n });\n\n if (!document.querySelector(SELECTORS.BEHAT)) {\n const grader = document.querySelector(SELECTORS.GRADEPARENT);\n const tableHeaders = grader.querySelectorAll(SELECTORS.TABLEHEADER);\n const studentHeader = grader.querySelector(SELECTORS.STUDENTHEADER);\n const leftOffset = getComputedStyle(studentHeader).getPropertyValue('left');\n const rightOffset = getComputedStyle(studentHeader).getPropertyValue('right');\n\n tableHeaders.forEach((tableHeader) => {\n if (tableHeader.colSpan > 1) {\n const addOffset = (tableHeader.offsetWidth - studentHeader.offsetWidth);\n if (window.right_to_left()) {\n tableHeader.style.right = 'calc(' + rightOffset + ' - ' + addOffset + 'px )';\n } else {\n tableHeader.style.left = 'calc(' + leftOffset + ' - ' + addOffset + 'px )';\n }\n }\n });\n }\n};\n\n/**\n * Define the intersection observer that will make sure that the average overall row is properly pinned.\n *\n * @param {boolean} stickyFooterEnabled Whether the page shows a sticky footer or not.\n */\nconst defineAverageRowIntersectionObserver = (stickyFooterEnabled) => {\n const stickyFooterHeight = stickyFooterEnabled ? document.querySelector(stickyFooterSelectors.STICKYFOOTER).offsetHeight : null;\n // Register an observer that will bump up the z-index value of the average overall row when it's pinned to prevent\n // the row being cut-off by the user column cells or other components within the report table that have higher\n // z-index values. If the page has a sticky footer, we need to make sure that the bottom root margin of the observer\n // subtracts the height of the sticky footer to prevent the row being cut-off by the footer.\n const intersectionObserver = new IntersectionObserver(\n ([e]) => e.target.closest('tr').classList.toggle('pinned', e.intersectionRatio < 1),\n {\n rootMargin: stickyFooterHeight ? `0px 0px -${stickyFooterHeight}px 0px` : \"0px\",\n threshold: [1]\n }\n );\n intersectionObserver.observe(document.querySelector(SELECTORS.AVERAGEROWHEADER));\n};\n"],"names":["SELECTORS","on","e","target","closest","classList","toggle","defineAverageRowIntersectionObserver","document","addEventListener","stickyFooterEvents","stickyFooterStateChanged","detail","enabled","querySelector","grader","tableHeaders","querySelectorAll","studentHeader","leftOffset","getComputedStyle","getPropertyValue","rightOffset","forEach","tableHeader","colSpan","addOffset","offsetWidth","window","right_to_left","style","right","left","stickyFooterEnabled","stickyFooterHeight","stickyFooterSelectors","STICKYFOOTER","offsetHeight","IntersectionObserver","_ref","intersectionRatio","rootMargin","threshold","observe"],"mappings":";;;;;;;gJA0BMA,sBACW,eADXA,wBAEa,iBAFbA,sBAGW,YAHXA,gBAIK,kBAJLA,uBAKY,wBALZA,2BAMgB,4BAMF,4BAIdA,wBAAwBC,GAAG,qCAAsCC,IAE/DA,EAAEC,OAAOC,QAAQJ,uBAAuBK,UAAUC,OAAO,0BAG7DC,sCAAqC,GAIrCC,SAASC,iBAAiBC,yBAAmBC,0BAA2BT,IACpEK,qCAAqCL,EAAEU,OAAOC,aAG7CL,SAASM,cAAcd,iBAAkB,OACpCe,OAASP,SAASM,cAAcd,uBAChCgB,aAAeD,OAAOE,iBAAiBjB,uBACvCkB,cAAgBH,OAAOD,cAAcd,yBACrCmB,WAAaC,iBAAiBF,eAAeG,iBAAiB,QAC9DC,YAAcF,iBAAiBF,eAAeG,iBAAiB,SAErEL,aAAaO,SAASC,iBACdA,YAAYC,QAAU,EAAG,OACnBC,UAAaF,YAAYG,YAAcT,cAAcS,YACvDC,OAAOC,gBACPL,YAAYM,MAAMC,MAAQ,QAAUT,YAAc,MAAQI,UAAY,OAEtEF,YAAYM,MAAME,KAAO,QAAUb,WAAa,MAAQO,UAAY,mBAYlFnB,qCAAwC0B,4BACpCC,mBAAqBD,oBAAsBzB,SAASM,cAAcqB,wBAAsBC,cAAcC,aAAe,KAK9F,IAAIC,sBAC7BC,WAAErC,eAAOA,EAAEC,OAAOC,QAAQ,MAAMC,UAAUC,OAAO,SAAUJ,EAAEsC,kBAAoB,KACjF,CACIC,WAAYP,sCAAiCA,6BAA6B,MAC1EQ,UAAW,CAAC,KAGCC,QAAQnC,SAASM,cAAcd"} report/grader/amd/build/group.min.js 0000604 00000002064 15062070557 0013444 0 ustar 00 define("gradereport_grader/group",["exports","core_group/comboboxsearch/group","core/url"],(function(_exports,_group,_url){function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}}Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.default=void 0,_group=_interopRequireDefault(_group),_url=_interopRequireDefault(_url);class Group extends _group.default{constructor(){var obj,key,value;super(),value=void 0,(key="courseID")in(obj=this)?Object.defineProperty(obj,key,{value:value,enumerable:!0,configurable:!0,writable:!0}):obj[key]=value,this.selectors={...this.selectors,courseid:'[data-region="courseid"]'};const component=document.querySelector(this.componentSelector());this.courseID=component.querySelector(this.selectors.courseid).dataset.courseid}static init(){return new Group}selectOneLink(groupID){return _url.default.relativeUrl("/grade/report/grader/index.php",{id:this.courseID,groupsearchvalue:this.getSearchTerm(),group:groupID},!1)}}return _exports.default=Group,_exports.default})); //# sourceMappingURL=group.min.js.map report/grader/amd/build/local/user/repository.min.js.map 0000604 00000003265 15062070557 0017357 0 ustar 00 {"version":3,"file":"repository.min.js","sources":["../../../src/local/user/repository.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * A repo for the search partial in the grader report.\n *\n * @module gradereport_grader/local/user/repository\n * @copyright 2022 Mathew May <mathew.solutions>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport ajax from 'core/ajax';\n\n/**\n * Given a course ID, we want to fetch the learners within this report.\n *\n * @method userFetch\n * @param {int} courseid ID of the course to fetch the users of.\n * @return {object} jQuery promise\n */\nexport const userFetch = (courseid) => {\n const request = {\n methodname: 'gradereport_grader_get_users_in_report',\n args: {\n courseid: courseid,\n },\n };\n return ajax.call([request])[0];\n};\n"],"names":["courseid","request","methodname","args","ajax","call"],"mappings":";;;;;;;8JAgC0BA,iBAChBC,QAAU,CACZC,WAAY,yCACZC,KAAM,CACFH,SAAUA,kBAGXI,cAAKC,KAAK,CAACJ,UAAU"} report/grader/amd/build/local/user/repository.min.js 0000604 00000001302 15062070557 0016571 0 ustar 00 define("gradereport_grader/local/user/repository",["exports","core/ajax"],(function(_exports,_ajax){var obj; /** * A repo for the search partial in the grader report. * * @module gradereport_grader/local/user/repository * @copyright 2022 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.userFetch=void 0,_ajax=(obj=_ajax)&&obj.__esModule?obj:{default:obj};_exports.userFetch=courseid=>{const request={methodname:"gradereport_grader_get_users_in_report",args:{courseid:courseid}};return _ajax.default.call([request])[0]}})); //# sourceMappingURL=repository.min.js.map report/grader/amd/build/group.min.js.map 0000604 00000005003 15062070557 0014214 0 ustar 00 {"version":3,"file":"group.min.js","sources":["../src/group.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Allow the user to search for groups within the grader report.\n *\n * @module gradereport_grader/group\n * @copyright 2023 Mathew May <mathew.solutions>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\nimport GroupSearch from 'core_group/comboboxsearch/group';\nimport Url from 'core/url';\n\nexport default class Group extends GroupSearch {\n\n courseID;\n\n constructor() {\n super();\n\n // Define our standard lookups.\n this.selectors = {...this.selectors,\n courseid: '[data-region=\"courseid\"]',\n };\n const component = document.querySelector(this.componentSelector());\n this.courseID = component.querySelector(this.selectors.courseid).dataset.courseid;\n }\n\n static init() {\n return new Group();\n }\n\n /**\n * Build up the view all link that is dedicated to a particular result.\n *\n * @param {Number} groupID The ID of the group selected.\n * @returns {string|*}\n */\n selectOneLink(groupID) {\n return Url.relativeUrl('/grade/report/grader/index.php', {\n id: this.courseID,\n groupsearchvalue: this.getSearchTerm(),\n group: groupID,\n }, false);\n }\n}\n"],"names":["Group","GroupSearch","constructor","selectors","this","courseid","component","document","querySelector","componentSelector","courseID","dataset","selectOneLink","groupID","Url","relativeUrl","id","groupsearchvalue","getSearchTerm","group"],"mappings":"2WAyBqBA,cAAcC,eAI/BC,6LAISC,UAAY,IAAIC,KAAKD,UACtBE,SAAU,kCAERC,UAAYC,SAASC,cAAcJ,KAAKK,0BACzCC,SAAWJ,UAAUE,cAAcJ,KAAKD,UAAUE,UAAUM,QAAQN,8BAIlE,IAAIL,MASfY,cAAcC,gBACHC,aAAIC,YAAY,iCAAkC,CACrDC,GAAIZ,KAAKM,SACTO,iBAAkBb,KAAKc,gBACvBC,MAAON,UACR"} report/grader/amd/build/collapse.min.js.map 0000604 00000073667 15062070557 0014707 0 ustar 00 {"version":3,"file":"collapse.min.js","sources":["../src/collapse.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Allow the user to show and hide columns of the report at will.\n *\n * @module gradereport_grader/collapse\n * @copyright 2023 Mathew May <mathew.solutions>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\nimport * as Repository from 'gradereport_grader/collapse/repository';\nimport search_combobox from 'core/comboboxsearch/search_combobox';\nimport {renderForPromise, replaceNodeContents, replaceNode} from 'core/templates';\nimport {debounce} from 'core/utils';\nimport $ from 'jquery';\nimport {getStrings} from 'core/str';\nimport CustomEvents from \"core/custom_interaction_events\";\nimport storage from 'core/localstorage';\nimport {addIconToContainer} from 'core/loadingicon';\nimport Notification from 'core/notification';\nimport Pending from 'core/pending';\n\n// Contain our selectors within this file until they could be of use elsewhere.\nconst selectors = {\n component: '.collapse-columns',\n formDropdown: '.columnsdropdownform',\n formItems: {\n cancel: 'cancel',\n save: 'save',\n checked: 'input[type=\"checkbox\"]:checked',\n currentlyUnchecked: 'input[type=\"checkbox\"]:not([data-action=\"selectall\"])',\n },\n hider: 'hide',\n expand: 'expand',\n colVal: '[data-col]',\n itemVal: '[data-itemid]',\n content: '[data-collapse=\"content\"]',\n sort: '[data-collapse=\"sort\"]',\n expandbutton: '[data-collapse=\"expandbutton\"]',\n rangerowcell: '[data-collapse=\"rangerowcell\"]',\n avgrowcell: '[data-collapse=\"avgrowcell\"]',\n menu: '[data-collapse=\"menu\"]',\n icons: '.data-collapse_gradeicons',\n count: '[data-collapse=\"count\"]',\n placeholder: '.collapsecolumndropdown [data-region=\"placeholder\"]',\n fullDropdown: '.collapsecolumndropdown',\n};\n\nconst countIndicator = document.querySelector(selectors.count);\n\nexport default class ColumnSearch extends search_combobox {\n\n userID = -1;\n courseID = null;\n defaultSort = '';\n\n nodes = [];\n\n gradeStrings = null;\n userStrings = null;\n stringMap = [];\n\n static init(userID, courseID, defaultSort) {\n return new ColumnSearch(userID, courseID, defaultSort);\n }\n\n constructor(userID, courseID, defaultSort) {\n super();\n this.userID = userID;\n this.courseID = courseID;\n this.defaultSort = defaultSort;\n this.component = document.querySelector(selectors.component);\n\n const pendingPromise = new Pending();\n // Display a loader whilst collapsing appropriate columns (based on the locally stored state for the current user).\n addIconToContainer(document.querySelector('.gradeparent')).then((loader) => {\n setTimeout(() => {\n // Get the users' checked columns to change.\n this.getDataset().forEach((item) => {\n this.nodesUpdate(item);\n });\n this.renderDefault();\n\n // Once the grade categories have been re-collapsed, remove the loader and display the Gradebook setup content.\n loader.remove();\n document.querySelector('.gradereport-grader-table').classList.remove('d-none');\n }, 10);\n }).then(() => pendingPromise.resolve()).catch(Notification.exception);\n }\n\n /**\n * The overall div that contains the searching widget.\n *\n * @returns {string}\n */\n componentSelector() {\n return '.collapse-columns';\n }\n\n /**\n * The dropdown div that contains the searching widget result space.\n *\n * @returns {string}\n */\n dropdownSelector() {\n return '.searchresultitemscontainer';\n }\n\n /**\n * The triggering div that contains the searching widget.\n *\n * @returns {string}\n */\n triggerSelector() {\n return '.collapsecolumn';\n }\n\n /**\n * Return the dataset that we will be searching upon.\n *\n * @returns {Array}\n */\n getDataset() {\n if (!this.dataset) {\n const cols = this.fetchDataset();\n this.dataset = JSON.parse(cols) ? JSON.parse(cols).split(',') : [];\n }\n this.datasetSize = this.dataset.length;\n return this.dataset;\n }\n\n /**\n * Get the data we will be searching against in this component.\n *\n * @returns {string}\n */\n fetchDataset() {\n return storage.get(`gradereport_grader_collapseditems_${this.courseID}_${this.userID}`);\n }\n\n /**\n * Given a user performs an action, update the users' preferences.\n */\n setPreferences() {\n storage.set(`gradereport_grader_collapseditems_${this.courseID}_${this.userID}`,\n JSON.stringify(this.getDataset().join(','))\n );\n }\n\n /**\n * Register clickable event listeners.\n */\n registerClickHandlers() {\n // Register click events within the component.\n this.component.addEventListener('click', this.clickHandler.bind(this));\n\n document.addEventListener('click', this.docClickHandler.bind(this));\n }\n\n /**\n * The handler for when a user interacts with the component.\n *\n * @param {MouseEvent} e The triggering event that we are working with.\n */\n clickHandler(e) {\n super.clickHandler(e);\n // Prevent BS from closing the dropdown if they click elsewhere within the dropdown besides the form.\n if (e.target.closest(selectors.fullDropdown)) {\n e.stopPropagation();\n }\n }\n\n /**\n * Externally defined click function to improve memory handling.\n *\n * @param {MouseEvent} e\n * @returns {Promise<void>}\n */\n async docClickHandler(e) {\n if (e.target.dataset.hider === selectors.hider) {\n e.preventDefault();\n const desiredToHide = e.target.closest(selectors.colVal) ?\n e.target.closest(selectors.colVal)?.dataset.col :\n e.target.closest(selectors.itemVal)?.dataset.itemid;\n const idx = this.getDataset().indexOf(desiredToHide);\n if (idx === -1) {\n this.getDataset().push(desiredToHide);\n }\n await this.prefcountpipe();\n\n this.nodesUpdate(desiredToHide);\n }\n\n if (e.target.closest('button')?.dataset.hider === selectors.expand) {\n e.preventDefault();\n const desiredToHide = e.target.closest(selectors.colVal) ?\n e.target.closest(selectors.colVal)?.dataset.col :\n e.target.closest(selectors.itemVal)?.dataset.itemid;\n const idx = this.getDataset().indexOf(desiredToHide);\n this.getDataset().splice(idx, 1);\n\n await this.prefcountpipe();\n\n this.nodesUpdate(e.target.closest(selectors.colVal)?.dataset.col);\n this.nodesUpdate(e.target.closest(selectors.colVal)?.dataset.itemid);\n }\n }\n\n /**\n * The handler for when a user presses a key within the component.\n *\n * @param {KeyboardEvent} e The triggering event that we are working with.\n */\n async keyHandler(e) {\n super.keyHandler(e);\n\n // Switch the key presses to handle keyboard nav.\n switch (e.key) {\n case 'Tab':\n if (e.target.closest(this.selectors.input)) {\n e.preventDefault();\n this.clearSearchButton.focus({preventScroll: true});\n }\n break;\n }\n }\n\n /**\n * Handle any keyboard inputs.\n */\n registerInputEvents() {\n // Register & handle the text input.\n this.searchInput.addEventListener('input', debounce(async() => {\n this.setSearchTerms(this.searchInput.value);\n // We can also require a set amount of input before search.\n if (this.searchInput.value === '') {\n // Hide the \"clear\" search button in the search bar.\n this.clearSearchButton.classList.add('d-none');\n } else {\n // Display the \"clear\" search button in the search bar.\n this.clearSearchButton.classList.remove('d-none');\n }\n // User has given something for us to filter against.\n await this.filterrenderpipe();\n }, 300));\n }\n\n /**\n * Handle the form submission within the dropdown.\n */\n registerFormEvents() {\n const form = this.component.querySelector(selectors.formDropdown);\n const events = [\n 'click',\n CustomEvents.events.activate,\n CustomEvents.events.keyboardActivate\n ];\n CustomEvents.define(document, events);\n\n const selectall = form.querySelector('[data-action=\"selectall\"]');\n\n // Register clicks & keyboard form handling.\n events.forEach((event) => {\n const submitBtn = form.querySelector(`[data-action=\"${selectors.formItems.save}\"`);\n form.addEventListener(event, (e) => {\n // Stop Bootstrap from being clever.\n e.stopPropagation();\n const input = e.target.closest('input');\n if (input) {\n // If the user is unchecking an item, we need to uncheck the select all if it's checked.\n if (selectall.checked && !input.checked) {\n selectall.checked = false;\n }\n const checkedCount = Array.from(form.querySelectorAll(selectors.formItems.checked)).length;\n // Check if any are clicked or not then change disabled.\n submitBtn.disabled = checkedCount <= 0;\n }\n }, false);\n\n // Stop Bootstrap from being clever.\n this.searchInput.addEventListener(event, e => e.stopPropagation());\n this.clearSearchButton.addEventListener(event, async(e) => {\n e.stopPropagation();\n this.searchInput.value = '';\n this.setSearchTerms(this.searchInput.value);\n await this.filterrenderpipe();\n });\n selectall.addEventListener(event, (e) => {\n // Stop Bootstrap from being clever.\n e.stopPropagation();\n if (!selectall.checked) {\n const touncheck = Array.from(form.querySelectorAll(selectors.formItems.checked));\n touncheck.forEach(item => {\n item.checked = false;\n });\n submitBtn.disabled = true;\n } else {\n const currentUnchecked = Array.from(form.querySelectorAll(selectors.formItems.currentlyUnchecked));\n currentUnchecked.forEach(item => {\n item.checked = true;\n });\n submitBtn.disabled = false;\n }\n });\n });\n\n form.addEventListener('submit', async(e) => {\n e.preventDefault();\n if (e.submitter.dataset.action === selectors.formItems.cancel) {\n $(this.component).dropdown('toggle');\n return;\n }\n // Get the users' checked columns to change.\n const checkedItems = [...form.elements].filter(item => item.checked);\n checkedItems.forEach((item) => {\n const idx = this.getDataset().indexOf(item.dataset.collapse);\n this.getDataset().splice(idx, 1);\n this.nodesUpdate(item.dataset.collapse);\n });\n // Reset the check all & submit to false just in case.\n selectall.checked = false;\n e.submitter.disabled = true;\n await this.prefcountpipe();\n });\n }\n\n nodesUpdate(item) {\n const colNodesToHide = [...document.querySelectorAll(`[data-col=\"${item}\"]`)];\n const itemIDNodesToHide = [...document.querySelectorAll(`[data-itemid=\"${item}\"]`)];\n this.nodes = [...colNodesToHide, ...itemIDNodesToHide];\n this.updateDisplay();\n }\n\n /**\n * Update the user preferences, count display then render the results.\n *\n * @returns {Promise<void>}\n */\n async prefcountpipe() {\n this.setPreferences();\n this.countUpdate();\n await this.filterrenderpipe();\n }\n\n /**\n * Dictate to the search component how and what we want to match upon.\n *\n * @param {Array} filterableData\n * @returns {Array} An array of objects containing the system reference and the user readable value.\n */\n async filterDataset(filterableData) {\n const stringUserMap = await this.fetchRequiredUserStrings();\n const stringGradeMap = await this.fetchRequiredGradeStrings();\n // Custom user profile fields are not in our string map and need a bit of extra love.\n const customFieldMap = this.fetchCustomFieldValues();\n this.stringMap = new Map([...stringGradeMap, ...stringUserMap, ...customFieldMap]);\n\n const searching = filterableData.map(s => {\n const mapObj = this.stringMap.get(s);\n if (mapObj === undefined) {\n return {key: s, string: s};\n }\n return {\n key: s,\n string: mapObj.itemname ?? this.stringMap.get(s),\n category: mapObj.category ?? '',\n };\n });\n // Sometimes we just want to show everything.\n if (this.getPreppedSearchTerm() === '') {\n return searching;\n }\n // Other times we want to actually filter the content.\n return searching.filter((col) => {\n return col.string.toString().toLowerCase().includes(this.getPreppedSearchTerm());\n });\n }\n\n /**\n * Given we have a subset of the dataset, set the field that we matched upon to inform the end user.\n */\n filterMatchDataset() {\n this.setMatchedResults(\n this.getMatchedResults().map((column) => {\n return {\n name: column.key,\n displayName: column.string ?? column.key,\n category: column.category ?? '',\n };\n })\n );\n }\n\n /**\n * With an array of nodes, switch their classes and values.\n */\n updateDisplay() {\n this.nodes.forEach((element) => {\n const content = element.querySelector(selectors.content);\n const sort = element.querySelector(selectors.sort);\n const expandButton = element.querySelector(selectors.expandbutton);\n const rangeRowCell = element.querySelector(selectors.rangerowcell);\n const avgRowCell = element.querySelector(selectors.avgrowcell);\n const nodeSet = [\n element.querySelector(selectors.menu),\n element.querySelector(selectors.icons),\n content\n ];\n\n // This can be further improved to reduce redundant similar calls.\n if (element.classList.contains('cell')) {\n // The column is actively being sorted, lets reset that and reload the page.\n if (sort !== null) {\n window.location = this.defaultSort;\n }\n if (content === null) {\n // If it's not a content cell, it must be an overall average or a range cell.\n const rowCell = avgRowCell ?? rangeRowCell;\n\n rowCell?.classList.toggle('d-none');\n rowCell?.setAttribute('aria-hidden',\n rowCell?.classList.contains('d-none') ? 'true' : 'false');\n } else if (content.classList.contains('d-none')) {\n // We should always have content but some cells do not contain menus or other actions.\n element.classList.remove('collapsed');\n // If there are many nodes, apply the following.\n if (content.childNodes.length > 1) {\n content.classList.add('d-flex');\n }\n nodeSet.forEach(node => {\n node?.classList.remove('d-none');\n node?.setAttribute('aria-hidden', 'false');\n });\n expandButton?.classList.add('d-none');\n expandButton?.setAttribute('aria-hidden', 'true');\n } else {\n element.classList.add('collapsed');\n content.classList.remove('d-flex');\n nodeSet.forEach(node => {\n node?.classList.add('d-none');\n node?.setAttribute('aria-hidden', 'true');\n });\n expandButton?.classList.remove('d-none');\n expandButton?.setAttribute('aria-hidden', 'false');\n }\n }\n });\n }\n\n /**\n * Update the visual count of collapsed columns or hide the count all together.\n */\n countUpdate() {\n countIndicator.textContent = this.getDatasetSize();\n if (this.getDatasetSize() > 0) {\n this.component.parentElement.classList.add('d-flex');\n this.component.parentElement.classList.remove('d-none');\n } else {\n this.component.parentElement.classList.remove('d-flex');\n this.component.parentElement.classList.add('d-none');\n }\n }\n\n /**\n * Build the content then replace the node by default we want our form to exist.\n */\n async renderDefault() {\n this.setMatchedResults(await this.filterDataset(this.getDataset()));\n this.filterMatchDataset();\n\n // Update the collapsed button pill.\n this.countUpdate();\n const {html, js} = await renderForPromise('gradereport_grader/collapse/collapsebody', {\n 'results': this.getMatchedResults(),\n 'userid': this.userID,\n });\n replaceNode(selectors.placeholder, html, js);\n this.updateNodes();\n\n // Given we now have the body, we can set up more triggers.\n this.registerFormEvents();\n this.registerInputEvents();\n\n // Add a small BS listener so that we can set the focus correctly on open.\n this.$component.on('shown.bs.dropdown', () => {\n this.searchInput.focus({preventScroll: true});\n });\n }\n\n /**\n * Build the content then replace the node.\n */\n async renderDropdown() {\n const form = this.component.querySelector(selectors.formDropdown);\n const selectall = form.querySelector('[data-action=\"selectall\"]');\n const {html, js} = await renderForPromise('gradereport_grader/collapse/collapseresults', {\n 'results': this.getMatchedResults(),\n 'searchTerm': this.getSearchTerm(),\n });\n selectall.disabled = this.getMatchedResults().length === 0;\n replaceNodeContents(this.getHTMLElements().searchDropdown, html, js);\n }\n\n /**\n * If we have any custom user profile fields, grab their system & readable names to add to our string map.\n *\n * @returns {array<string,*>} An array of associated string arrays ready for our map.\n */\n fetchCustomFieldValues() {\n const customFields = document.querySelectorAll('[data-collapse-name]');\n // Cast from NodeList to array to grab all the values.\n return [...customFields].map(field => [field.parentElement.dataset.col, field.dataset.collapseName]);\n }\n\n /**\n * Given the set of profile fields we can possibly search, fetch their strings,\n * so we can report to screen readers the field that matched.\n *\n * @returns {Promise<void>}\n */\n fetchRequiredUserStrings() {\n if (!this.userStrings) {\n const requiredStrings = [\n 'username',\n 'firstname',\n 'lastname',\n 'email',\n 'city',\n 'country',\n 'department',\n 'institution',\n 'idnumber',\n 'phone1',\n 'phone2',\n ];\n this.userStrings = getStrings(requiredStrings.map((key) => ({key})))\n .then((stringArray) => new Map(\n requiredStrings.map((key, index) => ([key, stringArray[index]]))\n ));\n }\n return this.userStrings;\n }\n\n /**\n * Given the set of gradable items we can possibly search, fetch their strings,\n * so we can report to screen readers the field that matched.\n *\n * @returns {Promise<void>}\n */\n fetchRequiredGradeStrings() {\n if (!this.gradeStrings) {\n this.gradeStrings = Repository.gradeItems(this.courseID)\n .then((result) => new Map(\n result.gradeItems.map(key => ([key.id, key]))\n ));\n }\n return this.gradeStrings;\n }\n}\n"],"names":["selectors","cancel","save","checked","currentlyUnchecked","countIndicator","document","querySelector","ColumnSearch","search_combobox","userID","courseID","defaultSort","constructor","component","pendingPromise","Pending","then","loader","setTimeout","getDataset","forEach","item","nodesUpdate","renderDefault","remove","classList","resolve","catch","Notification","exception","componentSelector","dropdownSelector","triggerSelector","this","dataset","cols","fetchDataset","JSON","parse","split","datasetSize","length","storage","get","setPreferences","set","stringify","join","registerClickHandlers","addEventListener","clickHandler","bind","docClickHandler","e","target","closest","stopPropagation","hider","preventDefault","desiredToHide","_e$target$closest","col","_e$target$closest2","itemid","indexOf","push","prefcountpipe","_e$target$closest4","_e$target$closest5","idx","splice","_e$target$closest6","_e$target$closest7","keyHandler","key","input","clearSearchButton","focus","preventScroll","registerInputEvents","searchInput","async","setSearchTerms","value","add","filterrenderpipe","registerFormEvents","form","events","CustomEvents","activate","keyboardActivate","define","selectall","event","submitBtn","checkedCount","Array","from","querySelectorAll","disabled","submitter","action","dropdown","elements","filter","collapse","colNodesToHide","itemIDNodesToHide","nodes","updateDisplay","countUpdate","filterableData","stringUserMap","fetchRequiredUserStrings","stringGradeMap","fetchRequiredGradeStrings","customFieldMap","fetchCustomFieldValues","stringMap","Map","searching","map","s","mapObj","undefined","string","itemname","category","getPreppedSearchTerm","toString","toLowerCase","includes","filterMatchDataset","setMatchedResults","getMatchedResults","column","name","displayName","element","content","sort","expandButton","rangeRowCell","avgRowCell","nodeSet","contains","window","location","rowCell","toggle","setAttribute","childNodes","node","textContent","getDatasetSize","parentElement","filterDataset","html","js","updateNodes","$component","on","getSearchTerm","getHTMLElements","searchDropdown","field","collapseName","userStrings","requiredStrings","stringArray","index","gradeStrings","Repository","gradeItems","result","id"],"mappings":"8/DAmCMA,oBACS,oBADTA,uBAEY,uBAFZA,oBAGS,CACPC,OAAQ,SACRC,KAAM,OACNC,QAAS,iCACTC,mBAAoB,yDAPtBJ,gBASK,OATLA,iBAUM,SAVNA,iBAWM,aAXNA,kBAYO,gBAZPA,kBAaO,4BAbPA,eAcI,yBAdJA,uBAeY,iCAfZA,uBAgBY,iCAhBZA,qBAiBU,+BAjBVA,eAkBI,yBAlBJA,gBAmBK,4BAnBLA,gBAoBK,0BApBLA,sBAqBW,sDArBXA,uBAsBY,0BAGZK,eAAiBC,SAASC,cAAcP,uBAEzBQ,qBAAqBC,qCAY1BC,OAAQC,SAAUC,oBACnB,IAAIJ,aAAaE,OAAQC,SAAUC,aAG9CC,YAAYH,OAAQC,SAAUC,oDAdpB,mCACC,yCACG,iCAEN,wCAEO,yCACD,uCACF,SAQHF,OAASA,YACTC,SAAWA,cACXC,YAAcA,iBACdE,UAAYR,SAASC,cAAcP,2BAElCe,eAAiB,IAAIC,qDAERV,SAASC,cAAc,iBAAiBU,MAAMC,SAC7DC,YAAW,UAEFC,aAAaC,SAASC,YAClBC,YAAYD,cAEhBE,gBAGLN,OAAOO,SACPnB,SAASC,cAAc,6BAA6BmB,UAAUD,OAAO,YACtE,OACJR,MAAK,IAAMF,eAAeY,YAAWC,MAAMC,sBAAaC,WAQ/DC,0BACW,oBAQXC,yBACW,8BAQXC,wBACW,kBAQXb,iBACSc,KAAKC,QAAS,OACTC,KAAOF,KAAKG,oBACbF,QAAUG,KAAKC,MAAMH,MAAQE,KAAKC,MAAMH,MAAMI,MAAM,KAAO,eAE/DC,YAAcP,KAAKC,QAAQO,OACzBR,KAAKC,QAQhBE,sBACWM,sBAAQC,gDAAyCV,KAAKvB,qBAAYuB,KAAKxB,SAMlFmC,uCACYC,gDAAyCZ,KAAKvB,qBAAYuB,KAAKxB,QACnE4B,KAAKS,UAAUb,KAAKd,aAAa4B,KAAK,OAO9CC,6BAESnC,UAAUoC,iBAAiB,QAAShB,KAAKiB,aAAaC,KAAKlB,OAEhE5B,SAAS4C,iBAAiB,QAAShB,KAAKmB,gBAAgBD,KAAKlB,OAQjEiB,aAAaG,SACHH,aAAaG,GAEfA,EAAEC,OAAOC,QAAQxD,yBACjBsD,EAAEG,wCAUYH,6BACdA,EAAEC,OAAOpB,QAAQuB,QAAU1D,gBAAiB,0CAC5CsD,EAAEK,uBACIC,cAAgBN,EAAEC,OAAOC,QAAQxD,4CACnCsD,EAAEC,OAAOC,QAAQxD,sDAAjB6D,kBAAoC1B,QAAQ2B,+BAC5CR,EAAEC,OAAOC,QAAQxD,wDAAjB+D,mBAAqC5B,QAAQ6B,QAEpC,IADD9B,KAAKd,aAAa6C,QAAQL,qBAE7BxC,aAAa8C,KAAKN,qBAErB1B,KAAKiC,qBAEN5C,YAAYqC,8CAGjBN,EAAEC,OAAOC,QAAQ,kEAAWrB,QAAQuB,SAAU1D,iBAAkB,iFAChEsD,EAAEK,uBACIC,cAAgBN,EAAEC,OAAOC,QAAQxD,6CACnCsD,EAAEC,OAAOC,QAAQxD,uDAAjBoE,mBAAoCjC,QAAQ2B,+BAC5CR,EAAEC,OAAOC,QAAQxD,wDAAjBqE,mBAAqClC,QAAQ6B,OAC3CM,IAAMpC,KAAKd,aAAa6C,QAAQL,oBACjCxC,aAAamD,OAAOD,IAAK,SAExBpC,KAAKiC,qBAEN5C,uCAAY+B,EAAEC,OAAOC,QAAQxD,uDAAjBwE,mBAAoCrC,QAAQ2B,UACxDvC,uCAAY+B,EAAEC,OAAOC,QAAQxD,uDAAjByE,mBAAoCtC,QAAQ6B,0BASpDV,YACPoB,WAAWpB,GAIR,QADDA,EAAEqB,IAEErB,EAAEC,OAAOC,QAAQtB,KAAKlC,UAAU4E,SAChCtB,EAAEK,sBACGkB,kBAAkBC,MAAM,CAACC,eAAe,KAS7DC,2BAESC,YAAY/B,iBAAiB,SAAS,oBAASgC,eAC3CC,eAAejD,KAAK+C,YAAYG,OAEN,KAA3BlD,KAAK+C,YAAYG,WAEZP,kBAAkBnD,UAAU2D,IAAI,eAGhCR,kBAAkBnD,UAAUD,OAAO,gBAGtCS,KAAKoD,qBACZ,MAMPC,2BACUC,KAAOtD,KAAKpB,UAAUP,cAAcP,wBACpCyF,OAAS,CACX,QACAC,mCAAaD,OAAOE,SACpBD,mCAAaD,OAAOG,qDAEXC,OAAOvF,SAAUmF,cAExBK,UAAYN,KAAKjF,cAAc,6BAGrCkF,OAAOpE,SAAS0E,cACNC,UAAYR,KAAKjF,sCAA+BP,oBAAoBE,WAC1EsF,KAAKtC,iBAAiB6C,OAAQzC,IAE1BA,EAAEG,wBACImB,MAAQtB,EAAEC,OAAOC,QAAQ,YAC3BoB,MAAO,CAEHkB,UAAU3F,UAAYyE,MAAMzE,UAC5B2F,UAAU3F,SAAU,SAElB8F,aAAeC,MAAMC,KAAKX,KAAKY,iBAAiBpG,oBAAoBG,UAAUuC,OAEpFsD,UAAUK,SAAWJ,cAAgB,MAE1C,QAGEhB,YAAY/B,iBAAiB6C,OAAOzC,GAAKA,EAAEG,yBAC3CoB,kBAAkB3B,iBAAiB6C,OAAOb,MAAAA,IAC3C5B,EAAEG,uBACGwB,YAAYG,MAAQ,QACpBD,eAAejD,KAAK+C,YAAYG,aAC/BlD,KAAKoD,sBAEfQ,UAAU5C,iBAAiB6C,OAAQzC,OAE/BA,EAAEG,kBACGqC,UAAU3F,QAMR,CACsB+F,MAAMC,KAAKX,KAAKY,iBAAiBpG,oBAAoBI,qBAC7DiB,SAAQC,OACrBA,KAAKnB,SAAU,KAEnB6F,UAAUK,UAAW,MAXD,CACFH,MAAMC,KAAKX,KAAKY,iBAAiBpG,oBAAoBG,UAC7DkB,SAAQC,OACdA,KAAKnB,SAAU,KAEnB6F,UAAUK,UAAW,SAWjCb,KAAKtC,iBAAiB,UAAUgC,MAAAA,OAC5B5B,EAAEK,iBACEL,EAAEgD,UAAUnE,QAAQoE,SAAWvG,oBAAoBC,sCACjDiC,KAAKpB,WAAW0F,SAAS,UAIV,IAAIhB,KAAKiB,UAAUC,QAAOpF,MAAQA,KAAKnB,UAC/CkB,SAASC,aACZgD,IAAMpC,KAAKd,aAAa6C,QAAQ3C,KAAKa,QAAQwE,eAC9CvF,aAAamD,OAAOD,IAAK,QACzB/C,YAAYD,KAAKa,QAAQwE,aAGlCb,UAAU3F,SAAU,EACpBmD,EAAEgD,UAAUD,UAAW,QACjBnE,KAAKiC,mBAInB5C,YAAYD,YACFsF,eAAiB,IAAItG,SAAS8F,sCAA+B9E,aAC7DuF,kBAAoB,IAAIvG,SAAS8F,yCAAkC9E,kBACpEwF,MAAQ,IAAIF,kBAAmBC,wBAC/BE,2CASAlE,sBACAmE,oBACC9E,KAAKoD,uCASK2B,sBACVC,oBAAsBhF,KAAKiF,2BAC3BC,qBAAuBlF,KAAKmF,4BAE5BC,eAAiBpF,KAAKqF,8BACvBC,UAAY,IAAIC,IAAI,IAAIL,kBAAmBF,iBAAkBI,uBAE5DI,UAAYT,eAAeU,KAAIC,gDAC3BC,OAAS3F,KAAKsF,UAAU5E,IAAIgF,eACnBE,IAAXD,OACO,CAAClD,IAAKiD,EAAGG,OAAQH,GAErB,CACHjD,IAAKiD,EACLG,gCAAQF,OAAOG,sDAAY9F,KAAKsF,UAAU5E,IAAIgF,GAC9CK,kCAAUJ,OAAOI,sDAAY,aAID,KAAhC/F,KAAKgG,uBACER,UAGJA,UAAUhB,QAAQ5C,KACdA,IAAIiE,OAAOI,WAAWC,cAAcC,SAASnG,KAAKgG,0BAOjEI,0BACSC,kBACDrG,KAAKsG,oBAAoBb,KAAKc,mDACnB,CACHC,KAAMD,OAAO9D,IACbgE,mCAAaF,OAAOV,gDAAUU,OAAO9D,IACrCsD,kCAAUQ,OAAOR,sDAAY,QAS7ClB,qBACSD,MAAMzF,SAASuH,gBACVC,QAAUD,QAAQrI,cAAcP,mBAChC8I,KAAOF,QAAQrI,cAAcP,gBAC7B+I,aAAeH,QAAQrI,cAAcP,wBACrCgJ,aAAeJ,QAAQrI,cAAcP,wBACrCiJ,WAAaL,QAAQrI,cAAcP,sBACnCkJ,QAAU,CACZN,QAAQrI,cAAcP,gBACtB4I,QAAQrI,cAAcP,iBACtB6I,YAIAD,QAAQlH,UAAUyH,SAAS,WAEd,OAATL,OACAM,OAAOC,SAAWnH,KAAKtB,aAEX,OAAZiI,QAAkB,OAEZS,QAAUL,MAAAA,WAAAA,WAAcD,aAE9BM,MAAAA,SAAAA,QAAS5H,UAAU6H,OAAO,UAC1BD,MAAAA,SAAAA,QAASE,aAAa,cAClBF,MAAAA,SAAAA,QAAS5H,UAAUyH,SAAS,UAAY,OAAS,cAC9CN,QAAQnH,UAAUyH,SAAS,WAElCP,QAAQlH,UAAUD,OAAO,aAErBoH,QAAQY,WAAW/G,OAAS,GAC5BmG,QAAQnH,UAAU2D,IAAI,UAE1B6D,QAAQ7H,SAAQqI,OACZA,MAAAA,MAAAA,KAAMhI,UAAUD,OAAO,UACvBiI,MAAAA,MAAAA,KAAMF,aAAa,cAAe,YAEtCT,MAAAA,cAAAA,aAAcrH,UAAU2D,IAAI,UAC5B0D,MAAAA,cAAAA,aAAcS,aAAa,cAAe,UAE1CZ,QAAQlH,UAAU2D,IAAI,aACtBwD,QAAQnH,UAAUD,OAAO,UACzByH,QAAQ7H,SAAQqI,OACZA,MAAAA,MAAAA,KAAMhI,UAAU2D,IAAI,UACpBqE,MAAAA,MAAAA,KAAMF,aAAa,cAAe,WAEtCT,MAAAA,cAAAA,aAAcrH,UAAUD,OAAO,UAC/BsH,MAAAA,cAAAA,aAAcS,aAAa,cAAe,aAS1DxC,cACI3G,eAAesJ,YAAczH,KAAK0H,iBAC9B1H,KAAK0H,iBAAmB,QACnB9I,UAAU+I,cAAcnI,UAAU2D,IAAI,eACtCvE,UAAU+I,cAAcnI,UAAUD,OAAO,iBAEzCX,UAAU+I,cAAcnI,UAAUD,OAAO,eACzCX,UAAU+I,cAAcnI,UAAU2D,IAAI,sCAQ1CkD,wBAAwBrG,KAAK4H,cAAc5H,KAAKd,oBAChDkH,0BAGAtB,oBACC+C,KAACA,KAADC,GAAOA,UAAY,+BAAiB,2CAA4C,SACvE9H,KAAKsG,2BACNtG,KAAKxB,oCAEPV,sBAAuB+J,KAAMC,SACpCC,mBAGA1E,0BACAP,2BAGAkF,WAAWC,GAAG,qBAAqB,UAC/BlF,YAAYH,MAAM,CAACC,eAAe,oCASrCe,UADO5D,KAAKpB,UAAUP,cAAcP,wBACnBO,cAAc,8BAC/BwJ,KAACA,KAADC,GAAOA,UAAY,+BAAiB,8CAA+C,SAC1E9H,KAAKsG,+BACFtG,KAAKkI,kBAEvBtE,UAAUO,SAA+C,IAApCnE,KAAKsG,oBAAoB9F,0CAC1BR,KAAKmI,kBAAkBC,eAAgBP,KAAMC,IAQrEzC,+BAGW,IAFcjH,SAAS8F,iBAAiB,yBAEtBuB,KAAI4C,OAAS,CAACA,MAAMV,cAAc1H,QAAQ2B,IAAKyG,MAAMpI,QAAQqI,gBAS1FrD,+BACSjF,KAAKuI,YAAa,OACbC,gBAAkB,CACpB,WACA,YACA,WACA,QACA,OACA,UACA,aACA,cACA,WACA,SACA,eAECD,aAAc,mBAAWC,gBAAgB/C,KAAKhD,OAAUA,IAAAA,SACxD1D,MAAM0J,aAAgB,IAAIlD,IACvBiD,gBAAgB/C,KAAI,CAAChD,IAAKiG,QAAW,CAACjG,IAAKgG,YAAYC,oBAG5D1I,KAAKuI,YAShBpD,mCACSnF,KAAK2I,oBACDA,aAAeC,WAAWC,WAAW7I,KAAKvB,UAC1CM,MAAM+J,QAAW,IAAIvD,IAClBuD,OAAOD,WAAWpD,KAAIhD,KAAQ,CAACA,IAAIsG,GAAItG,WAG5CzC,KAAK2I"} report/grader/amd/build/user.min.js.map 0000604 00000006174 15062070557 0014050 0 ustar 00 {"version":3,"file":"user.min.js","sources":["../src/user.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Allow the user to search for learners within the grader report.\n *\n * @module gradereport_grader/user\n * @copyright 2023 Mathew May <mathew.solutions>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\nimport UserSearch from 'core_user/comboboxsearch/user';\nimport Url from 'core/url';\nimport * as Repository from 'gradereport_grader/local/user/repository';\n\n// Define our standard lookups.\nconst selectors = {\n component: '.user-search',\n courseid: '[data-region=\"courseid\"]',\n};\nconst component = document.querySelector(selectors.component);\nconst courseID = component.querySelector(selectors.courseid).dataset.courseid;\n\nexport default class User extends UserSearch {\n\n constructor() {\n super();\n }\n\n static init() {\n return new User();\n }\n\n /**\n * Get the data we will be searching against in this component.\n *\n * @returns {Promise<*>}\n */\n fetchDataset() {\n return Repository.userFetch(courseID).then((r) => r.users);\n }\n\n /**\n * Build up the view all link.\n *\n * @returns {string|*}\n */\n selectAllResultsLink() {\n return Url.relativeUrl('/grade/report/grader/index.php', {\n id: courseID,\n searchvalue: this.getSearchTerm()\n }, false);\n }\n\n /**\n * Build up the view all link that is dedicated to a particular result.\n *\n * @param {Number} userID The ID of the user selected.\n * @returns {string|*}\n */\n selectOneLink(userID) {\n return Url.relativeUrl('/grade/report/grader/index.php', {\n id: courseID,\n searchvalue: this.getSearchTerm(),\n userid: userID,\n }, false);\n }\n}\n"],"names":["selectors","courseID","document","querySelector","dataset","courseid","User","UserSearch","constructor","fetchDataset","Repository","userFetch","then","r","users","selectAllResultsLink","Url","relativeUrl","id","searchvalue","this","getSearchTerm","selectOneLink","userID","userid"],"mappings":";;;;;;;q0BA2BMA,oBACS,eADTA,mBAEQ,2BAGRC,SADYC,SAASC,cAAcH,qBACdG,cAAcH,oBAAoBI,QAAQC,eAEhDC,aAAaC,cAE9BC,2CAKW,IAAIF,KAQfG,sBACWC,WAAWC,UAAUV,UAAUW,MAAMC,GAAMA,EAAEC,QAQxDC,8BACWC,aAAIC,YAAY,iCAAkC,CACrDC,GAAIjB,SACJkB,YAAaC,KAAKC,kBACnB,GASPC,cAAcC,eACHP,aAAIC,YAAY,iCAAkC,CACrDC,GAAIjB,SACJkB,YAAaC,KAAKC,gBAClBG,OAAQD,SACT"} report/grader/amd/build/user.min.js 0000604 00000004433 15062070557 0013270 0 ustar 00 define("gradereport_grader/user",["exports","core_user/comboboxsearch/user","core/url","gradereport_grader/local/user/repository"],(function(_exports,_user,_url,Repository){function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}} /** * Allow the user to search for learners within the grader report. * * @module gradereport_grader/user * @copyright 2023 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.default=void 0,_user=_interopRequireDefault(_user),_url=_interopRequireDefault(_url),Repository=function(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}newObj.default=obj,cache&&cache.set(obj,newObj);return newObj}(Repository);const selectors_component=".user-search",selectors_courseid='[data-region="courseid"]',courseID=document.querySelector(selectors_component).querySelector(selectors_courseid).dataset.courseid;class User extends _user.default{constructor(){super()}static init(){return new User}fetchDataset(){return Repository.userFetch(courseID).then((r=>r.users))}selectAllResultsLink(){return _url.default.relativeUrl("/grade/report/grader/index.php",{id:courseID,searchvalue:this.getSearchTerm()},!1)}selectOneLink(userID){return _url.default.relativeUrl("/grade/report/grader/index.php",{id:courseID,searchvalue:this.getSearchTerm(),userid:userID},!1)}}return _exports.default=User,_exports.default})); //# sourceMappingURL=user.min.js.map report/grader/amd/build/collapse.min.js 0000604 00000032666 15062070557 0014125 0 ustar 00 define("gradereport_grader/collapse",["exports","gradereport_grader/collapse/repository","core/comboboxsearch/search_combobox","core/templates","core/utils","jquery","core/str","core/custom_interaction_events","core/localstorage","core/loadingicon","core/notification","core/pending"],(function(_exports,Repository,_search_combobox,_templates,_utils,_jquery,_str,_custom_interaction_events,_localstorage,_loadingicon,_notification,_pending){function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}}function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}function _defineProperty(obj,key,value){return key in obj?Object.defineProperty(obj,key,{value:value,enumerable:!0,configurable:!0,writable:!0}):obj[key]=value,obj}Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.default=void 0,Repository=function(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}newObj.default=obj,cache&&cache.set(obj,newObj);return newObj}(Repository),_search_combobox=_interopRequireDefault(_search_combobox),_jquery=_interopRequireDefault(_jquery),_custom_interaction_events=_interopRequireDefault(_custom_interaction_events),_localstorage=_interopRequireDefault(_localstorage),_notification=_interopRequireDefault(_notification),_pending=_interopRequireDefault(_pending);const selectors_component=".collapse-columns",selectors_formDropdown=".columnsdropdownform",selectors_formItems={cancel:"cancel",save:"save",checked:'input[type="checkbox"]:checked',currentlyUnchecked:'input[type="checkbox"]:not([data-action="selectall"])'},selectors_hider="hide",selectors_expand="expand",selectors_colVal="[data-col]",selectors_itemVal="[data-itemid]",selectors_content='[data-collapse="content"]',selectors_sort='[data-collapse="sort"]',selectors_expandbutton='[data-collapse="expandbutton"]',selectors_rangerowcell='[data-collapse="rangerowcell"]',selectors_avgrowcell='[data-collapse="avgrowcell"]',selectors_menu='[data-collapse="menu"]',selectors_icons=".data-collapse_gradeicons",selectors_count='[data-collapse="count"]',selectors_placeholder='.collapsecolumndropdown [data-region="placeholder"]',selectors_fullDropdown=".collapsecolumndropdown",countIndicator=document.querySelector(selectors_count);class ColumnSearch extends _search_combobox.default{static init(userID,courseID,defaultSort){return new ColumnSearch(userID,courseID,defaultSort)}constructor(userID,courseID,defaultSort){super(),_defineProperty(this,"userID",-1),_defineProperty(this,"courseID",null),_defineProperty(this,"defaultSort",""),_defineProperty(this,"nodes",[]),_defineProperty(this,"gradeStrings",null),_defineProperty(this,"userStrings",null),_defineProperty(this,"stringMap",[]),this.userID=userID,this.courseID=courseID,this.defaultSort=defaultSort,this.component=document.querySelector(selectors_component);const pendingPromise=new _pending.default;(0,_loadingicon.addIconToContainer)(document.querySelector(".gradeparent")).then((loader=>{setTimeout((()=>{this.getDataset().forEach((item=>{this.nodesUpdate(item)})),this.renderDefault(),loader.remove(),document.querySelector(".gradereport-grader-table").classList.remove("d-none")}),10)})).then((()=>pendingPromise.resolve())).catch(_notification.default.exception)}componentSelector(){return".collapse-columns"}dropdownSelector(){return".searchresultitemscontainer"}triggerSelector(){return".collapsecolumn"}getDataset(){if(!this.dataset){const cols=this.fetchDataset();this.dataset=JSON.parse(cols)?JSON.parse(cols).split(","):[]}return this.datasetSize=this.dataset.length,this.dataset}fetchDataset(){return _localstorage.default.get("gradereport_grader_collapseditems_".concat(this.courseID,"_").concat(this.userID))}setPreferences(){_localstorage.default.set("gradereport_grader_collapseditems_".concat(this.courseID,"_").concat(this.userID),JSON.stringify(this.getDataset().join(",")))}registerClickHandlers(){this.component.addEventListener("click",this.clickHandler.bind(this)),document.addEventListener("click",this.docClickHandler.bind(this))}clickHandler(e){super.clickHandler(e),e.target.closest(selectors_fullDropdown)&&e.stopPropagation()}async docClickHandler(e){var _e$target$closest3;if(e.target.dataset.hider===selectors_hider){var _e$target$closest,_e$target$closest2;e.preventDefault();const desiredToHide=e.target.closest(selectors_colVal)?null===(_e$target$closest=e.target.closest(selectors_colVal))||void 0===_e$target$closest?void 0:_e$target$closest.dataset.col:null===(_e$target$closest2=e.target.closest(selectors_itemVal))||void 0===_e$target$closest2?void 0:_e$target$closest2.dataset.itemid;-1===this.getDataset().indexOf(desiredToHide)&&this.getDataset().push(desiredToHide),await this.prefcountpipe(),this.nodesUpdate(desiredToHide)}if((null===(_e$target$closest3=e.target.closest("button"))||void 0===_e$target$closest3?void 0:_e$target$closest3.dataset.hider)===selectors_expand){var _e$target$closest4,_e$target$closest5,_e$target$closest6,_e$target$closest7;e.preventDefault();const desiredToHide=e.target.closest(selectors_colVal)?null===(_e$target$closest4=e.target.closest(selectors_colVal))||void 0===_e$target$closest4?void 0:_e$target$closest4.dataset.col:null===(_e$target$closest5=e.target.closest(selectors_itemVal))||void 0===_e$target$closest5?void 0:_e$target$closest5.dataset.itemid,idx=this.getDataset().indexOf(desiredToHide);this.getDataset().splice(idx,1),await this.prefcountpipe(),this.nodesUpdate(null===(_e$target$closest6=e.target.closest(selectors_colVal))||void 0===_e$target$closest6?void 0:_e$target$closest6.dataset.col),this.nodesUpdate(null===(_e$target$closest7=e.target.closest(selectors_colVal))||void 0===_e$target$closest7?void 0:_e$target$closest7.dataset.itemid)}}async keyHandler(e){if(super.keyHandler(e),"Tab"===e.key)e.target.closest(this.selectors.input)&&(e.preventDefault(),this.clearSearchButton.focus({preventScroll:!0}))}registerInputEvents(){this.searchInput.addEventListener("input",(0,_utils.debounce)((async()=>{this.setSearchTerms(this.searchInput.value),""===this.searchInput.value?this.clearSearchButton.classList.add("d-none"):this.clearSearchButton.classList.remove("d-none"),await this.filterrenderpipe()}),300))}registerFormEvents(){const form=this.component.querySelector(selectors_formDropdown),events=["click",_custom_interaction_events.default.events.activate,_custom_interaction_events.default.events.keyboardActivate];_custom_interaction_events.default.define(document,events);const selectall=form.querySelector('[data-action="selectall"]');events.forEach((event=>{const submitBtn=form.querySelector('[data-action="'.concat(selectors_formItems.save,'"'));form.addEventListener(event,(e=>{e.stopPropagation();const input=e.target.closest("input");if(input){selectall.checked&&!input.checked&&(selectall.checked=!1);const checkedCount=Array.from(form.querySelectorAll(selectors_formItems.checked)).length;submitBtn.disabled=checkedCount<=0}}),!1),this.searchInput.addEventListener(event,(e=>e.stopPropagation())),this.clearSearchButton.addEventListener(event,(async e=>{e.stopPropagation(),this.searchInput.value="",this.setSearchTerms(this.searchInput.value),await this.filterrenderpipe()})),selectall.addEventListener(event,(e=>{if(e.stopPropagation(),selectall.checked){Array.from(form.querySelectorAll(selectors_formItems.currentlyUnchecked)).forEach((item=>{item.checked=!0})),submitBtn.disabled=!1}else{Array.from(form.querySelectorAll(selectors_formItems.checked)).forEach((item=>{item.checked=!1})),submitBtn.disabled=!0}}))})),form.addEventListener("submit",(async e=>{if(e.preventDefault(),e.submitter.dataset.action===selectors_formItems.cancel)return void(0,_jquery.default)(this.component).dropdown("toggle");[...form.elements].filter((item=>item.checked)).forEach((item=>{const idx=this.getDataset().indexOf(item.dataset.collapse);this.getDataset().splice(idx,1),this.nodesUpdate(item.dataset.collapse)})),selectall.checked=!1,e.submitter.disabled=!0,await this.prefcountpipe()}))}nodesUpdate(item){const colNodesToHide=[...document.querySelectorAll('[data-col="'.concat(item,'"]'))],itemIDNodesToHide=[...document.querySelectorAll('[data-itemid="'.concat(item,'"]'))];this.nodes=[...colNodesToHide,...itemIDNodesToHide],this.updateDisplay()}async prefcountpipe(){this.setPreferences(),this.countUpdate(),await this.filterrenderpipe()}async filterDataset(filterableData){const stringUserMap=await this.fetchRequiredUserStrings(),stringGradeMap=await this.fetchRequiredGradeStrings(),customFieldMap=this.fetchCustomFieldValues();this.stringMap=new Map([...stringGradeMap,...stringUserMap,...customFieldMap]);const searching=filterableData.map((s=>{var _mapObj$itemname,_mapObj$category;const mapObj=this.stringMap.get(s);return void 0===mapObj?{key:s,string:s}:{key:s,string:null!==(_mapObj$itemname=mapObj.itemname)&&void 0!==_mapObj$itemname?_mapObj$itemname:this.stringMap.get(s),category:null!==(_mapObj$category=mapObj.category)&&void 0!==_mapObj$category?_mapObj$category:""}}));return""===this.getPreppedSearchTerm()?searching:searching.filter((col=>col.string.toString().toLowerCase().includes(this.getPreppedSearchTerm())))}filterMatchDataset(){this.setMatchedResults(this.getMatchedResults().map((column=>{var _column$string,_column$category;return{name:column.key,displayName:null!==(_column$string=column.string)&&void 0!==_column$string?_column$string:column.key,category:null!==(_column$category=column.category)&&void 0!==_column$category?_column$category:""}})))}updateDisplay(){this.nodes.forEach((element=>{const content=element.querySelector(selectors_content),sort=element.querySelector(selectors_sort),expandButton=element.querySelector(selectors_expandbutton),rangeRowCell=element.querySelector(selectors_rangerowcell),avgRowCell=element.querySelector(selectors_avgrowcell),nodeSet=[element.querySelector(selectors_menu),element.querySelector(selectors_icons),content];if(element.classList.contains("cell"))if(null!==sort&&(window.location=this.defaultSort),null===content){const rowCell=null!=avgRowCell?avgRowCell:rangeRowCell;null==rowCell||rowCell.classList.toggle("d-none"),null==rowCell||rowCell.setAttribute("aria-hidden",null!=rowCell&&rowCell.classList.contains("d-none")?"true":"false")}else content.classList.contains("d-none")?(element.classList.remove("collapsed"),content.childNodes.length>1&&content.classList.add("d-flex"),nodeSet.forEach((node=>{null==node||node.classList.remove("d-none"),null==node||node.setAttribute("aria-hidden","false")})),null==expandButton||expandButton.classList.add("d-none"),null==expandButton||expandButton.setAttribute("aria-hidden","true")):(element.classList.add("collapsed"),content.classList.remove("d-flex"),nodeSet.forEach((node=>{null==node||node.classList.add("d-none"),null==node||node.setAttribute("aria-hidden","true")})),null==expandButton||expandButton.classList.remove("d-none"),null==expandButton||expandButton.setAttribute("aria-hidden","false"))}))}countUpdate(){countIndicator.textContent=this.getDatasetSize(),this.getDatasetSize()>0?(this.component.parentElement.classList.add("d-flex"),this.component.parentElement.classList.remove("d-none")):(this.component.parentElement.classList.remove("d-flex"),this.component.parentElement.classList.add("d-none"))}async renderDefault(){this.setMatchedResults(await this.filterDataset(this.getDataset())),this.filterMatchDataset(),this.countUpdate();const{html:html,js:js}=await(0,_templates.renderForPromise)("gradereport_grader/collapse/collapsebody",{results:this.getMatchedResults(),userid:this.userID});(0,_templates.replaceNode)(selectors_placeholder,html,js),this.updateNodes(),this.registerFormEvents(),this.registerInputEvents(),this.$component.on("shown.bs.dropdown",(()=>{this.searchInput.focus({preventScroll:!0})}))}async renderDropdown(){const selectall=this.component.querySelector(selectors_formDropdown).querySelector('[data-action="selectall"]'),{html:html,js:js}=await(0,_templates.renderForPromise)("gradereport_grader/collapse/collapseresults",{results:this.getMatchedResults(),searchTerm:this.getSearchTerm()});selectall.disabled=0===this.getMatchedResults().length,(0,_templates.replaceNodeContents)(this.getHTMLElements().searchDropdown,html,js)}fetchCustomFieldValues(){return[...document.querySelectorAll("[data-collapse-name]")].map((field=>[field.parentElement.dataset.col,field.dataset.collapseName]))}fetchRequiredUserStrings(){if(!this.userStrings){const requiredStrings=["username","firstname","lastname","email","city","country","department","institution","idnumber","phone1","phone2"];this.userStrings=(0,_str.getStrings)(requiredStrings.map((key=>({key:key})))).then((stringArray=>new Map(requiredStrings.map(((key,index)=>[key,stringArray[index]])))))}return this.userStrings}fetchRequiredGradeStrings(){return this.gradeStrings||(this.gradeStrings=Repository.gradeItems(this.courseID).then((result=>new Map(result.gradeItems.map((key=>[key.id,key])))))),this.gradeStrings}}return _exports.default=ColumnSearch,_exports.default})); //# sourceMappingURL=collapse.min.js.map report/grader/amd/build/feedback_modal.min.js 0000604 00000003707 15062070557 0015215 0 ustar 00 define("gradereport_grader/feedback_modal",["exports","core/modal","core/notification","core/ajax","core/templates"],(function(_exports,_modal,_notification,_ajax,_templates){function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}} /** * Javascript module for displaying feedback in a modal window * * @module gradereport_grader/feedback_modal * @copyright 2023 Kevin Percy <kevin.percy@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.init=void 0,_modal=_interopRequireDefault(_modal),_notification=_interopRequireDefault(_notification),_ajax=_interopRequireDefault(_ajax),_templates=_interopRequireDefault(_templates);const Selectors_showFeedback='[data-action="feedback"]',fetchFeedback=(courseid,userid,itemid)=>{const request={methodname:"core_grades_get_feedback",args:{courseid:courseid,userid:userid,itemid:itemid}};return _ajax.default.call([request])[0]},registerEventListeners=()=>{document.addEventListener("click",(e=>{const showFeedbackTrigger=e.target.closest(Selectors_showFeedback);if(showFeedbackTrigger){e.preventDefault();(async(courseid,userid,itemid)=>{let feedbackData;try{feedbackData=await fetchFeedback(courseid,userid,itemid)}catch(e){return Promise.reject(e)}return _modal.default.create({removeOnClose:!0,large:!0,verticallyCentered:!0}).then((modal=>{const body=_templates.default.render("core_grades/feedback_modal",{feedbacktext:feedbackData.feedbacktext,user:{picture:feedbackData.picture,fullname:feedbackData.fullname,additionalfield:feedbackData.additionalfield}});return modal.setBody(body),modal.setTitle(feedbackData.title),modal.show(),modal}))})(showFeedbackTrigger.dataset.courseid,e.target.closest("tr").dataset.uid,e.target.closest("td").dataset.itemid).catch(_notification.default.exception)}}))};_exports.init=()=>{registerEventListeners()}})); //# sourceMappingURL=feedback_modal.min.js.map report/grader/amd/build/feedback_modal.min.js.map 0000604 00000011231 15062070557 0015760 0 ustar 00 {"version":3,"file":"feedback_modal.min.js","sources":["../src/feedback_modal.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Javascript module for displaying feedback in a modal window\n *\n * @module gradereport_grader/feedback_modal\n * @copyright 2023 Kevin Percy <kevin.percy@moodle.com>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\nimport Modal from 'core/modal';\nimport Notification from 'core/notification';\nimport ajax from 'core/ajax';\nimport Templates from 'core/templates';\n\nconst Selectors = {\n showFeedback: '[data-action=\"feedback\"]'\n};\n\n/**\n * Create the modal to display the feedback.\n *\n * @param {int} courseid\n * @param {int} userid\n * @param {int} itemid\n * @returns {Promise}\n */\nconst getModal = async(courseid, userid, itemid) => {\n let feedbackData;\n\n try {\n feedbackData = await fetchFeedback(courseid, userid, itemid);\n } catch (e) {\n return Promise.reject(e);\n }\n\n return Modal.create({\n removeOnClose: true,\n large: true,\n verticallyCentered: true,\n })\n .then(modal => {\n const body = Templates.render('core_grades/feedback_modal', {\n feedbacktext: feedbackData.feedbacktext,\n user: {\n picture: feedbackData.picture,\n fullname: feedbackData.fullname,\n additionalfield: feedbackData.additionalfield,\n },\n });\n\n modal.setBody(body);\n modal.setTitle(feedbackData.title);\n modal.show();\n\n return modal;\n });\n};\n\n/**\n * Fetch the feedback data.\n *\n * @param {int} courseid\n * @param {int} userid\n * @param {int} itemid\n * @returns {Promise}\n */\nconst fetchFeedback = (courseid, userid, itemid) => {\n const request = {\n methodname: 'core_grades_get_feedback',\n args: {\n courseid: courseid,\n userid: userid,\n itemid: itemid,\n },\n };\n return ajax.call([request])[0];\n};\n\n/**\n * Register event listeners for the View Feedback links.\n */\nconst registerEventListeners = () => {\n document.addEventListener('click', e => {\n const showFeedbackTrigger = e.target.closest(Selectors.showFeedback);\n if (showFeedbackTrigger) {\n e.preventDefault();\n\n const courseid = showFeedbackTrigger.dataset.courseid;\n const userid = e.target.closest('tr').dataset.uid;\n const itemid = e.target.closest('td').dataset.itemid;\n\n getModal(courseid, userid, itemid)\n .catch(Notification.exception);\n }\n });\n};\n\n/**\n * Initialize module\n */\nexport const init = () => {\n registerEventListeners();\n};\n"],"names":["Selectors","fetchFeedback","courseid","userid","itemid","request","methodname","args","ajax","call","registerEventListeners","document","addEventListener","e","showFeedbackTrigger","target","closest","preventDefault","async","feedbackData","Promise","reject","Modal","create","removeOnClose","large","verticallyCentered","then","modal","body","Templates","render","feedbacktext","user","picture","fullname","additionalfield","setBody","setTitle","title","show","getModal","dataset","uid","catch","Notification","exception"],"mappings":";;;;;;;oQA2BMA,uBACY,2BAmDZC,cAAgB,CAACC,SAAUC,OAAQC,gBAC/BC,QAAU,CACZC,WAAY,2BACZC,KAAM,CACFL,SAAUA,SACVC,OAAQA,OACRC,OAAQA,gBAGTI,cAAKC,KAAK,CAACJ,UAAU,IAM1BK,uBAAyB,KAC3BC,SAASC,iBAAiB,SAASC,UACzBC,oBAAsBD,EAAEE,OAAOC,QAAQhB,2BACzCc,oBAAqB,CACrBD,EAAEI,iBA3DGC,OAAMhB,SAAUC,OAAQC,cACjCe,iBAGAA,mBAAqBlB,cAAcC,SAAUC,OAAQC,QACvD,MAAOS,UACEO,QAAQC,OAAOR,UAGnBS,eAAMC,OAAO,CAChBC,eAAe,EACfC,OAAO,EACPC,oBAAoB,IAEvBC,MAAKC,cACIC,KAAOC,mBAAUC,OAAO,6BAA8B,CACxDC,aAAcb,aAAaa,aAC3BC,KAAM,CACFC,QAASf,aAAae,QACtBC,SAAUhB,aAAagB,SACvBC,gBAAiBjB,aAAaiB,0BAItCR,MAAMS,QAAQR,MACdD,MAAMU,SAASnB,aAAaoB,OAC5BX,MAAMY,OAECZ,UAqCHa,CAJiB3B,oBAAoB4B,QAAQxC,SAC9BW,EAAEE,OAAOC,QAAQ,MAAM0B,QAAQC,IAC/B9B,EAAEE,OAAOC,QAAQ,MAAM0B,QAAQtC,QAGzCwC,MAAMC,sBAAaC,8BAQhB,KAChBpC"} report/grader/amd/src/feedback_modal.js 0000604 00000006246 15062070557 0014124 0 ustar 00 // 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/>. /** * Javascript module for displaying feedback in a modal window * * @module gradereport_grader/feedback_modal * @copyright 2023 Kevin Percy <kevin.percy@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import Modal from 'core/modal'; import Notification from 'core/notification'; import ajax from 'core/ajax'; import Templates from 'core/templates'; const Selectors = { showFeedback: '[data-action="feedback"]' }; /** * Create the modal to display the feedback. * * @param {int} courseid * @param {int} userid * @param {int} itemid * @returns {Promise} */ const getModal = async(courseid, userid, itemid) => { let feedbackData; try { feedbackData = await fetchFeedback(courseid, userid, itemid); } catch (e) { return Promise.reject(e); } return Modal.create({ removeOnClose: true, large: true, verticallyCentered: true, }) .then(modal => { const body = Templates.render('core_grades/feedback_modal', { feedbacktext: feedbackData.feedbacktext, user: { picture: feedbackData.picture, fullname: feedbackData.fullname, additionalfield: feedbackData.additionalfield, }, }); modal.setBody(body); modal.setTitle(feedbackData.title); modal.show(); return modal; }); }; /** * Fetch the feedback data. * * @param {int} courseid * @param {int} userid * @param {int} itemid * @returns {Promise} */ const fetchFeedback = (courseid, userid, itemid) => { const request = { methodname: 'core_grades_get_feedback', args: { courseid: courseid, userid: userid, itemid: itemid, }, }; return ajax.call([request])[0]; }; /** * Register event listeners for the View Feedback links. */ const registerEventListeners = () => { document.addEventListener('click', e => { const showFeedbackTrigger = e.target.closest(Selectors.showFeedback); if (showFeedbackTrigger) { e.preventDefault(); const courseid = showFeedbackTrigger.dataset.courseid; const userid = e.target.closest('tr').dataset.uid; const itemid = e.target.closest('td').dataset.itemid; getModal(courseid, userid, itemid) .catch(Notification.exception); } }); }; /** * Initialize module */ export const init = () => { registerEventListeners(); }; report/grader/amd/src/group.js 0000604 00000003562 15062070557 0012356 0 ustar 00 // 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/>. /** * Allow the user to search for groups within the grader report. * * @module gradereport_grader/group * @copyright 2023 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import GroupSearch from 'core_group/comboboxsearch/group'; import Url from 'core/url'; export default class Group extends GroupSearch { courseID; constructor() { super(); // Define our standard lookups. this.selectors = {...this.selectors, courseid: '[data-region="courseid"]', }; const component = document.querySelector(this.componentSelector()); this.courseID = component.querySelector(this.selectors.courseid).dataset.courseid; } static init() { return new Group(); } /** * Build up the view all link that is dedicated to a particular result. * * @param {Number} groupID The ID of the group selected. * @returns {string|*} */ selectOneLink(groupID) { return Url.relativeUrl('/grade/report/grader/index.php', { id: this.courseID, groupsearchvalue: this.getSearchTerm(), group: groupID, }, false); } } report/grader/amd/src/local/user/repository.js 0000604 00000002557 15062070557 0015514 0 ustar 00 // 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/>. /** * A repo for the search partial in the grader report. * * @module gradereport_grader/local/user/repository * @copyright 2022 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import ajax from 'core/ajax'; /** * Given a course ID, we want to fetch the learners within this report. * * @method userFetch * @param {int} courseid ID of the course to fetch the users of. * @return {object} jQuery promise */ export const userFetch = (courseid) => { const request = { methodname: 'gradereport_grader_get_users_in_report', args: { courseid: courseid, }, }; return ajax.call([request])[0]; }; report/grader/amd/src/collapse/repository.js 0000604 00000002551 15062070557 0015240 0 ustar 00 // 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/>. /** * A repo for the collapsing in the grader report. * * @module gradereport_grader/collapse/repository * @copyright 2022 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import ajax from 'core/ajax'; /** * Fetch all the information on gradeitems we'll need in the column collapser. * * @method gradeItems * @param {Number} courseid What course to fetch the gradeitems for * @return {object} jQuery promise */ export const gradeItems = (courseid) => { const request = { methodname: 'core_grades_get_gradeitems', args: { courseid: courseid, }, }; return ajax.call([request])[0]; }; report/grader/amd/src/user.js 0000604 00000004535 15062070557 0012201 0 ustar 00 // 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/>. /** * Allow the user to search for learners within the grader report. * * @module gradereport_grader/user * @copyright 2023 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import UserSearch from 'core_user/comboboxsearch/user'; import Url from 'core/url'; import * as Repository from 'gradereport_grader/local/user/repository'; // Define our standard lookups. const selectors = { component: '.user-search', courseid: '[data-region="courseid"]', }; const component = document.querySelector(selectors.component); const courseID = component.querySelector(selectors.courseid).dataset.courseid; export default class User extends UserSearch { constructor() { super(); } static init() { return new User(); } /** * Get the data we will be searching against in this component. * * @returns {Promise<*>} */ fetchDataset() { return Repository.userFetch(courseID).then((r) => r.users); } /** * Build up the view all link. * * @returns {string|*} */ selectAllResultsLink() { return Url.relativeUrl('/grade/report/grader/index.php', { id: courseID, searchvalue: this.getSearchTerm() }, false); } /** * Build up the view all link that is dedicated to a particular result. * * @param {Number} userID The ID of the user selected. * @returns {string|*} */ selectOneLink(userID) { return Url.relativeUrl('/grade/report/grader/index.php', { id: courseID, searchvalue: this.getSearchTerm(), userid: userID, }, false); } } report/grader/amd/src/stickycolspan.js 0000604 00000011077 15062070557 0014110 0 ustar 00 // 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/>. /** * Javascript module for fixing the position of sticky headers with multiple colspans * * @module gradereport_grader/stickycolspan * @copyright 2022 Bas Brands <bas@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import $ from 'jquery'; import {SELECTORS as stickyFooterSelectors, eventTypes as stickyFooterEvents} from 'core/sticky-footer'; const SELECTORS = { GRADEPARENT: '.gradeparent', STUDENTHEADER: '#studentheader', TABLEHEADER: 'th.header', BEHAT: 'body.behat-site', USERDROPDOWN: '.userrow th .dropdown', AVERAGEROWHEADER: '.lastrow th', }; /** * Initialize module */ export const init = () => { // The sticky positioning attributed to the user column cells affects the stacking context and makes the dropdowns // within these cells to be cut off. To solve this problem, whenever one of these action menus (dropdowns) is opened // we need to manually bump up the z-index value of the parent container element and revert once closed. $(SELECTORS.USERDROPDOWN).on('show.bs.dropdown hide.bs.dropdown', (e) => { // The closest heading element has sticky positioning which affects the stacking context in this case. e.target.closest(SELECTORS.TABLEHEADER).classList.toggle('actions-menu-active'); }); defineAverageRowIntersectionObserver(true); // Add an event listener to the sticky footer toggled event to re-define the average row intersection observer // accordingly. This is needed as on narrow screens when scrolling vertically the sticky footer is enabled and // disabled dynamically. document.addEventListener(stickyFooterEvents.stickyFooterStateChanged, (e) => { defineAverageRowIntersectionObserver(e.detail.enabled); }); if (!document.querySelector(SELECTORS.BEHAT)) { const grader = document.querySelector(SELECTORS.GRADEPARENT); const tableHeaders = grader.querySelectorAll(SELECTORS.TABLEHEADER); const studentHeader = grader.querySelector(SELECTORS.STUDENTHEADER); const leftOffset = getComputedStyle(studentHeader).getPropertyValue('left'); const rightOffset = getComputedStyle(studentHeader).getPropertyValue('right'); tableHeaders.forEach((tableHeader) => { if (tableHeader.colSpan > 1) { const addOffset = (tableHeader.offsetWidth - studentHeader.offsetWidth); if (window.right_to_left()) { tableHeader.style.right = 'calc(' + rightOffset + ' - ' + addOffset + 'px )'; } else { tableHeader.style.left = 'calc(' + leftOffset + ' - ' + addOffset + 'px )'; } } }); } }; /** * Define the intersection observer that will make sure that the average overall row is properly pinned. * * @param {boolean} stickyFooterEnabled Whether the page shows a sticky footer or not. */ const defineAverageRowIntersectionObserver = (stickyFooterEnabled) => { const stickyFooterHeight = stickyFooterEnabled ? document.querySelector(stickyFooterSelectors.STICKYFOOTER).offsetHeight : null; // Register an observer that will bump up the z-index value of the average overall row when it's pinned to prevent // the row being cut-off by the user column cells or other components within the report table that have higher // z-index values. If the page has a sticky footer, we need to make sure that the bottom root margin of the observer // subtracts the height of the sticky footer to prevent the row being cut-off by the footer. const intersectionObserver = new IntersectionObserver( ([e]) => e.target.closest('tr').classList.toggle('pinned', e.intersectionRatio < 1), { rootMargin: stickyFooterHeight ? `0px 0px -${stickyFooterHeight}px 0px` : "0px", threshold: [1] } ); intersectionObserver.observe(document.querySelector(SELECTORS.AVERAGEROWHEADER)); }; report/grader/amd/src/collapse.js 0000604 00000052036 15062070557 0013024 0 ustar 00 // 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/>. /** * Allow the user to show and hide columns of the report at will. * * @module gradereport_grader/collapse * @copyright 2023 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import * as Repository from 'gradereport_grader/collapse/repository'; import search_combobox from 'core/comboboxsearch/search_combobox'; import {renderForPromise, replaceNodeContents, replaceNode} from 'core/templates'; import {debounce} from 'core/utils'; import $ from 'jquery'; import {getStrings} from 'core/str'; import CustomEvents from "core/custom_interaction_events"; import storage from 'core/localstorage'; import {addIconToContainer} from 'core/loadingicon'; import Notification from 'core/notification'; import Pending from 'core/pending'; // Contain our selectors within this file until they could be of use elsewhere. const selectors = { component: '.collapse-columns', formDropdown: '.columnsdropdownform', formItems: { cancel: 'cancel', save: 'save', checked: 'input[type="checkbox"]:checked', currentlyUnchecked: 'input[type="checkbox"]:not([data-action="selectall"])', }, hider: 'hide', expand: 'expand', colVal: '[data-col]', itemVal: '[data-itemid]', content: '[data-collapse="content"]', sort: '[data-collapse="sort"]', expandbutton: '[data-collapse="expandbutton"]', rangerowcell: '[data-collapse="rangerowcell"]', avgrowcell: '[data-collapse="avgrowcell"]', menu: '[data-collapse="menu"]', icons: '.data-collapse_gradeicons', count: '[data-collapse="count"]', placeholder: '.collapsecolumndropdown [data-region="placeholder"]', fullDropdown: '.collapsecolumndropdown', }; const countIndicator = document.querySelector(selectors.count); export default class ColumnSearch extends search_combobox { userID = -1; courseID = null; defaultSort = ''; nodes = []; gradeStrings = null; userStrings = null; stringMap = []; static init(userID, courseID, defaultSort) { return new ColumnSearch(userID, courseID, defaultSort); } constructor(userID, courseID, defaultSort) { super(); this.userID = userID; this.courseID = courseID; this.defaultSort = defaultSort; this.component = document.querySelector(selectors.component); const pendingPromise = new Pending(); // Display a loader whilst collapsing appropriate columns (based on the locally stored state for the current user). addIconToContainer(document.querySelector('.gradeparent')).then((loader) => { setTimeout(() => { // Get the users' checked columns to change. this.getDataset().forEach((item) => { this.nodesUpdate(item); }); this.renderDefault(); // Once the grade categories have been re-collapsed, remove the loader and display the Gradebook setup content. loader.remove(); document.querySelector('.gradereport-grader-table').classList.remove('d-none'); }, 10); }).then(() => pendingPromise.resolve()).catch(Notification.exception); } /** * The overall div that contains the searching widget. * * @returns {string} */ componentSelector() { return '.collapse-columns'; } /** * The dropdown div that contains the searching widget result space. * * @returns {string} */ dropdownSelector() { return '.searchresultitemscontainer'; } /** * The triggering div that contains the searching widget. * * @returns {string} */ triggerSelector() { return '.collapsecolumn'; } /** * Return the dataset that we will be searching upon. * * @returns {Array} */ getDataset() { if (!this.dataset) { const cols = this.fetchDataset(); this.dataset = JSON.parse(cols) ? JSON.parse(cols).split(',') : []; } this.datasetSize = this.dataset.length; return this.dataset; } /** * Get the data we will be searching against in this component. * * @returns {string} */ fetchDataset() { return storage.get(`gradereport_grader_collapseditems_${this.courseID}_${this.userID}`); } /** * Given a user performs an action, update the users' preferences. */ setPreferences() { storage.set(`gradereport_grader_collapseditems_${this.courseID}_${this.userID}`, JSON.stringify(this.getDataset().join(',')) ); } /** * Register clickable event listeners. */ registerClickHandlers() { // Register click events within the component. this.component.addEventListener('click', this.clickHandler.bind(this)); document.addEventListener('click', this.docClickHandler.bind(this)); } /** * The handler for when a user interacts with the component. * * @param {MouseEvent} e The triggering event that we are working with. */ clickHandler(e) { super.clickHandler(e); // Prevent BS from closing the dropdown if they click elsewhere within the dropdown besides the form. if (e.target.closest(selectors.fullDropdown)) { e.stopPropagation(); } } /** * Externally defined click function to improve memory handling. * * @param {MouseEvent} e * @returns {Promise<void>} */ async docClickHandler(e) { if (e.target.dataset.hider === selectors.hider) { e.preventDefault(); const desiredToHide = e.target.closest(selectors.colVal) ? e.target.closest(selectors.colVal)?.dataset.col : e.target.closest(selectors.itemVal)?.dataset.itemid; const idx = this.getDataset().indexOf(desiredToHide); if (idx === -1) { this.getDataset().push(desiredToHide); } await this.prefcountpipe(); this.nodesUpdate(desiredToHide); } if (e.target.closest('button')?.dataset.hider === selectors.expand) { e.preventDefault(); const desiredToHide = e.target.closest(selectors.colVal) ? e.target.closest(selectors.colVal)?.dataset.col : e.target.closest(selectors.itemVal)?.dataset.itemid; const idx = this.getDataset().indexOf(desiredToHide); this.getDataset().splice(idx, 1); await this.prefcountpipe(); this.nodesUpdate(e.target.closest(selectors.colVal)?.dataset.col); this.nodesUpdate(e.target.closest(selectors.colVal)?.dataset.itemid); } } /** * The handler for when a user presses a key within the component. * * @param {KeyboardEvent} e The triggering event that we are working with. */ async keyHandler(e) { super.keyHandler(e); // Switch the key presses to handle keyboard nav. switch (e.key) { case 'Tab': if (e.target.closest(this.selectors.input)) { e.preventDefault(); this.clearSearchButton.focus({preventScroll: true}); } break; } } /** * Handle any keyboard inputs. */ registerInputEvents() { // Register & handle the text input. this.searchInput.addEventListener('input', debounce(async() => { this.setSearchTerms(this.searchInput.value); // We can also require a set amount of input before search. if (this.searchInput.value === '') { // Hide the "clear" search button in the search bar. this.clearSearchButton.classList.add('d-none'); } else { // Display the "clear" search button in the search bar. this.clearSearchButton.classList.remove('d-none'); } // User has given something for us to filter against. await this.filterrenderpipe(); }, 300)); } /** * Handle the form submission within the dropdown. */ registerFormEvents() { const form = this.component.querySelector(selectors.formDropdown); const events = [ 'click', CustomEvents.events.activate, CustomEvents.events.keyboardActivate ]; CustomEvents.define(document, events); const selectall = form.querySelector('[data-action="selectall"]'); // Register clicks & keyboard form handling. events.forEach((event) => { const submitBtn = form.querySelector(`[data-action="${selectors.formItems.save}"`); form.addEventListener(event, (e) => { // Stop Bootstrap from being clever. e.stopPropagation(); const input = e.target.closest('input'); if (input) { // If the user is unchecking an item, we need to uncheck the select all if it's checked. if (selectall.checked && !input.checked) { selectall.checked = false; } const checkedCount = Array.from(form.querySelectorAll(selectors.formItems.checked)).length; // Check if any are clicked or not then change disabled. submitBtn.disabled = checkedCount <= 0; } }, false); // Stop Bootstrap from being clever. this.searchInput.addEventListener(event, e => e.stopPropagation()); this.clearSearchButton.addEventListener(event, async(e) => { e.stopPropagation(); this.searchInput.value = ''; this.setSearchTerms(this.searchInput.value); await this.filterrenderpipe(); }); selectall.addEventListener(event, (e) => { // Stop Bootstrap from being clever. e.stopPropagation(); if (!selectall.checked) { const touncheck = Array.from(form.querySelectorAll(selectors.formItems.checked)); touncheck.forEach(item => { item.checked = false; }); submitBtn.disabled = true; } else { const currentUnchecked = Array.from(form.querySelectorAll(selectors.formItems.currentlyUnchecked)); currentUnchecked.forEach(item => { item.checked = true; }); submitBtn.disabled = false; } }); }); form.addEventListener('submit', async(e) => { e.preventDefault(); if (e.submitter.dataset.action === selectors.formItems.cancel) { $(this.component).dropdown('toggle'); return; } // Get the users' checked columns to change. const checkedItems = [...form.elements].filter(item => item.checked); checkedItems.forEach((item) => { const idx = this.getDataset().indexOf(item.dataset.collapse); this.getDataset().splice(idx, 1); this.nodesUpdate(item.dataset.collapse); }); // Reset the check all & submit to false just in case. selectall.checked = false; e.submitter.disabled = true; await this.prefcountpipe(); }); } nodesUpdate(item) { const colNodesToHide = [...document.querySelectorAll(`[data-col="${item}"]`)]; const itemIDNodesToHide = [...document.querySelectorAll(`[data-itemid="${item}"]`)]; this.nodes = [...colNodesToHide, ...itemIDNodesToHide]; this.updateDisplay(); } /** * Update the user preferences, count display then render the results. * * @returns {Promise<void>} */ async prefcountpipe() { this.setPreferences(); this.countUpdate(); await this.filterrenderpipe(); } /** * Dictate to the search component how and what we want to match upon. * * @param {Array} filterableData * @returns {Array} An array of objects containing the system reference and the user readable value. */ async filterDataset(filterableData) { const stringUserMap = await this.fetchRequiredUserStrings(); const stringGradeMap = await this.fetchRequiredGradeStrings(); // Custom user profile fields are not in our string map and need a bit of extra love. const customFieldMap = this.fetchCustomFieldValues(); this.stringMap = new Map([...stringGradeMap, ...stringUserMap, ...customFieldMap]); const searching = filterableData.map(s => { const mapObj = this.stringMap.get(s); if (mapObj === undefined) { return {key: s, string: s}; } return { key: s, string: mapObj.itemname ?? this.stringMap.get(s), category: mapObj.category ?? '', }; }); // Sometimes we just want to show everything. if (this.getPreppedSearchTerm() === '') { return searching; } // Other times we want to actually filter the content. return searching.filter((col) => { return col.string.toString().toLowerCase().includes(this.getPreppedSearchTerm()); }); } /** * Given we have a subset of the dataset, set the field that we matched upon to inform the end user. */ filterMatchDataset() { this.setMatchedResults( this.getMatchedResults().map((column) => { return { name: column.key, displayName: column.string ?? column.key, category: column.category ?? '', }; }) ); } /** * With an array of nodes, switch their classes and values. */ updateDisplay() { this.nodes.forEach((element) => { const content = element.querySelector(selectors.content); const sort = element.querySelector(selectors.sort); const expandButton = element.querySelector(selectors.expandbutton); const rangeRowCell = element.querySelector(selectors.rangerowcell); const avgRowCell = element.querySelector(selectors.avgrowcell); const nodeSet = [ element.querySelector(selectors.menu), element.querySelector(selectors.icons), content ]; // This can be further improved to reduce redundant similar calls. if (element.classList.contains('cell')) { // The column is actively being sorted, lets reset that and reload the page. if (sort !== null) { window.location = this.defaultSort; } if (content === null) { // If it's not a content cell, it must be an overall average or a range cell. const rowCell = avgRowCell ?? rangeRowCell; rowCell?.classList.toggle('d-none'); rowCell?.setAttribute('aria-hidden', rowCell?.classList.contains('d-none') ? 'true' : 'false'); } else if (content.classList.contains('d-none')) { // We should always have content but some cells do not contain menus or other actions. element.classList.remove('collapsed'); // If there are many nodes, apply the following. if (content.childNodes.length > 1) { content.classList.add('d-flex'); } nodeSet.forEach(node => { node?.classList.remove('d-none'); node?.setAttribute('aria-hidden', 'false'); }); expandButton?.classList.add('d-none'); expandButton?.setAttribute('aria-hidden', 'true'); } else { element.classList.add('collapsed'); content.classList.remove('d-flex'); nodeSet.forEach(node => { node?.classList.add('d-none'); node?.setAttribute('aria-hidden', 'true'); }); expandButton?.classList.remove('d-none'); expandButton?.setAttribute('aria-hidden', 'false'); } } }); } /** * Update the visual count of collapsed columns or hide the count all together. */ countUpdate() { countIndicator.textContent = this.getDatasetSize(); if (this.getDatasetSize() > 0) { this.component.parentElement.classList.add('d-flex'); this.component.parentElement.classList.remove('d-none'); } else { this.component.parentElement.classList.remove('d-flex'); this.component.parentElement.classList.add('d-none'); } } /** * Build the content then replace the node by default we want our form to exist. */ async renderDefault() { this.setMatchedResults(await this.filterDataset(this.getDataset())); this.filterMatchDataset(); // Update the collapsed button pill. this.countUpdate(); const {html, js} = await renderForPromise('gradereport_grader/collapse/collapsebody', { 'results': this.getMatchedResults(), 'userid': this.userID, }); replaceNode(selectors.placeholder, html, js); this.updateNodes(); // Given we now have the body, we can set up more triggers. this.registerFormEvents(); this.registerInputEvents(); // Add a small BS listener so that we can set the focus correctly on open. this.$component.on('shown.bs.dropdown', () => { this.searchInput.focus({preventScroll: true}); }); } /** * Build the content then replace the node. */ async renderDropdown() { const form = this.component.querySelector(selectors.formDropdown); const selectall = form.querySelector('[data-action="selectall"]'); const {html, js} = await renderForPromise('gradereport_grader/collapse/collapseresults', { 'results': this.getMatchedResults(), 'searchTerm': this.getSearchTerm(), }); selectall.disabled = this.getMatchedResults().length === 0; replaceNodeContents(this.getHTMLElements().searchDropdown, html, js); } /** * If we have any custom user profile fields, grab their system & readable names to add to our string map. * * @returns {array<string,*>} An array of associated string arrays ready for our map. */ fetchCustomFieldValues() { const customFields = document.querySelectorAll('[data-collapse-name]'); // Cast from NodeList to array to grab all the values. return [...customFields].map(field => [field.parentElement.dataset.col, field.dataset.collapseName]); } /** * Given the set of profile fields we can possibly search, fetch their strings, * so we can report to screen readers the field that matched. * * @returns {Promise<void>} */ fetchRequiredUserStrings() { if (!this.userStrings) { const requiredStrings = [ 'username', 'firstname', 'lastname', 'email', 'city', 'country', 'department', 'institution', 'idnumber', 'phone1', 'phone2', ]; this.userStrings = getStrings(requiredStrings.map((key) => ({key}))) .then((stringArray) => new Map( requiredStrings.map((key, index) => ([key, stringArray[index]])) )); } return this.userStrings; } /** * Given the set of gradable items we can possibly search, fetch their strings, * so we can report to screen readers the field that matched. * * @returns {Promise<void>} */ fetchRequiredGradeStrings() { if (!this.gradeStrings) { this.gradeStrings = Repository.gradeItems(this.courseID) .then((result) => new Map( result.gradeItems.map(key => ([key.id, key])) )); } return this.gradeStrings; } } report/grader/classes/output/action_bar.php 0000604 00000014021 15062070557 0015133 0 ustar 00 <?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/>. namespace gradereport_grader\output; use core\output\comboboxsearch; use core_grades\output\general_action_bar; use moodle_url; /** * Renderable class for the action bar elements in the grader report. * * @package gradereport_grader * @copyright 2022 Mihail Geshoski <mihail@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class action_bar extends \core_grades\output\action_bar { /** @var string $usersearch The content that the current user is looking for. */ protected string $usersearch = ''; /** * The class constructor. * * @param \context_course $context The context object. */ public function __construct(\context_course $context) { parent::__construct($context); $this->usersearch = optional_param('searchvalue', '', PARAM_NOTAGS); } /** * Returns the template for the action bar. * * @return string */ public function get_template(): string { return 'gradereport_grader/action_bar'; } /** * Export the data for the mustache template. * * @param \renderer_base $output renderer to be used to render the action bar elements. * @return array * @throws \moodle_exception */ public function export_for_template(\renderer_base $output): array { global $PAGE, $OUTPUT, $SESSION, $USER; // If in the course context, we should display the general navigation selector in gradebook. $courseid = $this->context->instanceid; // Get the data used to output the general navigation selector. $generalnavselector = new general_action_bar($this->context, new moodle_url('/grade/report/grader/index.php', ['id' => $courseid]), 'gradereport', 'grader'); $data = $generalnavselector->export_for_template($output); // If the user has the capability to view all grades, display the group selector (if applicable), the user selector // and the view mode selector (if applicable). if (has_capability('moodle/grade:viewall', $this->context)) { $course = get_course($courseid); $gradesrenderer = $PAGE->get_renderer('core_grades'); $initialscontent = $gradesrenderer->initials_selector( $course, $this->context, '/grade/report/grader/index.php' ); $initialselector = new comboboxsearch( false, $initialscontent->buttoncontent, $initialscontent->dropdowncontent, 'initials-selector', 'initialswidget', 'initialsdropdown', $initialscontent->buttonheader, ); $data['initialselector'] = $initialselector->export_for_template($output); $data['groupselector'] = $gradesrenderer->group_selector($course); $resetlink = new moodle_url('/grade/report/grader/index.php', ['id' => $courseid]); $searchinput = $OUTPUT->render_from_template('core_user/comboboxsearch/user_selector', [ 'currentvalue' => $this->usersearch, 'courseid' => $courseid, 'resetlink' => $resetlink->out(false), 'group' => 0, ]); $searchdropdown = new comboboxsearch( true, $searchinput, null, 'user-search dropdown d-flex', null, 'usersearchdropdown overflow-auto', null, false, ); $data['searchdropdown'] = $searchdropdown->export_for_template($output); // The collapsed column dialog is aligned to the edge of the screen, we need to place it such that it also aligns. $collapsemenudirection = right_to_left() ? 'dropdown-menu-left' : 'dropdown-menu-right'; $collapse = new comboboxsearch( true, get_string('collapsedcolumns', 'gradereport_grader', 0), null, 'collapse-columns', 'collapsecolumn', 'collapsecolumndropdown p-3 flex-column ' . $collapsemenudirection, null, true, ); $data['collapsedcolumns'] = [ 'classes' => 'd-none', 'content' => $collapse->export_for_template($output) ]; if ($course->groupmode == VISIBLEGROUPS || has_capability('moodle/site:accessallgroups', $this->context)) { $allowedgroups = groups_get_all_groups($course->id, 0, $course->defaultgroupingid); } else { $allowedgroups = groups_get_all_groups($course->id, $USER->id, $course->defaultgroupingid); } if (!empty($SESSION->gradereport["filterfirstname-{$this->context->id}"]) || !empty($SESSION->gradereport["filterlastname-{$this->context->id}"]) || groups_get_course_group($course, true, $allowedgroups) || $this->usersearch) { $reset = new moodle_url('/grade/report/grader/index.php', [ 'id' => $courseid, 'group' => 0, 'sifirst' => '', 'silast' => '' ]); $data['pagereset'] = $reset->out(false); } } return $data; } } report/grader/classes/event/grade_report_viewed.php 0000604 00000002714 15062070557 0016641 0 ustar 00 <?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/>. /** * Grader report viewed event. * * @package gradereport_grader * @copyright 2014 Adrian Greeve <adrian@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_grader\event; defined('MOODLE_INTERNAL') || die(); /** * Grader report viewed event class. * * @package gradereport_grader * @since Moodle 2.8 * @copyright 2014 Adrian Greeve <adrian@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class grade_report_viewed extends \core\event\grade_report_viewed { /** * Returns localised general event name. * * @return string */ public static function get_name() { return get_string('eventgradereportviewed', 'gradereport_grader'); } } report/grader/classes/privacy/provider.php 0000604 00000020205 15062070557 0015002 0 ustar 00 <?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/>. /** * Privacy Subsystem implementation for gradereport_grader. * * @package gradereport_grader * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_grader\privacy; defined('MOODLE_INTERNAL') || die(); use \core_privacy\local\metadata\collection; use \core_privacy\local\request\transform; use \core_privacy\local\request\writer; require_once $CFG->libdir.'/grade/constants.php'; /** * Privacy Subsystem for gradereport_grader implementing null_provider. * * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class provider implements \core_privacy\local\metadata\provider, \core_privacy\local\request\user_preference_provider { /** * Returns meta data about this system. * * @param collection $itemcollection The initialised item collection to add items to. * @return collection A listing of user data stored through this system. */ public static function get_metadata(collection $items) : collection { // There are several user preferences (shared between different courses). // Show/hide toggles preferences. $items->add_user_preference('grade_report_showaverages', 'privacy:metadata:preference:grade_report_showaverages'); $items->add_user_preference('grade_report_showuserimage', 'privacy:metadata:preference:grade_report_showuserimage'); $items->add_user_preference('grade_report_showranges', 'privacy:metadata:preference:grade_report_showranges'); // Special rows preferences. $items->add_user_preference('grade_report_rangesdisplaytype', 'privacy:metadata:preference:grade_report_rangesdisplaytype'); $items->add_user_preference('grade_report_rangesdecimalpoints', 'privacy:metadata:preference:grade_report_rangesdecimalpoints'); $items->add_user_preference('grade_report_averagesdisplaytype', 'privacy:metadata:preference:grade_report_averagesdisplaytype'); $items->add_user_preference('grade_report_averagesdecimalpoints', 'privacy:metadata:preference:grade_report_averagesdecimalpoints'); $items->add_user_preference('grade_report_meanselection', 'privacy:metadata:preference:grade_report_meanselection'); $items->add_user_preference('grade_report_shownumberofgrades', 'privacy:metadata:preference:grade_report_shownumberofgrades'); // General preferences. $items->add_user_preference('grade_report_quickgrading', 'privacy:metadata:preference:grade_report_quickgrading'); $items->add_user_preference('grade_report_studentsperpage', 'privacy:metadata:preference:grade_report_studentsperpage'); $items->add_user_preference('grade_report_showonlyactiveenrol', 'privacy:metadata:preference:grade_report_showonlyactiveenrol'); $items->add_user_preference('grade_report_aggregationposition', 'privacy:metadata:preference:grade_report_aggregationposition'); // There is also one user preference which can be defined on each course. $items->add_user_preference('grade_report_grader_collapsed_categories', 'privacy:metadata:preference:grade_report_grader_collapsed_categories'); return $items; } /** * Store all user preferences for the plugin. * * @param int $userid The userid of the user whose data is to be exported. */ public static function export_user_preferences(int $userid) { $preferences = get_user_preferences(null, null, $userid); foreach ($preferences as $name => $value) { $prefname = null; $prefdescription = null; $transformedvalue = null; switch ($name) { case 'grade_report_showaverages': case 'grade_report_showuserimage': case 'grade_report_showranges': case 'grade_report_shownumberofgrades': case 'grade_report_quickgrading': case 'grade_report_showonlyactiveenrol': case 'grade_report_meanselection': $prefname = $name; switch ($value) { case GRADE_REPORT_MEAN_ALL: $transformedvalue = get_string('meanall', 'grades'); break; case GRADE_REPORT_MEAN_GRADED: $transformedvalue = get_string('meangraded', 'grades'); break; } break; case 'grade_report_rangesdecimalpoints': case 'grade_report_averagesdecimalpoints': case 'grade_report_studentsperpage': $prefname = $name; $transformedvalue = $value; break; case 'grade_report_rangesdisplaytype': case 'grade_report_averagesdisplaytype': $prefname = $name; switch ($value) { case GRADE_REPORT_PREFERENCE_INHERIT: $transformedvalue = get_string('inherit', 'grades'); break; case GRADE_DISPLAY_TYPE_REAL: $transformedvalue = get_string('real', 'grades'); break; case GRADE_DISPLAY_TYPE_PERCENTAGE: $transformedvalue = get_string('percentage', 'grades'); break; case GRADE_DISPLAY_TYPE_LETTER: $transformedvalue = get_string('letter', 'grades'); break; } break; case 'grade_report_aggregationposition': $prefname = $name; switch ($value) { case GRADE_REPORT_AGGREGATION_POSITION_FIRST: $transformedvalue = get_string('positionfirst', 'grades'); break; case GRADE_REPORT_AGGREGATION_POSITION_LAST: $transformedvalue = get_string('positionlast', 'grades'); break; } break; default: if (strpos($name, 'grade_report_grader_collapsed_categories') === 0) { $prefname = 'grade_report_grader_collapsed_categories'; $courseid = substr($name, strlen('grade_report_grader_collapsed_categories')); $transformedvalue = $value; $course = get_course($courseid); $prefdescription = get_string( 'privacy:request:preference:'.$prefname, 'gradereport_grader', (object) [ 'name' => $course->fullname, ] ); } } if ($prefname !== null) { if ($prefdescription == null) { $prefdescription = get_string('privacy:metadata:preference:'.$prefname, 'gradereport_grader'); } writer::export_user_preference( 'gradereport_grader', $prefname, $transformedvalue, $prefdescription ); } } } } report/grader/classes/external/get_users_in_report.php 0000604 00000007740 15062070557 0017407 0 ustar 00 <?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/>. namespace gradereport_grader\external; use context_course; use core_user_external; use core_external\external_api; use core_external\external_function_parameters; use core_external\external_multiple_structure; use core_external\external_single_structure; use core_external\external_value; use core_external\external_warnings; use grade_report_grader; use user_picture; defined('MOODLE_INTERNAL') || die; require_once($CFG->dirroot.'/course/externallib.php'); require_once($CFG->dirroot .'/user/externallib.php'); require_once($CFG->dirroot.'/grade/lib.php'); require_once($CFG->dirroot.'/grade/report/grader/lib.php'); /** * External grade report grader API * * @package gradereport_grader * @copyright 2022 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class get_users_in_report extends external_api { /** * Describes the parameters for get_users_in_report * * @return external_function_parameters */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters ( [ 'courseid' => new external_value(PARAM_INT, 'Course ID', VALUE_REQUIRED) ] ); } /** * Given a course ID find Fetch the grader report and add some fields to the returned users. * * @param int $courseid Course ID to fetch the grader report for. * @return array Users and warnings to pass back to the calling widget. */ public static function execute(int $courseid): array { global $PAGE; self::validate_parameters( self::execute_parameters(), [ 'courseid' => $courseid, ] ); $warnings = []; $context = context_course::instance($courseid); self::validate_context($context); require_capability('gradereport/grader:view', $context); // Return tracking object. $gpr = new \grade_plugin_return( [ 'type' => 'report', 'plugin' => 'grader', 'courseid' => $courseid ] ); $report = new grade_report_grader($courseid, $gpr, $context); // For the returned users, Add a couple of extra fields that we need for the search module. $users = array_map(function ($user) use ($PAGE) { $user->fullname = fullname($user); $userpicture = new user_picture($user); $userpicture->size = 1; $user->profileimageurl = $userpicture->get_url($PAGE)->out(false); $userpicture->size = 0; // Size f2. $user->profileimageurlsmall = $userpicture->get_url($PAGE)->out(false); return $user; }, $report->load_users(true)); sort($users); return [ 'users' => $users, 'warnings' => $warnings, ]; } /** * Returns description of what the users & warnings should return. * * @return external_single_structure */ public static function execute_returns(): external_single_structure { return new external_single_structure([ 'users' => new external_multiple_structure(core_user_external::user_description()), 'warnings' => new external_warnings(), ]); } } report/grader/lib.php 0000604 00000264216 15062070557 0010620 0 ustar 00 <?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/>. /** * Definition of the grader report class * * @package gradereport_grader * @copyright 2007 Nicolas Connault * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once($CFG->dirroot . '/grade/report/lib.php'); require_once($CFG->libdir.'/tablelib.php'); /** * Class providing an API for the grader report building and displaying. * @uses grade_report * @copyright 2007 Nicolas Connault * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class grade_report_grader extends grade_report { /** * The final grades. * @var array $grades */ public $grades; /** * Contains all the grades for the course - even the ones not displayed in the grade tree. * * @var array $allgrades */ private $allgrades; /** * Contains all grade items expect GRADE_TYPE_NONE. * * @var array $allgradeitems */ private $allgradeitems; /** * Array of errors for bulk grades updating. * @var array $gradeserror */ public $gradeserror = array(); // SQL-RELATED /** * The id of the grade_item by which this report will be sorted. * @var int $sortitemid */ public $sortitemid; /** * Sortorder used in the SQL selections. * @var int $sortorder */ public $sortorder; /** * An SQL fragment affecting the search for users. * @var string $userselect */ public $userselect; /** * The bound params for $userselect * @var array $userselectparams */ public $userselectparams = array(); /** * List of collapsed categories from user preference * @var array $collapsed */ public $collapsed; /** * A count of the rows, used for css classes. * @var int $rowcount */ public $rowcount = 0; /** * Capability check caching * @var boolean $canviewhidden */ public $canviewhidden; /** @var int Maximum number of students that can be shown on one page */ public const MAX_STUDENTS_PER_PAGE = 5000; /** @var int[] List of available options on the pagination dropdown */ public const PAGINATION_OPTIONS = [20, 100]; /** * Allow category grade overriding * @var bool $overridecat */ protected $overridecat; /** @var array of objects, or empty array if no records were found. */ protected $users = []; /** * Constructor. Sets local copies of user preferences and initialises grade_tree. * @param int $courseid * @param object $gpr grade plugin return tracking object * @param string $context * @param int $page The current page being viewed (when report is paged) * @param int $sortitemid The id of the grade_item by which to sort the table * @param string $sort Sorting direction */ public function __construct($courseid, $gpr, $context, $page=null, $sortitemid=null, string $sort = '') { global $CFG; parent::__construct($courseid, $gpr, $context, $page); $this->canviewhidden = has_capability('moodle/grade:viewhidden', context_course::instance($this->course->id)); // load collapsed settings for this report $this->collapsed = static::get_collapsed_preferences($this->course->id); if (empty($CFG->enableoutcomes)) { $nooutcomes = false; } else { $nooutcomes = get_user_preferences('grade_report_shownooutcomes'); } // if user report preference set or site report setting set use it, otherwise use course or site setting $switch = $this->get_pref('aggregationposition'); if ($switch == '') { $switch = grade_get_setting($this->courseid, 'aggregationposition', $CFG->grade_aggregationposition); } // Grab the grade_tree for this course $this->gtree = new grade_tree($this->courseid, true, $switch, $this->collapsed, $nooutcomes); $this->sortitemid = $sortitemid; // base url for sorting by first/last name $this->baseurl = new moodle_url('index.php', array('id' => $this->courseid)); $studentsperpage = $this->get_students_per_page(); if (!empty($this->page) && !empty($studentsperpage)) { $this->baseurl->params(array('perpage' => $studentsperpage, 'page' => $this->page)); } $this->pbarurl = new moodle_url('/grade/report/grader/index.php', array('id' => $this->courseid)); $this->setup_groups(); $this->setup_users(); $this->setup_sortitemid($sort); $this->overridecat = (bool)get_config('moodle', 'grade_overridecat'); } /** * Processes the data sent by the form (grades). * Caller is responsible for all access control checks * @param array $data form submission (with magic quotes) * @return array empty array if success, array of warnings if something fails. */ public function process_data($data) { global $DB; $warnings = array(); $separategroups = false; $mygroups = array(); if ($this->groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $this->context)) { $separategroups = true; $mygroups = groups_get_user_groups($this->course->id); $mygroups = $mygroups[0]; // ignore groupings // reorder the groups fro better perf below $current = array_search($this->currentgroup, $mygroups); if ($current !== false) { unset($mygroups[$current]); array_unshift($mygroups, $this->currentgroup); } } $viewfullnames = has_capability('moodle/site:viewfullnames', $this->context); // always initialize all arrays $queue = array(); $this->load_users(); $this->load_final_grades(); // Were any changes made? $changedgrades = false; $timepageload = clean_param($data->timepageload, PARAM_INT); foreach ($data as $varname => $students) { $needsupdate = false; // Skip, not a grade. if (strpos($varname, 'grade') === 0) { $datatype = 'grade'; } else { continue; } foreach ($students as $userid => $items) { $userid = clean_param($userid, PARAM_INT); foreach ($items as $itemid => $postedvalue) { $itemid = clean_param($itemid, PARAM_INT); // Was change requested? $oldvalue = $this->grades[$userid][$itemid]; if ($datatype === 'grade') { // If there was no grade and there still isn't if (is_null($oldvalue->finalgrade) && $postedvalue == -1) { // -1 means no grade continue; } // If the grade item uses a custom scale if (!empty($oldvalue->grade_item->scaleid)) { if ((int)$oldvalue->finalgrade === (int)$postedvalue) { continue; } } else { // The grade item uses a numeric scale // Format the finalgrade from the DB so that it matches the grade from the client if ($postedvalue === format_float($oldvalue->finalgrade, $oldvalue->grade_item->get_decimals())) { continue; } } $changedgrades = true; } if (!$gradeitem = grade_item::fetch(array('id'=>$itemid, 'courseid'=>$this->courseid))) { throw new \moodle_exception('invalidgradeitemid'); } // Pre-process grade if ($datatype == 'grade') { if ($gradeitem->gradetype == GRADE_TYPE_SCALE) { if ($postedvalue == -1) { // -1 means no grade $finalgrade = null; } else { $finalgrade = $postedvalue; } } else { $finalgrade = unformat_float($postedvalue); } $errorstr = ''; $skip = false; $dategraded = $oldvalue->get_dategraded(); if (!empty($dategraded) && $timepageload < $dategraded) { // Warn if the grade was updated while we were editing this form. $errorstr = 'gradewasmodifiedduringediting'; $skip = true; } else if (!is_null($finalgrade)) { // Warn if the grade is out of bounds. $bounded = $gradeitem->bounded_grade($finalgrade); if ($bounded > $finalgrade) { $errorstr = 'lessthanmin'; } else if ($bounded < $finalgrade) { $errorstr = 'morethanmax'; } } if ($errorstr) { $userfieldsapi = \core_user\fields::for_name(); $userfields = 'id, ' . $userfieldsapi->get_sql('', false, '', '', false)->selects; $user = $DB->get_record('user', array('id' => $userid), $userfields); $gradestr = new stdClass(); $gradestr->username = fullname($user, $viewfullnames); $gradestr->itemname = $gradeitem->get_name(); $warnings[] = get_string($errorstr, 'grades', $gradestr); if ($skip) { // Skipping the update of this grade it failed the tests above. continue; } } } // group access control if ($separategroups) { // note: we can not use $this->currentgroup because it would fail badly // when having two browser windows each with different group $sharinggroup = false; foreach ($mygroups as $groupid) { if (groups_is_member($groupid, $userid)) { $sharinggroup = true; break; } } if (!$sharinggroup) { // either group membership changed or somebody is hacking grades of other group $warnings[] = get_string('errorsavegrade', 'grades'); continue; } } $gradeitem->update_final_grade($userid, $finalgrade, 'gradebook', false, FORMAT_MOODLE, null, null, true); } } } if ($changedgrades) { // If a final grade was overriden reload grades so dependent grades like course total will be correct $this->grades = null; } return $warnings; } /** * Setting the sort order, this depends on last state * all this should be in the new table class that we might need to use * for displaying grades. * @param string $sort sorting direction */ private function setup_sortitemid(string $sort = '') { global $SESSION; if (!isset($SESSION->gradeuserreport)) { $SESSION->gradeuserreport = new stdClass(); } if ($this->sortitemid) { if (!isset($SESSION->gradeuserreport->sort)) { $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC'; } else if (!$sort) { // this is the first sort, i.e. by last name if (!isset($SESSION->gradeuserreport->sortitemid)) { $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC'; } else if ($SESSION->gradeuserreport->sortitemid == $this->sortitemid) { // same as last sort if ($SESSION->gradeuserreport->sort == 'ASC') { $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC'; } else { $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC'; } } else { $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC'; } } $SESSION->gradeuserreport->sortitemid = $this->sortitemid; } else { // not requesting sort, use last setting (for paging) if (isset($SESSION->gradeuserreport->sortitemid)) { $this->sortitemid = $SESSION->gradeuserreport->sortitemid; } else { $this->sortitemid = 'lastname'; } if (isset($SESSION->gradeuserreport->sort)) { $this->sortorder = $SESSION->gradeuserreport->sort; } else { $this->sortorder = 'ASC'; } } // If explicit sorting direction exists. if ($sort) { $this->sortorder = $sort; $SESSION->gradeuserreport->sort = $sort; } } /** * pulls out the userids of the users to be display, and sorts them * * @param bool $allusers If we are getting the users within the report, we want them all irrespective of paging. */ public function load_users(bool $allusers = false) { global $CFG, $DB; if (!empty($this->users)) { return; } $this->setup_users(); // Limit to users with a gradeable role. list($gradebookrolessql, $gradebookrolesparams) = $DB->get_in_or_equal(explode(',', $this->gradebookroles), SQL_PARAMS_NAMED, 'grbr0'); // Check the status of showing only active enrolments. $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); // Limit to users with an active enrollment. list($enrolledsql, $enrolledparams) = get_enrolled_sql($this->context, '', 0, $showonlyactiveenrol); // Fields we need from the user table. $userfieldsapi = \core_user\fields::for_identity($this->context)->with_userpic(); $userfieldssql = $userfieldsapi->get_sql('u', true, '', '', false); // 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'); // If the user has clicked one of the sort asc/desc arrows. if (is_numeric($this->sortitemid)) { $params = array_merge(array('gitemid' => $this->sortitemid), $gradebookrolesparams, $this->userwheresql_params, $this->groupwheresql_params, $enrolledparams, $relatedctxparams); $sortjoin = "LEFT JOIN {grade_grades} g ON g.userid = u.id AND g.itemid = $this->sortitemid"; if ($this->sortorder == 'ASC') { $sort = $DB->sql_order_by_null('g.finalgrade'); } else { $sort = $DB->sql_order_by_null('g.finalgrade', SORT_DESC); } $sort .= ", u.idnumber, u.lastname, u.firstname, u.email"; } else { $sortjoin = ''; // The default sort will be that provided by the site for users, unless a valid user field is requested, // the value of which takes precedence. [$sort] = users_order_by_sql('u', null, $this->context, $userfieldssql->mappings); if (array_key_exists($this->sortitemid, $userfieldssql->mappings)) { // Ensure user sort field doesn't duplicate one of the default sort fields. $usersortfield = $userfieldssql->mappings[$this->sortitemid]; $defaultsortfields = array_diff(explode(', ', $sort), [$usersortfield]); $sort = "{$usersortfield} {$this->sortorder}, " . implode(', ', $defaultsortfields); } $params = array_merge($gradebookrolesparams, $this->userwheresql_params, $this->groupwheresql_params, $enrolledparams, $relatedctxparams); } $params = array_merge($userfieldssql->params, $params); $sql = "SELECT {$userfieldssql->selects} FROM {user} u {$userfieldssql->joins} JOIN ($enrolledsql) je ON je.id = u.id $this->groupsql $sortjoin JOIN ( SELECT DISTINCT ra.userid FROM {role_assignments} ra WHERE ra.roleid IN ($this->gradebookroles) AND ra.contextid $relatedctxsql ) rainner ON rainner.userid = u.id AND u.deleted = 0 $this->userwheresql $this->groupwheresql ORDER BY $sort"; // We never work with unlimited result. Limit the number of records by MAX_STUDENTS_PER_PAGE if no other limit is specified. $studentsperpage = ($this->get_students_per_page() && !$allusers) ? $this->get_students_per_page() : static::MAX_STUDENTS_PER_PAGE; $this->users = $DB->get_records_sql($sql, $params, $studentsperpage * $this->page, $studentsperpage); if (empty($this->users)) { $this->userselect = ''; $this->users = array(); $this->userselectparams = array(); } else { list($usql, $uparams) = $DB->get_in_or_equal(array_keys($this->users), SQL_PARAMS_NAMED, 'usid0'); $this->userselect = "AND g.userid $usql"; $this->userselectparams = $uparams; // First flag everyone as not suspended. foreach ($this->users as $user) { $this->users[$user->id]->suspendedenrolment = false; } // If we want to mix both suspended and not suspended users, let's find out who is suspended. if (!$showonlyactiveenrol) { $sql = "SELECT ue.userid FROM {user_enrolments} ue JOIN {enrol} e ON e.id = ue.enrolid WHERE ue.userid $usql AND ue.status = :uestatus AND e.status = :estatus AND e.courseid = :courseid AND ue.timestart < :now1 AND (ue.timeend = 0 OR ue.timeend > :now2) GROUP BY ue.userid"; $time = time(); $params = array_merge($uparams, array('estatus' => ENROL_INSTANCE_ENABLED, 'uestatus' => ENROL_USER_ACTIVE, 'courseid' => $coursecontext->instanceid, 'now1' => $time, 'now2' => $time)); $useractiveenrolments = $DB->get_records_sql($sql, $params); foreach ($this->users as $user) { $this->users[$user->id]->suspendedenrolment = !array_key_exists($user->id, $useractiveenrolments); } } } return $this->users; } /** * Load all grade items. */ protected function get_allgradeitems() { if (!empty($this->allgradeitems)) { return $this->allgradeitems; } $allgradeitems = grade_item::fetch_all(array('courseid' => $this->courseid)); // But hang on - don't include ones which are set to not show the grade at all. $this->allgradeitems = array_filter($allgradeitems, function($item) { return $item->gradetype != GRADE_TYPE_NONE; }); return $this->allgradeitems; } /** * we supply the userids in this query, and get all the grades * pulls out all the grades, this does not need to worry about paging */ public function load_final_grades() { global $CFG, $DB; if (!empty($this->grades)) { return; } if (empty($this->users)) { return; } // please note that we must fetch all grade_grades fields if we want to construct grade_grade object from it! $params = array_merge(array('courseid'=>$this->courseid), $this->userselectparams); $sql = "SELECT g.* FROM {grade_items} gi, {grade_grades} g WHERE g.itemid = gi.id AND gi.courseid = :courseid {$this->userselect}"; $userids = array_keys($this->users); $allgradeitems = $this->get_allgradeitems(); if ($grades = $DB->get_records_sql($sql, $params)) { foreach ($grades as $graderec) { $grade = new grade_grade($graderec, false); if (!empty($allgradeitems[$graderec->itemid])) { // Note: Filter out grades which have a grade type of GRADE_TYPE_NONE. // Only grades without this type are present in $allgradeitems. $this->allgrades[$graderec->userid][$graderec->itemid] = $grade; } if (in_array($graderec->userid, $userids) and array_key_exists($graderec->itemid, $this->gtree->get_items())) { // some items may not be present!! $this->grades[$graderec->userid][$graderec->itemid] = $grade; $this->grades[$graderec->userid][$graderec->itemid]->grade_item = $this->gtree->get_item($graderec->itemid); // db caching } } } // prefil grades that do not exist yet foreach ($userids as $userid) { foreach ($this->gtree->get_items() as $itemid => $unused) { if (!isset($this->grades[$userid][$itemid])) { $this->grades[$userid][$itemid] = new grade_grade(); $this->grades[$userid][$itemid]->itemid = $itemid; $this->grades[$userid][$itemid]->userid = $userid; $this->grades[$userid][$itemid]->grade_item = $this->gtree->get_item($itemid); // db caching $this->allgrades[$userid][$itemid] = $this->grades[$userid][$itemid]; } } } // Pre fill grades for any remaining items which might be collapsed. foreach ($userids as $userid) { foreach ($allgradeitems as $itemid => $gradeitem) { if (!isset($this->allgrades[$userid][$itemid])) { $this->allgrades[$userid][$itemid] = new grade_grade(); $this->allgrades[$userid][$itemid]->itemid = $itemid; $this->allgrades[$userid][$itemid]->userid = $userid; $this->allgrades[$userid][$itemid]->grade_item = $gradeitem; } } } } /** * Gets html toggle * @deprecated since Moodle 2.4 as it appears not to be used any more. */ public function get_toggles_html() { throw new coding_exception('get_toggles_html() can not be used any more'); } /** * Prints html toggle * @deprecated since 2.4 as it appears not to be used any more. * @param unknown $type */ public function print_toggle($type) { throw new coding_exception('print_toggle() can not be used any more'); } /** * Builds and returns the rows that will make up the left part of the grader report * This consists of student names and icons, links to user reports and id numbers, as well * as header cells for these columns. It also includes the fillers required for the * categories displayed on the right side of the report. * @param boolean $displayaverages whether to display average rows in the table * @return array Array of html_table_row objects */ public function get_left_rows($displayaverages) { global $CFG, $OUTPUT; // Course context to determine how the user details should be displayed. $coursecontext = context_course::instance($this->courseid); $rows = []; $showuserimage = $this->get_pref('showuserimage'); $viewfullnames = has_capability('moodle/site:viewfullnames', $this->context); $extrafields = \core_user\fields::get_identity_fields($this->context); $arrows = $this->get_sort_arrows($extrafields); $colspan = 1 + count($extrafields); $levels = count($this->gtree->levels) - 1; $fillercell = new html_table_cell(); $fillercell->header = true; $fillercell->attributes['scope'] = 'col'; $fillercell->attributes['class'] = 'cell topleft'; $fillercell->text = html_writer::span(get_string('participants'), 'accesshide'); $fillercell->colspan = $colspan; $fillercell->rowspan = $levels; $row = new html_table_row(array($fillercell)); $rows[] = $row; for ($i = 1; $i < $levels; $i++) { $row = new html_table_row(); $rows[] = $row; } $headerrow = new html_table_row(); $headerrow->attributes['class'] = 'heading'; $studentheader = new html_table_cell(); // The browser's scrollbar may partly cover (in certain operative systems) the content in the student header // when horizontally scrolling through the table contents (most noticeable when in RTL mode). // Therefore, add slight padding on the left or right when using RTL mode. $studentheader->attributes['class'] = "header pl-3"; $studentheader->scope = 'col'; $studentheader->header = true; $studentheader->id = 'studentheader'; $element = ['type' => 'userfield', 'name' => 'fullname']; $studentheader->text = $arrows['studentname'] . $this->gtree->get_cell_action_menu($element, 'gradeitem', $this->gpr, $this->baseurl); $headerrow->cells[] = $studentheader; foreach ($extrafields as $field) { $fieldheader = new html_table_cell(); $fieldheader->attributes['class'] = 'userfield user' . $field; $fieldheader->attributes['data-col'] = $field; $fieldheader->scope = 'col'; $fieldheader->header = true; $collapsecontext = ['field' => $field, 'name' => $field]; $collapsedicon = $OUTPUT->render_from_template('gradereport_grader/collapse/icon', $collapsecontext); // Need to wrap the button into a div with our hooking element for user items, gradeitems already have this. $collapsedicon = html_writer::div($collapsedicon, 'd-none', ['data-collapse' => 'expandbutton']); $element = ['type' => 'userfield', 'name' => $field]; $fieldheader->text = $arrows[$field] . $this->gtree->get_cell_action_menu($element, 'gradeitem', $this->gpr, $this->baseurl) . $collapsedicon; $headerrow->cells[] = $fieldheader; } $rows[] = $headerrow; $suspendedstring = null; $usercount = 0; foreach ($this->users as $userid => $user) { $userrow = new html_table_row(); $userrow->id = 'fixed_user_'.$userid; $userrow->attributes['class'] = ($usercount % 2) ? 'userrow even' : 'userrow odd'; $usercell = new html_table_cell(); $usercell->attributes['class'] = ($usercount % 2) ? 'header user even' : 'header user odd'; $usercount++; $usercell->header = true; $usercell->scope = 'row'; if ($showuserimage) { $usercell->text = $OUTPUT->render(\core_user::get_profile_picture($user, $coursecontext, [ 'link' => false, 'visibletoscreenreaders' => false ])); } $fullname = fullname($user, $viewfullnames); $usercell->text = html_writer::link( \core_user::get_profile_url($user, $coursecontext), $usercell->text . $fullname, ['class' => 'username'] ); if (!empty($user->suspendedenrolment)) { $usercell->attributes['class'] .= ' usersuspended'; //may be lots of suspended users so only get the string once if (empty($suspendedstring)) { $suspendedstring = get_string('userenrolmentsuspended', 'grades'); } $icon = $OUTPUT->pix_icon('i/enrolmentsuspended', $suspendedstring); $usercell->text .= html_writer::tag('span', $icon, array('class'=>'usersuspendedicon')); } // The browser's scrollbar may partly cover (in certain operative systems) the content in the user cells // when horizontally scrolling through the table contents (most noticeable when in RTL mode). // Therefore, add slight padding on the left or right when using RTL mode. $usercell->attributes['class'] .= ' pl-3'; $usercell->text .= $this->gtree->get_cell_action_menu(['userid' => $userid], 'user', $this->gpr); $userrow->cells[] = $usercell; foreach ($extrafields as $field) { $fieldcell = new html_table_cell(); $fieldcell->attributes['class'] = 'userfield user' . $field; $fieldcell->attributes['data-col'] = $field; $fieldcell->header = false; $fieldcell->text = html_writer::tag('div', s($user->{$field}), [ 'data-collapse' => 'content' ]); $userrow->cells[] = $fieldcell; } $userrow->attributes['data-uid'] = $userid; $rows[] = $userrow; } $rows = $this->get_left_range_row($rows, $colspan); if ($displayaverages) { $rows = $this->get_left_avg_row($rows, $colspan, true); $rows = $this->get_left_avg_row($rows, $colspan); } return $rows; } /** * Builds and returns the rows that will make up the right part of the grader report * @param boolean $displayaverages whether to display average rows in the table * @return array Array of html_table_row objects */ public function get_right_rows(bool $displayaverages) : array { global $CFG, $USER, $OUTPUT, $DB, $PAGE; $rows = []; $this->rowcount = 0; $numusers = count($this->users); $gradetabindex = 1; $strgrade = get_string('gradenoun'); $this->get_sort_arrows(); // Get preferences once. $quickgrading = $this->get_pref('quickgrading'); // Get strings which are re-used inside the loop. $strftimedatetimeshort = get_string('strftimedatetimeshort'); $strerror = get_string('error'); $stroverridengrade = get_string('overridden', 'grades'); $strfail = get_string('fail', 'grades'); $strpass = get_string('pass', 'grades'); $viewfullnames = has_capability('moodle/site:viewfullnames', $this->context); // Preload scale objects for items with a scaleid and initialize tab indices. $scaleslist = []; $tabindices = []; foreach ($this->gtree->get_items() as $itemid => $item) { if (!empty($item->scaleid)) { $scaleslist[] = $item->scaleid; } $tabindices[$item->id]['grade'] = $gradetabindex; $gradetabindex += $numusers * 2; } $cache = \cache::make_from_params(\cache_store::MODE_REQUEST, 'gradereport_grader', 'scales'); $scalesarray = $cache->get(get_class($this)); if (!$scalesarray) { $scalesarray = $DB->get_records_list('scale', 'id', $scaleslist); // Save to cache. $cache->set(get_class($this), $scalesarray); } foreach ($this->gtree->get_levels() as $row) { $headingrow = new html_table_row(); $headingrow->attributes['class'] = 'heading_name_row'; foreach ($row as $element) { $sortlink = clone($this->baseurl); if (isset($element['object']->id)) { $sortlink->param('sortitemid', $element['object']->id); } $type = $element['type']; if (!empty($element['colspan'])) { $colspan = $element['colspan']; } else { $colspan = 1; } if (!empty($element['depth'])) { $catlevel = 'catlevel'.$element['depth']; } else { $catlevel = ''; } // Element is a filler. if ($type == 'filler' || $type == 'fillerfirst' || $type == 'fillerlast') { $fillercell = new html_table_cell(); $fillercell->attributes['class'] = $type . ' ' . $catlevel; $fillercell->colspan = $colspan; $fillercell->text = ' '; // This is a filler cell; don't use a <th>, it'll confuse screen readers. $fillercell->header = false; $headingrow->cells[] = $fillercell; } else if ($type == 'category') { // Make sure the grade category has a grade total or at least has child grade items. if (grade_tree::can_output_item($element)) { // Element is a category. $categorycell = new html_table_cell(); $categorycell->attributes['class'] = 'category ' . $catlevel; $categorycell->colspan = $colspan; $categorycell->header = true; $categorycell->scope = 'col'; $statusicons = $this->gtree->set_grade_status_icons($element); if ($statusicons) { $categorycell->attributes['class'] .= ' statusicons'; } $context = new stdClass(); $context->courseheader = $this->get_course_header($element); $context->actionmenu = $this->gtree->get_cell_action_menu($element, 'gradeitem', $this->gpr); $context->statusicons = $statusicons; $categorycell->text = $OUTPUT->render_from_template('gradereport_grader/categorycell', $context); $headingrow->cells[] = $categorycell; } } else { // Element is a grade_item. $arrow = ''; if ($element['object']->id == $this->sortitemid) { if ($this->sortorder == 'ASC') { $arrow = $this->get_sort_arrow('down', $sortlink); } else { $arrow = $this->get_sort_arrow('up', $sortlink); } } $collapsecontext = [ 'field' => $element['object']->id, 'name' => $element['object']->get_name(), ]; $collapsedicon = ''; // We do not want grade category total items to be hidden away as it is controlled by something else. if (!$element['object']->is_aggregate_item()) { $collapsedicon = $OUTPUT->render_from_template('gradereport_grader/collapse/icon', $collapsecontext); } $headerlink = $this->gtree->get_element_header($element, true, true, false, false, true, $sortlink); $itemcell = new html_table_cell(); $itemcell->attributes['class'] = $type . ' ' . $catlevel . ' highlightable'. ' i'. $element['object']->id; $itemcell->attributes['data-itemid'] = $element['object']->id; $singleview = $this->gtree->get_cell_action_menu($element, 'gradeitem', $this->gpr, $this->baseurl); $statusicons = $this->gtree->set_grade_status_icons($element); if ($statusicons) { $itemcell->attributes['class'] .= ' statusicons'; } $itemcell->attributes['class'] .= $this->get_cell_display_class($element['object']); $itemcell->colspan = $colspan; $itemcell->header = true; $itemcell->scope = 'col'; $context = new stdClass(); $context->headerlink = $headerlink; $context->arrow = $arrow; $context->singleview = $singleview; $context->statusicons = $statusicons; $context->collapsedicon = $collapsedicon; $itemcell->text = $OUTPUT->render_from_template('gradereport_grader/headercell', $context); $headingrow->cells[] = $itemcell; } } $rows[] = $headingrow; } // Get all the grade items if the user can not view hidden grade items. // It is possible that the user is simply viewing the 'Course total' by switching to the 'Aggregates only' view // and that this user does not have the ability to view hidden items. In this case we still need to pass all the // grade items (in case one has been hidden) as the course total shown needs to be adjusted for this particular // user. if (!$this->canviewhidden) { $allgradeitems = $this->get_allgradeitems(); } foreach ($this->users as $userid => $user) { if ($this->canviewhidden) { $altered = []; $unknown = []; } else { $usergrades = $this->allgrades[$userid]; $hidingaffected = grade_grade::get_hiding_affected($usergrades, $allgradeitems); $altered = $hidingaffected['altered']; $unknown = $hidingaffected['unknowngrades']; unset($hidingaffected); } $itemrow = new html_table_row(); $itemrow->id = 'user_'.$userid; $fullname = fullname($user, $viewfullnames); foreach ($this->gtree->items as $itemid => $unused) { $item =& $this->gtree->items[$itemid]; $grade = $this->grades[$userid][$item->id]; $itemcell = new html_table_cell(); $itemcell->id = 'u' . $userid . 'i' . $itemid; $itemcell->attributes['data-itemid'] = $itemid; $itemcell->attributes['class'] = 'gradecell'; // Get the decimal points preference for this item. $decimalpoints = $item->get_decimals(); if (array_key_exists($itemid, $unknown)) { $gradeval = null; } else if (array_key_exists($itemid, $altered)) { $gradeval = $altered[$itemid]; } else { $gradeval = $grade->finalgrade; } $context = new stdClass(); // MDL-11274: Hide grades in the grader report if the current grader // doesn't have 'moodle/grade:viewhidden'. if (!$this->canviewhidden && $grade->is_hidden()) { if (!empty($CFG->grade_hiddenasdate) && $grade->get_datesubmitted() && !$item->is_category_item() && !$item->is_course_item()) { // 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. $context->text = userdate($grade->get_datesubmitted(), $strftimedatetimeshort); $context->extraclasses = 'datesubmitted'; } else { $context->text = '-'; } $itemcell->text = $OUTPUT->render_from_template('gradereport_grader/cell', $context); $itemrow->cells[] = $itemcell; continue; } // Emulate grade element. $eid = $this->gtree->get_grade_eid($grade); $element = ['eid' => $eid, 'object' => $grade, 'type' => 'grade']; $itemcell->attributes['class'] .= ' grade i' . $itemid; if ($item->is_category_item()) { $itemcell->attributes['class'] .= ' cat'; } if ($item->is_course_item()) { $itemcell->attributes['class'] .= ' course'; } if ($grade->is_overridden()) { $itemcell->attributes['class'] .= ' overridden'; $itemcell->attributes['aria-label'] = $stroverridengrade; } $hidden = ''; if ($grade->is_hidden()) { $hidden = ' dimmed_text '; } $gradepass = ' gradefail '; $context->gradepassicon = $OUTPUT->pix_icon('i/invalid', $strfail); if ($grade->is_passed($item)) { $gradepass = ' gradepass '; $context->gradepassicon = $OUTPUT->pix_icon('i/valid', $strpass); } else if (is_null($grade->is_passed($item))) { $gradepass = ''; $context->gradepassicon = ''; } $context->statusicons = $this->gtree->set_grade_status_icons($element); // If in editing mode, we need to print either a text box or a drop down (for scales) // grades in item of type grade category or course are not directly editable. if ($item->needsupdate) { $context->text = $strerror; $context->extraclasses = 'gradingerror'; } else if (!empty($USER->editing)) { if ($item->scaleid && !empty($scalesarray[$item->scaleid])) { $itemcell->attributes['class'] .= ' grade_type_scale'; } else if ($item->gradetype == GRADE_TYPE_VALUE) { $itemcell->attributes['class'] .= ' grade_type_value'; } else if ($item->gradetype == GRADE_TYPE_TEXT) { $itemcell->attributes['class'] .= ' grade_type_text'; } if ($grade->is_locked()) { $itemcell->attributes['class'] .= ' locked'; } if ($item->scaleid && !empty($scalesarray[$item->scaleid])) { $context->scale = true; $scale = $scalesarray[$item->scaleid]; $gradeval = (int)$gradeval; // Scales use only integers. $scales = explode(",", $scale->scale); // Reindex because scale is off 1. // MDL-12104 some previous scales might have taken up part of the array // so this needs to be reset. $scaleopt = []; $i = 0; foreach ($scales as $scaleoption) { $i++; $scaleopt[$i] = $scaleoption; } if ($quickgrading && $grade->is_editable()) { $context->iseditable = true; if (empty($item->outcomeid)) { $nogradestr = get_string('nograde'); } else { $nogradestr = get_string('nooutcome', 'grades'); } $attributes = [ 'tabindex' => $tabindices[$item->id]['grade'], 'id' => 'grade_' . $userid . '_' . $item->id ]; $gradelabel = $fullname . ' ' . $item->get_name(true); if ($context->statusicons) { $attributes['class'] = 'statusicons'; } $context->label = html_writer::label( get_string('useractivitygrade', 'gradereport_grader', $gradelabel), $attributes['id'], false, ['class' => 'accesshide']); $context->select = html_writer::select($scaleopt, 'grade['.$userid.']['.$item->id.']', $gradeval, [-1 => $nogradestr], $attributes); } else if (!empty($scale)) { $scales = explode(",", $scale->scale); $context->extraclasses = 'gradevalue' . $hidden . $gradepass; // Invalid grade if gradeval < 1. if ($gradeval < 1) { $context->text = '-'; } else { // Just in case somebody changes scale. $gradeval = $grade->grade_item->bounded_grade($gradeval); $context->text = $scales[$gradeval - 1]; } } } else if ($item->gradetype != GRADE_TYPE_TEXT) { // Value type. if ($quickgrading and $grade->is_editable()) { $context->iseditable = true; $value = format_float($gradeval, $decimalpoints); $gradelabel = $fullname . ' ' . $item->get_name(true); $context->id = 'grade_' . $userid . '_' . $item->id; $context->name = 'grade[' . $userid . '][' . $item->id .']'; $context->value = $value; $context->label = get_string('useractivitygrade', 'gradereport_grader', $gradelabel); $context->title = $strgrade; $context->tabindex = $tabindices[$item->id]['grade']; $context->extraclasses = 'form-control'; if ($context->statusicons) { $context->extraclasses .= ' statusicons'; } } else { $context->extraclasses = 'gradevalue' . $hidden . $gradepass; $context->text = format_float($gradeval, $decimalpoints); } } } else { // Not editing. $gradedisplaytype = $item->get_displaytype(); // Letter grades, scales and text grades are left aligned. $textgrade = false; $textgrades = [GRADE_DISPLAY_TYPE_LETTER, GRADE_DISPLAY_TYPE_REAL_LETTER, GRADE_DISPLAY_TYPE_LETTER_REAL, GRADE_DISPLAY_TYPE_LETTER_PERCENTAGE, GRADE_DISPLAY_TYPE_PERCENTAGE_LETTER]; if (in_array($gradedisplaytype, $textgrades)) { $textgrade = true; } if ($textgrade || ($item->gradetype == GRADE_TYPE_TEXT)) { $itemcell->attributes['class'] .= ' grade_type_text'; } else if ($item->scaleid && !empty($scalesarray[$item->scaleid])) { if ($gradedisplaytype == GRADE_DISPLAY_TYPE_PERCENTAGE) { $itemcell->attributes['class'] .= ' grade_type_value'; } else { $itemcell->attributes['class'] .= ' grade_type_scale'; } } else { $itemcell->attributes['class'] .= ' grade_type_value'; } if ($item->needsupdate) { $context->text = $strerror; $context->extraclasses = 'gradingerror' . $hidden . $gradepass; } else { // The max and min for an aggregation may be different to the grade_item. if (!is_null($gradeval)) { $item->grademax = $grade->get_grade_max(); $item->grademin = $grade->get_grade_min(); } $context->extraclasses = 'gradevalue ' . $hidden . $gradepass; $context->text = grade_format_gradevalue($gradeval, $item, true, $gradedisplaytype, null); } } if ($item->gradetype == GRADE_TYPE_TEXT && !empty($grade->feedback)) { $context->text = html_writer::span(shorten_text(strip_tags($grade->feedback), 20), '', ['data-action' => 'feedback', 'role' => 'button', 'data-courseid' => $this->courseid]); } if (!$item->needsupdate && !($item->gradetype == GRADE_TYPE_TEXT && empty($USER->editing))) { $context->actionmenu = $this->gtree->get_cell_action_menu($element, 'gradeitem', $this->gpr); } $itemcell->text = $OUTPUT->render_from_template('gradereport_grader/cell', $context); if (!empty($this->gradeserror[$item->id][$userid])) { $itemcell->text .= $this->gradeserror[$item->id][$userid]; } $itemrow->cells[] = $itemcell; } $rows[] = $itemrow; } if (!empty($USER->editing)) { $PAGE->requires->js_call_amd('core_form/changechecker', 'watchFormById', ['gradereport_grader']); } $rows = $this->get_right_range_row($rows); if ($displayaverages) { $rows = $this->get_right_avg_row($rows, true); $rows = $this->get_right_avg_row($rows); } return $rows; } /** * Depending on the style of report (fixedstudents vs traditional one-table), * arranges the rows of data in one or two tables, and returns the output of * these tables in HTML * @param boolean $displayaverages whether to display average rows in the table * @return string HTML */ public function get_grade_table($displayaverages = false) { global $OUTPUT; $leftrows = $this->get_left_rows($displayaverages); $rightrows = $this->get_right_rows($displayaverages); $html = ''; $fulltable = new html_table(); $fulltable->attributes['class'] = 'gradereport-grader-table d-none'; $fulltable->id = 'user-grades'; $fulltable->caption = get_string('summarygrader', 'gradereport_grader'); $fulltable->captionhide = true; // We don't want the table to be enclosed within in a .table-responsive div as it is heavily customised. $fulltable->responsive = false; // Extract rows from each side (left and right) and collate them into one row each foreach ($leftrows as $key => $row) { $row->cells = array_merge($row->cells, $rightrows[$key]->cells); $fulltable->data[] = $row; } $html .= html_writer::table($fulltable); return $OUTPUT->container($html, 'gradeparent'); } /** * Builds and return the row of icons for the left side of the report. * It only has one cell that says "Controls" * @param array $rows The Array of rows for the left part of the report * @param int $colspan The number of columns this cell has to span * @return array Array of rows for the left part of the report * @deprecated since Moodle 4.2 - The row is not shown anymore - we have actions menu. * @todo MDL-77307 This will be deleted in Moodle 4.6. */ public function get_left_icons_row($rows=array(), $colspan=1) { global $USER; debugging('The function get_left_icons_row() is deprecated, please do not use it anymore.', DEBUG_DEVELOPER); if (!empty($USER->editing)) { $controlsrow = new html_table_row(); $controlsrow->attributes['class'] = 'controls'; $controlscell = new html_table_cell(); $controlscell->attributes['class'] = 'header controls'; $controlscell->header = true; $controlscell->colspan = $colspan; $controlscell->text = get_string('controls', 'grades'); $controlsrow->cells[] = $controlscell; $rows[] = $controlsrow; } return $rows; } /** * Builds and return the header for the row of ranges, for the left part of the grader report. * @param array $rows The Array of rows for the left part of the report * @param int $colspan The number of columns this cell has to span * @return array Array of rows for the left part of the report */ public function get_left_range_row($rows=array(), $colspan=1) { global $CFG, $USER; if ($this->get_pref('showranges')) { $rangerow = new html_table_row(); $rangerow->attributes['class'] = 'range r'.$this->rowcount++; $rangecell = new html_table_cell(); $rangecell->attributes['class'] = 'header range'; $rangecell->colspan = $colspan; $rangecell->header = true; $rangecell->scope = 'row'; $rangecell->text = get_string('range', 'grades'); $rangerow->cells[] = $rangecell; $rows[] = $rangerow; } return $rows; } /** * Builds and return the headers for the rows of averages, for the left part of the grader report. * @param array $rows The Array of rows for the left part of the report * @param int $colspan The number of columns this cell has to span * @param bool $groupavg If true, returns the row for group averages, otherwise for overall averages * @return array Array of rows for the left part of the report */ public function get_left_avg_row($rows=array(), $colspan=1, $groupavg=false) { if (!$this->canviewhidden) { // totals might be affected by hiding, if user can not see hidden grades the aggregations might be altered // better not show them at all if user can not see all hideen grades return $rows; } $showaverages = $this->get_pref('showaverages'); $showaveragesgroup = $this->currentgroup && $showaverages; $straveragegroup = get_string('groupavg', 'grades'); if ($groupavg) { if ($showaveragesgroup) { $groupavgrow = new html_table_row(); $groupavgrow->attributes['class'] = 'groupavg r'.$this->rowcount++; $groupavgcell = new html_table_cell(); $groupavgcell->attributes['class'] = 'header range'; $groupavgcell->colspan = $colspan; $groupavgcell->header = true; $groupavgcell->scope = 'row'; $groupavgcell->text = $straveragegroup; $groupavgrow->cells[] = $groupavgcell; $rows[] = $groupavgrow; } } else { $straverage = get_string('overallaverage', 'grades'); if ($showaverages) { $avgrow = new html_table_row(); $avgrow->attributes['class'] = 'avg r'.$this->rowcount++; $avgcell = new html_table_cell(); $avgcell->attributes['class'] = 'header range'; $avgcell->colspan = $colspan; $avgcell->header = true; $avgcell->scope = 'row'; $avgcell->text = $straverage; $avgrow->cells[] = $avgcell; $rows[] = $avgrow; } } return $rows; } /** * Builds and return the row of icons when editing is on, for the right part of the grader report. * @param array $rows The Array of rows for the right part of the report * @return array Array of rows for the right part of the report * @deprecated since Moodle 4.2 - The row is not shown anymore - we have actions menu. * @todo MDL-77307 This will be deleted in Moodle 4.6. */ public function get_right_icons_row($rows=array()) { global $USER; debugging('The function get_right_icons_row() is deprecated, please do not use it anymore.', DEBUG_DEVELOPER); if (!empty($USER->editing)) { $iconsrow = new html_table_row(); $iconsrow->attributes['class'] = 'controls'; foreach ($this->gtree->items as $itemid => $unused) { // emulate grade element $item = $this->gtree->get_item($itemid); $eid = $this->gtree->get_item_eid($item); $element = $this->gtree->locate_element($eid); $itemcell = new html_table_cell(); $itemcell->attributes['class'] = 'controls icons i'.$itemid; $itemcell->text = $this->get_icons($element); $iconsrow->cells[] = $itemcell; } $rows[] = $iconsrow; } return $rows; } /** * Builds and return the row of ranges for the right part of the grader report. * @param array $rows The Array of rows for the right part of the report * @return array Array of rows for the right part of the report */ public function get_right_range_row($rows=array()) { if ($this->get_pref('showranges')) { $rangesdisplaytype = $this->get_pref('rangesdisplaytype'); $rangesdecimalpoints = $this->get_pref('rangesdecimalpoints'); $rangerow = new html_table_row(); $rangerow->attributes['class'] = 'heading range'; foreach ($this->gtree->items as $itemid => $unused) { $item =& $this->gtree->items[$itemid]; $itemcell = new html_table_cell(); $itemcell->attributes['class'] .= ' range i'. $itemid; $itemcell->attributes['class'] .= $this->get_cell_display_class($item); $hidden = ''; if ($item->is_hidden()) { $hidden = ' dimmed_text '; } $formattedrange = $item->get_formatted_range($rangesdisplaytype, $rangesdecimalpoints); $itemcell->attributes['data-itemid'] = $itemid; $itemcell->text = html_writer::div($formattedrange, 'rangevalues' . $hidden, ['data-collapse' => 'rangerowcell']); $rangerow->cells[] = $itemcell; } $rows[] = $rangerow; } return $rows; } /** * Builds and return the row of averages for the right part of the grader report. * @param array $rows Whether to return only group averages or all averages. * @param bool $grouponly Whether to return only group averages or all averages. * @return array Array of rows for the right part of the report */ public function get_right_avg_row($rows=array(), $grouponly=false) { global $USER, $DB, $OUTPUT, $CFG; if (!$this->canviewhidden) { // Totals might be affected by hiding, if user can not see hidden grades the aggregations might be altered // better not show them at all if user can not see all hidden grades. return $rows; } $averagesdisplaytype = $this->get_pref('averagesdisplaytype'); $averagesdecimalpoints = $this->get_pref('averagesdecimalpoints'); $meanselection = $this->get_pref('meanselection'); $shownumberofgrades = $this->get_pref('shownumberofgrades'); if ($grouponly) { $showaverages = $this->currentgroup && $this->get_pref('showaverages'); $groupsql = $this->groupsql; $groupwheresql = $this->groupwheresql; $groupwheresqlparams = $this->groupwheresql_params; } else { $showaverages = $this->get_pref('showaverages'); $groupsql = ""; $groupwheresql = ""; $groupwheresqlparams = array(); } if ($showaverages) { $totalcount = $this->get_numusers($grouponly); // Limit to users with a gradeable role. list($gradebookrolessql, $gradebookrolesparams) = $DB->get_in_or_equal(explode(',', $this->gradebookroles), SQL_PARAMS_NAMED, 'grbr0'); // Limit to users with an active enrollment. $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); list($enrolledsql, $enrolledparams) = get_enrolled_sql($this->context, '', 0, $showonlyactiveenrol); // 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'); $params = array_merge(array('courseid' => $this->courseid), $gradebookrolesparams, $enrolledparams, $groupwheresqlparams, $relatedctxparams); // Find sums of all grade items in course. $sql = "SELECT g.itemid, SUM(g.finalgrade) AS sum FROM {grade_items} gi JOIN {grade_grades} g ON g.itemid = gi.id JOIN {user} u ON u.id = g.userid 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 $groupsql WHERE gi.courseid = :courseid AND u.deleted = 0 AND g.finalgrade IS NOT NULL $groupwheresql GROUP BY g.itemid"; $sumarray = array(); if ($sums = $DB->get_records_sql($sql, $params)) { foreach ($sums as $itemid => $csum) { $sumarray[$itemid] = $csum->sum; } } // MDL-10875 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) $sql = "SELECT gi.id, COUNT(DISTINCT u.id) AS count FROM {grade_items} gi CROSS JOIN ($enrolledsql) u JOIN {role_assignments} ra ON ra.userid = u.id LEFT OUTER JOIN {grade_grades} g ON (g.itemid = gi.id AND g.userid = u.id AND g.finalgrade IS NOT NULL) $groupsql WHERE gi.courseid = :courseid AND ra.roleid $gradebookrolessql AND ra.contextid $relatedctxsql AND g.id IS NULL $groupwheresql GROUP BY gi.id"; $ungradedcounts = $DB->get_records_sql($sql, $params); $avgrow = new html_table_row(); $avgrow->attributes['class'] = 'avg'; foreach ($this->gtree->items as $itemid => $unused) { $item =& $this->gtree->items[$itemid]; if ($item->needsupdate) { $avgcell = new html_table_cell(); $avgcell->attributes['class'] = 'i'. $itemid; $avgcell->text = $OUTPUT->container(get_string('error'), 'gradingerror'); $avgrow->cells[] = $avgcell; continue; } if (!isset($sumarray[$item->id])) { $sumarray[$item->id] = 0; } if (empty($ungradedcounts[$itemid])) { $ungradedcount = 0; } else { $ungradedcount = $ungradedcounts[$itemid]->count; } if ($meanselection == GRADE_REPORT_MEAN_GRADED) { $meancount = $totalcount - $ungradedcount; } else { // Bump up the sum by the number of ungraded items * grademin $sumarray[$item->id] += $ungradedcount * $item->grademin; $meancount = $totalcount; } // Determine which display type to use for this average if (!empty($USER->editing)) { $displaytype = GRADE_DISPLAY_TYPE_REAL; } else if ($averagesdisplaytype == GRADE_REPORT_PREFERENCE_INHERIT) { // no ==0 here, please resave the report and user preferences $displaytype = $item->get_displaytype(); } else { $displaytype = $averagesdisplaytype; } // Override grade_item setting if a display preference (not inherit) was set for the averages if ($averagesdecimalpoints == GRADE_REPORT_PREFERENCE_INHERIT) { $decimalpoints = $item->get_decimals(); } else { $decimalpoints = $averagesdecimalpoints; } $gradetypeclass = $this->get_cell_display_class($item); if (!isset($sumarray[$item->id]) || $meancount == 0) { $avgcell = new html_table_cell(); $avgcell->attributes['class'] = $gradetypeclass . ' i'. $itemid; $avgcell->attributes['data-itemid'] = $itemid; $avgcell->text = html_writer::div('-', '', ['data-collapse' => 'avgrowcell']); $avgrow->cells[] = $avgcell; } else { $sum = $sumarray[$item->id]; $avgradeval = $sum/$meancount; $gradehtml = grade_format_gradevalue($avgradeval, $item, true, $displaytype, $decimalpoints); $numberofgrades = ''; if ($shownumberofgrades) { $numberofgrades = " ($meancount)"; } $avgcell = new html_table_cell(); $avgcell->attributes['class'] = $gradetypeclass . ' i'. $itemid; $avgcell->attributes['data-itemid'] = $itemid; $avgcell->text = html_writer::div($gradehtml.$numberofgrades, '', ['data-collapse' => 'avgrowcell']); $avgrow->cells[] = $avgcell; } } $rows[] = $avgrow; } return $rows; } /** * Given element category, create a collapsible icon and * course header. * * @param array $element * @return string HTML */ protected function get_course_header($element) { if (in_array($element['object']->id, $this->collapsed['aggregatesonly'])) { $showing = get_string('showingaggregatesonly', 'grades'); } else if (in_array($element['object']->id, $this->collapsed['gradesonly'])) { $showing = get_string('showinggradesonly', 'grades'); } else { $showing = get_string('showingfullmode', 'grades'); } $name = $element['object']->get_name(); $nameunescaped = $element['object']->get_name(false); $describedbyid = uniqid(); $courseheader = html_writer::tag('span', $name, [ 'title' => $nameunescaped, 'class' => 'gradeitemheader', 'aria-describedby' => $describedbyid ]); $courseheader .= html_writer::div($showing, 'sr-only', [ 'id' => $describedbyid ]); return $courseheader; } /** * Given a grade_category, grade_item or grade_grade, this function * figures out the state of the object and builds then returns a div * with the icons needed for the grader report. * * @param array $element * @return string HTML * @deprecated since Moodle 4.2 - The row is not shown anymore - we have actions menu. * @todo MDL-77307 This will be deleted in Moodle 4.6. */ protected function get_icons($element) { global $CFG, $USER, $OUTPUT; debugging('The function get_icons() is deprecated, please do not use it anymore.', DEBUG_DEVELOPER); if (empty($USER->editing)) { return '<div class="grade_icons" />'; } // Init all icons $editicon = ''; $editable = true; if ($element['type'] == 'grade') { $item = $element['object']->grade_item; if ($item->is_course_item() or $item->is_category_item()) { $editable = $this->overridecat; } } if ($element['type'] != 'categoryitem' && $element['type'] != 'courseitem' && $editable) { $editicon = $this->gtree->get_edit_icon($element, $this->gpr); } $editcalculationicon = ''; $showhideicon = ''; $lockunlockicon = ''; if (has_capability('moodle/grade:manage', $this->context)) { $editcalculationicon = $this->gtree->get_calculation_icon($element, $this->gpr); $showhideicon = $this->gtree->get_hiding_icon($element, $this->gpr); $lockunlockicon = $this->gtree->get_locking_icon($element, $this->gpr); } $gradeanalysisicon = ''; if ($element['type'] == 'grade') { $gradeanalysisicon .= $this->gtree->get_grade_analysis_icon($element['object']); } return $OUTPUT->container($editicon.$editcalculationicon.$showhideicon.$lockunlockicon.$gradeanalysisicon, 'grade_icons'); } /** * Given a category element returns collapsing +/- icon if available * * @deprecated since Moodle 2.9 MDL-46662 - please do not use this function any more. */ protected function get_collapsing_icon($element) { throw new coding_exception('get_collapsing_icon() can not be used any more, please use get_course_header() instead.'); } /** * Processes a single action against a category, grade_item or grade. * @param string $target eid ({type}{id}, e.g. c4 for category4) * @param string $action Which action to take (edit, delete etc...) * @return */ public function process_action($target, $action) { return self::do_process_action($target, $action, $this->course->id); } /** * From the list of categories that this user prefers to collapse choose ones that belong to the current course. * * This function serves two purposes. * Mainly it helps migrating from user preference style when all courses were stored in one preference. * Also it helps to remove the settings for categories that were removed if the array for one course grows too big. * * @param int $courseid * @param array $collapsed * @return array */ protected static function filter_collapsed_categories($courseid, $collapsed) { global $DB; // Ensure we always have an element for aggregatesonly and another for gradesonly, no matter it's empty. $collapsed['aggregatesonly'] = $collapsed['aggregatesonly'] ?? []; $collapsed['gradesonly'] = $collapsed['gradesonly'] ?? []; if (empty($collapsed['aggregatesonly']) && empty($collapsed['gradesonly'])) { return $collapsed; } $cats = $DB->get_fieldset_select('grade_categories', 'id', 'courseid = ?', array($courseid)); $collapsed['aggregatesonly'] = array_values(array_intersect($collapsed['aggregatesonly'], $cats)); $collapsed['gradesonly'] = array_values(array_intersect($collapsed['gradesonly'], $cats)); return $collapsed; } /** * Returns the list of categories that this user wants to collapse or display aggregatesonly * * This method also migrates on request from the old format of storing user preferences when they were stored * in one preference for all courses causing DB error when trying to insert very big value. * * @param int $courseid * @return array */ protected static function get_collapsed_preferences($courseid) { if ($collapsed = get_user_preferences('grade_report_grader_collapsed_categories'.$courseid)) { $collapsed = json_decode($collapsed, true); // Ensure we always have an element for aggregatesonly and another for gradesonly, no matter it's empty. $collapsed['aggregatesonly'] = $collapsed['aggregatesonly'] ?? []; $collapsed['gradesonly'] = $collapsed['gradesonly'] ?? []; return $collapsed; } // Try looking for old location of user setting that used to store all courses in one serialized user preference. $collapsed = ['aggregatesonly' => [], 'gradesonly' => []]; // Use this if old settings are not found. $collapsedall = []; $oldprefexists = false; if (($oldcollapsedpref = get_user_preferences('grade_report_grader_collapsed_categories')) !== null) { $oldprefexists = true; if ($collapsedall = unserialize_array($oldcollapsedpref)) { // Ensure we always have an element for aggregatesonly and another for gradesonly, no matter it's empty. $collapsedall['aggregatesonly'] = $collapsedall['aggregatesonly'] ?? []; $collapsedall['gradesonly'] = $collapsedall['gradesonly'] ?? []; // We found the old-style preference, filter out only categories that belong to this course and update the prefs. $collapsed = static::filter_collapsed_categories($courseid, $collapsedall); if (!empty($collapsed['aggregatesonly']) || !empty($collapsed['gradesonly'])) { static::set_collapsed_preferences($courseid, $collapsed); $collapsedall['aggregatesonly'] = array_diff($collapsedall['aggregatesonly'], $collapsed['aggregatesonly']); $collapsedall['gradesonly'] = array_diff($collapsedall['gradesonly'], $collapsed['gradesonly']); if (!empty($collapsedall['aggregatesonly']) || !empty($collapsedall['gradesonly'])) { set_user_preference('grade_report_grader_collapsed_categories', serialize($collapsedall)); } } } } // Arrived here, if the old pref exists and it doesn't contain // more information, it means that the migration of all the // data to new, by course, preferences is completed, so // the old one can be safely deleted. if ($oldprefexists && empty($collapsedall['aggregatesonly']) && empty($collapsedall['gradesonly'])) { unset_user_preference('grade_report_grader_collapsed_categories'); } return $collapsed; } /** * Sets the list of categories that user wants to see collapsed in user preferences * * This method may filter or even trim the list if it does not fit in DB field. * * @param int $courseid * @param array $collapsed */ protected static function set_collapsed_preferences($courseid, $collapsed) { global $DB; // In an unlikely case that the list of collapsed categories for one course is too big for the user preference size, // try to filter the list of categories since array may contain categories that were deleted. if (strlen(json_encode($collapsed)) >= 1333) { $collapsed = static::filter_collapsed_categories($courseid, $collapsed); } // If this did not help, "forget" about some of the collapsed categories. Still better than to loose all information. while (strlen(json_encode($collapsed)) >= 1333) { if (count($collapsed['aggregatesonly'])) { array_pop($collapsed['aggregatesonly']); } if (count($collapsed['gradesonly'])) { array_pop($collapsed['gradesonly']); } } if (!empty($collapsed['aggregatesonly']) || !empty($collapsed['gradesonly'])) { set_user_preference('grade_report_grader_collapsed_categories'.$courseid, json_encode($collapsed)); } else { unset_user_preference('grade_report_grader_collapsed_categories'.$courseid); } } /** * Processes a single action against a category, grade_item or grade. * @param string $target eid ({type}{id}, e.g. c4 for category4) * @param string $action Which action to take (edit, delete etc...) * @param int $courseid affected course. * @return */ public static function do_process_action($target, $action, $courseid = null) { global $DB; // TODO: this code should be in some grade_tree static method $targettype = substr($target, 0, 2); $targetid = substr($target, 2); // TODO: end if ($targettype !== 'cg') { // The following code only works with categories. return true; } if (!$courseid) { debugging('Function grade_report_grader::do_process_action() now requires additional argument courseid', DEBUG_DEVELOPER); if (!$courseid = $DB->get_field('grade_categories', 'courseid', array('id' => $targetid), IGNORE_MISSING)) { return true; } } $collapsed = static::get_collapsed_preferences($courseid); switch ($action) { case 'switch_minus': // Add category to array of aggregatesonly $key = array_search($targetid, $collapsed['gradesonly']); if ($key !== false) { unset($collapsed['gradesonly'][$key]); } if (!in_array($targetid, $collapsed['aggregatesonly'])) { $collapsed['aggregatesonly'][] = $targetid; static::set_collapsed_preferences($courseid, $collapsed); } break; case 'switch_plus': // Remove category from array of aggregatesonly, and add it to array of gradesonly $key = array_search($targetid, $collapsed['aggregatesonly']); if ($key !== false) { unset($collapsed['aggregatesonly'][$key]); } if (!in_array($targetid, $collapsed['gradesonly'])) { $collapsed['gradesonly'][] = $targetid; } static::set_collapsed_preferences($courseid, $collapsed); break; case 'switch_whole': // Remove the category from the array of collapsed cats $key = array_search($targetid, $collapsed['gradesonly']); if ($key !== false) { unset($collapsed['gradesonly'][$key]); static::set_collapsed_preferences($courseid, $collapsed); } $key = array_search($targetid, $collapsed['aggregatesonly']); if ($key !== false) { unset($collapsed['aggregatesonly'][$key]); static::set_collapsed_preferences($courseid, $collapsed); } break; default: break; } return true; } /** * Refactored function for generating HTML of sorting links with matching arrows. * Returns an array with 'studentname' and 'idnumber' as keys, with HTML ready * to inject into a table header cell. * @param array $extrafields Array of extra fields being displayed, such as * user idnumber * @return array An associative array of HTML sorting links+arrows */ public function get_sort_arrows(array $extrafields = []) { global $CFG; $arrows = array(); $sortlink = clone($this->baseurl); // Sourced from tablelib.php // Check the full name display for sortable fields. if (has_capability('moodle/site:viewfullnames', $this->context)) { $nameformat = $CFG->alternativefullnameformat; } else { $nameformat = $CFG->fullnamedisplay; } if ($nameformat == 'language') { $nameformat = get_string('fullnamedisplay'); } $arrows['studentname'] = ''; $requirednames = order_in_string(\core_user\fields::get_name_fields(), $nameformat); if (!empty($requirednames)) { foreach ($requirednames as $name) { $arrows['studentname'] .= html_writer::link( new moodle_url($this->baseurl, array('sortitemid' => $name)), get_string($name) ); if ($this->sortitemid == $name) { $sortlink->param('sortitemid', $name); if ($this->sortorder == 'ASC') { $sorticon = $this->get_sort_arrow('down', $sortlink); } else { $sorticon = $this->get_sort_arrow('up', $sortlink); } $arrows['studentname'] .= $sorticon; } $arrows['studentname'] .= ' / '; } $arrows['studentname'] = substr($arrows['studentname'], 0, -3); } foreach ($extrafields as $field) { $attributes = [ 'data-collapse' => 'content' ]; // With additional user profile fields, we can't grab the name via WS, so conditionally add it to rip out of the DOM. if (preg_match(\core_user\fields::PROFILE_FIELD_REGEX, $field)) { $attributes['data-collapse-name'] = \core_user\fields::get_display_name($field); } $fieldlink = html_writer::link(new moodle_url($this->baseurl, ['sortitemid' => $field]), \core_user\fields::get_display_name($field), $attributes); $arrows[$field] = $fieldlink; if ($field == $this->sortitemid) { $sortlink->param('sortitemid', $field); if ($this->sortorder == 'ASC') { $sorticon = $this->get_sort_arrow('down', $sortlink); } else { $sorticon = $this->get_sort_arrow('up', $sortlink); } $arrows[$field] .= $sorticon; } } return $arrows; } /** * Returns the maximum number of students to be displayed on each page * * @return int The maximum number of students to display per page */ public function get_students_per_page(): int { // Default to the lowest available option. return (int) get_user_preferences('grade_report_studentsperpage', min(static::PAGINATION_OPTIONS)); } /** * Returns link to change category view mode. * * @param moodle_url $url Url to grader report page * @param string $title Menu item title * @param string $action View mode to change to * @param bool $active Whether link is active in dropdown * * @return string|null */ public function get_category_view_mode_link(moodle_url $url, string $title, string $action, bool $active = false): ?string { $urlnew = $url; $urlnew->param('action', $action); $active = $active ? 'true' : 'false'; return html_writer::link($urlnew, $title, ['class' => 'dropdown-item', 'aria-label' => $title, 'aria-current' => $active, 'role' => 'menuitem']); } /** * Return the link to allow the field to collapse from the users view. * * @return string Dropdown menu link that'll trigger the collapsing functionality. * @throws coding_exception * @throws moodle_exception */ public function get_hide_show_link(): string { $link = new moodle_url('#', []); return html_writer::link( $link->out(false), get_string('collapse'), ['class' => 'dropdown-item', 'data-hider' => 'hide', 'aria-label' => get_string('collapse'), 'role' => 'menuitem'], ); } /** * Return the base report link with some default sorting applied. * * @return string * @throws moodle_exception */ public function get_default_sortable(): string { $sortlink = new moodle_url('/grade/report/grader/index.php', [ 'id' => $this->courseid, 'sortitemid' => 'firstname', 'sort' => 'asc' ]); $this->gpr->add_url_params($sortlink); return $sortlink->out(false); } /** * Return class used for text alignment. * * @param grade_item $item Can be grade item or grade * @return string class name used for text alignment */ public function get_cell_display_class(grade_item $item): string { global $USER; $gradetypeclass = ''; if (!empty($USER->editing)) { switch ($item->gradetype) { case GRADE_TYPE_SCALE: $gradetypeclass = ' grade_type_scale'; break; case GRADE_TYPE_VALUE: $gradetypeclass = ' grade_type_value'; break; case GRADE_TYPE_TEXT: $gradetypeclass = ' grade_type_text'; break; } } else { $gradedisplaytype = $item->get_displaytype(); // Letter grades, scales and text grades are left aligned. $textgrade = false; $textgrades = [GRADE_DISPLAY_TYPE_LETTER, GRADE_DISPLAY_TYPE_REAL_LETTER, GRADE_DISPLAY_TYPE_LETTER_REAL, GRADE_DISPLAY_TYPE_LETTER_PERCENTAGE, GRADE_DISPLAY_TYPE_PERCENTAGE_LETTER]; if (in_array($gradedisplaytype, $textgrades)) { $textgrade = true; } $cache = \cache::make_from_params(\cache_store::MODE_REQUEST, 'gradereport_grader', 'scales'); $scalesarray = $cache->get(get_class($this)); if ($textgrade || ($item->gradetype == GRADE_TYPE_TEXT)) { $gradetypeclass = ' grade_type_text'; } else if ($item->scaleid && !empty($scalesarray[$item->scaleid])) { if ($gradedisplaytype == GRADE_DISPLAY_TYPE_PERCENTAGE) { $gradetypeclass = ' grade_type_value'; } else { $gradetypeclass = ' grade_type_scale'; } } else { $gradetypeclass = ' grade_type_value'; } } return $gradetypeclass; } } /** * Adds report specific context variable * * @param context_course $context Course context * @param int $courseid Course ID * @param array $element An array representing an element in the grade_tree * @param grade_plugin_return $gpr A grade_plugin_return object * @param string $mode Not used * @param stdClass|null $templatecontext Template context * @return stdClass|null */ function gradereport_grader_get_report_link(context_course $context, int $courseid, array $element, grade_plugin_return $gpr, string $mode, ?stdClass $templatecontext): ?stdClass { static $report = null; if (!$report) { $report = new grade_report_grader($courseid, $gpr, $context); } if ($mode == 'category') { if (!isset($templatecontext)) { $templatecontext = new stdClass(); } $categoryid = $element['object']->id; // Load language strings. $strswitchminus = get_string('aggregatesonly', 'grades'); $strswitchplus = get_string('gradesonly', 'grades'); $strswitchwhole = get_string('fullmode', 'grades'); $url = new moodle_url($gpr->get_return_url(null, ['target' => $element['eid'], 'sesskey' => sesskey()])); $gradesonly = false; $aggregatesonly = false; $fullmode = false; if (in_array($categoryid, $report->collapsed['gradesonly'])) { $gradesonly = true; } else if (in_array($categoryid, $report->collapsed['aggregatesonly'])) { $aggregatesonly = true; } else { $fullmode = true; } $templatecontext->gradesonlyurl = $report->get_category_view_mode_link($url, $strswitchplus, 'switch_plus', $gradesonly); $templatecontext->aggregatesonlyurl = $report->get_category_view_mode_link($url, $strswitchminus, 'switch_minus', $aggregatesonly); $templatecontext->fullmodeurl = $report->get_category_view_mode_link($url, $strswitchwhole, 'switch_whole', $fullmode); return $templatecontext; } else if ($mode == 'gradeitem') { if (($element['type'] == 'userfield') && ($element['name'] !== 'fullname')) { $templatecontext->columncollapse = $report->get_hide_show_link(); $templatecontext->dataid = $element['name']; } // We do not want grade category total items to be hidden away as it is controlled by something else. if (isset($element['object']->id) && !$element['object']->is_aggregate_item()) { $templatecontext->columncollapse = $report->get_hide_show_link(); } return $templatecontext; } return null; } report/grader/db/access.php 0000604 00000002420 15062070557 0011663 0 ustar 00 <?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/>. /** * Capability definition for the gradebook grader report * * @package gradereport_grader * @copyright 2007 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); $capabilities = array( 'gradereport/grader:view' => array( 'riskbitmask' => RISK_PERSONAL, 'captype' => 'read', 'contextlevel' => CONTEXT_COURSE, 'archetypes' => array( 'teacher' => CAP_ALLOW, 'editingteacher' => CAP_ALLOW, 'manager' => CAP_ALLOW ) ) ); report/grader/db/services.php 0000604 00000002545 15062070557 0012255 0 ustar 00 <?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/>. /** * Grader grade report external functions and service definitions. * * @package gradereport_grader * @copyright 2022 Mathew May <Mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die; $functions = [ 'gradereport_grader_get_users_in_report' => [ 'classname' => 'gradereport_grader\\external\\get_users_in_report', 'methodname' => 'execute', 'description' => 'Returns the dataset of users within the report', 'type' => 'read', 'ajax' => true, 'capabilities' => 'gradereport/grader:view', 'services' => [MOODLE_OFFICIAL_MOBILE_SERVICE], ], ]; report/grader/db/upgrade.php 0000604 00000006671 15062070557 0012065 0 ustar 00 <?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/>. /** * Grader report upgrade steps. * * @package gradereport_grader * @copyright 2023 Ilya Tregubov <ilya@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); /** * Function to upgrade grader report. * * @param int $oldversion the version we are upgrading from * @return bool result */ function xmldb_gradereport_grader_upgrade(int $oldversion): bool { global $DB; if ($oldversion < 2023032100) { // Remove grade_report_showquickfeedback, grade_report_enableajax, grade_report_showeyecons, // grade_report_showlocks, grade_report_showanalysisicon preferences for every user. $DB->delete_records('user_preferences', ['name' => 'grade_report_showquickfeedback']); $DB->delete_records('user_preferences', ['name' => 'grade_report_enableajax']); $DB->delete_records('user_preferences', ['name' => 'grade_report_showeyecons']); $DB->delete_records('user_preferences', ['name' => 'grade_report_showlocks']); $DB->delete_records('user_preferences', ['name' => 'grade_report_showanalysisicon']); // Remove grade_report_showactivityicons, grade_report_showcalculations preferences for every user. $DB->delete_records('user_preferences', ['name' => 'grade_report_showactivityicons']); $DB->delete_records('user_preferences', ['name' => 'grade_report_showcalculations']); // The grade_report_showquickfeedback, grade_report_enableajax, grade_report_showeyecons, // grade_report_showlocks, grade_report_showanalysisicon settings have been removed. unset_config('grade_report_showquickfeedback'); unset_config('grade_report_enableajax'); unset_config('grade_report_showeyecons'); unset_config('grade_report_showlocks'); unset_config('grade_report_showanalysisicon'); // The grade_report_showactivityicons, grade_report_showcalculations settings have been removed. unset_config('grade_report_showactivityicons'); unset_config('grade_report_showcalculations'); // Main savepoint reached. upgrade_plugin_savepoint(true, 2023032100, 'gradereport', 'grader'); } if ($oldversion < 2023032700) { unset_config('grade_report_studentsperpage'); upgrade_plugin_savepoint(true, 2023032700, 'gradereport', 'grader'); } if ($oldversion < 2023032800) { // Remove plugin entry created by previously incorrect 2023032100 savepoint. $DB->delete_records('config_plugins', ['plugin' => 'grade_gradereport_grader']); upgrade_plugin_savepoint(true, 2023032800, 'gradereport', 'grader'); } // Automatically generated Moodle v4.2.0 release upgrade line. // Put any upgrade step following this. return true; } report/grader/version.php 0000604 00000002273 15062070557 0011530 0 ustar 00 <?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/>. /** * Version details for the grader report * * @package gradereport_grader * @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); $plugin->version = 2023100900; // The current plugin version (Date: YYYYMMDDXX). $plugin->requires = 2023100400; // Requires this Moodle version. $plugin->component = 'gradereport_grader'; // Full name of the plugin (used for diagnostics) report/grader/templates/perpage.mustache 0000604 00000003312 15062070557 0014501 0 ustar 00 {{! 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/>. }} {{! @template gradereport_grader/perpage The students per page dropdown element. Context variables required for this template: * baseurl - The base URL for the perpage action. * options - Choices Example context (json): { "baseurl": "http://example.com/grade/report/grader/index.php?id=2&report=grader", "options": [ {"name": "20", "value": "20"}, {"name": "100", "value": "100", "selected": true}, {"name": "All", "value": "0"} ] } }} <label> {{#str}}show{{/str}} <select name="perpage" class="custom-select ignoredirty" id="{{uniqid}}"> {{#options}} <option value="{{value}}" {{#selected}}selected{{/selected}}>{{{name}}}</option> {{/options}} </select> </label> {{#js}} document.getElementById('{{uniqid}}').addEventListener('change', function(e) { var url = new URL('{{baseurl}}'); url.searchParams.set('perpage', e.target.value); window.location.href = url; }); {{/js}} report/grader/templates/action_bar.mustache 0000604 00000010170 15062070557 0015157 0 ustar 00 {{! 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/>. }} {{! @template gradereport_grader/action_bar Actions bar for the grader report. Context variables required for this template: * generalnavselector - The data object containing the required properties to render the general navigation selector. * groupselector - (optional) HTML that outputs the group selector Example context (json): { "generalnavselector": { "name": "Gradebook tertiary navigation selector", "value": "opt2", "baseid": "select-menu56789", "selectedoption": "Gradebook setup", "options": [ { "selected": false, "isgroup": { "name": "View", "id": "select-menu-group1", "options": [ { "name": "Grader report", "value": "opt1", "id": "select-menu-option1", "selected": false } ] } }, { "selected": false, "isgroup": { "name": "Setup", "id": "select-menu-group2", "options": [ { "name": "Gradebook setup", "value": "opt2", "id": "select-menu-option2", "selected": true } ] } } ] }, "groupselector": "<div class='group-selector'></div>", "collapsedcolumns": "<div class='collapse-columns'></div>", "pagereset": "http://moodle.local/grade/report/grader/index.php?id=2&userid=2&reset=1" } }} <div class="container-fluid tertiary-navigation full-width-bottom-border"> <div class="row"> {{#generalnavselector}} <div class="navitem"> {{>core/tertiary_navigation_selector}} </div> <div class="navitem-divider"></div> {{/generalnavselector}} {{#searchdropdown}} <div class="navitem"> {{>core/comboboxsearch}} </div> <div class="navitem-divider"></div> {{/searchdropdown}} {{#groupselector}} <div class="navitem"> {{{.}}} </div> <div class="navitem-divider"></div> {{/groupselector}} {{#initialselector}} <div class="navitem d-flex flex-column align-self-center"> {{>core/comboboxsearch}} </div> <div class="navitem-divider"></div> {{/initialselector}} {{#pagereset}} <div class="navitem align-self-center"> <a href="{{{.}}}" class="btn btn-link">{{#str}}clearall, gradereport_grader{{/str}}</a> </div> <div class="navitem-divider"></div> {{/pagereset}} {{#collapsedcolumns}} <div class="navitem flex-column align-self-center ml-auto {{#classes}}{{.}}{{/classes}}" aria-live="polite"> {{#content}} {{>core/comboboxsearch}} {{/content}} </div> {{/collapsedcolumns}} </div> </div> report/grader/templates/headercell.mustache 0000604 00000004011 15062070557 0015143 0 ustar 00 {{! 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/>. }} {{! @template gradereport_grader/headercell Header cell template Example context (json): { "headerlink": "<a class='gradeitemheader' href='index.php?id=2&sortitemid=2'><img class='icon itemicon' src='http://moodlesite/theme/image.php/boost/assign/1680563323/monologo' alt='Assignment' />Assignment 1</a>", "arrow": "<a title='Descending' aria-label='Descending' href='index.php?id=2&sortitemid=2'><i class='icon fa fa-sort-desc fa-fw sorticon' aria-hidden='true' ></i></a>", "singleview": "<div class='action-menu moodle-actionmenu grader' id='action-menu-8' data-enhance='moodle-core-actionmenu'></div>", "statusicons": "<div class='grade_icons'><i class='icon fa fa-lock fa-fw text-muted' title='Locked' role='img' aria-label='Locked'></i></div>" } }} <div class="d-flex flex-column h-100"> <div class="d-none flex-grow-1 align-items-start" data-collapse="expandbutton"> {{{collapsedicon}}} </div> <div class="d-flex" data-collapse="content"> <div class="d-flex flex-grow-1"> {{{headerlink}}} <div class="mx-2 mt-2"> {{{arrow}}} </div> </div> <div> {{{singleview}}} </div> </div> <div class="d-flex flex-grow-1 align-items-end"> {{{statusicons}}} </div> </div> report/grader/templates/collapse/collapseresults.mustache 0000604 00000002606 15062070557 0020111 0 ustar 00 {{! 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/>. }} {{! @template gradereport_grader/collapse/collapseresults Context variables required for this template: * results - An array of found columns that are currently hidden. * searchTerm - What the user is currently searching for. Example context (json): { "results": [ { "name": "42", "displayName": "The meaning of life", "category": "Hitchhikers grade category" } ], "searchTerm": "Meaning of" } }} {{#results}} {{>gradereport_grader/collapse/collapseresultitems}} {{/results}} {{^results}} <span class="d-block my-4">{{#str}} noresultsfor, core, {{searchTerm}}{{/str}}</span> {{/results}} report/grader/templates/collapse/collapseresultitems.mustache 0000604 00000003400 15062070557 0020761 0 ustar 00 {{! 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/>. }} {{! @template gradereport_grader/collapse/collapseresultitems Context variables required for this template: * name - The 'system' name that we search against. * displayName - The 'end user' name that the user can search against. * category - The category that a gradable item is within. Example context (json): { "name": "42", "displayName": "The meaning of life", "category": "Hitchhikers grade category" } }} <li class="w-100 result-row form-check mb-1" role="none"> <input id="check-{{name}}-input" class="form-check-input" role="option" data-collapse="{{name}}" type="checkbox" value="" aria-labelledby="check-{{name}}"> <label id="check-{{name}}" class="selected-option-info d-block pr-3 text-truncate form-check-label" tabindex="-1"> <span class="selected-option-text w-100 p-0"> {{{displayName}}} </span> {{#category}} <span class="d-block w-100 pull-left text-muted text-truncate small"> {{category}} </span> {{/category}} </label> </li> report/grader/templates/collapse/collapsebody.mustache 0000604 00000006250 15062070557 0017344 0 ustar 00 {{! 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/>. }} {{! @template gradereport_grader/collapse/collapsebody The body of the column collapsing dropdown that contains the form and subsequent results from the search. Example context (json): { "results": [ { "name": "42", "displayName": "The meaning of life", "category": "Hitchhikers grade category" } ], "searchTerm": "Meaning of", "userid": "42" } }} <div class="flex-column h-100 w-100"> <span class="d-none" data-region="userid" data-userid="{{userid}}" aria-hidden="true"></span> {{< core/search_input_auto }} {{$label}}{{#str}} searchcollapsedcolumns, core_grades {{/str}}{{/label}} {{$placeholder}}{{#str}} searchcollapsedcolumns, core_grades {{/str}}{{/placeholder}} {{$additionalattributes}} role="combobox" aria-expanded="true" aria-controls="collapse-listbox" aria-autocomplete="list" data-input-element="collapse-input-{{uniqid}}" {{/additionalattributes}} {{/ core/search_input_auto }} <input type="hidden" name="search" id="collapse-input-{{uniqid}}"/> <form class="columnsdropdownform flex-column h-100"> <ul id="collapse-listbox" class="searchresultitemscontainer overflow-auto py-2 px-1 list-group mx-0 text-truncate" role="listbox" data-region="search-result-items-container" tabindex="-1" aria-label="{{#cleanstr}} aria:dropdowncolumns, gradereport_grader {{/cleanstr}}" aria-busy="true"> {{>gradereport_grader/collapse/collapseresults}} </ul> <div class="d-flex mt-2"> <div class="d-flex align-items-center form-check"> <label id="check-all" for="check-all-input" class="selected-option-info text-truncate form-check-label d-block" tabindex="-1"> <input disabled id="check-all-input" class="form-check-input" type="checkbox" data-action="selectall" aria-label="{{#str}}selectall, core{{/str}}"> {{#str}}selectall, core{{/str}} </label> </div> <div class="flex-row ml-auto"> <input class="btn btn-outline-secondary pull-right mx-2" data-action="cancel" type="submit" value="{{#str}}closebuttontitle{{/str}}"> <input disabled class="btn btn-primary pull-right" data-action="save" type="submit" value="{{#str}}expand{{/str}}"> </div> </div> </form> </div> report/grader/templates/collapse/icon.mustache 0000604 00000002351 15062070557 0015612 0 ustar 00 {{! 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/>. }} {{! @template gradereport_grader/collapse/icon Context variables required for this template: * field - Either the shortname of the user field or a grade item ID. Example context (json): { "field": "42", "name": "Meaning of life" } }} <button type="button" class="btn btn-link btn-icon icon-size-3" data-hider="expand" data-col="{{field}}"> <i class="icon fa fa-plus m-0" title="Reopen column" aria-hidden="true"></i> <span class="sr-only">{{#str}}reopencolumn, gradereport_grader, {{name}}{{/str}}</span> </button> report/grader/templates/cell.mustache 0000604 00000003774 15062070557 0014011 0 ustar 00 {{! 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/>. }} {{! @template gradereport_grader/cell Cell template. Example context (json): { "iseditable": "true", "statusicons": "<div class='grade_icons'><i class='icon fa fa-lock fa-fw text-muted' title='Locked' role='img' aria-label='Locked'></i></div>", "actionmenu": "<div class='action-menu moodle-actionmenu grader' id='action-menu-8' data-enhance='moodle-core-actionmenu'></div>", "id": "grade_313_624", "label": "grade_313_624", "title": "Grade", "extraclasses": "statusicons", "value": "Text information", "tabindex": "1", "name": "grade[313][624]" } }} <div class="d-flex flex-column h-100" data-collapse="content"> <div class="d-flex"> <div class="d-flex flex-grow-1"> {{#iseditable}} {{#scale}} {{>core_grades/grades/grader/scale}} {{/scale}} {{^scale}} {{>core_grades/grades/grader/input}} {{/scale}} {{/iseditable}} {{^iseditable}} {{>core_grades/grades/grader/text}} {{/iseditable}} </div> <div> {{{actionmenu}}} </div> </div> <div class="d-flex flex-grow-1 align-items-end"> {{{statusicons}}} </div> </div> report/grader/templates/categorycell.mustache 0000604 00000003431 15062070557 0015535 0 ustar 00 {{! 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/>. }} {{! @template gradereport_grader/headercell Header cell template Example context (json): { "headerlink": "<a class='gradeitemheader' href='index.php?id=2&sortitemid=2'><img class='icon itemicon' src='http://moodlesite/theme/image.php/boost/assign/1680563323/monologo' alt='Assignment' />Assignment 1</a>", "arrow": "<a title='Descending' aria-label='Descending' href='index.php?id=2&sortitemid=2'><i class='icon fa fa-sort-desc fa-fw sorticon' aria-hidden='true' ></i></a>", "singleview": "<div class='action-menu moodle-actionmenu grader' id='action-menu-8' data-enhance='moodle-core-actionmenu'></div>", "statusicons": "<div class='grade_icons'><i class='icon fa fa-lock fa-fw text-muted' title='Locked' role='img' aria-label='Locked'></i></div>" } }} <div class="d-flex flex-column h-100"> <div class="d-flex"> <div class="header"> {{{courseheader}}} </div> <div> {{{actionmenu}}} </div> </div> <div class="d-flex flex-grow-1 align-items-end"> {{{statusicons}}} </div> </div> report/grader/tests/behat/sort_gradeitems_user_fields.feature 0000604 00000017134 15062070557 0020715 0 ustar 00 @gradereport @gradereport_grader Feature: We can sort grades/user fields on the grader report In order to manage grades on grader report As a teacher I need to be able to sort grades or user fields. Background: Given the following "courses" exist: | fullname | shortname | format | | Course 1 | C1 | topics | And the following "users" exist: | username | firstname | lastname | email | | teacher1 | Teacher | 1 | teacher1@example.com | | student1 | StudentA | 2 | d@example.com | | student2 | StudentB | 4 | a@example.com | | student3 | StudentC | 3 | c@example.com | | student4 | StudentD | 1 | b@example.com | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | | student2 | C1 | student | | student3 | C1 | student | | student4 | C1 | student | And the following "activities" exist: | activity | course | section | name | intro | assignsubmission_onlinetext_enabled | submissiondrafts | | assign | C1 | 1 | Test assignment name 1 | Submit your online text | 1 | 0 | And the following "mod_assign > submissions" exist: | assign | user | onlinetext | | Test assignment name 1 | student1 | This is a submission for assignment 1 | | Test assignment name 1 | student2 | This is a submission for assignment 1 | | Test assignment name 1 | student3 | This is a submission for assignment 1 | | Test assignment name 1 | student4 | This is a submission for assignment 1 | And the following "grade items" exist: | itemname | grademin | grademax | course | | Manual grade | 20 | 40 | C1 | And the following "grade grades" exist: | gradeitem | user | grade | | Test assignment name 1 | student1 | 80 | | Test assignment name 1 | student2 | 40 | | Test assignment name 1 | student3 | 60 | And I log in as "teacher1" @javascript Scenario: Sort grades or user fields on grader report by using cell action menu When I am on "Course 1" course homepage with editing mode on And I navigate to "View > Grader report" in the course gradebook # Default sorting is lastname ascending. And "StudentD 1" "table_row" should appear before "StudentA 2" "table_row" And "StudentA 2" "table_row" should appear before "StudentC 3" "table_row" And "StudentC 3" "table_row" should appear before "StudentB 4" "table_row" # Sort by grades in descending order. And I click on grade item menu "Test assignment name 1" of type "gradeitem" on "grader" page And I choose "Descending" in the open action menu And I wait until the page is ready Then "StudentA 2" "table_row" should appear before "StudentC 3" "table_row" And "StudentC 3" "table_row" should appear before "StudentB 4" "table_row" And "StudentB 4" "table_row" should appear before "StudentD 1" "table_row" # Sort by grades in ascending order. And I click on grade item menu "Test assignment name 1" of type "gradeitem" on "grader" page And I choose "Ascending" in the open action menu And I wait until the page is ready Then "StudentD 1" "table_row" should appear before "StudentB 4" "table_row" And "StudentB 4" "table_row" should appear before "StudentC 3" "table_row" And "StudentC 3" "table_row" should appear before "StudentA 2" "table_row" # Sort by email in ascending order. And I click on user profile field menu "email" And I choose "Ascending" in the open action menu And I wait until the page is ready Then "StudentB 4" "table_row" should appear before "StudentD 1" "table_row" And "StudentD 1" "table_row" should appear before "StudentC 3" "table_row" And "StudentC 3" "table_row" should appear before "StudentA 2" "table_row" And I click on user profile field menu "email" # Sort by email in descending order. And I choose "Descending" in the open action menu And I wait until the page is ready Then "StudentA 2" "table_row" should appear before "StudentC 3" "table_row" And "StudentC 3" "table_row" should appear before "StudentD 1" "table_row" And "StudentD 1" "table_row" should appear before "StudentB 4" "table_row" @javascript Scenario: Sort grades or user fields on grader report by using element header When I am on "Course 1" course homepage with editing mode on And I navigate to "View > Grader report" in the course gradebook # Default sorting is lastname ascending. And "StudentD 1" "table_row" should appear before "StudentA 2" "table_row" And "StudentA 2" "table_row" should appear before "StudentC 3" "table_row" And "StudentC 3" "table_row" should appear before "StudentB 4" "table_row" # Sort by grades in ascending order. And I click on "Test assignment name 1" "link" in the "region-main" "region" And I wait until the page is ready Then "StudentD 1" "table_row" should appear before "StudentB 4" "table_row" And "StudentB 4" "table_row" should appear before "StudentC 3" "table_row" And "StudentC 3" "table_row" should appear before "StudentA 2" "table_row" # Sort by grades in descending order. And I click on "Test assignment name 1" "link" in the "region-main" "region" And I wait until the page is ready Then "StudentA 2" "table_row" should appear before "StudentC 3" "table_row" And "StudentC 3" "table_row" should appear before "StudentB 4" "table_row" And "StudentB 4" "table_row" should appear before "StudentD 1" "table_row" # Sort by email in ascending order. And I click on "Email address" "link" in the "region-main" "region" And I wait until the page is ready Then "StudentB 4" "table_row" should appear before "StudentD 1" "table_row" And "StudentD 1" "table_row" should appear before "StudentC 3" "table_row" And "StudentC 3" "table_row" should appear before "StudentA 2" "table_row" # Sort by email in descending order. And I click on "Email address" "link" in the "region-main" "region" And I wait until the page is ready Then "StudentA 2" "table_row" should appear before "StudentC 3" "table_row" And "StudentC 3" "table_row" should appear before "StudentD 1" "table_row" And "StudentD 1" "table_row" should appear before "StudentB 4" "table_row" # Sort by firstname in ascending order. And I click on "First name" "link" And I wait until the page is ready Then "StudentA 2" "table_row" should appear before "StudentB 4" "table_row" And "StudentB 4" "table_row" should appear before "StudentC 3" "table_row" And "StudentC 3" "table_row" should appear before "StudentD 1" "table_row" # Sort by firstname in descending order. And I click on "First name" "link" And I wait until the page is ready Then "StudentD 1" "table_row" should appear before "StudentC 3" "table_row" And "StudentC 3" "table_row" should appear before "StudentB 4" "table_row" And "StudentB 4" "table_row" should appear before "StudentA 2" "table_row" # Sort by lastname in ascending order. And I click on "Last name" "link" And I wait until the page is ready Then "StudentD 1" "table_row" should appear before "StudentA 2" "table_row" And "StudentA 2" "table_row" should appear before "StudentC 3" "table_row" And "StudentC 3" "table_row" should appear before "StudentB 4" "table_row" report/grader/tests/behat/behat_gradereport_grader.php 0000604 00000011377 15062070557 0017302 0 ustar 00 <?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/>. /** * Behat steps definitions for drag and drop onto image. * * @package gradereport_grader * @category test * @copyright 2015 Oakland University * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ // NOTE: no MOODLE_INTERNAL test here, this file may be required by behat before including /config.php. require_once(__DIR__ . '/../../../../../lib/behat/behat_base.php'); use Behat\Mink\Exception\ExpectationException as ExpectationException, Behat\Mink\Exception\ElementNotFoundException as ElementNotFoundException; /** * Steps definitions related with the drag and drop onto image question type. * * @copyright 2015 Oakland University * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class behat_gradereport_grader extends behat_base { /** * Gets the user id from its name. * * @throws Exception * @param string $name * @return int */ protected function get_user_id($name) { global $DB; $names = explode(' ', $name); if (!$id = $DB->get_field('user', 'id', array('firstname' => $names[0], 'lastname' => $names[1]))) { throw new Exception('The specified user with username "' . $name . '" does not exist'); } return $id; } /** * Gets the grade item id from its name. * * @deprecated since 4.2 * @todo MDL-77107 This will be deleted in Moodle 4.6. * @throws Exception * @param string $itemname * @return int */ protected function get_grade_item_id($itemname) { global $DB; debugging('behat_gradereport_grader::get_grade_item_id() is deprecated, please use' . ' behat_grades::get_grade_item_id() instead.', DEBUG_DEVELOPER); if ($id = $DB->get_field('grade_items', 'id', array('itemname' => $itemname))) { return $id; } // The course total is a special case. if ($itemname === "Course total") { if (!$id = $DB->get_field('grade_items', 'id', array('itemtype' => 'course'))) { throw new Exception('The specified grade_item with name "' . $itemname . '" does not exist'); } return $id; } // Find a category with the name. if ($catid = $DB->get_field('grade_categories', 'id', array('fullname' => $itemname))) { if ($id = $DB->get_field('grade_items', 'id', array('iteminstance' => $catid))) { return $id; } } throw new Exception('The specified grade_item with name "' . $itemname . '" does not exist'); } /** * Clicks on given user menu. * * @Given /^I click on user menu "([^"]*)"$/ * @param string $student */ public function i_click_on_user_menu(string $student) { $xpath = $this->get_user_selector($student); $this->execute("behat_general::i_click_on", array($this->escape($xpath), "xpath_element")); } /** * Gets unique xpath selector for a user. * * @throws Exception * @param string $student * @return string */ protected function get_user_selector(string $student) : string { $userid = $this->get_user_id($student); return "//table[@id='user-grades']//*[@data-type='user'][@data-id='" . $userid . "']"; } /** * Clicks on given user profile field menu. * * @Given /^I click on user profile field menu "([^"]*)"$/ * @param string $field */ public function i_click_on_user_profile_field_menu(string $field) { $xpath = "//table[@id='user-grades']//*[@data-type='" . mb_strtolower($field) . "']"; $this->execute("behat_general::i_click_on", array($this->escape($xpath), "xpath_element")); } /** * Return the list of partial named selectors. * * @return array */ public static function get_partial_named_selectors(): array { return [ new behat_component_named_selector( 'collapse search', [".//*[contains(concat(' ', @class, ' '), ' collapsecolumndropdown ')]"] ), ]; } } report/grader/tests/behat/behat_gradereport_grader_deprecated.php 0000604 00000025313 15062070557 0021455 0 ustar 00 <?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/>. // NOTE: no MOODLE_INTERNAL test here, this file may be required by behat before including /config.php. use Behat\Gherkin\Node\TableNode; require_once(__DIR__ . '/../../../../../lib/behat/behat_deprecated_base.php'); /** * Steps definitions that are now deprecated and will be removed in the next releases. * * This file only contains the steps that previously were in the behat_*.php files in the SAME DIRECTORY. * When deprecating steps from other components or plugins, create a behat_COMPONENT_deprecated.php * file in the same directory where the steps were defined. * * @package gradereport_grader * @category test * @copyright 2023 Ilya Tregubov * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class behat_gradereport_grader_deprecated extends behat_deprecated_base { /** * Remove focus for a grade value cell. * * @deprecated since 4.2 - we don't allow ajax edit on grader report anymore. * @todo MDL-77107 This will be deleted in Moodle 4.6. * @Given /^I click away from student "([^"]*)" and grade item "([^"]*)" feedback$/ * @param string $student * @param string $itemname */ public function i_click_away_from_student_and_grade_feedback($student, $itemname) { $this->deprecated_message(['behat_gradereport_grader::i_click_away_from_student_and_grade_feedback']); $xpath = $this->get_student_and_grade_feedback_selector($student, $itemname); $this->execute('behat_general::i_take_focus_off_field', array($this->escape($xpath), 'xpath_element')); } /** * Look for a feedback editing field. * * @deprecated since 4.2 - we don't allow ajax edit on grader report anymore. * @todo MDL-77107 This will be deleted in Moodle 4.6. * @Then /^I should see a feedback field for "([^"]*)" and grade item "([^"]*)"$/ * @param string $student * @param string $itemname */ public function i_should_see_feedback_field($student, $itemname) { $this->deprecated_message(['behat_gradereport_grader::i_should_see_feedback_field']); $xpath = $this->get_student_and_grade_feedback_selector($student, $itemname); $this->execute('behat_general::should_be_visible', array($this->escape($xpath), 'xpath_element')); } /** * Look for a lack of the feedback editing field. * * @deprecated since 4.2 - we don't allow ajax edit on grader report anymore. * @todo MDL-77107 This will be deleted in Moodle 4.6. * @Then /^I should not see a feedback field for "([^"]*)" and grade item "([^"]*)"$/ * @param string $student * @param string $itemname */ public function i_should_not_see_feedback_field($student, $itemname) { $this->deprecated_message(['behat_gradereport_grader::i_should_not_see_feedback_field']); $xpath = $this->get_student_and_grade_feedback_selector($student, $itemname); $this->execute('behat_general::should_not_exist', array($this->escape($xpath), 'xpath_element')); } /** * Gets xpath for a particular student/grade item feedback cell. * * @deprecated since 4.2 - we don't allow ajax edit on grader report anymore. * @todo MDL-77107 This will be deleted in Moodle 4.6. * @throws Exception * @param string $student * @param string $itemname * @return string */ protected function get_student_and_grade_feedback_selector($student, $itemname) { $this->deprecated_message(['behat_gradereport_grader::get_student_and_grade_feedback_selector']); $cell = $this->get_student_and_grade_cell_selector($student, $itemname); return $cell . "//input[contains(@id, 'feedback_') or @name='ajaxfeedback']"; } /** * Click a given user grade cell. * * @deprecated since 4.2 - we don't allow ajax edit on grader report anymore. * @todo MDL-77107 This will be deleted in Moodle 4.6. * @Given /^I click on student "([^"]*)" for grade item "([^"]*)"$/ * @param string $student * @param string $itemname */ public function i_click_on_student_and_grade_item($student, $itemname) { $this->deprecated_message(['behat_gradereport_grader::i_click_on_student_and_grade_item']); $xpath = $this->get_student_and_grade_cell_selector($student, $itemname); $this->execute("behat_general::i_click_on", array($this->escape($xpath), "xpath_element")); } /** * Remove focus for a grade value cell. * * @deprecated since 4.2 - we don't allow ajax edit on grader report anymore. * @todo MDL-77107 This will be deleted in Moodle 4.6. * @Given /^I click away from student "([^"]*)" and grade item "([^"]*)" value$/ * @param string $student * @param string $itemname */ public function i_click_away_from_student_and_grade_value($student, $itemname) { $this->deprecated_message(['behat_gradereport_grader::i_click_away_from_student_and_grade_value']); $xpath = $this->get_student_and_grade_value_selector($student, $itemname); $this->execute('behat_general::i_take_focus_off_field', array($this->escape($xpath), 'xpath_element')); } /** * Checks grade values with or without a edit box. * * @deprecated since 4.2 - we don't allow ajax edit on grader report anymore. * @todo MDL-77107 This will be deleted in Moodle 4.6. * @Then /^the grade for "([^"]*)" in grade item "([^"]*)" should match "([^"]*)"$/ * @throws Exception * @throws ElementNotFoundException * @param string $student * @param string $itemname * @param string $value */ public function the_grade_should_match($student, $itemname, $value) { $this->deprecated_message(['behat_gradereport_grader::the_grade_should_match']); $xpath = $this->get_student_and_grade_value_selector($student, $itemname); $gradefield = $this->getSession()->getPage()->find('xpath', $xpath); if (!empty($gradefield)) { // Get the field. $fieldtype = behat_field_manager::guess_field_type($gradefield, $this->getSession()); if (!$fieldtype) { throw new Exception('Could not get field type for grade field "' . $itemname . '"'); } $field = behat_field_manager::get_field_instance($fieldtype, $gradefield, $this->getSession()); if (!$field->matches($value)) { $fieldvalue = $field->get_value(); throw new ExpectationException( 'The "' . $student . '" and "' . $itemname . '" grade is "' . $fieldvalue . '", "' . $value . '" expected' , $this->getSession() ); } } else { // If there isn't a form field, just search for contents. $valueliteral = behat_context_helper::escape($value); $xpath = $this->get_student_and_grade_cell_selector($student, $itemname); $xpath .= "[contains(normalize-space(.)," . $valueliteral . ")]"; $node = $this->getSession()->getDriver()->find($xpath); if (empty($node)) { $locatorexceptionmsg = 'Cell for "' . $student . '" and "' . $itemname . '" with value "' . $value . '"'; throw new ElementNotFoundException($this->getSession(), $locatorexceptionmsg, null, $xpath); } } } /** * Look for a grade editing field. * * @deprecated since 4.2 - we don't allow ajax edit on grader report anymore. * @todo MDL-77107 This will be deleted in Moodle 4.6. * @Then /^I should see a grade field for "([^"]*)" and grade item "([^"]*)"$/ * @param string $student * @param string $itemname */ public function i_should_see_grade_field($student, $itemname) { $this->deprecated_message(['behat_gradereport_grader::i_should_see_grade_field']); $xpath = $this->get_student_and_grade_value_selector($student, $itemname); $this->execute('behat_general::should_be_visible', array($this->escape($xpath), 'xpath_element')); } /** * Look for a lack of the grade editing field. * * @deprecated since 4.2 - we don't allow ajax edit on grader report anymore. * @todo MDL-77107 This will be deleted in Moodle 4.6. * @Then /^I should not see a grade field for "([^"]*)" and grade item "([^"]*)"$/ * @param string $student * @param string $itemname */ public function i_should_not_see_grade_field($student, $itemname) { $this->deprecated_message(['behat_gradereport_grader::i_should_not_see_grade_field']); $xpath = $this->get_student_and_grade_value_selector($student, $itemname); $this->execute('behat_general::should_not_exist', array($this->escape($xpath), 'xpath_element')); } /** * Gets unique xpath selector for a student/grade item combo. * * @deprecated since 4.2 - we don't allow ajax edit on grader report anymore. * @todo MDL-77107 This will be deleted in Moodle 4.6. * @throws Exception * @param string $student * @param string $itemname * @return string */ protected function get_student_and_grade_cell_selector($student, $itemname) { $this->deprecated_message(['behat_gradereport_grader::get_student_and_grade_cell_selector']); $itemid = 'u' . $this->get_user_id($student) . 'i' . $this->get_grade_item_id($itemname); return "//table[@id='user-grades']//td[@id='" . $itemid . "']"; } /** * Gets xpath for a particular student/grade item grade value cell. * * @deprecated since 4.2 - we don't allow ajax edit on grader report anymore. * @todo MDL-77107 This will be deleted in Moodle 4.6. * @throws Exception * @param string $student * @param string $itemname * @return string */ protected function get_student_and_grade_value_selector($student, $itemname) { $this->deprecated_message(['behat_gradereport_grader::get_student_and_grade_value_selector']); $cell = $this->get_student_and_grade_cell_selector($student, $itemname); return $cell . "//*[contains(@id, 'grade_') or @name='ajaxgrade']"; } } report/grader/tests/behat/groupsearch.feature 0000604 00000014047 15062070557 0015460 0 ustar 00 @core @core_grades @gradereport_grader @javascript Feature: Group searching functionality within the grader report. Background: Given the following "courses" exist: | fullname | shortname | category | groupmode | | Course 1 | C1 | 0 | 1 | And the following "users" exist: | username | firstname | lastname | email | idnumber | | teacher1 | Teacher | 1 | teacher1@example.com | t1 | | student1 | Student | 1 | student1@example.com | s1 | | student2 | Student | 2 | student2@example.com | s2 | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | | student2 | C1 | student | And the following "groups" exist: | name | course | idnumber | | Default group | C1 | dg | | Group 2 | C1 | g2 | | Tutor group | C1 | tg | | Marker group | C1 | mg | And the following "group members" exist: | user | group | | student1 | dg | | student2 | g2 | And I am on the "Course 1" "grades > Grader report > View" page logged in as "teacher1" Scenario: A teacher can see the 'group' search widget only when group mode is enabled in the course Given ".groupsearchwidget" "css_element" should exist And I am on the "C1" "course editing" page And I set the following fields to these values: | id_groupmode | No groups | And I press "Save and display" When I navigate to "View > Grader report" in the course gradebook Then ".groupsearchwidget" "css_element" should not exist Scenario: A teacher can search for and find a group to display Given I confirm "Tutor group" in "group" search within the gradebook widget exists And I confirm "Marker group" in "group" search within the gradebook widget exists When I set the field "Search groups" to "tutor" And I wait until "Marker group" "option_role" does not exist Then I confirm "Tutor group" in "group" search within the gradebook widget exists And I confirm "Marker group" in "group" search within the gradebook widget does not exist And I click on "Tutor group" in the "group" search widget # The search input remains in the field on reload this is in keeping with other search implementations. And I click on ".groupsearchwidget" "css_element" And the field "Search groups" matches value "tutor" Then I set the field "Search groups" to "Turtle" And I should see "No results for \"Turtle\"" Scenario: A teacher can only see the group members in the 'user' search widget after selecting a group option # Confirm that all users are initially displayed in the 'user' search widget. Given I set the field "Search users" to "Student" And I confirm "Student 1" in "user" search within the gradebook widget exists And I confirm "Student 2" in "user" search within the gradebook widget exists # Select a particular group from the 'group' search widget. When I click on "Default group" in the "group" search widget # Confirm that only users which are members of the selected group are displayed in the 'user' search widget. And I set the field "Search users" to "Student" Then I confirm "Student 1" in "user" search within the gradebook widget exists And I confirm "Student 2" in "user" search within the gradebook widget does not exist And I click on "Tutor group" in the "group" search widget And I set the field "Search users" to "Student" And I confirm "Student 1" in "user" search within the gradebook widget does not exist And I confirm "Student 2" in "user" search within the gradebook widget does not exist And I click on "All participants" in the "group" search widget And I set the field "Search users" to "Student" And I confirm "Student 1" in "user" search within the gradebook widget exists And I confirm "Student 2" in "user" search within the gradebook widget exists @accessibility Scenario: A teacher can set focus and search using the input with a keyboard Given I click on ".groupsearchwidget" "css_element" # Basic tests for the page. And the page should meet accessibility standards And the page should meet "wcag131, wcag141, wcag412" accessibility standards And the page should meet accessibility standards with "wcag131, wcag141, wcag412" extra tests # Move onto general keyboard navigation testing. And I click on "Search groups" "field" And I wait until "Default group" "option_role" exists And I press the down key And the focused element is "All participants" "option_role" And I press the end key And the focused element is "Tutor group" "option_role" And I press the home key And the focused element is "All participants" "option_role" And I press the up key And the focused element is "Tutor group" "option_role" And I press the down key And the focused element is "All participants" "option_role" And I press the escape key And the focused element is "Search groups" "field" Then I set the field "Search groups" to "Goodmeme" And I wait until "Tutor group" "option_role" does not exist And I press the down key And the focused element is "Search groups" "field" And I navigate to "View > User report" in the course gradebook And I click on ".groupsearchwidget" "css_element" And I set the field "Search groups" to "Tutor" And I wait until "All participants" "option_role" does not exist And I press the down key And the focused element is "Tutor group" "option_role" # Lets check the tabbing order. And I set the field "Search groups" to "Marker" And I wait until "Marker group" "option_role" exists And I press the tab key And the focused element is "Clear search input" "button" And I press the enter key And I wait until the page is ready And ".groupsearchwidget" "css_element" should exist report/grader/tests/behat/locking.feature 0000604 00000006200 15062070557 0014554 0 ustar 00 Feature: Locking Grade Items and Categories in Gradebook In order to ensure that grade items and categories can be securely locked in the gradebook, As a teacher, I need to perform locking actions and verify the locking status. Background: Given the following "courses" exist: | fullname | shortname | | Course 1 | C1 | And the following "users" exist: | username | firstname | lastname | | teacher1 | Teacher | 1 | | student1 | Student | 1 | | student2 | Student | 2 | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | | student2 | C1 | student | And the following "grade categories" exist: | fullname | course | | Category 1 | C1 | And the following "grade items" exist: | itemname | course | gradecategory | | Manual grade 1 | C1 | Category 1 | | Manual grade 2 | C1 | Category 1 | And the following "grade items" exist: | itemname | course | | Manual grade 3 | C1 | @javascript Scenario: Locking and unlocking a grade item preserves individual student locks Given I am on the "Course 1" "grades > Grader report > View" page logged in as "teacher1" And I turn editing mode on And I change window size to "large" When I click on "Manual grade 1" "core_grades > grade_actions" in the "Student 1" "table_row" And I choose "Lock" in the open action menu And I click on grade item menu "Manual grade 1" of type "gradeitem" on "grader" page And I choose "Lock" in the open action menu And I click on grade item menu "Manual grade 1" of type "gradeitem" on "grader" page And I choose "Unlock" in the open action menu Then "Locked" "icon" should exist in the "Student 1" "table_row" And "Locked" "icon" should not exist in the "Student 2" "table_row" @javascript Scenario: Locking and unlocking a grade item through editing form preserves individual student locks Given I am on the "Course 1" "grades > Grader report > View" page logged in as "teacher1" And I turn editing mode on And I change window size to "large" When I click on "Manual grade 1" "core_grades > grade_actions" in the "Student 1" "table_row" And I choose "Edit grade" in the open action menu And I set the field "Locked" to "1" And I press "Save changes" And I click on grade item menu "Manual grade 1" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And I set the field "Locked" to "1" And I click on "Save" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Manual grade 1" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And I set the field "Locked" to "0" And I click on "Save" "button" in the "Edit grade item" "dialogue" Then "Locked" "icon" should exist in the "Student 1" "table_row" And "Locked" "icon" should not exist in the "Student 2" "table_row" report/grader/tests/behat/tertiary_name_filter.feature 0000604 00000025407 15062070557 0017350 0 ustar 00 @core @javascript @gradereport_grader Feature: Within the grader report, test that we can open our generic filter dropdown component In order to filter down the users on the page As a teacher I need to be able to see the filter and select a combination of parameters Background: Given the following "courses" exist: | fullname | shortname | category | groupmode | | Course 1 | C1 | 0 | 1 | And the following "users" exist: | username | firstname | lastname | email | idnumber | | teacher1 | Teacher | 1 | teacher1@example.com | t1 | | student1 | Student | 1 | student1@example.com | s1 | | student2 | Dummy | User | student2@example.com | s2 | | student3 | User | Example | student3@example.com | s3 | | student4 | User | Test | student4@example.com | s4 | | student5 | Turtle | Manatee | student5@example.com | s5 | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | | student2 | C1 | student | | student3 | C1 | student | | student4 | C1 | student | | student5 | C1 | student | And the following "activities" exist: | activity | course | idnumber | name | | assign | C1 | a1 | Test assignment one | And I am on the "Course 1" "grades > Grader report > View" page logged in as "teacher1" Scenario: A teacher can open the filter component Given I should see "Filter by name" When I click on "Filter by name" "combobox" Then I should see "27" node occurrences of type "input" in the "First name" "core_grades > initials bar" And I should see "27" node occurrences of type "input" in the "Last name" "core_grades > initials bar" And "input[data-action=cancel]" "css_element" should exist And "input[data-action=save]" "css_element" should exist Scenario: A teacher can filter the grader report to limit users reported Given I click on "Filter by name" "combobox" And I wait until "input[data-action=save]" "css_element" exists When I select "D" in the "First name" "core_grades > initials bar" And I press "Apply" And I wait to be redirected # We should only have one user that matches the "D" first name Then the following should exist in the "user-grades" table: | -1- | | Dummy User | And the following should not exist in the "user-grades" table: | -1- | | Teacher 1 | | Student 1 | | User Example | | User Test | | Turtle Manatee | # Test filtering on last name # Business logic: If all is selected, we will not show it i.e. First (D) and NOT First (D) Last (All) And I click on "First (D)" "combobox" And I select "All" in the "First name" "core_grades > initials bar" And I select "M" in the "Last name" "core_grades > initials bar" And I press "Apply" And I wait to be redirected # We should only have one user that matches the "T" first name And the following should exist in the "user-grades" table: | -1- | | Turtle Manatee | And the following should not exist in the "user-grades" table: | -1- | | Teacher 1 | | Student 1 | | User Example | | User Test | | Dummy User | # Test filtering on first && last name And I click on "Last (M)" "combobox" And I select "U" in the "First name" "core_grades > initials bar" And I select "T" in the "Last name" "core_grades > initials bar" And I press "Apply" And I wait to be redirected # We should only have one user that matches the "T" first name And the following should exist in the "user-grades" table: | -1- | | User Test | And the following should not exist in the "user-grades" table: | -1- | | Teacher 1 | | Student 1 | | User Example | | Dummy User | | Turtle Manatee | # Final cheeky check to ensure our button matches. And I click on "First (U) Last (T)" "combobox" Scenario: A teacher can quickly tell that a filter is applied to the current table Given I click on "Filter by name" "combobox" And I wait until "input[data-action=save]" "css_element" exists When I select "T" in the "First name" "core_grades > initials bar" And I press "Apply" And I wait to be redirected Then I should see "First (T)" # Check if removing the filter, removes the highlight and user notice of applied filters And I click on "First (T)" "combobox" And I wait until "input[data-action=save]" "css_element" exists And I select "All" in the "First name" "core_grades > initials bar" And I press "Apply" And I wait to be redirected # Check if the name button indicates if a filter is active And I should see "Filter by name" And I should not see "First (T)" Scenario: A teacher can close the filter either by clicking close or clicking off the dropdown Given I click on "Filter by name" "combobox" And "input[data-action=save]" "css_element" should be visible When I click on "input[data-action=cancel]" "css_element" Then "input[data-action=save]" "css_element" should not be visible # Click off the drop down And I click on "Filter by name" "combobox" And "input[data-action=save]" "css_element" should be visible And I click on "First name" "link" in the "gradereport-grader-table" "table" And "input[data-action=save]" "css_element" should not be visible Scenario: A teacher using a language besides english can reset the initials bar Given the following "language customisations" exist: | component | stringid | value | | core | all | すべて | And I click on "Filter by name" "combobox" And "input[data-action=save]" "css_element" should be visible And I select "T" in the "First name" "core_grades > initials bar" And I press "Apply" And I wait to be redirected And I click on "First (T)" "combobox" And I wait until "input[data-action=save]" "css_element" exists When I select "すべて" in the "First name" "core_grades > initials bar" And I press "Apply" And I wait to be redirected Then I should not see "First (すべて) Last (すべて)" And the following should exist in the "user-grades" table: | -1- | | Dummy User | | Student 1 | | User Example | | User Test | | Turtle Manatee | Scenario: A teacher can search and then filter by first or last name Given I set the field "Search users" to "Student 1" And I click on "Student 1" in the "user" search widget And I click on "Filter by name" "combobox" And I select "S" in the "First name" "core_grades > initials bar" When I press "Apply" And the field "Search users" matches value "Student 1" Then the following should exist in the "user-grades" table: | -1- | -1- | -3- | | Student 1 | student1@example.com | - | And the following should not exist in the "user-grades" table: | -1- | -1- | -3- | | Teacher 1 | teacher1@example.com | - | | Dummy User | student2@example.com | - | | User Example | student3@example.com | - | | User Test | student4@example.com | - | | Turtle Manatee | student5@example.com | - | And I click on "First (S)" "combobox" And I select "M" in the "First name" "core_grades > initials bar" And I press "Apply" And the following should not exist in the "user-grades" table: | -1- | -1- | -3- | | Student 1 | student1@example.com | - | | Teacher 1 | teacher1@example.com | - | | Dummy User | student2@example.com | - | | User Example | student3@example.com | - | | User Test | student4@example.com | - | | Turtle Manatee | student5@example.com | - | Scenario: A teacher can search for all users then filter with the initials bar Given I set the field "Search users" to "User" And I click on "View all results (3)" "option_role" And the following should exist in the "user-grades" table: | -1- | -1- | -3- | | User Example | student3@example.com | - | | User Test | student4@example.com | - | | Dummy User | student2@example.com | - | And the following should not exist in the "user-grades" table: | -1- | -1- | -3- | | Student 1 | student1@example.com | - | | Teacher 1 | teacher1@example.com | - | | Turtle Manatee | student5@example.com | - | When I click on "Filter by name" "combobox" And I select "E" in the "Last name" "core_grades > initials bar" And I press "Apply" Then the following should exist in the "user-grades" table: | -1- | -1- | -3- | | User Example | student3@example.com | - | And the following should not exist in the "user-grades" table: | -1- | -1- | -3- | | Student 1 | student1@example.com | - | | Teacher 1 | teacher1@example.com | - | | Dummy User | student2@example.com | - | | User Test | student4@example.com | - | | Turtle Manatee | student5@example.com | - | # This can be expanded for left/right/home & end keys but will have to be done in conjunction with the non mini render. @accessibility Scenario: A teacher can set focus and navigate the filter with the keyboard Given the page should meet accessibility standards And the page should meet "wcag131, wcag141, wcag412" accessibility standards And the page should meet accessibility standards with "wcag131, wcag141, wcag412" extra tests And I click on "Filter by name" "combobox" And "input[data-action=save]" "css_element" should be visible And the focused element is "All" "button" in the "First name" "core_grades > initials bar" When I press the tab key Then the focused element is "input[value=A]" "css_element" in the "First name" "core_grades > initials bar" And I press the tab key And the focused element is "input[value=B]" "css_element" in the "First name" "core_grades > initials bar" report/grader/tests/behat/switch_views.feature 0000604 00000014474 15062070557 0015660 0 ustar 00 @gradereport @gradereport_grader Feature: We can change what we are viewing on the grader report In order to check the expected results are displayed As a teacher I need to assign grades and check that they display correctly in the gradebook when switching between views. Background: Given the following "courses" exist: | fullname | shortname | format | | Course 1 | C1 | topics | And the following "users" exist: | username | firstname | lastname | email | | teacher1 | Teacher | 1 | teacher1@example.com | | student1 | Student | 1 | student1@example.com | | student2 | Student | 2 | student2@example.com | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | | student2 | C1 | student | And the following "activities" exist: | activity | course | section | name | intro | assignsubmission_onlinetext_enabled | submissiondrafts | | assign | C1 | 1 | Test assignment name 1 | Submit your online text | 1 | 0 | | assign | C1 | 1 | Test assignment name 2 | submit your online text | 1 | 0 | And the following "mod_assign > submissions" exist: | assign | user | onlinetext | | Test assignment name 1 | student1 | This is a submission for assignment 1 | | Test assignment name 2 | student1 | This is a submission for assignment 2 | And the following "grade items" exist: | itemname | grademin | grademax | course | | Manual grade | 20 | 40 | C1 | And the following "grade grades" exist: | gradeitem | user | grade | | Test assignment name 1 | student1 | 80 | | Test assignment name 2 | student1 | 90 | | Manual grade | student1 | 30 | And I log in as "teacher1" @javascript Scenario: View and minimise the grader report containing hidden activities When I am on "Course 1" course homepage with editing mode on And I open "Test assignment name 2" actions menu And I choose "Availability > Hide on course page" in the open action menu And I am on "Course 1" course homepage with editing mode off And I navigate to "View > Grader report" in the course gradebook And I should see "Test assignment name 1" in the "user-grades" "table" And I should see "Test assignment name 2" in the "user-grades" "table" And I should see "Manual grade" And I should see "Course total" And the following should exist in the "user-grades" table: | -1- | -1- | -3- | -4- | -5- | -6- | | Student 1 | student1@example.com | 80 | 90 | 30 | 170 | And I click on grade item menu "Course 1" of type "course" on "grader" page And I choose "Show totals only" in the open action menu And I should not see "Test assignment name 1" in the "user-grades" "table" And I should not see "Test assignment name 2" in the "user-grades" "table" And I should not see "Manual grade" And I should see "Course total" And the following should exist in the "user-grades" table: | -1- | -1- | -3- | | Student 1 | student1@example.com | 170 | And I click on grade item menu "Course 1" of type "course" on "grader" page And I click on "Show grades only" "link" And I should see "Test assignment name 1" in the "user-grades" "table" And I should see "Test assignment name 2" in the "user-grades" "table" And I should see "Manual grade" And I should not see "Course total" And the following should exist in the "user-grades" table: | -1- | -1- | -3- | -4- | -5- | | Student 1 | student1@example.com | 80 | 90 | 30 | @javascript @skip_chrome_zerosize Scenario: Minimise the grader report containing hidden activities without the 'moodle/grade:viewhidden' capability Given I am on "Course 1" course homepage with editing mode on And I open "Test assignment name 2" actions menu And I choose "Availability > Hide on course page" in the open action menu And the following "role capability" exists: | role | editingteacher | | moodle/grade:viewhidden | prevent | And I am on the "Course 1" "grades > Grader report > View" page logged in as "teacher1" Then I should see "Test assignment name 1" in the "user-grades" "table" And I should see "Test assignment name 2" in the "user-grades" "table" And I should see "Manual grade" And I should see "Course total" And the following should exist in the "user-grades" table: | -1- | -1- | -3- | -4- | -5- | -6- | | Student 1 | student1@example.com | 80 | - | 30 | 105.71 | And I click on grade item menu "Course 1" of type "course" on "grader" page And I choose "Show totals only" in the open action menu And I should not see "Test assignment name 1" in the "user-grades" "table" And I should not see "Test assignment name 2" in the "user-grades" "table" And I should not see "Manual grade" And I should see "Course total" And the following should exist in the "user-grades" table: | -1- | -1- | -3- | | Student 1 | student1@example.com | 105.71 | And I click on grade item menu "Course 1" of type "course" on "grader" page When I click on "Show grades only" "link" Then I should see "Test assignment name 1" in the "user-grades" "table" And I should see "Test assignment name 2" in the "user-grades" "table" And I should see "Manual grade" And I should not see "Course total" And the following should exist in the "user-grades" table: | -1- | -1- | -3- | -4- | -5- | | Student 1 | student1@example.com | 80 | - | 30 | report/grader/tests/behat/tertiary_navigation_searching.feature 0000604 00000043375 15062070557 0021251 0 ustar 00 @core @core_grades @javascript @gradereport @gradereport_grader Feature: Within the grader report, test that we can search for users In order to find specific users in the course gradebook As a teacher I need to be able to see the search input and trigger the search somehow Background: Given the following "courses" exist: | fullname | shortname | category | groupmode | | Course 1 | C1 | 0 | 1 | And the following "users" exist: | username | firstname | lastname | email | idnumber | phone1 | phone2 | department | institution | city | country | | teacher1 | Teacher | 1 | teacher1@example.com | t1 | 1234567892 | 1234567893 | ABC1 | ABCD | Perth | AU | | student1 | Student | 1 | student1@example.com | s1 | 3213078612 | 8974325612 | ABC1 | ABCD | Hanoi | VN | | student2 | Dummy | User | student2@example.com | s2 | 4365899871 | 7654789012 | ABC2 | ABCD | Tokyo | JP | | student3 | User | Example | student3@example.com | s3 | 3243249087 | 0875421745 | ABC2 | ABCD | Olney | GB | | student4 | User | Test | student4@example.com | s4 | 0987532523 | 2149871323 | ABC3 | ABCD | Tokyo | JP | | student5 | Turtle | Manatee | student5@example.com | s5 | 1239087780 | 9873623589 | ABC3 | ABCD | Perth | AU | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | | student2 | C1 | student | | student3 | C1 | student | | student4 | C1 | student | | student5 | C1 | student | And the following "groups" exist: | name | course | idnumber | | Default group | C1 | dg | And the following "group members" exist: | user | group | | student5 | dg | And the following "activities" exist: | activity | course | idnumber | name | | assign | C1 | a1 | Test assignment one | And the following config values are set as admin: | showuseridentity | idnumber,email,city,country,phone1,phone2,department,institution | And I am on the "Course 1" "grades > Grader report > View" page logged in as "teacher1" And I change window size to "large" Scenario: A teacher can view and trigger the user search # Check the placeholder text Given I should see "Search users" # Confirm the search is currently inactive and results are unfiltered. And the following should exist in the "user-grades" table: | -1- | | Turtle Manatee | | Student 1 | | User Example | | User Test | | Dummy User | And the following should not exist in the "user-grades" table: | -1- | | Teacher 1 | When I set the field "Search users" to "Turtle" And I wait until "View all results (1)" "option_role" exists And I confirm "Turtle Manatee" in "user" search within the gradebook widget exists And I confirm "User Example" in "user" search within the gradebook widget does not exist And I click on "Turtle Manatee" "list_item" # Business case: This will trigger a page reload and can not dynamically update the table. And I wait until the page is ready Then the following should exist in the "user-grades" table: | -1- | | Turtle Manatee | And the following should not exist in the "user-grades" table: | -1- | | Teacher 1 | | Student 1 | | User Example | | User Test | | Dummy User | And I set the field "Search users" to "Turt" And I wait until "View all results (1)" "option_role" exists And I click on "Clear search input" "button" in the ".user-search" "css_element" And "View all results (1)" "option_role" should not be visible Scenario: A teacher can search the grader report to find specified users # Case: Standard search. Given I click on "Dummy" in the "user" search widget And the following should exist in the "user-grades" table: | -1- | | Turtle Manatee | And the following should not exist in the "user-grades" table: | -1- | | Teacher 1 | | Student 1 | | User Example | | User Test | | Dummy User | # Case: No users found. When I set the field "Search users" to "Plagiarism" And I should see "No results for \"Plagiarism\"" # Table remains unchanged as the user had no results to select from the dropdown. And the following should exist in the "user-grades" table: | -1- | | Turtle Manatee | And the following should not exist in the "user-grades" table: | -1- | | Teacher 1 | | Student 1 | | User Example | | User Test | | Dummy User | # Case: Multiple users found and select only one result. Then I set the field "Search users" to "User" And I wait until "View all results (3)" "option_role" exists And I confirm "Dummy User" in "user" search within the gradebook widget exists And I confirm "User Example" in "user" search within the gradebook widget exists And I confirm "User Test" in "user" search within the gradebook widget exists And I confirm "Turtle Manatee" in "user" search within the gradebook widget does not exist # Check if the matched field names (by lines) includes some identifiable info to help differentiate similar users. And I confirm "User (student2@example.com)" in "user" search within the gradebook widget exists And I confirm "User (student3@example.com)" in "user" search within the gradebook widget exists And I confirm "User (student4@example.com)" in "user" search within the gradebook widget exists And I click on "Dummy User" "list_item" And I wait until the page is ready And the following should exist in the "user-grades" table: | -1- | | Dummy User | And the following should not exist in the "user-grades" table: | -1- | | Teacher 1 | | Student 1 | | User Example | | User Test | | Turtle Manatee | # Business case: When searching with multiple partial matches, show the matches in the dropdown + a "View all results for (Bob)" # Business case cont. When pressing enter with multiple partial matches, behave like when you select the "View all results for (Bob)" # Case: Multiple users found and select all partial matches. And I set the field "Search users" to "User" And I wait until "View all results (3)" "option_role" exists # Dont need to check if all users are in the dropdown, we checked that earlier in this test. And I click on "View all results (3)" "option_role" And I wait until the page is ready And the following should exist in the "user-grades" table: | -1- | | Dummy User | | User Example | | User Test | And the following should not exist in the "user-grades" table: | -1- | | Teacher 1 | | Student 1 | | Turtle Manatee | And I click on "Clear" "link" in the ".user-search" "css_element" And I wait until the page is ready And the following should exist in the "user-grades" table: | -1- | | Turtle Manatee | | Student 1 | | User Example | | User Test | | Dummy User | Scenario: A teacher can quickly tell that a search is active on the current table Given I click on "Turtle" in the "user" search widget # The search input remains in the field on reload this is in keeping with other search implementations. When the field "Search users" matches value "Turtle" And I wait until "View all results (1)" "link" does not exist # Test if we can then further retain the turtle result set and further filter from there. Then I set the field "Search users" to "Turtle plagiarism" And "Turtle Manatee" "list_item" should not exist And I should see "No results for \"Turtle plagiarism\"" Scenario: A teacher can search for values besides the users' name Given I set the field "Search users" to "student5@example.com" And I wait until "View all results (1)" "option_role" exists And "Turtle Manatee" "list_item" should exist And I set the field "Search users" to "@example.com" And I wait until "View all results (5)" "option_role" exists # Note: All learners match this email & showing emails is current default. And I confirm "Dummy User" in "user" search within the gradebook widget exists And I confirm "User Example" in "user" search within the gradebook widget exists And I confirm "User Test" in "user" search within the gradebook widget exists And I confirm "Student 1" in "user" search within the gradebook widget exists And I confirm "Turtle Manatee" in "user" search within the gradebook widget exists # Search on the country field. When I set the field "Search users" to "JP" And I wait until "Turtle Manatee" "list_item" does not exist And I confirm "Dummy User" in "user" search within the gradebook widget exists And I confirm "User Test" in "user" search within the gradebook widget exists # Search on the city field. And I set the field "Search users" to "Hanoi" And I wait until "User Test" "list_item" does not exist Then I confirm "Student 1" in "user" search within the gradebook widget exists # Search on the institution field. And I set the field "Search users" to "ABCD" And I wait until "Dummy User" "list_item" exists And I confirm "User Example" in "user" search within the gradebook widget exists And I confirm "User Test" in "user" search within the gradebook widget exists And I confirm "Student 1" in "user" search within the gradebook widget exists And I confirm "Turtle Manatee" in "user" search within the gradebook widget exists # Search on the department field. And I set the field "Search users" to "ABC3" And I wait until "User Example" "list_item" does not exist And I confirm "User Test" in "user" search within the gradebook widget exists And I confirm "Turtle Manatee" in "user" search within the gradebook widget exists # Search on the phone1 field. And I set the field "Search users" to "4365899871" And I wait until "User Test" "list_item" does not exist And I confirm "Dummy User" in "user" search within the gradebook widget exists # Search on the phone2 field. And I set the field "Search users" to "2149871323" And I wait until "Dummy User" "list_item" does not exist And I confirm "User Test" in "user" search within the gradebook widget exists # Search on the institution field then press enter to show the record set. And I set the field "Search users" to "ABC" And I wait until "Turtle Manatee" "list_item" exists And I confirm "Dummy User" in "user" search within the gradebook widget exists And I confirm "User Example" in "user" search within the gradebook widget exists And I confirm "User Test" in "user" search within the gradebook widget exists And I confirm "Student 1" in "user" search within the gradebook widget exists And I press the enter key And I wait until the page is ready And the following should exist in the "user-grades" table: | -1- | | Student 1 | | User Example | | User Test | | Dummy User | | Turtle Manatee | And the following should not exist in the "user-grades" table: | -1- | | Teacher 1 | @accessibility Scenario: A teacher can set focus and search using the input are with a keyboard Given I set the field "Search users" to "ABC" And the focused element is "Search users" "field" And I wait until "Turtle Manatee" "option_role" exists # Basic tests for the page. When the page should meet accessibility standards And the page should meet "wcag131, wcag141, wcag412" accessibility standards And the page should meet accessibility standards with "wcag131, wcag141, wcag412" extra tests And I press the down key And the focused element is "Student 1" "option_role" And I press the end key And the focused element is "View all results (5)" "option_role" And I press the home key And the focused element is "Student 1" "option_role" And I press the up key And the focused element is "View all results (5)" "option_role" And I press the down key And the focused element is "Student 1" "option_role" And I press the escape key And the focused element is "Search users" "field" Then I set the field "Search users" to "Goodmeme" And I press the down key And the focused element is "Search users" "field" And I navigate to "View > Grader report" in the course gradebook And I set the field "Search users" to "ABC" And I wait until "Turtle Manatee" "option_role" exists And I press the down key And the focused element is "Student 1" "option_role" # Lets check the tabbing order. And I set the field "Search users" to "ABC" And I wait until "View all results (5)" "option_role" exists And I press the tab key And the focused element is "Clear search input" "button" And I press the tab key And the focused element is "View all results (5)" "option_role" And I press the tab key And ".groupsearchwidget" "css_element" should exist # Ensure we can interact with the input & clear search options with the keyboard. # Space & Enter have the same handling for triggering the two functionalities. And I set the field "Search users" to "User" And I press the enter key And I wait to be redirected And the following should exist in the "user-grades" table: | -1- | | Dummy User | | User Example | | User Test | And the following should not exist in the "user-grades" table: | -1- | | Teacher 1 | | Student 1 | | Turtle Manatee | # Sometimes with behat we get unattached nodes causing spurious failures. And I wait "1" seconds And I set the field "Search users" to "ABC" And I wait until "Turtle Manatee" "option_role" exists And I press the tab key And the focused element is "Clear search input" "button" And I press the enter key And I wait until the page is ready And I confirm "Turtle Manatee" in "user" search within the gradebook widget does not exist Scenario: Once a teacher searches, it'll apply the currently set filters and inform the teacher as such # Set up a basic filtering case. Given I click on "Filter by name" "combobox" And I select "U" in the "First name" "core_grades > initials bar" And I select "E" in the "Last name" "core_grades > initials bar" And I press "Apply" And I wait until the page is ready And the following should exist in the "user-grades" table: | -1- | | User Example | And the following should not exist in the "user-grades" table: | -1- | | Teacher 1 | | Student 1 | | User Test | | Dummy User | | Turtle Manatee | # Begin the search checking if we are adhering the filters. When I set the field "Search users" to "Turtle" Then I confirm "Turtle Manatee" in "user" search within the gradebook widget does not exist Scenario: A teacher can reset the search and filters all at once Given I set the field "Search users" to "Turtle" And I click on "Turtle Manatee" "option_role" And I wait until the page is ready And the following should exist in the "user-grades" table: | -1- | | Turtle Manatee | And I click on "Filter by name" "combobox" And I select "T" in the "First name" "core_grades > initials bar" And I select "M" in the "Last name" "core_grades > initials bar" And the following should exist in the "user-grades" table: | -1- | | Turtle Manatee | And I click on "Default group" in the "group" search widget And the following should exist in the "user-grades" table: | -1- | | Turtle Manatee | And I wait until the page is ready When I click on "Clear all" "link" in the ".tertiary-navigation" "css_element" And I wait until the page is ready Then the field "Search users" matches value "" Scenario: As a teacher I can dynamically find users whilst ignoring pagination Given "42" "users" exist with the following data: | username | students[count] | | firstname | Student | | lastname | s[count] | | email | students[count]@example.com | And "42" "course enrolments" exist with the following data: | user | students[count] | | course | C1 | | role |student | And I reload the page And the field "perpage" matches value "20" When I set the field "Search users" to "42" # One of the users' phone numbers also matches. And I wait until "View all results (2)" "link" exists Then I confirm "Student s42" in "user" search within the gradebook widget exists report/grader/tests/behat/column_collapsing.feature 0000604 00000044775 15062070557 0016661 0 ustar 00 @core @javascript @gradereport @gradereport_grader Feature: Within the grader report, test that we can collapse columns In order to reduce usage of visual real estate As a teacher I need to be able to change how the report is displayed Background: Given the following "courses" exist: | fullname | shortname | category | groupmode | | Course 1 | C1 | 0 | 1 | And the following "grade categories" exist: | fullname | course | | Some cool grade category | C1 | And the following "custom profile fields" exist: | datatype | shortname | name | | text | enduro | Favourite enduro race | And the following "users" exist: | username | firstname | lastname | email | idnumber | phone1 | phone2 | department | institution | city | country | | teacher1 | Teacher | 1 | teacher1@example.com | t1 | 1234567892 | 1234567893 | ABC1 | ABCD | Perth | AU | | student1 | Student | 1 | student1@example.com | s1 | 3213078612 | 8974325612 | ABC1 | ABCD | Hanoi | VN | | student2 | Dummy | User | student2@example.com | s2 | 4365899871 | 7654789012 | ABC2 | ABCD | Tokyo | JP | | student3 | User | Example | student3@example.com | s3 | 3243249087 | 0875421745 | ABC2 | ABCD | Olney | GB | | student4 | User | Test | student4@example.com | s4 | 0987532523 | 2149871323 | ABC3 | ABCD | Tokyo | JP | | student5 | Turtle | Manatee | student5@example.com | s5 | 1239087780 | 9873623589 | ABC3 | ABCD | Perth | AU | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | | student2 | C1 | student | | student3 | C1 | student | | student4 | C1 | student | | student5 | C1 | student | And the following "activities" exist: | activity | course | idnumber | name | gradecategory | | assign | C1 | a1 | Test assignment one | Some cool grade category | | assign | C1 | a3 | Test assignment three | Some cool grade category | And the following "activities" exist: | activity | course | idnumber | name | | assign | C1 | a2 | Test assignment two | | assign | C1 | a4 | Test assignment four | And the following config values are set as admin: | showuseridentity | idnumber,email,city,country,phone1,phone2,department,institution,profile_field_enduro | And I change window size to "large" And I am on the "Course 1" "grades > Grader report > View" page logged in as "teacher1" Scenario: An admin collapses a user info column and then reloads the page to find the column still collapsed Given I should see "Email" in the "First name / Last name" "table_row" And I click on user profile field menu "Email" And I choose "Collapse" in the open action menu And I should not see "Email" in the "First name / Last name" "table_row" And I click on user profile field menu "profile_field_enduro" And I choose "Collapse" in the open action menu And I should not see "Favourite enduro race" in the "First name / Last name" "table_row" When I reload the page Then I should not see "Email" in the "First name / Last name" "table_row" # Check that the collapsed column is only for the user that set it. And I am on the "Course 1" "Course" page logged in as "admin" And I change window size to "large" And I navigate to "View > Grader report" in the course gradebook And I should see "Email" in the "First name / Last name" "table_row" Scenario: A teacher collapses a grade item column and then reloads the page to find the column still collapsed Given I should see "Test assignment one" in the "First name / Last name" "table_row" And I click on grade item menu "Test assignment one" of type "gradeitem" on "grader" page And I choose "Collapse" in the open action menu And I should not see "Test assignment one</a>" in the "First name / Last name" "table_row" When I reload the page Then I should not see "Test assignment one</a>" in the "First name / Last name" "table_row" Scenario: When a user collapses a column, inform them within the report and tertiary nav area Given I click on grade item menu "Test assignment one" of type "gradeitem" on "grader" page When I choose "Collapse" in the open action menu And I should not see "Test assignment one</a>" in the "First name / Last name" "table_row" Then I should see "Expand column Test assignment one" And I should see "Collapsed columns 1" Scenario: Collapsed columns can have their name searched and triggered to expand but the contents are not searched Given I should see "ID number" in the "First name / Last name" "table_row" And I click on user profile field menu "idnumber" And I choose "Collapse" in the open action menu # Opens the tertiary trigger button. And I click on "Collapsed columns" "combobox" # This is checking that the column name search dropdown exists. And I wait until "Search collapsed columns" "field" exists # Default state contains the collapsed column names. And I should see "ID number" # Search for a column that was not hidden. When I set the field "Search collapsed columns" to "Email" And I should see "No results for \"Email\"" # Search for a ID number value inside the column that was hidden. Then I set the field "Search collapsed columns" to "s5" And I should see "No results for \"s5\"" # Search for a column that was hidden. And I set the field "Search collapsed columns" to "ID" And I should see "ID number" Scenario: Expand multiple columns at once Given I click on grade item menu "Test assignment one" of type "gradeitem" on "grader" page And I choose "Collapse" in the open action menu And I click on grade item menu "Test assignment two" of type "gradeitem" on "grader" page And I choose "Collapse" in the open action menu And I click on grade item menu "Test assignment three" of type "gradeitem" on "grader" page And I choose "Collapse" in the open action menu And I click on grade item menu "Test assignment four" of type "gradeitem" on "grader" page And I choose "Collapse" in the open action menu And I click on user profile field menu "Email" And I choose "Collapse" in the open action menu And I click on user profile field menu "Phone1" And I choose "Collapse" in the open action menu And I click on "Collapsed columns" "combobox" # This is checking that the column name search dropdown exists. When I wait until "Search collapsed columns" "field" exists And I click on "Test assignment one" "option_role" in the "form" "gradereport_grader > collapse search" And I click on "Test assignment three" "option_role" in the "form" "gradereport_grader > collapse search" And I click on "Phone" "option_role" in the "form" "gradereport_grader > collapse search" And I click on "Expand" "button" in the "form" "gradereport_grader > collapse search" Then I should see "Test assignment one" in the "First name / Last name" "table_row" And I should see "Test assignment three" in the "First name / Last name" "table_row" And I should see "Phone" in the "First name / Last name" "table_row" And I should not see "Email" in the "First name / Last name" "table_row" # Add in the closing tag so that the reopen button does not cause a false flag. And I should not see "Test assignment two</a>" in the "First name / Last name" "table_row" And I should not see "Test assignment four</a>" in the "First name / Last name" "table_row" Scenario: If there is only one collapsed column it expands Given I click on user profile field menu "Email" And I choose "Collapse" in the open action menu And I should not see "Email" in the "First name / Last name" "table_row" And I hover "Expand column email" "button" When I press "Expand column email" Then I should see "Email" in the "First name / Last name" "table_row" Scenario: When a grade item is collapsed, the grade category is shown alongside the column name. Given I click on grade item menu "Test assignment one" of type "gradeitem" on "grader" page And I choose "Collapse" in the open action menu And I click on grade item menu "Test assignment two" of type "gradeitem" on "grader" page And I choose "Collapse" in the open action menu And I click on user profile field menu "Email" And I choose "Collapse" in the open action menu And I should not see "Test assignment one</a>" in the "First name / Last name" "table_row" And I should not see "Test assignment two</a>" in the "First name / Last name" "table_row" And I should not see "Email" in the "First name / Last name" "table_row" # Opens the tertiary trigger button. When I click on "Collapsed columns" "combobox" # This is checking that the column name search dropdown exists. And I wait until "Search collapsed columns" "field" exists # Add ordering test as well. And I should see "Test assignment one" in the "form" "gradereport_grader > collapse search" And I should see "Some cool grade category" in the "form" "gradereport_grader > collapse search" And I should see "Test assignment two" in the "form" "gradereport_grader > collapse search" And I should see "Course 1" in the "form" "gradereport_grader > collapse search" And I should see "Email" in the "form" "gradereport_grader > collapse search" And I should not see "Category div" in the "form" "gradereport_grader > collapse search" Scenario: Toggling edit mode should not show all collapsed columns Given I click on user profile field menu "Email" And I choose "Collapse" in the open action menu And I should not see "Email" in the "First name / Last name" "table_row" When I turn editing mode on And I wait until the page is ready Then I should not see "Email" in the "First name / Last name" "table_row" Scenario: Resulting columns from hidden grade categories cant be collapsed # Hiding columns already tested elsewhere, これはこれ、それはそれ。 Given I click on grade item menu "Some cool grade category" of type "category" on "grader" page And I choose "Show totals only" in the open action menu And I should not see "Test assignment name 1" And I should see "Some cool grade category total" When I click on grade item menu "Some cool grade category" of type "category" on "grader" page Then I should not see "Collapse" in the ".dropdown-menu.show" "css_element" @accessibility Scenario: A teacher can manipulate the report display in an accessible way # Hide a bunch of columns. Given I click on user profile field menu "Email" And I choose "Collapse" in the open action menu And I click on user profile field menu "Phone1" And I choose "Collapse" in the open action menu And I click on user profile field menu "Phone2" And I choose "Collapse" in the open action menu And I click on user profile field menu "Country" And I choose "Collapse" in the open action menu # Basic tests for the page. When I click on "Collapsed columns" "combobox" And the page should meet accessibility standards And the page should meet "wcag131, wcag141, wcag412" accessibility standards And the page should meet accessibility standards with "wcag131, wcag141, wcag412" extra tests # Move onto general keyboard navigation testing. Then the focused element is "Search collapsed columns" "field" And I press the down key And the focused element is "Email address" "option_role" And I press the end key And the focused element is "Country" "option_role" And I press the home key And the focused element is "Email address" "option_role" And I press the up key And the focused element is "Country" "option_role" And I press the down key And the focused element is "Email address" "option_role" And I press the end key And I press the tab key And the focused element is "Select all" "checkbox" And I press the escape key And the focused element is "Collapsed columns" "combobox" And I click on "Collapsed columns" "combobox" Then I set the field "Search collapsed columns" to "Goodmeme" And I wait until "No results for \"Goodmeme\"" "text" exists And I press the down key And the focused element is "Search collapsed columns" "field" # Lets check the tabbing order. And I set the field "Search collapsed columns" to "phone" And I wait until "Mobile phone" "option_role" exists And I press the tab key And the focused element is "Clear search input" "button" in the ".dropdown-menu.show" "css_element" And I press the tab key And I press the tab key And I press the tab key And I press the tab key And the focused element is "Close" "button" in the ".dropdown-menu.show" "css_element" And I press the tab key # The course grade category menu. And the focused element is "Cell actions" "button" # Tab over to the collapsed columns. And I click on user profile field menu "city" And I press the escape key And I press the tab key And the focused element is "Expand column country" "button" And I press the enter key And I press the tab key And the focused element is "Expand column phone1" "button" And I press the enter key And I should not see "Email" in the "First name / Last name" "table_row" And I should see "Phone" in the "First name / Last name" "table_row" And I should not see "Mobile phone" in the "First name / Last name" "table_row" And I should see "Country" in the "First name / Last name" "table_row" # Ensure that things did not start failing after we did some manipulation. And the page should meet accessibility standards And the page should meet "wcag131, wcag141, wcag412" accessibility standards And the page should meet accessibility standards with "wcag131, wcag141, wcag412" extra tests Scenario: Collapsed columns persist across paginated pages # Hide a bunch of columns. Given I click on user profile field menu "Email" And I choose "Collapse" in the open action menu And I click on user profile field menu "Phone1" And I choose "Collapse" in the open action menu And I click on user profile field menu "Phone2" And I choose "Collapse" in the open action menu And I click on user profile field menu "Country" And I choose "Collapse" in the open action menu # Ensure we are ready to move onto the next step. When I should see "Collapsed columns 4" # Confirm our columns are hidden. And I should not see "Email" in the "First name / Last name" "table_row" And I should not see "Phone" in the "First name / Last name" "table_row" And I should not see "Mobile phone" in the "First name / Last name" "table_row" And I should not see "Country" in the "First name / Last name" "table_row" # Navigate to the next paginated page and ensure our columns are still hidden. Then I set the field "perpage" to "100" And I should see "Collapsed columns 4" And I should not see "Email" in the "First name / Last name" "table_row" And I should not see "Phone" in the "First name / Last name" "table_row" And I should not see "Mobile phone" in the "First name / Last name" "table_row" And I should not see "Country" in the "First name / Last name" "table_row" Scenario: If a column is actively sorted and then collapsed the active sort on the page should become First name # This behaviour is inline with other tables where we collapse columns that are sortable. Given I click on user profile field menu "Email" And I choose "Descending" in the open action menu And I wait to be redirected And I click on user profile field menu "Email" When I choose "Collapse" in the open action menu And I wait to be redirected And I should not see "Email" in the "First name / Last name" "table_row" Then "Dummy User" "table_row" should appear before "Student 1" "table_row" And "Student 1" "table_row" should appear before "Turtle Manatee" "table_row" And "Turtle Manatee" "table_row" should appear before "User Example" "table_row" Scenario: If multiple columns are collapsed, then all the user to expand all of them at once # Hide a bunch of columns. Given I click on user profile field menu "Email" And I choose "Collapse" in the open action menu And I click on user profile field menu "Phone1" And I choose "Collapse" in the open action menu And I click on user profile field menu "Phone2" And I choose "Collapse" in the open action menu And I click on user profile field menu "Country" And I choose "Collapse" in the open action menu # Ensure we are ready to move onto the next step. And I wait until "Collapsed columns" "combobox" exists When I click on "Collapsed columns" "combobox" And I click on "Select all" "checkbox" And I click on "Expand" "button" in the "form" "gradereport_grader > collapse search" # All of the previously collapsed columns should now be visible. Then I should see "Email" in the "First name / Last name" "table_row" And I should see "Phone" in the "First name / Last name" "table_row" And I should see "Mobile phone" in the "First name / Last name" "table_row" And I should see "Country" in the "First name / Last name" "table_row" Scenario: If multiple columns are collapsed, when selecting all and then unselecting an option, the select all is then unchecked # Hide some columns. Given I click on user profile field menu "Email" And I choose "Collapse" in the open action menu And I click on user profile field menu "Country" And I choose "Collapse" in the open action menu # Ensure we are ready to move onto the next step. And I wait until "Collapsed columns" "combobox" exists When I click on "Collapsed columns" "combobox" And I click on "Select all" "checkbox" And I click on "Email" "option_role" in the "form" "gradereport_grader > collapse search" # The select all option should now be unchecked, Checking the form or option role is iffy with behat so we use the id. Then "input#check-all-input:not([checked=checked])" "css_element" should exist report/grader/tests/behat/pagination.feature 0000604 00000010077 15062070557 0015266 0 ustar 00 @gradereport @gradereport_grader Feature: grader report pagination In order to consume the content of the report better As a teacher I need the report to be paginated Background: Given the following "courses" exist: | fullname | shortname | | Course 1 | C1 | And the following "users" exist: | username | firstname | lastname | email | | teacher1 | Teacher | 1 | teacher1@example.com | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | @javascript Scenario: Default is used when teachers have no preference yet Given "41" "users" exist with the following data: | username | student[count] | | firstname | Student | | lastname | [count] | | email | student[count]@example.com | And "41" "course enrolments" exist with the following data: | user | student[count] | | course | C1 | | role |student | When I am on the "Course 1" "Course" page logged in as "teacher1" And I navigate to "View > Grader report" in the course gradebook Then the field "perpage" matches value "20" # Add 3 to the expected number because there are 2 header and 1 footer rows. And I should see "23" node occurrences of type "tr" in the "user-grades" "table" And I should see "3" in the ".stickyfooter .pagination" "css_element" And I should not see "4" in the ".stickyfooter .pagination" "css_element" @javascript Scenario: Teachers can have their preference for the number of students Given the following "courses" exist: | fullname | shortname | | Course 2 | C2 | And the following "course enrolments" exist: | user | course | role | | teacher1 | C2 | editingteacher | When I am on the "Course 1" "Course" page logged in as "teacher1" And I navigate to "View > Grader report" in the course gradebook And I set the field "perpage" to "100" And I am on the "Course 2" "Course" page And I navigate to "View > Grader report" in the course gradebook Then the field "perpage" matches value "100" @javascript Scenario: Teachers can change the number of students shown on the report Given "101" "users" exist with the following data: | username | student[count] | | firstname | Student | | lastname | [count] | | email | student[count]@example.com | And "101" "course enrolments" exist with the following data: | user | student[count] | | course | C1 | | role |student | When I am on the "Course 1" "Course" page logged in as "teacher1" And I navigate to "View > Grader report" in the course gradebook And I set the field "perpage" to "100" # Add 3 to the expected number because there are 2 header and 1 footer rows. Then I should see "103" node occurrences of type "tr" in the "user-grades" "table" And I should see "2" in the ".stickyfooter .pagination" "css_element" And I should not see "3" in the ".stickyfooter .pagination" "css_element" @javascript Scenario: The pagination bar is only displayed when there is more than one page Given "21" "users" exist with the following data: | username | student[count] | | firstname | Student | | lastname | [count] | | email | student[count]@example.com | And "21" "course enrolments" exist with the following data: | user | student[count] | | course | C1 | | role |student | When I am on the "Course 1" "Course" page logged in as "teacher1" And I navigate to "View > Grader report" in the course gradebook # By default, we have 20 students per page. Then ".stickyfooter .pagination" "css_element" should exist And I set the field "perpage" to "100" Then ".stickyfooter .pagination" "css_element" should not exist report/grader/tests/privacy/provider_test.php 0000604 00000011050 15062070557 0015544 0 ustar 00 <?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/>. /** * Unit tests for the gradereport_grader implementation of the privacy API. * * @package gradereport_grader * @category test * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradereport_grader\privacy; defined('MOODLE_INTERNAL') || die(); use core_privacy\local\metadata\collection; use core_privacy\local\request\writer; use core_privacy\local\request\approved_contextlist; use core_privacy\local\request\deletion_criteria; use gradereport_grader\privacy\provider; /** * Unit tests for the gradereport_grader implementation of the privacy API. * * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class provider_test extends \core_privacy\tests\provider_testcase { /** * Basic setup for these tests. */ public function setUp(): void { $this->resetAfterTest(true); } /** * Ensure that export_user_preferences returns no data if the user has no data. */ public function test_export_user_preferences_not_defined() { $user = \core_user::get_user_by_username('admin'); provider::export_user_preferences($user->id); $writer = writer::with_context(\context_system::instance()); $this->assertFalse($writer->has_any_data()); } /** * Ensure that export_user_preferences returns single preferences. * These preferences can be set on each course, but the value is shared in the whole site. */ public function test_export_user_preferences_single() { // Create test user, add some preferences. $user = $this->getDataGenerator()->create_user(); $this->setUser($user); set_user_preference('grade_report_meanselection', GRADE_REPORT_MEAN_GRADED, $user); set_user_preference('grade_report_studentsperpage', 50, $user); // Switch to admin user (so we can validate preferences of our test user are still exported). $this->setAdminUser(); // Validate exported data for our test user. provider::export_user_preferences($user->id); $context = \context_user::instance($user->id); /** @var \core_privacy\tests\request\content_writer $writer */ $writer = writer::with_context($context); $this->assertTrue($writer->has_any_data()); $prefs = $writer->get_user_preferences('gradereport_grader'); $this->assertCount(2, (array) $prefs); $this->assertEquals(get_string('meangraded', 'grades'), $prefs->grade_report_meanselection->value); $this->assertEquals(50, $prefs->grade_report_studentsperpage->value); } /** * Ensure that export_user_preferences returns preferences. */ public function test_export_user_preferences_multiple() { // Create a course and add a user preference. $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $course = $this->getDataGenerator()->create_course(); $collapsed = serialize(['aggregatesonly' => array(), 'gradesonly' => array()]); set_user_preference('grade_report_grader_collapsed_categories'.$course->id, $collapsed, $user); // Validate exported data. provider::export_user_preferences($user->id); $context = \context_user::instance($user->id); /** @var \core_privacy\tests\request\content_writer $writer */ $writer = writer::with_context($context); $this->assertTrue($writer->has_any_data()); $prefs = $writer->get_user_preferences('gradereport_grader'); $this->assertCount(1, (array) $prefs); $this->assertEquals( get_string('privacy:request:preference:grade_report_grader_collapsed_categories', 'gradereport_grader', ['name' => $course->fullname]), $prefs->grade_report_grader_collapsed_categories->description ); } } report/grader/preferences.php 0000604 00000005071 15062070557 0012343 0 ustar 00 <?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/>. /** * Grader report preferences configuration page * * @package gradereport_grader * @copyright 2007 Nicolas Connault * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once '../../../config.php'; require_once $CFG->libdir . '/gradelib.php'; require_once '../../lib.php'; core_php_time_limit::raise(); $courseid = required_param('id', PARAM_INT); $PAGE->set_url(new moodle_url('/grade/report/grader/preferences.php', array('id'=>$courseid))); $PAGE->set_pagelayout('admin'); /// Make sure they can even access this course if (!$course = $DB->get_record('course', array('id' => $courseid))) { throw new \moodle_exception('invalidcourseid'); } require_login($course); $context = context_course::instance($course->id); $systemcontext = context_system::instance(); require_capability('gradereport/grader:view', $context); require('preferences_form.php'); $mform = new grader_report_preferences_form('preferences.php', compact('course')); // If data submitted, then process and store. if ($data = $mform->get_data()) { foreach ($data as $preference => $value) { if (substr($preference, 0, 6) !== 'grade_') { continue; } if ($value == GRADE_REPORT_PREFERENCE_DEFAULT || strlen($value) == 0) { unset_user_preference($preference); } else { set_user_preference($preference, $value); } } } print_grade_page_head($courseid, 'settings', 'grader'); // If USER has admin capability, print a link to the site config page for this report if (has_capability('moodle/site:config', $systemcontext)) { echo '<div id="siteconfiglink"><a href="'.$CFG->wwwroot.'/'.$CFG->admin.'/settings.php?section=gradereportgrader">'; echo get_string('changereportdefaults', 'grades'); echo "</a></div>\n"; } echo $OUTPUT->box_start(); $mform->display(); echo $OUTPUT->box_end(); echo $OUTPUT->footer(); report/grader/index.php 0000604 00000022005 15062070557 0011145 0 ustar 00 <?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/>. /** * The gradebook grader report * * @package gradereport_grader * @copyright 2007 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once('../../../config.php'); require_once($CFG->libdir.'/gradelib.php'); require_once($CFG->dirroot.'/user/renderer.php'); require_once($CFG->dirroot.'/grade/lib.php'); require_once($CFG->dirroot.'/grade/report/grader/lib.php'); $courseid = required_param('id', PARAM_INT); // course id $page = optional_param('page', 0, PARAM_INT); // active page $edit = optional_param('edit', -1, PARAM_BOOL); // sticky editting mode $sortitemid = optional_param('sortitemid', 0, PARAM_ALPHANUMEXT); $sort = optional_param('sort', '', PARAM_ALPHA); $action = optional_param('action', 0, PARAM_ALPHAEXT); $move = optional_param('move', 0, PARAM_INT); $type = optional_param('type', 0, PARAM_ALPHA); $target = optional_param('target', 0, PARAM_ALPHANUM); $toggle = optional_param('toggle', null, PARAM_INT); $toggle_type = optional_param('toggle_type', 0, PARAM_ALPHANUM); $graderreportsifirst = optional_param('sifirst', null, PARAM_NOTAGS); $graderreportsilast = optional_param('silast', null, PARAM_NOTAGS); $studentsperpage = optional_param('perpage', null, PARAM_INT); $PAGE->set_url(new moodle_url('/grade/report/grader/index.php', array('id'=>$courseid))); $PAGE->set_pagelayout('report'); $PAGE->requires->js_call_amd('gradereport_grader/stickycolspan', 'init'); $PAGE->requires->js_call_amd('gradereport_grader/user', 'init'); $PAGE->requires->js_call_amd('gradereport_grader/feedback_modal', 'init'); $PAGE->requires->js_call_amd('core_grades/gradebooksetup_forms', 'init'); // basic access checks if (!$course = $DB->get_record('course', array('id' => $courseid))) { throw new \moodle_exception('invalidcourseid'); } // Conditionally add the group JS if we have groups enabled. if ($course->groupmode) { $PAGE->requires->js_call_amd('gradereport_grader/group', 'init'); } require_login($course); $context = context_course::instance($course->id); // The report object is recreated each time, save search information to SESSION object for future use. if (isset($graderreportsifirst)) { $SESSION->gradereport["filterfirstname-{$context->id}"] = $graderreportsifirst; } if (isset($graderreportsilast)) { $SESSION->gradereport["filtersurname-{$context->id}"] = $graderreportsilast; } if (isset($studentsperpage) && $studentsperpage >= 0) { set_user_preference('grade_report_studentsperpage', $studentsperpage); } require_capability('gradereport/grader:view', $context); require_capability('moodle/grade:viewall', $context); // return tracking object $gpr = new grade_plugin_return( array( 'type' => 'report', 'plugin' => 'grader', 'course' => $course, 'page' => $page ) ); // last selected report session tracking if (!isset($USER->grade_last_report)) { $USER->grade_last_report = array(); } $USER->grade_last_report[$course->id] = 'grader'; // Build editing on/off buttons. $buttons = ''; $PAGE->set_other_editing_capability('moodle/grade:edit'); if ($PAGE->user_allowed_editing() && !$PAGE->theme->haseditswitch) { if ($edit != - 1) { $USER->editing = $edit; } // Page params for the turn editing on button. $options = $gpr->get_options(); $buttons = $OUTPUT->edit_button(new moodle_url($PAGE->url, $options), 'get'); } $gradeserror = array(); // Handle toggle change request if (!is_null($toggle) && !empty($toggle_type)) { set_user_preferences(array('grade_report_show'.$toggle_type => $toggle)); } // Perform actions if (!empty($target) && !empty($action) && confirm_sesskey()) { grade_report_grader::do_process_action($target, $action, $courseid); } $reportname = get_string('pluginname', 'gradereport_grader'); // Do this check just before printing the grade header (and only do it once). grade_regrade_final_grades_if_required($course); //Initialise the grader report object that produces the table //the class grade_report_grader_ajax was removed as part of MDL-21562 if ($sort && strcasecmp($sort, 'desc') !== 0) { $sort = 'asc'; } // We have lots of hardcoded 'ASC' and 'DESC' strings in grade/report/grader.lib :(. So we need to uppercase the sort. $sort = strtoupper($sort); $report = new grade_report_grader($courseid, $gpr, $context, $page, $sortitemid, $sort); // We call this a little later since we need some info from the grader report. $PAGE->requires->js_call_amd('gradereport_grader/collapse', 'init', [ 'userID' => $USER->id, 'courseID' => $courseid, 'defaultSort' => $report->get_default_sortable() ]); $numusers = $report->get_numusers(true, true); $actionbar = new \gradereport_grader\output\action_bar($context, $report, $numusers); print_grade_page_head($COURSE->id, 'report', 'grader', false, false, $buttons, true, null, null, null, $actionbar); // make sure separate group does not prevent view if ($report->currentgroup == -2) { echo $OUTPUT->heading(get_string("notingroup")); echo $OUTPUT->footer(); exit; } $warnings = []; $isediting = has_capability('moodle/grade:edit', $context) && isset($USER->editing) && $USER->editing; if ($isediting && ($data = data_submitted()) && confirm_sesskey()) { // Processing posted grades here. $warnings = $report->process_data($data); } // Final grades MUST be loaded after the processing. $report->load_users(); $report->load_final_grades(); //show warnings if any foreach ($warnings as $warning) { echo $OUTPUT->notification($warning); } $displayaverages = true; if ($numusers == 0) { $displayaverages = false; } $reporthtml = $report->get_grade_table($displayaverages); $studentsperpage = $report->get_students_per_page(); // Print per-page dropdown. $pagingoptions = grade_report_grader::PAGINATION_OPTIONS; if ($studentsperpage) { $pagingoptions[] = $studentsperpage; // To make sure the current preference is within the options. } $pagingoptions = array_unique($pagingoptions); sort($pagingoptions); $pagingoptions = array_combine($pagingoptions, $pagingoptions); if ($numusers > grade_report_grader::MAX_STUDENTS_PER_PAGE) { $pagingoptions['0'] = grade_report_grader::MAX_STUDENTS_PER_PAGE; } else { $pagingoptions['0'] = get_string('all'); } $perpagedata = [ 'baseurl' => new moodle_url('/grade/report/grader/index.php', ['id' => s($courseid), 'report' => 'grader']), 'options' => [] ]; foreach ($pagingoptions as $key => $name) { $perpagedata['options'][] = [ 'name' => $name, 'value' => $key, 'selected' => $key == $studentsperpage, ]; } $footercontent = html_writer::div( $OUTPUT->render_from_template('gradereport_grader/perpage', $perpagedata) , 'col-auto' ); // The number of students per page is always limited even if it is claimed to be unlimited. $studentsperpage = $studentsperpage ?: grade_report_grader::MAX_STUDENTS_PER_PAGE; $footercontent .= html_writer::div( $OUTPUT->paging_bar($numusers, $report->page, $studentsperpage, $report->pbarurl), 'col' ); // print submit button if (!empty($USER->editing) && $report->get_pref('quickgrading')) { echo '<form action="index.php" enctype="application/x-www-form-urlencoded" method="post" id="gradereport_grader">'; // Enforce compatibility with our max_input_vars hack. echo '<div>'; echo '<input type="hidden" value="'.s($courseid).'" name="id" />'; echo '<input type="hidden" value="'.sesskey().'" name="sesskey" />'; echo '<input type="hidden" value="'.time().'" name="timepageload" />'; echo '<input type="hidden" value="grader" name="report"/>'; echo '<input type="hidden" value="'.$page.'" name="page"/>'; echo $gpr->get_form_fields(); echo $reporthtml; $footercontent .= html_writer::div( '<input type="submit" id="gradersubmit" class="btn btn-primary" value="'.s(get_string('savechanges')).'" />', 'col-auto' ); $stickyfooter = new core\output\sticky_footer($footercontent); echo $OUTPUT->render($stickyfooter); echo '</div></form>'; } else { echo $reporthtml; $stickyfooter = new core\output\sticky_footer($footercontent); echo $OUTPUT->render($stickyfooter); } $event = \gradereport_grader\event\grade_report_viewed::create( array( 'context' => $context, 'courseid' => $courseid, ) ); $event->trigger(); echo $OUTPUT->footer(); report/grader/lang/en/gradereport_grader.php 0000604 00000014372 15062070557 0015233 0 ustar 00 <?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/>. /** * Strings for component 'gradereport_grader', language 'en' * * @package gradereport_grader * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ $string['aria:dropdowncolumns'] = 'Collapsed columns found'; $string['clearall'] = 'Clear all'; $string['clearsearch'] = 'Clear searched users'; $string['collapsedcolumns'] = 'Collapsed columns <span class="badge badge-pill badge-primary ml-1" data-collapse="count">{$a}</span>'; $string['eventgradereportviewed'] = 'Grader report viewed'; $string['grader:manage'] = 'Manage the grader report'; $string['grader:view'] = 'View grader report'; $string['pluginname'] = 'Grader report'; $string['preferences'] = 'Grader report preferences'; $string['privacy:metadata:preference:grade_report_aggregationposition'] = 'Whether the category and course total columns are displayed first or last in the gradebook reports'; $string['privacy:metadata:preference:grade_report_averagesdecimalpoints'] = 'The number of decimal places to display for each average or whether the overall decimal places setting for the category or grade item is used (inherit).'; $string['privacy:metadata:preference:grade_report_averagesdisplaytype'] = 'Whether the average (mean) is displayed as real grades, percentages or letters, or whether the display type for the category or grade item is used (inherit).'; $string['privacy:metadata:preference:grade_report_grader_collapsed_categories'] = 'List of gradebook categories to be collapsed'; $string['privacy:metadata:preference:grade_report_meanselection'] = 'Whether cells with no grade should be included when calculating the average (mean) for each category or grade item'; $string['privacy:metadata:preference:grade_report_quickgrading'] = 'Whether to display a text input box for each grade, allowing many grades to be edited at the same time'; $string['privacy:metadata:preference:grade_report_rangesdecimalpoints'] = 'The number of decimal places to display for each range or whether the overall decimal places setting for the category or grade item is used (inherit)'; $string['privacy:metadata:preference:grade_report_rangesdisplaytype'] = 'Whether the range is displayed as real grades, percentages or letters, or whether the display type for the category or grade item is used (inherit)'; $string['privacy:metadata:preference:grade_report_showaverages'] = 'Whether to display an additional row with the average (mean) for each category and grade item'; $string['privacy:metadata:preference:grade_report_shownumberofgrades'] = 'Whether to display in brackets after each average the number of grades used when calculating the average'; $string['privacy:metadata:preference:grade_report_showonlyactiveenrol'] = 'Whether to display only active enrolled users (not suspended) in gradebook report or all the enrolled users'; $string['privacy:metadata:preference:grade_report_showranges'] = 'Whether to display an additional row with the range for each category and grade item'; $string['privacy:metadata:preference:grade_report_showuserimage'] = 'Whether to show the user\'s profile image next to the name'; $string['privacy:metadata:preference:grade_report_studentsperpage'] = 'The number of students displayed per page in the grader report'; $string['privacy:request:preference:grade_report_grader_collapsed_categories'] = 'You have some gradebook categories collapsed in the "{$a->name}" course'; $string['reopencolumn'] = 'Expand column {$a}'; $string['summarygrader'] = 'A table with the names of students in the first column, with assessable activities grouped by course and category across the top.'; $string['useractivitygrade'] = '{$a} grade'; $string['overriddengrade'] = 'Overridden grade'; $string['advancedgrading'] = 'View {$a} results'; $string['cellactions'] = 'Cell actions'; // Deprecated since Moodle 4.2. $string['privacy:metadata:preference:grade_report_showanalysisicon'] = 'Whether to show grade analysis icon by default. If the activity module supports it, the grade analysis icon links to a page with more detailed explanation of the grade and how it was obtained.'; $string['privacy:metadata:preference:grade_report_showeyecons'] = 'Whether to display the show/hide icon for each grade for controlling its visibility to the student'; $string['privacy:metadata:preference:grade_report_showlocks'] = 'Whether to display a lock/unlock icon for each grade for controlling if the grade can be automatically updated by the related activity when editing is turned on'; $string['privacy:metadata:preference:grade_report_showquickfeedback'] = 'Whether to display a feedback text input box with a dotted border for each grade, allowing the feedback for many grades to be edited at the same time'; $string['privacy:metadata:preference:grade_report_enableajax'] = 'Whether to add a layer of AJAX functionality to the grader report, simplifying and speeding up common operations'; $string['useractivityfeedback'] = '{$a} feedback'; $string['ajaxclicktoclose'] = 'Click this box to remove it'; $string['ajaxerror'] = 'Error'; $string['ajaxfailedupdate'] = 'Unable to update [1] for [2]'; $string['ajaxfieldchanged'] = 'The field you are currently editing has changed, would you like to use the updated value?'; $string['ajaxchoosescale'] = 'Choose'; $string['privacy:metadata:preference:grade_report_showactivityicons'] = 'Whether to show the activity icons next to activity names'; $string['privacy:metadata:preference:grade_report_showcalculations'] = 'Whether a calculator icon for each grade item and category with a visual indicator that a grade item is calculated is displayed or not when editing is turned on'; report/grader/lang/en/deprecated.txt 0000604 00000001337 15062070557 0013516 0 ustar 00 privacy:metadata:preference:grade_report_showquickfeedback,gradereport_grader useractivityfeedback,gradereport_grader privacy:metadata:preference:grade_report_enableajax,gradereport_grader ajaxclicktoclose,gradereport_grader ajaxerror,gradereport_grader ajaxfailedupdate,gradereport_grader ajaxfieldchanged,gradereport_grader ajaxchoosescale,gradereport_grader privacy:metadata:preference:grade_report_showeyecons,gradereport_grader privacy:metadata:preference:grade_report_showlocks,gradereport_grader privacy:metadata:preference:grade_report_showanalysisicon,gradereport_grader privacy:metadata:preference:grade_report_showactivityicons,gradereport_grader privacy:metadata:preference:grade_report_showcalculations,gradereport_grader report/grader/README.txt 0000604 00000000070 15062070557 0011021 0 ustar 00 The default gradebook interface that teachers will use. report/grader/settings.php 0000604 00000013306 15062070557 0011702 0 ustar 00 <?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/>. /** * Defines site config settings for the grader report * * @package gradereport_grader * @copyright 2007 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die; if ($ADMIN->fulltree) { $strinherit = get_string('inherit', 'grades'); $strpercentage = get_string('percentage', 'grades'); $strreal = get_string('real', 'grades'); $strletter = get_string('letter', 'grades'); $settings->add(new admin_setting_configcheckbox('grade_report_showonlyactiveenrol', get_string('showonlyactiveenrol', 'grades'), get_string('showonlyactiveenrol_help', 'grades'), 1)); $settings->add(new admin_setting_configcheckbox('grade_report_quickgrading', get_string('quickgrading', 'grades'), get_string('quickgrading_help', 'grades'), 1)); $settings->add(new admin_setting_configselect('grade_report_meanselection', get_string('meanselection', 'grades'), get_string('meanselection_help', 'grades'), GRADE_REPORT_MEAN_GRADED, array(GRADE_REPORT_MEAN_ALL => get_string('meanall', 'grades'), GRADE_REPORT_MEAN_GRADED => get_string('meangraded', 'grades')))); $settings->add(new admin_setting_configcheckbox('grade_report_showaverages', get_string('showaverages', 'grades'), get_string('showaverages_help', 'grades'), 1)); $settings->add(new admin_setting_configcheckbox('grade_report_showranges', get_string('showranges', 'grades'), get_string('showranges_help', 'grades'), 0)); $settings->add(new admin_setting_configcheckbox('grade_report_showuserimage', get_string('showuserimage', 'grades'), get_string('showuserimage_help', 'grades'), 1)); $settings->add(new admin_setting_configcheckbox('grade_report_shownumberofgrades', get_string('shownumberofgrades', 'grades'), get_string('shownumberofgrades_help', 'grades'), 0)); $settings->add(new admin_setting_configselect('grade_report_averagesdisplaytype', get_string('averagesdisplaytype', 'grades'), get_string('averagesdisplaytype_help', 'grades'), GRADE_REPORT_PREFERENCE_INHERIT, array(GRADE_REPORT_PREFERENCE_INHERIT => $strinherit, GRADE_DISPLAY_TYPE_REAL => $strreal, GRADE_DISPLAY_TYPE_PERCENTAGE => $strpercentage, GRADE_DISPLAY_TYPE_LETTER => $strletter))); $settings->add(new admin_setting_configselect('grade_report_rangesdisplaytype', get_string('rangesdisplaytype', 'grades'), get_string('rangesdisplaytype_help', 'grades'), GRADE_REPORT_PREFERENCE_INHERIT, array(GRADE_REPORT_PREFERENCE_INHERIT => $strinherit, GRADE_DISPLAY_TYPE_REAL => $strreal, GRADE_DISPLAY_TYPE_PERCENTAGE => $strpercentage, GRADE_DISPLAY_TYPE_LETTER => $strletter))); $settings->add(new admin_setting_configselect('grade_report_averagesdecimalpoints', get_string('averagesdecimalpoints', 'grades'), get_string('averagesdecimalpoints_help', 'grades'), GRADE_REPORT_PREFERENCE_INHERIT, array(GRADE_REPORT_PREFERENCE_INHERIT => $strinherit, '0' => '0', '1' => '1', '2' => '2', '3' => '3', '4' => '4', '5' => '5'))); $settings->add(new admin_setting_configselect('grade_report_rangesdecimalpoints', get_string('rangesdecimalpoints', 'grades'), get_string('rangesdecimalpoints_help', 'grades'), GRADE_REPORT_PREFERENCE_INHERIT, array(GRADE_REPORT_PREFERENCE_INHERIT => $strinherit, '0' => '0', '1' => '1', '2' => '2', '3' => '3', '4' => '4', '5' => '5'))); } report/grader/styles.css 0000604 00000013536 15062070557 0011373 0 ustar 00 /** * Container. */ .path-grade-report-grader .gradeparent { position: relative; } /** * The table. */ .path-grade-report-grader .gradeparent table { border: 1px solid #ccc; border-collapse: separate; border-spacing: 0; border-bottom-width: 0; border-right-width: 0; margin-bottom: 2em; height: 100%; } /** * All the cells. */ .path-grade-report-grader .gradeparent .cell { border: 1px solid #ccc; border-top-width: 0; border-left-width: 0; padding: 0.5rem 1rem; vertical-align: top; height: 100%; } .path-grade-report-grader .overriddengrade { color: #495057; border: none; -moz-appearance: none; -webkit-appearance: none; } .path-grade-report-grader .gradepass { color: #357a32; } .path-grade-report-grader .gradefail { color: #ca3120; } .path-grade-report-grader .grade_icons, .path-grade-report-grader .category_grade_icons { white-space: nowrap; margin-top: 0.5rem; } .path-grade-report-grader .grade_type_value .grade_icons { margin-left: auto; } .path-grade-report-grader .grade_icons .icon { margin-right: 1rem; } .path-grade-report-grader .grade_icons .icon:last-child { margin-right: 0; } /** * All the floating divs. */ .path-grade-report-grader .gradeparent .floater { display: none; } .path-grade-report-grader .gradeparent .floating { display: block; } /** * All the headers + floating cells. */ .path-grade-report-grader .gradeparent .heading .cell, .path-grade-report-grader .gradeparent .avg .cell, .path-grade-report-grader .gradeparent .user.cell { font-size: 14px; font-weight: normal; } .path-grade-report-grader .gradeparent .heading .header, .path-grade-report-grader .gradeparent .heading .userfield { white-space: nowrap; } .path-grade-report-grader .heading .gradeitemheader { text-indent: -1.5rem; padding-left: 1.5rem; padding-top: 6px; } .path-grade-report-grader .dropdown-item { text-align: left; } .path-grade-report-grader .heading .gradeitemheader .itemicon { text-align: right; } /** * The user cells. */ .path-grade-report-grader .gradeparent .user.cell { white-space: nowrap; } .path-grade-report-grader .gradeparent .highlightable.cell { min-width: 200px; } .path-grade-report-grader .gradeparent .highlightable.cell.collapsed { min-width: unset; } .path-grade-report-grader .gradeparent .user.cell .userpicture { border: none; vertical-align: middle; } .path-grade-report-grader .gradeitemheader { display: inline-block; overflow: hidden; text-overflow: ellipsis; max-width: 200px; vertical-align: middle; } /** * The footer's header. */ .path-grade-report-grader .gradeparent .range .header, .path-grade-report-grader .gradeparent .avg .header, .path-grade-report-grader .gradeparent .groupavg .header { font-weight: bold; text-align: right; } /** * The footer's floating cells. */ .path-grade-report-grader .gradeparent .avg.floating .cell { border-top-width: 1px; } /** * Content styling. */ .path-grade-report-grader .gradeparent .heading .cell .iconsmall { /* Fixes inconsistencies in cell height on IE. */ padding-top: 0; padding-bottom: 0; } .path-grade-report-grader .gradeparent .sorticon { vertical-align: middle; margin: 0; } .path-grade-report-grader .gradeparent td.grade_type_value, .path-grade-report-grader .gradeparent td.grade_type_value input, .path-grade-report-grader .gradeparent td.grade_type_value div { text-align: right; margin-left: auto; } .path-grade-report-grader .gradeparent .gradevalue { display: inline-block; } .path-grade-report-grader .header, .path-grade-report-grader td.userfield div { padding-top: 6px; } .path-grade-report-grader .gradeparent tr:nth-child(n) td.ajaxoverridden:nth-child(n) { /* Made very specific to override the default stripped style of the table. */ background-color: #ffe3a0; } .path-grade-report-grader .gradeparent .excludedfloater { font-weight: bold; color: red; font-size: 9px; float: left; } .path-grade-report-grader .gradeparent .category { text-align: left; } /** * Editing fields. * MDL-74286 - width 100% pushes action menu out of cell. */ .path-grade-report-grader .gradeparent select { text-overflow: ellipsis; min-width: 8rem; } .path-grade-report-grader .gradeparent .text { border: 1px solid #666; width: auto; margin: 0; padding: 0; text-align: center; } .path-grade-report-grader .gradeparent table .action-menu { display: inline-block; margin-right: -0.5rem; padding-left: 0.5rem; } .path-grade-report-grader .gradeparent table .heading .action-menu { padding-left: 0; } .path-grade-report-grader .dropdown-menu { width: max-content; } .path-grade-report-grader .initialsdropdown { width: 460px; } .path-grade-report-grader .initialsdropdown::after { content: ''; } .path-grade-report-grader .usersearchwidget::after { content: ''; } .path-grade-report-grader .usersearchwidget { pointer-events: none; } .path-grade-report-grader .usersearchwidget input { pointer-events: initial; z-index: 1; } .path-grade-report-grader .usersearchwidget button, .path-grade-report-grader .usersearchwidget a { pointer-events: initial; } .path-grade-report-grader .usersearchdropdown { /*Extra height to allow non result items.*/ max-height: 400px; width: 300px; pointer-events: all; padding: 0; } .path-grade-report-grader .usersearchdropdown .unsearchablecontentcontainer { position: sticky; bottom: 0; background-color: white; } .path-grade-report-grader .usersearchdropdown .footer { border-top: 1px solid #dee2e6; font-size: 90%; } .collapsecolumndropdown.show { width: 300px; max-height: 300px; } @media only screen and (min-width: 768px) { .path-grade-report-grader .gradeparent table { padding-right: 6em; } } report/grader/preferences_form.php 0000604 00000022033 15062070557 0013363 0 ustar 00 <?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/>. /** * Form for grader report preferences * * @package gradereport_grader * @copyright 2009 Nicolas Connault * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ if (!defined('MOODLE_INTERNAL')) { die('Direct access to this script is forbidden.'); /// It must be included from a Moodle page } require_once($CFG->libdir.'/formslib.php'); /** * First implementation of the preferences in the form of a moodleform. * TODO add "reset to site defaults" button */ class grader_report_preferences_form extends moodleform { function definition() { global $USER, $CFG; $mform =& $this->_form; $course = $this->_customdata['course']; $context = context_course::instance($course->id); $canviewhidden = has_capability('moodle/grade:viewhidden', $context); $checkbox_default = array(GRADE_REPORT_PREFERENCE_DEFAULT => '*default*', 0 => get_string('no'), 1 => get_string('yes')); $advanced = array(); /// form definition with preferences defaults //-------------------------------------------------------------------------------- $preferences = array(); // Initialise the preferences arrays with grade:manage capabilities if (has_capability('moodle/grade:manage', $context)) { $preferences['prefshow'] = array(); if ($canviewhidden) { $preferences['prefshow']['showaverages'] = $checkbox_default; } $preferences['prefrows'] = array( 'rangesdisplaytype' => array(GRADE_REPORT_PREFERENCE_DEFAULT => '*default*', GRADE_REPORT_PREFERENCE_INHERIT => get_string('inherit', 'grades'), GRADE_DISPLAY_TYPE_REAL => get_string('real', 'grades'), GRADE_DISPLAY_TYPE_PERCENTAGE => get_string('percentage', 'grades'), GRADE_DISPLAY_TYPE_LETTER => get_string('letter', 'grades')), 'rangesdecimalpoints' => array(GRADE_REPORT_PREFERENCE_DEFAULT => '*default*', GRADE_REPORT_PREFERENCE_INHERIT => get_string('inherit', 'grades'), 0=>0, 1=>1, 2=>2, 3=>3, 4=>4, 5=>5)); $advanced = array_merge($advanced, array('rangesdisplaytype', 'rangesdecimalpoints')); if ($canviewhidden) { $preferences['prefrows']['averagesdisplaytype'] = array(GRADE_REPORT_PREFERENCE_DEFAULT => '*default*', GRADE_REPORT_PREFERENCE_INHERIT => get_string('inherit', 'grades'), GRADE_DISPLAY_TYPE_REAL => get_string('real', 'grades'), GRADE_DISPLAY_TYPE_PERCENTAGE => get_string('percentage', 'grades'), GRADE_DISPLAY_TYPE_LETTER => get_string('letter', 'grades')); $preferences['prefrows']['averagesdecimalpoints'] = array(GRADE_REPORT_PREFERENCE_DEFAULT => '*default*', GRADE_REPORT_PREFERENCE_INHERIT => get_string('inherit', 'grades'), 0=>0, 1=>1, 2=>2, 3=>3, 4=>4, 5=>5); $preferences['prefrows']['meanselection'] = array(GRADE_REPORT_PREFERENCE_DEFAULT => '*default*', GRADE_REPORT_MEAN_ALL => get_string('meanall', 'grades'), GRADE_REPORT_MEAN_GRADED => get_string('meangraded', 'grades')); $advanced = array_merge($advanced, array('averagesdisplaytype', 'averagesdecimalpoints')); } } // Quickgrading use conditional on grade:edit capability. if (has_capability('moodle/grade:edit', $context)) { $preferences['prefgeneral']['quickgrading'] = $checkbox_default; } // View capability is the lowest permission. Users with grade:manage or grade:edit must also have grader:view if (has_capability('gradereport/grader:view', $context)) { if (has_capability('moodle/course:viewsuspendedusers', $context)) { $preferences['prefgeneral']['showonlyactiveenrol'] = $checkbox_default; } $preferences['prefgeneral']['aggregationposition'] = array(GRADE_REPORT_PREFERENCE_DEFAULT => '*default*', GRADE_REPORT_AGGREGATION_POSITION_FIRST => get_string('positionfirst', 'grades'), GRADE_REPORT_AGGREGATION_POSITION_LAST => get_string('positionlast', 'grades')); $preferences['prefshow']['showuserimage'] = $checkbox_default; $preferences['prefshow']['showranges'] = $checkbox_default; if ($canviewhidden) { $preferences['prefrows']['shownumberofgrades'] = $checkbox_default; } } foreach ($preferences as $group => $prefs) { $mform->addElement('header', $group, get_string($group, 'grades')); $mform->setExpanded($group); foreach ($prefs as $pref => $type) { // Detect and process dynamically numbered preferences if (preg_match('/([^[0-9]+)([0-9]+)/', $pref, $matches)) { $lang_string = $matches[1]; $number = ' ' . $matches[2]; } else { $lang_string = $pref; $number = null; } $full_pref = 'grade_report_' . $pref; $pref_value = get_user_preferences($full_pref); $options = null; if (is_array($type)) { $options = $type; $type = 'select'; // MDL-11478 // get default aggregationposition from grade_settings $course_value = null; if (!empty($CFG->{$full_pref})) { $course_value = grade_get_setting($course->id, $pref, $CFG->{$full_pref}); } if ($pref == 'aggregationposition') { if (!empty($options[$course_value])) { $default = $options[$course_value]; } else { $default = $options[$CFG->grade_aggregationposition]; } } elseif (isset($options[$CFG->{$full_pref}])) { $default = $options[$CFG->{$full_pref}]; } else { $default = ''; } } else { $default = $CFG->$full_pref; } // Replace the '*default*' value with the site default language string - 'default' might collide with custom language packs if (!is_null($options) AND isset($options[GRADE_REPORT_PREFERENCE_DEFAULT]) && $options[GRADE_REPORT_PREFERENCE_DEFAULT] == '*default*') { $options[GRADE_REPORT_PREFERENCE_DEFAULT] = get_string('reportdefault', 'grades', $default); } $label = get_string($lang_string, 'grades') . $number; $mform->addElement($type, $full_pref, $label, $options); if ($lang_string != 'showuserimage') { $mform->addHelpButton($full_pref, $lang_string, 'grades'); } $mform->setDefault($full_pref, $pref_value); $mform->setType($full_pref, PARAM_ALPHANUM); } } foreach($advanced as $name) { $mform->setAdvanced('grade_report_'.$name); } $mform->addElement('hidden', 'id'); $mform->setType('id', PARAM_INT); $mform->setDefault('id', $course->id); $this->add_action_buttons(false); } /// perform some extra moodle validation function validation($data, $files) { return parent::validation($data, $files); } } templates/grade_letters_action_bar.mustache 0000604 00000006347 15062070557 0015317 0 ustar 00 {{! 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/>. }} {{! @template core_grades/grade_letters_action_bar Actions bar for the grade letters page. Context variables required for this template: * generalnavselector - The data object containing the required properties to render the general navigation selector. * editbutton - The data object containing the required properties to render the 'edit grade letters' button. Example context (json): { "generalnavselector": { "name": "Gradebook tertiary navigation selector", "value": "opt2", "baseid": "select-menu56789", "selectedoption": "Import", "options": [ { "selected": false, "isgroup": { "name": "View", "id": "select-menu-group1", "options": [ { "name": "Grader report", "value": "opt1", "id": "select-menu-option1", "selected": false } ] } }, { "selected": false, "isgroup": { "name": "More", "id": "select-menu-group2", "options": [ { "name": "Grade letters", "value": "opt2", "id": "select-menu-option2", "selected": true } ] } } ] }, "editbutton": { "id": "single_button12345", "method" : "get", "classes": "singlebutton", "formid": null, "url" : "#", "primary" : true, "tooltip" : null, "label" : "Edit", "attributes": [] } } }} <div class="container-fluid tertiary-navigation full-width-bottom-border"> <div class="row"> {{#generalnavselector}} <div class="navitem"> {{>core/tertiary_navigation_selector}} </div> <div class="navitem-divider"></div> {{/generalnavselector}} {{#editbutton}} <div class="navitem"> {{>core/single_button}} </div> {{/editbutton}} </div> </div> templates/bulkactions/edit/tree/bulk_move_category_item.mustache 0000604 00000007667 15062070557 0021420 0 ustar 00 {{! 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/>. }} {{! @template core_grades/bulkactions/edit/tree/bulk_move_category_item Recursively renders a grade category tree for the bulk move modal. Context variables required for this template: * id - The id of the category. * name - The name of the category. * children - An array of child categories. * iscategory - Whether the item is a category or not. * haschildcategories - Whether the item has child categories or not. Example context (json): { "id": 1, "name": "Category 1", "children": [ { "id": 2, "name": "Category 2", "children": [ { "id": 3, "name": "Category 3", "children": [ { "id": 4, "name": "Category 4", "children": [], "iscategory": true } ], "iscategory": true, "haschildcategories": true } ], "iscategory": true, "haschildcategories": true } ], "iscategory": true, "haschildcategories": true } }} {{#haschildcategories}} <li data-for="sectionnode" role="treeitem" aria-owns="movemodalcollapse{{id}}" data-type="category" data-id="{{id}}" data-selected="false" aria-expanded="true" data-collapsible="true"> <div class="collapse-list-item d-flex" id="movemodalsection{{id}}"> <a role="button" href="#movemodalcollapse{{id}}" aria-controls="movemodalcollapse{{id}}" class="collapse-list-link btn" tabindex="-1"> <span class="expanded-icon text-nowrap" data-toggle="tooltip" title="{{#str}} collapse, core {{/str}}"> {{#pix}} t/expandedchevron, core, {{#str}} collapse, core {{/str}} {{/pix}} </span> <span class="collapsed-icon text-nowrap" data-toggle="tooltip" title="{{#str}} expand, core {{/str}}"> <span class="dir-rtl-hide">{{#pix}} t/collapsedchevron, core, {{#str}} expand, core {{/str}} {{/pix}}</span> <span class="dir-ltr-hide">{{#pix}} t/collapsedchevron_rtl, core, {{#str}} expand, core {{/str}} {{/pix}}</span> </span> </a> <span class="collapse-list-item-name">{{name}}</span> </div> <div id="movemodalcollapse{{id}}" class="collapse-list-item-content"> <ul class="unlist" role="group" aria-labelledby="movemodalsection{{id}}"> {{#children}} {{#iscategory}} {{> core_grades/bulkactions/edit/tree/bulk_move_category_item }} {{/iscategory}} {{/children}} </ul> </div> </li> {{/haschildcategories}} {{^haschildcategories}} <li data-for="sectionnode" role="treeitem" data-type="category" data-id="{{id}}" data-selected="false"> <div class="collapse-list-item d-flex"> <span class="collapse-list-item-name ml-2">{{name}}</span> </div> </li> {{/haschildcategories}} templates/bulkactions/edit/tree/bulk_move_trigger.mustache 0000604 00000002477 15062070557 0020222 0 ustar 00 {{! 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/>. }} {{! @template core_grades/bulkactions/edit/tree/bulk_move_trigger Renders the bulk move trigger element in gradebook setup including hidden inputs related to the action. Context variables required for this template: * none Example context (json): { } }} {{< core/bulkactions/bulk_action_trigger }} {{$action}}move{{/action}} {{$title}}{{#str}} move, core {{/str}}{{/title}} {{$icon}}{{#pix}} i/dragdrop, core {{/pix}}{{/icon}} {{/ core/bulkactions/bulk_action_trigger }} <input type="hidden" name="bulkmove" value="0" id="bulkmoveinput"> <input type="hidden" name="moveafter" value="" id="menumoveafter"> templates/bulkactions/edit/tree/bulk_move_grade_tree.mustache 0000604 00000004214 15062070557 0020647 0 ustar 00 {{! 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/>. }} {{! @template core_grades/bulkactions/edit/tree/bulk_move_grade_tree Renders the tree of categories and items for the bulk move action. Context variables required for this template: * id - The id of the category. * name - The name of the category. * children - An array of child categories. * iscategory - Whether the item is a category or not. Example context (json): { "id": 1, "name": "Category 1", "children": [ { "id": 2, "name": "Category 2", "children": [ { "id": 3, "name": "Category 3", "children": [ { "id": 4, "name": "Category 4", "children": [], "iscategory": true } ], "iscategory": true } ], "iscategory": true } ], "iscategory": true } }} <p data-for="sectionname">{{#str}} moveselectedto, grades {{/str}}</p> <nav class="collapse-list" id="destination-selector"> <ul class="unlist p-0" role="tree"> {{#iscategory}} {{> core_grades/bulkactions/edit/tree/bulk_move_category_item }} {{/iscategory}} </ul> </nav> templates/status_icons.mustache 0000604 00000002777 15062070557 0013033 0 ustar 00 {{! 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/>. }} {{! @template core_grades/status_icons Template for the grade status icons. Example context (json): { "classes": "gradestatus", "hidden": true, "locked": true, "overridden": false, "excluded": false, "feedback": false } }} <div class="text-muted {{classes}}"> {{#hidden}}{{#pix}}i/show, moodle, {{#str}} hidden, grades {{/str}}{{/pix}}{{/hidden}} {{#locked}}{{#pix}}i/lock, moodle, {{#str}} locked, grades {{/str}}{{/pix}}{{/locked}} {{#overridden}}{{#pix}}i/overriden_grade, moodle, {{#str}} overridden, grades {{/str}}{{/pix}}{{/overridden}} {{#excluded}}{{#pix}}i/excluded, moodle, {{#str}} excluded, grades {{/str}}{{/pix}}{{/excluded}} {{#feedback}}{{#pix}}i/asterisk, moodle, {{#str}} feedbackprovided, grades {{/str}}{{/pix}}{{/feedback}} </div> templates/searchwidget/readme.txt 0000604 00000000501 15062070557 0013210 0 ustar 00 NOTE: Templates inside this directory have been deprecated since Moodle 4.3 and will be removed in 4.7. They are only retained so that plugins using the now-deprecated searchwidget located in: 'grade/amd/src/searchwidget/basewidget.js' can continue to use this widget in a working state during the deprecation period. templates/searchwidget/searchresults.mustache 0000604 00000003262 15062070557 0015643 0 ustar 00 {{! 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/>. }} {{! @template core_grades/searchwidget/searchresults The wrapper in which our search results will be rendered Example context (json): { "searchresults": [ { "id": "1", "name": "Quiz 1", "fullname": "Cameron Greeve", "sendmessage": "http://foo.bar/message/index.php?id=25", "addcontact": "http://foo.bar/message/index.php?user1=2&user2=14&addcontact=14&sesskey=XXXXX", "currentuser": "2" } ] } }} <div class="searchresultitemscontainer-wrapper dropdown"> <ul class="searchresultitemscontainer d-flex flex-column mw-100 position-relative py-2 list-group rounded-0" role="none" data-region="search-result-items-container"> {{#searchresults}} {{>core_grades/searchwidget/searchitem}} {{/searchresults}} {{^searchresults}} <p>{{#str}} resultsfound, core, 0 {{/str}}</p> {{/searchresults}} </ul> </div> templates/searchwidget/error.mustache 0000604 00000002356 15062070557 0014110 0 ustar 00 {{! 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/>. }} {{! @template core_grades/searchwidget/error Chooser error template. Variables required for this template: * errormessage - The error message Example context (json): { "errormessage": "Error" } }} <div class="p-2 px-sm-5 py-sm-4"> <div class="alert alert-danger" role="alert"> <h5 class="alert-heading"> <i class="fa fa-exclamation-circle fa-fw text-danger"></i> {{#str}} error, error {{/str}} </h5> <hr> <p class="text-break">{{{errormessage}}}</p> </div> </div> templates/searchwidget/loading.mustache 0000604 00000001705 15062070557 0014371 0 ustar 00 {{! 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/>. }} {{! @template core_grades/searchwidget/loading This template renders the loading placeholder for the search widget. Example context (json): {} }} <div class="d-flex w-100 h-100 justify-content-center align-items-center"> {{> core/loading }} </div> templates/searchwidget/searchitem.mustache 0000604 00000003507 15062070557 0015102 0 ustar 00 {{! 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/>. }} {{! @template core_grades/searchwidget/searchitem Search result line items. Example context (json): { "id": "1", "name": "Quiz 1", "fullname": "Cameron Greeve" } }} <li role="option" class="dropdown-item d-flex px-2 py-1 {{^name}}align-items-center{{/name}}" {{#name}}id="item-{{id}}"{{/name}} {{^name}}id="user-{{id}}"{{/name}} data-value="{{id}}" > {{#name}} <span class="pull-left result-cell text-truncate mr-2"> {{name}} </span> {{/name}} {{^name}} <div class="d-block pr-2 w-25"> {{#profileimage}} <img class="userpicture w-75 mx-auto d-block" src="{{profileimage}}" alt="" /> {{/profileimage}} {{^profileimage}} <span class="userinitials"></span> {{/profileimage}} </div> <div class="d-block pr-3 w-75"> <span class="w-100 p-0 font-weight-bold"> {{fullname}} </span> <span class="w-100 pull-left text-truncate small"> {{email}} </span> </div> {{/name}} </li> templates/edit_tree_sticky_footer.mustache 0000604 00000002621 15062070557 0015211 0 ustar 00 {{! 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/>. }} {{! @template core_grades/edit_tree_sticky_footer Edit tree sticky footer template. Context variables required for this template: * movingmodeenabled - string - Whether moving mode is enabled. * courseid - int - The course id. Example context (json): { "movingmodeenabled": "false", "courseid": 1 } }} <div class="col-auto"> {{#movingmodeenabled}} <a class="btn btn-secondary" href="index.php?id={{courseid}}"> {{#cleanstr}}cancel{{/cleanstr}} </a> {{/movingmodeenabled}} {{^movingmodeenabled}} <input class="advanced btn btn-primary" type="submit" value="{{#cleanstr}}savechanges{{/cleanstr}}"> {{/movingmodeenabled}} </div> templates/cellmenu.mustache 0000604 00000014066 15062070557 0012113 0 ustar 00 {{! 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/>. }} {{! @template core_grades/cellmenu This template renders action menu for a given cell. Example context (json): { "editurl": "<a class='dropdown-item' aria-label='Edit grade' role='menuitem' href='grade/edit/tree/grade.php?courseid=13&itemid=608&userid=85&gpr_type=report&gpr_plugin=grader&gpr_courseid=13'>Edit grade</a>", "hideurl": "<a class='dropdown-item' aria-label='Hide' role='menuitem' href='grade/edit/tree/action.php?id=13&sesskey=sMAOMLAAN5&eid=n608u85&gpr_type=report&gpr_plugin=grader&gpr_courseid=13&action=hide'>Hide</a>", "reporturl0": "<a class='dropdown-item' aria-label='Single view for this user' role='menuitem' href='grade/report/singleview/index.php?id=13&itemid=39&item=user&gpr_type=report&gpr_plugin=grader&gpr_courseid=13'>Single view for this user</a>", "reporturl1": "<a class='dropdown-item' aria-label='User report' role='menuitem' href='grade/report/user/index.php?userid=39&id=13&gpr_type=report&gpr_plugin=grader&gpr_courseid=13'>User report</a>", "ascendingurl": "<a class='dropdown-item' aria-label='Ascending' role='menuitem' href='index.php?id=13&sortitemid=email&sort=asc&gpr_type=report&gpr_plugin=grader&gpr_courseid=13'>Ascending</a>", "descendingurl": "<a class='dropdown-item' aria-label='Descending' role='menuitem' href='index.php?id=13&sortitemid=email&sort=desc&gpr_type=report&gpr_plugin=grader&gpr_courseid=13'>Descending</a>", "ascendingfirstnameurl": "<a class='dropdown-item' aria-label='Ascending' role='menuitem' href='index.php?id=13&sortitemid=firstname&sort=asc&gpr_type=report&gpr_plugin=grader&gpr_courseid=13'>Ascending</a>", "descendingfirstnameurl": "<a class='dropdown-item' aria-label='Descending' role='menuitem' href='index.php?id=13&sortitemid=firstname&sort=desc&gpr_type=report&gpr_plugin=grader&gpr_courseid=13'>Descending</a>", "ascendinglastnameurl": "<a class='dropdown-item' aria-label='Ascending' role='menuitem' href='index.php?id=13&sortitemid=lastname&sort=asc&gpr_type=report&gpr_plugin=grader&gpr_courseid=13'>Ascending</a>", "descendinglastnameurl": "<a class='dropdown-item' aria-label='Descending' role='menuitem' href='index.php?id=13&sortitemid=lastname&sort=desc&gpr_type=report&gpr_plugin=grader&gpr_courseid=13'>Descending</a>", "viewfeedbackurl": "<a href='#' class='dropdown-item' aria-label='View feedback' role='menuitem'>View feedback</a>", "divider1": "true", "divider2": "true", "datatype": "item", "dataid": "123", "columncollapse": "<a class='dropdown-item' data-hider='hide' aria-label='Collapse' role='menuitem' href='#'>Collapse</a>" } }} <div class="action-menu moodle-actionmenu grader" data-collapse="menu"> <div class="dropdown"> <button class="btn btn-link btn-icon icon-size-3 cellmenubtn" type="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false" {{#databoundary}}data-boundary="{{databoundary}}"{{/databoundary}} {{#datatype}}data-type="{{datatype}}"{{/datatype}} {{#dataid}}data-id="{{dataid}}"{{/dataid}}> <i class="icon fa fa-ellipsis-h fa-fw m-0" title="{{#str}} cellactions, gradereport_grader {{/str}}" aria-hidden="true"></i> <span class="sr-only">{{#str}} cellactions, gradereport_grader {{/str}}</span> </button> <div role="menu" class="dropdown-menu"> {{#editurl}}{{{editurl}}}{{/editurl}} {{#editcalculationurl}}{{{editcalculationurl}}}{{/editcalculationurl}} {{#reporturl0}}{{{reporturl0}}}{{/reporturl0}} {{#reporturl1}}{{{reporturl1}}}{{/reporturl1}} {{#advancedgradingurl}}{{{advancedgradingurl}}}{{/advancedgradingurl}} {{#gradesonlyurl}}{{{gradesonlyurl}}}{{/gradesonlyurl}} {{#aggregatesonlyurl}}{{{aggregatesonlyurl}}}{{/aggregatesonlyurl}} {{#fullmodeurl}}{{{fullmodeurl}}}{{/fullmodeurl}} {{#deleteurl}}{{{deleteurl}}}{{/deleteurl}} {{#duplicateurl}}{{{duplicateurl}}}{{/duplicateurl}} {{#gradeanalysisurl}}{{{gradeanalysisurl}}}{{/gradeanalysisurl}} {{#divider1}} <div class="dropdown-divider" role="separator"></div> {{/divider1}} {{#ascendingfirstnameurl}} <h6 class="dropdown-header">{{#str}} firstname, moodle {{/str}}</h6> {{{ascendingfirstnameurl}}} {{{descendingfirstnameurl}}} <h6 class="dropdown-header">{{#str}} lastname, moodle {{/str}}</h6> {{{ascendinglastnameurl}}} {{{descendinglastnameurl}}} {{/ascendingfirstnameurl}} {{#ascendingurl}} {{{ascendingurl}}} {{{descendingurl}}} {{/ascendingurl}} {{#divider2}} <div class="dropdown-divider" role="separator"></div> {{/divider2}} {{#hideurl}}{{{hideurl}}}{{/hideurl}} {{#lockurl}}{{{lockurl}}}{{/lockurl}} {{#columncollapse}}{{{columncollapse}}}{{/columncollapse}} {{#resetweightsurl}}{{{resetweightsurl}}}{{/resetweightsurl}} {{#viewfeedbackurl}}{{{viewfeedbackurl}}}{{/viewfeedbackurl}} </div> </div> </div> templates/weight_field.mustache 0000604 00000002116 15062070557 0012732 0 ustar 00 {{! 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/>. }} {{! @template core_grades/weight_field Weight field. Example context (json): { "itemname": "Awesome test", "id": "2", "value": "100" } }} <label class="accesshide" for="weight_{{id}}"> {{#str}}extracreditvalue, grades, {{itemname}}{{/str}} </label> <input type="text" name="weight_{{id}}" id="weight_{{id}}" value="{{value}}" size="4" class="form-control"> templates/export_key_manager_action_bar.mustache 0000604 00000010666 15062070557 0016355 0 ustar 00 {{! 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/>. }} {{! @template core_grades/export_key_manager_action_bar Actions bar for the gradebook exports key manager page. Context variables required for this template: * generalnavselector - The data object containing the required properties to render the general navigation selector. * exportselector - The data object containing the required properties to render the export options selector. * adduserkeybutton - The data object containing the required properties to render the 'add user key' button. Example context (json): { "generalnavselector": { "name": "Gradebook tertiary navigation selector", "value": "opt2", "baseid": "select-menu56788", "selectedoption": "Export", "options": [ { "selected": false, "isgroup": { "name": "View", "id": "select-menu-group1", "options": [ { "name": "Grader report", "value": "opt1", "id": "select-menu-option1", "selected": false } ] } }, { "selected": false, "isgroup": { "name": "More", "id": "select-menu-group2", "options": [ { "name": "Export", "value": "opt2", "id": "select-menu-option2", "selected": true } ] } } ] }, "exportselector": { "name": "exportas", "value": "https://example.com/grade/export/keymanager.php", "baseid": "select-menu56789", "label": "Export as", "labelattributes": [ { "name": "class", "value": "font-weight-bold" } ], "selectedoption": "Key manager", "options": [ { "name": "Key manager", "value": "https://example.com/grade/export/keymanager.php", "selected": true, "id": "select-menu-option56789" } ] }, "adduserkeybutton": { "id": "single_button12345", "method" : "get", "classes": "singlebutton", "formid": null, "url" : "#", "primary" : true, "tooltip" : null, "label" : "Add user key", "attributes": [] } } }} <div class="container-fluid tertiary-navigation full-width-bottom-border"> <div class="row"> {{#generalnavselector}} <div class="navitem"> {{>core/tertiary_navigation_selector}} </div> <div class="navitem-divider"></div> {{/generalnavselector}} {{#exportselector}} <div class="navitem"> {{>core/select_menu}} </div> {{#js}} document.querySelector('#{{baseid}}').addEventListener('change', function(e) { window.location.href = e.target.value; }); {{/js}} {{/exportselector}} {{#adduserkeybutton}} <div class="navitem"> {{>core/single_button}} </div> {{/adduserkeybutton}} </div> </div> templates/export_action_bar.mustache 0000604 00000007546 15062070557 0014016 0 ustar 00 {{! 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/>. }} {{! @template core_grades/export_action_bar Actions bar for the gradebook export pages. Context variables required for this template: * generalnavselector - The data object containing the required properties to render the general navigation selector. * exportselector - The data object containing the required properties to render the export options selector. Example context (json): { "generalnavselector": { "name": "Gradebook tertiary navigation selector", "value": "opt2", "baseid": "select-menu56788", "selectedoption": "Export", "options": [ { "selected": false, "isgroup": { "name": "View", "id": "select-menu-group1", "options": [ { "name": "Grader report", "value": "opt1", "id": "select-menu-option1", "selected": false } ] } }, { "selected": false, "isgroup": { "name": "More", "id": "select-menu-group2", "options": [ { "name": "Export", "value": "opt2", "id": "select-menu-option2", "selected": true } ] } } ] }, "exportselector": { "name": "exportas", "value": "https://example.com/grade/export/ods/index.php", "baseid": "select-menu56789", "label": "Export as", "labelattributes": [ { "name": "class", "value": "font-weight-bold" } ], "selectedoption": "OpenDocument spreadsheet", "options": [ { "name": "OpenDocument spreadsheet", "value": "https://example.com/grade/export/ods/index.php", "selected": true, "id": "select-menu-option56789" } ] } } }} <div class="container-fluid tertiary-navigation full-width-bottom-border"> <div class="row"> {{#generalnavselector}} <div class="navitem"> {{>core/tertiary_navigation_selector}} </div> <div class="navitem-divider"></div> {{/generalnavselector}} {{#exportselector}} <div class="navitem"> {{>core/select_menu}} </div> {{#js}} document.querySelector('#{{baseid}}').addEventListener('change', function(e) { window.location.href = e.target.value; }); {{/js}} {{/exportselector}} </div> </div> templates/import_key_manager_action_bar.mustache 0000604 00000010667 15062070557 0016347 0 ustar 00 {{! 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/>. }} {{! @template core_grades/import_key_manager_action_bar Actions bar for the gradebook imports key manager page. Context variables required for this template: * generalnavselector - The data object containing the required properties to render the tertiary navigation selector. * importselector - The data object containing the required properties to render the import options selector. * adduserkeybutton - The data object containing the required properties to render the 'add user key' button. Example context (json): { "generalnavselector": { "name": "Gradebook tertiary navigation selector", "value": "opt2", "baseid": "select-menu56788", "selectedoption": "Import", "options": [ { "selected": false, "isgroup": { "name": "View", "id": "select-menu-group1", "options": [ { "name": "Grader report", "value": "opt1", "id": "select-menu-option1", "selected": false } ] } }, { "selected": false, "isgroup": { "name": "More", "id": "select-menu-group1", "options": [ { "name": "Import", "value": "opt2", "id": "select-menu-option2", "selected": true } ] } } ] }, "importselector": { "name": "importas", "value": "https://example.com/grade/import/keymanager.php", "baseid": "select-menu56789", "label": "Import as", "labelattributes": [ { "name": "class", "value": "font-weight-bold" } ], "selectedoption": "Key manager", "options": [ { "name": "Key manager", "value": "https://example.com/grade/import/keymanager.php", "selected": true, "id": "select-menu-option56789" } ] }, "adduserkeybutton": { "id": "single_button12345", "method" : "get", "classes": "singlebutton", "formid": null, "url" : "#", "primary" : true, "tooltip" : null, "label" : "Add user key", "attributes": [] } } }} <div class="container-fluid tertiary-navigation full-width-bottom-border"> <div class="row"> {{#generalnavselector}} <div class="navitem"> {{>core/tertiary_navigation_selector}} </div> <div class="navitem-divider"></div> {{/generalnavselector}} {{#importselector}} <div class="navitem"> {{>core/select_menu}} </div> {{#js}} document.querySelector('#{{baseid}}').addEventListener('change', function(e) { window.location.href = e.target.value; }); {{/js}} {{/importselector}} {{#adduserkeybutton}} <div class="navitem"> {{>core/single_button}} </div> {{/adduserkeybutton}} </div> </div> templates/export_publish_action_bar.mustache 0000604 00000003122 15062070557 0015526 0 ustar 00 {{! 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/>. }} {{! @template core_grades/export_publish_action_bar Actions bar for the gradebook publish export page. Context variables required for this template: * backbutton - The data object containing the required properties to render the 'back' button. Example context (json): { "backbutton": { "id": "single_button12345", "method" : "get", "classes": "singlebutton", "formid": null, "url" : "#", "primary" : false, "tooltip" : null, "label" : "Back", "attributes": [] } } }} <div class="container-fluid tertiary-navigation full-width-bottom-border"> <div class="row"> {{#backbutton}} <div class="navitem"> {{>core/single_button}} </div> <div class="navitem-divider"></div> {{/backbutton}} </div> </div> templates/grade_category_visibility_toggle.mustache 0000604 00000003154 15062070557 0017072 0 ustar 00 {{! 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/>. }} {{! @template core_grades/grade_category_visibility_toggle Template for the grade category visibility toggle element. Context variables required for this template: * category - The grade category identifier Example context (json): { "category": "gc2" } }} <a aria-expanded="true" role="button" data-category={{category}} data-target=".{{category}}[data-hidden='false']" class="btn btn-icon mr-1 toggle-category" href="#"> <span class="collapsed text-nowrap" title="{{#str}} collapse, core {{/str}}"> <i class="icon fa fa-chevron-down fa-fw" title="{{#str}} collapse, core {{/str}}" role="img" aria-label="{{#str}} collapse, core {{/str}}"></i> </span> <span class="expanded text-nowrap" title="{{#str}} expand, core {{/str}}"> <i class="icon fa fa-chevron-right fa-fw" title="{{#str}} expand, core {{/str}}" role="img" aria-label="{{#str}} expand, core {{/str}}"></i> </span> </a> templates/edit_tree.mustache 0000604 00000003753 15062070557 0012254 0 ustar 00 {{! 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/>. }} {{! @template core_grades/edit_tree Edit tree template. Context variables required for this template: * actionurl - string - Form action URL. * sesskey - string - The session key. * notification - object - Context data for the notification. * table - string - HTML content of the grade items table. * movingmodeenabled - string - Whether moving mode is enabled. * courseid - int - The course id. * stickyfooter - string - HTML content of the sticky footer. Example context (json): { "actionurl": "#", "sesskey": "fakesesskey", "notification": "", "table": "<table class='generaltable simple setup-grades' id='grade_edit_tree_table'><thead> <tr><th>Name</th><th>Weights</th><th>Max grade</th><th>Actions</th> </tr></thead><tbody></tbody></table>", "movingmodeenabled": "false", "courseid": 1, "stickyfooter": "<div id='gradetreesubmit'></div>" } }} {{#notification}} {{>core/notification_info}} {{/notification}} <div class="gradetree-wrapper d-none"> <form id="gradetreeform" method="post" action="{{actionurl}}" > <div class="position-relative"> <input type="hidden" name="sesskey" value="{{sesskey}}"> {{{table}}} {{{stickyfooter}}} </div> </form> </div> templates/scales_action_bar.mustache 0000604 00000006376 15062070557 0013747 0 ustar 00 {{! 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/>. }} {{! @template core_grades/scales_action_bar Actions bar for the gradebook scales page. Context variables required for this template: * generalnavselector - The data object containing the required properties to render the general navigation selector. * addnewscalebutton - The data object containing the required properties to render the 'add new scale' button. Example context (json): { "generalnavselector": { "name": "Gradebook tertiary navigation selector", "value": "opt2", "baseid": "select-menu56789", "selectedoption": "Scales", "options": [ { "selected": false, "isgroup": { "name": "View", "id": "select-menu-group1", "options": [ { "name": "Grader report", "value": "opt1", "id": "select-menu-option1", "selected": false } ] } }, { "selected": false, "isgroup": { "name": "More", "id": "select-menu-group2", "options": [ { "name": "Scales", "value": "opt2", "id": "select-menu-option2", "selected": true } ] } } ] }, "addnewscalebutton": { "id": "single_button12345", "method" : "get", "classes": "singlebutton", "formid": null, "url" : "#", "primary" : true, "tooltip" : null, "label" : "Manage outcomes", "attributes": [] } } }} <div class="container-fluid tertiary-navigation full-width-bottom-border"> <div class="row"> {{#generalnavselector}} <div class="navitem"> {{>core/tertiary_navigation_selector}} </div> <div class="navitem-divider"></div> {{/generalnavselector}} {{#addnewscalebutton}} <div class="navitem"> {{>core/single_button}} </div> {{/addnewscalebutton}} </div> </div> templates/feedback_modal.mustache 0000604 00000004242 15062070557 0013202 0 ustar 00 {{! 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/>. }} {{! @template core_grades/feedback_modal The body of the modal displayed when viewing feedback for a grade item. Context variables required for this template: * feedbacktext - The full text of the feedback. * user - Object containing information about the student. * picture - The image corresponding to the user. * fullname - The users full name. * additionalfield - Additional text displayed below the users full name (e.g. the users email address) Example context (json): { "feedbacktext": "<p>Example feedback text</p>", "user": { "picture": "<img src=\"http://example.com/pluginfile.php/14/user/icon/boost/f2\" class=\"userpicture\" width=\"40\" alt=\"\">", "fullname": "John Doe", "additionalfield": "johndoe@example.com" } } }} {{#user}} <div class="d-flex p-3"> <div class="d-block pr-3"> {{#picture}} {{{picture}}} {{/picture}} {{^picture}} <span class="userinitials"></span> {{/picture}} </div> <div class="d-block"> <span class="p-0 font-weight-bold"> {{fullname}} </span> {{#additionalfield}} <span class="d-block small"> {{additionalfield}} </span> {{/additionalfield}} </div> </div> {{/user}} <div class="box p-3"> {{{feedbacktext}}} </div> templates/general_action_bar.mustache 0000604 00000005303 15062070557 0014077 0 ustar 00 {{! 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/>. }} {{! @template core_grades/general_action_bar The general actions bar for navigating through the gradebook pages. Context variables required for this template: * generalnavselector - The data object containing the required properties to render the general navigation selector. Example context (json): { "generalnavselector": { "name": "Gradebook tertiary navigation selector", "value": "opt1", "baseid": "select-menu56789", "selectedoption": "Grader report", "options": [ { "selected": false, "isgroup": { "name": "View", "id": "select-menu-group1", "options": [ { "name": "Grader report", "value": "opt1", "id": "select-menu-option1", "selected": true } ] } }, { "selected": false, "isgroup": { "name": "More", "id": "select-menu-group2", "options": [ { "name": "Import", "value": "opt2", "id": "select-menu-option2", "selected": false } ] } } ] } } }} <div class="container-fluid tertiary-navigation full-width-bottom-border"> <div class="row"> {{#generalnavselector}} <div class="navitem"> {{>core/tertiary_navigation_selector}} </div> <div class="navitem-divider"></div> {{/generalnavselector}} </div> </div> templates/user_heading.mustache 0000604 00000005122 15062070557 0012735 0 ustar 00 {{! 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/>. }} {{! @template core_grades/user_heading Custom user heading. Context variables required for this template: * image - HTML img element representing the avatar of the user. * userprofileurl - The URL to the user profile page. * name - The name of the user * buttons - List of buttons to be displayed in the heading for the user report (e.g. 'message', 'add user to contacts') Example context (json): { "image": "<img src=\"http://example.com/pluginfile.php/14/user/icon/boost/f2\" class=\"userpicture\" width=\"50\" alt=\"\">", "userprofileurl": "http://example.com/user/view.php?id=6&course=8", "name": "John Doe", "buttons": [ { "linkattributes": [ { "name": "role", "value": "button" }, { "name": "data-userid", "value": "3" } ], "title": "Message", "url": "http://example.com/message/index.php?user1=2&user2=3&addcontact=3", "icon": { "name": "t/message", "component": "core" } } ] } }} <div class="user-heading d-flex align-items-center"> <div class="d-flex h4"> {{{image}}} </div> <div class="d-flex ml-2"> <h2><a class="h4 m-0" href="{{userprofileurl}}">{{name}}</a></h2> </div> <div class="d-inline-flex ml-4"> {{#buttons}} <a {{#linkattributes}} {{name}}="{{value}}" {{/linkattributes}} aria-label="{{title}}" href="{{url}}"> {{#icon}} <span> {{#pix}} {{name}}, {{component}}, {{title}} {{/pix}} </span> {{/icon}} </a> {{/buttons}} </div> </div> templates/weight_override_field.mustache 0000604 00000003262 15062070557 0014634 0 ustar 00 {{! 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/>. }} {{! @template core_grades/weight_override_field Weight override field. Example context (json): { "itemname": "Awesome test", "id": "2", "checked": "true", "value": "100" } }} <div class="form-inline"> <label class="accesshide" for="weightoverride_{{id}}"> {{#str}}overrideweightofa, grades, {{itemname}}{{/str}} </label> <input type="hidden" name="weightoverride_{{id}}" value="0"> <input type="checkbox" name="weightoverride_{{id}}" id="weightoverride_{{id}}" value="1" class="weightoverride" {{#checked}}checked{{/checked}}> <label class="accesshide" for="weight_{{id}}"> {{#str}}weightofa, grades, {{itemname}}{{/str}} </label> <input type="text" name="weight_{{id}}" id="weight_{{id}}" value="{{value}}" size="4" {{#disabled}}disabled{{/disabled}} class="form-control"> <span style="margin-left:5px">%</span> <div class="form-control-feedback invalid-feedback ml-3" id="id_error_weight_{{id}}"></div> </div> templates/manage_outcomes_action_bar.mustache 0000604 00000006736 15062070557 0015643 0 ustar 00 {{! 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/>. }} {{! @template core_grades/manage_outcomes_action_bar Actions bar for the manage outcomes page. Context variables required for this template: * backbutton - The data object containing the required properties to render the 'back' button. * addoutcomebutton - The data object containing the required properties to render the 'add a new outcome' button. * importoutcomesbutton - The data object containing the required properties to render the 'import outcomes' button. * exportoutcomesbutton - The data object containing the required properties to render the 'export outcomes' button. Example context (json): { "backbutton": { "id": "single_button12345", "method" : "get", "classes": "singlebutton", "formid": null, "url" : "#", "primary" : false, "tooltip" : null, "label" : "Back", "attributes": [] }, "addoutcomebutton": { "id": "single_button13245", "method" : "get", "classes": "singlebutton", "formid": null, "url" : "#", "primary" : true, "tooltip" : null, "label" : "Add a new outcome", "attributes": [] }, "importoutcomesbutton": { "id": "single_button14325", "method" : "get", "classes": "singlebutton", "formid": null, "url" : "#", "primary" : false, "tooltip" : null, "label" : "Import outcomes", "attributes": [] }, "exportoutcomesbutton": { "id": "single_button15245", "method" : "get", "classes": "singlebutton", "formid": null, "url" : "#", "primary" : false, "tooltip" : null, "label" : "Export all outcomes", "attributes": [] } } }} <div class="container-fluid tertiary-navigation full-width-bottom-border"> <div class="row"> {{#backbutton}} <div class="navitem"> {{>core/single_button}} </div> <div class="navitem-divider"></div> {{/backbutton}} {{#addoutcomebutton}} <div class="navitem"> {{>core/single_button}} </div> {{/addoutcomebutton}} <div class="ml-auto d-flex"> {{#importoutcomesbutton}} <div class="navitem"> {{>core/single_button}} </div> {{/importoutcomesbutton}} {{#exportoutcomesbutton}} <div class="navitem"> {{>core/single_button}} </div> {{/exportoutcomesbutton}} </div> </div> </div> templates/gradebook_setup_action_bar.mustache 0000604 00000006530 15062070557 0015642 0 ustar 00 {{! 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/>. }} {{! @template core_grades/gradebook_setup_action_bar Actions bar for the gradebook setup page. Context variables required for this template: * generalnavselector - The data object containing the required properties to render the general navigation selector. * addmenu - The data object containing the required properties to render the 'Add' action menu. Example context (json): { "generalnavselector": { "name": "Gradebook tertiary navigation selector", "value": "opt2", "baseid": "select-menu56789", "selectedoption": "Gradebook setup", "options": [ { "selected": false, "isgroup": { "name": "View", "id": "select-menu-group1", "options": [ { "name": "Grader report", "value": "opt1", "id": "select-menu-option1", "selected": false } ] } }, { "selected": false, "isgroup": { "name": "Setup", "id": "select-menu-group2", "options": [ { "name": "Gradebook setup", "value": "opt2", "id": "select-menu-option2", "selected": true } ] } } ] }, "addmenu": [ { "classes": "", "primary": { "items": [{"rawhtml": "<p>Item in primary menu</p>"}] }, "secondary": { "items": [{"rawhtml": "<p>Item in secondary menu</p>"}] } } ] } }} <div class="container-fluid tertiary-navigation full-width-bottom-border"> <div class="row"> {{#generalnavselector}} <div class="navitem"> {{>core/tertiary_navigation_selector}} </div> <div class="navitem-divider"></div> {{/generalnavselector}} <div class="navitem-divider ml-auto"></div> <div class="navitem"> {{#addmenu}} {{>core/action_menu}} {{/addmenu}} </div> <div class="navitem-divider"></div> </div> </div> templates/initials_dropdown_form.mustache 0000604 00000002766 15062070557 0015066 0 ustar 00 {{! 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/>. }} {{! @template core_grades/initials_dropdown_form The form component of our dropdown within the tertiary navigation. Context variables required for this template: * courseid - The course ID. * initialsbars - The rendered mini renderer from the user renderer. Example context (json): { "courseid": "2", "initialsbars": "Output from renderer method" } }} <form class="initialsdropdownform" action="#" data-courseid="{{courseid}}"> {{{initialsbars}}} <div class="d-flex flex-row justify-content-end"> <input class="btn btn-outline-secondary pull-right mx-2" data-action="cancel" type="submit" value="{{#str}}closebuttontitle{{/str}}"> <input class="btn btn-primary pull-right" data-action="save" type="submit" value="{{#str}}apply{{/str}}"> </div> </form> templates/grades/grader/input.mustache 0000604 00000002343 15062070557 0014152 0 ustar 00 {{! 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/>. }} {{! @template core_grades/grades/grader/input Input template for grader report cell. Example context (json): { "id": "grade_313_624", "label": "grade_313_624", "title": "Grade", "extraclasses": "statusicons", "value": "Text information", "tabindex": "1", "name": "grade[313][624]" } }} <label for="{{id}}" class="accesshide">{{{label}}}</label> <input id="{{id}}" name="{{name}}" type="text" value="{{value}}" title="{{title}}" class="{{extraclasses}}" tabindex="{{tabindex}}"> templates/grades/grader/text.mustache 0000604 00000002231 15062070557 0013773 0 ustar 00 {{! 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/>. }} {{! @template core_grades/grades/grader/text Text template for grader report cell. Example context (json): { "gradepassicon": "<i class='icon fa fa-times text-danger fa-fw ' title='Fail' role='img' aria-label='Fail'></i>", "extraclasses": " dimmed_text", "text": "<span class='gradevalue dimmed_text '>Mostly separate knowing</span>" } }} <div class="header"> {{{gradepassicon}}} <span class="{{extraclasses}}">{{{text}}}</span> </div> templates/grades/grader/scale.mustache 0000604 00000001766 15062070557 0014112 0 ustar 00 {{! 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/>. }} {{! @template core_grades/grades/grader/scale Scale template for grader report cell. Example context (json): { "label": "Text label", "select": "<select><option value='-1'>No outcome</option><option value='1'>Mostly separate knowing</option></select>" } }} {{{label}}}{{{select}}} templates/grades/grader/gradingpanel/scale.mustache 0000604 00000003064 15062070557 0016536 0 ustar 00 {{! 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/>. }} {{! @template core_grades/grades/grader/gradingpanel/scale Scale-based grading template for use in the grading panel. Context variables required for this template: Example context (json): { "value": 1, "selected": true, "title": "Motivational" } }} <form> <div class="form-group"> <label for="core_grades-grade-{{uniqid}}">{{#str}}gradenoun, moodle{{/str}}</label> <select class="form-control" name="grade" id="core_grades-grade-{{uniqid}}" aria-describedby="core_grades-help-{{uniqid}}"> <option value="-1">{{#str}} nograde, moodle{{/str}}</option> {{#options}} <option value="{{value}}" {{#selected}}selected{{/selected}}>{{title}}</option> {{/options}} </select> <small id="core_grades-help-{{uniqid}}" class="form-text text-muted">{{#str}}grade_help, core_grades{{/str}}</small> </div> </form> templates/grades/grader/gradingpanel/point.mustache 0000604 00000002512 15062070557 0016575 0 ustar 00 {{! 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/>. }} {{! @template core_grades/grades/grader/gradingpanel/point Point-based grading template for use in the grading panel. Context variables required for this template: Example context (json): { "grade": 47 } }} <form> <div class="form-group"> <label for="core_grades-grade-{{uniqid}}">{{#str}}gradenoun, moodle{{/str}}</label> <input class="form-control" type="number" name="grade" value="{{grade}}" id="core_grades-grade-{{uniqid}}" aria-describedby="core_grades-help-{{uniqid}}"> <small id="core_grades-help-{{uniqid}}" class="form-text text-muted">{{#str}}grade_help, core_grades{{/str}}</small> </div> </form> templates/grades/grader/gradingpanel/point_blank.mustache 0000604 00000001634 15062070557 0017750 0 ustar 00 {{! 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/>. }} {{! @template core_grades/grades/grader/gradingpanel/point_blank Point-based grading template for use in the grading panel. Context variables required for this template: Example context (json): { } }} templates/course_outcomes_action_bar.mustache 0000604 00000006442 15062070557 0015705 0 ustar 00 {{! 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/>. }} {{! @template core_grades/course_outcomes_action_bar Actions bar for the gradebook course outcomes page. Context variables required for this template: * generalnavselector - The data object containing the required properties to render the general navigation selector. * manageoutcomesbutton - The data object containing the required properties to render the 'manage outcomes' button. Example context (json): { "generalnavselector": { "name": "Gradebook tertiary navigation selector", "value": "opt2", "baseid": "select-menu56789", "selectedoption": "Outcomes", "options": [ { "selected": false, "isgroup": { "name": "View", "id": "select-menu-group1", "options": [ { "name": "Grader report", "value": "opt1", "id": "select-menu-option1", "selected": false } ] } }, { "selected": false, "isgroup": { "name": "More", "id": "select-menu-group2", "options": [ { "name": "Outcomes", "value": "opt2", "id": "select-menu-option2", "selected": true } ] } } ] }, "manageoutcomesbutton": { "id": "single_button12345", "method" : "get", "classes": "singlebutton", "formid": null, "url" : "#", "primary" : true, "tooltip" : null, "label" : "Manage outcomes", "attributes": [] } } }} <div class="container-fluid tertiary-navigation full-width-bottom-border"> <div class="row"> {{#generalnavselector}} <div class="navitem"> {{>core/tertiary_navigation_selector}} </div> <div class="navitem-divider"></div> {{/generalnavselector}} {{#manageoutcomesbutton}} <div class="navitem"> {{>core/single_button}} </div> {{/manageoutcomesbutton}} </div> </div> templates/import_action_bar.mustache 0000604 00000007502 15062070557 0013777 0 ustar 00 {{! 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/>. }} {{! @template core_grades/import_action_bar Actions bar for the gradebook import pages. Context variables required for this template: * generalnavselector - The data object containing the required properties to render the general navigation selector. * importselector - The data object containing the required properties to render the import options selector. Example context (json): { "generalnavselector": { "name": "Gradebook tertiary navigation selector", "value": "opt2", "baseid": "select-menu56788", "selectedoption": "Import", "options": [ { "selected": false, "isgroup": { "name": "View", "id": "select-menu-group1", "options": [ { "name": "Grader report", "value": "opt1", "id": "select-menu-option1", "selected": false } ] } }, { "selected": false, "isgroup": { "name": "More", "id": "select-menu-group2", "options": [ { "name": "Import", "value": "opt2", "id": "select-menu-option2", "selected": true } ] } } ] }, "importselector": { "name": "importas", "value": "https://example.com/grade/import/csv/index.php", "baseid": "select-menu56789", "label": "Import as", "labelattributes": [ { "name": "class", "value": "font-weight-bold" } ], "selectedoption": "CSV file", "options": [ { "name": "CSV file", "value": "https://example.com/grade/import/csv/index.php", "selected": true, "id": "select-menu-option56789" } ] } } }} <div class="container-fluid tertiary-navigation full-width-bottom-border"> <div class="row"> {{#generalnavselector}} <div class="navitem"> {{>core/tertiary_navigation_selector}} </div> <div class="navitem-divider"></div> {{/generalnavselector}} {{#importselector}} <div class="navitem"> {{>core/select_menu}} </div> {{#js}} document.querySelector('#{{baseid}}').addEventListener('change', function(e) { window.location.href = e.target.value; }); {{/js}} {{/importselector}} </div> </div> templates/category_settings.mustache 0000604 00000004276 15062070557 0014046 0 ustar 00 {{! 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/>. }} {{! @template core_grades/category_settings This template renders action menu for a given cell. Example context (json): { "aggregation": "Natural", "aggregateonlygraded": 1, "aggregateoutcomes": 0, "droplow": 1, "keephigh": 1, "calculatedgrade": "calculated grade" } }} <div class="card-deck" role="list"> {{#calculatedgrade}} <span class="badge badge-pill badge-light" role="listitem"> <strong>{{calculatedgrade}}</strong> </span> {{/calculatedgrade}} {{#aggregation}} <span class="badge badge-pill badge-light" role="listitem"> <strong>{{aggregation}}</strong> </span> {{/aggregation}} {{#aggregateonlygraded}} <span class="badge badge-pill badge-light" role="listitem"> <strong>{{#str}}aggregateonlygraded, grades{{/str}}</strong> </span> {{/aggregateonlygraded}} {{#aggregateoutcomes}} <span class="badge badge-pill badge-light" role="listitem"> <strong>{{#str}}aggregateoutcomes, grades{{/str}}</strong> </span> {{/aggregateoutcomes}} {{#droplow}} <span class="badge badge-pill badge-light" role="listitem"> <strong>{{#str}}droplowestvalues, grades, {{droplow}}{{/str}}</strong> </span> {{/droplow}} {{#keephigh}} <span class="badge badge-pill badge-light" role="listitem"> <strong>{{#str}}keephigh, grades{{/str}}</strong> </span> {{/keephigh}} </div> upgrade.txt 0000604 00000010204 15062070557 0006734 0 ustar 00 This file describes API changes in /grade/* ; Information provided here is intended especially for developers. === 4.3 === * The $showtitle parameter in the print_grade_page_head function located inside grade/lib.php has been deprecated and is not used anymore. * The deprecated `core_grades_create_gradecategory` external method has been removed, in addition to the accompanying `core_grades_external::create_gradecategory` methods * User, Group & Grade item JS classes have been added to easily enable the creation of combobox search components. Refer to the dev docs on details of how to implement this feature if desired. * basewidget.js has been deprecated and its uses replaced with the new JS classes mentioned above. * With the basewidget being deprecated all usages of it in core have now been migrated and the files that used it removed. The basewidget itself will go through the proper deprecation process and be removed in a future version. * The following webservices have had some optional parameters changed: - grade/classes/external/get_enrolled_users_for_selector - profileimage -> profileimageurl & profileimageurlsmall - return changed to use the core_user_external::user_description() method instead of a custom baked one. - grade/classes/external/get_groups_for_selector - Has been relocated to core_group_external::get_groups_for_selector() - groupimageurl is now available as an optional parameter to give the user an image either set or generated for the group. * The grade `itemname` property contained in the return structure of the following external methods is now PARAM_CLEANHTML: - `core_grades_get_gradeitems` - `gradereport_user_get_grade_items` * The grade_helper::get_lang_string() function has been deprecated. Please use get_string() instead. === 4.1 === * The $importactiveurl parameter in the constructor of the core_grades\output\import_action_bar class has been deprecated and is not used anymore. * The $exportactiveurl parameter in the constructor of the core_grades\output\export_action_bar class has been deprecated and is not used anymore. * The select_in_gradebook_navigation_selector() function in behat_grade.php has been deprecated. Please use behat_forms::i_set_the_field_to() instead. === 4.0 === * The select_in_gradebook_tabs() function in behat_grade.php has been deprecated. Please use the function select_in_gradebook_navigation_selector() instead. * The setting $CFG->grade_navmethod setting has been completely removed because it's not required anymore. This setting was used to set the type of navigation (tabs or dropdown box) used in gradebook which is now replaced with tertiary navigation. * The print_grade_plugin_selector() function has been deprecated. This function was used to generate and output the dropdown box navigation in gradebook which is now replaced with tertiary navigation. * The grade_print_tabs() function has been deprecated. This function was used to generate and output the tabs navigation in gradebook which is now replaced with tertiary navigation. * There is a new callback inside of grade_get_plugin_info called extend_gradebook_plugininfo which allows for new tabs to be added to the gradebook. === 3.7 === * The grade_cron() function has been removed. Please use grade_history_cleanup_task and grade_cron_task scheduled tasks instead. === 3.6 === * The grade_plugin_return constructor now uses parameters from the request as defaults, which can be overridden by parameters supplied to the constructor. This may lead to a change in behaviour if only some of the possible parameters are supplied. * The grade_plugin_return class now tracks groupid as well as the type, plugin, courseid, userid and page parameters that were tracked previously. The groupid parameter will be set using groups_get_course_group for the relevant course if the group is otherwise unspecified. * The above changes mean that code using grade_plugin_return objects should generally no longer call groups_get_course_group directly, but should use the gpr->groupid parameter instead. * The grade_plugin_return constructor now accepts either course or courseid as a parameter to specify course. renderer.php 0000604 00000022166 15062070557 0007075 0 ustar 00 <?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/>. defined('MOODLE_INTERNAL') || die; use core\output\comboboxsearch; use \core_grades\output\action_bar; use core_message\helper; use core_message\api; /** * Renderer class for the grade pages. * * @package core_grades * @copyright 2021 Mihail Geshoski <mihail@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class core_grades_renderer extends plugin_renderer_base { /** * Renders the action bar for a given page. * * @param action_bar $actionbar * @return string The HTML output */ public function render_action_bar(action_bar $actionbar): string { $data = $actionbar->export_for_template($this); return $this->render_from_template($actionbar->get_template(), $data); } /** * Renders the group selector trigger element. * * @param object $course The course object. * @param string|null $groupactionbaseurl The base URL for the group action. * @return string|null The raw HTML to render. */ public function group_selector(object $course, ?string $groupactionbaseurl = null): ?string { global $USER; // Make sure that group mode is enabled. if (!$groupmode = $course->groupmode) { return null; } $sbody = $this->render_from_template('core_group/comboboxsearch/searchbody', [ 'courseid' => $course->id, 'currentvalue' => optional_param('groupsearchvalue', '', PARAM_NOTAGS), ]); $label = $groupmode == VISIBLEGROUPS ? get_string('selectgroupsvisible') : get_string('selectgroupsseparate'); $data = [ 'name' => 'group', 'label' => $label, 'courseid' => $course->id, 'groupactionbaseurl' => $groupactionbaseurl ]; $context = context_course::instance($course->id); if ($groupmode == VISIBLEGROUPS || has_capability('moodle/site:accessallgroups', $context)) { $allowedgroups = groups_get_all_groups($course->id, 0, $course->defaultgroupingid); } else { $allowedgroups = groups_get_all_groups($course->id, $USER->id, $course->defaultgroupingid); } $activegroup = groups_get_course_group($course, true, $allowedgroups); $data['group'] = $activegroup; if ($activegroup) { $group = groups_get_group($activegroup); $data['selectedgroup'] = format_string($group->name, true, ['context' => $context]); } else if ($activegroup === 0) { $data['selectedgroup'] = get_string('allparticipants'); } $groupdropdown = new comboboxsearch( false, $this->render_from_template('core_group/comboboxsearch/group_selector', $data), $sbody, 'group-search', 'groupsearchwidget', 'groupsearchdropdown overflow-auto w-100', ); return $this->render_from_template($groupdropdown->get_template(), $groupdropdown->export_for_template($this)); } /** * Build the data to render the initials bar filter within the gradebook. * Using this initials selector means you'll have to retain the use of the templates & JS to handle form submission. * If a simple redirect on each selection is desired the standard user_search() within the user renderer is what you are after. * * @param object $course The course object. * @param context $context Our current context. * @param string $slug The slug for the report that called this function. * @return stdClass The data to output. */ public function initials_selector( object $course, context $context, string $slug ): stdClass { global $SESSION, $COURSE; // User search. $searchvalue = optional_param('searchvalue', null, PARAM_NOTAGS); $userid = optional_param('userid', null, PARAM_INT); $url = new moodle_url($slug, ['id' => $course->id]); $firstinitial = $SESSION->gradereport["filterfirstname-{$context->id}"] ?? ''; $lastinitial = $SESSION->gradereport["filtersurname-{$context->id}"] ?? ''; $renderer = $this->page->get_renderer('core_user'); $initialsbar = $renderer->partial_user_search($url, $firstinitial, $lastinitial, true); $currentfilter = ''; if ($firstinitial !== '' && $lastinitial !== '') { $currentfilter = get_string('filterbothactive', 'grades', ['first' => $firstinitial, 'last' => $lastinitial]); } else if ($firstinitial !== '') { $currentfilter = get_string('filterfirstactive', 'grades', ['first' => $firstinitial]); } else if ($lastinitial !== '') { $currentfilter = get_string('filterlastactive', 'grades', ['last' => $lastinitial]); } $this->page->requires->js_call_amd('core_grades/searchwidget/initials', 'init', [$slug, $userid, $searchvalue]); $formdata = (object) [ 'courseid' => $COURSE->id, 'initialsbars' => $initialsbar, ]; $dropdowncontent = $this->render_from_template('core_grades/initials_dropdown_form', $formdata); return (object) [ 'buttoncontent' => $currentfilter !== '' ? $currentfilter : get_string('filterbyname', 'core_grades'), 'buttonheader' => $currentfilter !== '' ? get_string('name') : null, 'dropdowncontent' => $dropdowncontent, ]; } /** * Creates and renders a custom user heading. * * @param stdClass $user The user object. * @param int $courseid The course ID. * @param bool $showbuttons Whether to display buttons (message, add to contacts) within the heading. * @return string The raw HTML to render. */ public function user_heading(stdClass $user, int $courseid, bool $showbuttons = true) : string { global $USER; $headingdata = [ 'userprofileurl' => (new moodle_url('/user/view.php', ['id' => $user->id, 'course' => $courseid]))->out(false), 'name' => fullname($user), 'image' => $this->user_picture($user, ['size' => 50, 'link' => false]) ]; if ($showbuttons) { // Generate the data for the 'message' button. $messagelinkattributes = array_map(function($name, $value) { return ['name' => $name, 'value' => $value]; }, array_keys(helper::messageuser_link_params($user->id)), helper::messageuser_link_params($user->id)); $messagelinkattributes[] = ['name' => 'class', 'value' => 'btn px-0']; $headingdata['buttons'][] = [ 'title' => get_string('message', 'message'), 'url' => (new moodle_url('/message/index.php', ['id' => $user->id]))->out(false), 'icon' => ['name' => 't/message', 'component' => 'core'], 'linkattributes' => $messagelinkattributes ]; // Include js for messaging. helper::messageuser_requirejs(); if ($USER->id != $user->id) { // Generate the data for the 'contact' button. $iscontact = api::is_contact($USER->id, $user->id); $contacttitle = $iscontact ? 'removefromyourcontacts' : 'addtoyourcontacts'; $contacturlaction = $iscontact ? 'removecontact' : 'addcontact'; $contacticon = $iscontact ? 't/removecontact' : 't/addcontact'; $togglelinkparams = helper::togglecontact_link_params($user, $iscontact, false); $togglecontactlinkattributes = array_map(function($name, $value) { if ($name === 'class') { $value .= ' btn px-0'; } return ['name' => $name, 'value' => $value]; }, array_keys($togglelinkparams), $togglelinkparams); $headingdata['buttons'][] = [ 'title' => get_string($contacttitle, 'message'), 'url' => (new moodle_url('/message/index.php', ['user1' => $USER->id, 'user2' => $user->id, $contacturlaction => $user->id, 'sesskey' => sesskey()]))->out(false), 'icon' => ['name' => $contacticon, 'component' => 'core'], 'linkattributes' => $togglecontactlinkattributes ]; // Include js for contact toggle. helper::togglecontact_requirejs(); } } return $this->render_from_template('core_grades/user_heading', $headingdata); } } index.php 0000604 00000002060 15062070557 0006365 0 ustar 00 <?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/>. /** * This page is provided for compatability and redirects the user to the default grade report * * @package core_grades * @copyright 2005 onwards Martin Dougiamas {@link http://moodle.com} * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once '../config.php'; $id = required_param('id', PARAM_INT); redirect('report/index.php?id='.$id); querylib.php 0000604 00000031301 15062070557 0007112 0 ustar 00 <?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/>. /** * Functions used to retrieve grades objects * * @package core_grades * @category grade * @copyright 2008 Petr Skoda and Nicolas Connault * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ /** * Returns the aggregated or calculated course grade(s) for a single course for one or more users * * @param int $courseid The ID of course * @param int|array $userid_or_ids Optional ID of the graded user or array of user IDs; if userid not used, returns only information about grade_item * @return stdClass Returns an object containing information about course grade item. scaleid, name, grade * and locked status etc and user course grades: $item->grades[$userid] => $usercoursegrade */ function grade_get_course_grades($courseid, $userid_or_ids=null) { $grade_item = grade_item::fetch_course_item($courseid); if ($grade_item->needsupdate) { grade_regrade_final_grades($courseid); } $item = new stdClass(); $item->scaleid = $grade_item->scaleid; $item->name = $grade_item->get_name(); $item->grademin = $grade_item->grademin; $item->grademax = $grade_item->grademax; $item->gradepass = $grade_item->gradepass; $item->locked = $grade_item->is_locked(); $item->hidden = $grade_item->is_hidden(); $item->grades = array(); switch ($grade_item->gradetype) { case GRADE_TYPE_NONE: break; case GRADE_TYPE_VALUE: $item->scaleid = 0; break; case GRADE_TYPE_TEXT: $item->scaleid = 0; $item->grademin = 0; $item->grademax = 0; $item->gradepass = 0; break; } if (empty($userid_or_ids)) { $userids = array(); } else if (is_array($userid_or_ids)) { $userids = $userid_or_ids; } else { $userids = array($userid_or_ids); } if ($userids) { $grade_grades = grade_grade::fetch_users_grades($grade_item, $userids, true); foreach ($userids as $userid) { $grade_grades[$userid]->grade_item =& $grade_item; $grade = new stdClass(); $grade->grade = $grade_grades[$userid]->finalgrade; $grade->locked = $grade_grades[$userid]->is_locked(); $grade->hidden = $grade_grades[$userid]->is_hidden(); $grade->overridden = $grade_grades[$userid]->overridden; $grade->feedback = $grade_grades[$userid]->feedback; $grade->feedbackformat = $grade_grades[$userid]->feedbackformat; $grade->usermodified = $grade_grades[$userid]->usermodified; $grade->dategraded = $grade_grades[$userid]->get_dategraded(); $grade->datesubmitted = $grade_grades[$userid]->get_datesubmitted(); // create text representation of grade if ($grade_item->needsupdate) { $grade->grade = false; $grade->str_grade = get_string('error'); $grade->str_long_grade = $grade->str_grade; } else if (is_null($grade->grade)) { $grade->str_grade = '-'; $grade->str_long_grade = $grade->str_grade; } else { $grade->str_grade = grade_format_gradevalue($grade->grade, $grade_item); if ($grade_item->gradetype == GRADE_TYPE_SCALE or $grade_item->get_displaytype() != GRADE_DISPLAY_TYPE_REAL) { $grade->str_long_grade = $grade->str_grade; } else { $a = new stdClass(); $a->grade = $grade->str_grade; $a->max = grade_format_gradevalue($grade_item->grademax, $grade_item); $grade->str_long_grade = get_string('gradelong', 'grades', $a); } } // create html representation of feedback if (is_null($grade->feedback)) { $grade->str_feedback = ''; } else { $grade->str_feedback = format_text($grade->feedback, $grade->feedbackformat); } $item->grades[$userid] = $grade; } } return $item; } /** * Returns the aggregated or calculated course grade for a single user for one or more courses * * @param int $userid The ID of the single user * @param int|array $courseid_or_ids Optional ID of course or array of IDs, empty means all of the user's courses * @return mixed grade info or grades array including item info, false if error */ function grade_get_course_grade($userid, $courseid_or_ids=null) { if (!is_array($courseid_or_ids)) { if (empty($courseid_or_ids)) { if (!$courses = enrol_get_users_courses($userid)) { return false; } $courseids = array_keys($courses); return grade_get_course_grade($userid, $courseids); } if (!is_numeric($courseid_or_ids)) { return false; } if (!$grades = grade_get_course_grade($userid, array($courseid_or_ids))) { return false; } else { // only one grade - not array $grade = reset($grades); return $grade; } } foreach ($courseid_or_ids as $courseid) { $grade_item = grade_item::fetch_course_item($courseid); $course_items[$grade_item->courseid] = $grade_item; } $grades = array(); foreach ($course_items as $grade_item) { if ($grade_item->needsupdate) { grade_regrade_final_grades($courseid); } $item = new stdClass(); $item->scaleid = $grade_item->scaleid; $item->name = $grade_item->get_name(); $item->grademin = $grade_item->grademin; $item->grademax = $grade_item->grademax; $item->gradepass = $grade_item->gradepass; $item->locked = $grade_item->is_locked(); $item->hidden = $grade_item->is_hidden(); switch ($grade_item->gradetype) { case GRADE_TYPE_NONE: break; case GRADE_TYPE_VALUE: $item->scaleid = 0; break; case GRADE_TYPE_TEXT: $item->scaleid = 0; $item->grademin = 0; $item->grademax = 0; $item->gradepass = 0; break; } $grade_grade = new grade_grade(array('userid'=>$userid, 'itemid'=>$grade_item->id)); $grade_grade->grade_item =& $grade_item; $grade = new stdClass(); $grade->grade = $grade_grade->finalgrade; $grade->locked = $grade_grade->is_locked(); $grade->hidden = $grade_grade->is_hidden(); $grade->overridden = $grade_grade->overridden; $grade->feedback = $grade_grade->feedback; $grade->feedbackformat = $grade_grade->feedbackformat; $grade->usermodified = $grade_grade->usermodified; $grade->dategraded = $grade_grade->get_dategraded(); $grade->item = $item; // create text representation of grade if ($grade_item->needsupdate) { $grade->grade = false; $grade->str_grade = get_string('error'); $grade->str_long_grade = $grade->str_grade; } else if (is_null($grade->grade)) { $grade->str_grade = '-'; $grade->str_long_grade = $grade->str_grade; } else { $grade->str_grade = grade_format_gradevalue($grade->grade, $grade_item); if ($grade_item->gradetype == GRADE_TYPE_SCALE or $grade_item->get_displaytype() != GRADE_DISPLAY_TYPE_REAL) { $grade->str_long_grade = $grade->str_grade; } else { $a = new stdClass(); $a->grade = $grade->str_grade; $a->max = grade_format_gradevalue($grade_item->grademax, $grade_item); $grade->str_long_grade = get_string('gradelong', 'grades', $a); } } // create html representation of feedback if (is_null($grade->feedback)) { $grade->str_feedback = ''; } else { $grade->str_feedback = format_text($grade->feedback, $grade->feedbackformat); } $grades[$grade_item->courseid] = $grade; } return $grades; } /** * Returns all grade items (including outcomes) or main item for a given activity identified by $cm object. * * @param cm_info $cm A course module object (preferably with modname property) * @param bool $only_main_item Limit the search to the primary grade item for the activity, 'itemnumber'==0 * @return mixed An array of grade item instances, one grade item if $only_main_item == true, false if error or not found */ function grade_get_grade_items_for_activity($cm, $only_main_item=false) { global $CFG, $DB; if (!isset($cm->modname)) { $params = array($cm->id); $cm = $DB->get_record_sql("SELECT cm.*, md.name as modname FROM {course_modules} cm, {modules} md WHERE cm.id = ? AND md.id = cm.module", $params); } if (empty($cm) or empty($cm->instance) or empty($cm->course)) { debugging("Incorrect cm parameter in grade_get_grade_items_for_activity()!"); return false; } if ($only_main_item) { return grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$cm->modname, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course, 'itemnumber'=>0)); } else { return grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$cm->modname, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course)); } } /** * Returns whether or not a user received grades in main grade item for given activity * * @param cm_info $cm The activity context module * @param int $userid The user ID * @return bool True if graded, false if user not graded yet */ function grade_is_user_graded_in_activity($cm, $userid) { $grade_items = grade_get_grade_items_for_activity($cm, true); if (empty($grade_items)) { return false; } $grade_item = reset($grade_items); if ($grade_item->gradetype == GRADE_TYPE_NONE) { return false; } if ($grade_item->needsupdate) { // activity items should never fail to regrade grade_regrade_final_grades($grade_item->courseid); } if (!$grade = $grade_item->get_final($userid)) { return false; } if (is_null($grade->finalgrade)) { return false; } return true; } /** * Returns an array of activities (defined as $cm objects) which are gradeable from gradebook, outcomes are ignored. * * @param int $courseid If provided then restrict to one course. * @param string $modulename If defined (could be 'forum', 'assignment' etc) then only that type are returned. * @return array $cm objects */ function grade_get_gradable_activities($courseid, $modulename='') { global $CFG, $DB; if (empty($modulename)) { if (!$modules = $DB->get_records('modules', array('visible' => '1'))) { return false; } $result = array(); foreach ($modules as $module) { if ($cms = grade_get_gradable_activities($courseid, $module->name)) { $result = $result + $cms; } } if (empty($result)) { return false; } else { return $result; } } $params = array($courseid, $modulename, GRADE_TYPE_NONE, $modulename); $sql = "SELECT cm.*, m.name, md.name as modname FROM {grade_items} gi, {course_modules} cm, {modules} md, {{$modulename}} m WHERE gi.courseid = ? AND gi.itemtype = 'mod' AND gi.itemmodule = ? AND gi.itemnumber = 0 AND gi.gradetype != ? AND gi.iteminstance = cm.instance AND cm.instance = m.id AND md.name = ? AND md.id = cm.module"; return $DB->get_records_sql($sql, $params); } edit/scale/edit.php 0000604 00000013046 15062070557 0010225 0 ustar 00 <?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/>. /** * Edit page for grade scales * * @package core_grades * @copyright 2007 Petr Skoda * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once '../../../config.php'; require_once $CFG->dirroot.'/grade/lib.php'; require_once $CFG->dirroot.'/grade/report/lib.php'; require_once 'edit_form.php'; $courseid = optional_param('courseid', 0, PARAM_INT); $id = optional_param('id', 0, PARAM_INT); $PAGE->set_url('/grade/edit/scale/edit.php', array('id' => $id, 'courseid' => $courseid)); $PAGE->set_pagelayout('admin'); navigation_node::override_active_url(new moodle_url('/grade/edit/scale/index.php', array('id' => $courseid))); $systemcontext = context_system::instance(); // a bit complex access control :-O if ($id) { /// editing existing scale if (!$scale_rec = $DB->get_record('scale', array('id' => $id))) { throw new \moodle_exception('invalidscaleid'); } if ($scale_rec->courseid) { $scale_rec->standard = 0; if (!$course = $DB->get_record('course', array('id' => $scale_rec->courseid))) { throw new \moodle_exception('invalidcourseid'); } require_login($course); $context = context_course::instance($course->id); require_capability('moodle/course:managescales', $context); $courseid = $course->id; } else { if ($courseid) { if (!$course = $DB->get_record('course', array('id' => $courseid))) { throw new \moodle_exception('invalidcourseid'); } } $scale_rec->standard = 1; $scale_rec->courseid = $courseid; require_login($courseid); require_capability('moodle/course:managescales', $systemcontext); } } else if ($courseid){ /// adding new scale from course if (!$course = $DB->get_record('course', array('id' => $courseid))) { throw new \moodle_exception('invalidcourseid'); } $scale_rec = new stdClass(); $scale_rec->standard = 0; $scale_rec->courseid = $courseid; require_login($course); $context = context_course::instance($course->id); require_capability('moodle/course:managescales', $context); } else { /// adding new scale from admin section $scale_rec = new stdClass(); $scale_rec->standard = 1; $scale_rec->courseid = 0; require_login(); require_capability('moodle/course:managescales', $systemcontext); } if (!$courseid) { require_once $CFG->libdir.'/adminlib.php'; admin_externalpage_setup('scales'); $PAGE->set_primary_active_tab('siteadminnode'); } // default return url $gpr = new grade_plugin_return(); $returnurl = $gpr->get_return_url('index.php?id='.$courseid); $editoroptions = array( 'maxfiles' => EDITOR_UNLIMITED_FILES, 'maxbytes' => $CFG->maxbytes, 'trusttext' => false, 'noclean' => true, 'context' => $systemcontext ); if (!empty($scale_rec->id)) { $editoroptions['subdirs'] = file_area_contains_subdirs($systemcontext, 'grade', 'scale', $scale_rec->id); $scale_rec = file_prepare_standard_editor($scale_rec, 'description', $editoroptions, $systemcontext, 'grade', 'scale', $scale_rec->id); } else { $editoroptions['subdirs'] = false; $scale_rec = file_prepare_standard_editor($scale_rec, 'description', $editoroptions, $systemcontext, 'grade', 'scale', null); } $mform = new edit_scale_form(null, compact('gpr', 'editoroptions')); $mform->set_data($scale_rec); if ($mform->is_cancelled()) { redirect($returnurl); } else if ($data = $mform->get_data()) { $scale = new grade_scale(array('id'=>$id)); $data->userid = $USER->id; if (empty($scale->id)) { $data->description = $data->description_editor['text']; $data->descriptionformat = $data->description_editor['format']; grade_scale::set_properties($scale, $data); if (!has_capability('moodle/grade:manage', $systemcontext)) { $data->standard = 0; } $scale->courseid = !empty($data->standard) ? 0 : $courseid; $scale->insert(); $data = file_postupdate_standard_editor($data, 'description', $editoroptions, $systemcontext, 'grade', 'scale', $scale->id); $DB->set_field($scale->table, 'description', $data->description, array('id'=>$scale->id)); } else { $data = file_postupdate_standard_editor($data, 'description', $editoroptions, $systemcontext, 'grade', 'scale', $id); grade_scale::set_properties($scale, $data); if (isset($data->standard)) { $scale->courseid = !empty($data->standard) ? 0 : $courseid; } else { unset($scale->courseid); // keep previous } $scale->update(); } redirect($returnurl); } $heading = $id ? get_string('editscale', 'grades') : get_string('addscale', 'grades'); $PAGE->navbar->add($heading); print_grade_page_head($COURSE->id, 'scale', null, $heading, false, false, false); $mform->display(); echo $OUTPUT->footer(); edit/scale/index.php 0000604 00000015746 15062070557 0010420 0 ustar 00 <?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/>. /** * A page for managing custom and standard scales * * @package core_grades * @copyright 2007 Petr Skoda * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once '../../../config.php'; require_once $CFG->dirroot.'/grade/lib.php'; require_once $CFG->libdir.'/gradelib.php'; $courseid = optional_param('id', 0, PARAM_INT); $action = optional_param('action', '', PARAM_ALPHA); $PAGE->set_url('/grade/edit/scale/index.php', array('id' => $courseid)); /// Make sure they can even access this course if ($courseid) { if (!$course = $DB->get_record('course', array('id' => $courseid))) { throw new \moodle_exception('invalidcourseid'); } require_login($course); $context = context_course::instance($course->id); require_capability('moodle/course:managescales', $context); $PAGE->set_pagelayout('admin'); } else { require_once $CFG->libdir.'/adminlib.php'; admin_externalpage_setup('scales'); $context = context_system::instance(); $PAGE->set_primary_active_tab('siteadminnode'); } /// return tracking object $gpr = new grade_plugin_return(array('type'=>'edit', 'plugin'=>'scale', 'courseid'=>$courseid)); $strscale = get_string('scale'); $strstandardscale = get_string('scalesstandard'); $strcustomscales = get_string('scalescustom'); $strname = get_string('name'); $strdelete = get_string('delete'); $stredit = get_string('edit'); $strused = get_string('used'); $stredit = get_string('edit'); switch ($action) { case 'delete': if (!confirm_sesskey()) { break; } $scaleid = required_param('scaleid', PARAM_INT); if (!$scale = grade_scale::fetch(array('id'=>$scaleid))) { break; } if (empty($scale->courseid)) { require_capability('moodle/course:managescales', context_system::instance()); } else if ($scale->courseid != $courseid) { throw new \moodle_exception('invalidcourseid'); } if (!$scale->can_delete()) { break; } $deleteconfirmed = optional_param('deleteconfirmed', 0, PARAM_BOOL); if (!$deleteconfirmed) { if ($courseid) { $PAGE->navbar->add(get_string('scales'), new moodle_url('/grade/edit/scale/index.php', ['id' => $courseid])); } $strdeletescale = get_string('deletescale', 'grades'); $PAGE->navbar->add($strdeletescale); $PAGE->set_title($strdeletescale); $PAGE->set_heading($COURSE->fullname); echo $OUTPUT->header(); $confirmurl = new moodle_url('index.php', array( 'id' => $courseid, 'scaleid' => $scale->id, 'action'=> 'delete', 'sesskey' => sesskey(), 'deleteconfirmed'=> 1)); echo $OUTPUT->confirm(get_string('scaleconfirmdelete', 'grades', $scale->get_name()), $confirmurl, "index.php?id={$courseid}"); echo $OUTPUT->footer(); die; } else { $scale->delete(); } break; } if (!$courseid) { echo $OUTPUT->header(); } $table = new html_table(); $table2 = new html_table(); $heading = ''; if ($courseid and $scales = grade_scale::fetch_all_local($courseid)) { $heading = $strcustomscales; $data = array(); foreach($scales as $scale) { $line = array(); $line[] = $scale->get_name() .'<div class="scale_options">'.str_replace(",", ", ", $scale->scale).'</div>'; $used = $scale->is_used(); $line[] = $used ? get_string('yes') : get_string('no'); $buttons = ""; $buttons .= grade_button('edit', $courseid, $scale); if (!$used) { $buttons .= grade_button('delete', $courseid, $scale); } $line[] = $buttons; $data[] = $line; } $table->head = array($strscale, $strused, $stredit); $table->size = array('70%', '20%', '10%'); $table->align = array('left', 'center', 'center'); $table->attributes['class'] = 'scaletable localscales generaltable'; $table->data = $data; } if ($scales = grade_scale::fetch_all_global()) { $heading = $strstandardscale; $data = array(); foreach($scales as $scale) { $line = array(); $line[] = $scale->get_name().'<div class="scale_options">'.str_replace(",", ", ", $scale->scale).'</div>'; $used = $scale->is_used(); $line[] = $used ? get_string('yes') : get_string('no'); $buttons = ""; if (has_capability('moodle/course:managescales', context_system::instance())) { $buttons .= grade_button('edit', $courseid, $scale); } if (!$used and has_capability('moodle/course:managescales', context_system::instance())) { $buttons .= grade_button('delete', $courseid, $scale); } $line[] = $buttons; $data[] = $line; } $table2->head = array($strscale, $strused, $stredit); $table->attributes['class'] = 'scaletable globalscales generaltable'; $table2->size = array('70%', '20%', '10%'); $table2->align = array('left', 'center', 'center'); $table2->data = $data; } $actionbar = new \core_grades\output\scales_action_bar($context); if ($courseid) { print_grade_page_head($courseid, 'scale', 'scale', false, false, false, true, null, null, null, $actionbar); } else { $renderer = $PAGE->get_renderer('core_grades'); echo $renderer->render_action_bar($actionbar); echo $OUTPUT->heading(get_string('scales', 'core')); } $hascustomscales = !empty($table->data); $hasstandardscales = !empty($table2->data); // If there are custom scales available in this context, output the custom scales table and a heading. if ($hascustomscales) { echo $OUTPUT->heading($strcustomscales, 3, 'main mt-3'); echo html_writer::table($table); } // If there are standard scales available in this context, output the standard scales table and a heading. if ($hasstandardscales) { echo $OUTPUT->heading($strstandardscale, 3, 'main mt-3'); echo html_writer::table($table2); } // If the are no available scales, display a notification. if (!$hascustomscales && !$hasstandardscales) { echo $OUTPUT->notification(get_string('noexistingscales', 'grades'), 'info', false); } echo $OUTPUT->footer(); edit/scale/edit_form.php 0000604 00000013710 15062070557 0011246 0 ustar 00 <?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/>. /** * Edit form for grade scales * * @package core_grades * @copyright 2007 Petr Skoda * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ if (!defined('MOODLE_INTERNAL')) { die('Direct access to this script is forbidden.'); /// It must be included from a Moodle page } require_once $CFG->libdir.'/formslib.php'; class edit_scale_form extends moodleform { function definition() { global $CFG; $mform =& $this->_form; // visible elements $mform->addElement('header', 'general', get_string('scale')); $mform->addElement('text', 'name', get_string('name'), 'size="40"'); $mform->addRule('name', get_string('required'), 'required', null, 'client'); $mform->setType('name', PARAM_TEXT); $mform->addElement('advcheckbox', 'standard', get_string('scalestandard')); $mform->addHelpButton('standard', 'scalestandard'); $mform->addElement('static', 'used', get_string('used')); $mform->addElement('textarea', 'scale', get_string('scale'), array('cols'=>50, 'rows'=>2)); $mform->addHelpButton('scale', 'scale'); $mform->addRule('scale', get_string('required'), 'required', null, 'client'); $mform->setType('scale', PARAM_TEXT); $mform->addElement('editor', 'description_editor', get_string('description'), null, $this->_customdata['editoroptions']); // hidden params $mform->addElement('hidden', 'id', 0); $mform->setType('id', PARAM_INT); $mform->addElement('hidden', 'courseid', 0); $mform->setType('courseid', PARAM_INT); /// add return tracking info $gpr = $this->_customdata['gpr']; $gpr->add_mform_elements($mform); //------------------------------------------------------------------------------- // buttons $this->add_action_buttons(); } /// tweak the form - depending on existing data function definition_after_data() { global $CFG; $mform =& $this->_form; $courseid = $mform->getElementValue('courseid'); if ($id = $mform->getElementValue('id')) { $scale = grade_scale::fetch(array('id'=>$id)); $used = $scale->is_used(); if ($used) { $mform->hardFreeze('scale'); } if (empty($courseid)) { $mform->hardFreeze('standard'); } else if (!has_capability('moodle/course:managescales', context_system::instance())) { //if they dont have managescales at system level the shouldnt be allowed to make scales standard (or not standard) $mform->hardFreeze('standard'); } else if ($used and !empty($scale->courseid)) { $mform->hardFreeze('standard'); } $usedstr = $scale->is_used() ? get_string('yes') : get_string('no'); $used_el =& $mform->getElement('used'); $used_el->setValue($usedstr); } else { $mform->removeElement('used'); if (empty($courseid) or !has_capability('moodle/course:managescales', context_system::instance())) { $mform->hardFreeze('standard'); } } } /// perform extra validation before submission function validation($data, $files) { global $CFG, $COURSE, $DB; $errors = parent::validation($data, $files); // we can not allow 2 scales with the same exact scale as this creates // problems for backup/restore $old = grade_scale::fetch(array('id'=>$data['id'])); if (array_key_exists('standard', $data)) { if (empty($data['standard'])) { $courseid = $COURSE->id; } else { $courseid = 0; } } else { $courseid = $old->courseid; } if (array_key_exists('scale', $data)) { $scalearray = explode(',', $data['scale']); $scalearray = array_map('trim', $scalearray); $scaleoptioncount = count($scalearray); if (count($scalearray) < 1) { $errors['scale'] = get_string('badlyformattedscale', 'grades'); } else { $thescale = implode(',',$scalearray); //this check strips out whitespace from the scale we're validating but not from those already in the DB $count = $DB->count_records_select('scale', "courseid=:courseid AND ".$DB->sql_compare_text('scale', core_text::strlen($thescale)).'=:scale', array('courseid'=>$courseid, 'scale'=>$thescale)); if ($count) { //if this is a new scale but we found a duplice in the DB //or we found a duplicate in another course report the error if (empty($old->id) or $old->courseid != $courseid) { $errors['scale'] = get_string('duplicatescale', 'grades'); } else if ($old->scale !== $thescale and $old->scale !== $data['scale']) { //if the old scale from DB is different but we found a duplicate then we're trying to modify a scale to be a duplicate $errors['scale'] = get_string('duplicatescale', 'grades'); } } } } return $errors; } } edit/letter/tabs.php 0000604 00000002731 15062070557 0010440 0 ustar 00 <?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/>. /** * Prints navigation tabs for viewing and editing grade letters * * @package core_grades * @copyright 2007 Petr Skoda * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ $row = $tabs = array(); $row[] = new tabobject('lettersview', $CFG->wwwroot.'/grade/edit/letter/index.php?id='.$COURSE->id, get_string('letters', 'grades')); if (has_capability('moodle/grade:manageletters', $context)) { $row[] = new tabobject('lettersedit', $CFG->wwwroot.'/grade/edit/letter/edit.php?id='.$context->id, get_string('edit')); } $tabs[] = $row; echo '<div class="letterdisplay">'; print_tabs($tabs, $currenttab); echo '</div>'; edit/letter/index.php 0000604 00000023044 15062070557 0010616 0 ustar 00 <?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/>. /** * List of grade letters. * * @package core_grades * @copyright 2008 Nicolas Connault * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once '../../../config.php'; require_once $CFG->dirroot.'/grade/lib.php'; require_once $CFG->libdir.'/gradelib.php'; $contextid = optional_param('id', SYSCONTEXTID, PARAM_INT); $action = optional_param('action', '', PARAM_ALPHA); $edit = optional_param('edit', false, PARAM_BOOL); //are we editing? $url = new moodle_url('/grade/edit/letter/index.php', array('id' => $contextid)); list($context, $course, $cm) = get_context_info_array($contextid); $contextid = null;//now we have a context object throw away the $contextid from the params //if viewing if (!$edit) { if (!has_capability('moodle/grade:manage', $context) and !has_capability('moodle/grade:manageletters', $context)) { throw new \moodle_exception('nopermissiontoviewletergrade'); } } else {//else we're editing require_capability('moodle/grade:manageletters', $context); navigation_node::override_active_url($url); $url->param('edit', 1); $PAGE->navbar->add(get_string('editgradeletters', 'grades'), $url); } $PAGE->set_url($url); $returnurl = null; $editparam = null; if ($context->contextlevel == CONTEXT_SYSTEM or $context->contextlevel == CONTEXT_COURSECAT) { require_once $CFG->libdir.'/adminlib.php'; admin_externalpage_setup('letters'); $admin = true; $returnurl = "$CFG->wwwroot/grade/edit/letter/index.php"; $editparam = '?edit=1'; $PAGE->set_primary_active_tab('siteadminnode'); } else if ($context->contextlevel == CONTEXT_COURSE) { $PAGE->set_pagelayout('standard');//calling this here to make blocks display require_login($context->instanceid, false, $cm); $admin = false; $returnurl = $CFG->wwwroot.'/grade/edit/letter/index.php?id='.$context->id; $editparam = '&edit=1'; $gpr = new grade_plugin_return(array('type'=>'edit', 'plugin'=>'letter', 'courseid'=>$course->id)); } else { throw new \moodle_exception('invalidcourselevel'); } $strgrades = get_string('grades'); $pagename = get_string('letters', 'grades'); $letters = grade_get_letters($context); $override = $DB->record_exists('grade_letters', array('contextid' => $context->id)); //if were viewing the letters if (!$edit) { $heading = get_string('gradeletters', 'grades'); $actionbar = new \core_grades\output\grade_letters_action_bar($context); if ($admin) { echo $OUTPUT->header(); $renderer = $PAGE->get_renderer('core_grades'); echo $renderer->render_action_bar($actionbar); echo $OUTPUT->heading($heading); } else { print_grade_page_head($course->id, 'letter', 'view', false, false, false, true, null, null, null, $actionbar); } $data = array(); $max = 100; foreach($letters as $boundary=>$letter) { $line = array(); $line[] = format_float($max,2).' %'; $line[] = format_float($boundary,2).' %'; $line[] = format_string($letter); $data[] = $line; $max = $boundary - 0.01; } if (!empty($override)) { echo $OUTPUT->notification(get_string('gradeletteroverridden', 'grades'), 'notifymessage'); } $table = new html_table(); $table->id = 'grade-letters-view'; $table->head = array(get_string('max', 'grades'), get_string('min', 'grades'), get_string('letter', 'grades')); $table->size = array('30%', '30%', '40%'); $table->align = array('left', 'left', 'left'); $table->width = '30%'; $table->data = $data; $table->tablealign = 'center'; echo html_writer::table($table); } else { //else we're editing require_once('edit_form.php'); $data = new stdClass(); $data->id = $context->id; $i = 0; foreach ($letters as $boundary=>$letter) { $data->gradeletter[$i] = $letter; $data->gradeboundary[$i] = $boundary; $i++; } $data->override = $override; // Count number of letters, used to build the repeated elements of the form. $lettercount = count($letters); $mform = new edit_letter_form($returnurl.$editparam, ['lettercount' => $lettercount, 'admin' => $admin]); $mform->set_data($data); if ($mform->is_cancelled()) { redirect($returnurl); } else if ($data = $mform->get_data()) { // Make sure we are updating the cache. $cache = cache::make('core', 'grade_letters'); if (!$admin and empty($data->override)) { $records = $DB->get_records('grade_letters', array('contextid' => $context->id)); foreach ($records as $record) { $DB->delete_records('grade_letters', array('id' => $record->id)); // Trigger the letter grade deleted event. $event = \core\event\grade_letter_deleted::create(array( 'objectid' => $record->id, 'context' => $context, )); $event->trigger(); } // Make sure we clear the cache for this context. $cache->delete($context->id); redirect($returnurl); } $letters = array(); for ($i = 0; $i < $data->gradeentrycount; $i++) { $letter = $data->gradeletter[$i]; if ($letter === '') { continue; } $boundary = floatval($data->gradeboundary[$i]); if ($boundary < 0 || $boundary > 100) { continue; // Skip if out of range. } // The keys need to be strings so floats are not truncated. $letters[number_format($boundary, 5)] = $letter; } $pool = array(); if ($records = $DB->get_records('grade_letters', array('contextid' => $context->id), 'lowerboundary ASC')) { foreach ($records as $r) { // Will re-use the lowerboundary to avoid duplicate during the update process. $pool[number_format($r->lowerboundary, 5)] = $r; } } foreach ($letters as $boundary => $letter) { $record = new stdClass(); $record->letter = $letter; $record->lowerboundary = $boundary; $record->contextid = $context->id; if (isset($pool[$boundary])) { // Re-use the existing boundary to avoid key constraint. if ($letter != $pool[$boundary]->letter) { // The letter has been assigned to another boundary, we update it. $record->id = $pool[$boundary]->id; $DB->update_record('grade_letters', $record); // Trigger the letter grade updated event. $event = \core\event\grade_letter_updated::create(array( 'objectid' => $record->id, 'context' => $context, )); $event->trigger(); } unset($pool[$boundary]); // Remove the letter from the pool. } else if ($candidate = array_pop($pool)) { // The boundary is new, we update a random record from the pool. $record->id = $candidate->id; $DB->update_record('grade_letters', $record); // Trigger the letter grade updated event. $event = \core\event\grade_letter_updated::create(array( 'objectid' => $record->id, 'context' => $context, )); $event->trigger(); } else { // No records were found, this must be a new letter. $newid = $DB->insert_record('grade_letters', $record); // Trigger the letter grade added event. $event = \core\event\grade_letter_created::create(array( 'objectid' => $newid, 'context' => $context, )); $event->trigger(); } } // Cache the changed letters. if (!empty($letters)) { // For some reason, the cache saves it in the order in which they were entered // but we really want to order them in descending order so we sort it here. krsort($letters); $cache->set($context->id, $letters); } // Delete the unused records. foreach($pool as $leftover) { $DB->delete_records('grade_letters', array('id' => $leftover->id)); // Trigger the letter grade deleted event. $event = \core\event\grade_letter_deleted::create(array( 'objectid' => $leftover->id, 'context' => $context, )); $event->trigger(); } redirect($returnurl); } print_grade_page_head($COURSE->id, 'letter', 'edit', get_string('editgradeletters', 'grades'), false, false, false); $mform->display(); } echo $OUTPUT->footer(); edit/letter/edit_form.php 0000604 00000006353 15062070557 0011463 0 ustar 00 <?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/>. /** * A moodleform for editing grade letters * * @package core_grades * @copyright 2007 Petr Skoda * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ if (!defined('MOODLE_INTERNAL')) { die('Direct access to this script is forbidden.'); /// It must be included from a Moodle page } require_once $CFG->libdir.'/formslib.php'; class edit_letter_form extends moodleform { public function definition() { $mform =& $this->_form; [ 'lettercount' => $lettercount, 'admin' => $admin, ] = $this->_customdata; $mform->addElement('header', 'gradeletters', get_string('gradeletters', 'grades')); // Only show "override site defaults" checkbox if editing the course grade letters if (!$admin) { $mform->addElement('checkbox', 'override', get_string('overridesitedefaultgradedisplaytype', 'grades')); $mform->addHelpButton('override', 'overridesitedefaultgradedisplaytype', 'grades'); } $gradeletter = get_string('gradeletter', 'grades'); $gradeboundary = get_string('gradeboundary', 'grades'); // The fields to create the grade letter/boundary. $elements = []; $elements[] = $mform->createElement('text', 'gradeletter', "{$gradeletter} {no}"); $elements[] = $mform->createElement('static', '', '', '≥'); $elements[] = $mform->createElement('float', 'gradeboundary', "{$gradeboundary} {no}"); $elements[] = $mform->createElement('static', '', '', '%'); // Element options/rules, fields should be disabled unless "Override" is checked for course grade letters. $options = []; $options['gradeletter']['type'] = PARAM_TEXT; if (!$admin) { $options['gradeletter']['disabledif'] = ['override', 'notchecked']; $options['gradeboundary']['disabledif'] = ['override', 'notchecked']; } // Create our repeatable elements, each one a group comprised of the fields defined previously. $this->repeat_elements([ $mform->createElement('group', 'gradeentry', "{$gradeletter} {no}", $elements, [' '], false) ], $lettercount, $options, 'gradeentrycount', 'gradeentryadd', 3); // Add a help icon to first element group, if it exists. if ($mform->elementExists('gradeentry[0]')) { $mform->addHelpButton('gradeentry[0]', 'gradeletter', 'grades'); } $mform->addElement('hidden', 'id'); $mform->setType('id', PARAM_INT); $this->add_action_buttons(); } } edit/settings/form.php 0000604 00000016114 15062070557 0011013 0 ustar 00 <?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/>. /** * A form for editing course grade settings * * @package core_grades * @copyright 2007 Petr Skoda * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ if (!defined('MOODLE_INTERNAL')) { die('Direct access to this script is forbidden.'); /// It must be included from a Moodle page } require_once($CFG->libdir.'/formslib.php'); /** * First implementation of the preferences in the form of a moodleform. * TODO add "reset to site defaults" button */ class course_settings_form extends moodleform { function definition() { global $USER, $CFG; $mform =& $this->_form; $systemcontext = context_system::instance(); $can_view_admin_links = false; if (has_capability('moodle/grade:manage', $systemcontext)) { $can_view_admin_links = true; } // General settings $strchangedefaults = get_string('changedefaults', 'grades'); $mform->addElement('header', 'general', get_string('generalsettings', 'grades')); if ($can_view_admin_links) { $link = '<a href="' . $CFG->wwwroot.'/'.$CFG->admin.'/settings.php?section=gradessettings">' . $strchangedefaults . '</a>'; $mform->addElement('static', 'generalsettingslink', null, $link); } $options = array(-1 => get_string('default', 'grades'), GRADE_REPORT_AGGREGATION_POSITION_FIRST => get_string('positionfirst', 'grades'), GRADE_REPORT_AGGREGATION_POSITION_LAST => get_string('positionlast', 'grades')); $default_gradedisplaytype = $CFG->grade_aggregationposition; foreach ($options as $key=>$option) { if ($key == $default_gradedisplaytype) { $options[-1] = get_string('defaultprev', 'grades', $option); break; } } $mform->addElement('select', 'aggregationposition', get_string('aggregationposition', 'grades'), $options); $mform->addHelpButton('aggregationposition', 'aggregationposition', 'grades'); if ($CFG->grade_minmaxtouse == GRADE_MIN_MAX_FROM_GRADE_ITEM) { $default = get_string('gradeitemminmax', 'grades'); } else if ($CFG->grade_minmaxtouse == GRADE_MIN_MAX_FROM_GRADE_GRADE) { $default = get_string('gradegrademinmax', 'grades'); } else { throw new coding_exception('Invalid $CFG->grade_minmaxtouse value.'); } $options = array( -1 => get_string('defaultprev', 'grades', $default), GRADE_MIN_MAX_FROM_GRADE_ITEM => get_string('gradeitemminmax', 'grades'), GRADE_MIN_MAX_FROM_GRADE_GRADE => get_string('gradegrademinmax', 'grades') ); $mform->addElement('select', 'minmaxtouse', get_string('minmaxtouse', 'grades'), $options); $mform->addHelpButton('minmaxtouse', 'minmaxtouse', 'grades'); // Grade item settings $mform->addElement('header', 'grade_item_settings', get_string('gradeitemsettings', 'grades')); $mform->setExpanded('grade_item_settings'); if ($can_view_admin_links) { $link = '<a href="' . $CFG->wwwroot.'/'.$CFG->admin.'/settings.php?section=gradeitemsettings">' . $strchangedefaults . '</a>'; $mform->addElement('static', 'gradeitemsettingslink', null, $link); } $options = array(-1 => get_string('default', 'grades'), GRADE_DISPLAY_TYPE_REAL => get_string('real', 'grades'), GRADE_DISPLAY_TYPE_REAL_PERCENTAGE => get_string('realpercentage', 'grades'), GRADE_DISPLAY_TYPE_REAL_LETTER => get_string('realletter', 'grades'), GRADE_DISPLAY_TYPE_PERCENTAGE => get_string('percentage', 'grades'), GRADE_DISPLAY_TYPE_PERCENTAGE_REAL => get_string('percentagereal', 'grades'), GRADE_DISPLAY_TYPE_PERCENTAGE_LETTER => get_string('percentageletter', 'grades'), GRADE_DISPLAY_TYPE_LETTER => get_string('letter', 'grades'), GRADE_DISPLAY_TYPE_LETTER_REAL => get_string('letterreal', 'grades'), GRADE_DISPLAY_TYPE_LETTER_PERCENTAGE => get_string('letterpercentage', 'grades')); $default_gradedisplaytype = $CFG->grade_displaytype; foreach ($options as $key=>$option) { if ($key == $default_gradedisplaytype) { $options[-1] = get_string('defaultprev', 'grades', $option); break; } } $mform->addElement('select', 'displaytype', get_string('gradedisplaytype', 'grades'), $options); $mform->addHelpButton('displaytype', 'gradedisplaytype', 'grades'); $mform->setDefault('displaytype', -1); $options = array(-1=> get_string('defaultprev', 'grades', $CFG->grade_decimalpoints), 0=>0, 1=>1, 2=>2, 3=>3, 4=>4, 5=>5); $mform->addElement('select', 'decimalpoints', get_string('decimalpoints', 'grades'), $options); $mform->addHelpButton('decimalpoints', 'decimalpoints', 'grades'); // add setting options for plugins $types = array('report', 'export', 'import'); foreach($types as $type) { foreach (core_component::get_plugin_list('grade'.$type) as $plugin => $plugindir) { // Include all the settings commands for this plugin if there are any if (file_exists($plugindir.'/lib.php')) { require_once($plugindir.'/lib.php'); $functionname = 'grade_'.$type.'_'.$plugin.'_settings_definition'; if (function_exists($functionname)) { $mform->addElement('header', 'grade_'.$type.$plugin, get_string('pluginname', 'grade'.$type.'_'.$plugin, NULL)); $mform->setExpanded('grade_'.$type.$plugin); if ($can_view_admin_links) { $link = '<a href="' . $CFG->wwwroot.'/'.$CFG->admin.'/settings.php?section=gradereport' . $plugin . '">' . $strchangedefaults . '</a>'; $mform->addElement('static', 'gradeitemsettingslink', null, $link); } $functionname($mform); } } } } $mform->addElement('hidden', 'id'); $mform->setType('id', PARAM_INT); $this->add_action_buttons(false); } } edit/settings/index.php 0000604 00000005750 15062070557 0011163 0 ustar 00 <?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/>. /** * A page for editing course grade settings * * @package core_grades * @copyright 2007 Petr Skoda * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once '../../../config.php'; require_once $CFG->dirroot.'/grade/lib.php'; require_once $CFG->libdir.'/gradelib.php'; require_once 'form.php'; $courseid = optional_param('id', SITEID, PARAM_INT); $PAGE->set_url('/grade/edit/settings/index.php', array('id'=>$courseid)); $PAGE->set_pagelayout('admin'); if (!$course = $DB->get_record('course', array('id' => $courseid))) { throw new \moodle_exception('invalidcourseid'); } require_login($course); $context = context_course::instance($course->id); require_capability('moodle/grade:manage', $context); $gpr = new grade_plugin_return(array('type'=>'edit', 'plugin'=>'settings', 'courseid'=>$courseid)); $strgrades = get_string('grades'); $pagename = get_string('coursesettings', 'grades'); $mform = new course_settings_form(); $settings = grade_get_settings($course->id); $mform->set_data($settings); if ($data = $mform->get_data()) { $data = (array)$data; $general = array('displaytype', 'decimalpoints', 'aggregationposition', 'minmaxtouse'); foreach ($data as $key=>$value) { if (!in_array($key, $general) and strpos($key, 'report_') !== 0 and strpos($key, 'import_') !== 0 and strpos($key, 'export_') !== 0) { continue; } if ($value == -1) { $value = null; } grade_set_setting($course->id, $key, $value); $previousvalue = isset($settings->{$key}) ? $settings->{$key} : null; if ($key == 'minmaxtouse' && $previousvalue != $value) { // The min max has changed, we need to regrade the grades. grade_force_full_regrading($courseid); } } } print_grade_page_head($courseid, 'settings', 'coursesettings'); // The settings could have been changed due to a notice shown in print_grade_page_head, we need to refresh them. $settings = grade_get_settings($course->id); $mform->set_data($settings); echo $OUTPUT->box_start('generalbox boxaligncenter boxwidthnormal centerpara'); echo get_string('coursesettingsexplanation', 'grades'); echo $OUTPUT->box_end(); $mform->display(); echo $OUTPUT->footer(); edit/outcome/edit_form.php 0000604 00000013037 15062070557 0011634 0 ustar 00 <?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/>. /** * Edit form for grade outcomes * * @package core_grades * @copyright 2007 Petr Skoda * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ if (!defined('MOODLE_INTERNAL')) { die('Direct access to this script is forbidden.'); /// It must be included from a Moodle page } require_once $CFG->libdir.'/formslib.php'; class edit_outcome_form extends moodleform { public function definition() { global $CFG, $COURSE; $mform =& $this->_form; // visible elements $mform->addElement('header', 'general', get_string('outcomes', 'grades')); $mform->addElement('text', 'fullname', get_string('outcomefullname', 'grades'), 'size="40"'); $mform->addRule('fullname', get_string('required'), 'required'); $mform->setType('fullname', PARAM_TEXT); $mform->addElement('text', 'shortname', get_string('outcomeshortname', 'grades'), 'size="20"'); $mform->addRule('shortname', get_string('required'), 'required'); $mform->setType('shortname', PARAM_NOTAGS); $mform->addElement('advcheckbox', 'standard', get_string('outcomestandard', 'grades')); $mform->addHelpButton('standard', 'outcomestandard', 'grades'); $options = array(); $mform->addElement('selectwithlink', 'scaleid', get_string('scale'), $options, null, array('link' => $CFG->wwwroot.'/grade/edit/scale/edit.php?courseid='.$COURSE->id, 'label' => get_string('scalescustomcreate'))); $mform->addHelpButton('scaleid', 'typescale', 'grades'); $mform->addRule('scaleid', get_string('required'), 'required'); $mform->addElement('editor', 'description_editor', get_string('description'), null, $this->_customdata['editoroptions']); // hidden params $mform->addElement('hidden', 'id', 0); $mform->setType('id', PARAM_INT); $mform->addElement('hidden', 'courseid', 0); $mform->setType('courseid', PARAM_INT); /// add return tracking info $gpr = $this->_customdata['gpr']; $gpr->add_mform_elements($mform); //------------------------------------------------------------------------------- // buttons $this->add_action_buttons(); } /// tweak the form - depending on existing data function definition_after_data() { global $CFG; $mform =& $this->_form; // first load proper scales if ($courseid = $mform->getElementValue('courseid')) { $options = array(); if ($scales = grade_scale::fetch_all_local($courseid)) { $options[-1] = '--'.get_string('scalescustom'); foreach($scales as $scale) { $options[$scale->id] = $scale->get_name(); } } if ($scales = grade_scale::fetch_all_global()) { $options[-2] = '--'.get_string('scalesstandard'); foreach($scales as $scale) { $options[$scale->id] = $scale->get_name(); } } $scale_el =& $mform->getElement('scaleid'); $scale_el->load($options); } else { $options = array(); if ($scales = grade_scale::fetch_all_global()) { foreach($scales as $scale) { $options[$scale->id] = $scale->get_name(); } } $scale_el =& $mform->getElement('scaleid'); $scale_el->load($options); } if ($id = $mform->getElementValue('id')) { $outcome = grade_outcome::fetch(array('id'=>$id)); $itemcount = $outcome->get_item_uses_count(); $coursecount = $outcome->get_course_uses_count(); if ($itemcount) { $mform->hardFreeze('scaleid'); } if (empty($courseid)) { $mform->hardFreeze('standard'); } else if (!has_capability('moodle/grade:manage', context_system::instance())) { $mform->hardFreeze('standard'); } else if ($coursecount and empty($outcome->courseid)) { $mform->hardFreeze('standard'); } } else { if (empty($courseid) or !has_capability('moodle/grade:manage', context_system::instance())) { $mform->hardFreeze('standard'); } } } /// perform extra validation before submission function validation($data, $files) { $errors = parent::validation($data, $files); if ($data['scaleid'] < 1) { $errors['scaleid'] = get_string('required'); } if (!empty($data['standard']) and $scale = grade_scale::fetch(array('id'=>$data['scaleid']))) { if (!empty($scale->courseid)) { //TODO: localize $errors['scaleid'] = 'Can not use custom scale in global outcome!'; } } return $errors; } } edit/outcome/course.php 0000604 00000011764 15062070557 0011171 0 ustar 00 <?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/>. /** * A page for selecting outcomes for use in a course * * @package core_grades * @copyright 2007 Petr Skoda * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once '../../../config.php'; require_once $CFG->dirroot.'/grade/lib.php'; require_once $CFG->libdir.'/gradelib.php'; $courseid = required_param('id', PARAM_INT); $PAGE->set_url('/grade/edit/outcome/course.php', array('id'=>$courseid)); $course = $DB->get_record('course', array('id' => $courseid), '*', MUST_EXIST); /// Make sure they can even access this course require_login($course); $context = context_course::instance($course->id); require_capability('moodle/course:update', $context); /// return tracking object $gpr = new grade_plugin_return(array('type'=>'edit', 'plugin'=>'outcomes', 'courseid'=>$courseid)); // first of all fix the state of outcomes_course table $standardoutcomes = grade_outcome::fetch_all_global(); $co_custom = grade_outcome::fetch_all_local($courseid); $co_standard_used = array(); $co_standard_notused = array(); if ($courseused = $DB->get_records('grade_outcomes_courses', array('courseid' => $courseid), '', 'outcomeid')) { $courseused = array_keys($courseused); } else { $courseused = array(); } // fix wrong entries in outcomes_courses foreach ($courseused as $oid) { if (!array_key_exists($oid, $standardoutcomes) and !array_key_exists($oid, $co_custom)) { $DB->delete_records('grade_outcomes_courses', array('outcomeid' => $oid, 'courseid' => $courseid)); } } // fix local custom outcomes missing in outcomes_course foreach($co_custom as $oid=>$outcome) { if (!in_array($oid, $courseused)) { $courseused[$oid] = $oid; $goc = new stdClass(); $goc->courseid = $courseid; $goc->outcomeid = $oid; $DB->insert_record('grade_outcomes_courses', $goc); } } // now check all used standard outcomes are in outcomes_course too $params = array($courseid); $sql = "SELECT DISTINCT outcomeid FROM {grade_items} WHERE courseid=? and outcomeid IS NOT NULL"; if ($realused = $DB->get_records_sql($sql, $params)) { $realused = array_keys($realused); foreach ($realused as $oid) { if (array_key_exists($oid, $standardoutcomes)) { $co_standard_used[$oid] = $standardoutcomes[$oid]; unset($standardoutcomes[$oid]); if (!in_array($oid, $courseused)) { $courseused[$oid] = $oid; $goc = new stdClass(); $goc->courseid = $courseid; $goc->outcomeid = $oid; $DB->insert_record('grade_outcomes_courses', $goc); } } } } // find all unused standard course outcomes - candidates for removal foreach ($standardoutcomes as $oid=>$outcome) { if (in_array($oid, $courseused)) { $co_standard_notused[$oid] = $standardoutcomes[$oid]; unset($standardoutcomes[$oid]); } } /// form processing if ($data = data_submitted() and confirm_sesskey()) { require_capability('moodle/grade:manageoutcomes', $context); if (!empty($data->add) && !empty($data->addoutcomes)) { /// add all selected to course list foreach ($data->addoutcomes as $add) { $add = clean_param($add, PARAM_INT); if (!array_key_exists($add, $standardoutcomes)) { continue; } $goc = new stdClass(); $goc->courseid = $courseid; $goc->outcomeid = $add; $DB->insert_record('grade_outcomes_courses', $goc); } } else if (!empty($data->remove) && !empty($data->removeoutcomes)) { /// remove all selected from course outcomes list foreach ($data->removeoutcomes as $remove) { $remove = clean_param($remove, PARAM_INT); if (!array_key_exists($remove, $co_standard_notused)) { continue; } $DB->delete_records('grade_outcomes_courses', array('courseid' => $courseid, 'outcomeid' => $remove)); } } redirect('course.php?id='.$courseid); // we must redirect to get fresh data } $actionbar = new \core_grades\output\course_outcomes_action_bar($context); // Print header. print_grade_page_head($COURSE->id, 'outcome', 'course', false, false, false, true, null, null, null, $actionbar); require('course_form.html'); echo $OUTPUT->footer(); edit/outcome/edit.php 0000604 00000014315 15062070557 0010611 0 ustar 00 <?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/>. /** * Edit page for grade outcomes. * * @package core_grades * @copyright 2008 Nicolas Connault * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once '../../../config.php'; require_once $CFG->dirroot.'/grade/lib.php'; require_once $CFG->dirroot.'/grade/report/lib.php'; require_once 'edit_form.php'; $courseid = optional_param('courseid', 0, PARAM_INT); $id = optional_param('id', 0, PARAM_INT); $url = new moodle_url('/grade/edit/outcome/edit.php'); if ($courseid !== 0) { $url->param('courseid', $courseid); } if ($id !== 0) { $url->param('id', $id); } $PAGE->set_url($url); $PAGE->set_pagelayout('admin'); $systemcontext = context_system::instance(); $heading = get_string('addoutcome', 'grades'); // a bit complex access control :-O if ($id) { $heading = get_string('editoutcome', 'grades'); /// editing existing outcome if (!$outcome_rec = $DB->get_record('grade_outcomes', array('id' => $id))) { throw new \moodle_exception('invalidoutcome'); } if ($outcome_rec->courseid) { $outcome_rec->standard = 0; if (!$course = $DB->get_record('course', array('id' => $outcome_rec->courseid))) { throw new \moodle_exception('invalidcourseid'); } require_login($course); $context = context_course::instance($course->id); require_capability('moodle/grade:manage', $context); $courseid = $course->id; } else { if ($courseid) { if (!$course = $DB->get_record('course', array('id' => $courseid))) { throw new \moodle_exception('invalidcourseid'); } } $outcome_rec->standard = 1; $outcome_rec->courseid = $courseid; require_login(); require_capability('moodle/grade:manage', $systemcontext); $PAGE->set_context($systemcontext); } } else if ($courseid){ /// adding new outcome from course $course = $DB->get_record('course', array('id' => $courseid), '*', MUST_EXIST); require_login($course); $context = context_course::instance($course->id); require_capability('moodle/grade:manage', $context); $outcome_rec = new stdClass(); $outcome_rec->standard = 0; $outcome_rec->courseid = $courseid; } else { require_login(); require_capability('moodle/grade:manage', $systemcontext); $PAGE->set_context($systemcontext); /// adding new outcome from admin section $outcome_rec = new stdClass(); $outcome_rec->standard = 1; $outcome_rec->courseid = 0; } if (!$courseid) { require_once $CFG->libdir.'/adminlib.php'; admin_externalpage_setup('outcomes'); $PAGE->set_primary_active_tab('siteadminnode'); } else { navigation_node::override_active_url(new moodle_url('/grade/edit/outcome/course.php', ['id' => $courseid])); $PAGE->navbar->add(get_string('manageoutcomes', 'grades'), new moodle_url('/grade/edit/outcome/index.php', ['id' => $courseid])); } // default return url $gpr = new grade_plugin_return(); $returnurl = $gpr->get_return_url('index.php?id='.$courseid); $editoroptions = array( 'maxfiles' => EDITOR_UNLIMITED_FILES, 'maxbytes' => $CFG->maxbytes, 'trusttext' => false, 'noclean' => true, 'context' => $systemcontext ); if (!empty($outcome_rec->id)) { $editoroptions['subdirs'] = file_area_contains_subdirs($systemcontext, 'grade', 'outcome', $outcome_rec->id); $outcome_rec = file_prepare_standard_editor($outcome_rec, 'description', $editoroptions, $systemcontext, 'grade', 'outcome', $outcome_rec->id); } else { $editoroptions['subdirs'] = false; $outcome_rec = file_prepare_standard_editor($outcome_rec, 'description', $editoroptions, $systemcontext, 'grade', 'outcome', null); } $mform = new edit_outcome_form(null, compact('gpr', 'editoroptions')); $mform->set_data($outcome_rec); if ($mform->is_cancelled()) { redirect($returnurl); } else if ($data = $mform->get_data()) { $outcome = new grade_outcome(array('id'=>$id)); $data->usermodified = $USER->id; if (empty($outcome->id)) { $data->description = $data->description_editor['text']; grade_outcome::set_properties($outcome, $data); if (!has_capability('moodle/grade:manage', $systemcontext)) { $data->standard = 0; } $outcome->courseid = !empty($data->standard) ? null : $courseid; if (empty($outcome->courseid)) { $outcome->courseid = null; } $outcome->insert(); $data = file_postupdate_standard_editor($data, 'description', $editoroptions, $systemcontext, 'grade', 'outcome', $outcome->id); $DB->set_field($outcome->table, 'description', $data->description, array('id'=>$outcome->id)); } else { $data = file_postupdate_standard_editor($data, 'description', $editoroptions, $systemcontext, 'grade', 'outcome', $id); grade_outcome::set_properties($outcome, $data); if (isset($data->standard)) { $outcome->courseid = !empty($data->standard) ? null : $courseid; } else { unset($outcome->courseid); // keep previous } $outcome->update(); } redirect($returnurl); } $PAGE->navbar->add($heading, $url); print_grade_page_head($courseid ?: SITEID, 'outcome', 'edit', $heading, false, false, false); if (!grade_scale::fetch_all_local($courseid) && !grade_scale::fetch_all_global()) { echo $OUTPUT->confirm(get_string('noscales', 'grades'), $CFG->wwwroot.'/grade/edit/scale/edit.php?courseid='.$courseid, $returnurl); echo $OUTPUT->footer(); die(); } $mform->display(); echo $OUTPUT->footer(); edit/outcome/export.php 0000604 00000010243 15062070557 0011201 0 ustar 00 <?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/>. /** * Exports selected outcomes in CSV format * * @package core_grades * @copyright 2008 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once '../../../config.php'; require_once $CFG->dirroot.'/grade/lib.php'; require_once $CFG->libdir.'/gradelib.php'; $courseid = optional_param('id', 0, PARAM_INT); $action = optional_param('action', '', PARAM_ALPHA); /// Make sure they can even access this course if ($courseid) { if (!$course = $DB->get_record('course', array('id' => $courseid))) { throw new \moodle_exception('invalidcourseid'); } require_login($course); $context = context_course::instance($course->id); require_capability('moodle/grade:manage', $context); if (empty($CFG->enableoutcomes)) { redirect('../../index.php?id='.$courseid); } } else { require_once $CFG->libdir.'/adminlib.php'; admin_externalpage_setup('outcomes'); } require_sesskey(); header("Content-Type: text/csv; charset=utf-8"); // TODO: make the filename more useful, include a date, a specific name, something... header('Content-Disposition: attachment; filename=outcomes.csv'); // sending header with clear names, to make 'what is what' as easy as possible to understand $header = array('outcome_name', 'outcome_shortname', 'outcome_description', 'scale_name', 'scale_items', 'scale_description'); echo format_csv($header, ';', '"'); $outcomes = array(); if ( $courseid ) { $outcomes = array_merge(grade_outcome::fetch_all_global(), grade_outcome::fetch_all_local($courseid)); } else { $outcomes = grade_outcome::fetch_all_global(); } foreach($outcomes as $outcome) { $line = array(); $line[] = $outcome->get_name(); $line[] = $outcome->get_shortname(); $line[] = $outcome->get_description(); $scale = $outcome->load_scale(); $line[] = $scale->get_name(); $line[] = $scale->compact_items(); $line[] = $scale->get_description(); echo format_csv($line, ';', '"'); } /** * Formats and returns a line of data, in CSV format. This code * is from http://au2.php.net/manual/en/function.fputcsv.php#77866 * * @param string[] $fields data to be exported * @param string $delimiter char to be used to separate fields * @param string $enclosure char used to enclose strings that contains newlines, spaces, tabs or the delimiter char itself * @returns string one line of csv data */ function format_csv($fields = array(), $delimiter = ';', $enclosure = '"') { $str = ''; $escape_char = '\\'; foreach ($fields as $value) { if (strpos($value, $delimiter) !== false || strpos($value, $enclosure) !== false || strpos($value, "\n") !== false || strpos($value, "\r") !== false || strpos($value, "\t") !== false || strpos($value, ' ') !== false) { $str2 = $enclosure; $escaped = 0; $len = strlen($value); for ($i=0;$i<$len;$i++) { if ($value[$i] == $escape_char) { $escaped = 1; } else if (!$escaped && $value[$i] == $enclosure) { $str2 .= $enclosure; } else { $escaped = 0; } $str2 .= $value[$i]; } $str2 .= $enclosure; $str .= $str2.$delimiter; } else { $str .= $value.$delimiter; } } $str = substr($str,0,-1); $str .= "\n"; return $str; } edit/outcome/import_outcomes_form.php 0000604 00000004504 15062070557 0014136 0 ustar 00 <?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/>. /** * A form to allow importing outcomes from a file * * @package core_grades * @copyright 2008 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ if (!defined('MOODLE_INTERNAL')) { die('Direct access to this script is forbidden.'); /// It must be included from a Moodle page } require_once($CFG->dirroot.'/lib/formslib.php'); class import_outcomes_form extends moodleform { public function definition() { global $PAGE, $USER; $mform =& $this->_form; $mform->addElement('hidden', 'action', 'upload'); $mform->setType('action', PARAM_ALPHANUMEXT); $mform->addElement('hidden', 'courseid', $PAGE->course->id); $mform->setType('courseid', PARAM_INT); $scope = array(); if (($PAGE->course->id > 1) && has_capability('moodle/grade:manage', context_system::instance())) { $mform->addElement('radio', 'scope', get_string('importcustom', 'grades'), null, 'custom'); $mform->addElement('radio', 'scope', get_string('importstandard', 'grades'), null, 'global'); $mform->setDefault('scope', 'custom'); } $mform->addElement('filepicker', 'userfile', get_string('importoutcomes', 'grades')); $mform->addRule('userfile', get_string('required'), 'required', null, 'server'); $mform->addHelpButton('userfile', 'importoutcomes', 'grades'); $buttonarray = [ $mform->createElement('submit', 'save', get_string('uploadthisfile')), $mform->createElement('cancel') ]; $mform->addGroup($buttonarray, 'buttonar', '', ' ', false); } } edit/outcome/tabs.php 0000604 00000003041 15062070557 0010607 0 ustar 00 <?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/>. /** * Prints navigation tabs for viewing and editing grade outcomes * * @package core_grades * @copyright 2009 Petr Skoda * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ $row = $tabs = array(); $context = context_course::instance($courseid); $row[] = new tabobject('courseoutcomes', $CFG->wwwroot.'/grade/edit/outcome/course.php?id='.$courseid, get_string('outcomescourse', 'grades')); if (has_capability('moodle/grade:manage', $context)) { $row[] = new tabobject('outcomes', $CFG->wwwroot.'/grade/edit/outcome/index.php?id='.$courseid, get_string('editoutcomes', 'grades')); } $tabs[] = $row; echo '<div class="outcomedisplay">'; print_tabs($tabs, $currenttab); echo '</div>'; edit/outcome/course_form.html 0000604 00000005606 15062070557 0012367 0 ustar 00 <?php $maxlength=70; ?> <form action="course.php" method="post"> <div> <table class="courseoutcomes"> <tr> <td> <label for="removeoutcomes"><?php print_string('outcomescourse', 'grades'); ?></label> <br /> <select id="removeoutcomes" size="20" name="removeoutcomes[]" multiple="multiple" class="form-control input-block-level"> <?php if ($co_standard_notused) { echo '<optgroup label="'.get_string('outcomescoursenotused', 'grades').'">'; foreach ($co_standard_notused as $outcome) { echo '<option value="'.$outcome->id.'">'.shorten_text($outcome->get_name(), $maxlength).'</option>'; } echo '</optgroup>'; } if ($co_standard_used) { echo '<optgroup label="'.get_string('outcomescourseused', 'grades').'">'; foreach ($co_standard_used as $outcome) { echo '<option value="'.$outcome->id.'">'.shorten_text($outcome->get_name(), $maxlength).'</option>'; } echo '</optgroup>'; } if ($co_custom) { echo '<optgroup label="'.get_string('outcomescoursecustom', 'grades').'">'; foreach ($co_custom as $outcome) { echo '<option value="'.$outcome->id.'">'.shorten_text($outcome->get_name(), $maxlength).'</option>'; } echo '</optgroup>'; } ?> </select> </td> <?php if (has_capability('moodle/grade:manageoutcomes', $context)) { ?> <td class="pl-3 pr-3"> <div class="my-3"> <input name="add" class="btn btn-secondary" id="add" type="submit" value="<?php echo $OUTPUT->larrow() . ' ' . get_string('add'); ?>" title="<?php print_string('add'); ?>" /> </div> <div class="my-3"> <input name="remove" class="btn btn-secondary" id="remove" type="submit" value="<?php echo get_string('remove') . ' ' . $OUTPUT->rarrow(); ?>" title="<?php print_string('remove'); ?>" /> </div> </td> <?php } ?> <td> <label for="addoutcomes"><?php print_string('outcomesstandardavailable', 'grades'); ?></label> <br /> <select id="addoutcomes" size="20" name="addoutcomes[]" multiple="multiple" class="form-control input-block-level"> <?php foreach ($standardoutcomes as $outcome) { echo '<option value="'.$outcome->id.'">'.shorten_text($outcome->get_name(), $maxlength).'</option>'; } ?> </select> </td> </tr> </table> <input name="id" type="hidden" value="<?php echo $courseid?>"/> <input type="hidden" name="sesskey" value="<?php echo sesskey() ?>" /> </div> </form> edit/outcome/import.php 0000604 00000024376 15062070557 0011206 0 ustar 00 <?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/>. /** * Import outcomes from a file * * @package core_grades * @copyright 2008 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once(__DIR__.'/../../../config.php'); require_once($CFG->dirroot.'/lib/formslib.php'); require_once($CFG->dirroot.'/grade/lib.php'); require_once($CFG->libdir.'/gradelib.php'); require_once('import_outcomes_form.php'); $courseid = optional_param('courseid', 0, PARAM_INT); $action = optional_param('action', '', PARAM_ALPHA); $scope = optional_param('scope', 'custom', PARAM_ALPHA); $url = new moodle_url('/grade/edit/outcome/import.php', array('courseid' => $courseid)); $PAGE->set_url($url); $PAGE->set_pagelayout('admin'); /// Make sure they can even access this course if ($courseid) { if (!$course = $DB->get_record('course', array('id' => $courseid))) { throw new \moodle_exception('invalidcourseid'); } require_login($course); $context = context_course::instance($course->id); if (empty($CFG->enableoutcomes)) { redirect('../../index.php?id='.$courseid); } navigation_node::override_active_url(new moodle_url('/grade/edit/outcome/course.php', ['id' => $courseid])); $PAGE->navbar->add(get_string('manageoutcomes', 'grades'), new moodle_url('/grade/edit/outcome/index.php', ['id' => $courseid])); $PAGE->navbar->add(get_string('importoutcomes', 'grades'), new moodle_url('/grade/edit/outcome/import.php', ['courseid' => $courseid])); } else { require_once $CFG->libdir.'/adminlib.php'; admin_externalpage_setup('outcomes'); $context = context_system::instance(); } require_capability('moodle/grade:manageoutcomes', $context); $upload_form = new import_outcomes_form(); if ($upload_form->is_cancelled()) { redirect(new moodle_url('/grade/edit/outcome/index.php', ['id' => $courseid])); die; } print_grade_page_head($courseid, 'outcome', 'import', get_string('importoutcomes', 'grades'), false, false, false); if (!$upload_form->get_data()) { // Display the import form. $upload_form->display(); echo $OUTPUT->footer(); die; } $imported_file = $CFG->tempdir . '/outcomeimport/importedfile_'.time().'.csv'; make_temp_directory('outcomeimport'); // copying imported file if (!$upload_form->save_file('userfile', $imported_file, true)) { redirect('import.php'. ($courseid ? "?courseid=$courseid" : ''), get_string('importfilemissing', 'grades')); } /// which scope are we importing the outcomes in? if (isset($courseid) && ($scope == 'custom')) { // custom scale $local_scope = true; } elseif (($scope == 'global') && has_capability('moodle/grade:manage', context_system::instance())) { // global scale $local_scope = false; } else { // shouldn't happen .. user might be trying to access this script without the right permissions. redirect('index.php', get_string('importerror', 'grades')); } // open the file, start importing data if ($handle = fopen($imported_file, 'r')) { $line = 0; // will keep track of current line, to give better error messages. $file_headers = ''; // $csv_data needs to have at least these columns, the value is the default position in the data file. $headers = array('outcome_name' => 0, 'outcome_shortname' => 1, 'scale_name' => 3, 'scale_items' => 4); $optional_headers = array('outcome_description'=>2, 'scale_description' => 5); $imported_headers = array(); // will later be initialized with the values found in the file $fatal_error = false; $errormessage = ''; // data should be separated by a ';'. *NOT* by a comma! TODO: version 2.0 // or whenever we can depend on PHP5, set the second parameter (8192) to 0 (unlimited line length) : the database can store over 128k per line. while ( $csv_data = fgetcsv($handle, 8192, ';', '"')) { // if the line is over 8k, it won't work... $line++; // be tolerant on input, as fgetcsv returns "an array comprising a single null field" on blank lines if ($csv_data == array(null)) { continue; } // on first run, grab and analyse the header if ($file_headers == '') { $file_headers = array_flip($csv_data); // save the header line ... TODO: use the header line to let import work with columns in arbitrary order $error = false; foreach($headers as $key => $value) { // sanity check #1: make sure the file contains all the mandatory headers if (!array_key_exists($key, $file_headers)) { $error = true; break; } } if ($error) { $fatal_error = true; $errormessage = get_string('importoutcomenofile', 'grades', $line); break; } foreach(array_merge($headers, $optional_headers) as $header => $position) { // match given columns to expected columns *into* $headers $imported_headers[$header] = $file_headers[$header]; } continue; // we don't import headers } // sanity check #2: every line must have the same number of columns as there are // headers. If not, processing stops. if ( count($csv_data) != count($file_headers) ) { $fatal_error = true; $errormessage = get_string('importoutcomenofile', 'grades', $line); break; } // sanity check #3: all required fields must be present on the current line. foreach ($headers as $header => $position) { if ($csv_data[$imported_headers[$header]] == '') { $fatal_error = true; $errormessage = get_string('importoutcomenofile', 'grades', $line); break; } } // MDL-17273 errors in csv are not preventing import from happening. We break from the while loop here if ($fatal_error) { break; } $params = array($csv_data[$imported_headers['outcome_shortname']]); $wheresql = 'shortname = ? '; if ($local_scope) { $params[] = $courseid; $wheresql .= ' AND courseid = ?'; } else { $wheresql .= ' AND courseid IS NULL'; } $outcome = $DB->get_records_select('grade_outcomes', $wheresql, $params); if ($outcome) { // already exists, print a message and skip. echo $OUTPUT->notification(get_string('importskippedoutcome', 'grades', $csv_data[$imported_headers['outcome_shortname']]), 'info', false); continue; } // new outcome will be added, search for compatible existing scale... $params = array($csv_data[$imported_headers['scale_name']], $csv_data[$imported_headers['scale_items']], $courseid); $wheresql = 'name = ? AND scale = ? AND (courseid = ? OR courseid = 0)'; $scale = $DB->get_records_select('scale', $wheresql, $params); if ($scale) { // already exists in the right scope: use it. $scale_id = key($scale); } else { if (!has_capability('moodle/course:managescales', $context)) { echo $OUTPUT->notification(get_string('importskippedoutcome', 'grades', $csv_data[$imported_headers['outcome_shortname']]), 'warning', false); continue; } else { // scale doesn't exists : create it. $scale_data = array('name' => $csv_data[$imported_headers['scale_name']], 'scale' => $csv_data[$imported_headers['scale_items']], 'description' => $csv_data[$imported_headers['scale_description']], 'userid' => $USER->id); if ($local_scope) { $scale_data['courseid'] = $courseid; } else { $scale_data['courseid'] = 0; // 'global' : scale use '0', outcomes use null } $scale = new grade_scale($scale_data); $scale_id = $scale->insert(); } } // add outcome $outcome_data = array('shortname' => $csv_data[$imported_headers['outcome_shortname']], 'fullname' => $csv_data[$imported_headers['outcome_name']], 'scaleid' => $scale_id, 'description' => $csv_data[$imported_headers['outcome_description']], 'usermodified' => $USER->id); if ($local_scope) { $outcome_data['courseid'] = $courseid; } else { $outcome_data['courseid'] = null; // 'global' : scale use '0', outcomes use null } $outcome = new grade_outcome($outcome_data); $outcome_id = $outcome->insert(); $outcome_success_strings = new StdClass(); $outcome_success_strings->name = $outcome_data['fullname']; $outcome_success_strings->id = $outcome_id; echo $OUTPUT->notification(get_string('importoutcomesuccess', 'grades', $outcome_success_strings), 'success', false); } if ($fatal_error) { echo $OUTPUT->notification($errormessage, 'error', false); echo $OUTPUT->single_button(new moodle_url('/grade/edit/outcome/import.php', ['courseid' => $courseid]), get_string('back'), 'get'); } else { echo $OUTPUT->single_button(new moodle_url('/grade/edit/outcome/index.php', ['id' => $courseid]), get_string('continue'), 'get'); } } else { echo $OUTPUT->box(get_string('importoutcomenofile', 'grades', 0)); } // finish fclose($handle); // delete temp file unlink($imported_file); echo $OUTPUT->footer(); edit/outcome/index.php 0000604 00000022723 15062070557 0010775 0 ustar 00 <?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/>. /** * Listing page for grade outcomes. * * @package core_grades * @copyright 2008 Nicolas Connault * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once(__DIR__.'/../../../config.php'); require_once($CFG->dirroot.'/grade/lib.php'); require_once($CFG->libdir.'/gradelib.php'); $courseid = optional_param('id', 0, PARAM_INT); $action = optional_param('action', '', PARAM_ALPHA); $url = new moodle_url('/grade/edit/outcome/index.php', ['id' => $courseid]); $PAGE->set_url($url); $PAGE->set_pagelayout('admin'); /// Make sure they can even access this course if ($courseid) { $course = $DB->get_record('course', array('id' => $courseid), '*', MUST_EXIST); require_login($course); $context = context_course::instance($course->id); require_capability('moodle/grade:manageoutcomes', $context); if (empty($CFG->enableoutcomes)) { redirect('../../index.php?id='.$courseid); } // This page doesn't exist on the navigation so map it to another navigation_node::override_active_url(new moodle_url('/grade/edit/outcome/course.php', array('id'=>$courseid))); $PAGE->navbar->add(get_string('manageoutcomes', 'grades'), $url); } else { if (empty($CFG->enableoutcomes)) { redirect('../../../'); } require_once $CFG->libdir.'/adminlib.php'; admin_externalpage_setup('outcomes'); $context = context_system::instance(); $PAGE->set_primary_active_tab('siteadminnode'); } /// return tracking object $gpr = new grade_plugin_return(array('type'=>'edit', 'plugin'=>'outcome', 'courseid'=>$courseid)); $strshortname = get_string('outcomeshortname', 'grades'); $strfullname = get_string('outcomefullname', 'grades'); $strscale = get_string('scale'); $strstandardoutcome = get_string('outcomesstandard', 'grades'); $strcustomoutcomes = get_string('outcomescustom', 'grades'); $strcreatenewoutcome = get_string('outcomecreate', 'grades'); $stritems = get_string('items', 'grades'); $strcourses = get_string('courses'); $stredit = get_string('edit'); switch ($action) { case 'delete': if (!confirm_sesskey()) { break; } $outcomeid = required_param('outcomeid', PARAM_INT); if (!$outcome = grade_outcome::fetch(array('id'=>$outcomeid))) { break; } if (empty($outcome->courseid)) { require_capability('moodle/grade:manage', context_system::instance()); } else if ($outcome->courseid != $courseid) { throw new \moodle_exception('invalidcourseid'); } if (!$outcome->can_delete()) { break; } $deleteconfirmed = optional_param('deleteconfirmed', 0, PARAM_BOOL); if(!$deleteconfirmed){ $PAGE->set_title(get_string('outcomedelete', 'grades')); $PAGE->navbar->add(get_string('outcomedelete', 'grades')); echo $OUTPUT->header(); $confirmurl = new moodle_url('index.php', array( 'id' => $courseid, 'outcomeid' => $outcome->id, 'action'=> 'delete', 'sesskey' => sesskey(), 'deleteconfirmed'=> 1)); echo $OUTPUT->confirm(get_string('outcomeconfirmdelete', 'grades', $outcome->fullname), $confirmurl, "index.php?id={$courseid}"); echo $OUTPUT->footer(); die; }else{ $outcome->delete(); } break; } $systemcontext = context_system::instance(); $caneditsystemscales = has_capability('moodle/course:managescales', $systemcontext); if ($courseid) { $caneditcoursescales = has_capability('moodle/course:managescales', $context); } else { $caneditcoursescales = $caneditsystemscales; } $outcomes_tables = array(); $heading = get_string('outcomes', 'grades'); if ($courseid and $outcomes = grade_outcome::fetch_all_local($courseid)) { $return = $OUTPUT->heading($strcustomoutcomes, 3, 'main mt-3'); $data = array(); foreach($outcomes as $outcome) { $line = array(); $line[] = $outcome->get_name(); $line[] = $outcome->get_shortname(); $scale = $outcome->load_scale(); if (empty($scale->id)) { // hopefully never happens $line[] = $scale->get_name(); debugging("Found a scale with no ID ({$scale->get_name()}) while outputting course outcomes", DEBUG_DEVELOPER); } else { if (empty($scale->courseid)) { $caneditthisscale = $caneditsystemscales; } else if ($scale->courseid == $courseid) { $caneditthisscale = $caneditcoursescales; } else { $context = context_course::instance($scale->courseid); $caneditthisscale = has_capability('moodle/course:managescales', $context); } if ($caneditthisscale) { $line[] = grade_print_scale_link($courseid, $scale, $gpr); } else { $line[] = $scale->get_name(); } } $line[] = $outcome->get_item_uses_count(); $buttons = grade_button('edit', $courseid, $outcome); if ($outcome->can_delete()) { $buttons .= grade_button('delete', $courseid, $outcome); } $line[] = $buttons; $data[] = $line; } $table = new html_table(); $table->head = array($strfullname, $strshortname, $strscale, $stritems, $stredit); $table->size = array('30%', '20%', '20%', '20%', '10%' ); $table->align = array('left', 'left', 'left', 'center', 'center'); $table->width = '90%'; $table->data = $data; $return .= html_writer::table($table); $outcomes_tables[] = $return; } if ($outcomes = grade_outcome::fetch_all_global()) { $return = $OUTPUT->heading($strstandardoutcome, 3, 'main mt-3'); $data = array(); foreach($outcomes as $outcome) { $line = array(); $line[] = $outcome->get_name(); $line[] = $outcome->get_shortname(); $scale = $outcome->load_scale(); if (empty($scale->id)) { // hopefully never happens $line[] = $scale->get_name(); debugging("Found a scale with no ID ({$scale->get_name()}) while outputting global outcomes", DEBUG_DEVELOPER); } else { if (empty($scale->courseid)) { $caneditthisscale = $caneditsystemscales; } else if ($scale->courseid == $courseid) { $caneditthisscale = $caneditcoursescales; } else { $context = context_course::instance($scale->courseid); $caneditthisscale = has_capability('moodle/course:managescales', $context); } if ($caneditthisscale) { $line[] = grade_print_scale_link($courseid, $scale, $gpr); } else { $line[] = $scale->get_name(); } } $line[] = $outcome->get_course_uses_count(); $line[] = $outcome->get_item_uses_count(); $buttons = ""; if (has_capability('moodle/grade:manage', context_system::instance())) { $buttons .= grade_button('edit', $courseid, $outcome); } if (has_capability('moodle/grade:manage', context_system::instance()) and $outcome->can_delete()) { $buttons .= grade_button('delete', $courseid, $outcome); } $line[] = $buttons; $data[] = $line; } $table = new html_table(); $table->head = array($strfullname, $strshortname, $strscale, $strcourses, $stritems, $stredit); $table->size = array('30%', '20%', '20%', '10%', '10%', '10%'); $table->align = array('left', 'left', 'left', 'center', 'center', 'center'); $table->width = '90%'; $table->data = $data; $return .= html_writer::table($table); $outcomes_tables[] = $return; } $actionbar = new \core_grades\output\manage_outcomes_action_bar($context, !empty($outcomes_tables)); print_grade_page_head($courseid ?: SITEID, 'outcome', 'edit', $heading, false, false, true, null, null, null, $actionbar); // If there are existing outcomes, output the outcome tables. if (!empty($outcomes_tables)) { foreach ($outcomes_tables as $table) { echo $table; } } else { echo $OUTPUT->notification(get_string('noexistingoutcomes', 'grades'), 'info', false); } echo $OUTPUT->footer(); /** * Local shortcut function for creating a link to a scale. * @param int $courseid The Course ID * @param grade_scale $scale The Scale to link to * @param grade_plugin_return $gpr An object used to identify the page we just came from * @return string html */ function grade_print_scale_link($courseid, $scale, $gpr) { global $CFG, $OUTPUT; $url = new moodle_url('/grade/edit/scale/edit.php', array('courseid' => $courseid, 'id' => $scale->id)); $url = $gpr->add_url_params($url); return html_writer::link($url, $scale->get_name()); } edit/tree/action.php 0000604 00000012336 15062070557 0010426 0 ustar 00 <?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/>. /** * Performs actions on grade items and categories like hiding and locking * * @package core_grades * @copyright 2007 Petr Skoda * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once '../../../config.php'; require_once $CFG->dirroot.'/grade/lib.php'; $courseid = required_param('id', PARAM_INT); $action = required_param('action', PARAM_ALPHA); $eid = required_param('eid', PARAM_ALPHANUM); $PAGE->set_url('/grade/edit/tree/action.php', array('id'=>$courseid, 'action'=>$action, 'eid'=>$eid)); /// Make sure they can even access this course if (!$course = $DB->get_record('course', array('id' => $courseid))) { throw new \moodle_exception('invalidcourseid'); } require_login($course); $context = context_course::instance($course->id); // default return url $gpr = new grade_plugin_return(); $returnurl = $gpr->get_return_url($CFG->wwwroot.'/grade/edit/tree/index.php?id='.$course->id); // get the grading tree object $gtree = new grade_tree($courseid, false, false); // what are we working with? if (!$element = $gtree->locate_element($eid)) { throw new \moodle_exception('invalidelementid', '', $returnurl); } $object = $element['object']; $type = $element['type']; switch ($action) { case 'hide': if ($eid and confirm_sesskey()) { if (!has_capability('moodle/grade:manage', $context) and !has_capability('moodle/grade:hide', $context)) { throw new \moodle_exception('nopermissiontohide', '', $returnurl); } if ($type == 'grade' and empty($object->id)) { $object->insert(); } if (!$object->can_control_visibility()) { throw new \moodle_exception('componentcontrolsvisibility', 'grades', $returnurl); } $object->set_hidden(1, true); } break; case 'show': if ($eid and confirm_sesskey()) { if (!has_capability('moodle/grade:manage', $context) and !has_capability('moodle/grade:hide', $context)) { throw new \moodle_exception('nopermissiontoshow', '', $returnurl); } if ($type == 'grade' and empty($object->id)) { $object->insert(); } if (!$object->can_control_visibility()) { throw new \moodle_exception('componentcontrolsvisibility', 'grades', $returnurl); } $object->set_hidden(0, true); } break; case 'lock': if ($eid and confirm_sesskey()) { if (!has_capability('moodle/grade:manage', $context) and !has_capability('moodle/grade:lock', $context)) { throw new \moodle_exception('nopermissiontolock', '', $returnurl); } if ($type == 'grade' and empty($object->id)) { $object->insert(); } $object->set_locked(1, false, true); } break; case 'unlock': if ($eid and confirm_sesskey()) { if (!has_capability('moodle/grade:manage', $context) and !has_capability('moodle/grade:unlock', $context)) { throw new \moodle_exception('nopermissiontounlock', '', $returnurl); } if ($type == 'grade' and empty($object->id)) { $object->insert(); } $object->set_locked(0, false, true); } break; case 'resetweights': if ($eid && confirm_sesskey()) { // This is specific to category items with natural weight as an aggregation method, and can // only be done by someone who can manage the grades. if ($type != 'category' || $object->aggregation != GRADE_AGGREGATE_SUM || !has_capability('moodle/grade:manage', $context)) { throw new \moodle_exception('nopermissiontoresetweights', 'grades', $returnurl); } // Remove the weightoverride flag from the children. $children = $object->get_children(); foreach ($children as $item) { if ($item['type'] == 'category') { $gradeitem = $item['object']->load_grade_item(); } else { $gradeitem = $item['object']; } if ($gradeitem->weightoverride == false) { continue; } $gradeitem->weightoverride = false; $gradeitem->update(); } // Force regrading. $object->force_regrading(); } } redirect($returnurl); //redirect($returnurl, 'debug delay', 5); edit/tree/category_form.php 0000604 00000066464 15062070557 0012024 0 ustar 00 <?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/>. /** * A moodleform to edit the grade options for an individual grade category * * @package core_grades * @copyright 2007 Petr Skoda * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ if (!defined('MOODLE_INTERNAL')) { die('Direct access to this script is forbidden.'); /// It must be included from a Moodle page } require_once $CFG->libdir.'/formslib.php'; class edit_category_form extends moodleform { private $aggregation_options = array(); function definition() { global $CFG, $COURSE, $DB, $OUTPUT; $mform =& $this->_form; $category = $this->_customdata['current']; $this->aggregation_options = grade_helper::get_aggregation_strings(); // visible elements $mform->addElement('header', 'headercategory', get_string('gradecategory', 'grades')); $mform->addElement('text', 'fullname', get_string('categoryname', 'grades')); $mform->setType('fullname', PARAM_TEXT); $mform->addRule('fullname', null, 'required', null, 'client'); $mform->addElement('select', 'aggregation', get_string('aggregation', 'grades'), $this->aggregation_options); $mform->addHelpButton('aggregation', 'aggregation', 'grades'); $mform->addElement('checkbox', 'aggregateonlygraded', get_string('aggregateonlygraded', 'grades')); $mform->addHelpButton('aggregateonlygraded', 'aggregateonlygraded', 'grades'); if (empty($CFG->enableoutcomes)) { $mform->addElement('hidden', 'aggregateoutcomes'); $mform->setType('aggregateoutcomes', PARAM_INT); } else { $mform->addElement('checkbox', 'aggregateoutcomes', get_string('aggregateoutcomes', 'grades')); $mform->addHelpButton('aggregateoutcomes', 'aggregateoutcomes', 'grades'); } $mform->addElement('text', 'keephigh', get_string('keephigh', 'grades'), 'size="3"'); $mform->setType('keephigh', PARAM_INT); $mform->addHelpButton('keephigh', 'keephigh', 'grades'); $mform->addElement('text', 'droplow', get_string('droplow', 'grades'), 'size="3"'); $mform->setType('droplow', PARAM_INT); $mform->addHelpButton('droplow', 'droplow', 'grades'); $mform->disabledIf('droplow', 'keephigh', 'noteq', 0); $mform->disabledIf('keephigh', 'droplow', 'noteq', 0); $mform->disabledIf('droplow', 'keephigh', 'noteq', 0); // Grade item settings // Displayed as Category total to avoid confusion between grade items requiring marking and category totals $mform->addElement('header', 'general', get_string('categorytotal', 'grades')); $mform->setExpanded('general'); $mform->addElement('text', 'grade_item_itemname', get_string('categorytotalname', 'grades')); $mform->setType('grade_item_itemname', PARAM_TEXT); $mform->addElement('text', 'grade_item_iteminfo', get_string('iteminfo', 'grades')); $mform->addHelpButton('grade_item_iteminfo', 'iteminfo', 'grades'); $mform->setType('grade_item_iteminfo', PARAM_TEXT); $mform->addElement('text', 'grade_item_idnumber', get_string('idnumbermod')); $mform->addHelpButton('grade_item_idnumber', 'idnumbermod'); $mform->setType('grade_item_idnumber', PARAM_RAW); if (!empty($category->id)) { $gradecategory = grade_category::fetch(array('id' => $category->id)); $gradeitem = $gradecategory->load_grade_item(); // If grades exist set a message so the user knows why they can not alter the grade type or scale. // We could never change the grade type for external items, so only need to show this for manual grade items. if ($gradeitem->has_overridden_grades()) { // Set a message so the user knows why the can not alter the grade type or scale. if ($gradeitem->gradetype == GRADE_TYPE_SCALE) { $gradesexistmsg = get_string('modgradecategorycantchangegradetyporscalemsg', 'grades'); } else { $gradesexistmsg = get_string('modgradecategorycantchangegradetypemsg', 'grades'); } $notification = new \core\output\notification($gradesexistmsg, \core\output\notification::NOTIFY_INFO); $notification->set_show_closebutton(false); $mform->addElement('static', 'gradesexistmsg', '', $OUTPUT->render($notification)); } } $options = array(GRADE_TYPE_NONE=>get_string('typenone', 'grades'), GRADE_TYPE_VALUE=>get_string('typevalue', 'grades'), GRADE_TYPE_SCALE=>get_string('typescale', 'grades'), GRADE_TYPE_TEXT=>get_string('typetext', 'grades')); $mform->addElement('select', 'grade_item_gradetype', get_string('gradetype', 'grades'), $options); $mform->addHelpButton('grade_item_gradetype', 'gradetype', 'grades'); $mform->setDefault('grade_item_gradetype', GRADE_TYPE_VALUE); $mform->disabledIf('grade_item_gradetype', 'aggregation', 'eq', GRADE_AGGREGATE_SUM); //$mform->addElement('text', 'calculation', get_string('calculation', 'grades')); //$mform->disabledIf('calculation', 'gradetype', 'eq', GRADE_TYPE_TEXT); //$mform->disabledIf('calculation', 'gradetype', 'eq', GRADE_TYPE_NONE); $options = array(0=>get_string('usenoscale', 'grades')); if ($scales = grade_scale::fetch_all_local($COURSE->id)) { foreach ($scales as $scale) { $options[$scale->id] = $scale->get_name(); } } if ($scales = grade_scale::fetch_all_global()) { foreach ($scales as $scale) { $options[$scale->id] = $scale->get_name(); } } // ugly BC hack - it was possible to use custom scale from other courses :-( if (!empty($category->grade_item_scaleid) and !isset($options[$category->grade_item_scaleid])) { if ($scale = grade_scale::fetch(array('id'=>$category->grade_item_scaleid))) { $options[$scale->id] = $scale->get_name().' '.get_string('incorrectcustomscale', 'grades'); } } $mform->addElement('select', 'grade_item_scaleid', get_string('scale'), $options); $mform->addHelpButton('grade_item_scaleid', 'typescale', 'grades'); $mform->disabledIf('grade_item_scaleid', 'grade_item_gradetype', 'noteq', GRADE_TYPE_SCALE); $mform->disabledIf('grade_item_scaleid', 'aggregation', 'eq', GRADE_AGGREGATE_SUM); $choices = array(); $choices[''] = get_string('choose'); $choices['no'] = get_string('no'); $choices['yes'] = get_string('yes'); $mform->addElement('select', 'grade_item_rescalegrades', get_string('modgradecategoryrescalegrades', 'grades'), $choices); $mform->addHelpButton('grade_item_rescalegrades', 'modgradecategoryrescalegrades', 'grades'); $mform->disabledIf('grade_item_rescalegrades', 'grade_item_gradetype', 'noteq', GRADE_TYPE_VALUE); $mform->addElement('float', 'grade_item_grademax', get_string('grademax', 'grades')); $mform->addHelpButton('grade_item_grademax', 'grademax', 'grades'); $mform->disabledIf('grade_item_grademax', 'grade_item_gradetype', 'noteq', GRADE_TYPE_VALUE); $mform->disabledIf('grade_item_grademax', 'aggregation', 'eq', GRADE_AGGREGATE_SUM); if ((bool) get_config('moodle', 'grade_report_showmin')) { $mform->addElement('float', 'grade_item_grademin', get_string('grademin', 'grades')); $mform->addHelpButton('grade_item_grademin', 'grademin', 'grades'); $mform->disabledIf('grade_item_grademin', 'grade_item_gradetype', 'noteq', GRADE_TYPE_VALUE); $mform->disabledIf('grade_item_grademin', 'aggregation', 'eq', GRADE_AGGREGATE_SUM); } $mform->addElement('float', 'grade_item_gradepass', get_string('gradepass', 'grades')); $mform->addHelpButton('grade_item_gradepass', 'gradepass', 'grades'); $mform->disabledIf('grade_item_gradepass', 'grade_item_gradetype', 'eq', GRADE_TYPE_NONE); $mform->disabledIf('grade_item_gradepass', 'grade_item_gradetype', 'eq', GRADE_TYPE_TEXT); /// grade display prefs $default_gradedisplaytype = grade_get_setting($COURSE->id, 'displaytype', $CFG->grade_displaytype); $options = array(GRADE_DISPLAY_TYPE_DEFAULT => get_string('default', 'grades'), GRADE_DISPLAY_TYPE_REAL => get_string('real', 'grades'), GRADE_DISPLAY_TYPE_PERCENTAGE => get_string('percentage', 'grades'), GRADE_DISPLAY_TYPE_LETTER => get_string('letter', 'grades'), GRADE_DISPLAY_TYPE_REAL_PERCENTAGE => get_string('realpercentage', 'grades'), GRADE_DISPLAY_TYPE_REAL_LETTER => get_string('realletter', 'grades'), GRADE_DISPLAY_TYPE_LETTER_REAL => get_string('letterreal', 'grades'), GRADE_DISPLAY_TYPE_LETTER_PERCENTAGE => get_string('letterpercentage', 'grades'), GRADE_DISPLAY_TYPE_PERCENTAGE_LETTER => get_string('percentageletter', 'grades'), GRADE_DISPLAY_TYPE_PERCENTAGE_REAL => get_string('percentagereal', 'grades') ); asort($options); foreach ($options as $key=>$option) { if ($key == $default_gradedisplaytype) { $options[GRADE_DISPLAY_TYPE_DEFAULT] = get_string('defaultprev', 'grades', $option); break; } } $mform->addElement('select', 'grade_item_display', get_string('gradedisplaytype', 'grades'), $options); $mform->addHelpButton('grade_item_display', 'gradedisplaytype', 'grades'); $mform->disabledIf('grade_item_display', 'grade_item_gradetype', 'in', array(GRADE_TYPE_TEXT, GRADE_TYPE_NONE)); $default_gradedecimals = grade_get_setting($COURSE->id, 'decimalpoints', $CFG->grade_decimalpoints); $options = array(-1=>get_string('defaultprev', 'grades', $default_gradedecimals), 0=>0, 1=>1, 2=>2, 3=>3, 4=>4, 5=>5); $mform->addElement('select', 'grade_item_decimals', get_string('decimalpoints', 'grades'), $options); $mform->addHelpButton('grade_item_decimals', 'decimalpoints', 'grades'); $mform->setDefault('grade_item_decimals', -1); $mform->disabledIf('grade_item_decimals', 'grade_item_display', 'eq', GRADE_DISPLAY_TYPE_LETTER); $mform->disabledIf('grade_item_decimals', 'grade_item_gradetype', 'in', array(GRADE_TYPE_TEXT, GRADE_TYPE_NONE)); if ($default_gradedisplaytype == GRADE_DISPLAY_TYPE_LETTER) { $mform->disabledIf('grade_item_decimals', 'grade_item_display', "eq", GRADE_DISPLAY_TYPE_DEFAULT); } /// hiding // advcheckbox is not compatible with disabledIf! $mform->addElement('checkbox', 'grade_item_hidden', get_string('hidden', 'grades')); $mform->addHelpButton('grade_item_hidden', 'hidden', 'grades'); $mform->addElement('date_time_selector', 'grade_item_hiddenuntil', get_string('hiddenuntil', 'grades'), array('optional'=>true)); $mform->disabledIf('grade_item_hidden', 'grade_item_hiddenuntil[enabled]', 'checked'); /// locking $mform->addElement('checkbox', 'grade_item_locked', get_string('locked', 'grades')); $mform->addHelpButton('grade_item_locked', 'locked', 'grades'); $mform->addElement('date_time_selector', 'grade_item_locktime', get_string('locktime', 'grades'), array('optional'=>true)); $mform->disabledIf('grade_item_locktime', 'grade_item_gradetype', 'eq', GRADE_TYPE_NONE); /// parent category related settings $mform->addElement('header', 'headerparent', get_string('parentcategory', 'grades')); $mform->setExpanded('headerparent'); $mform->addElement('advcheckbox', 'grade_item_weightoverride', get_string('adjustedweight', 'grades')); $mform->addHelpButton('grade_item_weightoverride', 'weightoverride', 'grades'); $mform->addElement('float', 'grade_item_aggregationcoef2', get_string('weight', 'grades')); $mform->addHelpButton('grade_item_aggregationcoef2', 'weight', 'grades'); $mform->disabledIf('grade_item_aggregationcoef2', 'grade_item_weightoverride'); $options = array(); $default = -1; $categories = grade_category::fetch_all(array('courseid'=>$COURSE->id)); foreach ($categories as $cat) { $cat->apply_forced_settings(); $options[$cat->id] = $cat->get_name(); if ($cat->is_course_category()) { $default = $cat->id; } } if (count($categories) > 1) { $mform->addElement('select', 'parentcategory', get_string('parentcategory', 'grades'), $options); $mform->setDefault('parentcategory', $default); $mform->addElement('static', 'currentparentaggregation', get_string('currentparentaggregation', 'grades')); } // hidden params $mform->addElement('hidden', 'id', 0); $mform->setType('id', PARAM_INT); $mform->addElement('hidden', 'courseid', 0); $mform->setType('courseid', PARAM_INT); /// add return tracking info $gpr = $this->_customdata['gpr']; $gpr->add_mform_elements($mform); //------------------------------------------------------------------------------- // buttons $this->add_action_buttons(); //------------------------------------------------------------------------------- $this->set_data($category); } function definition_after_data() { global $CFG, $COURSE; $mform =& $this->_form; $somecat = new grade_category(); foreach ($somecat->forceable as $property) { if ((int)$CFG->{"grade_{$property}_flag"} & 1) { if ($mform->elementExists($property)) { if (empty($CFG->grade_hideforcedsettings)) { $mform->hardFreeze($property); } else { if ($mform->elementExists($property)) { $mform->removeElement($property); } } } } } if ($CFG->grade_droplow > 0) { if ($mform->elementExists('keephigh')) { $mform->removeElement('keephigh'); } } else if ($CFG->grade_keephigh > 0) { if ($mform->elementExists('droplow')) { $mform->removeElement('droplow'); } } if ($id = $mform->getElementValue('id')) { $grade_category = grade_category::fetch(array('id'=>$id)); $grade_item = $grade_category->load_grade_item(); // remove agg coef if not used if ($grade_category->is_course_category()) { if ($mform->elementExists('parentcategory')) { $mform->removeElement('parentcategory'); } if ($mform->elementExists('currentparentaggregation')) { $mform->removeElement('currentparentaggregation'); } } else { // if we wanted to change parent of existing category - we would have to verify there are no circular references in parents!!! if ($mform->elementExists('parentcategory')) { $mform->hardFreeze('parentcategory'); } $parent_cat = $grade_category->get_parent_category(); $mform->setDefault('currentparentaggregation', $this->aggregation_options[$parent_cat->aggregation]); } // Prevent the user from using drop lowest/keep highest when the aggregation method cannot handle it. if (!$grade_category->can_apply_limit_rules()) { if ($mform->elementExists('keephigh')) { $mform->setConstant('keephigh', 0); $mform->hardFreeze('keephigh'); } if ($mform->elementExists('droplow')) { $mform->setConstant('droplow', 0); $mform->hardFreeze('droplow'); } } if ($grade_item->is_calculated()) { // following elements are ignored when calculation formula used if ($mform->elementExists('aggregation')) { $mform->removeElement('aggregation'); } if ($mform->elementExists('keephigh')) { $mform->removeElement('keephigh'); } if ($mform->elementExists('droplow')) { $mform->removeElement('droplow'); } if ($mform->elementExists('aggregateonlygraded')) { $mform->removeElement('aggregateonlygraded'); } if ($mform->elementExists('aggregateoutcomes')) { $mform->removeElement('aggregateoutcomes'); } } // If it is a course category, remove the "required" rule from the "fullname" element if ($grade_category->is_course_category()) { unset($mform->_rules['fullname']); $key = array_search('fullname', $mform->_required); unset($mform->_required[$key]); } // If it is a course category and its fullname is ?, show an empty field if ($grade_category->is_course_category() && $mform->getElementValue('fullname') == '?') { $mform->setDefault('fullname', ''); } // remove unwanted aggregation options if ($mform->elementExists('aggregation')) { $allaggoptions = array_keys($this->aggregation_options); $agg_el =& $mform->getElement('aggregation'); $visible = explode(',', $CFG->grade_aggregations_visible); if (!is_null($grade_category->aggregation)) { // current type is always visible $visible[] = $grade_category->aggregation; } foreach ($allaggoptions as $type) { if (!in_array($type, $visible)) { $agg_el->removeOption($type); } } } } else { // adding new category if ($mform->elementExists('currentparentaggregation')) { $mform->removeElement('currentparentaggregation'); } // remove unwanted aggregation options if ($mform->elementExists('aggregation')) { $allaggoptions = array_keys($this->aggregation_options); $agg_el =& $mform->getElement('aggregation'); $visible = explode(',', $CFG->grade_aggregations_visible); foreach ($allaggoptions as $type) { if (!in_array($type, $visible)) { $agg_el->removeOption($type); } } } $mform->removeElement('grade_item_rescalegrades'); } // no parent header for course category if (!$mform->elementExists('parentcategory')) { $mform->removeElement('headerparent'); } /// GRADE ITEM if ($id = $mform->getElementValue('id')) { $grade_category = grade_category::fetch(array('id'=>$id)); $grade_item = $grade_category->load_grade_item(); // Load appropriate "hidden"/"hidden until" defaults. if ($grade_item->is_hiddenuntil()) { $mform->setDefault('grade_item_hiddenuntil', $grade_item->get_hidden()); } else { $mform->setDefault('grade_item_hidden', $grade_item->get_hidden()); } if ($grade_item->is_outcome_item()) { // we have to prevent incompatible modifications of outcomes if outcomes disabled $mform->removeElement('grade_item_grademax'); if ($mform->elementExists('grade_item_grademin')) { $mform->removeElement('grade_item_grademin'); } $mform->removeElement('grade_item_gradetype'); $mform->removeElement('grade_item_display'); $mform->removeElement('grade_item_decimals'); $mform->hardFreeze('grade_item_scaleid'); // Only show the option to rescale grades on a category if its corresponding grade_item has overridden grade_grades. } else if ($grade_item->has_overridden_grades()) { // Can't change the grade type or the scale if there are grades. $mform->hardFreeze('grade_item_gradetype, grade_item_scaleid'); // If we are using scles then remove the unnecessary rescale and grade fields. if ($grade_item->gradetype == GRADE_TYPE_SCALE) { $mform->removeElement('grade_item_rescalegrades'); $mform->removeElement('grade_item_grademax'); if ($mform->elementExists('grade_item_grademin')) { $mform->removeElement('grade_item_grademin'); } } else { // Not using scale, so remove it. $mform->removeElement('grade_item_scaleid'); $mform->disabledIf('grade_item_grademax', 'grade_item_rescalegrades', 'eq', ''); $mform->disabledIf('grade_item_grademin', 'grade_item_rescalegrades', 'eq', ''); } } else { // Remove the rescale element if there are no grades. $mform->removeElement('grade_item_rescalegrades'); } //remove the aggregation coef element if not needed if ($grade_item->is_course_item()) { if ($mform->elementExists('grade_item_aggregationcoef')) { $mform->removeElement('grade_item_aggregationcoef'); } if ($mform->elementExists('grade_item_weightoverride')) { $mform->removeElement('grade_item_weightoverride'); } if ($mform->elementExists('grade_item_aggregationcoef2')) { $mform->removeElement('grade_item_aggregationcoef2'); } } else { if ($grade_item->is_category_item()) { $category = $grade_item->get_item_category(); $parent_category = $category->get_parent_category(); } else { $parent_category = $grade_item->get_parent_category(); } $parent_category->apply_forced_settings(); if (!$parent_category->is_aggregationcoef_used()) { if ($mform->elementExists('grade_item_aggregationcoef')) { $mform->removeElement('grade_item_aggregationcoef'); } } else { $coefstring = $grade_item->get_coefstring(); if ($coefstring == 'aggregationcoefextrasum' || $coefstring == 'aggregationcoefextraweightsum') { // advcheckbox is not compatible with disabledIf! $coefstring = 'aggregationcoefextrasum'; $element =& $mform->createElement('checkbox', 'grade_item_aggregationcoef', get_string($coefstring, 'grades')); } else { $element =& $mform->createElement('text', 'grade_item_aggregationcoef', get_string($coefstring, 'grades')); } $mform->insertElementBefore($element, 'parentcategory'); $mform->addHelpButton('grade_item_aggregationcoef', $coefstring, 'grades'); } // Remove fields used by natural weighting if the parent category is not using natural weighting. // Or if the item is a scale and scales are not used in aggregation. if ($parent_category->aggregation != GRADE_AGGREGATE_SUM || (empty($CFG->grade_includescalesinaggregation) && $grade_item->gradetype == GRADE_TYPE_SCALE)) { if ($mform->elementExists('grade_item_weightoverride')) { $mform->removeElement('grade_item_weightoverride'); } if ($mform->elementExists('grade_item_aggregationcoef2')) { $mform->removeElement('grade_item_aggregationcoef2'); } } } } } function validation($data, $files) { global $COURSE; $gradeitem = false; if ($data['id']) { $gradecategory = grade_category::fetch(array('id' => $data['id'])); $gradeitem = $gradecategory->load_grade_item(); } $errors = parent::validation($data, $files); if (array_key_exists('grade_item_gradetype', $data) and $data['grade_item_gradetype'] == GRADE_TYPE_SCALE) { if (empty($data['grade_item_scaleid'])) { $errors['grade_item_scaleid'] = get_string('missingscale', 'grades'); } } // We need to make all the validations related with grademax and grademin // with them being correct floats, keeping the originals unmodified for // later validations / showing the form back... // TODO: Note that once MDL-73994 is fixed we'll have to re-visit this and // adapt the code below to the new values arriving here, without forgetting // the special case of empties and nulls. $grademax = isset($data['grade_item_grademax']) ? unformat_float($data['grade_item_grademax']) : null; $grademin = isset($data['grade_item_grademin']) ? unformat_float($data['grade_item_grademin']) : null; if (!is_null($grademin) and !is_null($grademax)) { if (($grademax != 0 OR $grademin != 0) AND ($grademax == $grademin OR $grademax < $grademin)) { $errors['grade_item_grademin'] = get_string('incorrectminmax', 'grades'); $errors['grade_item_grademax'] = get_string('incorrectminmax', 'grades'); } } if ($data['id'] && $gradeitem->has_overridden_grades()) { if ($gradeitem->gradetype == GRADE_TYPE_VALUE) { if (grade_floats_different($grademin, $gradeitem->grademin) || grade_floats_different($grademax, $gradeitem->grademax)) { if (empty($data['grade_item_rescalegrades'])) { $errors['grade_item_rescalegrades'] = get_string('mustchooserescaleyesorno', 'grades'); } } } } return $errors; } } edit/tree/lib.php 0000604 00000145345 15062070557 0007726 0 ustar 00 <?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/>. /** * A library of classes used by the grade edit pages * * @package core_grades * @copyright 2009 Nicolas Connault * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class grade_edit_tree { public $columns = array(); /** * @var grade_tree $gtree @see grade/lib.php */ public $gtree; /** * @var grade_plugin_return @see grade/lib.php */ public $gpr; /** * @var string $moving The eid of the category or item being moved */ public $moving; public $deepest_level; public $uses_weight = false; public $table; public $categories = array(); /** * Constructor */ public function __construct($gtree, $moving, $gpr) { global $USER, $OUTPUT, $COURSE; $this->gtree = $gtree; $this->moving = $moving; $this->gpr = $gpr; $this->deepest_level = $this->get_deepest_level($this->gtree->top_element); $this->columns = array(grade_edit_tree_column::factory('name', array('deepest_level' => $this->deepest_level))); if ($this->uses_weight) { $this->columns[] = grade_edit_tree_column::factory('weight', array('adv' => 'weight')); } $this->columns[] = grade_edit_tree_column::factory('range'); // This is not a setting... How do we deal with it? $this->columns[] = grade_edit_tree_column::factory('status'); $this->columns[] = grade_edit_tree_column::factory('actions'); $this->table = new html_table(); $this->table->id = "grade_edit_tree_table"; $this->table->attributes['class'] = 'generaltable simple setup-grades'; if ($this->moving) { $this->table->attributes['class'] .= ' moving'; } foreach ($this->columns as $column) { if (!($this->moving && $column->hide_when_moving)) { $this->table->head[] = $column->get_header_cell(); } } $rowcount = 0; $this->table->data = $this->build_html_tree($this->gtree->top_element, true, array(), 0, $rowcount); } /** * Recursive function for building the table holding the grade categories and items, * with CSS indentation and styles. * * @param array $element The current tree element being rendered * @param boolean $totals Whether or not to print category grade items (category totals) * @param array $parents An array of parent categories for the current element (used for indentation and row classes) * * @return string HTML */ public function build_html_tree($element, $totals, $parents, $level, &$row_count) { global $CFG, $COURSE, $PAGE, $OUTPUT; $object = $element['object']; $eid = $element['eid']; $name = $this->gtree->get_element_header($element, true, false, true, false, true); $icon = $this->gtree->get_element_icon($element); $type = $this->gtree->get_element_type_string($element); $strippedname = $this->gtree->get_element_header($element, false, false, false); $is_category_item = false; if ($element['type'] == 'categoryitem' || $element['type'] == 'courseitem') { $is_category_item = true; } $rowclasses = array(); foreach ($parents as $parent_eid) { $rowclasses[] = $parent_eid; } $moveaction = ''; $actions = $this->gtree->get_cell_action_menu($element, 'setup', $this->gpr); if ($element['type'] == 'item' or ($element['type'] == 'category' and $element['depth'] > 1)) { $aurl = new moodle_url('index.php', array('id' => $COURSE->id, 'action' => 'moveselect', 'eid' => $eid, 'sesskey' => sesskey())); $moveaction .= $OUTPUT->action_icon($aurl, new pix_icon('t/move', get_string('move'))); } $returnrows = array(); $root = false; $id = required_param('id', PARAM_INT); /// prepare move target if needed $last = ''; /// print the list items now if ($this->moving == $eid) { // do not diplay children $cell = new html_table_cell(); $cell->colspan = 12; $cell->attributes['class'] = $element['type'] . ' moving column-name level' . ($level + 1) . ' level' . ($level % 2 ? 'even' : 'odd'); $cell->text = $name.' ('.get_string('move').')'; // Create a row that represents the available area to move a grade item or a category into. $movingarea = new html_table_row(); // Obtain all parent category identifiers for this item and add them to its class list. This information // will be used when collapsing or expanding grade categories to properly show or hide this area. $parentcategories = array_merge($rowclasses, [$eid]); $movingarea->attributes = [ 'class' => implode(' ', $parentcategories), 'data-hidden' => 'false' ]; $movingarea->cells[] = $cell; return [$movingarea]; } if ($element['type'] == 'category') { $level++; $this->categories[$object->id] = $strippedname; $category = grade_category::fetch(array('id' => $object->id)); $category->load_grade_item(); // Add aggregation coef input if not a course item and if parent category has correct aggregation type // Before we print the category's row, we must find out how many rows will appear below it (for the filler cell's rowspan) $aggregation_position = grade_get_setting($COURSE->id, 'aggregationposition', $CFG->grade_aggregationposition); $category_total_data = null; // Used if aggregationposition is set to "last", so we can print it last $html_children = array(); // Take into consideration that a category item always has an empty row (spacer) below. $row_count = 1; foreach($element['children'] as $child_el) { $moveto = null; if (empty($child_el['object']->itemtype)) { $child_el['object']->itemtype = false; } if (($child_el['object']->itemtype == 'course' || $child_el['object']->itemtype == 'category') && !$totals) { continue; } $child_eid = $child_el['eid']; $first = ''; if ($child_el['object']->itemtype == 'course' || $child_el['object']->itemtype == 'category') { $first = array('first' => 1); $child_eid = $eid; } if ($this->moving && $this->moving != $child_eid) { $strmove = get_string('move'); $actions = $moveaction = ''; // no action icons when moving $aurl = new moodle_url('index.php', array('id' => $COURSE->id, 'action' => 'move', 'eid' => $this->moving, 'moveafter' => $child_eid, 'sesskey' => sesskey())); if ($first) { $aurl->params($first); } $cell = new html_table_cell(); $cell->colspan = 12; $cell->attributes['class'] = 'movehere level' . ($level + 1) . ' level' . ($level % 2 ? 'even' : 'odd'); $cell->text = html_writer::link($aurl, html_writer::empty_tag('hr'), ['title' => get_string('movehere'), 'class' => 'movehere']); // Create a row that represents the available area to move a grade item or a category into. $moveto = new html_table_row(); // Obtain all parent category identifiers for this item and add them to its class list. This information // will be used when collapsing or expanding grade categories to properly show or hide this area. $parentcategories = array_merge($rowclasses, [$eid]); $moveto->attributes['class'] = implode(' ', $parentcategories); $moveto->attributes['data-hidden'] = 'false'; $moveto->cells[] = $cell; } $newparents = $parents; $newparents[] = $eid; $row_count++; $child_row_count = 0; // If moving, do not print course and category totals, but still print the moveto target box if ($this->moving && ($child_el['object']->itemtype == 'course' || $child_el['object']->itemtype == 'category')) { $html_children[] = $moveto; } elseif ($child_el['object']->itemtype == 'course' || $child_el['object']->itemtype == 'category') { // We don't build the item yet because we first need to know the deepest level of categories (for category/name colspans) $category_total_item = $this->build_html_tree($child_el, $totals, $newparents, $level, $child_row_count); if (!$aggregation_position) { $html_children = array_merge($html_children, $category_total_item); } } else { $html_children = array_merge($html_children, $this->build_html_tree($child_el, $totals, $newparents, $level, $child_row_count)); if (!empty($moveto)) { $html_children[] = $moveto; } if ($this->moving) { $row_count++; } } $row_count += $child_row_count; // If the child is a category, increment row_count by one more (for the extra coloured row) if ($child_el['type'] == 'category') { $row_count++; } } // Print category total at the end if aggregation position is "last" (1) if (!empty($category_total_item) && $aggregation_position) { $html_children = array_merge($html_children, $category_total_item); } // Determine if we are at the root if (isset($element['object']->grade_item) && $element['object']->grade_item->is_course_item()) { $root = true; } $levelclass = "level$level level" . ($level % 2 ? 'odd' : 'even'); $courseclass = ''; if ($level == 1) { $courseclass = 'coursecategory'; } $categoryrow = new html_table_row(); $categoryrow->id = 'grade-item-' . $eid; $categoryrow->attributes['class'] = $courseclass . ' category '; $categoryrow->attributes['data-category'] = $eid; if (!empty($parent_eid)) { $categoryrow->attributes['data-parent-category'] = $parent_eid; } $categoryrow->attributes['data-aggregation'] = $category->aggregation; $categoryrow->attributes['data-grademax'] = $category->grade_item->grademax; $categoryrow->attributes['data-aggregationcoef'] = floatval($category->grade_item->aggregationcoef); $categoryrow->attributes['data-itemid'] = $category->grade_item->id; $categoryrow->attributes['data-hidden'] = 'false'; foreach ($rowclasses as $class) { $categoryrow->attributes['class'] .= ' ' . $class; } foreach ($this->columns as $column) { if (!($this->moving && $column->hide_when_moving)) { $categoryrow->cells[] = $column->get_category_cell($category, $levelclass, [ 'id' => $id, 'name' => $name, 'level' => $level, 'actions' => $actions, 'moveaction' => $moveaction, 'eid' => $eid, ]); } } $emptyrow = new html_table_row(); // Obtain all parent category identifiers for this item and add them to its class list. This information // will be used when collapsing or expanding grade categories to properly show or hide this area. $parentcategories = array_merge($rowclasses, [$eid]); $emptyrow->attributes['class'] = 'spacer ' . implode(' ', $parentcategories); $emptyrow->attributes['data-hidden'] = 'false'; $emptyrow->attributes['aria-hidden'] = 'true'; $headercell = new html_table_cell(); $headercell->header = true; $headercell->scope = 'row'; $headercell->attributes['class'] = 'cell column-rowspan rowspan'; $headercell->attributes['aria-hidden'] = 'true'; $headercell->rowspan = $row_count; $emptyrow->cells[] = $headercell; $returnrows = array_merge([$categoryrow, $emptyrow], $html_children); // Print a coloured row to show the end of the category across the table $endcell = new html_table_cell(); $endcell->colspan = (19 - $level); $endcell->attributes['class'] = 'emptyrow colspan ' . $levelclass; $endcell->attributes['aria-hidden'] = 'true'; $returnrows[] = new html_table_row(array($endcell)); } else { // Dealing with a grade item $item = grade_item::fetch(array('id' => $object->id)); $element['type'] = 'item'; $element['object'] = $item; $categoryitemclass = ''; if ($item->itemtype == 'category') { $categoryitemclass = 'categoryitem'; } if ($item->itemtype == 'course') { $categoryitemclass = 'courseitem'; } $gradeitemrow = new html_table_row(); $gradeitemrow->id = 'grade-item-' . $eid; $gradeitemrow->attributes['class'] = $categoryitemclass . ' item '; $gradeitemrow->attributes['data-itemid'] = $object->id; $gradeitemrow->attributes['data-hidden'] = 'false'; // If this item is a course or category aggregation, add a data attribute that stores the identifier of // the related category or course. This attribute is used when collapsing a grade category to fetch the // max grade from the aggregation and display it in the grade category row when the category items are // collapsed and the aggregated max grade is not visible. if (!empty($categoryitemclass)) { $gradeitemrow->attributes['data-aggregationforcategory'] = $parent_eid; } else { $gradeitemrow->attributes['data-parent-category'] = $parent_eid; $gradeitemrow->attributes['data-grademax'] = $object->grademax; $gradeitemrow->attributes['data-aggregationcoef'] = floatval($object->aggregationcoef); } foreach ($rowclasses as $class) { $gradeitemrow->attributes['class'] .= ' ' . $class; } foreach ($this->columns as $column) { if (!($this->moving && $column->hide_when_moving)) { $gradeitemrow->cells[] = $column->get_item_cell( $item, [ 'id' => $id, 'name' => $name, 'level' => $level, 'actions' => $actions, 'element' => $element, 'eid' => $eid, 'moveaction' => $moveaction, 'itemtype' => $object->itemtype, 'icon' => $icon, 'type' => $type ] ); } } $returnrows[] = $gradeitemrow; } return $returnrows; } /** * Given a grade_item object, returns a labelled input if an aggregation coefficient (weight or extra credit) applies to it. * @param grade_item $item * @return string HTML */ static function get_weight_input($item) { global $OUTPUT; if (!is_object($item) || get_class($item) !== 'grade_item') { throw new Exception('grade_edit_tree::get_weight_input($item) was given a variable that is not of the required type (grade_item object)'); return false; } if ($item->is_course_item()) { return ''; } $parent_category = $item->get_parent_category(); $parent_category->apply_forced_settings(); $aggcoef = $item->get_coefstring(); $itemname = $item->itemname; if ($item->is_category_item()) { // Remember, the parent category of a category item is the category itself. $itemname = $parent_category->get_name(); } $str = ''; if ($aggcoef == 'aggregationcoefweight' || $aggcoef == 'aggregationcoef' || $aggcoef == 'aggregationcoefextraweight') { return $OUTPUT->render_from_template('core_grades/weight_field', [ 'id' => $item->id, 'itemname' => $itemname, 'value' => self::format_number($item->aggregationcoef) ]); } else if ($aggcoef == 'aggregationcoefextraweightsum') { $tpldata = [ 'id' => $item->id, 'itemname' => $itemname, 'value' => self::format_number($item->aggregationcoef2 * 100.0), 'checked' => $item->weightoverride, 'disabled' => !$item->weightoverride ]; $str .= $OUTPUT->render_from_template('core_grades/weight_override_field', $tpldata); } return $str; } // Trims trailing zeros. // Used on the 'Gradebook setup' page for grade items settings like aggregation co-efficient. // Grader report has its own decimal place settings so they are handled elsewhere. static function format_number($number) { $formatted = rtrim(format_float($number, 4),'0'); if (substr($formatted, -1)==get_string('decsep', 'langconfig')) { //if last char is the decimal point $formatted .= '0'; } return $formatted; } /** * Given an element of the grade tree, returns whether it is deletable or not (only manual grade items are deletable) * * @param array $element * @return bool */ public static function element_deletable($element) { global $COURSE; if ($element['type'] != 'item') { return true; } $grade_item = $element['object']; if ($grade_item->itemtype != 'mod' or $grade_item->is_outcome_item() or $grade_item->gradetype == GRADE_TYPE_NONE) { return true; } $modinfo = get_fast_modinfo($COURSE); if (!isset($modinfo->instances[$grade_item->itemmodule][$grade_item->iteminstance])) { // module does not exist return true; } return false; } /** * Given an element of the grade tree, returns whether it is duplicatable or not (only manual grade items are duplicatable) * * @param array $element * @return bool */ public static function element_duplicatable($element) { if ($element['type'] != 'item') { return false; } $gradeitem = $element['object']; if ($gradeitem->itemtype != 'mod') { return true; } return false; } /** * Given the grade tree and an array of element ids (e.g. c15, i42), and expecting the 'moveafter' URL param, * moves the selected items to the requested location. Then redirects the user to the given $returnurl * * @param object $gtree The grade tree (a recursive representation of the grade categories and grade items) * @param array $eids * @param string $returnurl */ function move_elements($eids, $returnurl) { $moveafter = required_param('moveafter', PARAM_INT); if (!is_array($eids)) { $eids = array($eids); } if(!$after_el = $this->gtree->locate_element("cg$moveafter")) { throw new \moodle_exception('invalidelementid', '', $returnurl); } $after = $after_el['object']; $parent = $after; $sortorder = $after->get_sortorder(); foreach ($eids as $eid) { if (!$element = $this->gtree->locate_element($eid)) { throw new \moodle_exception('invalidelementid', '', $returnurl); } $object = $element['object']; $object->set_parent($parent->id); $object->move_after_sortorder($sortorder); $sortorder++; } redirect($returnurl, '', 0); } /** * Recurses through the entire grade tree to find and return the maximum depth of the tree. * This should be run only once from the root element (course category), and is used for the * indentation of the Name column's cells (colspan) * * @param array $element An array of values representing a grade tree's element (all grade items in this case) * @param int $level The level of the current recursion * @param int $deepest_level A value passed to each subsequent level of recursion and incremented if $level > $deepest_level * @return int Deepest level */ function get_deepest_level($element, $level=0, $deepest_level=1) { $object = $element['object']; $level++; $coefstring = $element['object']->get_coefstring(); if ($element['type'] == 'category') { if ($coefstring == 'aggregationcoefweight' || $coefstring == 'aggregationcoefextraweightsum' || $coefstring == 'aggregationcoefextraweight') { $this->uses_weight = true; } foreach($element['children'] as $child_el) { if ($level > $deepest_level) { $deepest_level = $level; } $deepest_level = $this->get_deepest_level($child_el, $level, $deepest_level); } $category = grade_category::fetch(array('id' => $object->id)); $item = $category->get_grade_item(); if ($item->gradetype == GRADE_TYPE_NONE) { // Add 1 more level for grade category that has no total. $deepest_level++; } } return $deepest_level; } /** * Updates the provided gradecategory item with the provided data. * * @param grade_category $gradecategory The category to update. * @param stdClass $data the data to update the category with. * @return void */ public static function update_gradecategory(grade_category $gradecategory, stdClass $data) { // If no fullname is entered for a course category, put ? in the DB. if (!isset($data->fullname) || $data->fullname == '') { $data->fullname = '?'; } if (!isset($data->aggregateonlygraded)) { $data->aggregateonlygraded = 0; } if (!isset($data->aggregateoutcomes)) { $data->aggregateoutcomes = 0; } grade_category::set_properties($gradecategory, $data); // CATEGORY. if (empty($gradecategory->id)) { $gradecategory->insert(); } else { $gradecategory->update(); } // GRADE ITEM. // Grade item data saved with prefix "grade_item_". $itemdata = new stdClass(); foreach ($data as $k => $v) { if (preg_match('/grade_item_(.*)/', $k, $matches)) { $itemdata->{$matches[1]} = $v; } } if (!isset($itemdata->aggregationcoef)) { $itemdata->aggregationcoef = 0; } if (!isset($itemdata->gradepass) || $itemdata->gradepass == '') { $itemdata->gradepass = 0; } if (!isset($itemdata->grademax) || $itemdata->grademax == '') { $itemdata->grademax = 0; } if (!isset($itemdata->grademin) || $itemdata->grademin == '') { $itemdata->grademin = 0; } $hidden = empty($itemdata->hidden) ? 0 : $itemdata->hidden; $hiddenuntil = empty($itemdata->hiddenuntil) ? 0 : $itemdata->hiddenuntil; unset($itemdata->hidden); unset($itemdata->hiddenuntil); $locked = empty($itemdata->locked) ? 0 : $itemdata->locked; $locktime = empty($itemdata->locktime) ? 0 : $itemdata->locktime; unset($itemdata->locked); unset($itemdata->locktime); $convert = array('grademax', 'grademin', 'gradepass', 'multfactor', 'plusfactor', 'aggregationcoef', 'aggregationcoef2'); foreach ($convert as $param) { if (property_exists($itemdata, $param)) { $itemdata->$param = unformat_float($itemdata->$param); } } if (isset($itemdata->aggregationcoef2)) { $itemdata->aggregationcoef2 = $itemdata->aggregationcoef2 / 100.0; } // When creating a new category, a number of grade item fields are filled out automatically, and are required. // If the user leaves these fields empty during creation of a category, we let the default values take effect. // Otherwise, we let the user-entered grade item values take effect. $gradeitem = $gradecategory->load_grade_item(); $gradeitemcopy = fullclone($gradeitem); grade_item::set_properties($gradeitem, $itemdata); if (empty($gradeitem->id)) { $gradeitem->id = $gradeitemcopy->id; } if (empty($gradeitem->grademax) && $gradeitem->grademax != '0') { $gradeitem->grademax = $gradeitemcopy->grademax; } if (empty($gradeitem->grademin) && $gradeitem->grademin != '0') { $gradeitem->grademin = $gradeitemcopy->grademin; } if (empty($gradeitem->gradepass) && $gradeitem->gradepass != '0') { $gradeitem->gradepass = $gradeitemcopy->gradepass; } if (empty($gradeitem->aggregationcoef) && $gradeitem->aggregationcoef != '0') { $gradeitem->aggregationcoef = $gradeitemcopy->aggregationcoef; } // Handle null decimals value - must be done before update! if (!property_exists($itemdata, 'decimals') or $itemdata->decimals < 0) { $gradeitem->decimals = null; } // Change weightoverride flag. Check if the value is set, because it is not when the checkbox is not ticked. $itemdata->weightoverride = isset($itemdata->weightoverride) ? $itemdata->weightoverride : 0; if ($gradeitem->weightoverride != $itemdata->weightoverride && $gradecategory->aggregation == GRADE_AGGREGATE_SUM) { // If we are using natural weight and the weight has been un-overriden, force parent category to recalculate weights. $gradecategory->force_regrading(); } $gradeitem->weightoverride = $itemdata->weightoverride; $gradeitem->outcomeid = null; // This means we want to rescale overridden grades as well. if (!empty($data->grade_item_rescalegrades) && $data->grade_item_rescalegrades == 'yes') { $gradeitem->markasoverriddenwhengraded = false; $gradeitem->rescale_grades_keep_percentage($gradeitemcopy->grademin, $gradeitemcopy->grademax, $gradeitem->grademin, $gradeitem->grademax, 'gradebook'); } // Only update the category's 'hidden' status if it has changed. Leaving a category as 'unhidden' (checkbox left // unmarked) and submitting the form without this conditional check will result in displaying any grade items that // are in the category, including those that were previously 'hidden'. if (($gradecategory->get_hidden() != $hiddenuntil) || ($gradecategory->get_hidden() != $hidden)) { if ($hiddenuntil) { $gradecategory->set_hidden($hiddenuntil, true); } else { $gradecategory->set_hidden($hidden, true); } } $gradeitem->set_locktime($locktime); // Locktime first - it might be removed when unlocking. $gradeitem->set_locked($locked, false, true); $gradeitem->update(); // We don't need to insert it, it's already created when the category is created. // Set parent if needed. if (isset($data->parentcategory)) { $gradecategory->set_parent($data->parentcategory, 'gradebook'); } } } /** * Class grade_edit_tree_column * * @package core_grades * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ abstract class grade_edit_tree_column { public $forced; public $hidden; public $forced_hidden; public $advanced_hidden; public $hide_when_moving = true; /** * html_table_cell object used as a template for header cells in all categories. * It must be cloned before being used. * @var html_table_cell $headercell */ public $headercell; /** * html_table_cell object used as a template for category cells in all categories. * It must be cloned before being used. * @var html_table_cell $categorycell */ public $categorycell; /** * html_table_cell object used as a template for item cells in all categories. * It must be cloned before being used. * @var html_table_cell $itemcell */ public $itemcell; public static function factory($name, $params=array()) { $class_name = "grade_edit_tree_column_$name"; if (class_exists($class_name)) { return new $class_name($params); } } public abstract function get_header_cell(); public function get_category_cell($category, $levelclass, $params) { $cell = clone($this->categorycell); $cell->attributes['class'] .= ' ' . $levelclass; return $cell; } public function get_item_cell($item, $params) { $cell = clone($this->itemcell); if (isset($params['level'])) { $level = $params['level'] + (($item->itemtype == 'category' || $item->itemtype == 'course') ? 0 : 1); $cell->attributes['class'] .= ' level' . $level; $cell->attributes['class'] .= ' level' . ($level % 2 ? 'odd' : 'even'); } return $cell; } public function __construct() { $this->headercell = new html_table_cell(); $this->headercell->header = true; $this->headercell->attributes['class'] = 'header'; $this->categorycell = new html_table_cell(); $this->categorycell->attributes['class'] = 'cell'; $this->itemcell = new html_table_cell(); $this->itemcell->attributes['class'] = 'cell'; if (preg_match('/^grade_edit_tree_column_(\w*)$/', get_class($this), $matches)) { $this->headercell->attributes['class'] .= ' column-' . $matches[1]; $this->categorycell->attributes['class'] .= ' column-' . $matches[1]; $this->itemcell->attributes['class'] .= ' column-' . $matches[1]; } } } /** * Class grade_edit_tree_column_name * * @package core_grades * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class grade_edit_tree_column_name extends grade_edit_tree_column { public $forced = false; public $hidden = false; public $forced_hidden = false; public $advanced_hidden = false; public $deepest_level = 1; public $hide_when_moving = false; public function __construct($params) { if (empty($params['deepest_level'])) { throw new Exception('Tried to instantiate a grade_edit_tree_column_name object without the "deepest_level" param!'); } $this->deepest_level = $params['deepest_level']; parent::__construct(); } public function get_header_cell() { $headercell = clone($this->headercell); $headercell->colspan = $this->deepest_level + 1; $headercell->text = get_string('name'); return $headercell; } public function get_category_cell($category, $levelclass, $params) { global $OUTPUT; if (empty($params['name']) || empty($params['level'])) { throw new Exception('Array key (name or level) missing from 3rd param of grade_edit_tree_column_name::get_category_cell($category, $levelclass, $params)'); } $visibilitytoggle = $OUTPUT->render_from_template('core_grades/grade_category_visibility_toggle', [ 'category' => $params['eid'] ]); $mastercheckbox = ''; if ($this->deepest_level > 1) { if (empty($params['eid'])) { throw new Exception('Array key (eid) missing from 3rd param of ' . 'grade_edit_tree_column_select::get_category_cell($category, $levelclass, $params)'); } // Get toggle group for this master checkbox. $togglegroup = $this->get_checkbox_togglegroup($category); // Set label for this master checkbox. $masterlabel = $params['level'] === 1 ? get_string('all') : $params['name']; // Build the master checkbox. $mastercheckbox = new \core\output\checkbox_toggleall($togglegroup, true, [ 'id' => 'select_category_' . $category->id, 'name' => $togglegroup, 'value' => 1, 'classes' => 'itemselect ignoredirty', 'label' => $masterlabel, // Consistent label to prevent the select column from resizing. 'selectall' => $masterlabel, 'deselectall' => $masterlabel, 'labelclasses' => 'accesshide', ]); $mastercheckbox = $OUTPUT->render($mastercheckbox); } $moveaction = isset($params['moveaction']) ? $params['moveaction'] : ''; $categorycell = parent::get_category_cell($category, $levelclass, $params); $categorycell->colspan = ($this->deepest_level + 2) - $params['level']; $rowtitle = html_writer::div($params['name'], 'rowtitle'); $categorycell->text = html_writer::div($mastercheckbox . $visibilitytoggle . $moveaction . $rowtitle, 'font-weight-bold'); return $categorycell; } public function get_item_cell($item, $params) { if (empty($params['element']) || empty($params['name']) || empty($params['level'])) { throw new Exception('Array key (name, level or element) missing from 2nd param of grade_edit_tree_column_name::get_item_cell($item, $params)'); } $itemicon = \html_writer::div($params['icon'], 'mr-1'); $itemtype = \html_writer::span($params['type'], 'd-block text-uppercase small dimmed_text'); $itemtitle = html_writer::div($params['name'], 'rowtitle'); $content = \html_writer::div($itemtype . $itemtitle); $moveaction = isset($params['moveaction']) ? $params['moveaction'] : ''; $itemcell = parent::get_item_cell($item, $params); $itemcell->colspan = ($this->deepest_level + 1) - $params['level']; $checkbox = ''; if (($this->deepest_level > 1) && ($params['itemtype'] != 'course') && ($params['itemtype'] != 'category')) { global $OUTPUT; $label = get_string('select', 'grades', $params['name']); if (empty($params['itemtype']) || empty($params['eid'])) { throw new \moodle_exception('missingitemtypeoreid', 'core_grades'); } // Fetch the grade item's category. $category = $item->get_parent_category(); $togglegroup = $this->get_checkbox_togglegroup($category); $checkboxid = 'select_' . $params['eid']; $checkbox = new \core\output\checkbox_toggleall($togglegroup, false, [ 'id' => $checkboxid, 'name' => $checkboxid, 'label' => $label, 'labelclasses' => 'accesshide', 'classes' => 'itemselect ignoredirty', ]); $checkbox = $OUTPUT->render($checkbox); } $itemcell->text = \html_writer::div($checkbox . $moveaction . $itemicon . $content, "{$params['itemtype']} d-flex align-items-center"); return $itemcell; } /** * Generates a toggle group name for a bulk-action checkbox based on the given grade category. * * @param grade_category $category The grade category. * @return string */ protected function get_checkbox_togglegroup(grade_category $category): string { $levels = []; $categories = explode('/', $category->path); foreach ($categories as $categoryid) { $level = 'category' . $categoryid; if (!in_array($level, $levels)) { $levels[] = 'category' . $categoryid; } } $togglegroup = implode(' ', $levels); return $togglegroup; } } /** * Class grade_edit_tree_column_weight * * @package core_grades * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class grade_edit_tree_column_weight extends grade_edit_tree_column { public function get_header_cell() { global $OUTPUT; $headercell = clone($this->headercell); $headercell->text = get_string('weights', 'grades').$OUTPUT->help_icon('aggregationcoefweight', 'grades'); return $headercell; } public function get_category_cell($category, $levelclass, $params) { $item = $category->get_grade_item(); $categorycell = parent::get_category_cell($category, $levelclass, $params); $categorycell->text = grade_edit_tree::get_weight_input($item); return $categorycell; } public function get_item_cell($item, $params) { global $CFG; if (empty($params['element'])) { throw new Exception('Array key (element) missing from 2nd param of grade_edit_tree_column_weightorextracredit::get_item_cell($item, $params)'); } $itemcell = parent::get_item_cell($item, $params); $itemcell->text = ' '; $object = $params['element']['object']; if (!in_array($object->itemtype, array('courseitem', 'categoryitem', 'category')) && !in_array($object->gradetype, array(GRADE_TYPE_NONE, GRADE_TYPE_TEXT)) && (!$object->is_outcome_item() || $object->load_parent_category()->aggregateoutcomes) && ($object->gradetype != GRADE_TYPE_SCALE || !empty($CFG->grade_includescalesinaggregation))) { $itemcell->text = grade_edit_tree::get_weight_input($item); } return $itemcell; } } /** * Class grade_edit_tree_column_range * * @package core_grades * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class grade_edit_tree_column_range extends grade_edit_tree_column { public function get_header_cell() { $headercell = clone($this->headercell); $headercell->text = get_string('maxgrade', 'grades'); return $headercell; } public function get_category_cell($category, $levelclass, $params) { $categorycell = parent::get_category_cell($category, $levelclass, $params); $categorycell->text = ''; return $categorycell; } public function get_item_cell($item, $params) { global $DB, $OUTPUT; // If the parent aggregation is Natural, we should show the number, even for scales, as that value is used... // ...in the computation. For text grades, the grademax is not used, so we can still show the no value string. $parentcat = $item->get_parent_category(); if ($item->gradetype == GRADE_TYPE_TEXT) { $grademax = ' - '; } else if ($item->gradetype == GRADE_TYPE_SCALE) { $scale = $DB->get_record('scale', array('id' => $item->scaleid)); $scale_items = null; if (empty($scale)) { //if the item is using a scale that's been removed $scale_items = array(); } else { $scale_items = explode(',', $scale->scale); } if ($parentcat->aggregation == GRADE_AGGREGATE_SUM) { $grademax = end($scale_items) . ' (' . format_float($item->grademax, $item->get_decimals()) . ')'; } else { $grademax = end($scale_items) . ' (' . count($scale_items) . ')'; } } else { $grademax = format_float($item->grademax, $item->get_decimals()); } $isextracredit = false; if ($item->aggregationcoef > 0) { // For category grade items, we need the grandparent category. // The parent is just category the grade item represents. if ($item->is_category_item()) { $grandparentcat = $parentcat->get_parent_category(); if ($grandparentcat->is_extracredit_used()) { $isextracredit = true; } } else if ($parentcat->is_extracredit_used()) { $isextracredit = true; } } if ($isextracredit) { $grademax .= ' ' . html_writer::tag('abbr', get_string('aggregationcoefextrasumabbr', 'grades'), array('title' => get_string('aggregationcoefextrasum', 'grades'))); } $itemcell = parent::get_item_cell($item, $params); $itemcell->text = $grademax; return $itemcell; } } /** * Class grade_edit_tree_column_status * * @package core_grades * @copyright 2023 Ilya Tregubov <ilya@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class grade_edit_tree_column_status extends grade_edit_tree_column { /** * Get status column header cell * @return html_table_cell status column header cell */ public function get_header_cell() { $headercell = clone($this->headercell); $headercell->text = get_string('status'); return $headercell; } /** * Get category cell in status column * * @param grade_category $category grade category * @param string $levelclass Category level info * @param array $params Params (category id, action performed etc) * @return html_table_cell category cell in status columns */ public function get_category_cell($category, $levelclass, $params) { global $OUTPUT, $gtree; $category->load_grade_item(); $categorycell = parent::get_category_cell($category, $levelclass, $params); $element = []; $element['object'] = $category; $categorycell->text = $gtree->set_grade_status_icons($element); $context = new stdClass(); if ($category->grade_item->is_calculated()) { $context->calculatedgrade = get_string('calculatedgrade', 'grades'); } else { // Aggregation type. $aggrstrings = grade_helper::get_aggregation_strings(); $context->aggregation = $aggrstrings[$category->aggregation]; // Include/exclude empty grades. if ($category->aggregateonlygraded) { $context->aggregateonlygraded = $category->aggregateonlygraded; } // Aggregate outcomes. if ($category->aggregateoutcomes) { $context->aggregateoutcomes = $category->aggregateoutcomes; } // Drop the lowest. if ($category->droplow) { $context->droplow = $category->droplow; } // Keep the highest. if ($category->keephigh) { $context->keephigh = $category->keephigh; } } $categorycell->text .= $OUTPUT->render_from_template('core_grades/category_settings', $context); return $categorycell; } /** * Get category cell in status column * * @param grade_item $item grade item * @param array $params Params * @return html_table_cell item cell in status columns */ public function get_item_cell($item, $params) { global $gtree; $element = []; $element['object'] = $item; $itemcell = parent::get_item_cell($item, $params); $itemcell->text = $gtree->set_grade_status_icons($element); return $itemcell; } } /** * Class grade_edit_tree_column_actions * * @package core_grades * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class grade_edit_tree_column_actions extends grade_edit_tree_column { public function __construct($params) { parent::__construct(); } public function get_header_cell() { $headercell = clone($this->headercell); $headercell->text = get_string('actions'); return $headercell; } public function get_category_cell($category, $levelclass, $params) { if (empty($params['actions'])) { throw new Exception('Array key (actions) missing from 3rd param of grade_edit_tree_column_actions::get_category_actions($category, $levelclass, $params)'); } $categorycell = parent::get_category_cell($category, $levelclass, $params); $categorycell->text = $params['actions']; return $categorycell; } public function get_item_cell($item, $params) { if (empty($params['actions'])) { throw new Exception('Array key (actions) missing from 2nd param of grade_edit_tree_column_actions::get_item_cell($item, $params)'); } $itemcell = parent::get_item_cell($item, $params); $itemcell->text = $params['actions']; return $itemcell; } } /** * Class grade_edit_tree_column_select * * @deprecated Since Moodle 4.3. * @todo Final deprecation on Moodle 4.7 MDL-77668 * * @package core_grades * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class grade_edit_tree_column_select extends grade_edit_tree_column { /** * @deprecated Since Moodle 4.3. * @todo Final deprecation on Moodle 4.7 MDL-77668 */ public function get_header_cell() { debugging('Method grade_edit_tree_column_select::get_header_cell() is deprecated, ' . 'please do not use it anymore.', DEBUG_DEVELOPER); $headercell = clone($this->headercell); $headercell->text = get_string('select'); return $headercell; } /** * @deprecated Since Moodle 4.3. * @todo Final deprecation on Moodle 4.7 MDL-77668 */ public function get_category_cell($category, $levelclass, $params) { global $OUTPUT; debugging('Method grade_edit_tree_column_select::get_category_cell() is deprecated, ' . 'please do not use it anymore.', DEBUG_DEVELOPER); if (empty($params['eid'])) { throw new Exception('Array key (eid) missing from 3rd param of grade_edit_tree_column_select::get_category_cell($category, $levelclass, $params)'); } // Get toggle group for this master checkbox. $togglegroup = $this->get_checkbox_togglegroup($category); // Set label for this master checkbox. $masterlabel = get_string('all'); // Use category name if available. if ($category->fullname !== '?') { $masterlabel = format_string($category->fullname, true, ['escape' => false]); // Limit the displayed category name to prevent the Select column from getting too wide. if (core_text::strlen($masterlabel) > 20) { $masterlabel = get_string('textellipsis', 'core', core_text::substr($masterlabel, 0, 12)); } } // Build the master checkbox. $mastercheckbox = new \core\output\checkbox_toggleall($togglegroup, true, [ 'id' => 'select_category_' . $category->id, 'name' => $togglegroup, 'value' => 1, 'classes' => 'itemselect ignoredirty', 'label' => $masterlabel, // Consistent label to prevent the select column from resizing. 'selectall' => $masterlabel, 'deselectall' => $masterlabel, 'labelclasses' => 'm-0', ]); $categorycell = parent::get_category_cell($category, $levelclass, $params); $categorycell->text = $OUTPUT->render($mastercheckbox); return $categorycell; } /** * @deprecated Since Moodle 4.3. * @todo Final deprecation on Moodle 4.7 MDL-77668 */ public function get_item_cell($item, $params) { debugging('Method grade_edit_tree_column_select::get_item_cell() is deprecated, ' . 'please do not use it anymore.', DEBUG_DEVELOPER); if (empty($params['itemtype']) || empty($params['eid'])) { throw new \moodle_exception('missingitemtypeoreid', 'core_grades'); } $itemcell = parent::get_item_cell($item, $params); if ($params['itemtype'] != 'course' && $params['itemtype'] != 'category') { global $OUTPUT; // Fetch the grade item's category. $category = grade_category::fetch(['id' => $item->categoryid]); $togglegroup = $this->get_checkbox_togglegroup($category); $checkboxid = 'select_' . $params['eid']; $checkbox = new \core\output\checkbox_toggleall($togglegroup, false, [ 'id' => $checkboxid, 'name' => $checkboxid, 'label' => get_string('select', 'grades', $item->itemname), 'labelclasses' => 'accesshide', 'classes' => 'itemselect ignoredirty', ]); $itemcell->text = $OUTPUT->render($checkbox); } return $itemcell; } /** * Generates a toggle group name for a bulk-action checkbox based on the given grade category. * * @deprecated Since Moodle 4.3. * @todo Final deprecation on Moodle 4.7 MDL-77668 * * @param grade_category $category The grade category. * @return string */ protected function get_checkbox_togglegroup(grade_category $category): string { debugging('Method grade_edit_tree_column_select::get_checkbox_togglegroup() is deprecated, ' . 'please do not use it anymore.', DEBUG_DEVELOPER); $levels = []; $categories = explode('/', $category->path); foreach ($categories as $categoryid) { $level = 'category' . $categoryid; if (!in_array($level, $levels)) { $levels[] = 'category' . $categoryid; } } $togglegroup = implode(' ', $levels); return $togglegroup; } } edit/tree/grade_form.php 0000604 00000021163 15062070557 0011254 0 ustar 00 <?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/>. /** * A moodleform to allow the editing of a user's grade for a particular activity * * @package core_grades * @copyright 2007 Petr Skoda * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ if (!defined('MOODLE_INTERNAL')) { die('Direct access to this script is forbidden.'); /// It must be included from a Moodle page } require_once $CFG->libdir.'/formslib.php'; class edit_grade_form extends moodleform { function definition() { global $CFG, $COURSE, $DB; $mform =& $this->_form; $grade_item = $this->_customdata['grade_item']; $gpr = $this->_customdata['gpr']; if ($grade_item->is_course_item()) { $grade_category = null; } else if ($grade_item->is_category_item()) { $grade_category = $grade_item->get_item_category(); $grade_category = $grade_category->get_parent_category(); } else { $grade_category = $grade_item->get_parent_category(); } /// information fields $mform->addElement('static', 'user', get_string('user')); $mform->addElement('static', 'itemname', get_string('itemname', 'grades')); $mform->addElement('checkbox', 'overridden', get_string('overridden', 'grades')); $mform->addHelpButton('overridden', 'overridden', 'grades'); /// actual grade - numeric or scale if ($grade_item->gradetype == GRADE_TYPE_VALUE) { // numeric grade $mform->addElement('text', 'finalgrade', get_string('finalgrade', 'grades')); $mform->setType('finalgrade', PARAM_RAW); $mform->addHelpButton('finalgrade', 'finalgrade', 'grades'); $mform->disabledIf('finalgrade', 'overridden', 'notchecked'); } else if ($grade_item->gradetype == GRADE_TYPE_SCALE) { // scale grade $scaleopt = array(); if (empty($grade_item->outcomeid)) { $scaleopt[-1] = get_string('nograde'); } else { $scaleopt[-1] = get_string('nooutcome', 'grades'); } $i = 1; if ($scale = $DB->get_record('scale', array('id' => $grade_item->scaleid))) { foreach (explode(",", $scale->scale) as $option) { $scaleopt[$i] = $option; $i++; } } $mform->addElement('select', 'finalgrade', get_string('finalgrade', 'grades'), $scaleopt); $mform->addHelpButton('finalgrade', 'finalgrade', 'grades'); $mform->disabledIf('finalgrade', 'overridden', 'notchecked'); } $mform->addElement('advcheckbox', 'excluded', get_string('excluded', 'grades')); $mform->addHelpButton('excluded', 'excluded', 'grades'); /// hiding /// advcheckbox is not compatible with disabledIf !! $mform->addElement('checkbox', 'hidden', get_string('hidden', 'grades')); $mform->addHelpButton('hidden', 'hidden', 'grades'); $mform->addElement('date_time_selector', 'hiddenuntil', get_string('hiddenuntil', 'grades'), array('optional'=>true)); $mform->disabledIf('hidden', 'hiddenuntil[enabled]', 'checked'); /// locking $mform->addElement('advcheckbox', 'locked', get_string('locked', 'grades')); $mform->addHelpButton('locked', 'locked', 'grades'); $mform->addElement('date_time_selector', 'locktime', get_string('locktime', 'grades'), array('optional'=>true)); $mform->disabledIf('locktime', 'gradetype', 'eq', GRADE_TYPE_NONE); // Feedback format is automatically converted to html if user has enabled editor $feedbackoptions = array('maxfiles'=>0, 'maxbytes'=>0); //TODO: no files here for now, if ever gets implemented use component 'grade' and filearea 'feedback' $mform->addElement('editor', 'feedback', get_string('feedback', 'grades'), null, $feedbackoptions); $mform->addHelpButton('feedback', 'feedback', 'grades'); $mform->setType('text', PARAM_RAW); // to be cleaned before display, no XSS risk $mform->disabledIf('feedback', 'overridden'); // hidden params $mform->addElement('hidden', 'oldgrade'); $mform->setType('oldgrade', PARAM_RAW); $mform->addElement('hidden', 'oldfeedback'); $mform->setType('oldfeedback', PARAM_RAW); $mform->addElement('hidden', 'id', 0); $mform->setType('id', PARAM_INT); $mform->addElement('hidden', 'itemid', 0); $mform->setType('itemid', PARAM_INT); $mform->addElement('hidden', 'userid', 0); $mform->setType('userid', PARAM_INT); $mform->addElement('hidden', 'courseid', $COURSE->id); $mform->setType('courseid', PARAM_INT); /// add return tracking info $gpr->add_mform_elements($mform); //------------------------------------------------------------------------------- // buttons $this->add_action_buttons(); } function definition_after_data() { global $CFG, $COURSE, $DB; $context = context_course::instance($COURSE->id); $mform =& $this->_form; $grade_item = $this->_customdata['grade_item']; // fill in user name if user still exists $userid = $mform->getElementValue('userid'); if ($user = $DB->get_record('user', array('id' => $userid))) { $username = '<a href="'.$CFG->wwwroot.'/user/view.php?id='.$userid.'">'.fullname($user).'</a>'; $user_el =& $mform->getElement('user'); $user_el->setValue($username); } // add activity name + link if ($grade_item->itemtype == 'mod') { $cm = get_coursemodule_from_instance($grade_item->itemmodule, $grade_item->iteminstance, $grade_item->courseid); $itemname = '<a href="'.$CFG->wwwroot.'/mod/'.$grade_item->itemmodule.'/view.php?id='.$cm->id.'">'.$grade_item->get_name().'</a>'; } else { $itemname = $grade_item->get_name(); } $itemname_el =& $mform->getElement('itemname'); $itemname_el->setValue($itemname); // access control - disable not allowed elements if (!has_capability('moodle/grade:manage', $context)) { $mform->hardFreeze('excluded'); } if (!has_capability('moodle/grade:manage', $context) and !has_capability('moodle/grade:hide', $context)) { $mform->hardFreeze('hidden'); $mform->hardFreeze('hiddenuntil'); } $old_grade_grade = new grade_grade(array('itemid'=>$grade_item->id, 'userid'=>$userid)); $gradeitemoverridable = $grade_item->is_overridable_item(); if (!$gradeitemoverridable) { $mform->removeElement('overridden'); } if ($grade_item->is_hidden()) { $mform->hardFreeze('hidden'); } if ($old_grade_grade->is_locked()) { if ($grade_item->is_locked()) { $mform->hardFreeze('locked'); $mform->hardFreeze('locktime'); } if ($gradeitemoverridable) { $mform->hardFreeze('overridden'); } $mform->hardFreeze('finalgrade'); $mform->hardFreeze('feedback'); } else { if (empty($old_grade_grade->id)) { $old_grade_grade->locked = $grade_item->locked; $old_grade_grade->locktime = $grade_item->locktime; } if (($old_grade_grade->locked or $old_grade_grade->locktime) and (!has_capability('moodle/grade:manage', $context) and !has_capability('moodle/grade:unlock', $context))) { $mform->hardFreeze('locked'); $mform->hardFreeze('locktime'); } else if ((!$old_grade_grade->locked and !$old_grade_grade->locktime) and (!has_capability('moodle/grade:manage', $context) and !has_capability('moodle/grade:lock', $context))) { $mform->hardFreeze('locked'); $mform->hardFreeze('locktime'); } } } } edit/tree/item.php 0000604 00000017206 15062070557 0010110 0 ustar 00 <?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/>. /** * Edit the grade options for an individual grade item * * @package core_grades * @copyright 2007 Petr Skoda * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ use core_grades\form\add_item; require_once '../../../config.php'; require_once $CFG->dirroot.'/grade/lib.php'; require_once $CFG->dirroot.'/grade/report/lib.php'; require_once 'item_form.php'; $courseid = required_param('courseid', PARAM_INT); $id = optional_param('id', 0, PARAM_INT); $url = new moodle_url('/grade/edit/tree/item.php', array('courseid'=>$courseid)); if ($id !== 0) { $url->param('id', $id); } $PAGE->set_url($url); $PAGE->set_pagelayout('admin'); navigation_node::override_active_url(new moodle_url('/grade/edit/tree/index.php', array('id'=>$courseid))); if (!$course = $DB->get_record('course', array('id' => $courseid))) { throw new \moodle_exception('invalidcourseid'); } require_login($course); $context = context_course::instance($course->id); require_capability('moodle/grade:manage', $context); // default return url $gpr = new grade_plugin_return(); $returnurl = $gpr->get_return_url('index.php?id='.$course->id); $heading = get_string('itemsedit', 'grades'); if ($grade_item = grade_item::fetch(array('id'=>$id, 'courseid'=>$courseid))) { // redirect if outcomeid present if (!empty($grade_item->outcomeid) && !empty($CFG->enableoutcomes)) { $url = new moodle_url('/grade/edit/tree/outcomeitem.php', ['id' => $id, 'courseid' => $courseid]); redirect($gpr->add_url_params($url)); } if ($grade_item->is_course_item() or $grade_item->is_category_item()) { $grade_category = $grade_item->get_item_category(); $url = new moodle_url('/grade/edit/tree/category.php', ['id' => $grade_category->id, 'courseid' => $courseid]); redirect($gpr->add_url_params($url)); } $item = $grade_item->get_record_data(); $parent_category = $grade_item->get_parent_category(); $item->parentcategory = $parent_category->id; } else { $heading = get_string('newitem', 'grades'); $grade_item = new grade_item(array('courseid'=>$courseid, 'itemtype'=>'manual'), false); $item = $grade_item->get_record_data(); $parent_category = grade_category::fetch_course_category($courseid); $item->parentcategory = $parent_category->id; } $decimalpoints = $grade_item->get_decimals(); if ($item->hidden > 1) { $item->hiddenuntil = $item->hidden; $item->hidden = 0; } else { $item->hiddenuntil = 0; } $item->locked = !empty($item->locked); $item->grademax = format_float($item->grademax, $decimalpoints); $item->grademin = format_float($item->grademin, $decimalpoints); $item->gradepass = format_float($item->gradepass, $decimalpoints); $item->multfactor = format_float($item->multfactor, 4); $item->plusfactor = format_float($item->plusfactor, 4); if ($parent_category->aggregation == GRADE_AGGREGATE_SUM or $parent_category->aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN2) { $item->aggregationcoef = $item->aggregationcoef == 0 ? 0 : 1; } else { $item->aggregationcoef = format_float($item->aggregationcoef, 4); } if ($parent_category->aggregation == GRADE_AGGREGATE_SUM) { $item->aggregationcoef2 = format_float($item->aggregationcoef2 * 100.0); } $item->cancontrolvisibility = $grade_item->can_control_visibility(); $mform = new edit_item_form(null, array('current'=>$item, 'gpr'=>$gpr)); $simpleform = new add_item(null, ['itemid' => $grade_item->id, 'courseid' => $courseid, 'gpr' => $gpr]); // Data has been carried over from the dynamic form. if ($simpledata = $simpleform->get_submitted_data()) { $mform->set_data($simpledata); } if ($mform->is_cancelled()) { redirect($returnurl); } else if ($data = $mform->get_data()) { // This is a new item, and the category chosen is different than the default category. if (empty($grade_item->id) && isset($data->parentcategory) && $parent_category->id != $data->parentcategory) { $parent_category = grade_category::fetch(array('id' => $data->parentcategory)); } // If unset, give the aggregation values a default based on parent aggregation method. $defaults = grade_category::get_default_aggregation_coefficient_values($parent_category->aggregation); if (!isset($data->aggregationcoef) || $data->aggregationcoef == '') { $data->aggregationcoef = $defaults['aggregationcoef']; } if (!isset($data->weightoverride)) { $data->weightoverride = $defaults['weightoverride']; } if (!isset($data->gradepass) || $data->gradepass == '') { $data->gradepass = 0; } if (!isset($data->grademin) || $data->grademin == '') { $data->grademin = 0; } $hide = empty($data->hiddenuntil) ? 0 : $data->hiddenuntil; if (!$hide) { $hide = empty($data->hidden) ? 0 : $data->hidden; } unset($data->hidden); unset($data->hiddenuntil); $locked = empty($data->locked) ? 0: $data->locked; $locktime = empty($data->locktime) ? 0: $data->locktime; unset($data->locked); unset($data->locktime); $convert = array('grademax', 'grademin', 'gradepass', 'multfactor', 'plusfactor', 'aggregationcoef', 'aggregationcoef2'); foreach ($convert as $param) { if (property_exists($data, $param)) { $data->$param = unformat_float($data->$param); } } if (isset($data->aggregationcoef2) && $parent_category->aggregation == GRADE_AGGREGATE_SUM) { $data->aggregationcoef2 = $data->aggregationcoef2 / 100.0; } else { $data->aggregationcoef2 = $defaults['aggregationcoef2']; } $gradeitem = new grade_item(array('id' => $id, 'courseid' => $courseid)); $oldmin = $gradeitem->grademin; $oldmax = $gradeitem->grademax; grade_item::set_properties($gradeitem, $data); $gradeitem->outcomeid = null; // Handle null decimals value if (!property_exists($data, 'decimals') or $data->decimals < 0) { $gradeitem->decimals = null; } if (empty($gradeitem->id)) { $gradeitem->itemtype = 'manual'; // All new items to be manual only. $gradeitem->insert(); // set parent if needed if (isset($data->parentcategory)) { $gradeitem->set_parent($data->parentcategory, false); } } else { $gradeitem->update(); if (!empty($data->rescalegrades) && $data->rescalegrades == 'yes') { $newmin = $gradeitem->grademin; $newmax = $gradeitem->grademax; $gradeitem->rescale_grades_keep_percentage($oldmin, $oldmax, $newmin, $newmax, 'gradebook'); } } if ($item->cancontrolvisibility) { // Update hiding flag. $gradeitem->set_hidden($hide, true); } $gradeitem->set_locktime($locktime); // Locktime first - it might be removed when unlocking. $gradeitem->set_locked($locked, false, true); redirect($returnurl); } $PAGE->navbar->add($heading); print_grade_page_head($courseid, 'settings', null, $heading, false, false, false); $mform->display(); echo $OUTPUT->footer(); edit/tree/calculation.php 0000604 00000020455 15062070557 0011450 0 ustar 00 <?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/>. /** * Edit a calculated grade item * * @package core_grades * @copyright 2007 Petr Skoda * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once '../../../config.php'; require_once $CFG->dirroot.'/grade/lib.php'; require_once $CFG->libdir.'/mathslib.php'; require_once 'calculation_form.php'; $courseid = required_param('courseid', PARAM_INT); $id = required_param('id', PARAM_INT); $section = optional_param('section', 'calculation', PARAM_ALPHA); $idnumbers = optional_param_array('idnumbers', null, PARAM_RAW); $url = new moodle_url('/grade/edit/tree/calculation.php', array('id'=>$id, 'courseid'=>$courseid)); if ($section !== 'calculation') { $url->param('section', $section); } $PAGE->set_url($url); if (!$course = $DB->get_record('course', array('id' => $courseid))) { throw new \moodle_exception('invalidcourseid'); } require_login($course); $context = context_course::instance($course->id); require_capability('moodle/grade:manage', $context); $PAGE->set_pagelayout('admin'); navigation_node::override_active_url(new moodle_url('/grade/edit/tree/index.php', array('id'=>$course->id))); // default return url $gpr = new grade_plugin_return(); $returnurl = $gpr->get_return_url($CFG->wwwroot.'/grade/report/index.php?id='.$course->id); if (!$grade_item = grade_item::fetch(array('id'=>$id, 'courseid'=>$course->id))) { throw new \moodle_exception('invaliditemid'); } // activity items and items without grade can not have calculation if ($grade_item->is_external_item() or ($grade_item->gradetype != GRADE_TYPE_VALUE and $grade_item->gradetype != GRADE_TYPE_SCALE)) { redirect($returnurl, get_string('errornocalculationallowed', 'grades')); } $mform = new edit_calculation_form(null, array('gpr'=>$gpr, 'itemid' => $grade_item->id)); if ($mform->is_cancelled()) { redirect($returnurl); } $calculation = calc_formula::localize($grade_item->calculation); $calculation = grade_item::denormalize_formula($calculation, $grade_item->courseid); $mform->set_data(array('courseid'=>$grade_item->courseid, 'calculation'=>$calculation, 'id'=>$grade_item->id, 'itemname'=>$grade_item->itemname)); $errors = array(); if ($data = $mform->get_data()) { $calculation = calc_formula::unlocalize($data->calculation); $grade_item->set_calculation($calculation); redirect($returnurl); } elseif (!empty($section) AND $section='idnumbers' AND !empty($idnumbers)) { // Handle idnumbers separately (non-mform) //first validate and store the new idnumbers foreach ($idnumbers as $giid => $value) { if ($gi = grade_item::fetch(array('id' => $giid))) { if ($gi->itemtype == 'mod') { $cm = get_coursemodule_from_instance($gi->itemmodule, $gi->iteminstance, $gi->courseid); } else { $cm = null; } if (!grade_verify_idnumber($value, $COURSE->id, $gi, $cm)) { $errors[$giid] = get_string('idnumbertaken'); continue; } if (empty($gi->idnumber) and !$gi->add_idnumber($idnumbers[$gi->id])) { $errors[$giid] = get_string('error'); continue; } } else { $errors[$giid] = 'Could not fetch the grade_item with id=' . $giid; } } } $gtree = new grade_tree($course->id, false, false); $strgrades = get_string('grades'); $strgraderreport = get_string('graderreport', 'grades'); $strcalculationedit = get_string('editcalculation', 'grades'); $PAGE->navbar->add($strcalculationedit); print_grade_page_head($courseid, 'settings', null, $strcalculationedit, false, false, false); $mform->display(); // Now show the gradetree with the idnumbers add/edit form echo ' <form class="mform" id="mform2" method="post" action="' . $CFG->wwwroot . '/grade/edit/tree/calculation.php?courseid='.$courseid.'&id='.$id.'"> <div style="display: none;"> <input type="hidden" value="'.$id.'" name="id"/> <input type="hidden" value="'.$courseid.'" name="courseid"/> <input type="hidden" value="'.$gpr->type.'" name="gpr_type"/> <input type="hidden" value="'.$gpr->plugin.'" name="gpr_plugin"/> <input type="hidden" value="'.$gpr->courseid.'" name="gpr_courseid"/> <input type="hidden" value="'.sesskey().'" name="sesskey"/> <input type="hidden" value="idnumbers" name="section"/> </div> <fieldset id="idnumbers" class="clearfix"> <legend class="ftoggler">'.get_string('idnumbers', 'grades').'</legend> <div class="fcontainer clearfix"> <ul> ' . get_grade_tree($gtree, $gtree->top_element, $id, $errors) . ' </ul> </div> </fieldset> <div class="fitem" style="text-align: center;"> <input id="id_addidnumbers" type="submit" class="btn btn-secondary" value="' . get_string('addidnumbers', 'grades') . '" name="addidnumbers" /> </div> </form>'; echo $OUTPUT->footer(); die(); /** * Simplified version of the print_grade_tree() recursive function found in grade/edit/tree/index.php * Only prints a tree with a basic icon for each element, and an edit field for * items without an idnumber. * @param object $gtree * @param object $element * @param int $current_itemid The itemid of this page: should be excluded from the tree * @param array $errors An array of idnumbers => error * @return string */ function get_grade_tree(&$gtree, $element, $current_itemid=null, $errors=null) { global $CFG; $object = $element['object']; $eid = $element['eid']; $type = $element['type']; $grade_item = $object->get_grade_item(); $name = $object->get_name(); $return_string = ''; //TODO: improve outcome visualisation if ($type == 'item' and !empty($object->outcomeid)) { $name = $name.' ('.get_string('outcome', 'grades').')'; } $idnumber = $object->get_idnumber(); // Don't show idnumber or input field for current item if given to function. Highlight the item instead. if ($type != 'category') { if (is_null($current_itemid) OR $grade_item->id != $current_itemid) { if ($idnumber) { $name .= ": [[$idnumber]]"; } else { $closingdiv = ''; if (!empty($errors[$grade_item->id])) { $name .= '<div class="error"><span class="error">' . $errors[$grade_item->id].'</span><br />'."\n"; $closingdiv = "</div>\n"; } $name .= '<label class="accesshide" for="id_idnumber_' . $grade_item->id . '">' . get_string('gradeitems', 'grades') .'</label>'; $name .= '<input class="idnumber" id="id_idnumber_'.$grade_item->id.'" type="text" name="idnumbers['.$grade_item->id.']" />' . "\n"; $name .= $closingdiv; } } else { $name = "<strong>$name</strong>"; } } $icon = $gtree->get_element_icon($element, true); $last = ''; $catcourseitem = ($element['type'] == 'courseitem' or $element['type'] == 'categoryitem'); if ($type != 'category') { $return_string .= '<li class="'.$type.'">'.$icon.$name.'</li>' . "\n"; } else { $return_string .= '<li class="'.$type.'">'.$icon.$name . "\n"; $return_string .= '<ul class="catlevel'.$element['depth'].'">'."\n"; $last = null; foreach($element['children'] as $child_el) { $return_string .= get_grade_tree($gtree, $child_el, $current_itemid, $errors); } if ($last) { $return_string .= get_grade_tree($gtree, $last, $current_itemid, $errors); } $return_string .= '</ul></li>'."\n"; } return $return_string; } edit/tree/outcomeitem_form.php 0000604 00000026420 15062070557 0012525 0 ustar 00 <?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/>. /** * A moodleform to allow the creation and editing of outcome grade items * * @package core_grades * @copyright 2007 Petr Skoda * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ if (!defined('MOODLE_INTERNAL')) { die('Direct access to this script is forbidden.'); /// It must be included from a Moodle page } require_once $CFG->libdir.'/formslib.php'; class edit_outcomeitem_form extends moodleform { function definition() { global $COURSE, $CFG; $mform =& $this->_form; /// visible elements $mform->addElement('header', 'general', get_string('gradeoutcomeitem', 'grades')); $mform->addElement('text', 'itemname', get_string('itemname', 'grades')); $mform->addRule('itemname', get_string('required'), 'required', null, 'client'); $mform->setType('itemname', PARAM_TEXT); $mform->addElement('text', 'iteminfo', get_string('iteminfo', 'grades')); $mform->addHelpButton('iteminfo', 'iteminfo', 'grades'); $mform->setType('iteminfo', PARAM_TEXT); $mform->addElement('text', 'idnumber', get_string('idnumbermod')); $mform->addHelpButton('idnumber', 'idnumbermod'); $mform->setType('idnumber', PARAM_RAW); // allow setting of outcomes on module items too $options = array(); if ($outcomes = grade_outcome::fetch_all_available($COURSE->id)) { foreach ($outcomes as $outcome) { $options[$outcome->id] = $outcome->get_name(); } } $mform->addElement('selectwithlink', 'outcomeid', get_string('outcome', 'grades'), $options, null, array('link' => $CFG->wwwroot.'/grade/edit/outcome/course.php?id='.$COURSE->id, 'label' => get_string('outcomeassigntocourse', 'grades'))); $mform->addHelpButton('outcomeid', 'outcome', 'grades'); $mform->addRule('outcomeid', get_string('required'), 'required'); $options = array(0=>get_string('none')); if ($coursemods = get_course_mods($COURSE->id)) { foreach ($coursemods as $coursemod) { if ($mod = get_coursemodule_from_id($coursemod->modname, $coursemod->id)) { $options[$coursemod->id] = format_string($mod->name); } } } $mform->addElement('select', 'cmid', get_string('linkedactivity', 'grades'), $options); $mform->addHelpButton('cmid', 'linkedactivity', 'grades'); $mform->setDefault('cmid', 0); /// hiding /// advcheckbox is not compatible with disabledIf !! $mform->addElement('checkbox', 'hidden', get_string('hidden', 'grades')); $mform->addHelpButton('hidden', 'hidden', 'grades'); $mform->addElement('date_time_selector', 'hiddenuntil', get_string('hiddenuntil', 'grades'), array('optional'=>true)); $mform->disabledIf('hidden', 'hiddenuntil[enabled]', 'checked'); //locking $mform->addElement('advcheckbox', 'locked', get_string('locked', 'grades')); $mform->addHelpButton('locked', 'locked', 'grades'); $mform->addElement('date_time_selector', 'locktime', get_string('locktime', 'grades'), array('optional'=>true)); /// parent category related settings $mform->addElement('header', 'headerparent', get_string('parentcategory', 'grades')); $mform->addElement('advcheckbox', 'weightoverride', get_string('adjustedweight', 'grades')); $mform->addHelpButton('weightoverride', 'weightoverride', 'grades'); $mform->addElement('text', 'aggregationcoef2', get_string('weight', 'grades')); $mform->addHelpButton('aggregationcoef2', 'weight', 'grades'); $mform->setType('aggregationcoef2', PARAM_RAW); $mform->disabledIf('aggregationcoef2', 'weightoverride'); $options = array(); $default = ''; $coefstring = ''; $categories = grade_category::fetch_all(array('courseid'=>$COURSE->id)); foreach ($categories as $cat) { $cat->apply_forced_settings(); $options[$cat->id] = $cat->get_name(); if ($cat->is_course_category()) { $default = $cat->id; } if ($cat->is_aggregationcoef_used()) { if ($cat->aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN) { $coefstring = ($coefstring=='' or $coefstring=='aggregationcoefweight') ? 'aggregationcoefweight' : 'aggregationcoef'; } else if ($cat->aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN2) { $coefstring = ($coefstring=='' or $coefstring=='aggregationcoefextrasum') ? 'aggregationcoefextrasum' : 'aggregationcoef'; } else if ($cat->aggregation == GRADE_AGGREGATE_EXTRACREDIT_MEAN) { $coefstring = ($coefstring=='' or $coefstring=='aggregationcoefextraweight') ? 'aggregationcoefextraweight' : 'aggregationcoef'; } else if ($cat->aggregation == GRADE_AGGREGATE_SUM) { $coefstring = ($coefstring=='' or $coefstring=='aggregationcoefextrasum') ? 'aggregationcoefextrasum' : 'aggregationcoef'; } else { $coefstring = 'aggregationcoef'; } } else { $mform->disabledIf('aggregationcoef', 'parentcategory', 'eq', $cat->id); } } if (count($categories) > 1) { $mform->addElement('select', 'parentcategory', get_string('gradecategory', 'grades'), $options); $mform->disabledIf('parentcategory', 'cmid', 'noteq', 0); } if ($coefstring !== '') { if ($coefstring == 'aggregationcoefextrasum' || $coefstring == 'aggregationcoefextraweightsum') { // advcheckbox is not compatible with disabledIf! $coefstring = 'aggregationcoefextrasum'; $mform->addElement('checkbox', 'aggregationcoef', get_string($coefstring, 'grades')); } else { $mform->addElement('text', 'aggregationcoef', get_string($coefstring, 'grades')); } $mform->addHelpButton('aggregationcoef', $coefstring, 'grades'); } /// hidden params $mform->addElement('hidden', 'id', 0); $mform->setType('id', PARAM_INT); $mform->addElement('hidden', 'courseid', $COURSE->id); $mform->setType('courseid', PARAM_INT); /// add return tracking info $gpr = $this->_customdata['gpr']; $gpr->add_mform_elements($mform); //------------------------------------------------------------------------------- // buttons $this->add_action_buttons(); } /// tweak the form - depending on existing data function definition_after_data() { global $CFG, $COURSE; $mform =& $this->_form; if ($id = $mform->getElementValue('id')) { $grade_item = grade_item::fetch(array('id'=>$id)); //remove the aggregation coef element if not needed if ($grade_item->is_course_item()) { if ($mform->elementExists('parentcategory')) { $mform->removeElement('parentcategory'); } if ($mform->elementExists('aggregationcoef')) { $mform->removeElement('aggregationcoef'); } } else { // if we wanted to change parent of existing item - we would have to verify there are no circular references in parents!!! if ($mform->elementExists('parentcategory')) { $mform->hardFreeze('parentcategory'); } if ($grade_item->is_category_item()) { $category = $grade_item->get_item_category(); $parent_category = $category->get_parent_category(); } else { $parent_category = $grade_item->get_parent_category(); } $parent_category->apply_forced_settings(); if (!$parent_category->is_aggregationcoef_used() || !$parent_category->aggregateoutcomes) { if ($mform->elementExists('aggregationcoef')) { $mform->removeElement('aggregationcoef'); } } else { //fix label if needed $agg_el =& $mform->getElement('aggregationcoef'); $aggcoef = ''; if ($parent_category->aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN) { $aggcoef = 'aggregationcoefweight'; } else if ($parent_category->aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN2) { $aggcoef = 'aggregationcoefextrasum'; } else if ($parent_category->aggregation == GRADE_AGGREGATE_EXTRACREDIT_MEAN) { $aggcoef = 'aggregationcoefextraweight'; } else if ($parent_category->aggregation == GRADE_AGGREGATE_SUM) { $aggcoef = 'aggregationcoefextrasum'; } if ($aggcoef !== '') { $agg_el->setLabel(get_string($aggcoef, 'grades')); $mform->addHelpButton('aggregationcoef', $aggcoef, 'grades'); } } // Remove the natural weighting fields for other aggregations, // or when the category does not aggregate outcomes. if ($parent_category->aggregation != GRADE_AGGREGATE_SUM || !$parent_category->aggregateoutcomes) { if ($mform->elementExists('weightoverride')) { $mform->removeElement('weightoverride'); } if ($mform->elementExists('aggregationcoef2')) { $mform->removeElement('aggregationcoef2'); } } } } // no parent header for course category if (!$mform->elementExists('aggregationcoef') and !$mform->elementExists('parentcategory')) { $mform->removeElement('headerparent'); } } /// perform extra validation before submission function validation($data, $files) { global $COURSE; $errors = parent::validation($data, $files); if (array_key_exists('idnumber', $data)) { if ($data['id']) { $grade_item = new grade_item(array('id'=>$data['id'], 'courseid'=>$data['courseid'])); } else { $grade_item = null; } if (!grade_verify_idnumber($data['idnumber'], $COURSE->id, $grade_item, null)) { $errors['idnumber'] = get_string('idnumbertaken'); } } return $errors; } } edit/tree/grade.php 0000604 00000024262 15062070557 0010234 0 ustar 00 <?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/>. /** * Edit a user's grade for a particular activity * * @package core_grades * @copyright 2007 Petr Skoda * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once '../../../config.php'; require_once $CFG->dirroot.'/grade/lib.php'; require_once $CFG->dirroot.'/grade/report/lib.php'; require_once 'grade_form.php'; $courseid = required_param('courseid', PARAM_INT); $id = optional_param('id', 0, PARAM_INT); $itemid = optional_param('itemid', 0, PARAM_INT); $userid = optional_param('userid', 0, PARAM_INT); $url = new moodle_url('/grade/edit/tree/grade.php', array('courseid'=>$courseid)); if ($id !== 0) { $url->param('id', $id); } if ($itemid !== 0) { $url->param('itemid', $itemid); } if ($userid !== 0) { $url->param('userid', $userid); } $PAGE->set_url($url); if (!$course = $DB->get_record('course', array('id' => $courseid))) { throw new \moodle_exception('invalidcourseid'); } $PAGE->set_pagelayout('incourse'); require_login($course); $context = context_course::instance($course->id); if (!has_capability('moodle/grade:manage', $context)) { require_capability('moodle/grade:edit', $context); } // default return url $gpr = new grade_plugin_return(); $returnurl = $gpr->get_return_url($CFG->wwwroot.'/grade/report/index.php?id='.$course->id); // security checks! if (!empty($id)) { if (!$grade = $DB->get_record('grade_grades', array('id' => $id))) { throw new \moodle_exception('invalidgroupid'); } if (!empty($itemid) and $itemid != $grade->itemid) { throw new \moodle_exception('invaliditemid'); } $itemid = $grade->itemid; if (!empty($userid) and $userid != $grade->userid) { throw new \moodle_exception('invaliduser'); } $userid = $grade->userid; unset($grade); } else if (empty($userid) or empty($itemid)) { throw new \moodle_exception('missinguseranditemid'); } if (!$grade_item = grade_item::fetch(array('id'=>$itemid, 'courseid'=>$courseid))) { throw new \moodle_exception('cannotfindgradeitem'); } // now verify grading user has access to all groups or is member of the same group when separate groups used in course if (groups_get_course_groupmode($COURSE) == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) { if ($groups = groups_get_all_groups($COURSE->id, $userid)) { $ok = false; foreach ($groups as $group) { if (groups_is_member($group->id, $USER->id)) { $ok = true; } } if (!$ok) { throw new \moodle_exception('cannotgradeuser'); } } else { throw new \moodle_exception('cannotgradeuser'); } } $mform = new edit_grade_form(null, array('grade_item'=>$grade_item, 'gpr'=>$gpr)); if ($grade = $DB->get_record('grade_grades', array('itemid' => $grade_item->id, 'userid' => $userid))) { // always clean existing feedback - grading should not have XSS risk if (empty($grade->feedback)) { $grade->feedback = ''; } else { $options = new stdClass(); $options->smiley = false; $options->filter = false; $options->noclean = false; $options->para = false; $grade->feedback = format_text($grade->feedback, $grade->feedbackformat, $options); } $grade->feedbackformat = FORMAT_HTML; $grade->locked = $grade->locked > 0 ? 1:0; $grade->overridden = $grade->overridden > 0 ? 1:0; $grade->excluded = $grade->excluded > 0 ? 1:0; if ($grade->hidden > 1) { $grade->hiddenuntil = $grade->hidden; $grade->hidden = 1; } else { $grade->hiddenuntil = 0; } if ($grade_item->is_hidden()) { $grade->hidden = 1; } if ($grade_item->is_locked()) { $grade->locked = 1; } // normalize the final grade value if ($grade_item->gradetype == GRADE_TYPE_SCALE) { if (empty($grade->finalgrade)) { $grade->finalgrade = -1; } else { $grade->finalgrade = (int)$grade->finalgrade; } } else if ($grade_item->gradetype == GRADE_TYPE_VALUE) { $grade->finalgrade = format_float($grade->finalgrade, $grade_item->get_decimals()); } $grade->oldgrade = $grade->finalgrade; $grade->oldfeedback = $grade->feedback; $grade->feedback = array('text'=>$grade->feedback, 'format'=>$grade->feedbackformat); $mform->set_data($grade); } else { $grade = new stdClass(); $grade->feedback = array('text'=>'', 'format'=>FORMAT_HTML); $mform->set_data(array('itemid'=>$itemid, 'userid'=>$userid, 'locked'=>$grade_item->locked, 'locktime'=>$grade_item->locktime)); } if ($mform->is_cancelled()) { redirect($returnurl); // form processing } else if ($data = $mform->get_data(false)) { if (isset($data->feedback) && is_array($data->feedback)) { $data->feedbackformat = $data->feedback['format']; $data->feedback = $data->feedback['text']; } $old_grade_grade = new grade_grade(array('userid'=>$data->userid, 'itemid'=>$grade_item->id), true); //might not exist yet // fix no grade for scales if (!isset($data->finalgrade) or $data->finalgrade == $data->oldgrade) { $data->finalgrade = $old_grade_grade->finalgrade; } else if ($grade_item->gradetype == GRADE_TYPE_SCALE) { if ($data->finalgrade < 1) { $data->finalgrade = NULL; } } else if ($grade_item->gradetype == GRADE_TYPE_VALUE) { $data->finalgrade = unformat_float($data->finalgrade); } else { //this should not happen $data->finalgrade = $old_grade_grade->finalgrade; } // the overriding of feedback is tricky - we have to care about external items only if (!property_exists($data, 'feedback') or $data->feedback == $data->oldfeedback) { $data->feedback = $old_grade_grade->feedback; $data->feedbackformat = $old_grade_grade->feedbackformat; } // update final grade or feedback // when we set override grade the first time, it happens here $grade_item->update_final_grade($data->userid, $data->finalgrade, 'editgrade', $data->feedback, $data->feedbackformat); $grade_grade = new grade_grade(array('userid'=>$data->userid, 'itemid'=>$grade_item->id), true); $grade_grade->grade_item =& $grade_item; // no db fetching if (has_capability('moodle/grade:manage', $context) or has_capability('moodle/grade:edit', $context)) { // change overridden flag if (!isset($data->overridden)) { $data->overridden = 0; // checkbox unticked } $grade_grade->set_overridden($data->overridden); } if (has_capability('moodle/grade:manage', $context) or has_capability('moodle/grade:hide', $context)) { $hidden = empty($data->hidden) ? 0: $data->hidden; $hiddenuntil = empty($data->hiddenuntil) ? 0: $data->hiddenuntil; if ($grade_item->is_hidden()) { if ($old_grade_grade->hidden == 1 and $hiddenuntil == 0) { //nothing to do - grade was originally hidden, we want to keep it that way } else { $grade_grade->set_hidden($hiddenuntil); } } else { if ($hiddenuntil) { $grade_grade->set_hidden($hiddenuntil); } else { $grade_grade->set_hidden($hidden); // checkbox data might be undefined } } } if (isset($data->locked) and !$grade_item->is_locked()) { if (($old_grade_grade->locked or $old_grade_grade->locktime) and (!has_capability('moodle/grade:manage', $context) and !has_capability('moodle/grade:unlock', $context))) { //ignore data } else if ((!$old_grade_grade->locked and !$old_grade_grade->locktime) and (!has_capability('moodle/grade:manage', $context) and !has_capability('moodle/grade:lock', $context))) { //ignore data } else { $grade_grade->set_locktime($data->locktime); //set_lock may reset locktime $grade_grade->set_locked($data->locked, false, true); // reload grade in case it was regraded from activity $grade_grade = new grade_grade(array('userid'=>$data->userid, 'itemid'=>$grade_item->id), true); $grade_grade->grade_item =& $grade_item; // no db fetching } } if (isset($data->excluded) and has_capability('moodle/grade:manage', $context)) { $grade_grade->set_excluded($data->excluded); } // detect cases when we need to do full regrading if ($old_grade_grade->excluded != $grade_grade->excluded) { $parent = $grade_item->get_parent_category(); $parent->force_regrading(); } else if ($old_grade_grade->overridden != $grade_grade->overridden and empty($grade_grade->overridden)) { // only when unoverridding $grade_item->force_regrading(); } else if ($old_grade_grade->locktime != $grade_grade->locktime) { $grade_item->force_regrading(); } redirect($returnurl); } $strgrades = get_string('grades'); $strgraderreport = get_string('graderreport', 'grades'); $strgradeedit = get_string('editgrade', 'grades'); $struser = get_string('user'); grade_build_nav(__FILE__, $strgradeedit, array('courseid' => $courseid)); /*********** BEGIN OUTPUT *************/ $PAGE->set_title($strgrades . ': ' . $strgraderreport . ': ' . $strgradeedit); $PAGE->set_heading($course->fullname); echo $OUTPUT->header(); echo $OUTPUT->heading($strgradeedit); echo $OUTPUT->box_start(); // Form if in edit or add modes $mform->display(); echo $OUTPUT->box_end(); echo $OUTPUT->footer(); die; edit/tree/calculation_form.php 0000604 00000007204 15062070557 0012470 0 ustar 00 <?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/>. /** * A moodleform to allow the editing of a calculated grade item * * @package core_grades * @copyright 2007 Petr Skoda * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ if (!defined('MOODLE_INTERNAL')) { die('Direct access to this script is forbidden.'); /// It must be included from a Moodle page } require_once $CFG->libdir.'/formslib.php'; class edit_calculation_form extends moodleform { public $available; public $noidnumbers; function definition() { global $COURSE; $mform =& $this->_form; $itemid = $this->_customdata['itemid']; $this->available = grade_item::fetch_all(array('courseid'=>$COURSE->id)); $this->noidnumbers = array(); // All items that have no idnumbers are added to a separate section of the form (hidden by default), // enabling the user to assign idnumbers to these grade_items. foreach ($this->available as $item) { if (empty($item->idnumber)) { $this->noidnumbers[$item->id] = $item; unset($this->available[$item->id]); } if ($item->id == $itemid) { // Do not include the current grade_item in the available section unset($this->available[$item->id]); } } /// visible elements $mform->addElement('header', 'general', get_string('gradeitem', 'grades')); $mform->addElement('static', 'itemname', get_string('itemname', 'grades')); $mform->addElement('textarea', 'calculation', get_string('calculation', 'grades'), 'cols="60" rows="5"'); $mform->addHelpButton('calculation', 'calculation', 'grades'); $mform->setForceLtr('calculation'); /// hidden params $mform->addElement('hidden', 'id', 0); $mform->setType('id', PARAM_INT); $mform->addElement('hidden', 'courseid', 0); $mform->setType('courseid', PARAM_INT); $mform->addElement('hidden', 'section', 0); $mform->setType('section', PARAM_ALPHA); $mform->setDefault('section', 'calculation'); /// add return tracking info $gpr = $this->_customdata['gpr']; $gpr->add_mform_elements($mform); $this->add_action_buttons(); } function definition_after_data() { global $CFG, $COURSE; $mform =& $this->_form; } /// perform extra validation before submission function validation($data, $files) { $errors = parent::validation($data, $files); $mform =& $this->_form; // check the calculation formula if ($data['calculation'] != '') { $grade_item = grade_item::fetch(array('id'=>$data['id'], 'courseid'=>$data['courseid'])); $calculation = calc_formula::unlocalize(stripslashes($data['calculation'])); $result = $grade_item->validate_formula($calculation); if ($result !== true) { $errors['calculation'] = $result; } } return $errors; } } edit/tree/index.php 0000604 00000024107 15062070557 0010257 0 ustar 00 <?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/>. /** * The Gradebook setup page. * * @package core_grades * @copyright 2008 Nicolas Connault * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ define('NO_OUTPUT_BUFFERING', true); // The progress bar may be used here. require_once '../../../config.php'; require_once $CFG->dirroot.'/grade/lib.php'; require_once $CFG->dirroot.'/grade/report/lib.php'; // for preferences require_once $CFG->dirroot.'/grade/edit/tree/lib.php'; $courseid = required_param('id', PARAM_INT); $action = optional_param('action', 0, PARAM_ALPHA); $eid = optional_param('eid', 0, PARAM_ALPHANUM); $weightsadjusted = optional_param('weightsadjusted', 0, PARAM_INT); $url = new moodle_url('/grade/edit/tree/index.php', array('id' => $courseid)); $PAGE->set_url($url); $PAGE->set_pagelayout('admin'); /// Make sure they can even access this course if (!$course = $DB->get_record('course', array('id' => $courseid))) { throw new \moodle_exception('invalidcourseid'); } require_login($course); $context = context_course::instance($course->id); require_capability('moodle/grade:manage', $context); $PAGE->requires->js_call_amd('core_grades/edittree_index', 'init', [$courseid, $USER->id]); $PAGE->requires->js_call_amd('core_grades/gradebooksetup_forms', 'init'); $decsep = get_string('decsep', 'langconfig'); // This setting indicates if we should use algorithm prior to MDL-49257 fix for calculating extra credit weights. $gradebookcalculationfreeze = (int) get_config('core', 'gradebook_calculations_freeze_' . $courseid); $oldextracreditcalculation = $gradebookcalculationfreeze && ($gradebookcalculationfreeze <= 20150619); $PAGE->requires->js_call_amd('core_grades/edittree_weights', 'init', [$decsep, $oldextracreditcalculation]); /// return tracking object $gpr = new grade_plugin_return(array('type'=>'edit', 'plugin'=>'tree', 'courseid'=>$courseid)); $returnurl = $gpr->get_return_url(null); // get the grading tree object // note: total must be first for moving to work correctly, if you want it last moving code must be rewritten! $gtree = new grade_tree($courseid, false, false); if (empty($eid)) { $element = null; $object = null; } else { if (!$element = $gtree->locate_element($eid)) { throw new \moodle_exception('invalidelementid', '', $returnurl); } $object = $element['object']; } $switch = grade_get_setting($course->id, 'aggregationposition', $CFG->grade_aggregationposition); $strgrades = get_string('grades'); $strgraderreport = get_string('graderreport', 'grades'); $moving = false; $movingeid = false; if ($action == 'moveselect') { if ($eid and confirm_sesskey()) { $movingeid = $eid; $moving=true; } } $gradeedittree = new grade_edit_tree($gtree, $movingeid, $gpr); switch ($action) { case 'duplicate': if ($eid and confirm_sesskey()) { if (!$el = $gtree->locate_element($eid)) { throw new \moodle_exception('invalidelementid', '', $returnurl); } $object->duplicate(); redirect($returnurl); } break; case 'delete': if ($eid && confirm_sesskey()) { if (!$gradeedittree->element_deletable($element)) { // no deleting of external activities - they would be recreated anyway! // exception is activity without grading or misconfigured activities break; } $confirm = optional_param('confirm', 0, PARAM_BOOL); if ($confirm) { $object->delete('grade/report/grader/category'); redirect($returnurl); } } break; case 'autosort': //TODO: implement autosorting based on order of mods on course page, categories first, manual items last break; case 'move': if ($eid and confirm_sesskey()) { $moveafter = required_param('moveafter', PARAM_ALPHANUM); $first = optional_param('first', false, PARAM_BOOL); // If First is set to 1, it means the target is the first child of the category $moveafter if(!$after_el = $gtree->locate_element($moveafter)) { throw new \moodle_exception('invalidelementid', '', $returnurl); } $after = $after_el['object']; $sortorder = $after->get_sortorder(); if (!$first) { $parent = $after->get_parent_category(); $object->set_parent($parent->id); } else { $object->set_parent($after->id); } $object->move_after_sortorder($sortorder); redirect($returnurl); } break; default: break; } // If we go straight to the db to update an element we need to recreate the tree as // $gradeedittree has already been constructed. // Ideally we could do the updates through $gradeedittree to avoid recreating it. $recreatetree = false; if ($data = data_submitted() and confirm_sesskey()) { // Perform bulk actions first if (!empty($data->bulkmove)) { $elements = array(); foreach ($data as $key => $value) { if (preg_match('/select_(ig[0-9]*)/', $key, $matches)) { $elements[] = $matches[1]; } } $gradeedittree->move_elements($elements, $returnurl); } // Update weights (extra credits) on categories and items. foreach ($data as $key => $value) { if (preg_match('/^weight_([0-9]+)$/', $key, $matches)) { $aid = $matches[1]; $value = unformat_float($value); $value = clean_param($value, PARAM_FLOAT); $grade_item = grade_item::fetch(array('id' => $aid, 'courseid' => $courseid)); // Convert weight to aggregation coef2. $aggcoef = $grade_item->get_coefstring(); if ($aggcoef == 'aggregationcoefextraweightsum') { // The field 'weight' should only be sent when the checkbox 'weighoverride' is checked, // so there is not need to set weightoverride here, it is done below. $value = $value / 100.0; $grade_item->aggregationcoef2 = $value; } else if ($aggcoef == 'aggregationcoefweight' || $aggcoef == 'aggregationcoefextraweight') { $grade_item->aggregationcoef = $value; } $grade_item->update(); $recreatetree = true; // Grade item checkbox inputs. } elseif (preg_match('/^(weightoverride)_([0-9]+)$/', $key, $matches)) { $param = $matches[1]; $aid = $matches[2]; $value = clean_param($value, PARAM_BOOL); $grade_item = grade_item::fetch(array('id' => $aid, 'courseid' => $courseid)); $grade_item->$param = $value; $grade_item->update(); $recreatetree = true; } } } $originalweights = grade_helper::fetch_all_natural_weights_for_course($courseid); /** * Callback function to adjust the URL if weights changed after the * regrade. * * @param int $courseid The course ID * @param array $originalweights The weights before the regrade * @param int $weightsadjusted Whether weights have been adjusted * @return moodle_url A URL to redirect to after regrading when a progress bar is displayed. */ $grade_edit_tree_index_checkweights = function() use ($courseid, $originalweights, &$weightsadjusted) { global $PAGE; $alteredweights = grade_helper::fetch_all_natural_weights_for_course($courseid); if (array_diff($originalweights, $alteredweights)) { $weightsadjusted = 1; return new moodle_url($PAGE->url, array('weightsadjusted' => $weightsadjusted)); } return $PAGE->url; }; if (grade_regrade_final_grades_if_required($course, $grade_edit_tree_index_checkweights)) { $recreatetree = true; } $actionbar = new \core_grades\output\gradebook_setup_action_bar($context); print_grade_page_head($courseid, 'settings', 'setup', false, false, false, true, null, null, null, $actionbar); // Print Table of categories and items echo $OUTPUT->box_start('gradetreebox generalbox'); // Did we update something in the db and thus invalidate $gradeedittree? if ($recreatetree) { $gradeedittree = new grade_edit_tree($gtree, $movingeid, $gpr); } $tpldata = (object) [ 'actionurl' => $returnurl, 'sesskey' => sesskey(), 'movingmodeenabled' => $moving, 'courseid' => $courseid ]; // Check to see if we have a normalisation message to send. if ($weightsadjusted) { $notification = new \core\output\notification(get_string('weightsadjusted', 'grades'), \core\output\notification::NOTIFY_INFO); $tpldata->notification = $notification->export_for_template($OUTPUT); } $tpldata->table = html_writer::table($gradeedittree->table); // If not in moving mode and there is more than one grade category, then initialise the bulk action module. if (!$moving && count($gradeedittree->categories) > 1) { $PAGE->requires->js_call_amd('core_grades/bulkactions/edit/tree/bulk_actions', 'init', [$courseid]); } $footercontent = $OUTPUT->render_from_template('core_grades/edit_tree_sticky_footer', $tpldata); $stickyfooter = new core\output\sticky_footer($footercontent); $tpldata->stickyfooter = $OUTPUT->render($stickyfooter); echo $OUTPUT->render_from_template('core_grades/edit_tree', $tpldata); echo $OUTPUT->box_end(); $PAGE->requires->js_call_amd('core_form/changechecker', 'watchFormById', ['gradetreeform']); echo $OUTPUT->footer(); die; edit/tree/outcomeitem.php 0000604 00000021765 15062070557 0011511 0 ustar 00 <?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/>. /** * A page to create or edit outcome grade items * * @package core_grades * @copyright 2007 Petr Skoda * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ use core_grades\form\add_outcome; require_once '../../../config.php'; require_once $CFG->dirroot.'/grade/lib.php'; require_once $CFG->dirroot.'/grade/report/lib.php'; require_once 'outcomeitem_form.php'; $courseid = required_param('courseid', PARAM_INT); $id = optional_param('id', 0, PARAM_INT); $url = new moodle_url('/grade/edit/tree/outcomeitem.php', array('courseid'=>$courseid)); if ($id !== 0) { $url->param('id', $id); } $PAGE->set_url($url); $PAGE->set_pagelayout('admin'); navigation_node::override_active_url(new moodle_url('/grade/edit/tree/index.php', array('id'=>$courseid))); if (!$course = $DB->get_record('course', array('id' => $courseid))) { throw new \moodle_exception('invalidcourseid'); } require_login($course); $context = context_course::instance($course->id); require_capability('moodle/grade:manage', $context); // default return url $gpr = new grade_plugin_return(); $returnurl = $gpr->get_return_url('index.php?id='.$course->id); $mform = new edit_outcomeitem_form(null, array('gpr'=>$gpr)); if ($mform->is_cancelled() || empty($CFG->enableoutcomes)) { redirect($returnurl); } $heading = get_string('outcomeitemsedit', 'grades'); if ($grade_item = grade_item::fetch(array('id'=>$id, 'courseid'=>$courseid))) { // redirect if outcomeid present if (empty($grade_item->outcomeid)) { $url = new moodle_url('/grade/edit/tree/item.php', ['id' => $id, 'courseid' => $courseid]); redirect($gpr->add_url_params($url)); } $item = $grade_item->get_record_data(); $parent_category = $grade_item->get_parent_category(); $item->parentcategory = $parent_category->id; if ($item->itemtype == 'mod') { $cm = get_coursemodule_from_instance($item->itemmodule, $item->iteminstance, $item->courseid); $item->cmid = $cm->id; } else { $item->cmid = 0; } } else { $heading = get_string('newoutcomeitem', 'grades'); $grade_item = new grade_item(array('courseid'=>$courseid, 'itemtype'=>'manual'), false); $item = $grade_item->get_record_data(); $item->cmid = 0; $parent_category = grade_category::fetch_course_category($courseid); $item->parentcategory = $parent_category->id; } $decimalpoints = $grade_item->get_decimals(); if ($item->hidden > 1) { $item->hiddenuntil = $item->hidden; $item->hidden = 0; } else { $item->hiddenuntil = 0; } $item->locked = !empty($item->locked); $item->gradepass = format_float($item->gradepass, $decimalpoints); if (empty($parent_category)) { $item->aggregationcoef = 0; } else if ($parent_category->aggregation == GRADE_AGGREGATE_SUM) { $item->aggregationcoef = $item->aggregationcoef > 0 ? 1 : 0; $item->aggregationcoef2 = format_float($item->aggregationcoef2 * 100.0); } else { $item->aggregationcoef = format_float($item->aggregationcoef, 4); } $mform->set_data($item); $simpleform = new add_outcome(null, ['itemid' => $grade_item->id, 'courseid' => $courseid, 'gpr' => $gpr]); // Data has been carried over from the dynamic form. if ($simpledata = $simpleform->get_submitted_data()) { $mform->set_data($simpledata); } if ($data = $mform->get_data()) { // This is a new item, and the category chosen is different than the default category. if (empty($grade_item->id) && isset($data->parentcategory) && $parent_category->id != $data->parentcategory) { $parent_category = grade_category::fetch(array('id' => $data->parentcategory)); } // If unset, give the aggregation values a default based on parent aggregation method. $defaults = grade_category::get_default_aggregation_coefficient_values($parent_category->aggregation); if (!isset($data->aggregationcoef) || $data->aggregationcoef == '') { $data->aggregationcoef = $defaults['aggregationcoef']; } if (!isset($data->weightoverride)) { $data->weightoverride = $defaults['weightoverride']; } if (property_exists($data, 'calculation')) { $data->calculation = grade_item::normalize_formula($data->calculation, $course->id); } $hidden = empty($data->hidden) ? 0: $data->hidden; $hiddenuntil = empty($data->hiddenuntil) ? 0: $data->hiddenuntil; unset($data->hidden); unset($data->hiddenuntil); $locked = empty($data->locked) ? 0: $data->locked; $locktime = empty($data->locktime) ? 0: $data->locktime; unset($data->locked); unset($data->locktime); $convert = array('gradepass', 'aggregationcoef', 'aggregationcoef2'); foreach ($convert as $param) { if (property_exists($data, $param)) { $data->$param = unformat_float($data->$param); } } if (isset($data->aggregationcoef2) && $parent_category->aggregation == GRADE_AGGREGATE_SUM) { $data->aggregationcoef2 = $data->aggregationcoef2 / 100.0; } else { $data->aggregationcoef2 = $defaults['aggregationcoef2']; } $grade_item = new grade_item(array('id'=>$id, 'courseid'=>$courseid)); grade_item::set_properties($grade_item, $data); // fix activity links if (empty($data->cmid)) { // manual item $grade_item->itemtype = 'manual'; $grade_item->itemmodule = null; $grade_item->iteminstance = null; $grade_item->itemnumber = 0; } else { $params = array($data->cmid); $module = $DB->get_record_sql("SELECT cm.*, m.name as modname FROM {modules} m, {course_modules} cm WHERE cm.id = ? AND cm.module = m.id ", $params); $grade_item->itemtype = 'mod'; $grade_item->itemmodule = $module->modname; $grade_item->iteminstance = $module->instance; if ($items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$grade_item->itemmodule, 'iteminstance'=>$grade_item->iteminstance, 'courseid'=>$COURSE->id))) { if (!empty($grade_item->id) and in_array($grade_item, $items)) { //no change needed } else { $max = 999; foreach($items as $item) { if (empty($item->outcomeid)) { continue; } if ($item->itemnumber > $max) { $max = $item->itemnumber; } } $grade_item->itemnumber = $max + 1; } } else { $grade_item->itemnumber = 1000; } } // fix scale used $outcome = grade_outcome::fetch(array('id'=>$data->outcomeid)); $grade_item->gradetype = GRADE_TYPE_SCALE; $grade_item->scaleid = $outcome->scaleid; //TODO: we might recalculate existing outcome grades when changing scale if (empty($grade_item->id)) { $grade_item->insert(); // move next to activity if adding linked outcome if ($grade_item->itemtype == 'mod') { if ($item = grade_item::fetch(array('itemtype'=>'mod', 'itemmodule'=>$grade_item->itemmodule, 'iteminstance'=>$grade_item->iteminstance, 'itemnumber'=>0, 'courseid'=>$COURSE->id))) { $grade_item->set_parent($item->categoryid); $grade_item->move_after_sortorder($item->sortorder); } } else { // set parent if needed if (isset($data->parentcategory)) { $grade_item->set_parent($data->parentcategory, false); } } } else { $grade_item->update(); } // update hiding flag if ($hiddenuntil) { $grade_item->set_hidden($hiddenuntil, false); } else { $grade_item->set_hidden($hidden, false); } $grade_item->set_locktime($locktime); // locktime first - it might be removed when unlocking $grade_item->set_locked($locked, false, true); redirect($returnurl); } $PAGE->navbar->add($heading); print_grade_page_head($courseid, 'settings', null, $heading, false, false, false); if (!grade_outcome::fetch_all_available($COURSE->id)) { echo $OUTPUT->confirm(get_string('nooutcomes', 'grades'), $CFG->wwwroot.'/grade/edit/outcome/course.php?id='.$courseid, $returnurl); echo $OUTPUT->footer(); die(); } $mform->display(); echo $OUTPUT->footer(); edit/tree/item_form.php 0000604 00000055314 15062070557 0011135 0 ustar 00 <?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/>. /** * A moodleform allowing the editing of the grade options for an individual grade item * * @package core_grades * @copyright 2007 Petr Skoda * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ if (!defined('MOODLE_INTERNAL')) { die('Direct access to this script is forbidden.'); /// It must be included from a Moodle page } require_once $CFG->libdir.'/formslib.php'; class edit_item_form extends moodleform { private $displayoptions; function definition() { global $COURSE, $CFG, $DB; $mform =& $this->_form; $item = $this->_customdata['current']; /// visible elements $mform->addElement('header', 'general', get_string('gradeitem', 'grades')); $mform->addElement('text', 'itemname', get_string('itemname', 'grades')); $mform->setType('itemname', PARAM_TEXT); $mform->addElement('text', 'iteminfo', get_string('iteminfo', 'grades')); $mform->addHelpButton('iteminfo', 'iteminfo', 'grades'); $mform->setType('iteminfo', PARAM_TEXT); $mform->addElement('text', 'idnumber', get_string('idnumbermod')); $mform->addHelpButton('idnumber', 'idnumbermod'); $mform->setType('idnumber', PARAM_RAW); if (!empty($item->id)) { $gradeitem = new grade_item(array('id' => $item->id, 'courseid' => $item->courseid)); // If grades exist set a message so the user knows why they can not alter the grade type or scale. // We could never change the grade type for external items, so only need to show this for manual grade items. if ($gradeitem->has_grades() && !$gradeitem->is_external_item()) { // Set a message so the user knows why they can not alter the grade type or scale. if ($gradeitem->gradetype == GRADE_TYPE_SCALE) { $gradesexistmsg = get_string('modgradecantchangegradetyporscalemsg', 'grades'); } else { $gradesexistmsg = get_string('modgradecantchangegradetypemsg', 'grades'); } $gradesexisthtml = '<div class=\'alert\'>' . $gradesexistmsg . '</div>'; $mform->addElement('static', 'gradesexistmsg', '', $gradesexisthtml); } } // Manual grade items cannot have grade type GRADE_TYPE_NONE. $options = array(GRADE_TYPE_VALUE => get_string('typevalue', 'grades'), GRADE_TYPE_SCALE => get_string('typescale', 'grades'), GRADE_TYPE_TEXT => get_string('typetext', 'grades')); $mform->addElement('select', 'gradetype', get_string('gradetype', 'grades'), $options); $mform->addHelpButton('gradetype', 'gradetype', 'grades'); $mform->setDefault('gradetype', GRADE_TYPE_VALUE); //$mform->addElement('text', 'calculation', get_string('calculation', 'grades')); //$mform->disabledIf('calculation', 'gradetype', 'eq', GRADE_TYPE_TEXT); //$mform->disabledIf('calculation', 'gradetype', 'eq', GRADE_TYPE_NONE); $options = array(0=>get_string('usenoscale', 'grades')); if ($scales = grade_scale::fetch_all_local($COURSE->id)) { foreach ($scales as $scale) { $options[$scale->id] = $scale->get_name(); } } if ($scales = grade_scale::fetch_all_global()) { foreach ($scales as $scale) { $options[$scale->id] = $scale->get_name(); } } // ugly BC hack - it was possible to use custom scale from other courses :-( if (!empty($item->scaleid) and !isset($options[$item->scaleid])) { if ($scale = grade_scale::fetch(array('id'=>$item->scaleid))) { $options[$scale->id] = $scale->get_name().get_string('incorrectcustomscale', 'grades'); } } $mform->addElement('select', 'scaleid', get_string('scale'), $options); $mform->addHelpButton('scaleid', 'typescale', 'grades'); $mform->disabledIf('scaleid', 'gradetype', 'noteq', GRADE_TYPE_SCALE); $choices = array(); $choices[''] = get_string('choose'); $choices['no'] = get_string('no'); $choices['yes'] = get_string('yes'); $mform->addElement('select', 'rescalegrades', get_string('modgraderescalegrades', 'grades'), $choices); $mform->addHelpButton('rescalegrades', 'modgraderescalegrades', 'grades'); $mform->disabledIf('rescalegrades', 'gradetype', 'noteq', GRADE_TYPE_VALUE); $mform->addElement('float', 'grademax', get_string('grademax', 'grades')); $mform->addHelpButton('grademax', 'grademax', 'grades'); $mform->disabledIf('grademax', 'gradetype', 'noteq', GRADE_TYPE_VALUE); if ((bool) get_config('moodle', 'grade_report_showmin')) { $mform->addElement('float', 'grademin', get_string('grademin', 'grades')); $mform->addHelpButton('grademin', 'grademin', 'grades'); $mform->disabledIf('grademin', 'gradetype', 'noteq', GRADE_TYPE_VALUE); } $mform->addElement('float', 'gradepass', get_string('gradepass', 'grades')); $mform->addHelpButton('gradepass', 'gradepass', 'grades'); $mform->disabledIf('gradepass', 'gradetype', 'eq', GRADE_TYPE_NONE); $mform->disabledIf('gradepass', 'gradetype', 'eq', GRADE_TYPE_TEXT); $mform->addElement('float', 'multfactor', get_string('multfactor', 'grades')); $mform->addHelpButton('multfactor', 'multfactor', 'grades'); $mform->disabledIf('multfactor', 'gradetype', 'eq', GRADE_TYPE_NONE); $mform->disabledIf('multfactor', 'gradetype', 'eq', GRADE_TYPE_TEXT); $mform->addElement('float', 'plusfactor', get_string('plusfactor', 'grades')); $mform->addHelpButton('plusfactor', 'plusfactor', 'grades'); $mform->disabledIf('plusfactor', 'gradetype', 'eq', GRADE_TYPE_NONE); $mform->disabledIf('plusfactor', 'gradetype', 'eq', GRADE_TYPE_TEXT); /// grade display prefs $default_gradedisplaytype = grade_get_setting($COURSE->id, 'displaytype', $CFG->grade_displaytype); $options = array(GRADE_DISPLAY_TYPE_DEFAULT => get_string('default', 'grades'), GRADE_DISPLAY_TYPE_REAL => get_string('real', 'grades'), GRADE_DISPLAY_TYPE_PERCENTAGE => get_string('percentage', 'grades'), GRADE_DISPLAY_TYPE_LETTER => get_string('letter', 'grades'), GRADE_DISPLAY_TYPE_REAL_PERCENTAGE => get_string('realpercentage', 'grades'), GRADE_DISPLAY_TYPE_REAL_LETTER => get_string('realletter', 'grades'), GRADE_DISPLAY_TYPE_LETTER_REAL => get_string('letterreal', 'grades'), GRADE_DISPLAY_TYPE_LETTER_PERCENTAGE => get_string('letterpercentage', 'grades'), GRADE_DISPLAY_TYPE_PERCENTAGE_LETTER => get_string('percentageletter', 'grades'), GRADE_DISPLAY_TYPE_PERCENTAGE_REAL => get_string('percentagereal', 'grades') ); asort($options); foreach ($options as $key=>$option) { if ($key == $default_gradedisplaytype) { $options[GRADE_DISPLAY_TYPE_DEFAULT] = get_string('defaultprev', 'grades', $option); break; } } $mform->addElement('select', 'display', get_string('gradedisplaytype', 'grades'), $options); $mform->addHelpButton('display', 'gradedisplaytype', 'grades'); $mform->disabledIf('display', 'gradetype', 'eq', GRADE_TYPE_TEXT); $default_gradedecimals = grade_get_setting($COURSE->id, 'decimalpoints', $CFG->grade_decimalpoints); $options = array(-1=>get_string('defaultprev', 'grades', $default_gradedecimals), 0=>0, 1=>1, 2=>2, 3=>3, 4=>4, 5=>5); $mform->addElement('select', 'decimals', get_string('decimalpoints', 'grades'), $options); $mform->addHelpButton('decimals', 'decimalpoints', 'grades'); $mform->setDefault('decimals', -1); $mform->disabledIf('decimals', 'display', 'eq', GRADE_DISPLAY_TYPE_LETTER); if ($default_gradedisplaytype == GRADE_DISPLAY_TYPE_LETTER) { $mform->disabledIf('decimals', 'display', "eq", GRADE_DISPLAY_TYPE_DEFAULT); } $mform->disabledIf('decimals', 'gradetype', 'eq', GRADE_TYPE_TEXT); /// hiding if ($item->cancontrolvisibility) { $mform->addElement('advcheckbox', 'hidden', get_string('hidden', 'grades'), '', [], [0, 1]); $mform->addElement('date_time_selector', 'hiddenuntil', get_string('hiddenuntil', 'grades'), array('optional'=>true)); $mform->disabledIf('hidden', 'hiddenuntil[enabled]', 'checked'); } else { $mform->addElement('static', 'hidden', get_string('hidden', 'grades'), get_string('componentcontrolsvisibility', 'grades')); // Unset hidden to avoid data override. unset($item->hidden); } $mform->addHelpButton('hidden', 'hidden', 'grades'); /// locking $mform->addElement('advcheckbox', 'locked', get_string('locked', 'grades')); $mform->addHelpButton('locked', 'locked', 'grades'); $mform->addElement('date_time_selector', 'locktime', get_string('locktime', 'grades'), array('optional'=>true)); $mform->disabledIf('locktime', 'gradetype', 'eq', GRADE_TYPE_NONE); /// parent category related settings $mform->addElement('header', 'headerparent', get_string('parentcategory', 'grades')); $mform->addElement('advcheckbox', 'weightoverride', get_string('adjustedweight', 'grades')); $mform->addHelpButton('weightoverride', 'weightoverride', 'grades'); $mform->disabledIf('weightoverride', 'gradetype', 'eq', GRADE_TYPE_NONE); $mform->disabledIf('weightoverride', 'gradetype', 'eq', GRADE_TYPE_TEXT); $mform->addElement('float', 'aggregationcoef2', get_string('weight', 'grades')); $mform->addHelpButton('aggregationcoef2', 'weight', 'grades'); $mform->disabledIf('aggregationcoef2', 'weightoverride'); $mform->disabledIf('aggregationcoef2', 'gradetype', 'eq', GRADE_TYPE_NONE); $mform->disabledIf('aggregationcoef2', 'gradetype', 'eq', GRADE_TYPE_TEXT); $options = array(); $coefstring = ''; $categories = grade_category::fetch_all(array('courseid'=>$COURSE->id)); foreach ($categories as $cat) { $cat->apply_forced_settings(); $options[$cat->id] = $cat->get_name(); } if (count($categories) > 1) { $mform->addElement('select', 'parentcategory', get_string('gradecategory', 'grades'), $options); } /// hidden params $mform->addElement('hidden', 'id', 0); $mform->setType('id', PARAM_INT); $mform->addElement('hidden', 'courseid', $COURSE->id); $mform->setType('courseid', PARAM_INT); $mform->addElement('hidden', 'itemtype', 'manual'); // all new items are manual only $mform->setType('itemtype', PARAM_ALPHA); /// add return tracking info $gpr = $this->_customdata['gpr']; $gpr->add_mform_elements($mform); //------------------------------------------------------------------------------- // buttons $this->add_action_buttons(); //------------------------------------------------------------------------------- $this->set_data($item); } /// tweak the form - depending on existing data function definition_after_data() { global $CFG, $COURSE; $mform =& $this->_form; if ($id = $mform->getElementValue('id')) { $gradeitem = grade_item::fetch(array('id' => $id)); $parentcategory = $gradeitem->get_parent_category(); } else { // If we do not have an id, we are creating a new grade item. $gradeitem = new grade_item(array('courseid' => $COURSE->id, 'itemtype' => 'manual'), false); // Assign the course category to this grade item. $parentcategory = grade_category::fetch_course_category($COURSE->id); $gradeitem->parent_category = $parentcategory; } if (!$gradeitem->is_raw_used()) { $mform->removeElement('plusfactor'); $mform->removeElement('multfactor'); } if ($gradeitem->is_outcome_item()) { // We have to prevent incompatible modifications of outcomes if outcomes disabled. $mform->removeElement('grademax'); if ($mform->elementExists('grademin')) { $mform->removeElement('grademin'); } $mform->removeElement('gradetype'); $mform->removeElement('display'); $mform->removeElement('decimals'); $mform->hardFreeze('scaleid'); } else { if ($gradeitem->is_external_item()) { // Following items are set up from modules and should not be overrided by user. if ($mform->elementExists('grademin')) { // The site setting grade_report_showmin may have prevented grademin being added to the form. $mform->hardFreeze('grademin'); } $mform->hardFreeze('itemname,gradetype,grademax,scaleid'); if ($gradeitem->itemnumber == 0) { // The idnumber of grade itemnumber 0 is synced with course_modules. $mform->hardFreeze('idnumber'); } // For external items we can not change the grade type, even if no grades exist, so if it is set to // scale, then remove the grademax and grademin fields from the form - no point displaying them. if ($gradeitem->gradetype == GRADE_TYPE_SCALE) { $mform->removeElement('grademax'); if ($mform->elementExists('grademin')) { $mform->removeElement('grademin'); } } else { // Not using scale, so remove it. $mform->removeElement('scaleid'); } // Always remove the rescale grades element if it's an external item. $mform->removeElement('rescalegrades'); } else if ($gradeitem->has_grades()) { // Can't change the grade type or the scale if there are grades. $mform->hardFreeze('gradetype, scaleid'); // If we are using scales then remove the unnecessary rescale and grade fields. if ($gradeitem->gradetype == GRADE_TYPE_SCALE) { $mform->removeElement('rescalegrades'); $mform->removeElement('grademax'); if ($mform->elementExists('grademin')) { $mform->removeElement('grademin'); } } else { // Remove the scale field. $mform->removeElement('scaleid'); // Set the maximum grade to disabled unless a grade is chosen. $mform->disabledIf('grademax', 'rescalegrades', 'eq', ''); } } else { // Remove the rescale element if there are no grades. $mform->removeElement('rescalegrades'); } } // If we wanted to change parent of existing item - we would have to verify there are no circular references in parents!!! if ($id && $mform->elementExists('parentcategory')) { $mform->hardFreeze('parentcategory'); } $parentcategory->apply_forced_settings(); if (!$parentcategory->is_aggregationcoef_used()) { if ($mform->elementExists('aggregationcoef')) { $mform->removeElement('aggregationcoef'); } } else { $coefstring = $gradeitem->get_coefstring(); if ($coefstring !== '') { if ($coefstring == 'aggregationcoefextrasum' || $coefstring == 'aggregationcoefextraweightsum') { // The advcheckbox is not compatible with disabledIf! $coefstring = 'aggregationcoefextrasum'; $element =& $mform->createElement('checkbox', 'aggregationcoef', get_string($coefstring, 'grades')); } else { $element =& $mform->createElement('text', 'aggregationcoef', get_string($coefstring, 'grades')); } if ($mform->elementExists('parentcategory')) { $mform->insertElementBefore($element, 'parentcategory'); } else { $mform->insertElementBefore($element, 'id'); } $mform->addHelpButton('aggregationcoef', $coefstring, 'grades'); } $mform->disabledIf('aggregationcoef', 'gradetype', 'eq', GRADE_TYPE_NONE); $mform->disabledIf('aggregationcoef', 'gradetype', 'eq', GRADE_TYPE_TEXT); $mform->disabledIf('aggregationcoef', 'parentcategory', 'eq', $parentcategory->id); } // Remove fields used by natural weighting if the parent category is not using natural weighting. // Or if the item is a scale and scales are not used in aggregation. if ($parentcategory->aggregation != GRADE_AGGREGATE_SUM || (empty($CFG->grade_includescalesinaggregation) && $gradeitem->gradetype == GRADE_TYPE_SCALE)) { if ($mform->elementExists('weightoverride')) { $mform->removeElement('weightoverride'); } if ($mform->elementExists('aggregationcoef2')) { $mform->removeElement('aggregationcoef2'); } } if ($category = $gradeitem->get_item_category()) { if ($category->aggregation == GRADE_AGGREGATE_SUM) { if ($mform->elementExists('gradetype')) { $mform->hardFreeze('gradetype'); } if ($mform->elementExists('grademin')) { $mform->hardFreeze('grademin'); } if ($mform->elementExists('grademax')) { $mform->hardFreeze('grademax'); } if ($mform->elementExists('scaleid')) { $mform->removeElement('scaleid'); } } } // no parent header for course category if (!$mform->elementExists('aggregationcoef') and !$mform->elementExists('parentcategory')) { $mform->removeElement('headerparent'); } } /// perform extra validation before submission function validation($data, $files) { global $COURSE; $grade_item = false; if ($data['id']) { $grade_item = new grade_item(array('id' => $data['id'], 'courseid' => $data['courseid'])); } $errors = parent::validation($data, $files); if (array_key_exists('idnumber', $data)) { if ($grade_item) { if ($grade_item->itemtype == 'mod') { $cm = get_coursemodule_from_instance($grade_item->itemmodule, $grade_item->iteminstance, $grade_item->courseid); } else { $cm = null; } } else { $grade_item = null; $cm = null; } if (!grade_verify_idnumber($data['idnumber'], $COURSE->id, $grade_item, $cm)) { $errors['idnumber'] = get_string('idnumbertaken'); } } if (array_key_exists('gradetype', $data) and $data['gradetype'] == GRADE_TYPE_SCALE) { if (empty($data['scaleid'])) { $errors['scaleid'] = get_string('missingscale', 'grades'); } } // We need to make all the validations related with grademax and grademin // with them being correct floats, keeping the originals unmodified for // later validations / showing the form back... // TODO: Note that once MDL-73994 is fixed we'll have to re-visit this and // adapt the code below to the new values arriving here, without forgetting // the special case of empties and nulls. $grademax = isset($data['grademax']) ? unformat_float($data['grademax']) : null; $grademin = isset($data['grademin']) ? unformat_float($data['grademin']) : null; if (!is_null($grademin) and !is_null($grademax)) { if ($grademax == $grademin or $grademax < $grademin) { $errors['grademin'] = get_string('incorrectminmax', 'grades'); $errors['grademax'] = get_string('incorrectminmax', 'grades'); } } // We do not want the user to be able to change the grade type or scale for this item if grades exist. if ($grade_item && $grade_item->has_grades()) { // Check that grade type is set - should never not be set unless form has been modified. if (!isset($data['gradetype'])) { $errors['gradetype'] = get_string('modgradecantchangegradetype', 'grades'); } else if ($data['gradetype'] !== $grade_item->gradetype) { // Check if we are changing the grade type. $errors['gradetype'] = get_string('modgradecantchangegradetype', 'grades'); } else if ($data['gradetype'] == GRADE_TYPE_SCALE) { // Check if we are changing the scale - can't do this when grades exist. if (isset($data['scaleid']) && ($data['scaleid'] !== $grade_item->scaleid)) { $errors['scaleid'] = get_string('modgradecantchangescale', 'grades'); } } } if ($grade_item) { if ($grade_item->gradetype == GRADE_TYPE_VALUE) { if ((((bool) get_config('moodle', 'grade_report_showmin')) && grade_floats_different($grademin, $grade_item->grademin)) || grade_floats_different($grademax, $grade_item->grademax)) { if ($grade_item->has_grades() && empty($data['rescalegrades'])) { $errors['rescalegrades'] = get_string('mustchooserescaleyesorno', 'grades'); } } } } return $errors; } } edit/tree/category.php 0000604 00000014472 15062070557 0010771 0 ustar 00 <?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/>. /** * Edit the grade options for an individual grade category * * @package core_grades * @copyright 2007 Petr Skoda * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ use core_grades\form\add_category; require_once('../../../config.php'); require_once($CFG->dirroot.'/grade/lib.php'); require_once($CFG->dirroot.'/grade/edit/tree/lib.php'); require_once($CFG->dirroot.'/grade/report/lib.php'); require_once('category_form.php'); $courseid = required_param('courseid', PARAM_INT); $id = optional_param('id', 0, PARAM_INT); // grade_category->id $url = new moodle_url('/grade/edit/tree/category.php', array('courseid'=>$courseid)); if ($id !== 0) { $url->param('id', $id); } $PAGE->set_url($url); $PAGE->set_pagelayout('admin'); navigation_node::override_active_url(new moodle_url('/grade/edit/tree/index.php', array('id'=>$courseid))); if (!$course = $DB->get_record('course', array('id' => $courseid))) { throw new \moodle_exception('invalidcourseid'); } require_login($course); $context = context_course::instance($course->id); require_capability('moodle/grade:manage', $context); // default return url $gpr = new grade_plugin_return(); $returnurl = $gpr->get_return_url('index.php?id='.$course->id); $heading = get_string('categoryedit', 'grades'); if ($id) { if (!$grade_category = grade_category::fetch(array('id'=>$id, 'courseid'=>$course->id))) { throw new \moodle_exception('invalidcategory'); } $grade_category->apply_forced_settings(); $category = $grade_category->get_record_data(); // set parent $category->parentcategory = $grade_category->parent; $grade_item = $grade_category->load_grade_item(); // nomalize coef values if needed $parent_category = $grade_category->get_parent_category(); foreach ($grade_item->get_record_data() as $key => $value) { $category->{"grade_item_$key"} = $value; } $decimalpoints = $grade_item->get_decimals(); $category->grade_item_grademax = format_float($category->grade_item_grademax, $decimalpoints); $category->grade_item_grademin = format_float($category->grade_item_grademin, $decimalpoints); $category->grade_item_gradepass = format_float($category->grade_item_gradepass, $decimalpoints); $category->grade_item_multfactor = format_float($category->grade_item_multfactor, 4); $category->grade_item_plusfactor = format_float($category->grade_item_plusfactor, 4); $category->grade_item_aggregationcoef2 = format_float($category->grade_item_aggregationcoef2 * 100.0, 4); if (!$parent_category) { // keep as is } else if ($parent_category->aggregation == GRADE_AGGREGATE_SUM or $parent_category->aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN2) { $category->grade_item_aggregationcoef = $category->grade_item_aggregationcoef == 0 ? 0 : 1; } else { $category->grade_item_aggregationcoef = format_float($category->grade_item_aggregationcoef, 4); } // Check to see if the gradebook is frozen. This allows grades to not be altered at all until a user verifies that they // wish to update the grades. $gradebookcalculationsfreeze = get_config('core', 'gradebook_calculations_freeze_' . $courseid); // Stick with the original code if the grade book is frozen. if ($gradebookcalculationsfreeze && (int)$gradebookcalculationsfreeze <= 20150627) { if ($category->aggregation == GRADE_AGGREGATE_SUM) { // Input fields for grademin and grademax are disabled for the "Natural" category, // this means they will be ignored if user does not change aggregation method. // But if user does change aggregation method the default values should be used. $category->grademax = 100; $category->grade_item_grademax = 100; $category->grademin = 0; $category->grade_item_grademin = 0; } } else { if ($category->aggregation == GRADE_AGGREGATE_SUM && !$grade_item->is_calculated()) { // Input fields for grademin and grademax are disabled for the "Natural" category, // this means they will be ignored if user does not change aggregation method. // But if user does change aggregation method the default values should be used. // This does not apply to calculated category totals. $category->grademax = 100; $category->grade_item_grademax = 100; $category->grademin = 0; $category->grade_item_grademin = 0; } } } else { $heading = get_string('newcategory', 'grades'); $grade_category = new grade_category(array('courseid'=>$courseid), false); $grade_category->apply_default_settings(); $grade_category->apply_forced_settings(); $category = $grade_category->get_record_data(); $grade_item = new grade_item(array('courseid'=>$courseid, 'itemtype'=>'manual'), false); foreach ($grade_item->get_record_data() as $key => $value) { $category->{"grade_item_$key"} = $value; } } $mform = new edit_category_form(null, array('current'=>$category, 'gpr'=>$gpr)); $simpleform = new add_category(null, ['category' => $grade_category->id, 'courseid' => $courseid, 'gpr' => $gpr]); // Data has been carried over from the dynamic form. if ($simpledata = $simpleform->get_submitted_data()) { $mform->set_data($simpledata); } if ($mform->is_cancelled()) { redirect($returnurl); } else if ($data = $mform->get_data()) { grade_edit_tree::update_gradecategory($grade_category, $data); redirect($returnurl); } $PAGE->navbar->add($heading); print_grade_page_head($courseid, 'settings', null, $heading, false, false, false); $mform->display(); echo $OUTPUT->footer(); die; import/lib.php 0000604 00000023422 15062070557 0007343 0 ustar 00 <?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/>. require_once($CFG->libdir.'/gradelib.php'); /** * Returns new improtcode for current user * @return int importcode */ function get_new_importcode() { global $USER, $DB; $importcode = time(); while ($DB->get_record('grade_import_values', array('importcode' => $importcode, 'importer' => $USER->id))) { $importcode--; } return $importcode; } /** * given an import code, commits all entries in buffer tables * (grade_import_value and grade_import_newitem) * If this function is called, we assume that all data collected * up to this point is fine and we can go ahead and commit * @param int $courseid - ID of the course. * @param int $importcode - Import batch identifier. * @param bool $importfeedback - Whether to import feedback as well. * @param bool $verbose - Print feedback and continue button. * @return bool success */ function grade_import_commit($courseid, $importcode, $importfeedback=true, $verbose=true) { global $CFG, $USER, $DB, $OUTPUT; $failed = false; $executionerrors = false; $commitstart = time(); // start time in case we need to roll back $newitemids = array(); // array to hold new grade_item ids from grade_import_newitem table, mapping array /// first select distinct new grade_items with this batch $params = array($importcode, $USER->id); if ($newitems = $DB->get_records_sql("SELECT * FROM {grade_import_newitem} WHERE importcode = ? AND importer=?", $params)) { // instances of the new grade_items created, cached // in case grade_update fails, so that we can remove them $instances = array(); foreach ($newitems as $newitem) { // get all grades with this item $gradeimportparams = array('newgradeitem' => $newitem->id, 'importcode' => $importcode, 'importer' => $USER->id); if ($grades = $DB->get_records('grade_import_values', $gradeimportparams)) { /// create a new grade item for this - must use false as second param! /// TODO: we need some bounds here too $gradeitem = new grade_item(array('courseid'=>$courseid, 'itemtype'=>'manual', 'itemname'=>$newitem->itemname), false); $gradeitem->insert('import'); $instances[] = $gradeitem; // insert each individual grade to this new grade item foreach ($grades as $grade) { if (!$gradeitem->update_final_grade($grade->userid, $grade->finalgrade, 'import', $grade->feedback, FORMAT_MOODLE, null, null, true)) { $failed = true; break 2; } } } } if ($failed) { foreach ($instances as $instance) { $gradeitem->delete('import'); } import_cleanup($importcode); return false; } } /// then find all existing items if ($gradeitems = $DB->get_records_sql("SELECT DISTINCT (itemid) FROM {grade_import_values} WHERE importcode = ? AND importer=? AND itemid > 0", array($importcode, $USER->id))) { $modifieditems = array(); foreach ($gradeitems as $itemid=>$notused) { if (!$gradeitem = new grade_item(array('id'=>$itemid))) { // not supposed to happen, but just in case import_cleanup($importcode); return false; } // get all grades with this item $gradeimportparams = array('itemid' => $itemid, 'importcode' => $importcode, 'importer' => $USER->id); if ($grades = $DB->get_records('grade_import_values', $gradeimportparams)) { // make the grades array for update_grade foreach ($grades as $grade) { if (!$importfeedback || $grade->feedback === null) { $grade->feedback = false; // ignore it } if ($grade->importonlyfeedback) { // False means do not change. See grade_itme::update_final_grade(). $grade->finalgrade = false; } if (!$gradeitem->update_final_grade($grade->userid, $grade->finalgrade, 'import', $grade->feedback, FORMAT_MOODLE, null, null, true)) { $errordata = new stdClass(); $errordata->itemname = $gradeitem->itemname; $errordata->userid = $grade->userid; $executionerrors[] = get_string('errorsettinggrade', 'grades', $errordata); $failed = true; break 2; } } //$itemdetails -> idnumber = $gradeitem->idnumber; $modifieditems[] = $itemid; } } if ($failed) { if ($executionerrors && $verbose) { echo $OUTPUT->notification(get_string('gradeimportfailed', 'grades')); foreach ($executionerrors as $errorstr) { echo $OUTPUT->notification($errorstr); } } import_cleanup($importcode); return false; } } if ($verbose) { echo $OUTPUT->notification(get_string('importsuccess', 'grades'), 'notifysuccess'); $unenrolledusers = get_unenrolled_users_in_import($importcode, $courseid); if ($unenrolledusers) { $list = array(); foreach ($unenrolledusers as $u) { $u->fullname = fullname($u); $list[] = get_string('usergrade', 'grades', $u); } echo $OUTPUT->notification(get_string('unenrolledusersinimport', 'grades', html_writer::alist($list)), 'notifysuccess'); } echo $OUTPUT->continue_button($CFG->wwwroot.'/grade/index.php?id='.$courseid); } // clean up import_cleanup($importcode); return true; } /** * This function returns an array of grades that were included in the import, * but where the user does not currently have a graded role on the course. These grades * are still stored in the database, but will not be visible in the gradebook unless * this user subsequently enrols on the course in a graded roles. * * The returned objects have fields useridnumber and gradeidnumber, plus enough user name fields to pass to {@see fullname} * * @param integer $importcode import batch identifier * @param integer $courseid the course we are importing to. * @return mixed and array of user objects, or false if none. */ function get_unenrolled_users_in_import($importcode, $courseid) { global $CFG, $DB; $coursecontext = context_course::instance($courseid); // We want to query both the current context and parent contexts. list($relatedctxsql, $relatedctxparams) = $DB->get_in_or_equal($coursecontext->get_parent_context_ids(true), SQL_PARAMS_NAMED, 'relatedctx'); // Users with a gradeable role. list($gradebookrolessql, $gradebookrolesparams) = $DB->get_in_or_equal(explode(',', $CFG->gradebookroles), SQL_PARAMS_NAMED, 'grbr'); $usernamefields = core_user\fields::for_name()->get_sql('u', false, '', '', false); // Enrolled users. $context = context_course::instance($courseid); list($enrolledsql, $enrolledparams) = get_enrolled_sql($context); list($sort, $sortparams) = users_order_by_sql('u'); $sql = "SELECT giv.id, {$usernamefields->selects}, u.idnumber AS useridnumber, COALESCE(gi.idnumber, gin.itemname) AS gradeidnumber FROM {grade_import_values} giv JOIN {user} u ON giv.userid = u.id LEFT JOIN {grade_items} gi ON gi.id = giv.itemid LEFT JOIN {grade_import_newitem} gin ON gin.id = giv.newgradeitem LEFT JOIN ($enrolledsql) je ON je.id = u.id LEFT JOIN {role_assignments} ra ON (giv.userid = ra.userid AND ra.roleid $gradebookrolessql AND ra.contextid $relatedctxsql) WHERE giv.importcode = :importcode AND (ra.id IS NULL OR je.id IS NULL) ORDER BY gradeidnumber, $sort"; $params = array_merge($gradebookrolesparams, $enrolledparams, $sortparams, $relatedctxparams); $params['importcode'] = $importcode; return $DB->get_records_sql($sql, $params); } /** * removes entries from grade import buffer tables grade_import_value and grade_import_newitem * after a successful import, or during an import abort * @param string importcode - import batch identifier */ function import_cleanup($importcode) { global $USER, $DB; // remove entries from buffer table $DB->delete_records('grade_import_values', array('importcode' => $importcode, 'importer' => $USER->id)); $DB->delete_records('grade_import_newitem', array('importcode' => $importcode, 'importer' => $USER->id)); } import/direct/db/access.php 0000604 00000002257 15062070557 0011700 0 ustar 00 <?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/>. /** * Capabilities gradeimport plugin. * * @package gradeimport_direct * @copyright 2014 Adrian Greeve <adrian@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); $capabilities = array( 'gradeimport/direct:view' => array( 'captype' => 'write', 'contextlevel' => CONTEXT_COURSE, 'archetypes' => array( 'editingteacher' => CAP_ALLOW, 'manager' => CAP_ALLOW ) ) ); import/direct/lang/en/gradeimport_direct.php 0000604 00000003024 15062070557 0015235 0 ustar 00 <?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/>. /** * Strings for component 'gradeimport_direct', language 'en', branch 'MOODLE_28_STABLE' * * @package gradeimport_direct * @copyright 2014 Adrian Greeve <adrian@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ $string['direct:view'] = 'Import grades from spreadsheet'; $string['pluginname'] = 'Paste from spreadsheet'; $string['privacy:metadata'] = 'The import grades from copied spreadsheed plugin does not store any personal data.'; $string['userdata'] = 'Help copying data into this form.'; $string['userdata_help'] = 'Grades may be copied and pasted from a spreadsheet into the gradebook. The spreadsheet should have a column containing user identity data - either username or ID number or email address. Each column for import should have a column header.'; $string['userdata_link'] = 'grade/import/direct/index'; import/direct/version.php 0000604 00000002404 15062070557 0011531 0 ustar 00 <?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/>. /** * Version details * * @package gradeimport_direct * @copyright 2014 Adrian Greeve <adrian@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); $plugin->version = 2023100900; // The current plugin version (Date: YYYYMMDDXX). $plugin->requires = 2023100400; // Requires this Moodle version. $plugin->component = 'gradeimport_direct'; // Full name of the plugin (used for diagnostics). $plugin->dependencies = ['gradeimport_csv' => 2023100400]; // Grade import csv is required for this plugin. import/direct/classes/privacy/provider.php 0000604 00000003003 15062070557 0015004 0 ustar 00 <?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/>. /** * Privacy Subsystem implementation for gradeimport_direct. * * @package gradeimport_direct * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradeimport_direct\privacy; defined('MOODLE_INTERNAL') || die(); /** * Privacy Subsystem for gradeimport_direct implementing null_provider. * * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class provider implements \core_privacy\local\metadata\null_provider { /** * Get the language string identifier with the component's language * file to explain why this plugin stores no data. * * @return string */ public static function get_reason() : string { return 'privacy:metadata'; } } import/direct/classes/mapping_form.php 0000604 00000011607 15062070557 0014164 0 ustar 00 <?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/>. require_once($CFG->libdir.'/formslib.php'); require_once($CFG->libdir.'/gradelib.php'); if (!defined('MOODLE_INTERNAL')) { die('Direct access to this script is forbidden.'); // It must be included from a Moodle page. } /** * Form for mapping columns to the fields in the table. * * @package gradeimport_direct * @copyright 2014 Adrian Greeve <adrian@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class gradeimport_direct_mapping_form extends moodleform { /** * Definition method. */ public function definition() { global $CFG, $COURSE; $mform = $this->_form; // This is an array of headers. $header = $this->_customdata['header']; // Course id. $mform->addElement('header', 'general', get_string('identifier', 'grades')); $mapfromoptions = array(); if ($header) { foreach ($header as $i => $h) { $mapfromoptions[$i] = s($h); } } $mform->addElement('select', 'mapfrom', get_string('mapfrom', 'grades'), $mapfromoptions); $mform->addHelpButton('mapfrom', 'mapfrom', 'grades'); $maptooptions = array( 'userid' => get_string('userid', 'grades'), 'username' => get_string('username'), 'useridnumber' => get_string('idnumber'), 'useremail' => get_string('email'), '0' => get_string('ignore', 'grades') ); $mform->addElement('select', 'mapto', get_string('mapto', 'grades'), $maptooptions); $mform->addHelpButton('mapto', 'mapto', 'grades'); $mform->addElement('header', 'general_map', get_string('mappings', 'grades')); $mform->addHelpButton('general_map', 'mappings', 'grades'); // Add a feedback option. $feedbacks = array(); if ($gradeitems = $this->_customdata['gradeitems']) { foreach ($gradeitems as $itemid => $itemname) { $feedbacks['feedback_'.$itemid] = get_string('feedbackforgradeitems', 'grades', $itemname); } } if ($header) { $i = 0; foreach ($header as $h) { $h = trim($h); // This is what each header maps to. $headermapsto = array( get_string('others', 'grades') => array( '0' => get_string('ignore', 'grades'), 'new' => get_string('newitem', 'grades') ), get_string('gradeitems', 'grades') => $gradeitems, get_string('feedbacks', 'grades') => $feedbacks ); $mform->addElement('selectgroups', 'mapping_'.$i, s($h), $headermapsto); $i++; } } // Course id needs to be passed for auth purposes. $mform->addElement('hidden', 'map', 1); $mform->setType('map', PARAM_INT); $mform->setConstant('map', 1); $mform->addElement('hidden', 'id', $this->_customdata['id']); $mform->setType('id', PARAM_INT); $mform->setConstant('id', $this->_customdata['id']); $mform->addElement('hidden', 'iid', $this->_customdata['iid']); $mform->setType('iid', PARAM_INT); $mform->setConstant('iid', $this->_customdata['iid']); $mform->addElement('hidden', 'importcode', $this->_customdata['importcode']); $mform->setType('importcode', PARAM_FILE); $mform->setConstant('importcode', $this->_customdata['importcode']); $mform->addElement('hidden', 'verbosescales', 1); $mform->setType('verbosescales', PARAM_INT); $mform->setConstant('verbosescales', $this->_customdata['importcode']); $mform->addElement('hidden', 'groupid', groups_get_course_group($COURSE)); $mform->setType('groupid', PARAM_INT); $mform->setConstant('groupid', groups_get_course_group($COURSE)); $mform->addElement('hidden', 'forceimport', $this->_customdata['forceimport']); $mform->setType('forceimport', PARAM_BOOL); $mform->setConstant('forceimport', $this->_customdata['forceimport']); $this->add_sticky_action_buttons(false, get_string('uploadgrades', 'grades')); } } import/direct/classes/import_form.php 0000604 00000006554 15062070557 0014050 0 ustar 00 <?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/>. require_once($CFG->libdir.'/formslib.php'); if (!defined('MOODLE_INTERNAL')) { die('Direct access to this script is forbidden.'); // It must be included from a Moodle page. } /** * Form for copying and pasting from a spreadsheet. * * @package gradeimport_direct * @copyright 2014 Adrian Greeve <adrian@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class gradeimport_direct_import_form extends moodleform { /** * Definition method. */ public function definition() { global $COURSE; $mform = $this->_form; if (isset($this->_customdata)) { // Hardcoding plugin names here is hacky. $features = $this->_customdata; } else { $features = array(); } // Course id needs to be passed for auth purposes. $mform->addElement('hidden', 'id', optional_param('id', 0, PARAM_INT)); $mform->setType('id', PARAM_INT); $mform->addElement('header', 'general', get_string('pluginname', 'gradeimport_direct')); // Data upload from copy/paste. $mform->addElement('textarea', 'userdata', get_string('importdata', 'core_grades'), array('rows' => 10, 'class' => 'gradeimport_data_area')); $mform->addHelpButton('userdata', 'importdata', 'core_grades'); $mform->addRule('userdata', null, 'required'); $mform->setType('userdata', PARAM_RAW); $encodings = core_text::get_encodings(); $mform->addElement('select', 'encoding', get_string('encoding', 'grades'), $encodings); $mform->addHelpButton('encoding', 'encoding', 'grades'); if (!empty($features['verbosescales'])) { $options = array(1 => get_string('yes'), 0 => get_string('no')); $mform->addElement('select', 'verbosescales', get_string('verbosescales', 'grades'), $options); $mform->addHelpButton('verbosescales', 'verbosescales', 'grades'); } $options = array('10' => 10, '20' => 20, '100' => 100, '1000' => 1000, '100000' => 100000); $mform->addElement('select', 'previewrows', get_string('rowpreviewnum', 'grades'), $options); $mform->addHelpButton('previewrows', 'rowpreviewnum', 'grades'); $mform->setType('previewrows', PARAM_INT); $mform->addElement('hidden', 'groupid', groups_get_course_group($COURSE)); $mform->setType('groupid', PARAM_INT); $mform->addElement('advcheckbox', 'forceimport', get_string('forceimport', 'grades')); $mform->addHelpButton('forceimport', 'forceimport', 'grades'); $mform->setDefault('forceimport', false); $this->add_sticky_action_buttons(false, get_string('uploadgrades', 'grades')); } } import/direct/index.php 0000604 00000012333 15062070557 0011155 0 ustar 00 <?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/>. /** * Page to import grades directly from a spreadsheet (Excel or Libre Office): * * @package gradeimport * @copyright 2007 Moodle Pty Ltd (http://moodle.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once("../../../config.php"); require_once($CFG->libdir . '/gradelib.php'); require_once($CFG->dirroot . '/grade/lib.php'); require_once($CFG->dirroot . '/grade/import/grade_import_form.php'); require_once($CFG->dirroot . '/grade/import/lib.php'); require_once($CFG->libdir . '/csvlib.class.php'); $id = required_param('id', PARAM_INT); // Course id. $verbosescales = optional_param('verbosescales', 1, PARAM_BOOL); $iid = optional_param('iid', null, PARAM_INT); $importcode = optional_param('importcode', '', PARAM_FILE); $forceimport = optional_param('forceimport', false, PARAM_BOOL); $url = new moodle_url('/grade/import/direct/index.php', array('id' => $id)); if ($verbosescales !== 1) { $url->param('verbosescales', $verbosescales); } $PAGE->set_url($url); if (!$course = $DB->get_record('course', array('id' => $id))) { throw new \moodle_exception('invalidcourseid'); } require_login($course); $context = context_course::instance($id); require_capability('moodle/grade:import', $context); require_capability('gradeimport/direct:view', $context); $separatemode = (groups_get_course_groupmode($COURSE) == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)); $currentgroup = groups_get_course_group($course); $actionbar = new \core_grades\output\import_action_bar($context, null, 'direct'); print_grade_page_head($course->id, 'import', 'direct', get_string('pluginname', 'gradeimport_direct'), false, false, true, 'userdata', 'gradeimport_direct', null, $actionbar); $renderer = $PAGE->get_renderer('gradeimport_csv'); // Get the grade items to be matched with the import mapping columns. $gradeitems = gradeimport_csv_load_data::fetch_grade_items($course->id); // If the csv file hasn't been imported yet then look for a form submission or // show the initial submission form. if (!$iid) { // Set up the import form. $mform = new gradeimport_direct_import_form(null, array('includeseparator' => true, 'verbosescales' => true, 'acceptedtypes' => array('.csv', '.txt'))); // If the import form has been submitted. if ($formdata = $mform->get_data()) { $text = $formdata->userdata; $csvimport = new gradeimport_csv_load_data(); $csvimport->load_csv_content($text, $formdata->encoding, 'tab', $formdata->previewrows); $csvimporterror = $csvimport->get_error(); if (!empty($csvimporterror)) { echo $renderer->errors(array($csvimport->get_error())); echo $OUTPUT->footer(); die(); } $iid = $csvimport->get_iid(); echo $renderer->import_preview_page($csvimport->get_headers(), $csvimport->get_previewdata()); } else { // Display the standard upload file form. echo $renderer->standard_upload_file_form($course, $mform); echo $OUTPUT->footer(); die(); } } // Data has already been submitted so we can use the $iid to retrieve it. $csvimport = new csv_import_reader($iid, 'grade'); $header = $csvimport->get_columns(); // Get a new import code for updating to the grade book. if (empty($importcode)) { $importcode = get_new_importcode(); } $mappingformdata = array( 'gradeitems' => $gradeitems, 'header' => $header, 'iid' => $iid, 'id' => $id, 'forceimport' => $forceimport, 'importcode' => $importcode, 'verbosescales' => $verbosescales ); // We create a form to handle mapping data from the file to the database. $mform2 = new gradeimport_direct_mapping_form(null, $mappingformdata); // Here, if we have data, we process the fields and enter the information into the database. if ($formdata = $mform2->get_data()) { $gradeimport = new gradeimport_csv_load_data(); $status = $gradeimport->prepare_import_grade_data($header, $formdata, $csvimport, $course->id, $separatemode, $currentgroup, $verbosescales); // At this stage if things are all ok, we commit the changes from temp table. if ($status) { grade_import_commit($course->id, $importcode); } else { $errors = $gradeimport->get_gradebookerrors(); $errors[] = get_string('importfailed', 'grades'); echo $renderer->errors($errors); } echo $OUTPUT->footer(); } else { // If data hasn't been submitted then display the data mapping form. $mform2->display(); echo $OUTPUT->footer(); } import/csv/index.php 0000604 00000012455 15062070557 0010503 0 ustar 00 <?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/>. require_once("../../../config.php"); require_once($CFG->libdir.'/gradelib.php'); require_once($CFG->dirroot.'/grade/lib.php'); require_once($CFG->dirroot. '/grade/import/grade_import_form.php'); require_once($CFG->dirroot.'/grade/import/lib.php'); require_once($CFG->libdir . '/csvlib.class.php'); $id = required_param('id', PARAM_INT); // Course id. $separator = optional_param('separator', '', PARAM_ALPHA); $verbosescales = optional_param('verbosescales', 1, PARAM_BOOL); $iid = optional_param('iid', null, PARAM_INT); $importcode = optional_param('importcode', '', PARAM_FILE); $forceimport = optional_param('forceimport', false, PARAM_BOOL); $url = new moodle_url('/grade/import/csv/index.php', array('id'=>$id)); if ($separator !== '') { $url->param('separator', $separator); } if ($verbosescales !== 1) { $url->param('verbosescales', $verbosescales); } $PAGE->set_url($url); if (!$course = $DB->get_record('course', array('id'=>$id))) { throw new \moodle_exception('invalidcourseid'); } require_login($course); $context = context_course::instance($id); require_capability('moodle/grade:import', $context); require_capability('gradeimport/csv:view', $context); $separatemode = (groups_get_course_groupmode($COURSE) == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)); $currentgroup = groups_get_course_group($course); $actionbar = new \core_grades\output\import_action_bar($context, null, 'csv'); print_grade_page_head($course->id, 'import', 'csv', get_string('importcsv', 'grades'), false, false, true, 'importcsv', 'grades', null, $actionbar); $renderer = $PAGE->get_renderer('gradeimport_csv'); // Get the grade items to be matched with the import mapping columns. $gradeitems = gradeimport_csv_load_data::fetch_grade_items($course->id); // If the csv file hasn't been imported yet then look for a form submission or // show the initial submission form. if (!$iid) { // Set up the import form. $mform = new grade_import_form(null, array('includeseparator' => true, 'verbosescales' => $verbosescales, 'acceptedtypes' => array('.csv', '.txt'))); // If the import form has been submitted. if ($formdata = $mform->get_data()) { $text = $mform->get_file_content('userfile'); $csvimport = new gradeimport_csv_load_data(); $csvimport->load_csv_content($text, $formdata->encoding, $separator, $formdata->previewrows); $csvimporterror = $csvimport->get_error(); if (!empty($csvimporterror)) { echo $renderer->errors(array($csvimport->get_error())); echo $OUTPUT->continue_button(new moodle_url('/grade/import/csv/index.php', ['id' => $course->id])); echo $OUTPUT->footer(); die(); } $iid = $csvimport->get_iid(); echo $renderer->import_preview_page($csvimport->get_headers(), $csvimport->get_previewdata()); } else { // Display the standard upload file form. echo $renderer->standard_upload_file_form($course, $mform); echo $OUTPUT->footer(); die(); } } // Data has already been submitted so we can use the $iid to retrieve it. $csvimport = new csv_import_reader($iid, 'grade'); $header = $csvimport->get_columns(); // Get a new import code for updating to the grade book. if (empty($importcode)) { $importcode = get_new_importcode(); } $mappingformdata = array( 'gradeitems' => $gradeitems, 'header' => $header, 'iid' => $iid, 'id' => $id, 'importcode' => $importcode, 'forceimport' => $forceimport, 'verbosescales' => $verbosescales ); // we create a form to handle mapping data from the file to the database. $mform2 = new grade_import_mapping_form(null, $mappingformdata); // Here, if we have data, we process the fields and enter the information into the database. if ($formdata = $mform2->get_data()) { $gradeimport = new gradeimport_csv_load_data(); $status = $gradeimport->prepare_import_grade_data($header, $formdata, $csvimport, $course->id, $separatemode, $currentgroup, $verbosescales); // At this stage if things are all ok, we commit the changes from temp table. if ($status) { grade_import_commit($course->id, $importcode); } else { $errors = $gradeimport->get_gradebookerrors(); $errors[] = get_string('importfailed', 'grades'); echo $renderer->errors($errors); echo $OUTPUT->continue_button(new moodle_url('/grade/import/csv/index.php', ['id' => $course->id])); } echo $OUTPUT->footer(); } else { // If data hasn't been submitted then display the data mapping form. $mform2->display(); echo $OUTPUT->footer(); } import/csv/lang/en/gradeimport_csv.php 0000604 00000002171 15062070557 0014101 0 ustar 00 <?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/>. /** * Strings for component 'gradeimport_csv', language 'en', branch 'MOODLE_20_STABLE' * * @package gradeimport_csv * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ $string['csv:view'] = 'Import grades from CSV'; $string['pluginname'] = 'CSV file'; $string['privacy:metadata'] = 'The import grades from CSV plugin does not store any personal data.'; import/csv/version.php 0000604 00000002256 15062070557 0011057 0 ustar 00 <?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/>. /** * Version details * * @package gradeimport * @subpackage csv * @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); $plugin->version = 2023100900; // The current plugin version (Date: YYYYMMDDXX). $plugin->requires = 2023100400; // Requires this Moodle version. $plugin->component = 'gradeimport_csv'; // Full name of the plugin (used for diagnostics) import/csv/db/access.php 0000604 00000002233 15062070557 0011213 0 ustar 00 <?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/>. /** * Capabilities gradeimport plugin. * * @package gradeimport_csv * @copyright 2007 Martin Dougiamas * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); $capabilities = array( 'gradeimport/csv:view' => array( 'captype' => 'write', 'contextlevel' => CONTEXT_COURSE, 'archetypes' => array( 'editingteacher' => CAP_ALLOW, 'manager' => CAP_ALLOW ) ) ); import/csv/classes/privacy/provider.php 0000604 00000002767 15062070557 0014345 0 ustar 00 <?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/>. /** * Privacy Subsystem implementation for gradeimport_csv. * * @package gradeimport_csv * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradeimport_csv\privacy; defined('MOODLE_INTERNAL') || die(); /** * Privacy Subsystem for gradeimport_csv implementing null_provider. * * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class provider implements \core_privacy\local\metadata\null_provider { /** * Get the language string identifier with the component's language * file to explain why this plugin stores no data. * * @return string */ public static function get_reason() : string { return 'privacy:metadata'; } } import/csv/classes/load_data.php 0000604 00000063372 15062070557 0012745 0 ustar 00 <?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/>. /** * A class for loading and preparing grade data from import. * * @package gradeimport_csv * @copyright 2014 Adrian Greeve <adrian@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); /** * A class for loading and preparing grade data from import. * * @package gradeimport_csv * @copyright 2014 Adrian Greeve <adrian@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class gradeimport_csv_load_data { /** @var string $error csv import error. */ protected $error; /** @var int $iid Unique identifier for these csv records. */ protected $iid; /** @var array $headers Column names for the data. */ protected $headers; /** @var array $previewdata A subsection of the csv imported data. */ protected $previewdata; // The map_user_data_with_value variables. /** @var array $newgrades Grades to be inserted into the gradebook. */ protected $newgrades; /** @var array $newfeedbacks Feedback to be inserted into the gradebook. */ protected $newfeedbacks; /** @var int $studentid Student ID*/ protected $studentid; // The prepare_import_grade_data() variables. /** @var bool $status The current status of the import. True = okay, False = errors. */ protected $status; /** @var int $importcode The code for this batch insert. */ protected $importcode; /** @var array $gradebookerrors An array of errors from trying to import into the gradebook. */ protected $gradebookerrors; /** @var array $newgradeitems An array of new grade items to be inserted into the gradebook. */ protected $newgradeitems; /** * Load CSV content for previewing. * * @param string $text The grade data being imported. * @param string $encoding The type of encoding the file uses. * @param string $separator The separator being used to define each field. * @param int $previewrows How many rows are being previewed. */ public function load_csv_content($text, $encoding, $separator, $previewrows) { $this->raise_limits(); $this->iid = csv_import_reader::get_new_iid('grade'); $csvimport = new csv_import_reader($this->iid, 'grade'); $csvimport->load_csv_content($text, $encoding, $separator); $this->error = $csvimport->get_error(); // If there are no import errors then proceed. if (empty($this->error)) { // Get header (field names). $this->headers = $csvimport->get_columns(); $this->trim_headers(); $csvimport->init(); $this->previewdata = array(); for ($numlines = 0; $numlines <= $previewrows; $numlines++) { $lines = $csvimport->next(); if ($lines) { $this->previewdata[] = $lines; } } } } /** * Gets all of the grade items in this course. * * @param int $courseid Course id; * @return array An array of grade items for the course. */ public static function fetch_grade_items($courseid) { $gradeitems = null; if ($allgradeitems = grade_item::fetch_all(array('courseid' => $courseid))) { foreach ($allgradeitems as $gradeitem) { // Skip course type and category type. if ($gradeitem->itemtype == 'course' || $gradeitem->itemtype == 'category') { continue; } $displaystring = null; if (!empty($gradeitem->itemmodule)) { $displaystring = get_string('modulename', $gradeitem->itemmodule).get_string('labelsep', 'langconfig') .$gradeitem->get_name(); } else { $displaystring = $gradeitem->get_name(); } $gradeitems[$gradeitem->id] = $displaystring; } } return $gradeitems; } /** * Cleans the column headers from the CSV file. */ protected function trim_headers() { foreach ($this->headers as $i => $h) { $h = trim($h); // Remove whitespace. $h = clean_param($h, PARAM_RAW); // Clean the header. $this->headers[$i] = $h; } } /** * Raises the php execution time and memory limits for importing the CSV file. */ protected function raise_limits() { // Large files are likely to take their time and memory. Let PHP know // that we'll take longer, and that the process should be recycled soon // to free up memory. core_php_time_limit::raise(); raise_memory_limit(MEMORY_EXTRA); } /** * Inserts a record into the grade_import_values table. This also adds common record information. * * @param object $record The grade record being inserted into the database. * @param int $studentid The student ID. * @return bool|int true or insert id on success. Null if the grade value is too high. */ protected function insert_grade_record($record, $studentid) { global $DB, $USER, $CFG; $record->importcode = $this->importcode; $record->userid = $studentid; $record->importer = $USER->id; // By default the maximum grade is 100. $gradepointmaximum = 100; // If the grade limit has been increased then use the gradepointmax setting. if ($CFG->unlimitedgrades) { $gradepointmaximum = $CFG->gradepointmax; } // If the record final grade is set then check that the grade value isn't too high. // Final grade will not be set if we are inserting feedback. if (!isset($record->finalgrade) || $record->finalgrade <= $gradepointmaximum) { return $DB->insert_record('grade_import_values', $record); } else { $this->cleanup_import(get_string('gradevaluetoobig', 'grades', $gradepointmaximum)); return null; } } /** * Insert the new grade into the grade item buffer table. * * @param array $header The column headers from the CSV file. * @param int $key Current row identifier. * @param string $value The value for this row (final grade). * @return stdClass new grade that is ready for commiting to the gradebook. */ protected function import_new_grade_item($header, $key, $value) { global $DB, $USER; // First check if header is already in temp database. if (empty($this->newgradeitems[$key])) { $newgradeitem = new stdClass(); $newgradeitem->itemname = $header[$key]; $newgradeitem->importcode = $this->importcode; $newgradeitem->importer = $USER->id; // Insert into new grade item buffer. $this->newgradeitems[$key] = $DB->insert_record('grade_import_newitem', $newgradeitem); } $newgrade = new stdClass(); $newgrade->newgradeitem = $this->newgradeitems[$key]; $trimmed = trim($value); if ($trimmed === '' or $trimmed == '-') { // Blank or dash grade means null, ie "no grade". $newgrade->finalgrade = null; } else { // We have an actual grade. $newgrade->finalgrade = $value; } $this->newgrades[] = $newgrade; return $newgrade; } /** * Check that the user is in the system. * * @param string $value The value, from the csv file, being mapped to identify the user. * @param array $userfields Contains the field and label being mapped from. * @return int Returns the user ID if it exists, otherwise null. */ protected function check_user_exists($value, $userfields) { global $DB; $user = null; $errorkey = false; // The user may use the incorrect field to match the user. This could result in an exception. try { $field = $userfields['field']; // Fields that can be queried in a case-insensitive manner. $caseinsensitivefields = [ 'email', 'username', ]; // Build query predicate. if (in_array($field, $caseinsensitivefields)) { // Case-insensitive. $select = $DB->sql_equal($field, ':' . $field, false); } else { // Exact-value. $select = "{$field} = :{$field}"; } // Validate if the user id value is numerical. if ($field === 'id' && !is_numeric($value)) { $errorkey = 'usermappingerror'; } // Make sure the record exists and that there's only one matching record found. $user = $DB->get_record_select('user', $select, array($userfields['field'] => $value), '*', MUST_EXIST); } catch (dml_missing_record_exception $missingex) { $errorkey = 'usermappingerror'; } catch (dml_multiple_records_exception $multiex) { $errorkey = 'usermappingerrormultipleusersfound'; } // Field may be fine, but no records were returned. if ($errorkey) { $usermappingerrorobj = new stdClass(); $usermappingerrorobj->field = $userfields['label']; $usermappingerrorobj->value = $value; $this->cleanup_import(get_string($errorkey, 'grades', $usermappingerrorobj)); unset($usermappingerrorobj); return null; } return $user->id; } /** * Check to see if the feedback matches a grade item. * * @param int $courseid The course ID. * @param int $itemid The ID of the grade item that the feedback relates to. * @param string $value The actual feedback being imported. * @return object Creates a feedback object with the item ID and the feedback value. */ protected function create_feedback($courseid, $itemid, $value) { // Case of an id, only maps id of a grade_item. // This was idnumber. if (!new grade_item(array('id' => $itemid, 'courseid' => $courseid))) { // Supplied bad mapping, should not be possible since user // had to pick mapping. $this->cleanup_import(get_string('importfailed', 'grades')); return null; } // The itemid is the id of the grade item. $feedback = new stdClass(); $feedback->itemid = $itemid; $feedback->feedback = $value; return $feedback; } /** * This updates existing grade items. * * @param int $courseid The course ID. * @param array $map Mapping information provided by the user. * @param int $key The line that we are currently working on. * @param bool $verbosescales Form setting for grading with scales. * @param string $value The grade value. * @return array grades to be updated. */ protected function update_grade_item($courseid, $map, $key, $verbosescales, $value) { // Case of an id, only maps id of a grade_item. // This was idnumber. if (!$gradeitem = new grade_item(array('id' => $map[$key], 'courseid' => $courseid))) { // Supplied bad mapping, should not be possible since user // had to pick mapping. $this->cleanup_import(get_string('importfailed', 'grades')); return null; } // Check if grade item is locked if so, abort. if ($gradeitem->is_locked()) { $this->cleanup_import(get_string('gradeitemlocked', 'grades')); return null; } $newgrade = new stdClass(); $newgrade->itemid = $gradeitem->id; if ($gradeitem->gradetype == GRADE_TYPE_SCALE and $verbosescales) { if ($value === '' or $value == '-') { $value = null; // No grade. } else { $scale = $gradeitem->load_scale(); $scales = explode(',', $scale->scale); $scales = array_map('trim', $scales); // Hack - trim whitespace around scale options. array_unshift($scales, '-'); // Scales start at key 1. $key = array_search($value, $scales); if ($key === false) { $this->cleanup_import(get_string('badgrade', 'grades')); return null; } $value = $key; } $newgrade->finalgrade = $value; } else { if ($value === '' or $value == '-') { $value = null; // No grade. } else { // If the value has a local decimal or can correctly be unformatted, do it. $validvalue = unformat_float($value, true); if ($validvalue !== false) { $value = $validvalue; } else { // Non numeric grade value supplied, possibly mapped wrong column. $this->cleanup_import(get_string('badgrade', 'grades')); return null; } } $newgrade->finalgrade = $value; } $this->newgrades[] = $newgrade; return $this->newgrades; } /** * Clean up failed CSV grade import. Clears the temp table for inserting grades. * * @param string $notification The error message to display from the unsuccessful grade import. */ protected function cleanup_import($notification) { $this->status = false; import_cleanup($this->importcode); $this->gradebookerrors[] = $notification; } /** * Check user mapping. * * @param string $mappingidentifier The user field that we are matching together. * @param string $value The value we are checking / importing. * @param array $header The column headers of the csv file. * @param array $map Mapping information provided by the user. * @param int $key Current row identifier. * @param int $courseid The course ID. * @param int $feedbackgradeid The ID of the grade item that the feedback relates to. * @param bool $verbosescales Form setting for grading with scales. */ protected function map_user_data_with_value($mappingidentifier, $value, $header, $map, $key, $courseid, $feedbackgradeid, $verbosescales) { // Fields that the user can be mapped from. $userfields = array( 'userid' => array( 'field' => 'id', 'label' => 'id', ), 'useridnumber' => array( 'field' => 'idnumber', 'label' => 'idnumber', ), 'useremail' => array( 'field' => 'email', 'label' => 'email address', ), 'username' => array( 'field' => 'username', 'label' => 'username', ), ); switch ($mappingidentifier) { case 'userid': case 'useridnumber': case 'useremail': case 'username': $this->studentid = $this->check_user_exists($value, $userfields[$mappingidentifier]); break; case 'new': $this->import_new_grade_item($header, $key, $value); break; case 'feedback': if ($feedbackgradeid) { $feedback = $this->create_feedback($courseid, $feedbackgradeid, $value); if (isset($feedback)) { $this->newfeedbacks[] = $feedback; } } break; default: // Existing grade items. if (!empty($map[$key])) { $this->newgrades = $this->update_grade_item($courseid, $map, $key, $verbosescales, $value, $mappingidentifier); } // Otherwise, we ignore this column altogether because user has chosen // to ignore them (e.g. institution, address etc). break; } } /** * Checks and prepares grade data for inserting into the gradebook. * * @param array $header Column headers of the CSV file. * @param object $formdata Mapping information from the preview page. * @param object $csvimport csv import reader object for iterating over the imported CSV file. * @param int $courseid The course ID. * @param bool $separatemode If we have groups are they separate? * @param mixed $currentgroup current group information. * @param bool $verbosescales Form setting for grading with scales. * @return bool True if the status for importing is okay, false if there are errors. */ public function prepare_import_grade_data($header, $formdata, $csvimport, $courseid, $separatemode, $currentgroup, $verbosescales) { global $DB, $USER; // The import code is used for inserting data into the grade tables. $this->importcode = $formdata->importcode; $this->status = true; $this->headers = $header; $this->studentid = null; $this->gradebookerrors = null; $forceimport = $formdata->forceimport; // Temporary array to keep track of what new headers are processed. $this->newgradeitems = array(); $this->trim_headers(); $timeexportkey = null; $map = array(); // Loops mapping_0, mapping_1 .. mapping_n and construct $map array. foreach ($header as $i => $head) { if (isset($formdata->{'mapping_'.$i})) { $map[$i] = $formdata->{'mapping_'.$i}; } if ($head == get_string('timeexported', 'gradeexport_txt')) { $timeexportkey = $i; } } // If mapping information is supplied. $map[clean_param($formdata->mapfrom, PARAM_RAW)] = clean_param($formdata->mapto, PARAM_RAW); // Check for mapto collisions. $maperrors = array(); foreach ($map as $i => $j) { if ($j == 0) { // You can have multiple ignores. continue; } else { if (!isset($maperrors[$j])) { $maperrors[$j] = true; } else { // Collision. throw new \moodle_exception('cannotmapfield', '', '', $j); } } } $this->raise_limits(); $csvimport->init(); while ($line = $csvimport->next()) { if (count($line) <= 1) { // There is no data on this line, move on. continue; } // Array to hold all grades to be inserted. $this->newgrades = array(); // Array to hold all feedback. $this->newfeedbacks = array(); // Each line is a student record. foreach ($line as $key => $value) { $value = clean_param($value, PARAM_RAW); $value = trim($value); /* * the options are * 1) userid, useridnumber, usermail, username - used to identify user row * 2) new - new grade item * 3) id - id of the old grade item to map onto * 3) feedback_id - feedback for grade item id */ // Explode the mapping for feedback into a label 'feedback' and the identifying number. $mappingbase = explode("_", $map[$key]); $mappingidentifier = $mappingbase[0]; // Set the feedback identifier if it exists. if (isset($mappingbase[1])) { $feedbackgradeid = (int)$mappingbase[1]; } else { $feedbackgradeid = ''; } $this->map_user_data_with_value($mappingidentifier, $value, $header, $map, $key, $courseid, $feedbackgradeid, $verbosescales); if ($this->status === false) { return $this->status; } } // No user mapping supplied at all, or user mapping failed. if (empty($this->studentid) || !is_numeric($this->studentid)) { // User not found, abort whole import. $this->cleanup_import(get_string('usermappingerrorusernotfound', 'grades')); break; } if ($separatemode and !groups_is_member($currentgroup, $this->studentid)) { // Not allowed to import into this group, abort. $this->cleanup_import(get_string('usermappingerrorcurrentgroup', 'grades')); break; } // Insert results of this students into buffer. if ($this->status and !empty($this->newgrades)) { foreach ($this->newgrades as $newgrade) { // Check if grade_grade is locked and if so, abort. if (!empty($newgrade->itemid) and $gradegrade = new grade_grade(array('itemid' => $newgrade->itemid, 'userid' => $this->studentid))) { if ($gradegrade->is_locked()) { // Individual grade locked. $this->cleanup_import(get_string('gradelocked', 'grades')); return $this->status; } // Check if the force import option is disabled and the last exported date column is present. if (!$forceimport && !empty($timeexportkey)) { $exportedtime = $line[$timeexportkey]; if (clean_param($exportedtime, PARAM_INT) != $exportedtime || $exportedtime > time() || $exportedtime < strtotime("-1 year", time())) { // The date is invalid, or in the future, or more than a year old. $this->cleanup_import(get_string('invalidgradeexporteddate', 'grades')); return $this->status; } $timemodified = $gradegrade->get_dategraded(); if (!empty($timemodified) && ($exportedtime < $timemodified)) { // The item was graded after we exported it, we return here not to override it. $user = core_user::get_user($this->studentid); $this->cleanup_import(get_string('gradealreadyupdated', 'grades', fullname($user))); return $this->status; } } } $insertid = self::insert_grade_record($newgrade, $this->studentid); // Check to see if the insert was successful. if (empty($insertid)) { return null; } } } // Updating/inserting all comments here. if ($this->status and !empty($this->newfeedbacks)) { foreach ($this->newfeedbacks as $newfeedback) { $sql = "SELECT * FROM {grade_import_values} WHERE importcode=? AND userid=? AND itemid=? AND importer=?"; if ($feedback = $DB->get_record_sql($sql, array($this->importcode, $this->studentid, $newfeedback->itemid, $USER->id))) { $newfeedback->id = $feedback->id; $DB->update_record('grade_import_values', $newfeedback); } else { // The grade item for this is not updated. $newfeedback->importonlyfeedback = true; $insertid = self::insert_grade_record($newfeedback, $this->studentid); // Check to see if the insert was successful. if (empty($insertid)) { return null; } } } } } return $this->status; } /** * Returns the headers parameter for this class. * * @return array returns headers parameter for this class. */ public function get_headers() { return $this->headers; } /** * Returns the error parameter for this class. * * @return string returns error parameter for this class. */ public function get_error() { return $this->error; } /** * Returns the iid parameter for this class. * * @return int returns iid parameter for this class. */ public function get_iid() { return $this->iid; } /** * Returns the preview_data parameter for this class. * * @return array returns previewdata parameter for this class. */ public function get_previewdata() { return $this->previewdata; } /** * Returns the gradebookerrors parameter for this class. * * @return array returns gradebookerrors parameter for this class. */ public function get_gradebookerrors() { return $this->gradebookerrors; } } import/csv/classes/output/renderer.php 0000604 00000005656 15062070557 0014204 0 ustar 00 <?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/>. /** * Renderers for the import of CSV files into the gradebook. * * @package gradeimport_csv * @copyright 2014 Adrian Greeve <adrian@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); /** * Renderers for the import of CSV files into the gradebook. * * @package gradeimport_csv * @copyright 2014 Adrian Greeve <adrian@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class gradeimport_csv_renderer extends plugin_renderer_base { /** * A renderer for the standard upload file form. * * @param object $course The course we are doing all of this action in. * @param object $mform The mform for uploading CSV files. * @return string html to be displayed. */ public function standard_upload_file_form($course, $mform) { $output = groups_print_course_menu($course, 'index.php?id=' . $course->id, true); $output .= html_writer::start_tag('div', array('class' => 'clearer')); $output .= html_writer::end_tag('div'); // Form. ob_start(); $mform->display(); $output .= ob_get_contents(); ob_end_clean(); return $output; } /** * A renderer for the CSV file preview. * * @param array $header Column headers from the CSV file. * @param array $data The rest of the data from the CSV file. * @return string html to be displayed. */ public function import_preview_page($header, $data) { $html = $this->output->heading(get_string('importpreview', 'grades')); $table = new html_table(); $table->head = array_map('s', $header); $table->data = array_map(static function($row) { return array_map('s', $row); }, $data); $html .= html_writer::table($table); return $html; } /** * A renderer for errors generated trying to import the CSV file. * * @param array $errors Display import errors. * @return string errors as html to be displayed. */ public function errors($errors) { $html = ''; foreach ($errors as $error) { $html .= $this->output->notification($error); } return $html; } } import/csv/tests/load_data_test.php 0000604 00000061665 15062070557 0013514 0 ustar 00 <?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/>. namespace gradeimport_csv; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once($CFG->dirroot . '/grade/import/csv/tests/fixtures/phpunit_gradeimport_csv_load_data.php'); require_once($CFG->libdir . '/csvlib.class.php'); require_once($CFG->libdir . '/grade/grade_item.php'); require_once($CFG->libdir . '/grade/tests/fixtures/lib.php'); /** * Unit tests for lib.php * * @package gradeimport_csv * @copyright 2014 Adrian Greeve * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class load_data_test extends \grade_base_testcase { /** @var string $oktext Text to be imported. This data should have no issues being imported. */ protected $oktext = '"First name","Last name","ID number",Institution,Department,"Email address","Assignment: Assignment for grape group", "Feedback: Assignment for grape group","Assignment: Second new grade item","Course total" Anne,Able,,"Moodle HQ","Rock on!",student7@example.com,56.00,"We welcome feedback",,56.00 Bobby,Bunce,,"Moodle HQ","Rock on!",student5@example.com,75.00,,45.0,75.00'; /** @var string $badtext Text to be imported. This data has an extra column and should not succeed in being imported. */ protected $badtext = '"First name","Last name","ID number",Institution,Department,"Email address","Assignment: Assignment for grape group","Course total" Anne,Able,,"Moodle HQ","Rock on!",student7@example.com,56.00,56.00,78.00 Bobby,Bunce,,"Moodle HQ","Rock on!",student5@example.com,75.00,75.00'; /** @var string $csvtext CSV data to be imported with Last download from this course column. */ protected $csvtext = '"First name","Last name","ID number",Institution,Department,"Email address","Assignment: Assignment for grape group", "Feedback: Assignment for grape group","Course total","Last downloaded from this course" Anne,Able,,"Moodle HQ","Rock on!",student7@example.com,56.00,"We welcome feedback",56.00,{exportdate} Bobby,Bunce,,"Moodle HQ","Rock on!",student5@example.com,75.00,,75.00,{exportdate}'; /** @var int $iid Import ID. */ protected $iid; /** @var object $csvimport a csv_import_reader object that handles the csv import. */ protected $csvimport; /** @var array $columns The first row of the csv file. These are the columns of the import file.*/ protected $columns; public function tearDown(): void { $this->csvimport = null; } /** * Load up the above text through the csv import. * * @param string $content Text to be imported into the gradebook. * @return array All text separated by commas now in an array. */ protected function csv_load($content) { // Import the csv strings. $this->iid = \csv_import_reader::get_new_iid('grade'); $this->csvimport = new \csv_import_reader($this->iid, 'grade'); $this->csvimport->load_csv_content($content, 'utf8', 'comma'); $this->columns = $this->csvimport->get_columns(); $this->csvimport->init(); while ($line = $this->csvimport->next()) { $testarray[] = $line; } return $testarray; } /** * Test loading data and returning preview content. */ public function test_load_csv_content() { $encoding = 'utf8'; $separator = 'comma'; $previewrows = 5; $csvpreview = new \phpunit_gradeimport_csv_load_data(); $csvpreview->load_csv_content($this->oktext, $encoding, $separator, $previewrows); $expecteddata = array(array( 'Anne', 'Able', '', 'Moodle HQ', 'Rock on!', 'student7@example.com', 56.00, 'We welcome feedback', '', 56.00 ), array( 'Bobby', 'Bunce', '', 'Moodle HQ', 'Rock on!', 'student5@example.com', 75.00, '', 45.0, 75.00 ) ); $expectedheaders = array( 'First name', 'Last name', 'ID number', 'Institution', 'Department', 'Email address', 'Assignment: Assignment for grape group', 'Feedback: Assignment for grape group', 'Assignment: Second new grade item', 'Course total' ); // Check that general data is returned as expected. $this->assertEquals($csvpreview->get_previewdata(), $expecteddata); // Check that headers are returned as expected. $this->assertEquals($csvpreview->get_headers(), $expectedheaders); // Check that errors are being recorded. $csvpreview = new \phpunit_gradeimport_csv_load_data(); $csvpreview->load_csv_content($this->badtext, $encoding, $separator, $previewrows); // Columns shouldn't match. $this->assertEquals($csvpreview->get_error(), get_string('csvweirdcolumns', 'error')); } /** * Test fetching grade items for the course. */ public function test_fetch_grade_items() { $gradeitemsarray = \grade_item::fetch_all(array('courseid' => $this->courseid)); $gradeitems = \phpunit_gradeimport_csv_load_data::fetch_grade_items($this->courseid); // Make sure that each grade item is located in the gradeitemsarray. foreach ($gradeitems as $key => $gradeitem) { $this->assertArrayHasKey($key, $gradeitemsarray); } // Get the key for a specific grade item. $quizkey = null; foreach ($gradeitemsarray as $key => $value) { if ($value->itemname == "Quiz grade item") { $quizkey = $key; } } // Expected modified item name. $testitemname = get_string('modulename', $gradeitemsarray[$quizkey]->itemmodule) . ': ' . $gradeitemsarray[$quizkey]->itemname; // Check that an item that is a module, is concatenated properly. $this->assertEquals($testitemname, $gradeitems[$quizkey]); } /** * Test the inserting of grade record data. */ public function test_insert_grade_record() { global $DB, $USER; $user = $this->getDataGenerator()->create_user(); $this->setAdminUser(); $record = new \stdClass(); $record->itemid = 4; $record->newgradeitem = 25; $record->finalgrade = 62.00; $record->feedback = 'Some test feedback'; $testobject = new \phpunit_gradeimport_csv_load_data(); $testobject->test_insert_grade_record($record, $user->id); $gradeimportvalues = $DB->get_records('grade_import_values'); // Get the insert id. $key = key($gradeimportvalues); $testarray = array(); $testarray[$key] = new \stdClass(); $testarray[$key]->id = $key; $testarray[$key]->itemid = $record->itemid; $testarray[$key]->newgradeitem = $record->newgradeitem; $testarray[$key]->userid = $user->id; $testarray[$key]->finalgrade = $record->finalgrade; $testarray[$key]->feedback = $record->feedback; $testarray[$key]->importcode = $testobject->get_importcode(); $testarray[$key]->importer = $USER->id; $testarray[$key]->importonlyfeedback = 0; // Check that the record was inserted into the database. $this->assertEquals($gradeimportvalues, $testarray); } /** * Test preparing a new grade item for import into the gradebook. */ public function test_import_new_grade_item() { global $DB; $this->setAdminUser(); $this->csv_load($this->oktext); $columns = $this->columns; // The assignment is item 6. $key = 6; $testobject = new \phpunit_gradeimport_csv_load_data(); // Key for this assessment. $this->csvimport->init(); $testarray = array(); while ($line = $this->csvimport->next()) { $testarray[] = $testobject->test_import_new_grade_item($columns, $key, $line[$key]); } // Query the database and check how many results were inserted. $newgradeimportitems = $DB->get_records('grade_import_newitem'); $this->assertEquals(count($testarray), count($newgradeimportitems)); } /** * Data provider for \gradeimport_csv_load_data_testcase::test_check_user_exists(). * * @return array */ public function check_user_exists_provider() { return [ 'Fetch by email' => [ 'email', 's1@example.com', true ], 'Fetch by email, different case' => [ 'email', 'S1@EXAMPLE.COM', true ], 'Fetch data using a non-existent email' => [ 'email', 's2@example.com', false ], 'Multiple accounts with the same email' => [ 'email', 's1@example.com', false, 1 ], 'Fetch data using a valid user ID' => [ 'id', true, true ], 'Fetch data using a non-existent user ID' => [ 'id', false, false ], 'Fetch data using a valid username' => [ 'username', 's1', true ], 'Fetch data using a valid username, different case' => [ 'username', 'S1', true ], 'Fetch data using an invalid username' => [ 'username', 's2', false ], 'Fetch data using a valid ID Number' => [ 'idnumber', 's1', true ], 'Fetch data using an invalid ID Number' => [ 'idnumber', 's2', false ], ]; } /** * Check that the user matches a user in the system. * * @dataProvider check_user_exists_provider * @param string $field The field to use for the query. * @param string|boolean $value The field value. When fetching by ID, set true to fetch valid user ID, false otherwise. * @param boolean $successexpected Whether we expect for a user to be found or not. * @param int $allowaccountssameemail Value for $CFG->allowaccountssameemail */ public function test_check_user_exists($field, $value, $successexpected, $allowaccountssameemail = 0) { $this->resetAfterTest(); $generator = $this->getDataGenerator(); // Need to add one of the users into the system. $user = $generator->create_user([ 'firstname' => 'Anne', 'lastname' => 'Able', 'email' => 's1@example.com', 'idnumber' => 's1', 'username' => 's1', ]); if ($allowaccountssameemail) { // Create another user with the same email address. $generator->create_user(['email' => 's1@example.com']); } // Since the data provider can't know what user ID to use, do a special handling for ID field tests. if ($field === 'id') { if ($value) { // Test for fetching data using a valid user ID. Use the generated user's ID. $value = $user->id; } else { // Test for fetching data using a non-existent user ID. $value = $user->id + 1; } } $userfields = [ 'field' => $field, 'label' => 'Field label: ' . $field ]; $testobject = new \phpunit_gradeimport_csv_load_data(); // Check whether the user exists. If so, then the user id is returned. Otherwise, it returns null. $userid = $testobject->test_check_user_exists($value, $userfields); if ($successexpected) { // Check that the user id returned matches with the user that we created. $this->assertEquals($user->id, $userid); // Check that there are no errors. $this->assertEmpty($testobject->get_gradebookerrors()); } else { // Check that the userid is null. $this->assertNull($userid); // Check that expected error message and actual message match. $gradebookerrors = $testobject->get_gradebookerrors(); $mappingobject = (object)[ 'field' => $userfields['label'], 'value' => $value, ]; if ($allowaccountssameemail) { $expectederrormessage = get_string('usermappingerrormultipleusersfound', 'grades', $mappingobject); } else { $expectederrormessage = get_string('usermappingerror', 'grades', $mappingobject); } $this->assertEquals($expectederrormessage, $gradebookerrors[0]); } } /** * Test preparing feedback for inserting / updating into the gradebook. */ public function test_create_feedback() { $testarray = $this->csv_load($this->oktext); $testobject = new \phpunit_gradeimport_csv_load_data(); // Try to insert some feedback for an assessment. $feedback = $testobject->test_create_feedback($this->courseid, 1, $testarray[0][7]); // Expected result. $expectedfeedback = array('itemid' => 1, 'feedback' => $testarray[0][7]); $this->assertEquals((array)$feedback, $expectedfeedback); } /** * Test preparing grade_items for upgrading into the gradebook. */ public function test_update_grade_item() { $testarray = $this->csv_load($this->oktext); $testobject = new \phpunit_gradeimport_csv_load_data(); // We're not using scales so no to this option. $verbosescales = 0; // Map and key are to retrieve the grade_item that we are updating. $map = array(1); $key = 0; // We return the new grade array for saving. $newgrades = $testobject->test_update_grade_item($this->courseid, $map, $key, $verbosescales, $testarray[0][6]); $expectedresult = array(); $expectedresult[0] = new \stdClass(); $expectedresult[0]->itemid = 1; $expectedresult[0]->finalgrade = $testarray[0][6]; $this->assertEquals($newgrades, $expectedresult); // Try sending a bad grade value (A letter instead of a float / int). $newgrades = $testobject->test_update_grade_item($this->courseid, $map, $key, $verbosescales, 'A'); // The $newgrades variable should be null. $this->assertNull($newgrades); $expectederrormessage = get_string('badgrade', 'grades'); // Check that the error message is what we expect. $gradebookerrors = $testobject->get_gradebookerrors(); $this->assertEquals($expectederrormessage, $gradebookerrors[0]); } /** * Test importing data and mapping it with items in the course. */ public function test_map_user_data_with_value() { // Need to add one of the users into the system. $user = new \stdClass(); $user->firstname = 'Anne'; $user->lastname = 'Able'; $user->email = 'student7@example.com'; $userdetail = $this->getDataGenerator()->create_user($user); $testarray = $this->csv_load($this->oktext); $testobject = new \phpunit_gradeimport_csv_load_data(); // We're not using scales so no to this option. $verbosescales = 0; // Map and key are to retrieve the grade_item that we are updating. $map = array(1); $key = 0; // Test new user mapping. This should return the user id if there were no problems. $userid = $testobject->test_map_user_data_with_value('useremail', $testarray[0][5], $this->columns, $map, $key, $this->courseid, $map[$key], $verbosescales); $this->assertEquals($userid, $userdetail->id); $newgrades = $testobject->test_map_user_data_with_value('new', $testarray[0][6], $this->columns, $map, $key, $this->courseid, $map[$key], $verbosescales); // Check that the final grade is the same as the one inserted. $this->assertEquals($testarray[0][6], $newgrades[0]->finalgrade); $newgrades = $testobject->test_map_user_data_with_value('new', $testarray[0][8], $this->columns, $map, $key, $this->courseid, $map[$key], $verbosescales); // Check that the final grade is the same as the one inserted. // The testobject should now contain 2 new grade items. $this->assertEquals(2, count($newgrades)); // Because this grade item is empty, the value for final grade should be null. $this->assertNull($newgrades[1]->finalgrade); $feedback = $testobject->test_map_user_data_with_value('feedback', $testarray[0][7], $this->columns, $map, $key, $this->courseid, $map[$key], $verbosescales); // Expected result. $resultarray = array(); $resultarray[0] = new \stdClass(); $resultarray[0]->itemid = 1; $resultarray[0]->feedback = $testarray[0][7]; $this->assertEquals($feedback, $resultarray); // Default behaviour (update a grade item). $newgrades = $testobject->test_map_user_data_with_value('default', $testarray[0][6], $this->columns, $map, $key, $this->courseid, $map[$key], $verbosescales); $this->assertEquals($testarray[0][6], $newgrades[0]->finalgrade); } /** * Test importing data into the gradebook. */ public function test_prepare_import_grade_data() { global $DB; // Need to add one of the users into the system. $user = new \stdClass(); $user->firstname = 'Anne'; $user->lastname = 'Able'; $user->email = 'student7@example.com'; // Insert user 1. $this->getDataGenerator()->create_user($user); $user = new \stdClass(); $user->firstname = 'Bobby'; $user->lastname = 'Bunce'; $user->email = 'student5@example.com'; // Insert user 2. $this->getDataGenerator()->create_user($user); $this->csv_load($this->oktext); $importcode = 007; $verbosescales = 0; // Form data object. $formdata = new \stdClass(); $formdata->mapfrom = 5; $formdata->mapto = 'useremail'; $formdata->mapping_0 = 0; $formdata->mapping_1 = 0; $formdata->mapping_2 = 0; $formdata->mapping_3 = 0; $formdata->mapping_4 = 0; $formdata->mapping_5 = 0; $formdata->mapping_6 = 'new'; $formdata->mapping_7 = 'feedback_2'; $formdata->mapping_8 = 0; $formdata->mapping_9 = 0; $formdata->map = 1; $formdata->id = 2; $formdata->iid = $this->iid; $formdata->importcode = $importcode; $formdata->forceimport = false; // Blam go time. $testobject = new \phpunit_gradeimport_csv_load_data(); $dataloaded = $testobject->prepare_import_grade_data($this->columns, $formdata, $this->csvimport, $this->courseid, '', '', $verbosescales); // If everything inserted properly then this should be true. $this->assertTrue($dataloaded); } /* * Test importing csv data into the gradebook using "Last downloaded from this course" column and force import option. */ public function test_force_import_option () { // Need to add users into the system. $user = new \stdClass(); $user->firstname = 'Anne'; $user->lastname = 'Able'; $user->email = 'student7@example.com'; $user->id_number = 1; $user1 = $this->getDataGenerator()->create_user($user); $user = new \stdClass(); $user->firstname = 'Bobby'; $user->lastname = 'Bunce'; $user->email = 'student5@example.com'; $user->id_number = 2; $user2 = $this->getDataGenerator()->create_user($user); // Create a new grade item. $params = array( 'itemtype' => 'manual', 'itemname' => 'Grade item 1', 'gradetype' => GRADE_TYPE_VALUE, 'courseid' => $this->courseid ); $gradeitem = new \grade_item($params, false); $gradeitemid = $gradeitem->insert(); $importcode = 001; $verbosescales = 0; // Form data object. $formdata = new \stdClass(); $formdata->mapfrom = 5; $formdata->mapto = 'useremail'; $formdata->mapping_0 = 0; $formdata->mapping_1 = 0; $formdata->mapping_2 = 0; $formdata->mapping_3 = 0; $formdata->mapping_4 = 0; $formdata->mapping_5 = 0; $formdata->mapping_6 = $gradeitemid; $formdata->mapping_7 = 'feedback_2'; $formdata->mapping_8 = 0; $formdata->mapping_9 = 0; $formdata->map = 1; $formdata->id = 2; $formdata->iid = $this->iid; $formdata->importcode = $importcode; $formdata->forceimport = false; // Add last download from this course column to csv content. $exportdate = time(); $newcsvdata = str_replace('{exportdate}', $exportdate, $this->csvtext); $this->csv_load($newcsvdata); $testobject = new \phpunit_gradeimport_csv_load_data(); $dataloaded = $testobject->prepare_import_grade_data($this->columns, $formdata, $this->csvimport, $this->courseid, '', '', $verbosescales); $this->assertTrue($dataloaded); // We must update the last modified date. grade_import_commit($this->courseid, $importcode, false, false); // Test using force import disabled and a date in the past. $pastdate = strtotime('-1 day', time()); $newcsvdata = str_replace('{exportdate}', $pastdate, $this->csvtext); $this->csv_load($newcsvdata); $testobject = new \phpunit_gradeimport_csv_load_data(); $dataloaded = $testobject->prepare_import_grade_data($this->columns, $formdata, $this->csvimport, $this->courseid, '', '', $verbosescales); $this->assertFalse($dataloaded); $errors = $testobject->get_gradebookerrors(); $this->assertEquals($errors[0], get_string('gradealreadyupdated', 'grades', fullname($user1))); // Test using force import enabled and a date in the past. $formdata->forceimport = true; $testobject = new \phpunit_gradeimport_csv_load_data(); $dataloaded = $testobject->prepare_import_grade_data($this->columns, $formdata, $this->csvimport, $this->courseid, '', '', $verbosescales); $this->assertTrue($dataloaded); // Test importing using an old exported file (2 years ago). $formdata->forceimport = false; $twoyearsago = strtotime('-2 year', time()); $newcsvdata = str_replace('{exportdate}', $twoyearsago, $this->csvtext); $this->csv_load($newcsvdata); $testobject = new \phpunit_gradeimport_csv_load_data(); $dataloaded = $testobject->prepare_import_grade_data($this->columns, $formdata, $this->csvimport, $this->courseid, '', '', $verbosescales); $this->assertFalse($dataloaded); $errors = $testobject->get_gradebookerrors(); $this->assertEquals($errors[0], get_string('invalidgradeexporteddate', 'grades')); // Test importing using invalid exported date. $baddate = '0123A56B89'; $newcsvdata = str_replace('{exportdate}', $baddate, $this->csvtext); $this->csv_load($newcsvdata); $formdata->mapping_6 = $gradeitemid; $testobject = new \phpunit_gradeimport_csv_load_data(); $dataloaded = $testobject->prepare_import_grade_data($this->columns, $formdata, $this->csvimport, $this->courseid, '', '', $verbosescales); $this->assertFalse($dataloaded); $errors = $testobject->get_gradebookerrors(); $this->assertEquals($errors[0], get_string('invalidgradeexporteddate', 'grades')); // Test importing using date in the future. $oneyearahead = strtotime('+1 year', time()); $oldcsv = str_replace('{exportdate}', $oneyearahead, $this->csvtext); $this->csv_load($oldcsv); $formdata->mapping_6 = $gradeitemid; $testobject = new \phpunit_gradeimport_csv_load_data(); $dataloaded = $testobject->prepare_import_grade_data($this->columns, $formdata, $this->csvimport, $this->courseid, '', '', $verbosescales); $this->assertFalse($dataloaded); $errors = $testobject->get_gradebookerrors(); $this->assertEquals($errors[0], get_string('invalidgradeexporteddate', 'grades')); } } import/csv/tests/fixtures/phpunit_gradeimport_csv_load_data.php 0000604 00000010712 15062070557 0021330 0 ustar 00 <?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/>. require_once($CFG->dirroot . '/grade/import/csv/classes/load_data.php'); require_once($CFG->dirroot . '/grade/import/lib.php'); /** * Class to open up private methods in gradeimport_csv_load_data(). */ class phpunit_gradeimport_csv_load_data extends gradeimport_csv_load_data { /** * Method to open up the appropriate method for unit testing. * * @param object $record * @param int $studentid */ public function test_insert_grade_record($record, $studentid) { $this->importcode = 00001; $this->insert_grade_record($record, $studentid); } /** * Method to open up the appropriate method for unit testing. */ public function get_importcode() { return $this->importcode; } /** * Method to open up the appropriate method for unit testing. * * @param array $header The column headers from the CSV file. * @param int $key Current row identifier. * @param string $value The value for this row (final grade). * @return array new grades that are ready for commiting to the gradebook. */ public function test_import_new_grade_item($header, $key, $value) { $this->newgradeitems = null; $this->importcode = 00001; return $this->import_new_grade_item($header, $key, $value); } /** * Method to open up the appropriate method for unit testing. * * @param string $value The value, from the csv file, being mapped to identify the user. * @param array $userfields Contains the field and label being mapped from. * @return int Returns the user ID if it exists, otherwise null. */ public function test_check_user_exists($value, $userfields) { return $this->check_user_exists($value, $userfields); } /** * Method to open up the appropriate method for unit testing. * * @param int $courseid The course ID. * @param int $itemid The ID of the grade item that the feedback relates to. * @param string $value The actual feedback being imported. * @return object Creates a feedback object with the item ID and the feedback value. */ public function test_create_feedback($courseid, $itemid, $value) { return $this->create_feedback($courseid, $itemid, $value); } /** * Method to open up the appropriate method for unit testing. */ public function test_update_grade_item($courseid, $map, $key, $verbosescales, $value) { return $this->update_grade_item($courseid, $map, $key, $verbosescales, $value); } /** * Method to open up the appropriate method for unit testing. * * @param int $courseid The course ID. * @param array $map Mapping information provided by the user. * @param int $key The line that we are currently working on. * @param bool $verbosescales Form setting for grading with scales. * @param string $value The grade value . * @return array grades to be updated. */ public function test_map_user_data_with_value($mappingidentifier, $value, $header, $map, $key, $courseid, $feedbackgradeid, $verbosescales) { // Set an import code. $this->importcode = 00001; $this->map_user_data_with_value($mappingidentifier, $value, $header, $map, $key, $courseid, $feedbackgradeid, $verbosescales); switch ($mappingidentifier) { case 'userid': case 'useridnumber': case 'useremail': case 'username': return $this->studentid; break; case 'new': return $this->newgrades; break; case 'feedback': return $this->newfeedbacks; break; default: return $this->newgrades; break; } } } import/index.php 0000604 00000004533 15062070557 0007706 0 ustar 00 <?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/>. /** * Redirects the user to a default grades import plugin page. * * @package core_grades * @copyright 2021 Mihail Geshoski <mihail@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once(__DIR__ . '/../../config.php'); // Course ID. $courseid = required_param('id', PARAM_INT); $PAGE->set_url(new moodle_url('/grade/import/index.php', ['id' => $courseid])); // Basic access checks. if (!$course = $DB->get_record('course', ['id' => $courseid])) { throw new moodle_exception('invalidcourseid', 'error'); } require_login($course); $context = context_course::instance($courseid); require_capability('moodle/grade:import', $context); // Retrieve all grade import plugins the current user can access. $importplugins = array_filter(core_component::get_plugin_list('gradeimport'), static function(string $importplugin) use ($context): bool { return has_capability("gradeimport/{$importplugin}:view", $context); }, ARRAY_FILTER_USE_KEY ); if (!empty($importplugins)) { $importplugin = array_key_first($importplugins); $url = new moodle_url("/grade/import/{$importplugin}/index.php", ['id' => $courseid]); redirect($url); } // Otherwise, output the page with a notification stating that there are no available grade import options. $PAGE->set_title(get_string('import', 'grades')); $PAGE->set_pagelayout('incourse'); $PAGE->set_heading($course->fullname); $PAGE->set_pagetype('course-view-' . $course->format); echo $OUTPUT->header(); echo $OUTPUT->heading(get_string('import', 'grades')); echo html_writer::div($OUTPUT->notification(get_string('nogradeimport', 'grades'), 'error'), 'mt-3'); echo $OUTPUT->footer(); import/key_form.php 0000604 00000003702 15062070557 0010407 0 ustar 00 <?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/>. /** * Grade import key management form. * * @package moodlecore * @copyright 2008 Petr Skoda * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ if (!defined('MOODLE_INTERNAL')) { die('Direct access to this script is forbidden.'); /// It must be included from a Moodle page } require_once($CFG->dirroot.'/lib/formslib.php'); class key_form extends moodleform { // Define the form function definition () { global $USER, $CFG, $COURSE; $mform =& $this->_form; $mform->addElement('static', 'value', get_string('keyvalue', 'userkey')); $mform->addElement('text', 'iprestriction', get_string('keyiprestriction', 'userkey'), array('size'=>80)); $mform->addElement('date_time_selector', 'validuntil', get_string('keyvaliduntil', 'userkey'), array('optional'=>true)); $mform->addHelpButton('iprestriction', 'keyiprestriction', 'userkey'); $mform->addHelpButton('validuntil', 'keyvaliduntil', 'userkey'); $mform->setType('iprestriction', PARAM_RAW_TRIMMED); $mform->addElement('hidden','id'); $mform->setType('id', PARAM_INT); $mform->addElement('hidden','courseid'); $mform->setType('courseid', PARAM_INT); $this->add_action_buttons(); } } import/grade_import_form.php 0000604 00000017271 15062070557 0012301 0 ustar 00 <?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/>. if (!defined('MOODLE_INTERNAL')) { die('Direct access to this script is forbidden.'); /// It must be included from a Moodle page } require_once $CFG->libdir.'/formslib.php'; require_once($CFG->libdir.'/gradelib.php'); class grade_import_form extends moodleform { function definition (){ global $COURSE; $mform =& $this->_form; if (isset($this->_customdata)) { // hardcoding plugin names here is hacky $features = $this->_customdata; } else { $features = array(); } // course id needs to be passed for auth purposes $mform->addElement('hidden', 'id', optional_param('id', 0, PARAM_INT)); $mform->setType('id', PARAM_INT); $mform->addElement('header', 'general', get_string('importfile', 'grades')); // Restrict the possible upload file types. if (!empty($features['acceptedtypes'])) { $acceptedtypes = $features['acceptedtypes']; } else { $acceptedtypes = '*'; } // File upload. $mform->addElement('filepicker', 'userfile', get_string('file'), null, array('accepted_types' => $acceptedtypes)); $mform->addRule('userfile', null, 'required'); $encodings = core_text::get_encodings(); $mform->addElement('select', 'encoding', get_string('encoding', 'grades'), $encodings); $mform->addHelpButton('encoding', 'encoding', 'grades'); if (!empty($features['includeseparator'])) { $radio = array(); $radio[] = $mform->createElement('radio', 'separator', null, get_string('septab', 'grades'), 'tab'); $radio[] = $mform->createElement('radio', 'separator', null, get_string('sepcomma', 'grades'), 'comma'); $radio[] = $mform->createElement('radio', 'separator', null, get_string('sepcolon', 'grades'), 'colon'); $radio[] = $mform->createElement('radio', 'separator', null, get_string('sepsemicolon', 'grades'), 'semicolon'); $mform->addGroup($radio, 'separator', get_string('separator', 'grades'), ' ', false); $mform->addHelpButton('separator', 'separator', 'grades'); $mform->setDefault('separator', 'comma'); } if (!empty($features['verbosescales'])) { $options = array(1=>get_string('yes'), 0=>get_string('no')); $mform->addElement('select', 'verbosescales', get_string('verbosescales', 'grades'), $options); $mform->addHelpButton('verbosescales', 'verbosescales', 'grades'); } $options = array('10'=>10, '20'=>20, '100'=>100, '1000'=>1000, '100000'=>100000); $mform->addElement('select', 'previewrows', get_string('rowpreviewnum', 'grades'), $options); // TODO: localize $mform->addHelpButton('previewrows', 'rowpreviewnum', 'grades'); $mform->setType('previewrows', PARAM_INT); $mform->addElement('checkbox', 'forceimport', get_string('forceimport', 'grades')); $mform->addHelpButton('forceimport', 'forceimport', 'grades'); $mform->setDefault('forceimport', false); $mform->setType('forceimport', PARAM_BOOL); $mform->addElement('hidden', 'groupid', groups_get_course_group($COURSE)); $mform->setType('groupid', PARAM_INT); $this->add_sticky_action_buttons(false, get_string('uploadgrades', 'grades')); } } class grade_import_mapping_form extends moodleform { function definition () { global $CFG, $COURSE; $mform =& $this->_form; // this is an array of headers $header = $this->_customdata['header']; // course id $mform->addElement('header', 'general', get_string('identifier', 'grades')); $mapfromoptions = array(); if ($header) { foreach ($header as $i=>$h) { $mapfromoptions[$i] = s($h); } } $mform->addElement('select', 'mapfrom', get_string('mapfrom', 'grades'), $mapfromoptions); $mform->addHelpButton('mapfrom', 'mapfrom', 'grades'); $maptooptions = array( 'userid' => get_string('userid', 'grades'), 'username' => get_string('username'), 'useridnumber' => get_string('idnumber'), 'useremail' => get_string('email'), '0' => get_string('ignore', 'grades') ); $mform->addElement('select', 'mapto', get_string('mapto', 'grades'), $maptooptions); $mform->addHelpButton('mapto', 'mapto', 'grades'); $mform->addElement('header', 'general_map', get_string('mappings', 'grades')); $mform->addHelpButton('general_map', 'mappings', 'grades'); // Add a feedback option. $feedbacks = []; $gradeitems = (array) $this->_customdata['gradeitems']; foreach ($gradeitems as $itemid => $itemname) { $feedbacks['feedback_'.$itemid] = get_string('feedbackforgradeitems', 'grades', $itemname); } if ($header) { $i = 0; // index foreach ($header as $h) { $h = trim($h); // This is what each header maps to. $headermapsto = array( get_string('others', 'grades') => array( '0' => get_string('ignore', 'grades'), 'new' => get_string('newitem', 'grades') ), get_string('gradeitems', 'grades') => $gradeitems, get_string('feedbacks', 'grades') => $feedbacks ); $mform->addElement('selectgroups', 'mapping_'.$i, s($h), $headermapsto); $i++; } } // course id needs to be passed for auth purposes $mform->addElement('hidden', 'map', 1); $mform->setType('map', PARAM_INT); $mform->setConstant('map', 1); $mform->addElement('hidden', 'id', $this->_customdata['id']); $mform->setType('id', PARAM_INT); $mform->setConstant('id', $this->_customdata['id']); $mform->addElement('hidden', 'iid', $this->_customdata['iid']); $mform->setType('iid', PARAM_INT); $mform->setConstant('iid', $this->_customdata['iid']); $mform->addElement('hidden', 'importcode', $this->_customdata['importcode']); $mform->setType('importcode', PARAM_FILE); $mform->setConstant('importcode', $this->_customdata['importcode']); $mform->addElement('hidden', 'verbosescales', 1); $mform->setType('verbosescales', PARAM_INT); $mform->setConstant('verbosescales', $this->_customdata['verbosescales']); $mform->addElement('hidden', 'groupid', groups_get_course_group($COURSE)); $mform->setType('groupid', PARAM_INT); $mform->setConstant('groupid', groups_get_course_group($COURSE)); $mform->addElement('hidden', 'forceimport', $this->_customdata['forceimport']); $mform->setType('forceimport', PARAM_BOOL); $mform->setConstant('forceimport', $this->_customdata['forceimport']); $this->add_sticky_action_buttons(false, get_string('uploadgrades', 'grades')); } } import/key.php 0000604 00000011405 15062070557 0007363 0 ustar 00 <?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/>. /** * Import key management. * * @package moodlecore * @copyright 2008 Nicolas Connault * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once('../../config.php'); require_once('key_form.php'); require_once($CFG->dirroot.'/grade/lib.php'); /// get url variables $courseid = optional_param('courseid', 0, PARAM_INT); $id = optional_param('id', 0, PARAM_INT); $delete = optional_param('delete', 0, PARAM_BOOL); $confirm = optional_param('confirm', 0, PARAM_BOOL); $url = new moodle_url('/grade/import/key.php', ['courseid' => $courseid, 'id' => $id]); $PAGE->set_url($url); if ($id) { if (!$key = $DB->get_record('user_private_key', array('id' => $id))) { throw new \moodle_exception('invalidgroupid'); } if (empty($courseid)) { $courseid = $key->instance; } else if ($courseid != $key->instance) { throw new \moodle_exception('invalidcourseid'); } if (!$course = $DB->get_record('course', array('id' => $courseid))) { throw new \moodle_exception('invalidcourseid'); } } else { if (!$course = $DB->get_record('course', array('id' => $courseid))) { throw new \moodle_exception('invalidcourseid'); } $key = new stdClass(); } $key->courseid = $course->id; require_login($course); $context = context_course::instance($course->id); require_capability('moodle/grade:import', $context); // Check if the user has at least one grade publishing capability. $plugins = grade_helper::get_plugins_import($course->id); if (!isset($plugins['keymanager'])) { throw new \moodle_exception('nopermissions'); } // extra security check if (!empty($key->userid) and $USER->id != $key->userid) { throw new \moodle_exception('notownerofkey'); } $returnurl = $CFG->wwwroot.'/grade/import/keymanager.php?id='.$course->id; $strkeys = get_string('keymanager', 'userkey'); $strimportgrades = get_string('import', 'grades'); $PAGE->navbar->add($strimportgrades, new moodle_url(new moodle_url('/grade/import/index.php', ['id' => $courseid]))); $PAGE->navbar->add($strkeys, new moodle_url('/grade/import/keymanager.php', ['id' => $courseid])); if ($id and $delete) { if (!$confirm) { $PAGE->set_title(get_string('deleteselectedkey')); $PAGE->set_heading($course->fullname); $PAGE->set_secondary_active_tab('grades'); $PAGE->navbar->add(get_string('deleteuserkey', 'userkey')); echo $OUTPUT->header(); $optionsyes = array('id'=>$id, 'delete'=>1, 'courseid'=>$courseid, 'sesskey'=>sesskey(), 'confirm'=>1); $optionsno = array('id'=>$courseid); $formcontinue = new single_button(new moodle_url('key.php', $optionsyes), get_string('yes'), 'get'); $formcancel = new single_button(new moodle_url('keymanager.php', $optionsno), get_string('no'), 'get'); echo $OUTPUT->confirm(get_string('deletekeyconfirm', 'userkey', $key->value), $formcontinue, $formcancel); echo $OUTPUT->footer(); die; } else if (confirm_sesskey()){ $DB->delete_records('user_private_key', array('id' => $id)); redirect('keymanager.php?id='.$course->id); } } /// First create the form $editform = new key_form(); $editform->set_data($key); if ($editform->is_cancelled()) { redirect($returnurl); } elseif ($data = $editform->get_data()) { if ($data->id) { $record = new stdClass(); $record->id = $data->id; $record->iprestriction = $data->iprestriction; $record->validuntil = $data->validuntil; $DB->update_record('user_private_key', $record); } else { create_user_key('grade/import', $USER->id, $course->id, $data->iprestriction, $data->validuntil); } redirect($returnurl); } if ($id) { $strheading = get_string('edituserkey', 'userkey'); } else { $strheading = get_string('createuserkey', 'userkey'); } $PAGE->navbar->add($strheading); /// Print header $PAGE->set_title($strkeys); $PAGE->set_heading($course->fullname); $PAGE->set_secondary_active_tab('grades'); echo $OUTPUT->header(); echo $OUTPUT->heading($strheading); $editform->display(); echo $OUTPUT->footer(); import/keymanager.php 0000604 00000005720 15062070557 0010721 0 ustar 00 <?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/>. /** * Grade import key management page. * * @package moodlecore * @copyright 2008 Petr Skoda * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once(__DIR__.'/../../config.php'); require_once($CFG->dirroot.'/grade/lib.php'); $id = required_param('id', PARAM_INT); // course id $PAGE->set_url('/grade/import/keymanager.php', array('id' => $id)); if (!$course = $DB->get_record('course', array('id'=>$id))) { throw new \moodle_exception('invalidcourseid'); } require_login($course); $context = context_course::instance($id); require_capability('moodle/grade:import', $context); // Check if the user has at least one grade publishing capability. $plugins = grade_helper::get_plugins_import($course->id); if (!isset($plugins['keymanager'])) { throw new \moodle_exception('nopermissions'); } $actionbar = new \core_grades\output\import_key_manager_action_bar($context); print_grade_page_head($course->id, 'import', 'keymanager', get_string('keymanager', 'grades'), false, false, true, 'importcsv', 'grades', null, $actionbar); $stredit = get_string('edit'); $strdelete = get_string('delete'); $data = array(); $params = array($course->id, $USER->id); if ($keys = $DB->get_records_select('user_private_key', "script='grade/import' AND instance=? AND userid=?", $params)) { foreach($keys as $key) { $line = array(); $line[0] = format_string($key->value); $line[1] = $key->iprestriction; $line[2] = empty($key->validuntil) ? get_string('always') : userdate($key->validuntil); $url = new moodle_url('key.php', array('id' => $key->id)); $buttons = $OUTPUT->action_icon($url, new pix_icon('t/edit', $stredit)); $url->param('delete', 1); $url->param('sesskey', sesskey()); $buttons .= $OUTPUT->action_icon($url, new pix_icon('t/delete', $strdelete)); $line[3] = $buttons; $data[] = $line; } } $table = new html_table(); $table->head = array(get_string('keyvalue', 'userkey'), get_string('keyiprestriction', 'userkey'), get_string('keyvaliduntil', 'userkey'), $stredit); $table->size = array('50%', '30%', '10%', '10%'); $table->align = array('left', 'left', 'left', 'center'); $table->width = '90%'; $table->data = $data; echo html_writer::table($table); echo $OUTPUT->footer(); import/xml/lib.php 0000604 00000010740 15062070557 0010142 0 ustar 00 <?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/>. require_once $CFG->libdir.'/gradelib.php'; require_once($CFG->libdir.'/xmlize.php'); require_once $CFG->dirroot.'/grade/lib.php'; require_once $CFG->dirroot.'/grade/import/lib.php'; function import_xml_grades($text, $course, &$error) { global $USER, $DB; $importcode = get_new_importcode(); $status = true; $content = xmlize($text); if (!empty($content['results']['#']['result'])) { $results = $content['results']['#']['result']; foreach ($results as $i => $result) { $gradeidnumber = $result['#']['assignment'][0]['#']; if (!$grade_items = grade_item::fetch_all(array('idnumber'=>$gradeidnumber, 'courseid'=>$course->id))) { // gradeitem does not exist // no data in temp table so far, abort $status = false; $error = get_string('errincorrectgradeidnumber', 'gradeimport_xml', $gradeidnumber); break; } else if (count($grade_items) != 1) { $status = false; $error = get_string('errduplicategradeidnumber', 'gradeimport_xml', $gradeidnumber); break; } else { $grade_item = reset($grade_items); } // grade item locked, abort if ($grade_item->is_locked()) { $status = false; $error = get_string('gradeitemlocked', 'grades'); break; } // check if user exist and convert idnumber to user id $useridnumber = $result['#']['student'][0]['#']; if (!$user = $DB->get_record('user', array('idnumber' =>$useridnumber))) { // no user found, abort $status = false; $error = get_string('errincorrectuseridnumber', 'gradeimport_xml', $useridnumber); break; } // check if grade_grade is locked and if so, abort if ($grade_grade = new grade_grade(array('itemid'=>$grade_item->id, 'userid'=>$user->id))) { $grade_grade->grade_item =& $grade_item; if ($grade_grade->is_locked()) { // individual grade locked, abort $status = false; $error = get_string('gradelocked', 'grades'); break; } } $newgrade = new stdClass(); $newgrade->itemid = $grade_item->id; $newgrade->userid = $user->id; $newgrade->importcode = $importcode; $newgrade->importer = $USER->id; // check grade value exists and is a numeric grade if (isset($result['#']['score'][0]['#']) && $result['#']['score'][0]['#'] !== '-') { if (is_numeric($result['#']['score'][0]['#'])) { $newgrade->finalgrade = $result['#']['score'][0]['#']; } else { $status = false; $error = get_string('badgrade', 'grades'); break; } } else { $newgrade->finalgrade = NULL; } // check grade feedback exists if (isset($result['#']['feedback'][0]['#'])) { $newgrade->feedback = $result['#']['feedback'][0]['#']; } else { $newgrade->feedback = NULL; } // insert this grade into a temp table $DB->insert_record('grade_import_values', $newgrade); } } else { // no results section found in xml, // assuming bad format, abort import $status = false; $error = get_string('errbadxmlformat', 'gradeimport_xml'); } if ($status) { return $importcode; } else { import_cleanup($importcode); return false; } } import/xml/fetch.php 0000604 00000002522 15062070557 0010464 0 ustar 00 <?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/>. define('NO_MOODLE_COOKIES', true); // session not used here require_once '../../../config.php'; $id = required_param('id', PARAM_INT); // course id if (!$course = $DB->get_record('course', array('id'=>$id))) { throw new \moodle_exception('invalidcourseid'); } require_user_key_login('grade/import', $id); // we want different keys for each course if (empty($CFG->gradepublishing)) { throw new \moodle_exception('gradepubdisable'); } $context = context_course::instance($id); require_capability('gradeimport/xml:publish', $context); // use the same page parameters as import.php and append &key=sdhakjsahdksahdkjsahksadjksahdkjsadhksa require 'import.php'; import/xml/classes/privacy/provider.php 0000604 00000002767 15062070557 0014352 0 ustar 00 <?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/>. /** * Privacy Subsystem implementation for gradeimport_xml. * * @package gradeimport_xml * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradeimport_xml\privacy; defined('MOODLE_INTERNAL') || die(); /** * Privacy Subsystem for gradeimport_xml implementing null_provider. * * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class provider implements \core_privacy\local\metadata\null_provider { /** * Get the language string identifier with the component's language * file to explain why this plugin stores no data. * * @return string */ public static function get_reason() : string { return 'privacy:metadata'; } } import/xml/db/access.php 0000604 00000002537 15062070557 0011227 0 ustar 00 <?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/>. /** * Capabilities gradeimport plugin. * * @package gradeimport_xml * @copyright 2007 Martin Dougiamas * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); $capabilities = array( 'gradeimport/xml:view' => array( 'captype' => 'write', 'contextlevel' => CONTEXT_COURSE, 'archetypes' => array( 'editingteacher' => CAP_ALLOW, 'manager' => CAP_ALLOW ) ), 'gradeimport/xml:publish' => array( 'captype' => 'write', 'contextlevel' => CONTEXT_COURSE, 'archetypes' => array( 'manager' => CAP_ALLOW ) ) ); import/xml/index.php 0000604 00000007444 15062070557 0010512 0 ustar 00 <?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/>. require_once('../../../config.php'); require_once($CFG->libdir . '/gradelib.php'); require_once($CFG->dirroot . '/grade/lib.php'); require_once($CFG->dirroot . '/grade/import/xml/lib.php'); require_once($CFG->dirroot . '/grade/import/xml/grade_import_form.php'); $id = required_param('id', PARAM_INT); // course id $PAGE->set_url(new moodle_url('/grade/import/xml/index.php', array('id'=>$id))); $PAGE->set_pagelayout('admin'); if (!$course = $DB->get_record('course', array('id'=>$id))) { throw new \moodle_exception('invalidcourseid'); } require_login($course); $context = context_course::instance($id); require_capability('moodle/grade:import', $context); require_capability('gradeimport/xml:view', $context); // print header $strgrades = get_string('grades', 'grades'); $actionstr = get_string('pluginname', 'gradeimport_xml'); if (!empty($CFG->gradepublishing)) { $CFG->gradepublishing = has_capability('gradeimport/xml:publish', $context); } $mform = new grade_import_form(null, array('acceptedtypes' => array('.xml'))); if ($data = $mform->get_data()) { // Large files are likely to take their time and memory. Let PHP know // that we'll take longer, and that the process should be recycled soon // to free up memory. core_php_time_limit::raise(); raise_memory_limit(MEMORY_EXTRA); if ($text = $mform->get_file_content('userfile')) { print_grade_page_head($COURSE->id, 'import', 'xml', get_string('importxml', 'grades'), false, false, true, 'importxml', 'gradeimport_xml'); $error = ''; $importcode = import_xml_grades($text, $course, $error); if ($importcode) { grade_import_commit($id, $importcode, $data->feedback, true); echo $OUTPUT->footer(); die; } else { echo $OUTPUT->notification($error); echo $OUTPUT->continue_button($CFG->wwwroot.'/grade/index.php?id='.$course->id); echo $OUTPUT->footer(); die; } } else if (empty($data->key)) { redirect('import.php?id='.$id.'&feedback='.(int)($data->feedback).'&url='.urlencode($data->url)); } else { if ($data->key == 1) { $data->key = create_user_key('grade/import', $USER->id, $course->id, $data->iprestriction, $data->validuntil); } print_grade_page_head($COURSE->id, 'import', 'xml', get_string('importxml', 'grades'), false, false, true, 'importxml', 'gradeimport_xml'); echo '<div class="gradeexportlink">'; $link = $CFG->wwwroot.'/grade/import/xml/fetch.php?id='.$id.'&feedback='.(int)($data->feedback).'&url='.urlencode($data->url).'&key='.$data->key; echo get_string('import', 'grades').': <a href="'.$link.'">'.$link.'</a>'; echo '</div>'; echo $OUTPUT->footer(); die; } } $actionbar = new \core_grades\output\import_action_bar($context, null, 'xml'); print_grade_page_head($COURSE->id, 'import', 'xml', get_string('importxml', 'grades'), false, false, true, 'importxml', 'gradeimport_xml', null, $actionbar); $mform->display(); echo $OUTPUT->footer(); import/xml/lang/en/gradeimport_xml.php 0000604 00000004461 15062070557 0014117 0 ustar 00 <?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/>. /** * Strings for component 'gradeimport_xml', language 'en', branch 'MOODLE_20_STABLE' * * @package gradeimport_xml * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ $string['errbadxmlformat'] = 'Error - bad XML format'; $string['errduplicategradeidnumber'] = 'Error - there are two grade items with idnumber \'{$a}\' in this course. This should be impossible.'; $string['errduplicateidnumber'] = 'Error - duplicate idnumber'; $string['errincorrectgradeidnumber'] = 'Error - idnumber \'{$a}\' from the import file does not match any grade item.'; $string['errincorrectidnumber'] = 'Error - incorrect idnumber'; $string['errincorrectuseridnumber'] = 'Error - idnumber \'{$a}\' from the import file does not match any user.'; $string['error'] = 'Errors occur'; $string['errorduringimport'] = 'An error occurred when trying to import: {$a}'; $string['fileurl'] = 'Remote file URL'; $string['fileurl_help'] = 'The remote file URL field is for fetching data from a remote server, such as a student information system.'; $string['pluginname'] = 'XML file'; $string['privacy:metadata'] = 'The import grades from XML plugin does not store any personal data.'; $string['xml:publish'] = 'Publish import grades from XML'; $string['xml:view'] = 'Import grades from XML'; $string['importxml'] = 'XML import'; $string['importxml_help'] = 'Grades can be imported via an XML file containing user ID numbers and activity ID numbers. To obtain the correct format, first export some grades to XML file then view the file.'; $string['importxml_link'] = 'grade/import/xml/index'; import/xml/grade_import_form.php 0000604 00000011676 15062070557 0013104 0 ustar 00 <?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/>. if (!defined('MOODLE_INTERNAL')) { die('Direct access to this script is forbidden.'); /// It must be included from a Moodle page } require_once $CFG->libdir.'/formslib.php'; class grade_import_form extends moodleform { function definition () { global $COURSE, $USER, $CFG, $DB; $mform =& $this->_form; if (isset($this->_customdata)) { $features = $this->_customdata; } else { $features = array(); } // course id needs to be passed for auth purposes $mform->addElement('hidden', 'id', optional_param('id', 0, PARAM_INT)); $mform->setType('id', PARAM_INT); $mform->addElement('header', 'general', get_string('importfile', 'grades')); $mform->addElement('advcheckbox', 'feedback', get_string('importfeedback', 'grades')); $mform->setDefault('feedback', 0); // Restrict the possible upload file types. if (!empty($features['acceptedtypes'])) { $acceptedtypes = $features['acceptedtypes']; } else { $acceptedtypes = '*'; } // File upload. $mform->addElement('filepicker', 'userfile', get_string('file'), null, array('accepted_types' => $acceptedtypes)); $mform->disabledIf('userfile', 'url', 'noteq', ''); $mform->addElement('text', 'url', get_string('fileurl', 'gradeimport_xml'), 'size="80"'); $mform->setType('url', PARAM_URL); $mform->disabledIf('url', 'userfile', 'noteq', ''); $mform->addHelpButton('url', 'fileurl', 'gradeimport_xml'); if (!empty($CFG->gradepublishing)) { $mform->addElement('header', 'publishing', get_string('publishing', 'grades')); $options = array(get_string('nopublish', 'grades'), get_string('createnewkey', 'userkey')); $keys = $DB->get_records_select('user_private_key', "script='grade/import' AND instance=? AND userid=?", array($COURSE->id, $USER->id)); if ($keys) { foreach ($keys as $key) { $options[$key->value] = $key->value; // TODO: add more details - ip restriction, valid until ?? } } $mform->addElement('select', 'key', get_string('userkey', 'userkey'), $options); $mform->addHelpButton('key', 'userkey', 'userkey'); $mform->addElement('static', 'keymanagerlink', get_string('keymanager', 'userkey'), '<a href="'.$CFG->wwwroot.'/grade/import/keymanager.php?id='.$COURSE->id.'">'.get_string('keymanager', 'userkey').'</a>'); $mform->addElement('text', 'iprestriction', get_string('keyiprestriction', 'userkey'), array('size'=>80)); $mform->addHelpButton('iprestriction', 'keyiprestriction', 'userkey'); $mform->setDefault('iprestriction', getremoteaddr()); // own IP - just in case somebody does not know what user key is $mform->addElement('date_time_selector', 'validuntil', get_string('keyvaliduntil', 'userkey'), array('optional'=>true)); $mform->addHelpButton('validuntil', 'keyvaliduntil', 'userkey'); $mform->setDefault('validuntil', time()+3600*24*7); // only 1 week default duration - just in case somebody does not know what user key is $mform->disabledIf('iprestriction', 'key', 'noteq', 1); $mform->disabledIf('validuntil', 'key', 'noteq', 1); $mform->disabledIf('iprestriction', 'url', 'eq', ''); $mform->disabledIf('validuntil', 'url', 'eq', ''); $mform->disabledIf('key', 'url', 'eq', ''); } $this->add_sticky_action_buttons(false, get_string('uploadgrades', 'grades')); } function validation($data, $files) { $err = parent::validation($data, $files); if (empty($data['url']) and empty($data['userfile'])) { if (array_key_exists('url', $data)) { $err['url'] = get_string('required'); } if (array_key_exists('userfile', $data)) { $err['userfile'] = get_string('required'); } } else if (array_key_exists('url', $data) and $data['url'] != clean_param($data['url'], PARAM_URL)) { $err['url'] = get_string('error'); } return $err; } } import/xml/version.php 0000604 00000002256 15062070557 0011064 0 ustar 00 <?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/>. /** * Version details * * @package gradeimport * @subpackage xml * @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); $plugin->version = 2023100900; // The current plugin version (Date: YYYYMMDDXX). $plugin->requires = 2023100400; // Requires this Moodle version. $plugin->component = 'gradeimport_xml'; // Full name of the plugin (used for diagnostics) import/xml/import.php 0000604 00000005177 15062070557 0010716 0 ustar 00 <?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/>. require_once '../../../config.php'; require_once 'lib.php'; require_once $CFG->libdir.'/filelib.php'; $gradesurl = required_param('url', PARAM_URL); // only real urls here $id = required_param('id', PARAM_INT); // course id $feedback = optional_param('feedback', 0, PARAM_BOOL); $url = new moodle_url('/grade/import/xml/import.php', array('id' => $id,'url' => $gradesurl)); if ($feedback !== 0) { $url->param('feedback', $feedback); } $PAGE->set_url($url); if (!$course = $DB->get_record('course', array('id'=>$id))) { throw new \moodle_exception('invalidcourseid'); } require_login($course); $context = context_course::instance($id); require_capability('moodle/grade:import', $context); require_capability('gradeimport/xml:view', $context); // Large files are likely to take their time and memory. Let PHP know // that we'll take longer, and that the process should be recycled soon // to free up memory. core_php_time_limit::raise(); raise_memory_limit(MEMORY_EXTRA); $text = download_file_content($gradesurl); if ($text === false) { throw new \moodle_exception('cannotreadfile', 'error', $CFG->wwwroot . '/grade/import/xml/index.php?id=' . $id, $gradesurl); } $error = ''; $importcode = import_xml_grades($text, $course, $error); if ($importcode !== false) { /// commit the code if we are up this far if (defined('USER_KEY_LOGIN')) { if (grade_import_commit($id, $importcode, $feedback, false)) { echo 'ok'; die; } else { throw new \moodle_exception('cannotimportgrade'); // TODO: localize. } } else { print_grade_page_head($course->id, 'import', 'xml', get_string('importxml', 'grades')); grade_import_commit($id, $importcode, $feedback, true); echo $OUTPUT->footer(); die; } } else { throw new \moodle_exception('errorduringimport', 'gradeimport_xml', $CFG->wwwroot . '/grade/import/xml/index.php?id=' . $id, $error); } export/grade_export_form.php 0000604 00000027423 15062070557 0012317 0 ustar 00 <?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/>. if (!defined('MOODLE_INTERNAL')) { die('Direct access to this script is forbidden.'); /// It must be included from a Moodle page } require_once $CFG->libdir.'/formslib.php'; class grade_export_form extends moodleform { function definition() { global $CFG, $COURSE, $USER, $DB; $isdeprecatedui = false; $mform =& $this->_form; if (isset($this->_customdata)) { // hardcoding plugin names here is hacky $features = $this->_customdata; } else { $features = array(); } if (empty($features['simpleui'])) { debugging('Grade export plugin needs updating to support one step exports.', DEBUG_DEVELOPER); } $mform->addElement('header', 'gradeitems', get_string('gradeitemsinc', 'grades')); $mform->setExpanded('gradeitems', true); if (!empty($features['idnumberrequired'])) { $mform->addElement('static', 'idnumberwarning', get_string('useridnumberwarning', 'grades')); } $switch = grade_get_setting($COURSE->id, 'aggregationposition', $CFG->grade_aggregationposition); // Grab the grade_seq for this course $gseq = new grade_seq($COURSE->id, $switch); if ($grade_items = $gseq->items) { $needs_multiselect = false; $canviewhidden = has_capability('moodle/grade:viewhidden', context_course::instance($COURSE->id)); foreach ($grade_items as $grade_item) { // Is the grade_item hidden? If so, can the user see hidden grade_items? if ($grade_item->is_hidden() && !$canviewhidden) { continue; } if (!empty($features['idnumberrequired']) and empty($grade_item->idnumber)) { $mform->addElement('checkbox', 'itemids['.$grade_item->id.']', $grade_item->get_name(), get_string('noidnumber', 'grades')); $mform->hardFreeze('itemids['.$grade_item->id.']'); } else { $mform->addElement('advcheckbox', 'itemids['.$grade_item->id.']', $grade_item->get_name(), null, array('group' => 1)); $mform->setDefault('itemids['.$grade_item->id.']', 1); $needs_multiselect = true; } } if ($needs_multiselect) { $this->add_checkbox_controller(1, null, null, 1); // 1st argument is group name, 2nd is link text, 3rd is attributes and 4th is original value } } $mform->addElement('header', 'options', get_string('exportformatoptions', 'grades')); if (!empty($features['simpleui'])) { $mform->setExpanded('options', false); } $mform->addElement('advcheckbox', 'export_feedback', get_string('exportfeedback', 'grades')); $exportfeedback = isset($CFG->grade_export_exportfeedback) ? $CFG->grade_export_exportfeedback : 0; $mform->setDefault('export_feedback', $exportfeedback); $coursecontext = context_course::instance($COURSE->id); if (has_capability('moodle/course:viewsuspendedusers', $coursecontext)) { $mform->addElement('advcheckbox', 'export_onlyactive', get_string('exportonlyactive', 'grades')); $mform->setType('export_onlyactive', PARAM_BOOL); $mform->setDefault('export_onlyactive', 1); $mform->addHelpButton('export_onlyactive', 'exportonlyactive', 'grades'); } else { $mform->addElement('hidden', 'export_onlyactive', 1); $mform->setType('export_onlyactive', PARAM_BOOL); $mform->setConstant('export_onlyactive', 1); } if (empty($features['simpleui'])) { $options = array('10'=>10, '20'=>20, '100'=>100, '1000'=>1000, '100000'=>100000); $mform->addElement('select', 'previewrows', get_string('previewrows', 'grades'), $options); } if (!empty($features['updategradesonly'])) { $mform->addElement('advcheckbox', 'updatedgradesonly', get_string('updatedgradesonly', 'grades')); } /// selections for decimal points and format, MDL-11667, defaults to site settings, if set //$default_gradedisplaytype = $CFG->grade_export_displaytype; $options = array(GRADE_DISPLAY_TYPE_REAL => get_string('real', 'grades'), GRADE_DISPLAY_TYPE_PERCENTAGE => get_string('percentage', 'grades'), GRADE_DISPLAY_TYPE_LETTER => get_string('letter', 'grades')); /* foreach ($options as $key=>$option) { if ($key == $default_gradedisplaytype) { $options[GRADE_DISPLAY_TYPE_DEFAULT] = get_string('defaultprev', 'grades', $option); break; } } */ if ($features['multipledisplaytypes']) { /* * Using advcheckbox because we need the grade display type (name) as key and grade display type (constant) as value. * The method format_column_name requires the lang file string and the format_grade method requires the constant. */ $checkboxes = array(); $checkboxes[] = $mform->createElement('advcheckbox', 'display[real]', null, get_string('real', 'grades'), null, array(0, GRADE_DISPLAY_TYPE_REAL)); $checkboxes[] = $mform->createElement('advcheckbox', 'display[percentage]', null, get_string('percentage', 'grades'), null, array(0, GRADE_DISPLAY_TYPE_PERCENTAGE)); $checkboxes[] = $mform->createElement('advcheckbox', 'display[letter]', null, get_string('letter', 'grades'), null, array(0, GRADE_DISPLAY_TYPE_LETTER)); $mform->addGroup($checkboxes, 'displaytypes', get_string('gradeexportdisplaytypes', 'grades'), ' ', false); $mform->setDefault('display[real]', $CFG->grade_export_displaytype == GRADE_DISPLAY_TYPE_REAL); $mform->setDefault('display[percentage]', $CFG->grade_export_displaytype == GRADE_DISPLAY_TYPE_PERCENTAGE); $mform->setDefault('display[letter]', $CFG->grade_export_displaytype == GRADE_DISPLAY_TYPE_LETTER); } else { // Only used by XML grade export format. $mform->addElement('select', 'display', get_string('gradeexportdisplaytype', 'grades'), $options); $mform->setDefault('display', $CFG->grade_export_displaytype); } //$default_gradedecimals = $CFG->grade_export_decimalpoints; $options = array(0=>0, 1=>1, 2=>2, 3=>3, 4=>4, 5=>5); $mform->addElement('select', 'decimals', get_string('gradeexportdecimalpoints', 'grades'), $options); $mform->setDefault('decimals', $CFG->grade_export_decimalpoints); $mform->disabledIf('decimals', 'display', 'eq', GRADE_DISPLAY_TYPE_LETTER); /* if ($default_gradedisplaytype == GRADE_DISPLAY_TYPE_LETTER) { $mform->disabledIf('decimals', 'display', "eq", GRADE_DISPLAY_TYPE_DEFAULT); } */ if (!empty($features['includeseparator'])) { $radio = array(); $radio[] = $mform->createElement('radio', 'separator', null, get_string('septab', 'grades'), 'tab'); $radio[] = $mform->createElement('radio', 'separator', null, get_string('sepcomma', 'grades'), 'comma'); $radio[] = $mform->createElement('radio', 'separator', null, get_string('sepcolon', 'grades'), 'colon'); $radio[] = $mform->createElement('radio', 'separator', null, get_string('sepsemicolon', 'grades'), 'semicolon'); $mform->addGroup($radio, 'separator', get_string('separator', 'grades'), ' ', false); $mform->setDefault('separator', 'comma'); } if (!empty($CFG->gradepublishing) and !empty($features['publishing'])) { $mform->addElement('header', 'publishing', get_string('publishingoptions', 'grades')); if (!empty($features['simpleui'])) { $mform->setExpanded('publishing', false); } $options = array(get_string('nopublish', 'grades'), get_string('createnewkey', 'userkey')); $keys = $DB->get_records_select('user_private_key', "script='grade/export' AND instance=? AND userid=?", array($COURSE->id, $USER->id)); if ($keys) { foreach ($keys as $key) { $options[$key->value] = $key->value; // TODO: add more details - ip restriction, valid until ?? } } $mform->addElement('select', 'key', get_string('userkey', 'userkey'), $options); $mform->addHelpButton('key', 'userkey', 'userkey'); $mform->addElement('static', 'keymanagerlink', get_string('keymanager', 'userkey'), '<a href="'.$CFG->wwwroot.'/grade/export/keymanager.php?id='.$COURSE->id.'">'.get_string('keymanager', 'userkey').'</a>'); $mform->addElement('text', 'iprestriction', get_string('keyiprestriction', 'userkey'), array('size'=>80)); $mform->addHelpButton('iprestriction', 'keyiprestriction', 'userkey'); $mform->setDefault('iprestriction', getremoteaddr()); // own IP - just in case somebody does not know what user key is $mform->setType('iprestriction', PARAM_RAW_TRIMMED); $mform->addElement('date_time_selector', 'validuntil', get_string('keyvaliduntil', 'userkey'), array('optional'=>true)); $mform->addHelpButton('validuntil', 'keyvaliduntil', 'userkey'); $mform->setDefault('validuntil', time()+3600*24*7); // only 1 week default duration - just in case somebody does not know what user key is $mform->setType('validuntil', PARAM_INT); $mform->disabledIf('iprestriction', 'key', 'noteq', 1); $mform->disabledIf('validuntil', 'key', 'noteq', 1); } $mform->addElement('hidden', 'id', $COURSE->id); $mform->setType('id', PARAM_INT); $submitstring = get_string('download'); if (empty($features['simpleui'])) { $submitstring = get_string('submit'); } else if (!empty($CFG->gradepublishing)) { $submitstring = get_string('export', 'grades'); } $this->add_sticky_action_buttons(false, $submitstring); } /** * Overrides the mform get_data method. * * Created to force a value since the validation method does not work with multiple checkbox. * * @return stdClass form data object. */ public function get_data() { global $CFG; $data = parent::get_data(); if ($data && $this->_customdata['multipledisplaytypes']) { if (count(array_filter($data->display)) == 0) { // Ensure that a value was selected as the export plugins expect at least one value. if ($CFG->grade_export_displaytype == GRADE_DISPLAY_TYPE_LETTER) { $data->display['letter'] = GRADE_DISPLAY_TYPE_LETTER; } else if ($CFG->grade_export_displaytype == GRADE_DISPLAY_TYPE_PERCENTAGE) { $data->display['percentage'] = GRADE_DISPLAY_TYPE_PERCENTAGE; } else { $data->display['real'] = GRADE_DISPLAY_TYPE_REAL; } } } return $data; } } export/xml/version.php 0000604 00000002256 15062070557 0011073 0 ustar 00 <?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/>. /** * Version details * * @package gradeexport * @subpackage xml * @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); $plugin->version = 2023100900; // The current plugin version (Date: YYYYMMDDXX). $plugin->requires = 2023100400; // Requires this Moodle version. $plugin->component = 'gradeexport_xml'; // Full name of the plugin (used for diagnostics) export/xml/db/access.php 0000604 00000002746 15062070557 0011240 0 ustar 00 <?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/>. /** * Capabilities gradeexport plugin. * * @package gradeexport_xml * @copyright 2007 Petr Skoda {@link http://skodak.org} * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); $capabilities = array( 'gradeexport/xml:view' => array( 'riskbitmask' => RISK_PERSONAL, 'captype' => 'read', 'contextlevel' => CONTEXT_COURSE, 'archetypes' => array( 'teacher' => CAP_ALLOW, 'editingteacher' => CAP_ALLOW, 'manager' => CAP_ALLOW ) ), 'gradeexport/xml:publish' => array( 'riskbitmask' => RISK_PERSONAL, 'captype' => 'read', 'contextlevel' => CONTEXT_COURSE, 'archetypes' => array( 'manager' => CAP_ALLOW ) ) ); export/xml/lang/en/gradeexport_xml.php 0000604 00000002341 15062070557 0014130 0 ustar 00 <?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/>. /** * Strings for component 'gradeexport_xml', language 'en', branch 'MOODLE_20_STABLE' * * @package gradeexport_xml * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ $string['eventgradeexported'] = 'XML grade exported'; $string['pluginname'] = 'XML file'; $string['privacy:metadata'] = 'The XML file grade export plugin does not store any personal data.'; $string['xml:publish'] = 'Publish XML grade export'; $string['xml:view'] = 'Use XML grade export'; export/xml/index.php 0000604 00000004767 15062070557 0010526 0 ustar 00 <?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/>. require_once '../../../config.php'; require_once $CFG->dirroot.'/grade/export/lib.php'; require_once 'grade_export_xml.php'; $id = required_param('id', PARAM_INT); // course id $PAGE->set_url('/grade/export/xml/index.php', array('id'=>$id)); if (!$course = $DB->get_record('course', array('id'=>$id))) { throw new \moodle_exception('invalidcourseid'); } require_login($course); $context = context_course::instance($id); require_capability('moodle/grade:export', $context); require_capability('gradeexport/xml:view', $context); $actionbar = new \core_grades\output\export_action_bar($context, null, 'xml'); print_grade_page_head($COURSE->id, 'export', 'xml', get_string('exportto', 'grades') . ' ' . get_string('pluginname', 'gradeexport_xml'), false, false, true, null, null, null, $actionbar); export_verify_grades($COURSE->id); if (!empty($CFG->gradepublishing)) { $CFG->gradepublishing = has_capability('gradeexport/xml:publish', $context); } $actionurl = new moodle_url('/grade/export/xml/export.php'); // The option 'idnumberrequired' excludes grade items that dont have an ID to use during import. $formoptions = array( 'idnumberrequired' => true, 'updategradesonly' => true, 'publishing' => true, 'simpleui' => true, 'multipledisplaytypes' => false ); $mform = new grade_export_form($actionurl, $formoptions); $groupmode = groups_get_course_groupmode($course); // Groups are being used. $currentgroup = groups_get_course_group($course, true); if (($groupmode == SEPARATEGROUPS) && (!$currentgroup) && (!has_capability('moodle/site:accessallgroups', $context))) { echo $OUTPUT->heading(get_string("notingroup")); echo $OUTPUT->footer(); die; } groups_print_course_menu($course, 'index.php?id='.$id); echo '<div class="clearer"></div>'; $mform->display(); echo $OUTPUT->footer(); export/xml/tests/event/events_test.php 0000604 00000004165 15062070557 0014235 0 ustar 00 <?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/>. namespace gradeexport_xml\event; /** * XML grade export events test cases. * * @package gradeexport_xml * @copyright 2016 Zane Karl zkarl@oid.ucla.edu * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class events_test extends \advanced_testcase { /** * Setup is called before calling test case. */ public function setUp(): void { $this->resetAfterTest(); } /** * Test course_module_instance_list_viewed event. */ public function test_logging() { // There is no proper API to call to trigger this event, so what we are // doing here is simply making sure that the events returns the right information. $course = $this->getDataGenerator()->create_course(); $params = array( 'context' => \context_course::instance($course->id) ); $event = \gradeexport_xml\event\grade_exported::create($params); // Triggering and capturing the event. $sink = $this->redirectEvents(); $event->trigger(); $events = $sink->get_events(); $this->assertCount(1, $events); $event = reset($events); // Checking that the event contains the expected values. $this->assertInstanceOf('\gradeexport_xml\event\grade_exported', $event); $this->assertEquals(\context_course::instance($course->id), $event->get_context()); $this->assertEquals('xml', $event->get_export_type()); } } export/xml/tests/behat/export.feature 0000604 00000004241 15062070557 0014014 0 ustar 00 @gradeexport @gradeexport_xml Feature: I need to export grades as xml In order to easily review marks As a teacher I need to have a export grades as xml Background: Given the following "courses" exist: | fullname | shortname | category | groupmode | | Course 1 | C1 | 0 | 1 | And the following "users" exist: | username | firstname | lastname | email | idnumber | | teacher1 | Teacher | 1 | teacher1@example.com | t1 | | student1 | Student | 1 | student1@example.com | s1 | | student2 | Student | 2 | student2@example.com | 'Bill'&"Ben"<tag>Hello</tag> | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | | student2 | C1 | student | And the following "activities" exist: | activity | course | idnumber | name | | assign | C1 | a1 | Test assignment name | And the following "grade grades" exist: | gradeitem | user | grade | | Test assignment name | student1 | 80.00 | | Test assignment name | student2 | 42.00 | And I am on the "Course 1" course page logged in as teacher1 @javascript Scenario: Export grades as XML When I navigate to "XML file" export page in the course gradebook And I expand all fieldsets And I set the field "Grade export decimal places" to "1" And I press "Download" Then I should see "s1" in the "//results//result[1]//student" "xpath_element" And I should see "a1" in the "//results//result[1]//assignment" "xpath_element" And I should see "80.0" in the "//results//result[1]//score" "xpath_element" And I should not see "80.00" in the "//results//result[1]//score" "xpath_element" # Ensure we have the encoded ID number of student 2. And I should see "'Bill'&\"Ben\"<tag>Hello</tag>" in the "//results//result[2]//student" "xpath_element" And I should see "a1" in the "//results//result[2]//assignment" "xpath_element" And I should see "42.0" in the "//results//result[2]//score" "xpath_element" And I should not see "42.00" in the "//results//result[2]//score" "xpath_element" export/xml/export.php 0000604 00000005437 15062070557 0010733 0 ustar 00 <?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/>. require_once '../../../config.php'; require_once $CFG->dirroot.'/grade/export/lib.php'; require_once 'grade_export_xml.php'; $id = required_param('id', PARAM_INT); // course id $PAGE->set_url('/grade/export/xml/export.php', array('id'=>$id)); if (!$course = $DB->get_record('course', array('id'=>$id))) { throw new \moodle_exception('invalidcourseid'); } require_login($course); $context = context_course::instance($id); $groupid = groups_get_course_group($course, true); require_capability('moodle/grade:export', $context); require_capability('gradeexport/xml:view', $context); // We need to call this method here before any print otherwise the menu won't display. // If you use this method without this check, will break the direct grade exporting (without publishing). $key = optional_param('key', '', PARAM_RAW); if (!empty($CFG->gradepublishing) && !empty($key)) { $actionbar = new \core_grades\output\export_publish_action_bar($context, 'xml'); print_grade_page_head($COURSE->id, 'export', 'xml', get_string('exportto', 'grades') . ' ' . get_string('pluginname', 'gradeexport_xml'), false, false, true, null, null, null, $actionbar); } if (groups_get_course_groupmode($COURSE) == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) { if (!groups_is_member($groupid, $USER->id)) { throw new \moodle_exception('cannotaccessgroup', 'grades'); } } $mform = new grade_export_form(null, array('publishing' => true, 'simpleui' => true, 'multipledisplaytypes' => false, 'idnumberrequired' => true, 'updategradesonly' => true)); $formdata = $mform->get_data(); $export = new grade_export_xml($course, $groupid, $formdata); // If the gradepublishing is enabled and user key is selected print the grade publishing link. if (!empty($CFG->gradepublishing) && !empty($key)) { groups_print_course_menu($course, 'index.php?id='.$id); echo $export->get_grade_publishing_url(); echo $OUTPUT->footer(); } else { $event = \gradeexport_xml\event\grade_exported::create(array('context' => $context)); $event->trigger(); $export->print_grades(); } export/xml/grade_export_xml.php 0000604 00000013776 15062070557 0012762 0 ustar 00 <?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/>. require_once($CFG->dirroot.'/grade/export/lib.php'); require_once($CFG->libdir.'/filelib.php'); class grade_export_xml extends grade_export { public $plugin = 'xml'; public $updatedgradesonly = false; // default to export ALL grades /** * Ensure we produce correctly formed XML content by encoding idnumbers appropriately * * @param string $idnumber * @return string */ private static function xml_export_idnumber(string $idnumber): string { return htmlspecialchars($idnumber, ENT_QUOTES | ENT_XML1); } /** * Handle form processing for export. Note we need to handle the case where there are no 'itemids[]' being included in the * form, because each is disabled for selection due to having empty idnumber * * @param stdClass $formdata */ public function process_form($formdata) { if (!isset($formdata->itemids)) { $formdata->itemids = self::EXPORT_SELECT_NONE; } parent::process_form($formdata); } /** * To be implemented by child classes * @param boolean $feedback * @param boolean $publish Whether to output directly, or send as a file * @return string */ public function print_grades($feedback = false) { global $CFG; require_once($CFG->libdir.'/filelib.php'); $export_tracking = $this->track_exports(); $strgrades = get_string('grades'); /// Calculate file name $shortname = format_string($this->course->shortname, true, array('context' => context_course::instance($this->course->id))); $downloadfilename = clean_filename("$shortname $strgrades.xml"); make_temp_directory('gradeexport'); $tempfilename = $CFG->tempdir .'/gradeexport/'. md5(sesskey().microtime().$downloadfilename); if (!$handle = fopen($tempfilename, 'w+b')) { throw new \moodle_exception('cannotcreatetempdir'); } /// time stamp to ensure uniqueness of batch export fwrite($handle, '<results batch="xml_export_'.time().'">'."\n"); $export_buffer = array(); $geub = new grade_export_update_buffer(); $gui = new graded_users_iterator($this->course, $this->columns, $this->groupid); $gui->require_active_enrolment($this->onlyactive); $gui->init(); while ($userdata = $gui->next_user()) { $user = $userdata->user; if (empty($user->idnumber)) { //id number must exist otherwise we cant match up students when importing continue; } // studentgrades[] index should match with corresponding $index foreach ($userdata->grades as $itemid => $grade) { $grade_item = $this->grade_items[$itemid]; $grade->grade_item =& $grade_item; // MDL-11669, skip exported grades or bad grades (if setting says so) if ($export_tracking) { $status = $geub->track($grade); if ($this->updatedgradesonly && ($status == 'nochange' || $status == 'unknown')) { continue; } } fwrite($handle, "\t<result>\n"); if ($export_tracking) { fwrite($handle, "\t\t<state>$status</state>\n"); } // only need id number $gradeitemidnumber = self::xml_export_idnumber($grade_item->idnumber); fwrite($handle, "\t\t<assignment>{$gradeitemidnumber}</assignment>\n"); // this column should be customizable to use either student id, idnumber, uesrname or email. $useridnumber = self::xml_export_idnumber($user->idnumber); fwrite($handle, "\t\t<student>{$useridnumber}</student>\n"); // Format and display the grade in the selected display type (real, letter, percentage). if (is_array($this->displaytype)) { // Grades display type came from the return of export_bulk_export_data() on grade publishing. foreach ($this->displaytype as $gradedisplayconst) { $gradestr = $this->format_grade($grade, $gradedisplayconst); fwrite($handle, "\t\t<score>$gradestr</score>\n"); } } else { // Grade display type submitted directly from the grade export form. $gradestr = $this->format_grade($grade, $this->displaytype); fwrite($handle, "\t\t<score>$gradestr</score>\n"); } if ($this->export_feedback) { $feedbackstr = $this->format_feedback($userdata->feedbacks[$itemid], $grade); fwrite($handle, "\t\t<feedback>$feedbackstr</feedback>\n"); } fwrite($handle, "\t</result>\n"); } } fwrite($handle, "</results>"); fclose($handle); $gui->close(); $geub->close(); if (defined('BEHAT_SITE_RUNNING')) { // If behat is running, we cannot test the output if we force a file download. include($tempfilename); } else { @header("Content-type: text/xml; charset=UTF-8"); send_temp_file($tempfilename, $downloadfilename, false); } } } export/xml/dump.php 0000604 00000004543 15062070557 0010354 0 ustar 00 <?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/>. define('NO_MOODLE_COOKIES', true); // session not used here require_once '../../../config.php'; require_once($CFG->dirroot.'/grade/export/xml/grade_export_xml.php'); $id = required_param('id', PARAM_INT); $groupid = optional_param('groupid', 0, PARAM_INT); $itemids = required_param('itemids', PARAM_RAW); $exportfeedback = optional_param('export_feedback', 0, PARAM_BOOL); $updatedgradesonly = optional_param('updatedgradesonly', false, PARAM_BOOL); $displaytype = optional_param('displaytype', $CFG->grade_export_displaytype, PARAM_RAW); $decimalpoints = optional_param('decimalpoints', $CFG->grade_export_decimalpoints, PARAM_INT); $onlyactive = optional_param('export_onlyactive', 0, PARAM_BOOL); if (!$course = $DB->get_record('course', array('id'=>$id))) { throw new \moodle_exception('invalidcourseid'); } require_user_key_login('grade/export', $id); // we want different keys for each course if (empty($CFG->gradepublishing)) { throw new \moodle_exception('gradepubdisable'); } $context = context_course::instance($id); require_capability('moodle/grade:export', $context); require_capability('gradeexport/xml:publish', $context); require_capability('gradeexport/xml:view', $context); if (!groups_group_visible($groupid, $COURSE)) { throw new \moodle_exception('cannotaccessgroup', 'grades'); } // Get all url parameters and create an object to simulate a form submission. $formdata = grade_export::export_bulk_export_data($id, $itemids, $exportfeedback, $onlyactive, $displaytype, $decimalpoints, $updatedgradesonly, null); $export = new grade_export_xml($course, $groupid, $formdata); $export->print_grades(); export/xml/classes/privacy/provider.php 0000604 00000002767 15062070557 0014361 0 ustar 00 <?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/>. /** * Privacy Subsystem implementation for gradeexport_xml. * * @package gradeexport_xml * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradeexport_xml\privacy; defined('MOODLE_INTERNAL') || die(); /** * Privacy Subsystem for gradeexport_xml implementing null_provider. * * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class provider implements \core_privacy\local\metadata\null_provider { /** * Get the language string identifier with the component's language * file to explain why this plugin stores no data. * * @return string */ public static function get_reason() : string { return 'privacy:metadata'; } } export/xml/classes/event/grade_exported.php 0000604 00000002316 15062070557 0015155 0 ustar 00 <?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/>. /** * Grade export event. * * @package gradeexport_xml * @copyright 2016 Zane Karl <zkarl@oid.ucla.edu> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradeexport_xml\event; defined('MOODLE_INTERNAL') || die(); /** * Grade export event class. * * @package gradeexport_xml * @since Moodle 3.2 * @copyright 2016 Zane Karl <zkarl@oid.ucla.edu> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class grade_exported extends \core\event\grade_exported { } export/key.php 0000604 00000011351 15062070557 0007372 0 ustar 00 <?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/>. /** * Grade export key edit page. * * @package moodlecore * @copyright 2008 Petr Skoda * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once('../../config.php'); require_once('key_form.php'); require_once($CFG->dirroot.'/grade/lib.php'); /// get url variables $courseid = optional_param('courseid', 0, PARAM_INT); $id = optional_param('id', 0, PARAM_INT); // The key's id $delete = optional_param('delete', 0, PARAM_BOOL); $confirm = optional_param('confirm', 0, PARAM_BOOL); $PAGE->set_url('/grade/export/key.php', array('id' => $id, 'courseid' => $courseid)); if ($id) { if (!$key = $DB->get_record('user_private_key', array('id' => $id))) { throw new \moodle_exception('invalidgroupid'); } if (empty($courseid)) { $courseid = $key->instance; } else if ($courseid != $key->instance) { throw new \moodle_exception('invalidcourseid'); } if (!$course = $DB->get_record('course', array('id'=>$courseid))) { throw new \moodle_exception('invalidcourseid'); } } else { if (!$course = $DB->get_record('course', array('id'=>$courseid))) { throw new \moodle_exception('invalidcourseid'); } $key = new stdClass(); } $key->courseid = $course->id; require_login($course); $context = context_course::instance($course->id); require_capability('moodle/grade:export', $context); // Check if the user has at least one grade publishing capability. $plugins = grade_helper::get_plugins_export($course->id); if (!isset($plugins['keymanager'])) { throw new \moodle_exception('nopermissions'); } // extra security check if (!empty($key->userid) and $USER->id != $key->userid) { throw new \moodle_exception('notownerofkey'); } $returnurl = $CFG->wwwroot.'/grade/export/keymanager.php?id='.$course->id; $strkeys = get_string('keymanager', 'userkey'); $strexportgrades = get_string('export', 'grades'); $PAGE->navbar->add($strexportgrades, new moodle_url('/grade/export/index.php', ['id' => $courseid])); $PAGE->navbar->add($strkeys, new moodle_url('/grade/export/keymanager.php', ['id' => $courseid])); if ($id and $delete) { if (!$confirm) { $PAGE->set_title(get_string('deleteselectedkey')); $PAGE->set_heading($course->fullname); $PAGE->set_secondary_active_tab('grades'); $PAGE->navbar->add(get_string('deleteuserkey', 'userkey')); echo $OUTPUT->header(); $optionsyes = array('id'=>$id, 'delete'=>1, 'courseid'=>$courseid, 'sesskey'=>sesskey(), 'confirm'=>1); $optionsno = array('id'=>$courseid); $formcontinue = new single_button(new moodle_url('key.php', $optionsyes), get_string('yes'), 'get'); $formcancel = new single_button(new moodle_url('keymanager.php', $optionsno), get_string('no'), 'get'); echo $OUTPUT->confirm(get_string('deletekeyconfirm', 'userkey', $key->value), $formcontinue, $formcancel); echo $OUTPUT->footer(); die; } else if (confirm_sesskey()){ $DB->delete_records('user_private_key', array('id' => $id)); redirect('keymanager.php?id='.$course->id); } } /// First create the form $editform = new key_form(); $editform->set_data($key); if ($editform->is_cancelled()) { redirect($returnurl); } elseif ($data = $editform->get_data()) { if ($data->id) { $record = new stdClass(); $record->id = $data->id; $record->iprestriction = $data->iprestriction; $record->validuntil = $data->validuntil; $DB->update_record('user_private_key', $record); } else { create_user_key('grade/export', $USER->id, $course->id, $data->iprestriction, $data->validuntil); } redirect($returnurl); } if ($id) { $strheading = get_string('edituserkey', 'userkey'); } else { $strheading = get_string('createuserkey', 'userkey'); } $PAGE->navbar->add($strheading); /// Print header $PAGE->set_title($strkeys); $PAGE->set_heading($course->fullname); $PAGE->set_secondary_active_tab('grades'); echo $OUTPUT->header(); echo $OUTPUT->heading($strheading); $editform->display(); echo $OUTPUT->footer(); export/index.php 0000604 00000004532 15062070557 0007714 0 ustar 00 <?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/>. /** * Redirects the user to a default grades export plugin page. * * @package core_grades * @copyright 2021 Mihail Geshoski <mihail@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once(__DIR__ . '/../../config.php'); // Course ID. $courseid = required_param('id', PARAM_INT); $PAGE->set_url(new moodle_url('/grade/export/index.php', ['id' => $courseid])); // Basic access checks. if (!$course = $DB->get_record('course', ['id' => $courseid])) { throw new moodle_exception('invalidcourseid', 'error'); } require_login($course); $context = context_course::instance($courseid); require_capability('moodle/grade:export', $context); // Retrieve all grade export plugins the current user can access. $exportplugins = array_filter(core_component::get_plugin_list('gradeexport'), static function(string $exportplugin) use ($context): bool { return has_capability("gradeexport/{$exportplugin}:view", $context); }, ARRAY_FILTER_USE_KEY ); if (!empty($exportplugins)) { $exportplugin = array_key_first($exportplugins); $url = new moodle_url("/grade/export/{$exportplugin}/index.php", ['id' => $courseid]); redirect($url); } // Otherwise, output the page with a notification stating that there are no available grade export options. $PAGE->set_title(get_string('export', 'grades')); $PAGE->set_pagelayout('incourse'); $PAGE->set_heading($course->fullname); $PAGE->set_pagetype('course-view-' . $course->format); echo $OUTPUT->header(); echo $OUTPUT->heading(get_string('export', 'grades')); echo html_writer::div($OUTPUT->notification(get_string('nogradeexport', 'debug'), 'error'), 'mt-3'); echo $OUTPUT->footer(); export/ods/tests/event/events_test.php 0000604 00000004165 15062070557 0014222 0 ustar 00 <?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/>. namespace gradeexport_ods\event; /** * ODS grade export events test cases. * * @package gradeexport_ods * @copyright 2016 Zane Karl zkarl@oid.ucla.edu * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class events_test extends \advanced_testcase { /** * Setup is called before calling test case. */ public function setUp(): void { $this->resetAfterTest(); } /** * Test course_module_instance_list_viewed event. */ public function test_logging() { // There is no proper API to call to trigger this event, so what we are // doing here is simply making sure that the events returns the right information. $course = $this->getDataGenerator()->create_course(); $params = array( 'context' => \context_course::instance($course->id) ); $event = \gradeexport_ods\event\grade_exported::create($params); // Triggering and capturing the event. $sink = $this->redirectEvents(); $event->trigger(); $events = $sink->get_events(); $this->assertCount(1, $events); $event = reset($events); // Checking that the event contains the expected values. $this->assertInstanceOf('\gradeexport_ods\event\grade_exported', $event); $this->assertEquals(\context_course::instance($course->id), $event->get_context()); $this->assertEquals('ods', $event->get_export_type()); } } export/ods/version.php 0000604 00000002256 15062070557 0011060 0 ustar 00 <?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/>. /** * Version details * * @package gradeexport * @subpackage ods * @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); $plugin->version = 2023100900; // The current plugin version (Date: YYYYMMDDXX). $plugin->requires = 2023100400; // Requires this Moodle version. $plugin->component = 'gradeexport_ods'; // Full name of the plugin (used for diagnostics) export/ods/lang/en/gradeexport_ods.php 0000604 00000002521 15062070557 0014102 0 ustar 00 <?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/>. /** * Strings for component 'gradeexport_ods', language 'en', branch 'MOODLE_20_STABLE' * * @package gradeexport_ods * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ $string['eventgradeexported'] = 'OpenDocument grade exported'; $string['pluginname'] = 'OpenDocument spreadsheet'; $string['ods:publish'] = 'Publish ODS grade export'; $string['ods:view'] = 'Use OpenDocument grade export'; $string['privacy:metadata'] = 'The OpenDocument spreadsheet grade export plugin does not store any personal data.'; $string['timeexported'] = 'Last downloaded from this course'; export/ods/grade_export_ods.php 0000604 00000011600 15062070557 0012714 0 ustar 00 <?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/>. require_once($CFG->dirroot.'/grade/export/lib.php'); class grade_export_ods extends grade_export { public $plugin = 'ods'; /** * Constructor should set up all the private variables ready to be pulled * @param object $course * @param int $groupid id of selected group, 0 means all * @param stdClass $formdata The validated data from the grade export form. */ public function __construct($course, $groupid, $formdata) { parent::__construct($course, $groupid, $formdata); // Overrides. $this->usercustomfields = true; } /** * To be implemented by child classes */ function print_grades() { global $CFG; require_once($CFG->dirroot.'/lib/odslib.class.php'); $export_tracking = $this->track_exports(); $strgrades = get_string('grades'); $shortname = format_string($this->course->shortname, true, array('context' => context_course::instance($this->course->id))); // Calculate file name $downloadfilename = clean_filename("$shortname $strgrades.ods"); // Creating a workbook $workbook = new MoodleODSWorkbook("-"); // Sending HTTP headers $workbook->send($downloadfilename); // Adding the worksheet $myxls = $workbook->add_worksheet($strgrades); // Print names of all the fields. $profilefields = grade_helper::get_user_profile_fields($this->course->id, $this->usercustomfields); foreach ($profilefields as $id => $field) { $myxls->write_string(0, $id, $field->fullname); } $pos = count($profilefields); if (!$this->onlyactive) { $myxls->write_string(0, $pos++, get_string("suspended")); } foreach ($this->columns as $grade_item) { foreach ($this->displaytype as $gradedisplayname => $gradedisplayconst) { $myxls->write_string(0, $pos++, $this->format_column_name($grade_item, false, $gradedisplayname)); } // Add a column_feedback column. if ($this->export_feedback) { $myxls->write_string(0, $pos++, $this->format_column_name($grade_item, true)); } } // Last downloaded column header. $myxls->write_string(0, $pos++, get_string('timeexported', 'gradeexport_ods')); // Print all the lines of data. $i = 0; $geub = new grade_export_update_buffer(); $gui = new graded_users_iterator($this->course, $this->columns, $this->groupid); $gui->require_active_enrolment($this->onlyactive); $gui->allow_user_custom_fields($this->usercustomfields); $gui->init(); while ($userdata = $gui->next_user()) { $i++; $user = $userdata->user; foreach($profilefields as $id => $field) { $fieldvalue = grade_helper::get_user_field_value($user, $field); $myxls->write_string($i, $id, $fieldvalue); } $j = count($profilefields); if (!$this->onlyactive) { $issuspended = ($user->suspendedenrolment) ? get_string('yes') : ''; $myxls->write_string($i, $j++, $issuspended); } foreach ($userdata->grades as $itemid => $grade) { if ($export_tracking) { $status = $geub->track($grade); } foreach ($this->displaytype as $gradedisplayconst) { $gradestr = $this->format_grade($grade, $gradedisplayconst); if (is_numeric($gradestr)) { $myxls->write_number($i, $j++, $gradestr); } else { $myxls->write_string($i, $j++, $gradestr); } } // writing feedback if requested if ($this->export_feedback) { $myxls->write_string($i, $j++, $this->format_feedback($userdata->feedbacks[$itemid], $grade)); } } // Time exported. $myxls->write_string($i, $j++, time()); } $gui->close(); $geub->close(); // Close the workbook. $workbook->close(); exit; } } export/ods/classes/event/grade_exported.php 0000604 00000002316 15062070557 0015142 0 ustar 00 <?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/>. /** * Grade export event. * * @package gradeexport_ods * @copyright 2016 Zane Karl <zkarl@oid.ucla.edu> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradeexport_ods\event; defined('MOODLE_INTERNAL') || die(); /** * Grade export event class. * * @package gradeexport_ods * @since Moodle 3.2 * @copyright 2016 Zane Karl <zkarl@oid.ucla.edu> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class grade_exported extends \core\event\grade_exported { } export/ods/classes/privacy/provider.php 0000604 00000002767 15062070557 0014346 0 ustar 00 <?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/>. /** * Privacy Subsystem implementation for gradeexport_ods. * * @package gradeexport_ods * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradeexport_ods\privacy; defined('MOODLE_INTERNAL') || die(); /** * Privacy Subsystem for gradeexport_ods implementing null_provider. * * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class provider implements \core_privacy\local\metadata\null_provider { /** * Get the language string identifier with the component's language * file to explain why this plugin stores no data. * * @return string */ public static function get_reason() : string { return 'privacy:metadata'; } } export/ods/export.php 0000604 00000005325 15062070557 0010714 0 ustar 00 <?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/>. require_once '../../../config.php'; require_once $CFG->dirroot.'/grade/export/lib.php'; require_once 'grade_export_ods.php'; $id = required_param('id', PARAM_INT); // course id $PAGE->set_url('/grade/export/ods/export.php', array('id'=>$id)); if (!$course = $DB->get_record('course', array('id'=>$id))) { throw new \moodle_exception('invalidcourseid'); } require_login($course); $context = context_course::instance($id); $groupid = groups_get_course_group($course, true); require_capability('moodle/grade:export', $context); require_capability('gradeexport/ods:view', $context); // We need to call this method here before any output otherwise the menu won't display. // If you use this method without this check, will break the direct grade exporting (without publishing). $key = optional_param('key', '', PARAM_RAW); if (!empty($CFG->gradepublishing) && !empty($key)) { $actionbar = new \core_grades\output\export_publish_action_bar($context, 'ods'); print_grade_page_head($COURSE->id, 'export', 'ods', get_string('exportto', 'grades') . ' ' . get_string('pluginname', 'gradeexport_ods'), false, false, true, null, null, null, $actionbar); } if (groups_get_course_groupmode($COURSE) == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) { if (!groups_is_member($groupid, $USER->id)) { throw new \moodle_exception('cannotaccessgroup', 'grades'); } } $mform = new grade_export_form(null, array('publishing' => true, 'simpleui' => true, 'multipledisplaytypes' => true)); $data = $mform->get_data(); $export = new grade_export_ods($course, $groupid, $data); // If the gradepublishing is enabled and user key is selected print the grade publishing link. if (!empty($CFG->gradepublishing) && !empty($key)) { groups_print_course_menu($course, 'index.php?id='.$id); echo $export->get_grade_publishing_url(); echo $OUTPUT->footer(); } else { $event = \gradeexport_ods\event\grade_exported::create(array('context' => $context)); $event->trigger(); $export->print_grades(); } export/ods/db/access.php 0000604 00000002746 15062070557 0011225 0 ustar 00 <?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/>. /** * Capabilities gradeexport plugin. * * @package gradeexport_ods * @copyright 2007 Petr Skoda {@link http://skodak.org} * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); $capabilities = array( 'gradeexport/ods:view' => array( 'riskbitmask' => RISK_PERSONAL, 'captype' => 'read', 'contextlevel' => CONTEXT_COURSE, 'archetypes' => array( 'teacher' => CAP_ALLOW, 'editingteacher' => CAP_ALLOW, 'manager' => CAP_ALLOW ) ), 'gradeexport/ods:publish' => array( 'riskbitmask' => RISK_PERSONAL, 'captype' => 'read', 'contextlevel' => CONTEXT_COURSE, 'archetypes' => array( 'manager' => CAP_ALLOW ) ) ); export/ods/dump.php 0000604 00000004373 15062070557 0010342 0 ustar 00 <?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/>. define('NO_MOODLE_COOKIES', true); // session not used here require_once '../../../config.php'; require_once($CFG->dirroot.'/grade/export/ods/grade_export_ods.php'); $id = required_param('id', PARAM_INT); $groupid = optional_param('groupid', 0, PARAM_INT); $itemids = required_param('itemids', PARAM_RAW); $exportfeedback = optional_param('export_feedback', 0, PARAM_BOOL); $displaytype = optional_param('displaytype', $CFG->grade_export_displaytype, PARAM_RAW); $decimalpoints = optional_param('decimalpoints', $CFG->grade_export_decimalpoints, PARAM_INT); $onlyactive = optional_param('export_onlyactive', 0, PARAM_BOOL); if (!$course = $DB->get_record('course', array('id'=>$id))) { throw new \moodle_exception('invalidcourseid'); } require_user_key_login('grade/export', $id); // we want different keys for each course if (empty($CFG->gradepublishing)) { throw new \moodle_exception('gradepubdisable'); } $context = context_course::instance($id); require_capability('moodle/grade:export', $context); require_capability('gradeexport/ods:view', $context); require_capability('gradeexport/ods:publish', $context); if (!groups_group_visible($groupid, $COURSE)) { throw new \moodle_exception('cannotaccessgroup', 'grades'); } // Get all url parameters and create an object to simulate a form submission. $formdata = grade_export::export_bulk_export_data($id, $itemids, $exportfeedback, $onlyactive, $displaytype, $decimalpoints); $export = new grade_export_ods($course, $groupid, $formdata); $export->print_grades(); export/ods/index.php 0000604 00000004536 15062070557 0010505 0 ustar 00 <?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/>. require_once '../../../config.php'; require_once $CFG->dirroot.'/grade/export/lib.php'; require_once 'grade_export_ods.php'; $id = required_param('id', PARAM_INT); // course id $PAGE->set_url('/grade/export/ods/index.php', array('id'=>$id)); if (!$course = $DB->get_record('course', array('id'=>$id))) { throw new \moodle_exception('invalidcourseid'); } require_login($course); $context = context_course::instance($id); require_capability('moodle/grade:export', $context); require_capability('gradeexport/ods:view', $context); $actionbar = new \core_grades\output\export_action_bar($context, null, 'ods'); print_grade_page_head($COURSE->id, 'export', 'ods', get_string('exportto', 'grades') . ' ' . get_string('pluginname', 'gradeexport_ods'), false, false, true, null, null, null, $actionbar); export_verify_grades($COURSE->id); if (!empty($CFG->gradepublishing)) { $CFG->gradepublishing = has_capability('gradeexport/ods:publish', $context); } $actionurl = new moodle_url('/grade/export/ods/export.php'); $formoptions = array( 'publishing' => true, 'simpleui' => true, 'multipledisplaytypes' => true ); $mform = new grade_export_form($actionurl, $formoptions); $groupmode = groups_get_course_groupmode($course); // Groups are being used. $currentgroup = groups_get_course_group($course, true); if (($groupmode == SEPARATEGROUPS) && (!$currentgroup) && (!has_capability('moodle/site:accessallgroups', $context))) { echo $OUTPUT->heading(get_string("notingroup")); echo $OUTPUT->footer(); die; } groups_print_course_menu($course, 'index.php?id='.$id); echo '<div class="clearer"></div>'; $mform->display(); echo $OUTPUT->footer(); export/key_form.php 0000604 00000003765 15062070557 0010427 0 ustar 00 <?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/>. /** * Grade export key management form. * * @package moodlecore * @copyright 2008 Petr Skoda * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ if (!defined('MOODLE_INTERNAL')) { die('Direct access to this script is forbidden.'); /// It must be included from a Moodle page } require_once($CFG->dirroot.'/lib/formslib.php'); class key_form extends moodleform { // Define the form function definition () { global $USER, $CFG, $COURSE; $mform =& $this->_form; $mform->addElement('static', 'value', get_string('keyvalue', 'userkey')); $mform->addElement('text', 'iprestriction', get_string('keyiprestriction', 'userkey'), array('size'=>80)); $mform->setType('iprestriction', PARAM_RAW_TRIMMED); $mform->addElement('date_time_selector', 'validuntil', get_string('keyvaliduntil', 'userkey'), array('optional'=>true)); $mform->setType('validuntil', PARAM_INT); $mform->addHelpButton('iprestriction', 'keyiprestriction', 'userkey'); $mform->addHelpButton('validuntil', 'keyvaliduntil', 'userkey'); $mform->addElement('hidden','id'); $mform->setType('id', PARAM_INT); $mform->addElement('hidden','courseid'); $mform->setType('courseid', PARAM_INT); $this->add_action_buttons(); } } export/txt/tests/event/events_test.php 0000604 00000004165 15062070557 0014254 0 ustar 00 <?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/>. namespace gradeexport_txt\event; /** * TXT grade export events test cases. * * @package gradeexport_txt * @copyright 2016 Zane Karl zkarl@oid.ucla.edu * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class events_test extends \advanced_testcase { /** * Setup is called before calling test case. */ public function setUp(): void { $this->resetAfterTest(); } /** * Test course_module_instance_list_viewed event. */ public function test_logging() { // There is no proper API to call to trigger this event, so what we are // doing here is simply making sure that the events returns the right information. $course = $this->getDataGenerator()->create_course(); $params = array( 'context' => \context_course::instance($course->id) ); $event = \gradeexport_txt\event\grade_exported::create($params); // Triggering and capturing the event. $sink = $this->redirectEvents(); $event->trigger(); $events = $sink->get_events(); $this->assertCount(1, $events); $event = reset($events); // Checking that the event contains the expected values. $this->assertInstanceOf('\gradeexport_txt\event\grade_exported', $event); $this->assertEquals(\context_course::instance($course->id), $event->get_context()); $this->assertEquals('txt', $event->get_export_type()); } } export/txt/tests/behat/export.feature 0000604 00000006022 15062070557 0014032 0 ustar 00 @gradeexport @gradeexport_txt Feature: I need to export grades as text In order to easily review marks As a teacher I need to have a export grades as text Background: Given the following "courses" exist: | fullname | shortname | category | groupmode | | Course 1 | C1 | 0 | 1 | And the following "users" exist: | username | firstname | lastname | email | | teacher1 | Teacher | 1 | teacher1@example.com | | student1 | Student | 1 | student1@example.com | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | And the following "activities" exist: | activity | course | idnumber | name | intro | assignsubmission_onlinetext_enabled | | assign | C1 | a1 | Test assignment name | Submit your online text | 1 | | assign | C1 | a2 | Test assignment name 2 | Submit your online text | 1 | And the following "grade grades" exist: | gradeitem | user | grade | | Test assignment name | student1 | 80.00 | And I am on the "Course 1" "grades > Grader report > View" page logged in as "teacher1" @javascript Scenario: Export grades as text When I navigate to "Plain text file" export page in the course gradebook And I expand all fieldsets And I click on "Course total" "checkbox" And I set the field "Grade export decimal places" to "1" And I press "Download" Then I should see "Student,1" And I should see "80.0" And I should not see "Course total" And I should not see "80.00" @javascript Scenario: Export grades as text using real When I navigate to "Plain text file" export page in the course gradebook And I expand all fieldsets And I set the following fields to these values: | Real | 1 | And I click on "Course total" "checkbox" And I press "Download" Then I should see "Student,1" And I should see "80.00" @javascript Scenario: Export grades as text using percentages and letters When I navigate to "Plain text file" export page in the course gradebook And I set the following fields to these values: | Percentage | 1 | | Letter | 1 | And I press "Download" Then I should see "Student,1" And I should see "80.00 %" And I should see "B-" And I should not see "40.00 %" And I should not see ",F," @javascript Scenario: Export grades as text using real, percentages and letters When I navigate to "Plain text file" export page in the course gradebook And I set the following fields to these values: | Real | 1 | | Percentage | 1 | | Letter | 1 | And I press "Download" Then I should see "Student,1" And I should see "80.00" And I should see "80.00 %" And I should see "B-" And I should not see "40.00 %" And I should not see ",F," export/txt/db/access.php 0000604 00000002746 15062070557 0011257 0 ustar 00 <?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/>. /** * Capabilities gradeexport plugin. * * @package gradeexport_txt * @copyright 2007 Petr Skoda {@link http://skodak.org} * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); $capabilities = array( 'gradeexport/txt:view' => array( 'riskbitmask' => RISK_PERSONAL, 'captype' => 'read', 'contextlevel' => CONTEXT_COURSE, 'archetypes' => array( 'teacher' => CAP_ALLOW, 'editingteacher' => CAP_ALLOW, 'manager' => CAP_ALLOW ) ), 'gradeexport/txt:publish' => array( 'riskbitmask' => RISK_PERSONAL, 'captype' => 'read', 'contextlevel' => CONTEXT_COURSE, 'archetypes' => array( 'manager' => CAP_ALLOW ) ) ); export/txt/export.php 0000604 00000005424 15062070557 0010746 0 ustar 00 <?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/>. require_once '../../../config.php'; require_once $CFG->dirroot.'/grade/export/lib.php'; require_once 'grade_export_txt.php'; $id = required_param('id', PARAM_INT); // course id $PAGE->set_url('/grade/export/txt/export.php', array('id'=>$id)); if (!$course = $DB->get_record('course', array('id'=>$id))) { throw new \moodle_exception('invalidcourseid'); } require_login($course); $context = context_course::instance($id); $groupid = groups_get_course_group($course, true); require_capability('moodle/grade:export', $context); require_capability('gradeexport/txt:view', $context); // We need to call this method here before any print otherwise the menu won't display. // If you use this method without this check, will break the direct grade exporting (without publishing). $key = optional_param('key', '', PARAM_RAW); if (!empty($CFG->gradepublishing) && !empty($key)) { $actionbar = new \core_grades\output\export_publish_action_bar($context, 'txt'); print_grade_page_head($COURSE->id, 'export', 'txt', get_string('exportto', 'grades') . ' ' . get_string('pluginname', 'gradeexport_txt'), false, false, true, null, null, null, $actionbar); } if (groups_get_course_groupmode($COURSE) == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) { if (!groups_is_member($groupid, $USER->id)) { throw new \moodle_exception('cannotaccessgroup', 'grades'); } } $params = array( 'includeseparator'=>true, 'publishing' => true, 'simpleui' => true, 'multipledisplaytypes' => true ); $mform = new grade_export_form(null, $params); $data = $mform->get_data(); $export = new grade_export_txt($course, $groupid, $data); // If the gradepublishing is enabled and user key is selected print the grade publishing link. if (!empty($CFG->gradepublishing) && !empty($key)) { groups_print_course_menu($course, 'index.php?id='.$id); echo $export->get_grade_publishing_url(); echo $OUTPUT->footer(); } else { $event = \gradeexport_txt\event\grade_exported::create(array('context' => $context)); $event->trigger(); $export->print_grades(); } export/txt/index.php 0000604 00000004574 15062070557 0010541 0 ustar 00 <?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/>. require_once '../../../config.php'; require_once $CFG->dirroot.'/grade/export/lib.php'; require_once 'grade_export_txt.php'; $id = required_param('id', PARAM_INT); // course id $PAGE->set_url('/grade/export/txt/index.php', array('id'=>$id)); if (!$course = $DB->get_record('course', array('id'=>$id))) { throw new \moodle_exception('invalidcourseid'); } require_login($course); $context = context_course::instance($id); require_capability('moodle/grade:export', $context); require_capability('gradeexport/txt:view', $context); $actionbar = new \core_grades\output\export_action_bar($context, null, 'txt'); print_grade_page_head($COURSE->id, 'export', 'txt', get_string('exportto', 'grades') . ' ' . get_string('pluginname', 'gradeexport_txt'), false, false, true, null, null, null, $actionbar); export_verify_grades($COURSE->id); if (!empty($CFG->gradepublishing)) { $CFG->gradepublishing = has_capability('gradeexport/txt:publish', $context); } $actionurl = new moodle_url('/grade/export/txt/export.php'); $formoptions = array( 'includeseparator'=>true, 'publishing' => true, 'simpleui' => true, 'multipledisplaytypes' => true ); $mform = new grade_export_form($actionurl, $formoptions); $groupmode = groups_get_course_groupmode($course); // Groups are being used. $currentgroup = groups_get_course_group($course, true); if (($groupmode == SEPARATEGROUPS) && (!$currentgroup) && (!has_capability('moodle/site:accessallgroups', $context))) { echo $OUTPUT->heading(get_string("notingroup")); echo $OUTPUT->footer(); die; } groups_print_course_menu($course, 'index.php?id='.$id); echo '<div class="clearer"></div>'; $mform->display(); echo $OUTPUT->footer(); export/txt/dump.php 0000604 00000004526 15062070557 0010374 0 ustar 00 <?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/>. define('NO_MOODLE_COOKIES', true); // session not used here require_once '../../../config.php'; require_once($CFG->dirroot.'/grade/export/txt/grade_export_txt.php'); $id = required_param('id', PARAM_INT); $groupid = optional_param('groupid', 0, PARAM_INT); $itemids = required_param('itemids', PARAM_RAW); $exportfeedback = optional_param('export_feedback', 0, PARAM_BOOL); $separator = optional_param('separator', 'comma', PARAM_ALPHA); $displaytype = optional_param('displaytype', $CFG->grade_export_displaytype, PARAM_RAW); $decimalpoints = optional_param('decimalpoints', $CFG->grade_export_decimalpoints, PARAM_INT); $onlyactive = optional_param('export_onlyactive', 0, PARAM_BOOL); if (!$course = $DB->get_record('course', array('id'=>$id))) { throw new \moodle_exception('invalidcourseid'); } require_user_key_login('grade/export', $id); // we want different keys for each course if (empty($CFG->gradepublishing)) { throw new \moodle_exception('gradepubdisable'); } $context = context_course::instance($id); require_capability('moodle/grade:export', $context); require_capability('gradeexport/txt:publish', $context); require_capability('gradeexport/txt:view', $context); if (!groups_group_visible($groupid, $COURSE)) { throw new \moodle_exception('cannotaccessgroup', 'grades'); } // Get all url parameters and create an object to simulate a form submission. $formdata = grade_export::export_bulk_export_data($id, $itemids, $exportfeedback, $onlyactive, $displaytype, $decimalpoints, null, $separator); $export = new grade_export_txt($course, $groupid, $formdata); $export->print_grades(); export/txt/version.php 0000604 00000002256 15062070557 0011112 0 ustar 00 <?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/>. /** * Version details * * @package gradeexport * @subpackage txt * @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); $plugin->version = 2023100900; // The current plugin version (Date: YYYYMMDDXX). $plugin->requires = 2023100400; // Requires this Moodle version. $plugin->component = 'gradeexport_txt'; // Full name of the plugin (used for diagnostics) export/txt/classes/event/grade_exported.php 0000604 00000002316 15062070557 0015174 0 ustar 00 <?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/>. /** * Grade export event. * * @package gradeexport_txt * @copyright 2016 Zane Karl <zkarl@oid.ucla.edu> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradeexport_txt\event; defined('MOODLE_INTERNAL') || die(); /** * Grade export event class. * * @package gradeexport_txt * @since Moodle 3.2 * @copyright 2016 Zane Karl <zkarl@oid.ucla.edu> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class grade_exported extends \core\event\grade_exported { } export/txt/classes/privacy/provider.php 0000604 00000002767 15062070557 0014400 0 ustar 00 <?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/>. /** * Privacy Subsystem implementation for gradeexport_txt. * * @package gradeexport_txt * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradeexport_txt\privacy; defined('MOODLE_INTERNAL') || die(); /** * Privacy Subsystem for gradeexport_txt implementing null_provider. * * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class provider implements \core_privacy\local\metadata\null_provider { /** * Get the language string identifier with the component's language * file to explain why this plugin stores no data. * * @return string */ public static function get_reason() : string { return 'privacy:metadata'; } } export/txt/grade_export_txt.php 0000604 00000011012 15062070557 0012775 0 ustar 00 <?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/>. require_once($CFG->dirroot.'/grade/export/lib.php'); require_once($CFG->libdir . '/csvlib.class.php'); class grade_export_txt extends grade_export { public $plugin = 'txt'; public $separator; // default separator /** * Constructor should set up all the private variables ready to be pulled * @param object $course * @param int $groupid id of selected group, 0 means all * @param stdClass $formdata The validated data from the grade export form. */ public function __construct($course, $groupid, $formdata) { parent::__construct($course, $groupid, $formdata); $this->separator = $formdata->separator; // Overrides. $this->usercustomfields = true; } public function get_export_params() { $params = parent::get_export_params(); $params['separator'] = $this->separator; return $params; } public function print_grades() { global $CFG; $export_tracking = $this->track_exports(); $strgrades = get_string('grades'); $profilefields = grade_helper::get_user_profile_fields($this->course->id, $this->usercustomfields); $shortname = format_string($this->course->shortname, true, array('context' => context_course::instance($this->course->id))); $downloadfilename = clean_filename("$shortname $strgrades"); $csvexport = new csv_export_writer($this->separator); $csvexport->set_filename($downloadfilename); // Print names of all the fields $exporttitle = array(); foreach ($profilefields as $field) { $exporttitle[] = $field->fullname; } if (!$this->onlyactive) { $exporttitle[] = get_string("suspended"); } // Add grades and feedback columns. foreach ($this->columns as $grade_item) { foreach ($this->displaytype as $gradedisplayname => $gradedisplayconst) { $exporttitle[] = $this->format_column_name($grade_item, false, $gradedisplayname); } if ($this->export_feedback) { $exporttitle[] = $this->format_column_name($grade_item, true); } } // Last downloaded column header. $exporttitle[] = get_string('timeexported', 'gradeexport_txt'); $csvexport->add_data($exporttitle); // Print all the lines of data. $geub = new grade_export_update_buffer(); $gui = new graded_users_iterator($this->course, $this->columns, $this->groupid); $gui->require_active_enrolment($this->onlyactive); $gui->allow_user_custom_fields($this->usercustomfields); $gui->init(); while ($userdata = $gui->next_user()) { $exportdata = array(); $user = $userdata->user; foreach ($profilefields as $field) { $fieldvalue = grade_helper::get_user_field_value($user, $field); $exportdata[] = $fieldvalue; } if (!$this->onlyactive) { $issuspended = ($user->suspendedenrolment) ? get_string('yes') : ''; $exportdata[] = $issuspended; } foreach ($userdata->grades as $itemid => $grade) { if ($export_tracking) { $status = $geub->track($grade); } foreach ($this->displaytype as $gradedisplayconst) { $exportdata[] = $this->format_grade($grade, $gradedisplayconst); } if ($this->export_feedback) { $exportdata[] = $this->format_feedback($userdata->feedbacks[$itemid], $grade); } } // Time exported. $exportdata[] = time(); $csvexport->add_data($exportdata); } $gui->close(); $geub->close(); $csvexport->download_file(); exit; } } export/txt/lang/en/gradeexport_txt.php 0000604 00000002456 15062070557 0014175 0 ustar 00 <?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/>. /** * Strings for component 'gradeexport_txt', language 'en', branch 'MOODLE_20_STABLE' * * @package gradeexport_txt * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ $string['eventgradeexported'] = 'TXT grade exported'; $string['pluginname'] = 'Plain text file'; $string['privacy:metadata'] = 'The Plain text file grade export plugin does not store any personal data.'; $string['timeexported'] = 'Last downloaded from this course'; $string['txt:publish'] = 'Publish TXT grade export'; $string['txt:view'] = 'Use text grade export'; export/keymanager.php 0000604 00000005763 15062070557 0010737 0 ustar 00 <?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/>. /** * Grade export key management page. * * @package moodlecore * @copyright 2008 Petr Skoda * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once '../../config.php'; require_once $CFG->dirroot.'/grade/export/lib.php'; $id = required_param('id', PARAM_INT); // course id $PAGE->set_url('/grade/export/keymanager.php', array('id' => $id)); if (!$course = $DB->get_record('course', array('id'=>$id))) { throw new \moodle_exception('invalidcourseid'); } require_login($course); $context = context_course::instance($id); require_capability('moodle/grade:export', $context); // Check if the user has at least one grade publishing capability. $plugins = grade_helper::get_plugins_export($course->id); if (!isset($plugins['keymanager'])) { throw new \moodle_exception('nopermissions'); } $actionbar = new \core_grades\output\export_key_manager_action_bar($context); print_grade_page_head($COURSE->id, 'export', 'keymanager', get_string('keymanager', 'grades'), false, false, true, null, null, null, $actionbar); $stredit = get_string('edit'); $strdelete = get_string('delete'); $data = array(); $keys = $DB->get_records_select('user_private_key', "script='grade/export' AND instance=? AND userid=?", array($course->id, $USER->id)); if ($keys) { foreach($keys as $key) { $line = array(); $line[0] = format_string($key->value); $line[1] = $key->iprestriction; $line[2] = empty($key->validuntil) ? get_string('always') : userdate($key->validuntil); $url = new moodle_url('key.php'); if (!empty($key->id)) { $url->param('id', $key->id); } $buttons = $OUTPUT->action_icon($url, new pix_icon('t/edit', $stredit)); $url->param('delete', 1); $url->param('sesskey', sesskey()); $buttons .= $OUTPUT->action_icon($url, new pix_icon('t/delete', $strdelete)); $line[3] = $buttons; $data[] = $line; } } $table = new html_table(); $table->head = array(get_string('keyvalue', 'userkey'), get_string('keyiprestriction', 'userkey'), get_string('keyvaliduntil', 'userkey'), $stredit); $table->size = array('50%', '30%', '10%', '10%'); $table->align = array('left', 'left', 'left', 'center'); $table->width = '90%'; $table->data = $data; echo html_writer::table($table); echo $OUTPUT->footer(); export/lib.php 0000604 00000066066 15062070557 0007365 0 ustar 00 <?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/>. require_once($CFG->dirroot.'/lib/gradelib.php'); require_once($CFG->dirroot.'/grade/lib.php'); require_once($CFG->dirroot.'/grade/export/grade_export_form.php'); /** * Base export class */ abstract class grade_export { /** @var int Value to state nothing is being exported. */ protected const EXPORT_SELECT_NONE = -1; public $plugin; // plgin name - must be filled in subclasses! public $grade_items; // list of all course grade items public $groupid; // groupid, 0 means all groups public $course; // course object public $columns; // array of grade_items selected for export public $export_letters; // export letters public $export_feedback; // export feedback public $userkey; // export using private user key public $updatedgradesonly; // only export updated grades /** * Grade display type (real, percentages or letter). * * This attribute is an integer for XML file export. Otherwise is an array for all other formats (ODS, XLS and TXT). * * @var $displaytype Grade display type constant (1, 2 or 3) or an array of display types where the key is the name * and the value is the grade display type constant or 0 for unchecked display types. * @access public. */ public $displaytype; public $decimalpoints; // number of decimal points for exports public $onlyactive; // only include users with an active enrolment public $usercustomfields; // include users custom fields /** * @deprecated since Moodle 2.8 * @var $previewrows Number of rows in preview. */ public $previewrows; /** * Constructor should set up all the private variables ready to be pulled. * * This constructor used to accept the individual parameters as separate arguments, in * 2.8 this was simplified to just accept the data from the moodle form. * * @access public * @param object $course * @param int $groupid * @param stdClass|null $formdata * @note Exporting as letters will lead to data loss if that exported set it re-imported. */ public function __construct($course, $groupid, $formdata) { if (func_num_args() != 3 || ($formdata != null && get_class($formdata) != "stdClass")) { $args = func_get_args(); return call_user_func_array(array($this, "deprecated_constructor"), $args); } $this->course = $course; $this->groupid = $groupid; $this->grade_items = grade_item::fetch_all(array('courseid'=>$this->course->id)); $this->process_form($formdata); } /** * Old deprecated constructor. * * This deprecated constructor accepts the individual parameters as separate arguments, in * 2.8 this was simplified to just accept the data from the moodle form. * * @deprecated since 2.8 MDL-46548. Instead call the shortened constructor which accepts the data * directly from the grade_export_form. */ protected function deprecated_constructor($course, $groupid=0, $itemlist='', $export_feedback=false, $updatedgradesonly = false, $displaytype = GRADE_DISPLAY_TYPE_REAL, $decimalpoints = 2, $onlyactive = false, $usercustomfields = false) { debugging('Many argument constructor for class "grade_export" is deprecated. Call the 3 argument version instead.', DEBUG_DEVELOPER); $this->course = $course; $this->groupid = $groupid; $this->grade_items = grade_item::fetch_all(array('courseid'=>$this->course->id)); //Populating the columns here is required by /grade/export/(whatever)/export.php //however index.php, when the form is submitted, will construct the collection here //with an empty $itemlist then reconstruct it in process_form() using $formdata $this->columns = array(); if (!empty($itemlist)) { // Check that user selected something. if ($itemlist != self::EXPORT_SELECT_NONE) { $itemids = explode(',', $itemlist); // remove items that are not requested foreach ($itemids as $itemid) { if (array_key_exists($itemid, $this->grade_items)) { $this->columns[$itemid] =& $this->grade_items[$itemid]; } } } } else { foreach ($this->grade_items as $itemid=>$unused) { $this->columns[$itemid] =& $this->grade_items[$itemid]; } } $this->export_feedback = $export_feedback; $this->userkey = ''; $this->previewrows = false; $this->updatedgradesonly = $updatedgradesonly; $this->displaytype = $displaytype; $this->decimalpoints = $decimalpoints; $this->onlyactive = $onlyactive; $this->usercustomfields = $usercustomfields; } /** * Init object based using data from form * @param object $formdata */ function process_form($formdata) { global $USER; $this->columns = array(); if (!empty($formdata->itemids)) { // Check that user selected something. if ($formdata->itemids != self::EXPORT_SELECT_NONE) { foreach ($formdata->itemids as $itemid=>$selected) { if ($selected and array_key_exists($itemid, $this->grade_items)) { $this->columns[$itemid] =& $this->grade_items[$itemid]; } } } } else { foreach ($this->grade_items as $itemid=>$unused) { $this->columns[$itemid] =& $this->grade_items[$itemid]; } } if (isset($formdata->key)) { if ($formdata->key == 1 && isset($formdata->iprestriction) && isset($formdata->validuntil)) { // Create a new key $formdata->key = create_user_key('grade/export', $USER->id, $this->course->id, $formdata->iprestriction, $formdata->validuntil); } $this->userkey = $formdata->key; } if (isset($formdata->decimals)) { $this->decimalpoints = $formdata->decimals; } if (isset($formdata->export_letters)) { $this->export_letters = $formdata->export_letters; } if (isset($formdata->export_feedback)) { $this->export_feedback = $formdata->export_feedback; } if (isset($formdata->export_onlyactive)) { $this->onlyactive = $formdata->export_onlyactive; } if (isset($formdata->previewrows)) { $this->previewrows = $formdata->previewrows; } if (isset($formdata->display)) { $this->displaytype = $formdata->display; // Used by grade exports which accept multiple display types. // If the checkbox value is 0 (unchecked) then remove it. if (is_array($formdata->display)) { $this->displaytype = array_filter($formdata->display); } } if (isset($formdata->updatedgradesonly)) { $this->updatedgradesonly = $formdata->updatedgradesonly; } } /** * Update exported field in grade_grades table * @return boolean */ public function track_exports() { global $CFG; /// Whether this plugin is entitled to update export time if ($expplugins = explode(",", $CFG->gradeexport)) { if (in_array($this->plugin, $expplugins)) { return true; } else { return false; } } else { return false; } } /** * Returns string representation of final grade * @param object $grade instance of grade_grade class * @param integer $gradedisplayconst grade display type constant. * @return string */ public function format_grade($grade, $gradedisplayconst = null) { $displaytype = $this->displaytype; if (is_array($this->displaytype) && !is_null($gradedisplayconst)) { $displaytype = $gradedisplayconst; } $gradeitem = $this->grade_items[$grade->itemid]; // We are going to store the min and max so that we can "reset" the grade_item for later. $grademax = $gradeitem->grademax; $grademin = $gradeitem->grademin; // Updating grade_item with this grade_grades min and max. $gradeitem->grademax = $grade->get_grade_max(); $gradeitem->grademin = $grade->get_grade_min(); $formattedgrade = grade_format_gradevalue($grade->finalgrade, $gradeitem, false, $displaytype, $this->decimalpoints); // Resetting the grade item in case it is reused. $gradeitem->grademax = $grademax; $gradeitem->grademin = $grademin; return $formattedgrade; } /** * Returns the name of column in export * @param object $grade_item * @param boolean $feedback feedback colum * @param string $gradedisplayname grade display name. * @return string */ public function format_column_name($grade_item, $feedback=false, $gradedisplayname = null) { $column = new stdClass(); if ($grade_item->itemtype == 'mod') { $column->name = get_string('modulename', $grade_item->itemmodule).get_string('labelsep', 'langconfig').$grade_item->get_name(); } else { $column->name = $grade_item->get_name(true); } // We can't have feedback and display type at the same time. $column->extra = ($feedback) ? get_string('feedback') : get_string($gradedisplayname, 'grades'); return html_to_text(get_string('gradeexportcolumntype', 'grades', $column), 0, false); } /** * Returns formatted grade feedback * @param object $feedback object with properties feedback and feedbackformat * @param object $grade Grade object with grade properties * @return string */ public function format_feedback($feedback, $grade = null) { $string = $feedback->feedback; if (!empty($grade)) { // Rewrite links to get the export working for 36, refer MDL-63488. $string = file_rewrite_pluginfile_urls( $feedback->feedback, 'pluginfile.php', $grade->get_context()->id, GRADE_FILE_COMPONENT, GRADE_FEEDBACK_FILEAREA, $grade->id ); } return strip_tags(format_text($string, $feedback->feedbackformat)); } /** * Implemented by child class */ public abstract function print_grades(); /** * Prints preview of exported grades on screen as a feedback mechanism * @param bool $require_user_idnumber true means skip users without idnumber * @deprecated since 2.8 MDL-46548. Previews are not useful on export. */ public function display_preview($require_user_idnumber=false) { global $OUTPUT; debugging('function grade_export::display_preview is deprecated.', DEBUG_DEVELOPER); $userprofilefields = grade_helper::get_user_profile_fields($this->course->id, $this->usercustomfields); $formatoptions = new stdClass(); $formatoptions->para = false; echo $OUTPUT->heading(get_string('previewrows', 'grades')); echo '<table>'; echo '<tr>'; foreach ($userprofilefields as $field) { echo '<th>' . $field->fullname . '</th>'; } if (!$this->onlyactive) { echo '<th>'.get_string("suspended")."</th>"; } foreach ($this->columns as $grade_item) { echo '<th>'.$this->format_column_name($grade_item).'</th>'; /// add a column_feedback column if ($this->export_feedback) { echo '<th>'.$this->format_column_name($grade_item, true).'</th>'; } } echo '</tr>'; /// Print all the lines of data. $i = 0; $gui = new graded_users_iterator($this->course, $this->columns, $this->groupid); $gui->require_active_enrolment($this->onlyactive); $gui->allow_user_custom_fields($this->usercustomfields); $gui->init(); while ($userdata = $gui->next_user()) { // number of preview rows if ($this->previewrows and $this->previewrows <= $i) { break; } $user = $userdata->user; if ($require_user_idnumber and empty($user->idnumber)) { // some exports require user idnumber so we can match up students when importing the data continue; } $gradeupdated = false; // if no grade is update at all for this user, do not display this row $rowstr = ''; foreach ($this->columns as $itemid=>$unused) { $gradetxt = $this->format_grade($userdata->grades[$itemid]); // get the status of this grade, and put it through track to get the status $g = new grade_export_update_buffer(); $grade_grade = new grade_grade(array('itemid'=>$itemid, 'userid'=>$user->id)); $status = $g->track($grade_grade); if ($this->updatedgradesonly && ($status == 'nochange' || $status == 'unknown')) { $rowstr .= '<td>'.get_string('unchangedgrade', 'grades').'</td>'; } else { $rowstr .= "<td>$gradetxt</td>"; $gradeupdated = true; } if ($this->export_feedback) { $rowstr .= '<td>'.$this->format_feedback($userdata->feedbacks[$itemid]).'</td>'; } } // if we are requesting updated grades only, we are not interested in this user at all if (!$gradeupdated && $this->updatedgradesonly) { continue; } echo '<tr>'; foreach ($userprofilefields as $field) { $fieldvalue = grade_helper::get_user_field_value($user, $field); // @see profile_field_base::display_data(). echo '<td>' . format_text($fieldvalue, FORMAT_MOODLE, $formatoptions) . '</td>'; } if (!$this->onlyactive) { $issuspended = ($user->suspendedenrolment) ? get_string('yes') : ''; echo "<td>$issuspended</td>"; } echo $rowstr; echo "</tr>"; $i++; // increment the counter } echo '</table>'; $gui->close(); } /** * Returns array of parameters used by dump.php and export.php. * @return array */ public function get_export_params() { $itemids = array_keys($this->columns); $itemidsparam = implode(',', $itemids); if (empty($itemidsparam)) { $itemidsparam = self::EXPORT_SELECT_NONE; } // We have a single grade display type constant. if (!is_array($this->displaytype)) { $displaytypes = $this->displaytype; } else { // Implode the grade display types array as moodle_url function doesn't accept arrays. $displaytypes = implode(',', $this->displaytype); } if (!empty($this->updatedgradesonly)) { $updatedgradesonly = $this->updatedgradesonly; } else { $updatedgradesonly = 0; } $params = array('id' => $this->course->id, 'groupid' => $this->groupid, 'itemids' => $itemidsparam, 'export_letters' => $this->export_letters, 'export_feedback' => $this->export_feedback, 'updatedgradesonly' => $updatedgradesonly, 'decimalpoints' => $this->decimalpoints, 'export_onlyactive' => $this->onlyactive, 'usercustomfields' => $this->usercustomfields, 'displaytype' => $displaytypes, 'key' => $this->userkey); return $params; } /** * Either prints a "Export" box, which will redirect the user to the download page, * or prints the URL for the published data. * * @deprecated since 2.8 MDL-46548. Call get_export_url and set the * action of the grade_export_form instead. * @return void */ public function print_continue() { global $CFG, $OUTPUT; debugging('function grade_export::print_continue is deprecated.', DEBUG_DEVELOPER); $params = $this->get_export_params(); echo $OUTPUT->heading(get_string('export', 'grades')); echo $OUTPUT->container_start('gradeexportlink'); if (!$this->userkey) { // This button should trigger a download prompt. $url = new moodle_url('/grade/export/'.$this->plugin.'/export.php', $params); echo $OUTPUT->single_button($url, get_string('download', 'admin')); } else { $paramstr = ''; $sep = '?'; foreach($params as $name=>$value) { $paramstr .= $sep.$name.'='.$value; $sep = '&'; } $link = $CFG->wwwroot.'/grade/export/'.$this->plugin.'/dump.php'.$paramstr.'&key='.$this->userkey; echo get_string('download', 'admin').': ' . html_writer::link($link, $link); } echo $OUTPUT->container_end(); return; } /** * Generate the export url. * * Get submitted form data and create the url to be used on the grade publish feature. * * @return moodle_url the url of grade publishing export. */ public function get_export_url() { return new moodle_url('/grade/export/'.$this->plugin.'/dump.php', $this->get_export_params()); } /** * Convert the grade display types parameter into the required array to grade exporting class. * * In order to export, the array key must be the display type name and the value must be the grade display type * constant. * * Note: Added support for combined display types constants like the (GRADE_DISPLAY_TYPE_PERCENTAGE_REAL) as * the $CFG->grade_export_displaytype config is still used on 2.7 in case of missing displaytype url param. * In these cases, the file will be exported with a column for each display type. * * @param string $displaytypes can be a single or multiple display type constants comma separated. * @return array $types */ public static function convert_flat_displaytypes_to_array($displaytypes) { $types = array(); // We have a single grade display type constant. if (is_int($displaytypes)) { $displaytype = clean_param($displaytypes, PARAM_INT); // Let's set a default value, will be replaced below by the grade display type constant. $display[$displaytype] = 1; } else { // Multiple grade display types constants. $display = array_flip(explode(',', $displaytypes)); } // Now, create the array in the required format by grade exporting class. foreach ($display as $type => $value) { $type = clean_param($type, PARAM_INT); if ($type == GRADE_DISPLAY_TYPE_LETTER) { $types['letter'] = GRADE_DISPLAY_TYPE_LETTER; } else if ($type == GRADE_DISPLAY_TYPE_PERCENTAGE) { $types['percentage'] = GRADE_DISPLAY_TYPE_PERCENTAGE; } else if ($type == GRADE_DISPLAY_TYPE_REAL) { $types['real'] = GRADE_DISPLAY_TYPE_REAL; } else if ($type == GRADE_DISPLAY_TYPE_REAL_PERCENTAGE) { $types['real'] = GRADE_DISPLAY_TYPE_REAL; $types['percentage'] = GRADE_DISPLAY_TYPE_PERCENTAGE; } else if ($type == GRADE_DISPLAY_TYPE_REAL_LETTER) { $types['real'] = GRADE_DISPLAY_TYPE_REAL; $types['letter'] = GRADE_DISPLAY_TYPE_LETTER; } else if ($type == GRADE_DISPLAY_TYPE_LETTER_REAL) { $types['letter'] = GRADE_DISPLAY_TYPE_LETTER; $types['real'] = GRADE_DISPLAY_TYPE_REAL; } else if ($type == GRADE_DISPLAY_TYPE_LETTER_PERCENTAGE) { $types['letter'] = GRADE_DISPLAY_TYPE_LETTER; $types['percentage'] = GRADE_DISPLAY_TYPE_PERCENTAGE; } else if ($type == GRADE_DISPLAY_TYPE_PERCENTAGE_LETTER) { $types['percentage'] = GRADE_DISPLAY_TYPE_PERCENTAGE; $types['letter'] = GRADE_DISPLAY_TYPE_LETTER; } else if ($type == GRADE_DISPLAY_TYPE_PERCENTAGE_REAL) { $types['percentage'] = GRADE_DISPLAY_TYPE_PERCENTAGE; $types['real'] = GRADE_DISPLAY_TYPE_REAL; } } return $types; } /** * Convert the item ids parameter into the required array to grade exporting class. * * In order to export, the array key must be the grade item id and all values must be one. * * @param string $itemids can be a single item id or many item ids comma separated. * @return array $items correctly formatted array. */ public static function convert_flat_itemids_to_array($itemids) { $items = array(); // We just have one single item id. if (is_int($itemids)) { $itemid = clean_param($itemids, PARAM_INT); $items[$itemid] = 1; } else { // Few grade items. $items = array_flip(explode(',', $itemids)); foreach ($items as $itemid => $value) { $itemid = clean_param($itemid, PARAM_INT); $items[$itemid] = 1; } } return $items; } /** * Create the html code of the grade publishing feature. * * @return string $output html code of the grade publishing. */ public function get_grade_publishing_url() { $url = $this->get_export_url(); $output = html_writer::start_div(); $output .= html_writer::tag('p', get_string('gradepublishinglink', 'grades', html_writer::link($url, $url))); $output .= html_writer::end_div(); return $output; } /** * Create a stdClass object from URL parameters to be used by grade_export class. * * @param int $id course id. * @param string $itemids grade items comma separated. * @param bool $exportfeedback export feedback option. * @param bool $onlyactive only enrolled active students. * @param string $displaytype grade display type constants comma separated. * @param int $decimalpoints grade decimal points. * @param null $updatedgradesonly recently updated grades only (Used by XML exporting only). * @param null $separator separator character: tab, comma, colon and semicolon (Used by TXT exporting only). * * @return stdClass $formdata */ public static function export_bulk_export_data($id, $itemids, $exportfeedback, $onlyactive, $displaytype, $decimalpoints, $updatedgradesonly = null, $separator = null) { $formdata = new \stdClass(); $formdata->id = $id; $formdata->itemids = self::convert_flat_itemids_to_array($itemids); $formdata->exportfeedback = $exportfeedback; $formdata->export_onlyactive = $onlyactive; $formdata->display = self::convert_flat_displaytypes_to_array($displaytype); $formdata->decimals = $decimalpoints; if (!empty($updatedgradesonly)) { $formdata->updatedgradesonly = $updatedgradesonly; } if (!empty($separator)) { $formdata->separator = $separator; } return $formdata; } } /** * This class is used to update the exported field in grade_grades. * It does internal buffering to speedup the db operations. */ class grade_export_update_buffer { public $update_list; public $export_time; /** * Constructor - creates the buffer and initialises the time stamp */ public function __construct() { $this->update_list = array(); $this->export_time = time(); } /** * Old syntax of class constructor. Deprecated in PHP7. * * @deprecated since Moodle 3.1 */ public function grade_export_update_buffer() { debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER); self::__construct(); } public function flush($buffersize) { global $CFG, $DB; if (count($this->update_list) > $buffersize) { list($usql, $params) = $DB->get_in_or_equal($this->update_list); $params = array_merge(array($this->export_time), $params); $sql = "UPDATE {grade_grades} SET exported = ? WHERE id $usql"; $DB->execute($sql, $params); $this->update_list = array(); } } /** * Track grade export status * @param object $grade_grade * @return string $status (unknow, new, regrade, nochange) */ public function track($grade_grade) { if (empty($grade_grade->exported) or empty($grade_grade->timemodified)) { if (is_null($grade_grade->finalgrade)) { // grade does not exist yet $status = 'unknown'; } else { $status = 'new'; $this->update_list[] = $grade_grade->id; } } else if ($grade_grade->exported < $grade_grade->timemodified) { $status = 'regrade'; $this->update_list[] = $grade_grade->id; } else if ($grade_grade->exported >= $grade_grade->timemodified) { $status = 'nochange'; } else { // something is wrong? $status = 'unknown'; } $this->flush(100); return $status; } /** * Flush and close the buffer. */ public function close() { $this->flush(0); } } /** * Verify that there is a valid set of grades to export. * @param $courseid int The course being exported */ function export_verify_grades($courseid) { if (grade_needs_regrade_final_grades($courseid)) { throw new moodle_exception('gradesneedregrading', 'grades'); } } export/xls/classes/event/grade_exported.php 0000604 00000002316 15062070557 0015163 0 ustar 00 <?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/>. /** * Grade export event. * * @package gradeexport_xls * @copyright 2016 Zane Karl <zkarl@oid.ucla.edu> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradeexport_xls\event; defined('MOODLE_INTERNAL') || die(); /** * Grade export event class. * * @package gradeexport_xls * @since Moodle 3.2 * @copyright 2016 Zane Karl <zkarl@oid.ucla.edu> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class grade_exported extends \core\event\grade_exported { } export/xls/classes/privacy/provider.php 0000604 00000002767 15062070557 0014367 0 ustar 00 <?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/>. /** * Privacy Subsystem implementation for gradeexport_xls. * * @package gradeexport_xls * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace gradeexport_xls\privacy; defined('MOODLE_INTERNAL') || die(); /** * Privacy Subsystem for gradeexport_xls implementing null_provider. * * @copyright 2018 Sara Arjona <sara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class provider implements \core_privacy\local\metadata\null_provider { /** * Get the language string identifier with the component's language * file to explain why this plugin stores no data. * * @return string */ public static function get_reason() : string { return 'privacy:metadata'; } } export/xls/version.php 0000604 00000002256 15062070557 0011101 0 ustar 00 <?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/>. /** * Version details * * @package gradeexport * @subpackage xls * @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); $plugin->version = 2023100900; // The current plugin version (Date: YYYYMMDDXX). $plugin->requires = 2023100400; // Requires this Moodle version. $plugin->component = 'gradeexport_xls'; // Full name of the plugin (used for diagnostics) export/xls/tests/event/events_test.php 0000604 00000004165 15062070557 0014243 0 ustar 00 <?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/>. namespace gradeexport_xls\event; /** * XLS grade export events test cases. * * @package gradeexport_xls * @copyright 2016 Zane Karl zkarl@oid.ucla.edu * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class events_test extends \advanced_testcase { /** * Setup is called before calling test case. */ public function setUp(): void { $this->resetAfterTest(); } /** * Test course_module_instance_list_viewed event. */ public function test_logging() { // There is no proper API to call to trigger this event, so what we are // doing here is simply making sure that the events returns the right information. $course = $this->getDataGenerator()->create_course(); $params = array( 'context' => \context_course::instance($course->id) ); $event = \gradeexport_xls\event\grade_exported::create($params); // Triggering and capturing the event. $sink = $this->redirectEvents(); $event->trigger(); $events = $sink->get_events(); $this->assertCount(1, $events); $event = reset($events); // Checking that the event contains the expected values. $this->assertInstanceOf('\gradeexport_xls\event\grade_exported', $event); $this->assertEquals(\context_course::instance($course->id), $event->get_context()); $this->assertEquals('xls', $event->get_export_type()); } } export/xls/dump.php 0000604 00000004373 15062070557 0010363 0 ustar 00 <?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/>. define('NO_MOODLE_COOKIES', true); // session not used here require_once '../../../config.php'; require_once($CFG->dirroot.'/grade/export/xls/grade_export_xls.php'); $id = required_param('id', PARAM_INT); $groupid = optional_param('groupid', 0, PARAM_INT); $itemids = required_param('itemids', PARAM_RAW); $exportfeedback = optional_param('export_feedback', 0, PARAM_BOOL); $displaytype = optional_param('displaytype', $CFG->grade_export_displaytype, PARAM_RAW); $decimalpoints = optional_param('decimalpoints', $CFG->grade_export_decimalpoints, PARAM_INT); $onlyactive = optional_param('export_onlyactive', 0, PARAM_BOOL); if (!$course = $DB->get_record('course', array('id'=>$id))) { throw new \moodle_exception('invalidcourseid'); } require_user_key_login('grade/export', $id); // we want different keys for each course if (empty($CFG->gradepublishing)) { throw new \moodle_exception('gradepubdisable'); } $context = context_course::instance($id); require_capability('moodle/grade:export', $context); require_capability('gradeexport/xls:view', $context); require_capability('gradeexport/xls:publish', $context); if (!groups_group_visible($groupid, $COURSE)) { throw new \moodle_exception('cannotaccessgroup', 'grades'); } // Get all url parameters and create an object to simulate a form submission. $formdata = grade_export::export_bulk_export_data($id, $itemids, $exportfeedback, $onlyactive, $displaytype, $decimalpoints); $export = new grade_export_xls($course, $groupid, $formdata); $export->print_grades(); export/xls/lang/en/gradeexport_xls.php 0000604 00000002463 15062070557 0014151 0 ustar 00 <?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/>. /** * Strings for component 'gradeexport_xls', language 'en', branch 'MOODLE_20_STABLE' * * @package gradeexport_xls * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ $string['eventgradeexported'] = 'XLS grade exported'; $string['pluginname'] = 'Excel spreadsheet'; $string['privacy:metadata'] = 'The Excel spreadsheet grade export plugin does not store any personal data.'; $string['timeexported'] = 'Last downloaded from this course'; $string['xls:publish'] = 'Publish XLS grade export'; $string['xls:view'] = 'Use Excel grade export'; export/xls/index.php 0000604 00000004510 15062070557 0010516 0 ustar 00 <?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/>. require_once '../../../config.php'; require_once $CFG->dirroot.'/grade/export/lib.php'; require_once 'grade_export_xls.php'; $id = required_param('id', PARAM_INT); // course id $PAGE->set_url('/grade/export/xls/index.php', array('id'=>$id)); if (!$course = $DB->get_record('course', array('id'=>$id))) { throw new \moodle_exception('invalidcourseid'); } require_login($course); $context = context_course::instance($id); require_capability('moodle/grade:export', $context); require_capability('gradeexport/xls:view', $context); $actionbar = new \core_grades\output\export_action_bar($context, null, 'xls'); print_grade_page_head($COURSE->id, 'export', 'xls', get_string('exportto', 'grades') . ' ' . get_string('pluginname', 'gradeexport_xls'), false, false, true, null, null, null, $actionbar); export_verify_grades($COURSE->id); if (!empty($CFG->gradepublishing)) { $CFG->gradepublishing = has_capability('gradeexport/xls:publish', $context); } $actionurl = new moodle_url('/grade/export/xls/export.php'); $formoptions = array( 'publishing' => true, 'simpleui' => true, 'multipledisplaytypes' => true ); $mform = new grade_export_form($actionurl, $formoptions); $groupmode = groups_get_course_groupmode($course); // Groups are being used $currentgroup = groups_get_course_group($course, true); if ($groupmode == SEPARATEGROUPS and !$currentgroup and !has_capability('moodle/site:accessallgroups', $context)) { echo $OUTPUT->heading(get_string("notingroup")); echo $OUTPUT->footer(); die; } groups_print_course_menu($course, 'index.php?id='.$id); echo '<div class="clearer"></div>'; $mform->display(); echo $OUTPUT->footer(); export/xls/export.php 0000604 00000005335 15062070557 0010736 0 ustar 00 <?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/>. require_once '../../../config.php'; require_once $CFG->dirroot.'/grade/export/lib.php'; require_once 'grade_export_xls.php'; $id = required_param('id', PARAM_INT); // course id $PAGE->set_url('/grade/export/xls/export.php', array('id'=>$id)); if (!$course = $DB->get_record('course', array('id'=>$id))) { throw new \moodle_exception('invalidcourseid'); } require_login($course); $context = context_course::instance($id); $groupid = groups_get_course_group($course, true); require_capability('moodle/grade:export', $context); require_capability('gradeexport/xls:view', $context); // We need to call this method here before any print otherwise the menu won't display. // If you use this method without this check, will break the direct grade exporting (without publishing). $key = optional_param('key', '', PARAM_RAW); if (!empty($CFG->gradepublishing) && !empty($key)) { $actionbar = new \core_grades\output\export_publish_action_bar($context, 'xls'); print_grade_page_head($COURSE->id, 'export', 'xls', get_string('exportto', 'grades') . ' ' . get_string('pluginname', 'gradeexport_xls'), false, false, true, null, null, null, $actionbar); } if (groups_get_course_groupmode($COURSE) == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) { if (!groups_is_member($groupid, $USER->id)) { throw new \moodle_exception('cannotaccessgroup', 'grades'); } } $mform = new grade_export_form(null, array('publishing' => true, 'simpleui' => true, 'multipledisplaytypes' => true)); $formdata = $mform->get_data(); $export = new grade_export_xls($course, $groupid, $formdata); // If the gradepublishing is enabled and user key is selected print the grade publishing link. if (!empty($CFG->gradepublishing) && !empty($key)) { groups_print_course_menu($course, 'index.php?id='.$id); echo $export->get_grade_publishing_url(); echo $OUTPUT->footer(); } else { $event = \gradeexport_xls\event\grade_exported::create(array('context' => $context)); $event->trigger(); $export->print_grades(); } export/xls/grade_export_xls.php 0000604 00000012040 15062070557 0012755 0 ustar 00 <?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/>. require_once($CFG->dirroot.'/grade/export/lib.php'); class grade_export_xls extends grade_export { public $plugin = 'xls'; /** * Constructor should set up all the private variables ready to be pulled * @param object $course * @param int $groupid id of selected group, 0 means all * @param stdClass $formdata The validated data from the grade export form. */ public function __construct($course, $groupid, $formdata) { parent::__construct($course, $groupid, $formdata); // Overrides. $this->usercustomfields = true; } /** * To be implemented by child classes */ public function print_grades() { global $CFG; require_once($CFG->dirroot.'/lib/excellib.class.php'); $export_tracking = $this->track_exports(); $strgrades = get_string('grades'); // If this file was requested from a form, then mark download as complete (before sending headers). \core_form\util::form_download_complete(); // Calculate file name $shortname = format_string($this->course->shortname, true, array('context' => context_course::instance($this->course->id))); $downloadfilename = clean_filename("$shortname $strgrades.xls"); // Creating a workbook $workbook = new MoodleExcelWorkbook("-"); // Sending HTTP headers $workbook->send($downloadfilename); // Adding the worksheet $myxls = $workbook->add_worksheet($strgrades); // Print names of all the fields $profilefields = grade_helper::get_user_profile_fields($this->course->id, $this->usercustomfields); foreach ($profilefields as $id => $field) { $myxls->write_string(0, $id, $field->fullname); } $pos = count($profilefields); if (!$this->onlyactive) { $myxls->write_string(0, $pos++, get_string("suspended")); } foreach ($this->columns as $grade_item) { foreach ($this->displaytype as $gradedisplayname => $gradedisplayconst) { $myxls->write_string(0, $pos++, $this->format_column_name($grade_item, false, $gradedisplayname)); } // Add a column_feedback column if ($this->export_feedback) { $myxls->write_string(0, $pos++, $this->format_column_name($grade_item, true)); } } // Last downloaded column header. $myxls->write_string(0, $pos++, get_string('timeexported', 'gradeexport_xls')); // Print all the lines of data. $i = 0; $geub = new grade_export_update_buffer(); $gui = new graded_users_iterator($this->course, $this->columns, $this->groupid); $gui->require_active_enrolment($this->onlyactive); $gui->allow_user_custom_fields($this->usercustomfields); $gui->init(); while ($userdata = $gui->next_user()) { $i++; $user = $userdata->user; foreach ($profilefields as $id => $field) { $fieldvalue = grade_helper::get_user_field_value($user, $field); $myxls->write_string($i, $id, $fieldvalue); } $j = count($profilefields); if (!$this->onlyactive) { $issuspended = ($user->suspendedenrolment) ? get_string('yes') : ''; $myxls->write_string($i, $j++, $issuspended); } foreach ($userdata->grades as $itemid => $grade) { if ($export_tracking) { $status = $geub->track($grade); } foreach ($this->displaytype as $gradedisplayconst) { $gradestr = $this->format_grade($grade, $gradedisplayconst); if (is_numeric($gradestr)) { $myxls->write_number($i, $j++, $gradestr); } else { $myxls->write_string($i, $j++, $gradestr); } } // writing feedback if requested if ($this->export_feedback) { $myxls->write_string($i, $j++, $this->format_feedback($userdata->feedbacks[$itemid], $grade)); } } // Time exported. $myxls->write_string($i, $j++, time()); } $gui->close(); $geub->close(); /// Close the workbook $workbook->close(); exit; } } export/xls/db/access.php 0000604 00000002746 15062070557 0011246 0 ustar 00 <?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/>. /** * Capabilities gradeexport plugin. * * @package gradeexport_xls * @copyright 2007 Petr Skoda {@link http://skodak.org} * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); $capabilities = array( 'gradeexport/xls:view' => array( 'riskbitmask' => RISK_PERSONAL, 'captype' => 'read', 'contextlevel' => CONTEXT_COURSE, 'archetypes' => array( 'teacher' => CAP_ALLOW, 'editingteacher' => CAP_ALLOW, 'manager' => CAP_ALLOW ) ), 'gradeexport/xls:publish' => array( 'riskbitmask' => RISK_PERSONAL, 'captype' => 'read', 'contextlevel' => CONTEXT_COURSE, 'archetypes' => array( 'manager' => CAP_ALLOW ) ) ); export/upgrade.txt 0000604 00000001642 15062070557 0010263 0 ustar 00 This files describes API changes in /grade/export/* - plugins, information provided here is intended especially for developers. === 2.8 === The UI for the grade export form was simplified down so it's all on one page. The export preview was removed because it was not useful (more useful on import than on export). To update your export plugins you must pass 'simpleui' => true as an option to the grade_export_form, and make your grade_export_form submit directly to your export script. It's easiest to look at a complete example - see "git show 1cc43058" for a complete example of updating the ods exporter. Also the grade export UI form was changed to support multiples display types. The combo box was removed from (Open Document, Plain Text, Excel) and for each selected display type a column is generated. We didn't extended this solution to XML export which remains with a combo and can only select a single display type. tests/edittreelib_test.php 0000604 00000012337 15062070557 0011763 0 ustar 00 <?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/>. namespace core_grades; use grade_edit_tree; use grade_edit_tree_column; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once($CFG->dirroot.'/grade/edit/tree/lib.php'); /** * Tests grade_edit_tree (deals with the data on the 'Gradebook setup' page in the gradebook) * * @package core_grades * @category test * @author Andrew Davis * @license http://www.gnu.org/copyleft/gpl.html GNU Public License */ class edittreelib_test extends \advanced_testcase { public function test_format_number() { $numinput = array(0, 1, 1.01, '1.010', 1.2345); $numoutput = array(0.0, 1.0, 1.01, 1.01, 1.2345); for ($i = 0; $i < count($numinput); $i++) { $msg = 'format_number() testing '.$numinput[$i].' %s'; $this->assertEquals(grade_edit_tree::format_number($numinput[$i]), $numoutput[$i], $msg); } } public function test_grade_edit_tree_column_range_get_item_cell() { global $DB, $CFG; $this->resetAfterTest(true); // Make some things we need. $scale = $this->getDataGenerator()->create_scale(); $course = $this->getDataGenerator()->create_course(); $assign = $this->getDataGenerator()->create_module('assign', array('course' => $course->id)); $modulecontext = \context_module::instance($assign->cmid); // The generator returns a dummy object, lets get the real assign object. $assign = new \assign($modulecontext, false, false); $cm = $assign->get_course_module(); // Get range column. $column = grade_edit_tree_column::factory('range'); $gradeitemparams = array( 'itemtype' => 'mod', 'itemmodule' => $cm->modname, 'iteminstance' => $cm->instance, 'courseid' => $cm->course, 'itemnumber' => 0 ); // Lets set the grade to something we know. $instance = $assign->get_instance(); $instance->grade = 70; $instance->instance = $instance->id; $assign->update_instance($instance); $gradeitem = \grade_item::fetch($gradeitemparams); $cell = $column->get_item_cell($gradeitem, array()); $this->assertEquals(GRADE_TYPE_VALUE, $gradeitem->gradetype); $this->assertEquals(null, $gradeitem->scaleid); $this->assertEqualsWithDelta(70.0, (float) $cell->text, 0.01, "Grade text is 70"); // Now change it to a scale. $instance = $assign->get_instance(); $instance->grade = -($scale->id); $instance->instance = $instance->id; $assign->update_instance($instance); $gradeitem = \grade_item::fetch($gradeitemparams); $cell = $column->get_item_cell($gradeitem, array()); // Make the expected scale text. $scaleitems = null; $scaleitems = explode(',', $scale->scale); // Make sure that we expect grademax (displayed in parenthesis) be the same // as number of items in the scale. $scalestring = end($scaleitems) . ' (' . format_float(count($scaleitems), 2) . ')'; $this->assertEquals(GRADE_TYPE_SCALE, $gradeitem->gradetype); $this->assertEquals($scale->id, $gradeitem->scaleid); $this->assertEquals($scalestring, $cell->text, "Grade text matches scale"); // Now change it to no grade with gradebook feedback enabled. $adminconfig = $assign->get_admin_config(); $gradebookplugin = $adminconfig->feedback_plugin_for_gradebook; $gradebookplugin .= '_enabled'; $instance = $assign->get_instance(); $instance->grade = 0; $instance->$gradebookplugin = 1; $instance->instance = $instance->id; $assign->update_instance($instance); $gradeitem = \grade_item::fetch($gradeitemparams); $cell = $column->get_item_cell($gradeitem, array()); $this->assertEquals(GRADE_TYPE_TEXT, $gradeitem->gradetype); $this->assertEquals(null, $gradeitem->scaleid); $this->assertEquals(' - ', $cell->text, 'Grade text matches empty value of " - "'); // Now change it to no grade with gradebook feedback disabled. $instance = $assign->get_instance(); $instance->grade = 0; $instance->$gradebookplugin = 0; $instance->instance = $instance->id; $assign->update_instance($instance); $gradeitem = \grade_item::fetch($gradeitemparams); $cell = $column->get_item_cell($gradeitem, array()); $this->assertEquals(GRADE_TYPE_NONE, $gradeitem->gradetype); $this->assertEquals(null, $gradeitem->scaleid); } } tests/grades/grader/gradingpanel/scale/external/store_test.php 0000604 00000042070 15062070557 0020675 0 ustar 00 <?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/>. declare(strict_types = 1); namespace core_grades\grades\grader\gradingpanel\scale\external; use advanced_testcase; use coding_exception; use core_grades\component_gradeitem; use core_external\external_api; use mod_forum\local\entities\forum as forum_entity; use moodle_exception; use grade_grade; use grade_item; /** * Unit tests for core_grades\component_gradeitems; * * @package core_grades * @category test * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class store_test extends advanced_testcase { /** * Ensure that an execute with an invalid component is rejected. */ public function test_execute_invalid_component(): void { $this->resetAfterTest(); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(coding_exception::class); $this->expectExceptionMessage("The 'foo' item is not valid for the 'mod_invalid' component"); store::execute('mod_invalid', 1, 'foo', 2, false, 'formdata'); } /** * Ensure that an execute with an invalid itemname on a valid component is rejected. */ public function test_execute_invalid_itemname(): void { $this->resetAfterTest(); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(coding_exception::class); $this->expectExceptionMessage("The 'foo' item is not valid for the 'mod_forum' component"); store::execute('mod_forum', 1, 'foo', 2, false, 'formdata'); } /** * Ensure that an execute against a different grading method is rejected. */ public function test_execute_incorrect_type(): void { $this->resetAfterTest(); $forum = $this->get_forum_instance([ // Negative numbers mean a scale. 'grade_forum' => 5, ]); $course = $forum->get_course_record(); $teacher = $this->getDataGenerator()->create_and_enrol($course, 'teacher'); $student = $this->getDataGenerator()->create_and_enrol($course, 'student'); $this->setUser($teacher); $gradeitem = component_gradeitem::instance('mod_forum', $forum->get_context(), 'forum'); $this->expectException(moodle_exception::class); $this->expectExceptionMessage("not configured for grading with scales"); store::execute('mod_forum', (int) $forum->get_context()->id, 'forum', (int) $student->id, false, 'formdata'); } /** * Ensure that an execute against a different grading method is rejected. */ public function test_execute_disabled(): void { $this->resetAfterTest(); $forum = $this->get_forum_instance(); $course = $forum->get_course_record(); $teacher = $this->getDataGenerator()->create_and_enrol($course, 'teacher'); $student = $this->getDataGenerator()->create_and_enrol($course, 'student'); $this->setUser($teacher); $gradeitem = component_gradeitem::instance('mod_forum', $forum->get_context(), 'forum'); $this->expectException(moodle_exception::class); $this->expectExceptionMessage("Grading is not enabled"); store::execute('mod_forum', (int) $forum->get_context()->id, 'forum', (int) $student->id, false, 'formdata'); } /** * Ensure that an execute against the correct grading method returns the current state of the user. */ public function test_execute_store_empty(): void { [ 'forum' => $forum, 'options' => $options, 'student' => $student, 'teacher' => $teacher, ] = $this->get_test_data(); $this->setUser($teacher); $formdata = [ 'grade' => null, ]; $gradeitem = component_gradeitem::instance('mod_forum', $forum->get_context(), 'forum'); $result = store::execute('mod_forum', (int) $forum->get_context()->id, 'forum', (int) $student->id, false, http_build_query($formdata)); $result = external_api::clean_returnvalue(store::execute_returns(), $result); // The result should still be empty. $this->assertIsArray($result); $this->assertArrayHasKey('templatename', $result); $this->assertEquals('core_grades/grades/grader/gradingpanel/scale', $result['templatename']); $this->assertArrayHasKey('warnings', $result); $this->assertIsArray($result['warnings']); $this->assertEmpty($result['warnings']); // Test the grade array items. $this->assertArrayHasKey('grade', $result); $this->assertIsArray($result['grade']); $this->assertIsInt($result['grade']['timecreated']); $this->assertArrayHasKey('timemodified', $result['grade']); $this->assertIsInt($result['grade']['timemodified']); $this->assertArrayHasKey('usergrade', $result['grade']); $this->assertEquals('-', $result['grade']['usergrade']); $this->assertArrayHasKey('maxgrade', $result['grade']); $this->assertIsInt($result['grade']['maxgrade']); $this->assertEquals(3, $result['grade']['maxgrade']); $this->assertArrayHasKey('gradedby', $result['grade']); $this->assertEquals(fullname($teacher), $result['grade']['gradedby']); $this->assertArrayHasKey('options', $result['grade']); $this->assertCount(count($options), $result['grade']['options']); rsort($options); foreach ($options as $index => $option) { $this->assertArrayHasKey($index, $result['grade']['options']); $returnedoption = $result['grade']['options'][$index]; $this->assertArrayHasKey('value', $returnedoption); $this->assertEquals(3 - $index, $returnedoption['value']); $this->assertArrayHasKey('title', $returnedoption); $this->assertEquals($option, $returnedoption['title']); $this->assertArrayHasKey('selected', $returnedoption); $this->assertFalse($returnedoption['selected']); } // Compare against the grade stored in the database. $storedgradeitem = grade_item::fetch([ 'courseid' => $forum->get_course_id(), 'itemtype' => 'mod', 'itemmodule' => 'forum', 'iteminstance' => $forum->get_id(), 'itemnumber' => $gradeitem->get_grade_itemid(), ]); $storedgrade = grade_grade::fetch([ 'userid' => $student->id, 'itemid' => $storedgradeitem->id, ]); $this->assertEmpty($storedgrade->rawgrade); } /** * Ensure that an execute against the correct grading method returns the current state of the user. */ public function test_execute_store_not_selected(): void { [ 'forum' => $forum, 'options' => $options, 'student' => $student, 'teacher' => $teacher, ] = $this->get_test_data(); $this->setUser($teacher); $formdata = [ 'grade' => -1, ]; $gradeitem = component_gradeitem::instance('mod_forum', $forum->get_context(), 'forum'); $result = store::execute('mod_forum', (int) $forum->get_context()->id, 'forum', (int) $student->id, false, http_build_query($formdata)); $result = external_api::clean_returnvalue(store::execute_returns(), $result); // The result should still be empty. $this->assertIsArray($result); $this->assertArrayHasKey('templatename', $result); $this->assertEquals('core_grades/grades/grader/gradingpanel/scale', $result['templatename']); $this->assertArrayHasKey('warnings', $result); $this->assertIsArray($result['warnings']); $this->assertEmpty($result['warnings']); // Test the grade array items. $this->assertArrayHasKey('grade', $result); $this->assertIsArray($result['grade']); $this->assertIsInt($result['grade']['timecreated']); $this->assertArrayHasKey('timemodified', $result['grade']); $this->assertIsInt($result['grade']['timemodified']); $this->assertArrayHasKey('usergrade', $result['grade']); $this->assertEquals('-', $result['grade']['usergrade']); $this->assertArrayHasKey('maxgrade', $result['grade']); $this->assertIsInt($result['grade']['maxgrade']); $this->assertEquals(3, $result['grade']['maxgrade']); $this->assertArrayHasKey('gradedby', $result['grade']); $this->assertEquals(null, $result['grade']['gradedby']); $this->assertArrayHasKey('options', $result['grade']); $this->assertCount(count($options), $result['grade']['options']); rsort($options); foreach ($options as $index => $option) { $this->assertArrayHasKey($index, $result['grade']['options']); $returnedoption = $result['grade']['options'][$index]; $this->assertArrayHasKey('value', $returnedoption); $this->assertEquals(3 - $index, $returnedoption['value']); $this->assertArrayHasKey('title', $returnedoption); $this->assertEquals($option, $returnedoption['title']); $this->assertArrayHasKey('selected', $returnedoption); $this->assertFalse($returnedoption['selected']); } // Compare against the grade stored in the database. $storedgradeitem = grade_item::fetch([ 'courseid' => $forum->get_course_id(), 'itemtype' => 'mod', 'itemmodule' => 'forum', 'iteminstance' => $forum->get_id(), 'itemnumber' => $gradeitem->get_grade_itemid(), ]); $storedgrade = grade_grade::fetch([ 'userid' => $student->id, 'itemid' => $storedgradeitem->id, ]); // No grade will have been saved. $this->assertFalse($storedgrade); } /** * Ensure that an execute against the correct grading method returns the current state of the user. */ public function test_execute_store_graded(): void { [ 'scale' => $scale, 'forum' => $forum, 'options' => $options, 'student' => $student, 'teacher' => $teacher, ] = $this->get_test_data(); $this->setUser($teacher); $formdata = [ 'grade' => 2, ]; $formattedvalue = grade_floatval(unformat_float($formdata['grade'])); $gradeitem = component_gradeitem::instance('mod_forum', $forum->get_context(), 'forum'); $result = store::execute('mod_forum', (int) $forum->get_context()->id, 'forum', (int) $student->id, false, http_build_query($formdata)); $result = external_api::clean_returnvalue(store::execute_returns(), $result); // The result should still be empty. $this->assertIsArray($result); $this->assertArrayHasKey('templatename', $result); $this->assertEquals('core_grades/grades/grader/gradingpanel/scale', $result['templatename']); $this->assertArrayHasKey('warnings', $result); $this->assertIsArray($result['warnings']); $this->assertEmpty($result['warnings']); // Test the grade array items. $this->assertArrayHasKey('grade', $result); $this->assertIsArray($result['grade']); $this->assertIsInt($result['grade']['timecreated']); $this->assertArrayHasKey('timemodified', $result['grade']); $this->assertIsInt($result['grade']['timemodified']); $this->assertArrayHasKey('usergrade', $result['grade']); $this->assertEquals('B', $result['grade']['usergrade']); $this->assertArrayHasKey('maxgrade', $result['grade']); $this->assertIsInt($result['grade']['maxgrade']); $this->assertEquals(3, $result['grade']['maxgrade']); $this->assertArrayHasKey('gradedby', $result['grade']); $this->assertEquals(fullname($teacher), $result['grade']['gradedby']); $this->assertArrayHasKey('options', $result['grade']); $this->assertCount(count($options), $result['grade']['options']); rsort($options); foreach ($options as $index => $option) { $this->assertArrayHasKey($index, $result['grade']['options']); $returnedoption = $result['grade']['options'][$index]; $this->assertArrayHasKey('value', $returnedoption); $this->assertEquals(3 - $index, $returnedoption['value']); $this->assertArrayHasKey('title', $returnedoption); $this->assertEquals($option, $returnedoption['title']); $this->assertArrayHasKey('selected', $returnedoption); } // Compare against the grade stored in the database. $storedgradeitem = grade_item::fetch([ 'courseid' => $forum->get_course_id(), 'itemtype' => 'mod', 'itemmodule' => 'forum', 'iteminstance' => $forum->get_id(), 'itemnumber' => $gradeitem->get_grade_itemid(), ]); $storedgrade = grade_grade::fetch([ 'userid' => $student->id, 'itemid' => $storedgradeitem->id, ]); $this->assertEquals($formattedvalue, $storedgrade->rawgrade); $this->assertEquals($scale->id, $storedgrade->rawscaleid); // The grade was 2, which relates to the middle option. $this->assertFalse($result['grade']['options'][0]['selected']); $this->assertTrue($result['grade']['options'][1]['selected']); $this->assertFalse($result['grade']['options'][2]['selected']); } /** * Ensure that an out-of-range value is rejected. * * @dataProvider execute_out_of_range_provider * @param int $suppliedvalue The value that was submitted */ public function test_execute_store_out_of_range(int $suppliedvalue): void { [ 'scale' => $scale, 'forum' => $forum, 'options' => $options, 'student' => $student, 'teacher' => $teacher, ] = $this->get_test_data(); $this->setUser($teacher); $formdata = [ 'grade' => $suppliedvalue, ]; $gradeitem = component_gradeitem::instance('mod_forum', $forum->get_context(), 'forum'); $this->expectException(moodle_exception::class); $this->expectExceptionMessage("Invalid grade '{$suppliedvalue}' provided. Grades must be between 0 and 3."); store::execute('mod_forum', (int) $forum->get_context()->id, 'forum', (int) $student->id, false, http_build_query($formdata)); } /** * Data provider for out of range tests. * * @return array */ public function execute_out_of_range_provider(): array { return [ 'above' => [ 'supplied' => 500, ], 'above just' => [ 'supplied' => 4, ], 'below' => [ 'supplied' => -100, ], '-10' => [ 'supplied' => -10, ], ]; } /** * Get a forum instance. * * @param array $config * @return forum_entity */ protected function get_forum_instance(array $config = []): forum_entity { $this->resetAfterTest(); $datagenerator = $this->getDataGenerator(); $course = $datagenerator->create_course(); $forum = $datagenerator->create_module('forum', array_merge($config, ['course' => $course->id])); $vaultfactory = \mod_forum\local\container::get_vault_factory(); $vault = $vaultfactory->get_forum_vault(); return $vault->get_from_id((int) $forum->id); } /** * Get test data for scaled forums. * * @return array */ protected function get_test_data(): array { $this->resetAfterTest(); $options = [ 'A', 'B', 'C' ]; $scale = $this->getDataGenerator()->create_scale(['scale' => implode(',', $options)]); $forum = $this->get_forum_instance([ // Negative numbers mean a scale. 'grade_forum' => -1 * $scale->id ]); $course = $forum->get_course_record(); $teacher = $this->getDataGenerator()->create_and_enrol($course, 'teacher'); $student = $this->getDataGenerator()->create_and_enrol($course, 'student'); return [ 'forum' => $forum, 'scale' => $scale, 'options' => $options, 'student' => $student, 'teacher' => $teacher, ]; } } tests/grades/grader/gradingpanel/scale/external/fetch_test.php 0000604 00000030562 15062070557 0020635 0 ustar 00 <?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/>. declare(strict_types = 1); namespace core_grades\grades\grader\gradingpanel\scale\external; use advanced_testcase; use coding_exception; use core_grades\component_gradeitem; use core_external\external_api; use mod_forum\local\entities\forum as forum_entity; use moodle_exception; /** * Unit tests for core_grades\component_gradeitems; * * @package core_grades * @category test * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class fetch_test extends advanced_testcase { /** * Ensure that an execute with an invalid component is rejected. */ public function test_execute_invalid_component(): void { $this->resetAfterTest(); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(coding_exception::class); $this->expectExceptionMessage("The 'foo' item is not valid for the 'mod_invalid' component"); fetch::execute('mod_invalid', 1, 'foo', 2); } /** * Ensure that an execute with an invalid itemname on a valid component is rejected. */ public function test_execute_invalid_itemname(): void { $this->resetAfterTest(); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(coding_exception::class); $this->expectExceptionMessage("The 'foo' item is not valid for the 'mod_forum' component"); fetch::execute('mod_forum', 1, 'foo', 2); } /** * Ensure that an execute against a different grading method is rejected. */ public function test_execute_incorrect_type(): void { $this->resetAfterTest(); $forum = $this->get_forum_instance([ // Negative numbers mean a scale. 'grade_forum' => 5, ]); $course = $forum->get_course_record(); $teacher = $this->getDataGenerator()->create_and_enrol($course, 'teacher'); $student = $this->getDataGenerator()->create_and_enrol($course, 'student'); $this->setUser($teacher); $gradeitem = component_gradeitem::instance('mod_forum', $forum->get_context(), 'forum'); $this->expectException(moodle_exception::class); $this->expectExceptionMessage("not configured for grading with scales"); fetch::execute('mod_forum', (int) $forum->get_context()->id, 'forum', (int) $student->id); } /** * Ensure that an execute against the correct grading method returns the current state of the user. */ public function test_execute_fetch_empty(): void { $this->resetAfterTest(); $options = [ 'A', 'B', 'C' ]; $scale = $this->getDataGenerator()->create_scale(['scale' => implode(',', $options)]); $forum = $this->get_forum_instance([ // Negative numbers mean a scale. 'grade_forum' => -1 * $scale->id ]); $course = $forum->get_course_record(); $teacher = $this->getDataGenerator()->create_and_enrol($course, 'teacher'); $student = $this->getDataGenerator()->create_and_enrol($course, 'student'); $this->setUser($teacher); $gradeitem = component_gradeitem::instance('mod_forum', $forum->get_context(), 'forum'); $result = fetch::execute('mod_forum', (int) $forum->get_context()->id, 'forum', (int) $student->id); $result = external_api::clean_returnvalue(fetch::execute_returns(), $result); $this->assertIsArray($result); $this->assertArrayHasKey('templatename', $result); $this->assertEquals('core_grades/grades/grader/gradingpanel/scale', $result['templatename']); $this->assertArrayHasKey('warnings', $result); $this->assertIsArray($result['warnings']); $this->assertEmpty($result['warnings']); // Test the grade array items. $this->assertArrayHasKey('grade', $result); $this->assertIsArray($result['grade']); $this->assertIsInt($result['grade']['timecreated']); $this->assertArrayHasKey('timemodified', $result['grade']); $this->assertIsInt($result['grade']['timemodified']); $this->assertArrayHasKey('usergrade', $result['grade']); $this->assertEquals('-', $result['grade']['usergrade']); $this->assertArrayHasKey('maxgrade', $result['grade']); $this->assertIsInt($result['grade']['maxgrade']); $this->assertEquals(3, $result['grade']['maxgrade']); $this->assertArrayHasKey('gradedby', $result['grade']); $this->assertEquals(null, $result['grade']['gradedby']); $this->assertArrayHasKey('options', $result['grade']); $this->assertCount(count($options), $result['grade']['options']); rsort($options); foreach ($options as $index => $option) { $this->assertArrayHasKey($index, $result['grade']['options']); $returnedoption = $result['grade']['options'][$index]; $this->assertArrayHasKey('value', $returnedoption); $this->assertEquals(3 - $index, $returnedoption['value']); $this->assertArrayHasKey('title', $returnedoption); $this->assertEquals($option, $returnedoption['title']); $this->assertArrayHasKey('selected', $returnedoption); $this->assertFalse($returnedoption['selected']); } } /** * Ensure that an execute against the correct grading method returns the current state of the user. */ public function test_execute_fetch_graded(): void { $this->resetAfterTest(); $options = [ 'A', 'B', 'C' ]; $scale = $this->getDataGenerator()->create_scale(['scale' => implode(',', $options)]); $forum = $this->get_forum_instance([ // Negative numbers mean a scale. 'grade_forum' => -1 * $scale->id ]); $course = $forum->get_course_record(); $teacher = $this->getDataGenerator()->create_and_enrol($course, 'teacher'); $student = $this->getDataGenerator()->create_and_enrol($course, 'student'); $this->execute_and_assert_fetch($forum, $options, $scale, $teacher, $teacher, $student); } /** * Class mates should not get other's grades. */ public function test_execute_fetch_does_not_return_data_to_other_students(): void { $this->resetAfterTest(); $options = [ 'A', 'B', 'C' ]; $scale = $this->getDataGenerator()->create_scale(['scale' => implode(',', $options)]); $forum = $this->get_forum_instance([ // Negative numbers mean a scale. 'grade_forum' => -1 * $scale->id ]); $course = $forum->get_course_record(); $teacher = $this->getDataGenerator()->create_and_enrol($course, 'teacher'); $student = $this->getDataGenerator()->create_and_enrol($course, 'student'); $evilstudent = $this->getDataGenerator()->create_and_enrol($course, 'student'); $this->expectException(\required_capability_exception::class); $this->execute_and_assert_fetch($forum, $options, $scale, $evilstudent, $teacher, $student); } /** * Grades can be returned to graded user. */ public function test_execute_fetch_return_data_to_graded_user(): void { $this->resetAfterTest(); $options = [ 'A', 'B', 'C' ]; $scale = $this->getDataGenerator()->create_scale(['scale' => implode(',', $options)]); $forum = $this->get_forum_instance([ // Negative numbers mean a scale. 'grade_forum' => -1 * $scale->id ]); $course = $forum->get_course_record(); $teacher = $this->getDataGenerator()->create_and_enrol($course, 'teacher'); $student = $this->getDataGenerator()->create_and_enrol($course, 'student'); $this->execute_and_assert_fetch($forum, $options, $scale, $student, $teacher, $student); } /** * Executes the fetch method with the given users and returns the result. */ private function execute_and_assert_fetch ($forum, $options, $scale, $fetcheruser, $grader, $gradeduser) { $this->setUser($grader); $gradeitem = component_gradeitem::instance('mod_forum', $forum->get_context(), 'forum'); $gradeitem->store_grade_from_formdata($gradeduser, $grader, (object) [ 'grade' => 2, ]); $this->setUser($fetcheruser); $result = fetch::execute('mod_forum', (int) $forum->get_context()->id, 'forum', (int) $gradeduser->id); $result = external_api::clean_returnvalue(fetch::execute_returns(), $result); $this->assertIsArray($result); $this->assertArrayHasKey('templatename', $result); $this->assertEquals('core_grades/grades/grader/gradingpanel/scale', $result['templatename']); $result = fetch::execute('mod_forum', (int) $forum->get_context()->id, 'forum', (int) $gradeduser->id); $result = external_api::clean_returnvalue(fetch::execute_returns(), $result); $this->assertIsArray($result); $this->assertArrayHasKey('templatename', $result); $this->assertEquals('core_grades/grades/grader/gradingpanel/scale', $result['templatename']); $this->assertArrayHasKey('warnings', $result); $this->assertIsArray($result['warnings']); $this->assertEmpty($result['warnings']); // Test the grade array items. $this->assertArrayHasKey('grade', $result); $this->assertIsArray($result['grade']); $this->assertIsInt($result['grade']['timecreated']); $this->assertArrayHasKey('timemodified', $result['grade']); $this->assertIsInt($result['grade']['timemodified']); $this->assertArrayHasKey('usergrade', $result['grade']); $this->assertEquals('B', $result['grade']['usergrade']); $this->assertArrayHasKey('maxgrade', $result['grade']); $this->assertIsInt($result['grade']['maxgrade']); $this->assertEquals(3, $result['grade']['maxgrade']); $this->assertArrayHasKey('gradedby', $result['grade']); $this->assertEquals(fullname($grader), $result['grade']['gradedby']); $this->assertArrayHasKey('options', $result['grade']); $this->assertCount(count($options), $result['grade']['options']); rsort($options); foreach ($options as $index => $option) { $this->assertArrayHasKey($index, $result['grade']['options']); $returnedoption = $result['grade']['options'][$index]; $this->assertArrayHasKey('value', $returnedoption); $this->assertEquals(3 - $index, $returnedoption['value']); $this->assertArrayHasKey('title', $returnedoption); $this->assertEquals($option, $returnedoption['title']); $this->assertArrayHasKey('selected', $returnedoption); } // The grade was 2, which relates to the middle option. $this->assertFalse($result['grade']['options'][0]['selected']); $this->assertTrue($result['grade']['options'][1]['selected']); $this->assertFalse($result['grade']['options'][2]['selected']); } /** * Get a forum instance. * * @param array $config * @return forum_entity */ protected function get_forum_instance(array $config = []): forum_entity { $this->resetAfterTest(); $datagenerator = $this->getDataGenerator(); $course = $datagenerator->create_course(); $forum = $datagenerator->create_module('forum', array_merge($config, ['course' => $course->id])); $vaultfactory = \mod_forum\local\container::get_vault_factory(); $vault = $vaultfactory->get_forum_vault(); return $vault->get_from_id((int) $forum->id); } } tests/grades/grader/gradingpanel/point/external/fetch_test.php 0000604 00000023470 15062070557 0020677 0 ustar 00 <?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/>. declare(strict_types = 1); namespace core_grades\grades\grader\gradingpanel\point\external; use advanced_testcase; use coding_exception; use core_grades\component_gradeitem; use core_external\external_api; use mod_forum\local\entities\forum as forum_entity; use moodle_exception; /** * Unit tests for core_grades\component_gradeitems; * * @package core_grades * @category test * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class fetch_test extends advanced_testcase { /** * Ensure that an execute with an invalid component is rejected. */ public function test_execute_invalid_component(): void { $this->resetAfterTest(); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(coding_exception::class); $this->expectExceptionMessage("The 'foo' item is not valid for the 'mod_invalid' component"); fetch::execute('mod_invalid', 1, 'foo', 2); } /** * Ensure that an execute with an invalid itemname on a valid component is rejected. */ public function test_execute_invalid_itemname(): void { $this->resetAfterTest(); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(coding_exception::class); $this->expectExceptionMessage("The 'foo' item is not valid for the 'mod_forum' component"); fetch::execute('mod_forum', 1, 'foo', 2); } /** * Ensure that an execute against a different grading method is rejected. */ public function test_execute_incorrect_type(): void { $this->resetAfterTest(); $forum = $this->get_forum_instance([ // Negative numbers mean a scale. 'grade_forum' => -1, ]); $course = $forum->get_course_record(); $teacher = $this->getDataGenerator()->create_and_enrol($course, 'teacher'); $student = $this->getDataGenerator()->create_and_enrol($course, 'student'); $this->setUser($teacher); $gradeitem = component_gradeitem::instance('mod_forum', $forum->get_context(), 'forum'); $this->expectException(moodle_exception::class); $this->expectExceptionMessage("not configured for direct grading"); fetch::execute('mod_forum', (int) $forum->get_context()->id, 'forum', (int) $student->id); } /** * Ensure that an execute against the correct grading method returns the current state of the user. */ public function test_execute_fetch_empty(): void { $this->resetAfterTest(); $forum = $this->get_forum_instance([ // Negative numbers mean a scale. 'grade_forum' => 5, ]); $course = $forum->get_course_record(); $teacher = $this->getDataGenerator()->create_and_enrol($course, 'teacher'); $student = $this->getDataGenerator()->create_and_enrol($course, 'student'); $this->setUser($teacher); $gradeitem = component_gradeitem::instance('mod_forum', $forum->get_context(), 'forum'); $result = fetch::execute('mod_forum', (int) $forum->get_context()->id, 'forum', (int) $student->id); $result = external_api::clean_returnvalue(fetch::execute_returns(), $result); $this->assertIsArray($result); $this->assertArrayHasKey('templatename', $result); $this->assertEquals('core_grades/grades/grader/gradingpanel/point', $result['templatename']); $this->assertArrayHasKey('warnings', $result); $this->assertIsArray($result['warnings']); $this->assertEmpty($result['warnings']); // Test the grade array items. $this->assertArrayHasKey('grade', $result); $this->assertIsArray($result['grade']); $this->assertArrayHasKey('grade', $result['grade']); $this->assertEmpty($result['grade']['grade']); $this->assertIsInt($result['grade']['timecreated']); $this->assertArrayHasKey('timemodified', $result['grade']); $this->assertIsInt($result['grade']['timemodified']); $this->assertArrayHasKey('usergrade', $result['grade']); $this->assertEquals('- / 5.00', $result['grade']['usergrade']); $this->assertArrayHasKey('maxgrade', $result['grade']); $this->assertIsInt($result['grade']['maxgrade']); $this->assertEquals(5, $result['grade']['maxgrade']); $this->assertArrayHasKey('gradedby', $result['grade']); $this->assertEquals(null, $result['grade']['gradedby']); } /** * Ensure that an execute against the correct grading method returns the current state of the user. */ public function test_execute_fetch_graded(): void { $this->resetAfterTest(); $forum = $this->get_forum_instance([ // Negative numbers mean a scale. 'grade_forum' => 5, ]); $course = $forum->get_course_record(); $teacher = $this->getDataGenerator()->create_and_enrol($course, 'teacher'); $student = $this->getDataGenerator()->create_and_enrol($course, 'student'); $this->execute_and_assert_fetch($forum, $teacher, $teacher, $student); } /** * Class mates should not get other's grades. */ public function test_execute_fetch_does_not_return_data_to_other_students(): void { $this->resetAfterTest(); $forum = $this->get_forum_instance([ // Negative numbers mean a scale. 'grade_forum' => 5, ]); $course = $forum->get_course_record(); $teacher = $this->getDataGenerator()->create_and_enrol($course, 'teacher'); $student = $this->getDataGenerator()->create_and_enrol($course, 'student'); $evilstudent = $this->getDataGenerator()->create_and_enrol($course, 'student'); $this->expectException(\required_capability_exception::class); $this->execute_and_assert_fetch($forum, $evilstudent, $teacher, $student); } /** * Grades can be returned to graded user. */ public function test_execute_fetch_return_data_to_graded_user(): void { $this->resetAfterTest(); $forum = $this->get_forum_instance([ // Negative numbers mean a scale. 'grade_forum' => 5, ]); $course = $forum->get_course_record(); $teacher = $this->getDataGenerator()->create_and_enrol($course, 'teacher'); $student = $this->getDataGenerator()->create_and_enrol($course, 'student'); $this->execute_and_assert_fetch($forum, $student, $teacher, $student); } /** * Executes the fetch method with the given users and returns the result. */ private function execute_and_assert_fetch ($forum, $fetcheruser, $grader, $gradeduser) { $this->setUser($grader); $gradeitem = component_gradeitem::instance('mod_forum', $forum->get_context(), 'forum'); $gradeitem->store_grade_from_formdata($gradeduser, $grader, (object) [ 'grade' => 4, ]); $this->setUser($fetcheruser); $result = fetch::execute('mod_forum', (int) $forum->get_context()->id, 'forum', (int) $gradeduser->id); $result = external_api::clean_returnvalue(fetch::execute_returns(), $result); $this->assertIsArray($result); $this->assertArrayHasKey('templatename', $result); $this->assertEquals('core_grades/grades/grader/gradingpanel/point', $result['templatename']); $this->assertArrayHasKey('warnings', $result); $this->assertIsArray($result['warnings']); $this->assertEmpty($result['warnings']); // Test the grade array items. $this->assertArrayHasKey('grade', $result); $this->assertIsArray($result['grade']); $this->assertArrayHasKey('grade', $result['grade']); $this->assertIsFloat($result['grade']['grade']); $this->assertEquals(grade_floatval(unformat_float(4)), $result['grade']['grade']); $this->assertIsInt($result['grade']['timecreated']); $this->assertArrayHasKey('timemodified', $result['grade']); $this->assertIsInt($result['grade']['timemodified']); $this->assertArrayHasKey('usergrade', $result['grade']); $this->assertEquals('4.00 / 5.00', $result['grade']['usergrade']); $this->assertArrayHasKey('maxgrade', $result['grade']); $this->assertIsInt($result['grade']['maxgrade']); $this->assertEquals(5, $result['grade']['maxgrade']); $this->assertArrayHasKey('gradedby', $result['grade']); $this->assertEquals(fullname($grader), $result['grade']['gradedby']); return $result; } /** * Get a forum instance. * * @param array $config * @return forum_entity */ protected function get_forum_instance(array $config = []): forum_entity { $this->resetAfterTest(); $datagenerator = $this->getDataGenerator(); $course = $datagenerator->create_course(); $forum = $datagenerator->create_module('forum', array_merge($config, ['course' => $course->id])); $vaultfactory = \mod_forum\local\container::get_vault_factory(); $vault = $vaultfactory->get_forum_vault(); return $vault->get_from_id((int) $forum->id); } } tests/grades/grader/gradingpanel/point/external/store_test.php 0000604 00000031107 15062070557 0020736 0 ustar 00 <?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/>. declare(strict_types = 1); namespace core_grades\grades\grader\gradingpanel\point\external; use advanced_testcase; use coding_exception; use core_grades\component_gradeitem; use core_external\external_api; use mod_forum\local\entities\forum as forum_entity; use moodle_exception; use grade_grade; use grade_item; /** * Unit tests for core_grades\component_gradeitems; * * @package core_grades * @category test * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class store_test extends advanced_testcase { /** * Ensure that an execute with an invalid component is rejected. */ public function test_execute_invalid_component(): void { $this->resetAfterTest(); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(coding_exception::class); $this->expectExceptionMessage("The 'foo' item is not valid for the 'mod_invalid' component"); store::execute('mod_invalid', 1, 'foo', 2, false, 'formdata'); } /** * Ensure that an execute with an invalid itemname on a valid component is rejected. */ public function test_execute_invalid_itemname(): void { $this->resetAfterTest(); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(coding_exception::class); $this->expectExceptionMessage("The 'foo' item is not valid for the 'mod_forum' component"); store::execute('mod_forum', 1, 'foo', 2, false, 'formdata'); } /** * Ensure that an execute against a different grading method is rejected. */ public function test_execute_incorrect_type(): void { $this->resetAfterTest(); $forum = $this->get_forum_instance([ // Negative numbers mean a scale. 'grade_forum' => -1, ]); $course = $forum->get_course_record(); $teacher = $this->getDataGenerator()->create_and_enrol($course, 'teacher'); $student = $this->getDataGenerator()->create_and_enrol($course, 'student'); $this->setUser($teacher); $gradeitem = component_gradeitem::instance('mod_forum', $forum->get_context(), 'forum'); $this->expectException(moodle_exception::class); $this->expectExceptionMessage("not configured for direct grading"); store::execute('mod_forum', (int) $forum->get_context()->id, 'forum', (int) $student->id, false, 'formdata'); } /** * Ensure that an execute against a different grading method is rejected. */ public function test_execute_disabled(): void { $this->resetAfterTest(); $forum = $this->get_forum_instance(); $course = $forum->get_course_record(); $teacher = $this->getDataGenerator()->create_and_enrol($course, 'teacher'); $student = $this->getDataGenerator()->create_and_enrol($course, 'student'); $this->setUser($teacher); $gradeitem = component_gradeitem::instance('mod_forum', $forum->get_context(), 'forum'); $this->expectException(moodle_exception::class); $this->expectExceptionMessage("Grading is not enabled"); store::execute('mod_forum', (int) $forum->get_context()->id, 'forum', (int) $student->id, false, 'formdata'); } /** * Ensure that an execute against the correct grading method returns the current state of the user. */ public function test_execute_store_empty(): void { $this->resetAfterTest(); $forum = $this->get_forum_instance([ // Negative numbers mean a scale. 'grade_forum' => 5, ]); $course = $forum->get_course_record(); $teacher = $this->getDataGenerator()->create_and_enrol($course, 'teacher'); $student = $this->getDataGenerator()->create_and_enrol($course, 'student'); $this->setUser($teacher); $formdata = [ 'grade' => null, ]; $gradeitem = component_gradeitem::instance('mod_forum', $forum->get_context(), 'forum'); $result = store::execute('mod_forum', (int) $forum->get_context()->id, 'forum', (int) $student->id, false, http_build_query($formdata)); $result = external_api::clean_returnvalue(store::execute_returns(), $result); // The result should still be empty. $this->assertIsArray($result); $this->assertArrayHasKey('templatename', $result); $this->assertEquals('core_grades/grades/grader/gradingpanel/point', $result['templatename']); $this->assertArrayHasKey('grade', $result); $this->assertIsArray($result['grade']); $this->assertArrayHasKey('grade', $result['grade']); $this->assertEmpty($result['grade']['grade']); $this->assertArrayHasKey('timecreated', $result['grade']); $this->assertIsInt($result['grade']['timecreated']); $this->assertArrayHasKey('timemodified', $result['grade']); $this->assertIsInt($result['grade']['timemodified']); $this->assertArrayHasKey('warnings', $result); $this->assertIsArray($result['warnings']); $this->assertEmpty($result['warnings']); // Test the grade array items. $this->assertArrayHasKey('grade', $result); $this->assertIsArray($result['grade']); $this->assertArrayHasKey('grade', $result['grade']); $this->assertEquals(null, $result['grade']['grade']); $this->assertIsInt($result['grade']['timecreated']); $this->assertArrayHasKey('timemodified', $result['grade']); $this->assertIsInt($result['grade']['timemodified']); $this->assertArrayHasKey('usergrade', $result['grade']); $this->assertEquals('- / 5.00', $result['grade']['usergrade']); $this->assertArrayHasKey('maxgrade', $result['grade']); $this->assertIsInt($result['grade']['maxgrade']); $this->assertEquals(5, $result['grade']['maxgrade']); $this->assertArrayHasKey('gradedby', $result['grade']); $this->assertEquals(fullname($teacher), $result['grade']['gradedby']); // Compare against the grade stored in the database. $storedgradeitem = grade_item::fetch([ 'courseid' => $forum->get_course_id(), 'itemtype' => 'mod', 'itemmodule' => 'forum', 'iteminstance' => $forum->get_id(), 'itemnumber' => $gradeitem->get_grade_itemid(), ]); $storedgrade = grade_grade::fetch([ 'userid' => $student->id, 'itemid' => $storedgradeitem->id, ]); $this->assertEmpty($storedgrade->rawgrade); } /** * Ensure that an execute against the correct grading method returns the current state of the user. */ public function test_execute_store_graded(): void { $this->resetAfterTest(); $forum = $this->get_forum_instance([ // Negative numbers mean a scale. 'grade_forum' => 5, ]); $course = $forum->get_course_record(); $teacher = $this->getDataGenerator()->create_and_enrol($course, 'teacher'); $student = $this->getDataGenerator()->create_and_enrol($course, 'student'); $this->setUser($teacher); $formdata = [ 'grade' => 4, ]; $gradeitem = component_gradeitem::instance('mod_forum', $forum->get_context(), 'forum'); $result = store::execute('mod_forum', (int) $forum->get_context()->id, 'forum', (int) $student->id, false, http_build_query($formdata)); $result = external_api::clean_returnvalue(store::execute_returns(), $result); // The result should still be empty. $this->assertIsArray($result); $this->assertArrayHasKey('templatename', $result); $this->assertEquals('core_grades/grades/grader/gradingpanel/point', $result['templatename']); $this->assertArrayHasKey('warnings', $result); $this->assertIsArray($result['warnings']); $this->assertEmpty($result['warnings']); // Test the grade array items. $this->assertArrayHasKey('grade', $result); $this->assertIsArray($result['grade']); $this->assertArrayHasKey('grade', $result['grade']); $this->assertEquals(grade_floatval(unformat_float(4)), $result['grade']['grade']); $this->assertIsInt($result['grade']['timecreated']); $this->assertArrayHasKey('timemodified', $result['grade']); $this->assertIsInt($result['grade']['timemodified']); $this->assertArrayHasKey('usergrade', $result['grade']); $this->assertEquals('4.00 / 5.00', $result['grade']['usergrade']); $this->assertArrayHasKey('maxgrade', $result['grade']); $this->assertIsInt($result['grade']['maxgrade']); $this->assertEquals(5, $result['grade']['maxgrade']); $this->assertArrayHasKey('gradedby', $result['grade']); $this->assertEquals(fullname($teacher), $result['grade']['gradedby']); // Compare against the grade stored in the database. $storedgradeitem = grade_item::fetch([ 'courseid' => $forum->get_course_id(), 'itemtype' => 'mod', 'itemmodule' => 'forum', 'iteminstance' => $forum->get_id(), 'itemnumber' => $gradeitem->get_grade_itemid(), ]); $storedgrade = grade_grade::fetch([ 'userid' => $student->id, 'itemid' => $storedgradeitem->id, ]); $this->assertEquals(grade_floatval(unformat_float(4)), $storedgrade->rawgrade); } /** * Ensure that an out-of-range value is rejected. * * @dataProvider execute_out_of_range_provider * @param int $maxvalue The max value of the forum * @param int $suppliedvalue The value that was submitted */ public function test_execute_store_out_of__range(int $maxvalue, float $suppliedvalue): void { $this->resetAfterTest(); $forum = $this->get_forum_instance([ // Negative numbers mean a scale. 'grade_forum' => $maxvalue, ]); $course = $forum->get_course_record(); $teacher = $this->getDataGenerator()->create_and_enrol($course, 'teacher'); $student = $this->getDataGenerator()->create_and_enrol($course, 'student'); $this->setUser($teacher); $formdata = [ 'grade' => $suppliedvalue, ]; $gradeitem = component_gradeitem::instance('mod_forum', $forum->get_context(), 'forum'); $this->expectException(moodle_exception::class); $this->expectExceptionMessage("Invalid grade '{$suppliedvalue}' provided. Grades must be between 0 and {$maxvalue}."); store::execute('mod_forum', (int) $forum->get_context()->id, 'forum', (int) $student->id, false, http_build_query($formdata)); } /** * Data provider for out of range tests. * * @return array */ public function execute_out_of_range_provider(): array { return [ 'above' => [ 'max' => 100, 'supplied' => 101, ], 'above just' => [ 'max' => 100, 'supplied' => 101.001, ], 'below' => [ 'max' => 100, 'supplied' => -100, ], '-1' => [ 'max' => 100, 'supplied' => -1, ], ]; } /** * Get a forum instance. * * @param array $config * @return forum_entity */ protected function get_forum_instance(array $config = []): forum_entity { $this->resetAfterTest(); $datagenerator = $this->getDataGenerator(); $course = $datagenerator->create_course(); $forum = $datagenerator->create_module('forum', array_merge($config, ['course' => $course->id])); $vaultfactory = \mod_forum\local\container::get_vault_factory(); $vault = $vaultfactory->get_forum_vault(); return $vault->get_from_id((int) $forum->id); } } tests/behat/behat_grade_deprecated.php 0000604 00000004777 15062070557 0014131 0 ustar 00 <?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/>. // NOTE: no MOODLE_INTERNAL test here, this file may be required by behat before including /config.php. use Behat\Gherkin\Node\TableNode; require_once(__DIR__ . '/../../../lib/behat/behat_deprecated_base.php'); /** * Steps definitions that are now deprecated and will be removed in the next releases. * * This file only contains the steps that previously were in the behat_*.php files in the SAME DIRECTORY. * When deprecating steps from other components or plugins, create a behat_COMPONENT_deprecated.php * file in the same directory where the steps were defined. * * @package core_grades * @category test * @copyright 2023 Ilya Tregubov * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class behat_grade_deprecated extends behat_deprecated_base { /** * Enters a quick feedback via the gradebook for a specific grade item and user when viewing * the 'Grader report' with editing mode turned on. * * @deprecated since 4.2 - we don't allow edit feedback on grader report anymore. * @todo MDL-77107 This will be deleted in Moodle 4.6. * @Given /^I give the feedback "(?P<grade_number>(?:[^"]|\\")*)" to the user "(?P<username_string>(?:[^"]|\\")*)" for the grade item "(?P<grade_activity_string>(?:[^"]|\\")*)"$/ * @param string $feedback * @param string $userfullname the user's fullname as returned by fullname() * @param string $itemname */ public function i_give_the_feedback($feedback, $userfullname, $itemname) { $this->deprecated_message(['behat_grade::i_give_the_feedback']); $gradelabel = $userfullname . ' ' . $itemname; $fieldstr = get_string('useractivityfeedback', 'gradereport_grader', $gradelabel); $this->execute('behat_forms::i_set_the_field_to', array($this->escape($fieldstr), $this->escape($feedback))); } } tests/behat/grade_single_item_scales.feature 0000604 00000020410 15062070557 0015341 0 ustar 00 @core @core_grades @javascript Feature: View gradebook when single item scales are used In order to use single item scales to grade activities As an teacher I need to be able to view gradebook with single item scales Background: Given I log in as "admin" And the "multilang" filter is "on" And the "multilang" filter applies to "content and headings" And I set the following administration settings values: | grade_report_showranges | 1 | | grade_aggregations_visible | Mean of grades,Weighted mean of grades,Simple weighted mean of grades,Mean of grades (with extra credits),Median of grades,Lowest grade,Highest grade,Mode of grades,Natural | And I navigate to "Grades > Scales" in site administration And I press "Add a new scale" And I set the following fields to these values: | Name | <span lang="en" class="multilang">EN</span><span lang="fr" class="multilang">FR</span> Singleitem | | Scale | Ace! | And I press "Save changes" And I log out And the following "courses" exist: | fullname | shortname | | Course 1 | C1 | And the following "users" exist: | username | firstname | lastname | email | idnumber | | teacher1 | Teacher | 1 | teacher1@example.com | t1 | | student1 | Student | 1 | student1@example.com | s1 | | student2 | Student | 2 | student2@example.com | s2 | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | | student2 | C1 | student | And the following "grade categories" exist: | fullname | course | | <span lang='en' class='multilang'>EN</span><span lang='fr' class='multilang'>FR</span> Sub category 1 | C1 | And the following "activities" exist: | activity | course | idnumber | name | intro | gradecategory | | assign | C1 | a1 | Test assignment one | Submit something! | <span lang='en' class='multilang'>EN</span><span lang='fr' class='multilang'>FR</span> Sub category 1 | And the "multilang" filter is "on" And the "multilang" filter applies to "content and headings" And I am on the "Test assignment one" "assign activity editing" page logged in as teacher1 And I expand all fieldsets And I set the field "grade[modgrade_type]" to "Scale" And I set the field "grade[modgrade_scale]" to "EN Singleitem" And I press "Save and display" And I follow "View all submissions" And I click on "Grade" "link" in the "Student 1" "table_row" And I set the field "Grade" to "A" And I press "Save changes" When I am on the "Course 1" "grades > course grade settings" page And I set the field "Show weightings" to "Show" And I set the field "Show contribution to course total" to "Show" And I press "Save changes" And I navigate to "View > Grader report" in the course gradebook And I turn editing mode on Scenario: Test displaying single item scales in gradebook in aggregation method Natural When I turn editing mode off Then the following should exist in the "user-grades" table: | -1- | -1- | -3- | -4- | -5- | | Student 1 | student1@example.com | Ace! | 1.00 | 1.00 | And the following should exist in the "user-grades" table: | -1- | -2- | -3- | -4- | | Range | Ace!–Ace! | 0.00–1.00 | 0.00–1.00 | | Overall average | Ace! | 1.00 | 1.00 | And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget And the following should exist in the "user-grade" table: | Grade item | Grade | Range | Contribution to course total | | Test assignment one | Ace! | Ace!–Ace! | 100.00 % | | ENFR Sub category 1 total | 1.00 | 0–1 | - | | Course total | 1.00 | 0–1 | - | And I click on "Student 2" in the "user" search widget And the following should exist in the "user-grade" table: | Grade item | Grade | Range | Contribution to course total | | Test assignment one | - | Ace!–Ace! | - | | ENFR Sub category 1 total | - | 0–1 | - | | Course total | - | 0–1 | - | And I navigate to "Setup > Gradebook setup" in the course gradebook And the following should exist in the "grade_edit_tree_table" table: | Name | Max grade | | Test assignment one | 1.00 | | ENFR Sub category 1 total | 1.00 | | Course total | 1.00 | Scenario Outline: Test displaying single item scales in gradebook in all other aggregation methods Given I set the following settings for grade item "Course 1" of type "course" on "grader" page: | Aggregation | <aggregation> | And I set the following settings for grade item "<span lang='en' class='multilang'>EN</span><span lang='fr' class='multilang'>FR</span> Sub category 1" of type "category" on "grader" page: | Aggregation | <aggregation> | | Category name | Sub category (<aggregation>) | And I turn editing mode off Then the following should exist in the "user-grades" table: | -1- | -1- | -3- | -4- | -5- | | Student 1 | student1@example.com | Ace! | <cattotal1> | <coursetotal1> | | Student 2 | student2@example.com | - | - | - | And the following should exist in the "user-grades" table: | -1- | -2- | -3- | -4- | | Range | Ace!–Ace! | 0.00–100.0 | 0.00–100.00 | | Overall average | Ace! | <catavg> | <overallavg> | And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget And the following should exist in the "user-grade" table: | Grade item | Grade | Range | Contribution to course total | | Test assignment one | Ace! | Ace!–Ace! | <contrib1> | | Sub category (<aggregation>) total | <cattotal1> | 0–100 | - | | Course total | <coursetotal1> | 0–100 | - | And I navigate to "Setup > Gradebook setup" in the course gradebook And the following should exist in the "grade_edit_tree_table" table: | Name | Max grade | | Test assignment one | Ace! (1) | | Sub category (<aggregation>) total | 100.00 | | Course total | 100.00 | Examples: | aggregation | contrib1 | cattotal1 | coursetotal1 | catavg | overallavg | | Mean of grades | 100.00 % | 100.00 | 100.00 | 100.00 | 100.00 | | Weighted mean of grades | 0.00 % | 100.00 | 100.00 | 100.00 | 100.00 | | Simple weighted mean of grades | 0.00 % | - | - | - | - | | Mean of grades (with extra credits) | 100.00 % | 100.00 | 100.00 | 100.00 | 100.00 | | Median of grades | 100.00 % | 100.00 | 100.00 | 100.00 | 100.00 | | Lowest grade | 100.00 % | 100.00 | 100.00 | 100.00 | 100.00 | | Highest grade | 100.00 % | 100.00 | 100.00 | 100.00 | 100.00 | | Mode of grades | 100.00 % | 100.00 | 100.00 | 100.00 | 100.00 | tests/behat/grade_scales.feature 0000604 00000025240 15062070557 0012770 0 ustar 00 @core @core_grades @javascript Feature: View gradebook when scales are used In order to use scales to grade activities As an teacher I need to be able to view gradebook with scales Background: Given I log in as "admin" And I set the following administration settings values: | grade_report_showranges | 1 | | grade_aggregations_visible | Mean of grades,Weighted mean of grades,Simple weighted mean of grades,Mean of grades (with extra credits),Median of grades,Lowest grade,Highest grade,Mode of grades,Natural | And I navigate to "Grades > Scales" in site administration And I press "Add a new scale" And I set the following fields to these values: | Name | Letterscale | | Scale | F,D,C,B,A | And I press "Save changes" And I log out And the following "courses" exist: | fullname | shortname | | Course 1 | C1 | And the following "users" exist: | username | firstname | lastname | email | idnumber | | teacher1 | Teacher | 1 | teacher1@example.com | t1 | | student1 | Student | 1 | student1@example.com | s1 | | student2 | Student | 2 | student2@example.com | s2 | | student3 | Student | 3 | student3@example.com | s3 | | student4 | Student | 4 | student4@example.com | s4 | | student5 | Student | 5 | student5@example.com | s5 | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | | student2 | C1 | student | | student3 | C1 | student | | student4 | C1 | student | | student5 | C1 | student | And the following "grade categories" exist: | fullname | course | | Sub category 1 | C1 | And the following "activities" exist: | activity | course | idnumber | name | intro | gradecategory | | assign | C1 | a1 | Test assignment one | Submit something! | Sub category 1 | And I am on the "Test assignment one" "assign activity editing" page logged in as teacher1 And I expand all fieldsets And I set the field "grade[modgrade_type]" to "Scale" And I set the field "grade[modgrade_scale]" to "Letterscale" And I press "Save and display" And I follow "View all submissions" And I click on "Grade" "link" in the "Student 1" "table_row" And I set the field "Grade" to "A" And I press "Save changes" And I click on "[data-action=next-user]" "css_element" And I set the field "Grade" to "B" And I press "Save changes" And I click on "[data-action=next-user]" "css_element" And I set the field "Grade" to "C" And I press "Save changes" And I click on "[data-action=next-user]" "css_element" And I set the field "Grade" to "D" And I press "Save changes" And I click on "[data-action=next-user]" "css_element" And I set the field "Grade" to "F" And I press "Save changes" And I am on "Course 1" course homepage And I navigate to "Setup > Course grade settings" in the course gradebook And I set the field "Show weightings" to "Show" And I set the field "Show contribution to course total" to "Show" And I press "Save changes" And I navigate to "View > Grader report" in the course gradebook And I turn editing mode on Scenario: Test displaying scales in gradebook in aggregation method Natural When I turn editing mode off Then the following should exist in the "user-grades" table: | -1- | -1- | -3- | -4- | -5- | | Student 1 | student1@example.com | A | 5.00 | 5.00 | | Student 2 | student2@example.com | B | 4.00 | 4.00 | | Student 3 | student3@example.com | C | 3.00 | 3.00 | | Student 4 | student4@example.com | D | 2.00 | 2.00 | | Student 5 | student5@example.com | F | 1.00 | 1.00 | And the following should exist in the "user-grades" table: | -1- | -2- | -3- | -4- | | Range | F–A | 0.00–5.00 | 0.00–5.00 | | Overall average | C | 3.00 | 3.00 | And I navigate to "View > User report" in the course gradebook And I click on "Student 3" in the "user" search widget And the following should exist in the "user-grade" table: | Grade item | Grade | Range | Percentage | Contribution to course total | | Test assignment one | C | F–A | 50.00 % | 60.00 % | | Sub category 1 total | 3.00 | 0–5 | 60.00 % | - | | Course total | 3.00 | 0–5 | 60.00 % | - | And I navigate to "Setup > Gradebook setup" in the course gradebook And the following should exist in the "grade_edit_tree_table" table: | Name | Max grade | | Test assignment one | 5.00 | | Sub category 1 total | 5.00 | | Course total | 5.00 | And I log out And I log in as "student2" And I follow "Grades" in the user menu And I click on "Course 1" "link" in the "region-main" "region" And the following should exist in the "user-grade" table: | Grade item | Grade | Range | Percentage | Contribution to course total | | Test assignment one | B | F–A | 75.00 % | 80.00 % | | Sub category 1 total | 4.00 | 0–5 | 80.00 % | - | | Course total | 4.00 | 0–5 | 80.00 % | - | Scenario Outline: Test displaying scales in gradebook in all other aggregation methods Given I set the following settings for grade item "Course 1" of type "course" on "grader" page: | Aggregation | <aggregation> | And I set the following settings for grade item "Sub category 1" of type "category" on "grader" page: | Aggregation | <aggregation> | | Category name | Sub category (<aggregation>) | | Maximum grade | 5 | | Minimum grade | 1 | And I turn editing mode off Then the following should exist in the "user-grades" table: | -1- | -1- | -3- | -4- | -5- | | Student 1 | student1@example.com | A | 5.00 | <coursetotal1> | | Student 2 | student2@example.com | B | 4.00 | <coursetotal2> | | Student 3 | student3@example.com | C | 3.00 | <coursetotal3> | | Student 4 | student4@example.com | D | 2.00 | <coursetotal4> | | Student 5 | student5@example.com | F | 1.00 | <coursetotal5> | And the following should exist in the "user-grades" table: | -1- | -2- | -3- | -4- | | Range | F–A | 1.00–5.00 | 0.00–100.00 | | Overall average | C | 3.00 | <overallavg> | And I navigate to "View > User report" in the course gradebook And I click on "Student 3" in the "user" search widget And the following should exist in the "user-grade" table: | Grade item | Grade | Range | Percentage | Contribution to course total | | Test assignment one | C | F–A | 50.00 % | <contrib3> | | Sub category (<aggregation>) total | 3.00 | 1–5 | 50.00 % | - | | Course total | <coursetotal3> | 0–100 | <courseperc3> | - | And I navigate to "Setup > Gradebook setup" in the course gradebook And the following should exist in the "grade_edit_tree_table" table: | Name | Max grade | | Test assignment one | A (5) | | Sub category (<aggregation>) total | | | Course total | | And I log out And I log in as "student2" And I follow "Grades" in the user menu And I click on "Course 1" "link" in the "region-main" "region" And the following should exist in the "user-grade" table: | Grade item | Grade | Range | Percentage | Contribution to course total | | Test assignment one | B | F–A | 75.00 % | <contrib2> | | Sub category (<aggregation>) total | 4.00 | 1–5 | 75.00 % | - | | Course total | <coursetotal2> | 0–100 | <courseperc2> | - | Examples: | aggregation | coursetotal1 | coursetotal2 | coursetotal3 | coursetotal4 | coursetotal5 |overallavg | courseperc2 | courseperc3 | contrib2 | contrib3 | | Mean of grades | 100.00 | 75.00 | 50.00 | 25.00 | 0.00 | 50.00 | 75.00 % | 50.00 % | 75.00 % | 50.00 % | | Weighted mean of grades | 100.00 | 75.00 | 50.00 | 25.00 | 0.00 | 50.00 | 75.00 % | 50.00 % | 75.00 % | 50.00 % | | Simple weighted mean of grades | 100.00 | 75.00 | 50.00 | 25.00 | 0.00 | 50.00 | 75.00 % | 50.00 % | 75.00 % | 50.00 % | | Mean of grades (with extra credits) | 100.00 | 75.00 | 50.00 | 25.00 | 0.00 | 50.00 | 75.00 % | 50.00 % | 75.00 % | 50.00 % | | Median of grades | 100.00 | 75.00 | 50.00 | 25.00 | 0.00 | 50.00 | 75.00 % | 50.00 % | 75.00 % | 50.00 % | | Lowest grade | 100.00 | 75.00 | 50.00 | 25.00 | 0.00 | 50.00 | 75.00 % | 50.00 % | 75.00 % | 50.00 % | | Highest grade | 100.00 | 75.00 | 50.00 | 25.00 | 0.00 | 50.00 | 75.00 % | 50.00 % | 75.00 % | 50.00 % | | Mode of grades | 100.00 | 75.00 | 50.00 | 25.00 | 0.00 | 50.00 | 75.00 % | 50.00 % | 75.00 % | 50.00 % | tests/behat/siteadmin_grades_outcomes_breadcrumbs.feature 0000604 00000002526 15062070557 0020147 0 ustar 00 @core @core_grades @javascript Feature: Verify the breadcrumbs in grade outcomes site administration pages Whenever I navigate to advanced features page in site administration As an admin The breadcrumbs should be visible Background: Given I log in as "admin" Scenario: Verify the breadcrumbs in grades outcomes by adding a new outcome, visiting editing page and visiting delete page as an admin Given I navigate to "Advanced features" in site administration And I click on "Enable outcomes" "checkbox" And I press "Save changes" And I navigate to "Grades > Outcomes" in site administration And I click on "Add a new outcome" "button" And "Add an outcome" "text" should exist in the ".breadcrumb" "css_element" And "Outcomes" "link" should exist in the ".breadcrumb" "css_element" And I set the field "Full name" to "Outcome test" And I set the field "Short name" to "outcome_test" And I press "Save changes" When I click on "Edit" "link" Then "Edit outcome" "text" should exist in the ".breadcrumb" "css_element" And "Outcomes" "link" should exist in the ".breadcrumb" "css_element" And I press "Cancel" And I click on "Delete" "link" And "Delete outcome" "text" should exist in the ".breadcrumb" "css_element" And "Outcomes" "link" should exist in the ".breadcrumb" "css_element" tests/behat/grade_item_validation.feature 0000604 00000014713 15062070557 0014671 0 ustar 00 @core_grades @javascript Feature: Grade item validation In order to ensure validation is provided to the teacher As a teacher I need to know why I can not add/edit values on the grade item form Background: Given the following "users" exist: | username | firstname | lastname | email | | student1 | Student | 1 | student1@example.com | | teacher1 | Teacher | 1 | teacher1@example.com | And the following "courses" exist: | fullname | shortname | category | groupmode | | Course 1 | C1 | 0 | 1 | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | And the following "grade categories" exist: | fullname | course | | Category 1 | C1 | And I log in as "admin" And I navigate to "Grades > Scales" in site administration And I press "Add a new scale" And I set the following fields to these values: | Name | ABCDEF | | Scale | F,E,D,C,B,A | And I press "Save changes" And I press "Add a new scale" And I set the following fields to these values: | Name | Letter scale | | Scale | Disappointing, Good, Very good, Excellent | And I press "Save changes" And I am on the "Course 1" "grades > gradebook setup" page And I choose the "Add grade item" item in the "Add" action menu And I set the following fields to these values: | Item name | MI 1 | And I click on "Save" "button" in the "New grade item" "dialogue" Scenario: Being able to change the grade type, scale and maximum grade for a manual grade item when there are no grades Given I click on grade item menu "MI 1" of type "gradeitem" on "setup" page And I choose "Edit grade item" in the open action menu When I should not see "Some grades have already been awarded, so the grade type" Then I set the field "Grade type" to "Scale" And I click on "Save" "button" in the "Edit grade item" "dialogue" And I should see "Scale must be selected" And I set the field "Scale" to "ABCDEF" And I click on "Save" "button" in the "Edit grade item" "dialogue" And I should not see "You cannot change the type, as grades already exist for this item" And I click on grade item menu "MI 1" of type "gradeitem" on "setup" page And I choose "Edit grade item" in the open action menu And I should not see "Some grades have already been awarded, so the grade type" And I set the field "Scale" to "Letter scale" And I click on "Save" "button" in the "Edit grade item" "dialogue" And I should not see "You cannot change the scale, as grades already exist for this item" Scenario: Attempting to change a manual item's grade type when grades already exist Given I navigate to "View > Grader report" in the course gradebook And I turn editing mode on And I give the grade "20.00" to the user "Student 1" for the grade item "MI 1" And I press "Save changes" And I navigate to "Setup > Gradebook setup" in the course gradebook And I click on grade item menu "MI 1" of type "gradeitem" on "setup" page When I choose "Edit grade item" in the open action menu Then I should see "Some grades have already been awarded, so the grade type cannot be changed. If you wish to change the maximum grade, you must first choose whether or not to rescale existing grades." And "//div[contains(concat(' ', normalize-space(@class), ' '), 'felement') and contains(text(), 'Value')]" "xpath_element" should exist Scenario: Attempting to change a manual item's scale when grades already exist Given I click on grade item menu "MI 1" of type "gradeitem" on "setup" page And I choose "Edit grade item" in the open action menu And I set the field "Grade type" to "Scale" And I set the field "Scale" to "ABCDEF" And I click on "Save" "button" in the "Edit grade item" "dialogue" And I navigate to "View > Grader report" in the course gradebook And I turn editing mode on And I give the grade "C" to the user "Student 1" for the grade item "MI 1" And I press "Save changes" And I navigate to "Setup > Gradebook setup" in the course gradebook And I click on grade item menu "MI 1" of type "gradeitem" on "setup" page And I choose "Edit grade item" in the open action menu Then I should see "Some grades have already been awarded, so the grade type and scale cannot be changed." And "//div[contains(concat(' ', normalize-space(@class), ' '), 'felement') and contains(text(), 'ABCDEF')]" "xpath_element" should exist Scenario: Attempting to change a manual item's maximum grade when no rescaling option has been chosen Given I navigate to "View > Grader report" in the course gradebook And I turn editing mode on And I give the grade "20.00" to the user "Student 1" for the grade item "MI 1" And I press "Save changes" And I navigate to "Setup > Gradebook setup" in the course gradebook And I click on grade item menu "MI 1" of type "gradeitem" on "setup" page When I choose "Edit grade item" in the open action menu Then I should see "Some grades have already been awarded, so the grade type cannot be changed. If you wish to change the maximum grade, you must first choose whether or not to rescale existing grades." And I should see "Choose" in the "Rescale existing grades" "field" And the "Maximum grade" "field" should be disabled Scenario: As a teacher confirm that I can delete items within the gradebook Given I navigate to "Setup > Gradebook setup" in the course gradebook And the following should exist in the "setup-grades" table: | Name | | Course | | MI 1 | | Category 1 | | Course total | And I click on grade item menu "MI 1" of type "gradeitem" on "setup" page And I choose "Delete" in the open action menu And "Confirm" "dialogue" should exist When I click on "Delete" "button" in the "Confirm" "dialogue" And I wait to be redirected And the following should not exist in the "setup-grades" table: | Name | | MI 1 | When I click on grade item menu "Category 1" of type "category" on "setup" page And I choose "Delete" in the open action menu And "Confirm" "dialogue" should exist And I click on "Delete" "button" in the "Confirm" "dialogue" And I wait to be redirected And the following should not exist in the "setup-grades" table: | Name | | Category 1 | tests/behat/grade_natural_normalisation.feature 0000604 00000040054 15062070557 0016123 0 ustar 00 @core @core_grades Feature: We can use natural aggregation and weights will be normalised to a total of one hundred In order to override weights As a teacher I need to add assessments to the gradebook. Background: Given the following "courses" exist: | fullname | shortname | category | groupmode | | Course 1 | C1 | 0 | 1 | And the following "users" exist: | username | firstname | lastname | email | idnumber | | teacher1 | Teacher | 1 | teacher1@example.com | t1 | | student1 | Student | 1 | student1@example.com | s1 | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | And the following "grade categories" exist: | fullname | course | | Sub category 1 | C1 | And the following "activities" exist: | activity | course | idnumber | name | intro | grade | | assign | C1 | a1 | Test assignment one | Submit something! | 300 | | assign | C1 | a2 | Test assignment two | Submit something! | 100 | | assign | C1 | a3 | Test assignment three | Submit something! | 150 | | assign | C1 | a4 | Test assignment four | Submit nothing! | 150 | And the following "activities" exist: | activity | course | idnumber | name | intro | gradecategory | grade | | assign | C1 | a5 | Test assignment five | Submit something! | Sub category 1 | 20 | | assign | C1 | a6 | Test assignment six | Submit something! | Sub category 1 | 10 | | assign | C1 | a7 | Test assignment seven | Submit nothing! | Sub category 1 | 15 | And I am on the "Course 1" "grades > gradebook setup" page logged in as "teacher1" @javascript Scenario: Setting all weights in a category to exactly one hundred in total. And the field "Weight of Test assignment five" matches value "44.444" And the field "Weight of Test assignment six" matches value "22.222" And the field "Weight of Test assignment seven" matches value "33.333" When I set the field "Override weight of Test assignment five" to "1" And I set the field "Override weight of Test assignment six" to "1" And I set the field "Override weight of Test assignment seven" to "1" And I set the field "Weight of Test assignment five" to "30" And I set the field "Weight of Test assignment six" to "50" And I set the field "Weight of Test assignment seven" to "20" And I press "Save changes" Then I should not see "Your weights have been adjusted to total 100." And the field "Weight of Test assignment five" matches value "30.0" And the field "Weight of Test assignment six" matches value "50.0" And the field "Weight of Test assignment seven" matches value "20.0" @javascript Scenario: Setting all weights in a category to less than one hundred is prevented. When I set the field "Override weight of Test assignment five" to "1" And I set the field "Override weight of Test assignment six" to "1" And I set the field "Override weight of Test assignment seven" to "1" And I set the field "Weight of Test assignment five" to "1" And I set the field "Weight of Test assignment six" to "1" And I set the field "Weight of Test assignment seven" to "2" Then I should see "Weight total is less than 100%." in the "Test assignment five" "table_row" And I should see "Weight total is less than 100%." in the "Test assignment six" "table_row" And I should see "Weight total is less than 100%." in the "Test assignment seven" "table_row" And I start watching to see if a new page loads And I press "Save changes" And a new page should not have loaded since I started watching @javascript Scenario: Set one of the grade item weights to a figure over one hundred is prevented. When I set the field "Override weight of Test assignment five" to "1" And I set the field "Weight of Test assignment five" to "120" Then I should see "Weight total exceeds 100%." in the "Test assignment five" "table_row" And the field "Weight of Test assignment five" matches value "120.0" And the field "Weight of Test assignment six" matches value "0.0" And the field "Weight of Test assignment seven" matches value "0.0" And I start watching to see if a new page loads And I press "Save changes" And a new page should not have loaded since I started watching @javascript Scenario: Setting several but not all grade item weights to over one hundred each is prevented. When I set the field "Override weight of Test assignment five" to "1" And I set the field "Override weight of Test assignment six" to "1" And I set the field "Weight of Test assignment five" to "150" And I set the field "Weight of Test assignment six" to "150" Then I should see "Weight total exceeds 100%." in the "Test assignment five" "table_row" And I should see "Weight total exceeds 100%." in the "Test assignment six" "table_row" And the field "Weight of Test assignment five" matches value "150.0" And the field "Weight of Test assignment six" matches value "150.0" And the field "Weight of Test assignment seven" matches value "0.0" And I start watching to see if a new page loads And I press "Save changes" And a new page should not have loaded since I started watching @javascript Scenario: Grade items weights are not normalised when all grade item weights are overridden (sum exactly 100). Extra credit is set respectful to number of items. When I set the following settings for grade item "Test assignment seven" of type "gradeitem" on "setup" page: | Extra credit | 1 | And the field "Weight of Test assignment five" matches value "66.667" And the field "Weight of Test assignment six" matches value "33.333" And the field "Weight of Test assignment seven" matches value "50.0" And I set the field "Override weight of Test assignment five" to "1" And I set the field "Override weight of Test assignment six" to "1" And I set the field "Weight of Test assignment five" to "60" And I set the field "Weight of Test assignment six" to "40" And I press "Save changes" Then I should not see "Your weights have been adjusted to total 100." And the field "Weight of Test assignment five" matches value "60.000" And the field "Weight of Test assignment six" matches value "40.000" And the field "Weight of Test assignment seven" matches value "50.0" And I reset weights for grade category "Sub category 1" And the field "Weight of Test assignment five" matches value "66.667" And the field "Weight of Test assignment six" matches value "33.333" And the field "Weight of Test assignment seven" matches value "50.0" @javascript Scenario: Setting grade items weights is prevented when all grade item weights are overridden (sum over 100). Extra credit is set respectful to number of items. When I set the following settings for grade item "Test assignment seven" of type "gradeitem" on "setup" page: | Extra credit | 1 | And I set the field "Override weight of Test assignment five" to "1" And I set the field "Override weight of Test assignment six" to "1" And I set the field "Weight of Test assignment five" to "60" And I set the field "Weight of Test assignment six" to "50" Then I should see "Weight total exceeds 100%." in the "Test assignment five" "table_row" And I should see "Weight total exceeds 100%." in the "Test assignment six" "table_row" And the field "Weight of Test assignment five" matches value "60.0" And the field "Weight of Test assignment six" matches value "50.0" And the field "Weight of Test assignment seven" matches value "50.0" And I start watching to see if a new page loads And I press "Save changes" And a new page should not have loaded since I started watching And I reset weights for grade category "Sub category 1" And the field "Weight of Test assignment five" matches value "66.667" And the field "Weight of Test assignment six" matches value "33.333" And the field "Weight of Test assignment seven" matches value "50.0" @javascript Scenario: Setting grade items weights is prevented when all grade item weights are overridden (sum under 100). Extra credit is set respectful to number of items. When I set the following settings for grade item "Test assignment seven" of type "gradeitem" on "setup" page: | Extra credit | 1 | And I set the field "Override weight of Test assignment five" to "1" And I set the field "Override weight of Test assignment six" to "1" And I set the field "Weight of Test assignment five" to "40" And I set the field "Weight of Test assignment six" to "30" Then I should see "Weight total is less than 100%." in the "Test assignment five" "table_row" And I should see "Weight total is less than 100%." in the "Test assignment six" "table_row" And the field "Weight of Test assignment five" matches value "40.0" And the field "Weight of Test assignment six" matches value "30.0" And the field "Weight of Test assignment seven" matches value "50.0" And I start watching to see if a new page loads And I press "Save changes" And a new page should not have loaded since I started watching And I reset weights for grade category "Sub category 1" And the field "Weight of Test assignment five" matches value "66.667" And the field "Weight of Test assignment six" matches value "33.333" And the field "Weight of Test assignment seven" matches value "50.0" @javascript Scenario: Grade items weights are normalised when not all grade item weights are overridden. Extra credit is set respectful to number of items. When I set the following settings for grade item "Test assignment seven" of type "gradeitem" on "setup" page: | Extra credit | 1 | And I set the field "Override weight of Test assignment five" to "1" And I set the field "Weight of Test assignment five" to "40" And I press "Save changes" Then I should see "Your weights have been adjusted to total 100." And the field "Weight of Test assignment five" matches value "40.00" And the field "Weight of Test assignment six" matches value "60.000" And the field "Weight of Test assignment seven" matches value "50.0" And I reset weights for grade category "Sub category 1" And the field "Weight of Test assignment five" matches value "66.667" And the field "Weight of Test assignment six" matches value "33.333" And the field "Weight of Test assignment seven" matches value "50.0" @javascript Scenario: The extra credit grade item weight is overridden to a figure over one hundred and then the grade item is set to normal. When I set the following settings for grade item "Test assignment seven" of type "gradeitem" on "setup" page: | Extra credit | 1 | And I set the field "Override weight of Test assignment seven" to "1" And I set the field "Weight of Test assignment seven" to "105" And I press "Save changes" Then I should not see "Your weights have been adjusted to total 100." And the field "Weight of Test assignment five" matches value "66.667" And the field "Weight of Test assignment six" matches value "33.333" And the field "Weight of Test assignment seven" matches value "105.0" When I set the following settings for grade item "Test assignment seven" of type "gradeitem" on "setup" page: | Extra credit | 0 | And I should see "Your weights have been adjusted to total 100." And the field "Weight of Test assignment five" matches value "0.0" And the field "Weight of Test assignment six" matches value "0.0" And the field "Weight of Test assignment seven" matches value "100.0" @javascript Scenario: The extra credit grade item weight is overridden to a figure over one hundred and then the grade category is reset. When I set the following settings for grade item "Test assignment seven" of type "gradeitem" on "setup" page: | Extra credit | 1 | And I set the field "Override weight of Test assignment seven" to "1" And I set the field "Weight of Test assignment seven" to "105" And I press "Save changes" And I reset weights for grade category "Sub category 1" And the field "Weight of Test assignment five" matches value "66.667" And the field "Weight of Test assignment six" matches value "33.333" And the field "Weight of Test assignment seven" matches value "50.0" @javascript Scenario: Two out of three grade items weights are overridden and one is not. The overridden grade item weights total over one hundred. Given I set the field "Override weight of Test assignment six" to "1" And I set the field "Override weight of Test assignment seven" to "1" And I set the field "Weight of Test assignment six" to "55" And I set the field "Weight of Test assignment seven" to "65" Then I should not see "Weight total exceeds 100%." in the "Test assignment five" "table_row" And I should see "Weight total exceeds 100%." in the "Test assignment six" "table_row" And I should see "Weight total exceeds 100%." in the "Test assignment seven" "table_row" And the field "Weight of Test assignment five" matches value "0.0" And the field "Weight of Test assignment six" matches value "55.0" And the field "Weight of Test assignment seven" matches value "65.0" And I start watching to see if a new page loads And I press "Save changes" And a new page should not have loaded since I started watching @javascript Scenario: With one grade item set as extra credit, when I reset the weights for a category they return to the natural weights. When I set the following settings for grade item "Test assignment five" of type "gradeitem" on "setup" page: | Extra credit | 1 | And I set the field "Override weight of Test assignment six" to "1" And I set the field "Override weight of Test assignment seven" to "1" And I set the field "Weight of Test assignment six" to "55" And I set the field "Weight of Test assignment seven" to "40" And I press "Save changes" And I reset weights for grade category "Sub category 1" Then the field "Weight of Test assignment five" matches value "80.0" And the field "Weight of Test assignment six" matches value "40.0" And the field "Weight of Test assignment seven" matches value "60.0" @javascript Scenario: Overriding a grade item with a negative value results in the value being changed to zero. When I set the field "Override weight of Test assignment five" to "1" And I set the field "Weight of Test assignment five" to "-15" Then the field "Weight of Test assignment five" matches value "0.0" And the field "Weight of Test assignment six" matches value "40.0" And the field "Weight of Test assignment seven" matches value "60.0" And I press "Save changes" Then the field "Weight of Test assignment five" matches value "0.0" And the field "Weight of Test assignment six" matches value "40.0" And the field "Weight of Test assignment seven" matches value "60.0" And I set the field "Override weight of Test assignment six" to "1" And I set the field "Weight of Test assignment six" to "-25" And the field "Weight of Test assignment six" matches value "0.0" And the field "Weight of Test assignment seven" matches value "100.0" And I reset weights for grade category "Sub category 1" And I set the field "Override weight of Test assignment five" to "1" And I set the field "Override weight of Test assignment six" to "1" And I set the field "Weight of Test assignment five" to "-10" And I set the field "Weight of Test assignment six" to "120" And I should see "Weight total exceeds 100%." in the "Test assignment five" "table_row" And I should see "Weight total exceeds 100%." in the "Test assignment six" "table_row" And the field "Weight of Test assignment five" matches value "0.0" And the field "Weight of Test assignment six" matches value "120.0" And the field "Weight of Test assignment seven" matches value "0.0" And I start watching to see if a new page loads And I press "Save changes" And a new page should not have loaded since I started watching tests/behat/grade_item_duplication.feature 0000604 00000004543 15062070557 0015052 0 ustar 00 @core @core_grades @javascript Feature: We can duplicate grade items that already exist. In order to quickly create grade items that have similar settings. As a teacher I need to duplicate an existing grade item and check that its values are properly duplicated. Background: Given the following "courses" exist: | fullname | shortname | format | | Course 1 | C1 | topics | And the following "grade categories" exist: | fullname | course | | Category1 | C1 | And the following "activities" exist: | activity | course | idnumber | name | gradecategory | | assign | C1 | a1 | Assignment1 | Category1 | And the following "users" exist: | username | firstname | lastname | email | | teacher1 | Teacher | 1 | teacher1@example.com | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | And the following "grade items" exist: | itemname | course | category | idnumber | gradetype | grademax | grademin | gradepass | display | decimals | hidden | weightoverride | | Item1 | C1 | Category1 | 001 | Value | 80.00 | 5.00 | 40.00 | 1 | 1 | 0 | 1 | Scenario: Ensure the duplicated grade item settings match the original grade item Given I am on the "Course 1" "grades > gradebook setup" page logged in as "teacher1" And I should not see "Duplicate Category1" And I should not see "Duplicate Assignment1" When I duplicate the grade item "Item1" Then I should see "Item1 (copy)" And I click on grade item menu "Item1 (copy)" of type "gradeitem" on "setup" page And I choose "Edit grade item" in the open action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" And the field "Item name" matches value "Item1 (copy)" And the field "ID number" matches value "" And the field "Grade type" matches value "Value" And the field "Maximum grade" matches value "80.00" And the field "Minimum grade" matches value "5.00" And the field "Grade to pass" matches value "40.00" And the field "Grade display type" matches value "Real" And the field "Overall decimal places" matches value "1" And the field "Hidden" matches value "0" And the field "Weight adjusted" matches value "1" tests/behat/grade_UI_settings.feature 0000604 00000004007 15062070557 0013751 0 ustar 00 @core @core_grades Feature: Site settings can be used to hide parts of the gradebook UI In order to hide UI elements As an admin I need to modify gradebook related system settings Background: Given the following "courses" exist: | fullname | shortname | category | format | | Course 1 | C1 | 0 | topics | And the following "users" exist: | username | firstname | lastname | email | idnumber | | student1 | Student | 1 | student1@example.com | s1 | And the following "course enrolments" exist: | user | course | role | | student1 | C1 | student | And the following "activities" exist: | activity | course | idnumber | name | intro | | assign | C1 | assign1 | Assignment1 | Assignment 1 intro | And I am on the "Course 1" "grades > Grader report > View" page logged in as "admin" And I turn editing mode on @javascript Scenario: Hide minimum grade Given I click on grade item menu "Assignment1" of type "gradeitem" on "grader" page When I choose "Edit grade item" in the open action menu And I should see "Minimum grade" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" Then I navigate to "Grades > General settings" in site administration And I set the field "Show minimum grade" to "0" And I press "Save changes" And I am on the "Course 1" "grades > Grader report > View" page And I click on grade item menu "Assignment1" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And I should not see "Minimum grade" @javascript Scenario: Disable category overriding And "tr .course input[type='text']" "css_element" should exist Then I navigate to "Grades > Grade category settings" in site administration And I set the field "Allow category grades to be manually overridden" to "0" And I press "Save changes" And I am on the "Course 1" "grades > Grader report > View" page And "tr .course input[type='text']" "css_element" should not exist tests/behat/grade_contribution_with_extra_credit.feature 0000604 00000010457 15062070557 0020031 0 ustar 00 @core @core_grades @javascript Feature: Extra credit contributions are normalised when going out of bounds In order to use extra credit As a teacher I need to add some extra credit items. Background: Given the following "courses" exist: | fullname | shortname | category | groupmode | | Course 1 | C1 | 0 | 1 | And the following "users" exist: | username | firstname | lastname | email | idnumber | | teacher1 | Teacher | 1 | teacher1@example.com | t1 | | student1 | Student | 1 | student1@example.com | s1 | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | And I log in as "admin" And I set the following administration settings values: | grade_aggregations_visible | Simple weighted mean of grades,Mean of grades (with extra credits),Natural | And I am on the "Course 1" "grades > gradebook setup" page And I choose the "Add grade item" item in the "Add" action menu And I set the following fields to these values: | Item name | Manual item 1 | | Maximum grade | 150 | And I click on "Save" "button" in the "New grade item" "dialogue" And I choose the "Add grade item" item in the "Add" action menu And I set the following fields to these values: | Item name | Manual item 2 | And I click on "Save" "button" in the "New grade item" "dialogue" And I choose the "Add grade item" item in the "Add" action menu And I set the following fields to these values: | Item name | Manual item 3 | And I click on "Save" "button" in the "New grade item" "dialogue" And I choose the "Add grade item" item in the "Add" action menu And I set the following fields to these values: | Item name | Manual item 4 | And I click on "Save" "button" in the "New grade item" "dialogue" And I navigate to "Setup > Course grade settings" in the course gradebook And I set the field "Show weighting" to "Show" And I set the field "Show contribution to course total" to "Show" And I press "Save changes" And I am on the "Course 1" "grades > Grader report > View" page logged in as "teacher1" And I turn editing mode on And I give the grade "80.00" to the user "Student 1" for the grade item "Manual item 1" And I give the grade "10.00" to the user "Student 1" for the grade item "Manual item 2" And I give the grade "70.00" to the user "Student 1" for the grade item "Manual item 3" And I give the grade "90.00" to the user "Student 1" for the grade item "Manual item 4" And I press "Save changes" Scenario Outline: The contribution of extra credit items is normalised Given I navigate to "Setup > Gradebook setup" in the course gradebook When I set the following settings for grade item "Course 1" of type "course" on "setup" page: | Aggregation | <aggregation> | And I set the following settings for grade item "Manual item 2" of type "gradeitem" on "setup" page: | aggregationcoef | 1 | And I set the following settings for grade item "Manual item 3" of type "gradeitem" on "setup" page: | aggregationcoef | 1 | And I set the following settings for grade item "Manual item 4" of type "gradeitem" on "setup" page: | aggregationcoef | 1 | And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Contribution to course total | | Manual item 1 | <m1w> | 80.00 | <m1c> | | Manual item 2 | <m2w> | 10.00 | <m2c> | | Manual item 3 | <m3w> | 70.00 | <m3c> | | Manual item 4 | 0.00 % | 90.00 | 0.00 % | Examples: | aggregation | m1w | m1c | m2w | m2c | m3w | m3c | | Natural | 100.00 % | 53.33 % | 66.67 % | 6.67 % | 57.14 % | 40.00 % | | Simple weighted mean of grades | 100.00 % | 53.33 % | 66.67 % | 6.67 % | 57.14 % | 40.00 % | | Mean of grades (with extra credits) | 100.00 % | 53.33 % | 100.00 % | 10.00 % | 52.38 % | 36.67 % | tests/behat/grade_mingrade.feature 0000604 00000015215 15062070557 0013305 0 ustar 00 @core @core_grades Feature: We can use a minimum grade different than zero In order to use a minimum grade different than zero As an teacher I need to set up a minimum grade different than zero Background: Given the following "courses" exist: | fullname | shortname | category | groupmode | | Course 1 | C1 | 0 | 1 | And the following "users" exist: | username | firstname | lastname | email | idnumber | | teacher1 | Teacher | 1 | teacher1@example.com | t1 | | student1 | Student | 1 | student1@example.com | s1 | | student2 | Student | 2 | student2@example.com | s2 | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | | student2 | C1 | student | And the following "grade categories" exist: | fullname | course | | Sub category 1 | C1 | | Sub category 2 | C1 | And I log in as "admin" And I set the following administration settings values: | grade_aggregations_visible | Mean of grades,Weighted mean of grades,Simple weighted mean of grades,Mean of grades (with extra credits),Median of grades,Lowest grade,Highest grade,Mode of grades,Natural | And I am on the "Course 1" "grades > gradebook setup" page And I choose the "Add grade item" item in the "Add" action menu And I set the following fields to these values: | Item name | Manual item 1 | | Minimum grade | -100 | | Grade category | Course 1 | And I click on "Save" "button" in the "New grade item" "dialogue" And I choose the "Add grade item" item in the "Add" action menu And I set the following fields to these values: | Item name | Manual item 2 | | Minimum grade | 50 | | Grade category | Course 1 | And I click on "Save" "button" in the "New grade item" "dialogue" And I choose the "Add grade item" item in the "Add" action menu And I set the following fields to these values: | Item name | Manual item 3 | | Maximum grade | 50 | | Minimum grade | -100 | | Grade category | Sub category 1 | And I click on "Save" "button" in the "New grade item" "dialogue" And I choose the "Add grade item" item in the "Add" action menu And I set the following fields to these values: | Item name | Manual item 4 | | Minimum grade | -100 | | Grade category | Sub category 1 | And I click on "Save" "button" in the "New grade item" "dialogue" And I choose the "Add grade item" item in the "Add" action menu And I set the following fields to these values: | Item name | Manual item 5 | | Minimum grade | 50 | | Grade category | Sub category 2 | And I click on "Save" "button" in the "New grade item" "dialogue" And I choose the "Add grade item" item in the "Add" action menu And I set the following fields to these values: | Item name | Manual item 6 | | Minimum grade | 50 | | Grade category | Sub category 2 | And I click on "Save" "button" in the "New grade item" "dialogue" And I navigate to "Setup > Course grade settings" in the course gradebook And I set the field "Show weightings" to "Show" And I set the field "Show contribution to course total" to "Show" And I press "Save changes" @javascript Scenario: Natural aggregation with negative and positive grade And I navigate to "Setup > Gradebook setup" in the course gradebook And I set the following settings for grade item "Sub category 1" of type "category" on "setup" page: | Aggregation | Natural | | Exclude empty grades | 0 | And I set the following settings for grade item "Sub category 2" of type "category" on "setup" page: | Aggregation | Natural | | Exclude empty grades | 0 | And I set the following settings for grade item "Course 1" of type "course" on "setup" page: | Aggregation | Natural | | Exclude empty grades | 0 | And I am on the "Course 1" "grades > Grader report > View" page logged in as "teacher1" And I turn editing mode on When I give the grade "-25.00" to the user "Student 1" for the grade item "Manual item 1" And I give the grade "50.00" to the user "Student 1" for the grade item "Manual item 2" And I give the grade "-80.00" to the user "Student 1" for the grade item "Manual item 3" And I give the grade "-10.00" to the user "Student 1" for the grade item "Manual item 4" And I give the grade "50.00" to the user "Student 1" for the grade item "Manual item 5" And I give the grade "75.00" to the user "Student 1" for the grade item "Manual item 6" And I give the grade "0.00" to the user "Student 2" for the grade item "Manual item 1" And I give the grade "0.00" to the user "Student 2" for the grade item "Manual item 2" And I give the grade "-10.00" to the user "Student 2" for the grade item "Manual item 3" And I give the grade "50.00" to the user "Student 2" for the grade item "Manual item 4" And I give the grade "0.00" to the user "Student 2" for the grade item "Manual item 5" And I give the grade "0.00" to the user "Student 2" for the grade item "Manual item 6" And I press "Save changes" And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Contribution to course total | | Manual item 1 | 18.18 % | -25.00 | -4.55 % | | Manual item 2 | 18.18 % | 50.00 | 9.09 % | | Manual item 3 | 33.33 % | -80.00 | -14.55 % | | Manual item 4 | 66.67 % | -10.00 | -1.82 % | | Manual item 5 | 50.00 % | 50.00 | 9.09 % | | Manual item 6 | 50.00 % | 75.00 | 13.64 % | And I click on "Student 2" in the "user" search widget And the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Contribution to course total | | Manual item 1 | 18.18 % | 0.00 | 0.00 % | | Manual item 2 | 18.18 % | 50.00 | 9.09 % | | Manual item 3 | 33.33 % | -10.00 | -1.82 % | | Manual item 4 | 66.67 % | 50.00 | 9.09 % | | Manual item 5 | 50.00 % | 50.00 | 9.09 % | | Manual item 6 | 50.00 % | 50.00 | 9.09 % | tests/behat/grade_regrade_do_not_override.feature 0000604 00000006671 15062070557 0016377 0 ustar 00 @core @core_grades Feature: Regrading grades does not unnecessarily mark some as overriden In order to regrade a grade item As an admin I need to keep the overridden status of all grades Background: Given the following "courses" exist: | fullname | shortname | category | format | | Course 1 | C1 | 0 | topics | And the following "users" exist: | username | firstname | lastname | email | idnumber | | student1 | Student | 1 | student1@example.com | s1 | | student2 | Student | 2 | student2@example.com | s2 | And the following "course enrolments" exist: | user | course | role | | student1 | C1 | student | | student2 | C1 | student | And the following "activities" exist: | activity | course | idnumber | name | intro | | assign | C1 | assign1 | Assignment 1 | Assignment 1 intro | And I log in as "admin" And I navigate to "Grades > Grade category settings" in site administration And I set the field "Available aggregation types" to "Weighted mean of grades" And I press "Save changes" And I am on the "Assignment 1" "assign activity" page And I follow "View all submissions" And I click on "Grade" "link" in the "Student 1" "table_row" And I set the field "Grade out of 100" to "80" And I press "Save and show next" And I set the field "Grade out of 100" to "60" And I press "Save changes" And I am on the "Course 1" "grades > Grader report > View" page And the following should exist in the "gradereport-grader-table" table: | | | | | First name / Last name | Assignment 1 | Course total | | Student 1 | 80.00 | 80.00 | | Student 2 | 60.00 | 60.00 | And I turn editing mode on And I give the grade "80.00" to the user "Student 2" for the grade item "Course total" And I press "Save changes" And I navigate to "Setup > Gradebook setup" in the course gradebook And I set the following settings for grade item "Course 1" of type "course" on "setup" page: | Aggregation | Weighted mean of grades | | Rescale overridden grades | Yes | | Maximum grade | 200 | And I press "Save changes" @javascript Scenario: Confirm regrading did not overwrite overridden status Given I navigate to "View > Grader report" in the course gradebook Then "td.overridden" "css_element" should not exist in the "Student 1" "table_row" And "td.overridden" "css_element" should exist in the "Student 2" "table_row" @javascript Scenario: Confirm overridden course total does not get regraded when activity grade is changed Given I am on the "Assignment 1" "assign activity" page And I follow "View all submissions" And I click on "Grade" "link" in the "Student 1" "table_row" And I set the field "Grade out of 100" to "90" And I press "Save and show next" And I set the field "Grade out of 100" to "70" And I press "Save changes" When I am on the "Course 1" "grades > Grader report > View" page Then the following should exist in the "gradereport-grader-table" table: | | | | | First name / Last name | Assignment 1 | Course total | | Student 1 | 90.00 | 180.00 | | Student 2 | 70.00 | 160.00 | tests/behat/grade_aggregation.feature 0000604 00000104604 15062070557 0014007 0 ustar 00 @core @core_grades @javascript Feature: We can use calculated grade totals In order to calculate grade totals As an teacher I need to add aggregate columns to the gradebook Background: Given the following "courses" exist: | fullname | shortname | category | groupmode | | Course 1 | C1 | 0 | 1 | And the following "users" exist: | username | firstname | lastname | email | idnumber | | teacher1 | Teacher | 1 | teacher1@example.com | t1 | | student1 | Student | 1 | student1@example.com | s1 | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | And the following "grade categories" exist: | fullname | course | | Sub category 1 | C1 | | Sub category 2 & | C1 | And the following "activities" exist: | activity | course | idnumber | name | intro | grade | | assign | C1 | a1 | Test assignment one & | Submit something! | 300 | | assign | C1 | a2 | Test assignment two | Submit something! | 100 | | assign | C1 | a3 | Test assignment three | Submit something! | 150 | | assign | C1 | a4 | Test assignment four | Submit nothing! | 150 | And the following "activities" exist: | activity | course | idnumber | name | intro | gradecategory | grade | | assign | C1 | a5 | Test assignment five | Submit something! | Sub category 1 | 20 | | assign | C1 | a6 | Test assignment six | Submit something! | Sub category 1 | 10 | | assign | C1 | a7 | Test assignment seven | Submit nothing! | Sub category 1 | 15 | And the following "activities" exist: | activity | course | idnumber | name | intro | gradecategory | grade | | assign | C1 | a8 | Test assignment eight | Submit something! | Sub category 2 & | 20 | | assign | C1 | a9 | Test assignment nine | Submit something! | Sub category 2 & | 10 | | assign | C1 | 10 | Test assignment ten | Submit nothing! | Sub category 2 & | 15 | And I log in as "admin" And I set the following administration settings values: | grade_aggregations_visible | Mean of grades,Weighted mean of grades,Simple weighted mean of grades,Mean of grades (with extra credits),Median of grades,Lowest grade,Highest grade,Mode of grades,Natural | And the following "grade grades" exist: | gradeitem | user | grade | | Test assignment one & | student1 | 60.00 | | Test assignment two | student1 | 20.00 | | Test assignment three | student1 | 40.00 | | Test assignment five | student1 | 10.00 | | Test assignment six | student1 | 5.00 | | Test assignment eight | student1 | 10.00 | | Test assignment nine | student1 | 5.00 | And I am on the "Course 1" "grades > Grader report > View" page logged in as "teacher1" And I turn editing mode on And I change window size to "large" And I hide the grade item "Test assignment two" of type "gradeitem" on "grader" page And I hide the grade item "Test assignment five" of type "gradeitem" on "grader" page And I hide the grade item "Test assignment eight" of type "gradeitem" on "grader" page And I change window size to "medium" And I navigate to "Setup > Course grade settings" in the course gradebook And I set the field "Grade display type" to "Real (percentage)" And I press "Save changes" Scenario: Mean of grades aggregation When I navigate to "View > Grader report" in the course gradebook And I set the following settings for grade item "Course 1" of type "course" on "grader" page: | Aggregation | Mean of grades | And I set the following settings for grade item "Sub category 1" of type "category" on "grader" page: | Aggregation | Mean of grades | And I set the following settings for grade item "Sub category 2 &" of type "category" on "grader" page: | Aggregation | Mean of grades | | Exclude empty grades | 0 | And I turn editing mode off Then I should see "30.00 (30.00 %)" in the ".course" "css_element" And I navigate to "Setup > Course grade settings" in the course gradebook And I set the field "Hide totals if they contain hidden items" to "Show totals excluding hidden items" And I press "Save changes" And I log out And I log in as "student1" And I follow "Grades" in the user menu And I should see "30.42 (30.42 %)" in the "overview-grade" "table" Scenario: Weighted mean of grades aggregation When I navigate to "View > Grader report" in the course gradebook And I set the following settings for grade item "Course 1" of type "course" on "grader" page: | Aggregation | Weighted mean of grades | And I set the following settings for grade item "Sub category 1" of type "category" on "grader" page: | Aggregation | Weighted mean of grades | | Item weight | 1 | And I set the following settings for grade item "Sub category 2 &" of type "category" on "grader" page: | Aggregation | Weighted mean of grades | | Item weight | 1 | | Exclude empty grades | 0 | And I set the following settings for grade item "Test assignment one &" of type "gradeitem" on "grader" page: | Item weight | 3 | And I turn editing mode off Then I should see "27.14 (27.14 %)" in the ".course" "css_element" And I navigate to "Setup > Course grade settings" in the course gradebook And I set the field "Hide totals if they contain hidden items" to "Show totals excluding hidden items" And I press "Save changes" And I log out And I log in as "student1" And I follow "Grades" in the user menu And I should see "26.94 (26.94 %)" in the "overview-grade" "table" Scenario: Simple weighted mean of grades aggregation When I navigate to "View > Grader report" in the course gradebook And I set the following settings for grade item "Course 1" of type "course" on "grader" page: | Aggregation | Simple weighted mean of grades | And I set the following settings for grade item "Sub category 1" of type "category" on "grader" page: | Aggregation | Simple weighted mean of grades | And I set the following settings for grade item "Sub category 2 &" of type "category" on "grader" page: | Aggregation | Simple weighted mean of grades | | Exclude empty grades | 0 | And I set the following settings for grade item "Test assignment one &" of type "gradeitem" on "grader" page: | Extra credit | 1 | And I turn editing mode off Then I should see "45.19 (45.19 %)" in the ".course" "css_element" And I navigate to "Setup > Course grade settings" in the course gradebook And I set the field "Hide totals if they contain hidden items" to "Show totals excluding hidden items" And I press "Save changes" And I log out And I log in as "student1" And I follow "Grades" in the user menu And I should see "48.57 (48.57 %)" in the "overview-grade" "table" Scenario: Mean of grades (with extra credits) aggregation When I navigate to "View > Grader report" in the course gradebook And I set the following settings for grade item "Course 1" of type "course" on "grader" page: | Aggregation | Mean of grades (with extra credits) | And I set the following settings for grade item "Sub category 1" of type "category" on "grader" page: | Aggregation | Mean of grades (with extra credits) | And I set the following settings for grade item "Sub category 2 &" of type "category" on "grader" page: | Aggregation | Mean of grades (with extra credits) | | Exclude empty grades | 0 | And I set the following settings for grade item "Test assignment one &" of type "gradeitem" on "grader" page: | Extra credit weight | 2 | And I turn editing mode off Then I should see "42.50 (42.50 %)" in the ".course" "css_element" And I navigate to "Setup > Course grade settings" in the course gradebook And I set the field "Hide totals if they contain hidden items" to "Show totals excluding hidden items" And I press "Save changes" And I log out And I log in as "student1" And I follow "Grades" in the user menu And I should see "47.22 (47.22 %)" in the "overview-grade" "table" Scenario: Median of grades aggregation When I navigate to "View > Grader report" in the course gradebook And I set the following settings for grade item "Course 1" of type "course" on "grader" page: | Aggregation | Median of grades | And I set the following settings for grade item "Sub category 1" of type "category" on "grader" page: | Aggregation | Median of grades | And I set the following settings for grade item "Sub category 2 &" of type "category" on "grader" page: | Aggregation | Median of grades | | Exclude empty grades | 0 | And I press "Save changes" And I turn editing mode off Then I should see "26.67 (26.67 %)" in the ".course" "css_element" And I navigate to "Setup > Course grade settings" in the course gradebook And I set the field "Hide totals if they contain hidden items" to "Show totals excluding hidden items" And I press "Save changes" And I log out And I log in as "student1" And I follow "Grades" in the user menu And I should see "25.83 (25.83 %)" in the "overview-grade" "table" Scenario: Lowest grade aggregation When I navigate to "View > Grader report" in the course gradebook And I set the following settings for grade item "Course 1" of type "course" on "grader" page: | Aggregation | Lowest grade | And I set the following settings for grade item "Sub category 1" of type "category" on "grader" page: | Aggregation | Lowest grade | And I set the following settings for grade item "Sub category 2 &" of type "category" on "grader" page: | Aggregation | Lowest grade | | Exclude empty grades | 0 | And I set the following settings for grade item "Test assignment five" of type "gradeitem" on "grader" page: | Hidden | 1 | And I set the following settings for grade item "Test assignment four" of type "gradeitem" on "grader" page: | Hidden | 1 | And I turn editing mode off Then I should see "0.00 (0.00 %)" in the ".course" "css_element" And I navigate to "Setup > Course grade settings" in the course gradebook And I set the field "Hide totals if they contain hidden items" to "Show totals excluding hidden items" And I press "Save changes" And I log out And I log in as "student1" And I follow "Grades" in the user menu And I should see "0.00 (0.00 %)" in the "overview-grade" "table" Scenario: Highest grade aggregation When I navigate to "View > Grader report" in the course gradebook And I set the following settings for grade item "Course 1" of type "course" on "grader" page: | Aggregation | Highest grade | And I set the following settings for grade item "Sub category 1" of type "category" on "grader" page: | Aggregation | Highest grade | And I set the following settings for grade item "Sub category 2 &" of type "category" on "grader" page: | Aggregation | Highest grade | | Exclude empty grades | 0 | And I set the following settings for grade item "Test assignment one &" of type "gradeitem" on "grader" page: | Hidden | 1 | And I turn editing mode off Then I should see "50.00 (50.00 %)" in the ".course" "css_element" And I navigate to "Setup > Course grade settings" in the course gradebook And I set the field "Hide totals if they contain hidden items" to "Show totals excluding hidden items" And I press "Save changes" And I log out And I log in as "student1" And I follow "Grades" in the user menu And I should see "50.00 (50.00 %)" in the "overview-grade" "table" Scenario: Mode of grades aggregation When I navigate to "View > Grader report" in the course gradebook And I set the following settings for grade item "Course 1" of type "course" on "grader" page: | Aggregation | Mode of grades | And I set the following settings for grade item "Sub category 1" of type "category" on "grader" page: | Aggregation | Mode of grades | And I set the following settings for grade item "Sub category 2 &" of type "category" on "grader" page: | Aggregation | Mode of grades | | Exclude empty grades | 0 | And I set the following settings for grade item "Test assignment one &" of type "gradeitem" on "grader" page: | Hidden | 1 | And I turn editing mode off Then I should see "50.00 (50.00 %)" in the ".course" "css_element" And I navigate to "Setup > Course grade settings" in the course gradebook And I set the field "Hide totals if they contain hidden items" to "Show totals excluding hidden items" And I press "Save changes" And I log out And I log in as "student1" And I follow "Grades" in the user menu And I should see "50.00 (50.00 %)" in the "overview-grade" "table" Scenario: Natural aggregation on outcome items with natural weights And the following config values are set as admin: | enableoutcomes | 1 | And the following "scales" exist: | name | scale | | Test Scale | Disappointing, Good, Very good, Excellent | And the following "grade outcomes" exist: | fullname | shortname | course | scale | | Outcome 1 | OT1 | C1 | Test Scale | And the following "grade items" exist: | itemname | course | outcome | gradetype | scale | | Test outcome item one | C1 | OT1 | Scale | Test Scale | And I navigate to "Setup > Gradebook setup" in the course gradebook And I set the following settings for grade item "Course 1" of type "course" on "setup" page: | Aggregation | Natural | | Include outcomes in aggregation | 1 | | Exclude empty grades | 0 | And I change window size to "large" And I navigate to "View > Grader report" in the course gradebook And I give the grade "Excellent" to the user "Student 1" for the grade item "Test outcome item one" And I press "Save changes" And I navigate to "Setup > Course grade settings" in the course gradebook And I set the field "report_overview_showtotalsifcontainhidden" to "Show totals excluding hidden items" And I set the field "report_user_showtotalsifcontainhidden" to "Show totals excluding hidden items" And I press "Save changes" And I log out And I log in as "student1" And I follow "Grades" in the user menu Then I should see "114.82 (18.27 %)" in the "overview-grade" "table" And I click on "Course 1" "link" in the "region-main" "region" And "Test outcome item one" row "Grade" column of "user-grade" table should contain "Excellent (100.00 %)" And I am on the "Course 1" "grades > gradebook setup" page logged in as "teacher1" And I set the following settings for grade item "Test outcome item one" of type "gradeitem" on "setup" page: | aggregationcoef | 1 | And I log out And I log in as "student1" And I follow "Grades" in the user menu Then I should see "114.00 (18.39 %)" in the "overview-grade" "table" And I click on "Course 1" "link" in the "region-main" "region" And "Test outcome item one" row "Grade" column of "user-grade" table should contain "Excellent (100.00 %)" And I am on the "Course 1" "grades > gradebook setup" page logged in as "teacher1" And I set the following settings for grade item "Course 1" of type "course" on "setup" page: | Aggregation | Natural | | Include outcomes in aggregation | 0 | And I press "Save" And I log out And I log in as "student1" And I follow "Grades" in the user menu Then I should see "110.00 (17.74 %)" in the "overview-grade" "table" And I click on "Course 1" "link" in the "region-main" "region" And "Test outcome item one" row "Grade" column of "user-grade" table should contain "Excellent (100.00 %)" Scenario: Natural aggregation on outcome items with modified weights And the following config values are set as admin: | enableoutcomes | 1 | And the following "scales" exist: | name | scale | | Test Scale | Disappointing, Good, Very good, Excellent | And the following "grade outcomes" exist: | fullname | shortname | course | scale | | Outcome 1 | OT1 | C1 | Test Scale | And the following "grade items" exist: | itemname | course | outcome | gradetype | scale | | Test outcome item one | C1 | OT1 | Scale | Test Scale | And I navigate to "Setup > Gradebook setup" in the course gradebook And I set the following settings for grade item "Course 1" of type "course" on "setup" page: | Aggregation | Natural | | Include outcomes in aggregation | 1 | | Exclude empty grades | 0 | And I set the following settings for grade item "Test outcome item one" of type "gradeitem" on "setup" page: | Weight adjusted | 1 | | aggregationcoef2 | 100 | And I change window size to "large" And I navigate to "View > Grader report" in the course gradebook And I give the grade "Excellent" to the user "Student 1" for the grade item "Test outcome item one" And I press "Save changes" And I navigate to "Setup > Course grade settings" in the course gradebook And I set the field "report_overview_showtotalsifcontainhidden" to "Show totals excluding hidden items" And I set the field "report_user_showtotalsifcontainhidden" to "Show totals excluding hidden items" And I press "Save changes" And I log out And I log in as "student1" And I follow "Grades" in the user menu Then I should see "4.00 (100.00 %)" in the "overview-grade" "table" And I click on "Course 1" "link" in the "region-main" "region" And "Test outcome item one" row "Grade" column of "user-grade" table should contain "Excellent (100.00 %)" Scenario: Natural aggregation When I navigate to "View > Grader report" in the course gradebook And I set the following settings for grade item "Course 1" of type "course" on "grader" page: | Aggregation | Natural | | Exclude empty grades | 0 | And I set the following settings for grade item "Sub category 1" of type "category" on "grader" page: | Aggregation | Natural | | Exclude empty grades | 0 | And I set the following settings for grade item "Sub category 2 &" of type "category" on "grader" page: | Aggregation | Natural | | Exclude empty grades | 1 | And I set the following settings for grade item "Test assignment six" of type "gradeitem" on "grader" page: | Weight adjusted | 1 | | aggregationcoef2 | 50 | And I set the following settings for grade item "Test assignment three" of type "gradeitem" on "grader" page: | Extra credit | 1 | And I turn editing mode off Then I should see "152.68 (24.43 %)" in the ".course" "css_element" And I navigate to "Setup > Course grade settings" in the course gradebook And I set the field "report_overview_showtotalsifcontainhidden" to "Show totals excluding hidden items" And I set the field "report_user_showtotalsifcontainhidden" to "Show totals excluding hidden items" And I set the field "Show contribution to course total" to "Show" And I set the field "Show weightings" to "Show" And I press "Save changes" And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget And I set the field "View report as" to "Myself" And the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Contribution to course total | | Test assignment five | 28.57 % | 10.00 (50.00 %) | 0–20 | 1.03 % | | Test assignment six | 50.00 % | 5.00 (50.00 %) | 0–10 | 1.80 % | | Test assignment seven | 21.43 % | - | 0–15 | 0.00 % | | Test assignment eight | 66.67 % | 10.00 (50.00 %) | 0–20 | 1.60 % | | Test assignment nine | 33.33 % | 5.00 (50.00 %) | 0–10 | 0.80 % | | Test assignment ten | 0.00 %( Empty ) | - | 0–15 | 0.00 % | | Test assignment one & | 48.00 % | 60.00 (20.00 %) | 0–300 | 9.60 % | | Test assignment two | 16.00 % | 20.00 (20.00 %) | 0–100 | 3.20 % | | Test assignment three | 24.00 %( Extra credit ) | 40.00 (26.67 %) | 0–150 | 6.40 % | | Test assignment four | 24.00 % | - | 0–150 | 0.00 % | And I log out And I log in as "student1" And I follow "Grades" in the user menu And I should see "113.75 (23.45 %)" in the "overview-grade" "table" And I click on "Course 1" "link" in the "region-main" "region" And the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Contribution to course total | | Test assignment six | 70.00 % | 5.00 (50.00 %) | 0–10 | 1.80 % | | Test assignment seven | 30.00 % | - | 0–15 | 0.00 % | | Test assignment nine | 100.00 % | 5.00 (50.00 %) | 0–10 | 1.03 % | | Test assignment ten | -( Empty ) | - | 0–15 | - | | Test assignment one & | 61.86 % | 60.00 (20.00 %) | 0–300 | 12.37 % | | Test assignment three | 30.93 %( Extra credit ) | 40.00 (26.67 %) | 0–150 | 8.25 % | | Test assignment four | 30.93 % | - | 0–150 | 0.00 % | Scenario: Natural aggregation with drop lowest When I am on the "Course 1" "grades > Grader report > View" page logged in as "admin" And I turn editing mode on And I set the following settings for grade item "Course 1" of type "course" on "grader" page: | Aggregation | Natural | | Exclude empty grades | 0 | And I set the following settings for grade item "Sub category 1" of type "category" on "grader" page: | Aggregation | Natural | | Exclude empty grades | 0 | And I set the following settings for grade item "Sub category 2 &" of type "category" on "grader" page: | Aggregation | Natural | | Exclude empty grades | 0 | And I navigate to "Setup > Gradebook setup" in the course gradebook And I choose the "Add category" item in the "Add" action menu And I set the following fields to these values: | Category name | Sub category 3 | | Aggregation | Natural | | Drop the lowest | 1 | And I click on "Save" "button" in the "New category" "dialogue" And I wait until the page is ready And I choose the "Add grade item" item in the "Add" action menu And I set the following fields to these values: | Item name | Manual item 1 | | Grade category | Sub category 3 | And I click on "Save" "button" in the "New grade item" "dialogue" And I choose the "Add grade item" item in the "Add" action menu And I set the following fields to these values: | Item name | Manual item 2 | | Grade category | Sub category 3 | And I click on "Save" "button" in the "New grade item" "dialogue" And I choose the "Add grade item" item in the "Add" action menu And I set the following fields to these values: | Item name | Manual item 3 | | Grade category | Sub category 3 | And I click on "Save" "button" in the "New grade item" "dialogue" And I navigate to "View > Grader report" in the course gradebook And I give the grade "60.00" to the user "Student 1" for the grade item "Manual item 1" And I give the grade "20.00" to the user "Student 1" for the grade item "Manual item 2" And I give the grade "40.00" to the user "Student 1" for the grade item "Manual item 3" And I press "Save changes" And I turn editing mode off Then I should see "250.00 (25.25 %)" in the ".course" "css_element" And I turn editing mode on And I set the following settings for grade item "Manual item 2" of type "gradeitem" on "grader" page: | Extra credit | 1 | And I turn editing mode off And I should see "270.00 (27.27 %)" in the ".course" "css_element" And I turn editing mode on And I set the following settings for grade item "Manual item 2" of type "gradeitem" on "grader" page: | Rescale existing grades | No | | Maximum grade | 200 | | Extra credit | 0 | # Change window size to ultra-wide to avoid 'out-of-bounds' random failures. And I change window size to "5120x2160" And I give the grade "21.00" to the user "Student 1" for the grade item "Manual item 2" And I press "Save changes" And I give the grade "20.00" to the user "Student 1" for the grade item "Manual item 2" And I press "Save changes" And I turn editing mode off And I should see "270.00 (22.69 %)" in the ".course" "css_element" And I turn editing mode on And I set the following settings for grade item "Manual item 2" of type "gradeitem" on "grader" page: | Rescale existing grades | No | | Maximum grade | 100 | | Extra credit | 0 | # Change window size to ultra-wide to avoid 'out-of-bounds' random failures. And I change window size to "5120x2160" And I give the grade "21.00" to the user "Student 1" for the grade item "Manual item 2" And I press "Save changes" And I give the grade "20.00" to the user "Student 1" for the grade item "Manual item 2" And I press "Save changes" And I turn editing mode off And I should see "250.00 (25.25 %)" in the ".course" "css_element" And I navigate to "Setup > Gradebook setup" in the course gradebook And I choose the "Add category" item in the "Add" action menu And I set the following fields to these values: | Category name | Sub sub category 1 | | Parent category | Sub category 3 | And I click on "Save" "button" in the "New category" "dialogue" And I wait until the page is ready And I navigate to "View > Grader report" in the course gradebook And I should see "270.00 (24.77 %)" in the ".course" "css_element" Scenario: Natural aggregation from the setup screen When I navigate to "Setup > Gradebook setup" in the course gradebook And I set the following settings for grade item "Course 1" of type "course" on "setup" page: | Aggregation | Natural | And I set the following settings for grade item "Sub category 1" of type "category" on "setup" page: | Aggregation | Natural | And I set the following settings for grade item "Sub category 2 &" of type "category" on "setup" page: | Aggregation | Natural | And the field "Weight of Test assignment one &" matches value "37.975" And the field "Weight of Test assignment two" matches value "12.658" And the field "Weight of Sub category 1" matches value "5.696" And the field "Weight of Sub category 2" matches value "5.696" And I set the field "Override weight of Test assignment one &" to "1" And I set the field "Weight of Test assignment one &" to "10" And the field "Weight of Test assignment two" matches value "18.367" And the field "Weight of Sub category 1" matches value "8.265" And the field "Weight of Sub category 2" matches value "8.265" And I set the field "Override weight of Test assignment two" to "1" And I set the field "Override weight of Test assignment two" to "0" And the field "Weight of Test assignment six" matches value "22.222" And I set the field "Override weight of Test assignment six" to "1" And I set the field "Weight of Test assignment six" to "50" And I set the field "Override weight of Test assignment six" to "0" And the field "Weight of Test assignment six" matches value "22.222" And the field "Weight of Test assignment ten" matches value "33.333" And I set the field "Override weight of Test assignment ten" to "1" And I set the field "Weight of Test assignment ten" to "50" And I set the field "Override weight of Sub category 1" to "1" And I set the field "Weight of Sub category 1" to "15" Then the field "Weight of Test assignment one &" matches value "10.0" And the field "Weight of Test assignment two" matches value "16.854" And the field "Weight of Test assignment six" matches value "22.222" And the field "Weight of Test assignment ten" matches value "50.0" And the field "Weight of Sub category 1" matches value "15.0" And I press "Save changes" Then the field "Weight of Test assignment one &" matches value "10.0" And the field "Weight of Test assignment two" matches value "16.854" And the field "Weight of Test assignment six" matches value "22.222" And the field "Weight of Test assignment ten" matches value "50.0" And the field "Weight of Sub category 1" matches value "15.0" And I set the field "Override weight of Test assignment one &" to "0" And I set the field "Override weight of Test assignment two" to "0" And I set the field "Override weight of Test assignment six" to "0" And I set the field "Override weight of Sub category 1" to "0" And the field "Weight of Test assignment one &" matches value "37.975" And the field "Weight of Sub category 1" matches value "5.696" And I press "Save changes" And the field "Weight of Test assignment one &" matches value "37.975" And the field "Weight of Sub category 1" matches value "5.696" And I reset weights for grade category "Sub category 2 &" And the field "Weight of Test assignment ten" matches value "33.333" Scenario: Natural aggregation with weights of zero When I navigate to "View > Grader report" in the course gradebook And I set the following settings for grade item "Course 1" of type "course" on "grader" page: | Aggregation | Natural | | Exclude empty grades | 0 | And I set the following settings for grade item "Sub category 1" of type "category" on "grader" page: | Aggregation | Natural | | Exclude empty grades | 0 | And I set the following settings for grade item "Sub category 2 &" of type "category" on "grader" page: | Aggregation | Natural | | Exclude empty grades | 0 | And I turn editing mode off And I navigate to "Setup > Gradebook setup" in the course gradebook And "//span[@class='grateitemheader'][@title='Sub category 2 &']" "xpath_element" should not exist And "//span[@class='grateitemheader'][@title='Link to Test assignment one & Assignment']" "xpath_element" should not exist And I set the field "Override weight of Test assignment one &" to "1" And I set the field "Weight of Test assignment one &" to "0" And I should see "490.00" in the "Course total" "table_row" And I set the field "Override weight of Test assignment six" to "1" And I set the field "Weight of Test assignment six" to "0" And I should see "480.00" in the "Course total" "table_row" And I set the field "Override weight of Test assignment nine" to "1" And I set the field "Weight of Test assignment nine" to "100" And I press "Save changes" And I navigate to "Setup > Course grade settings" in the course gradebook And I set the field "report_overview_showtotalsifcontainhidden" to "Show totals excluding hidden items" And I set the field "report_user_showtotalsifcontainhidden" to "Show totals excluding hidden items" And I set the field "Show contribution to course total" to "Show" And I set the field "Show weightings" to "Show" And I press "Save changes" And I navigate to "View > Grader report" in the course gradebook Then I should see "75.00 (16.85 %)" in the ".course" "css_element" And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget And I set the field "View report as" to "Myself" And the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Contribution to course total | | Test assignment five | 57.14 % | 10.00 (50.00 %) | 2.25 % | | Test assignment six | 0.00 % | 5.00 (50.00 %) | 0.00 % | | Test assignment seven | 42.86 % | - | 0.00 % | | Test assignment eight | 0.00 % | 10.00 (50.00 %) | 0.00 % | | Test assignment nine | 100.00 % | 5.00 (50.00 %) | 1.12 % | | Test assignment ten | 0.00 % | - | 0.00 % | | Test assignment one & | 0.00 % | 60.00 (20.00 %) | 0.00 % | | Test assignment two | 22.47 % | 20.00 (20.00 %) | 4.49 % | | Test assignment three | 33.71 % | 40.00 (26.67 %) | 8.99 % | | Test assignment four | 33.71 % | - | 0.00 | And I log out And I log in as "student1" And I follow "Grades" in the user menu And I should see "45.00 (13.85 %)" in the "overview-grade" "table" And I click on "Course 1" "link" in the "region-main" "region" And the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Contribution to course total | | Test assignment six | 0.00 % | 5.00 (50.00 %) | 0.00 % | | Test assignment seven | 100.00 % | - | 0.00 % | | Test assignment nine | 100.00 % | 5.00 (50.00 %) | 1.54 % | | Test assignment ten | 0.00 | - | 0.00 % | | Test assignment one & | 0.00 % | 60.00 (20.00 %) | 0.00 % | | Test assignment three | 46.15 % | 40.00 (26.67 %) | 12.31 % | | Test assignment four | 46.15 % | - | 0.00 % | tests/behat/grade_point_maximum.feature 0000604 00000011315 15062070557 0014402 0 ustar 00 @core @core_grades Feature: We can change the grading type and maximum grade point values In order to verify that we can change the system-level maximum grade point value As an admin I need to modify the system maximum grade point and ensure that activities can use the full range. I need to ensure that using scales for activities still works correctly. I need to ensure that the maximum grade point value is enforced for new and existing activities. Background: Given the following "courses" exist: | fullname | shortname | category | format | | Course 1 | C1 | 0 | topics | Given the following "activities" exist: | activity | course | idnumber | name | intro | | assign | C1 | assign1 | Test Assignment 1 | Test Assignment 1 | And I log in as "admin" And I navigate to "Grades > General settings" in site administration And I set the following fields to these values: | Grade point maximum | 900 | | Grade point default | 800 | And I press "Save changes" And I am on "Course 1" course homepage @javascript Scenario: Validate that switching the type of grading used correctly disables input form elements Given I am on the "Test Assignment 1" "assign activity editing" page When I expand all fieldsets And I set the field "grade[modgrade_type]" to "Point" Then the "Scale" "select" should be disabled And the "Maximum grade" "field" should be enabled And I set the field "grade[modgrade_type]" to "Scale" And the "Maximum grade" "field" should be disabled Then the "Scale" "select" should be enabled And I set the field "grade[modgrade_type]" to "None" Then the "Scale" "select" should be disabled And the "Maximum grade" "field" should be disabled And I press "Save and return to course" @javascript Scenario: Create an activity with a maximum grade point value less than the system maximum Given I am on the "Test Assignment 1" "assign activity editing" page When I expand all fieldsets And I set the field "grade[modgrade_type]" to "point" And I set the field "grade[modgrade_point]" to "600" And I press "Save and display" And I am on the "Test Assignment 1" "assign activity editing" page Then the field "grade[modgrade_point]" matches value "600" And the "Scale" "select" should be disabled And I press "Save and return to course" @javascript Scenario: Create an activity with a scale as the grade type Given I am on the "Test Assignment 1" "assign activity editing" page When I expand all fieldsets And I set the field "grade[modgrade_type]" to "Scale" And I set the field "grade[modgrade_scale]" to "Separate and Connected ways of knowing" And I press "Save and display" And I am on the "Test Assignment 1" "assign activity editing" page Then the field "grade[modgrade_scale]" matches value "Separate and Connected ways of knowing" And the "Maximum grade" "field" should be disabled And I press "Save and return to course" @javascript Scenario: Create an activity with no grade as the grade type Given I am on the "Test Assignment 1" "assign activity editing" page When I expand all fieldsets And I set the field "grade[modgrade_type]" to "None" And I press "Save and display" And I am on the "Test Assignment 1" "assign activity editing" page And the "Scale" "select" should be disabled And the "Maximum grade" "field" should be disabled And I press "Save and return to course" Scenario: Create an activity with a maximum grade point value higher than the system maximum Given I am on the "Test Assignment 1" "assign activity editing" page When I expand all fieldsets And I set the field "grade[modgrade_type]" to "Point" And I set the field "grade[modgrade_point]" to "20000" And I press "Save and display" Then I should see "Invalid grade value. This must be an integer between 1 and 900" And I press "Cancel" Scenario: Create an activity with a valid maximum grade point and then change the system maximum to be lower Given I am on the "Test Assignment 1" "assign activity editing" page When I expand all fieldsets And I set the field "grade[modgrade_type]" to "point" And I set the field "grade[modgrade_point]" to "600" And I press "Save and display" And I navigate to "Grades > General settings" in site administration And I set the following fields to these values: | Grade point maximum | 100 | And I press "Save changes" And I am on the "Test Assignment 1" "assign activity editing" page And I press "Save and display" Then I should see "Invalid grade value. This must be an integer between 1 and 100" And I press "Cancel" tests/behat/grade_scales_logging.feature 0000604 00000001677 15062070557 0014506 0 ustar 00 @core @core_grades Feature: We can view the logs for any changes to grade scales. In order to view changes grade scales As an administrator I need to add make changes and then view the logs. Scenario: I edit scales and then view the logs. Given I log in as "admin" And I navigate to "Grades > Scales" in site administration # Add a scale And I press "Add a new scale" And I set the following fields to these values: | Name | Letterscale | | Scale | F,D,C,B,A | And I press "Save changes" # Delete first scale And I follow "Delete" And I press "Continue" # Edit first scale And I follow "Edit" And I set the following fields to these values: | id_scale | ONE,TWO,THREE | And I press "Save changes" When I navigate to "Reports > Live logs" in site administration Then I should see "Scale created" And I should see "Scale updated" And I should see "Scale deleted" tests/behat/toggle_grade_categories.feature 0000604 00000031554 15062070557 0015211 0 ustar 00 @core @core_grades @javascript Feature: Teachers can toggle the visibility of the grade categories in the Gradebook setup page. In order to focus only on the information that I am interested in As a teacher I need to be able to easily toggle the visibility of grade categories in the Gradebook setup page Background: Given the following "courses" exist: | fullname | shortname | category | | Course | C1 | 0 | And the following "users" exist: | username | firstname | lastname | email | idnumber | | teacher1 | Teacher 1 | 1 | teacher1@example.com | t1 | | teacher2 | Teacher 2 | 2 | teacher2@example.com | t2 | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | teacher2 | C1 | editingteacher | And the following "grade categories" exist: | fullname | course | | Category 1 | C1 | And the following "activities" exist: | activity | course | idnumber | name | intro | | assign | C1 | a1 | Test assignment one | Submit something! | And the following "activities" exist: | activity | course | idnumber | name | intro | gradecategory | | assign | C1 | a2 | Test assignment two | Submit something! | Category 1 | And the following "grade items" exist: | itemname | grademax | course | gradecategory | | Manual grade | 40 | C1 | Category 1 | And I am on the "Course" "grades > gradebook setup" page logged in as "teacher1" Scenario: A teacher can collapse and expand grade categories in the Gradebook setup page Given the following should exist in the "setup-grades" table: | Name | | Course | | Test assignment one | | Category 1 | | Test assignment two | | Manual grade | | Category 1 total | | Course total | And "Collapse" "link" should exist in the "Course" "table_row" And "Collapse" "link" should exist in the "Category 1" "table_row" # Collapse the grade category 'Category 1'. When I click on "Collapse" "link" in the "Category 1" "table_row" Then the following should exist in the "setup-grades" table: | Name | | Course | | Test assignment one | | Category 1 | | Course total | And "Collapse" "link" should exist in the "Course" "table_row" And "Expand" "link" should exist in the "Category 1" "table_row" And the following should not exist in the "user-grades" table: | Test assignment two | | Manual grade | | Category 1 total | # Expand the grade category 'Category 1'. And I click on "Expand" "link" in the "Category 1" "table_row" And the following should exist in the "setup-grades" table: | Name | | Course | | Test assignment one | | Category 1 | | Test assignment two | | Manual grade | | Category 1 total | | Course total | And "Collapse" "link" should exist in the "Course" "table_row" And "Collapse" "link" should exist in the "Category 1" "table_row" # Collapse again the grade category 'Category 1'. And I click on "Collapse" "link" in the "Category 1" "table_row" # Collapse the grade category 'Course'. And I click on "Collapse" "link" in the "Course" "table_row" And the following should exist in the "setup-grades" table: | Name | | Course | And I should see "Course" in the "setup-grades" "table" And "Expand" "link" should exist in the "Course" "table_row" And the following should not exist in the "setup-grades" table: | Name | | Test assignment one | | Category 1 | | Test assignment two | | Manual grade | | Category 1 total | | Course total | # Expand the grade category 'Course'. 'Category 1' should be still collapsed. And I click on "Expand" "link" in the "Course" "table_row" And the following should exist in the "setup-grades" table: | Name | | Course | | Test assignment one | | Category 1 | | Course total | And "Collapse" "link" should exist in the "Course" "table_row" And "Expand" "link" should exist in the "Category 1" "table_row" And the following should not exist in the "setup-grades" table: | Name | | Test assignment two | | Manual grade | | Category 1 total | Scenario: A teacher can see the aggregated max grade for a grade category even when the category is collapsed Given the following should exist in the "setup-grades" table: | Name | Max grade | | Course | | | Category 1 | | | Category 1 total | 140.00 | | Course total | 240.00 | # Collapse the grade category 'Category 1'. The aggregated max grade should now be displayed within the 'Category 1' row. When I click on "Collapse" "link" in the "Category 1" "table_row" Then the following should exist in the "setup-grades" table: | Name | Max grade | | Course | | | Category 1 | 140.00 | | Course total | 240.00 | And I should not see "Category 1 total" in the "setup-grades" "table" # Collapse the grade category 'Course'. The aggregated max grade should now be displayed within the 'Course' row. And I click on "Collapse" "link" in the "Course" "table_row" And "Course" row "Max grade" column of "setup-grades" table should contain "240.00" And I should not see "Course total" in the "setup-grades" "table" # Expand the grade category 'Course'. The aggregated max grade should not be displayed within the 'Course' row anymore. And I click on "Expand" "link" in the "Course" "table_row" And the following should exist in the "setup-grades" table: | Name | Max grade | | Course | | | Category 1 | 140.00 | | Course total | 240.00 | And I should not see "Category 1 total" in the "setup-grades" "table" Scenario: A teacher can collapse and expand grade categories in the Gradebook setup when moving grade items Given I click on "Move" "link" in the "Test assignment one" "table_row" And the following should exist in the "setup-grades" table: | Name | | Course | | Test assignment one | | Category 1 | | Test assignment two | | Manual grade | | Category 1 total | | Course total | And "Collapse" "link" should exist in the "Course" "table_row" And "Collapse" "link" should exist in the "Category 1" "table_row" # Collapse the grade category 'Category 1'. When I click on "Collapse" "link" in the "Category 1" "table_row" Then the following should exist in the "setup-grades" table: | Name | | Course | | Test assignment one | | Category 1 | And "Collapse" "link" should exist in the "Course" "table_row" And "Expand" "link" should exist in the "Category 1" "table_row" And the following should not exist in the "setup-grades" table: | Name | | Test assignment two | | Manual grade | | Category 1 total | # Expand the grade category 'Category 1'. And I click on "Expand" "link" in the "Category 1" "table_row" And the following should exist in the "setup-grades" table: | Name | | Course | | Test assignment one | | Category 1 | | Test assignment two | | Manual grade | | Category 1 total | | Course total | And "Collapse" "link" should exist in the "Course" "table_row" And "Collapse" "link" should exist in the "Category 1" "table_row" # Collapse again the grade category 'Category 1'. And I click on "Collapse" "link" in the "Category 1" "table_row" # Collapse the grade category 'Course'. And I click on "Collapse" "link" in the "Course" "table_row" And I should see "Course" in the "setup-grades" "table" And "Expand" "link" should exist in the "Course" "table_row" And the following should not exist in the "setup-grades" table: | Name | | Test assignment one | | Category 1 | | Test assignment two | | Manual grade | | Category 1 total | | Course total | # Expand the grade category 'Course'. 'Category 1' should be still collapsed. And I click on "Expand" "link" in the "Course" "table_row" And the following should exist in the "setup-grades" table: | Name | | Course | | Test assignment one | | Category 1 | | Course total | And "Collapse" "link" should exist in the "Course" "table_row" And "Expand" "link" should exist in the "Category 1" "table_row" And the following should not exist in the "setup-grades" table: | Name | | Test assignment two | | Manual grade | | Category 1 total | Scenario: Previously collapsed categories are still shown as collapsed when a teacher navigates back to Gradebook setup # Collapse the grade category 'Category 1' and navigate to the course homepage. Given I click on "Collapse" "link" in the "Category 1" "table_row" # Navigate back to Gradebook setup and confirm that the category 'Category 1' is still collapsed. When I am on the "Course" "grades > gradebook setup" page Then the following should exist in the "setup-grades" table: | Name | | Course | | Test assignment one | | Category 1 | | Course total | And "Collapse" "link" should exist in the "Course" "table_row" And "Expand" "link" should exist in the "Category 1" "table_row" And the following should not exist in the "setup-grades" table: | Name | | Test assignment two | | Manual grade | | Category 1 total | Scenario: Previously collapsed categories are still shown as collapsed when a teacher is moving grade items in Gradebook setup # Collapse the grade category 'Category 1'. Given I click on "Collapse" "link" in the "Category 1" "table_row" # Attempt to move a grade item and confirm that the category 'Category 1' is still collapsed. When I click on "Move" "link" in the "Test assignment one" "table_row" Then the following should exist in the "setup-grades" table: | Name | | Course | | Test assignment one | | Category 1 | | Course total | And "Collapse" "link" should exist in the "Course" "table_row" And "Expand" "link" should exist in the "Category 1" "table_row" And the following should not exist in the "setup-grades" table: | Name | | Test assignment two | | Manual grade | | Category 1 total | Scenario: Grade categories are shown as collapsed only to the teacher that collapsed them # Collapse the grade category 'Category 1'. Given I click on "Collapse" "link" in the "Category 1" "table_row" # Log in as teacher2 and confirm that the category 'Category 1' is not collapsed. When I am on the "Course" "grades > gradebook setup" page logged in as "teacher2" Then the following should exist in the "setup-grades" table: | Name | | Course | | Test assignment one | | Category 1 | | Test assignment two | | Manual grade | | Category 1 total | | Course total | And "Collapse" "link" should exist in the "Course" "table_row" And "Collapse" "link" should exist in the "Category 1" "table_row" # Log in as teacher1 and confirm that the category 'Category 1' is still collapsed. And I am on the "Course" "grades > gradebook setup" page logged in as "teacher1" And the following should exist in the "setup-grades" table: | Name | | Course | | Test assignment one | | Category 1 | | Course total | And "Collapse" "link" should exist in the "Course" "table_row" And "Expand" "link" should exist in the "Category 1" "table_row" And the following should not exist in the "setup-grades" table: | Name | | Test assignment two | | Manual grade | | Category 1 total | tests/behat/grade_feedback.feature 0000604 00000006722 15062070557 0013246 0 ustar 00 @gradereport @gradereport_grader @javascript Feature: Display feedback on the Grader report In order to check the expected results are displayed As a teacher I need to see the feedback information in a modal Background: Given the following "courses" exist: | fullname | shortname | | Course 1 | C1 | And the following "users" exist: | username | firstname | lastname | email | | teacher1 | Teacher | 1 | teacher1@example.com | | student1 | Student | 1 | student1@example.com | | student2 | Student | 2 | student2@example.com | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | | student2 | C1 | student | And the following "activities" exist: | activity | course | name | assignfeedback_comments_enabled | | assign | C1 | Test assignment name 1 | 1 | | assign | C1 | Test assignment name 2 | 1 | And the following "mod_assign > submissions" exist: | assign | user | onlinetext | | Test assignment name 1 | student1 | This is a submission for assignment 1 | | Test assignment name 2 | student1 | This is a submission for assignment 2 | And the following "grade items" exist: | itemname | course | gradetype | itemtype | | Grade item 1 | C1 | text | manual | And the following "grade grades" exist: | gradeitem | user | grade | feedback | | Grade item 1 | student1 | | Longer feedback text content | And I am on the "Test assignment name 1" "assign activity" page logged in as teacher1 And I follow "View all submissions" And I click on "Grade" "link" in the "Student 1" "table_row" And I set the following fields to these values: | Grade out of 100 | 50 | | Feedback comments | This is feedback | And I press "Save changes" Scenario: View the feedback icon on the Grader report When I am on the "Course 1" "grades > Grader report > View" page Then I should see "Test assignment name 1" in the "user-grades" "table" And I should see "Test assignment name 2" in the "user-grades" "table" And "Feedback provided" "icon" should exist in the "Student 1" "table_row" And "Feedback provided" "icon" should not exist in the "Student 2" "table_row" Scenario: View the feedback modal from the action menu When I am on the "Course 1" "grades > Grader report > View" page And I click on "Test assignment name 1" "core_grades > grade_actions" in the "Student 1" "table_row" When I choose "View feedback" in the open action menu Then I should see "This is feedback" in the "Test assignment name 1" "dialogue" Scenario: View the feedback text for text only grade When I am on the "Course 1" "grades > Grader report > View" page Then I should see "Grade item 1" And "Longer feedback ..." "text" should exist in the "Student 1" "table_row" Scenario: View the feedback modal for text only grade Given I am on the "Course 1" "grades > Grader report > View" page When I click on "Longer feedback ..." "text" in the "Student 1" "table_row" Then I should see "Longer feedback text content" in the "Grade item 1" "dialogue" tests/behat/grade_letter_boundary.feature 0000604 00000003737 15062070557 0014727 0 ustar 00 @core @core_grades Feature: We can customise the letter boundary of a course. In order to change the letter boundary of a course As a teacher I need to add assessments to the gradebook. @javascript Scenario: I edit the letter boundaries of a course and grade a student. Given the following "courses" exist: | fullname | shortname | category | | Course 1 | C1 | 0 | And the following "users" exist: | username | firstname | lastname | email | idnumber | alternatename | | teacher1 | Teacher | 1 | teacher1@example.com | t1 | Terry | | student1 | Student | 1 | student1@example.com | s1 | Sally | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | And the following "activities" exist: | activity | course | idnumber | name | intro | grade | | assign | C1 | a1 | Test assignment one | Submit something! | 100 | And I am on the "Course 1" "grades > course grade settings" page logged in as "teacher1" And I set the following fields to these values: | Grade display type | Letter | And I press "Save changes" And I navigate to "More > Grade letters" in the course gradebook And I click on "Edit" "button" And I set the following fields to these values: | Override site defaults | 1 | | Letter grade boundary 10 | 57 | And I press "Save changes" And I navigate to "View > Grader report" in the course gradebook And I turn editing mode on And I give the grade "57" to the user "Student 1" for the grade item "Test assignment one" And I press "Save changes" And I am on "Course 1" course homepage with editing mode off And I navigate to "View > Grader report" in the course gradebook Then the following should exist in the "user-grades" table: | -1- | -1- |-3- | -4- | | Student 1 | student1@example.com | D | D | tests/behat/grade_calculated_grade_items.feature 0000604 00000025521 15062070557 0016164 0 ustar 00 @core @core_grades Feature: Calculated grade items can be used in the gradebook In order to use calculated grade items in the gradebook As a teacher I need setup calculated grade items in the 'Gradebook setup' page. Background: Given the following "courses" exist: | fullname | shortname | category | groupmode | | Course 1 | C1 | 0 | 1 | And the following "users" exist: | username | firstname | lastname | email | idnumber | | teacher1 | Teacher | 1 | teacher1@example.com | t1 | | student1 | Student | 1 | student1@example.com | s1 | | student2 | Student | 2 | student2@example.com | s2 | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | | student2 | C1 | student | And I am on the "Course 1" "grades > gradebook setup" page logged in as "admin" @javascript Scenario: The max grade for a category item, with a calculation using Natural aggregation, can be changed Given I choose the "Add category" item in the "Add" action menu And I set the following fields to these values: | Category name | Calc cat | And I click on "Save" "button" in the "New category" "dialogue" And I wait until the page is ready And I choose the "Add grade item" item in the "Add" action menu And I set the following fields to these values: | Item name | grade item 1 | | Grade category | Calc cat | And I click on "Save" "button" in the "New grade item" "dialogue" And I set "=[[gi1]]/2" calculation for grade category "Calc cat" with idnumbers: | grade item 1 | gi1 | And I set the following settings for grade item "Calc cat" of type "category" on "setup" page: | Maximum grade | 50 | And I navigate to "View > Grader report" in the course gradebook And I turn editing mode on And I give the grade "75.00" to the user "Student 1" for the grade item "grade item 1" And I press "Save changes" And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget And the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | grade item 1 | - | 75.00 | 0–100 | 75.00 % | - | | Calc cat total | 100.00 % | 37.50 | 0–50 | 75.00 % | - | | Course total | - | 37.50 | 0–50 | 75.00 % | - | @javascript Scenario: Changing max grade for a category item with a calculation that has existing grades will display the same points with the new max grade values immediately. Given I choose the "Add category" item in the "Add" action menu And I set the following fields to these values: | Category name | Calc cat | And I click on "Save" "button" in the "New category" "dialogue" And I wait until the page is ready And I should not see "Calculated grade" in the "Calc cat" "table_row" And I choose the "Add grade item" item in the "Add" action menu And I set the following fields to these values: | Item name | grade item 1 | | Grade category | Calc cat | And I click on "Save" "button" in the "New grade item" "dialogue" And I set "=[[gi1]]/2" calculation for grade category "Calc cat" with idnumbers: | grade item 1 | gi1 | And I should see "Calculated grade" in the "Calc cat" "table_row" And I set the following settings for grade item "Calc cat" of type "category" on "setup" page: | Maximum grade | 50 | And I navigate to "View > Grader report" in the course gradebook And I turn editing mode on And I give the grade "75.00" to the user "Student 1" for the grade item "grade item 1" And I press "Save changes" And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget And the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | grade item 1 | - | 75.00 | 0–100 | 75.00 % | - | | Calc cat total | 100.00 % | 37.50 | 0–50 | 75.00 % | - | | Course total | - | 37.50 | 0–50 | 75.00 % | - | And I navigate to "Setup > Gradebook setup" in the course gradebook And I set the following settings for grade item "Calc cat" of type "category" on "setup" page: | Maximum grade | 40 | And I navigate to "View > Grader report" in the course gradebook And I give the grade "65.00" to the user "Student 2" for the grade item "grade item 1" And I press "Save changes" And I navigate to "View > User report" in the course gradebook When I click on "Student 1" in the "user" search widget Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | grade item 1 | - | 75.00 | 0–100 | 75.00 % | - | | Calc cat total | 100.00 % | 37.50 | 0–40 | 93.75 % | - | | Course total | - | 37.50 | 0–40 | 93.75 % | - | And I click on "Student 2" in the "user" search widget And the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | grade item 1 | - | 65.00 | 0–100 | 65.00 % | - | | Calc cat total | 100.00 % | 32.50 | 0–40 | 81.25 % | - | | Course total | - | 32.50 | 0–40 | 81.25 % | - | And I navigate to "Setup > Course grade settings" in the course gradebook And I set the following fields to these values: | Min and max grades used in calculation | Initial min and max grades | And I press "Save changes" And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget And the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | grade item 1 | - | 75.00 | 0–100 | 75.00 % | - | | Calc cat total | 100.00 % | 37.50 | 0–40 | 93.75 % | - | | Course total | - | 37.50 | 0–40 | 93.75 % | - | And I click on "Student 2" in the "user" search widget And the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | grade item 1 | - | 65.00 | 0–100 | 65.00 % | - | | Calc cat total | 100.00 % | 32.50 | 0–40 | 81.25 % | - | | Course total | - | 32.50 | 0–40 | 81.25 % | - | @javascript Scenario: Values in calculated grade items are not always out of one hundred Given I choose the "Add grade item" item in the "Add" action menu And I set the following fields to these values: | Item name | grade item 1 | And I click on "Save" "button" in the "New grade item" "dialogue" And I choose the "Add grade item" item in the "Add" action menu And I set the following fields to these values: | Item name | calc item | And I click on "Save" "button" in the "New grade item" "dialogue" And I set "=[[gi1]]/2" calculation for grade item "calc item" with idnumbers: | grade item 1 | gi1 | And I set the following settings for grade item "calc item" of type "gradeitem" on "setup" page: | Maximum grade | 50 | And I navigate to "Setup > Course grade settings" in the course gradebook And I set the following fields to these values: | Min and max grades used in calculation | Initial min and max grades | And I press "Save changes" And I navigate to "View > Grader report" in the course gradebook And I turn editing mode on And I give the grade "75.00" to the user "Student 1" for the grade item "grade item 1" And I press "Save changes" And I navigate to "View > User report" in the course gradebook When I click on "Student 1" in the "user" search widget Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | grade item 1 | 66.67 % | 75.00 | 0–100 | 75.00 % | 50.00 % | | calc item | 33.33 % | 37.50 | 0–50 | 75.00 % | 25.00 % | | Course total | - | 112.50 | 0–150 | 75.00 % | - | And I navigate to "Setup > Gradebook setup" in the course gradebook And I set the following settings for grade item "calc item" of type "gradeitem" on "setup" page: | Rescale existing grades | No | | Maximum grade | 40 | And I navigate to "View > Grader report" in the course gradebook And I give the grade "65.00" to the user "Student 2" for the grade item "grade item 1" And I press "Save changes" And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget And the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | grade item 1 | 71.43 % | 75.00 | 0–100 | 75.00 % | 53.57 % | | calc item | 28.57 % | 37.50 | 0–40 | 93.75 % | 26.79 % | | Course total | - | 112.50 | 0–140 | 80.36 % | - | And I click on "Student 2" in the "user" search widget And the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | grade item 1 | 71.43 % | 65.00 | 0–100 | 65.00 % | 46.43 % | | calc item | 28.57 % | 32.50 | 0–40 | 81.25 % | 23.21 % | | Course total | - | 97.50 | 0–140 | 69.64 % | - | tests/behat/grade_letter_logging.feature 0000604 00000002761 15062070557 0014526 0 ustar 00 @core @core_grades @javascript Feature: We can view the logs for any changes to grade letters. In order to view changes the letter boundary of a course As an administrator I need to add make changes and then view the logs. Scenario: I override the letter boundaries and check the logs. Given the following "courses" exist: | fullname | shortname | category | | Course 1 | C1 | 0 | And I am on the "Course 1" "grades > course grade settings" page logged in as "admin" And I set the following fields to these values: | Grade display type | Letter | And I press "Save changes" And I navigate to "More > Grade letters" in the course gradebook And I click on "Edit" "button" And I set the following fields to these values: | Override site defaults | 1 | | Letter grade boundary 10 | 57 | And I press "Save changes" And I click on "Edit" "button" And I set the following fields to these values: | Override site defaults | 1 | | Letter grade boundary 10 | 50 | And I press "Save changes" And I click on "Edit" "button" And I set the following fields to these values: | Override site defaults | 1 | | Grade letter 11 | | | Letter grade boundary 11 | | And I press "Save changes" When I navigate to "Reports > Live logs" in site administration Then I should see "Grade letter created" And I should see "Grade letter updated" And I should see "Grade letter deleted" tests/behat/grade_calculated_weights.feature 0000604 00000037550 15062070557 0015360 0 ustar 00 @core @core_grades Feature: We can understand the gradebook user report In order to understand the gradebook user report As an teacher I need to see the calculated weights for each type of aggregation Background: Given the following "courses" exist: | fullname | shortname | category | groupmode | | Course 1 | C1 | 0 | 1 | And the following "users" exist: | username | firstname | lastname | email | idnumber | | teacher1 | Teacher | 1 | teacher1@example.com | t1 | | student1 | Student | 1 | student1@example.com | s1 | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | And the following "activities" exist: | activity | course | idnumber | name | intro | | assign | C1 | a1 | Test assignment one | Submit something! | | assign | C1 | a2 | Test assignment two | Submit something! | | assign | C1 | a3 | Test assignment three | Submit something! | | assign | C1 | a4 | Test assignment four | Submit something! | | assign | C1 | a5 | Test assignment five | Submit something! | | assign | C1 | a6 | Test assignment six | Submit something! | And I log in as "admin" And I set the following administration settings values: | grade_aggregations_visible | Mean of grades,Weighted mean of grades,Simple weighted mean of grades,Mean of grades (with extra credits),Median of grades,Lowest grade,Highest grade,Mode of grades,Natural | And the following "grade grades" exist: | gradeitem | user | grade | | Test assignment one | student1 | 60.00 | | Test assignment two | student1 | 20.00 | | Test assignment three | student1 | 40.00 | | Test assignment four | student1 | 10.00 | | Test assignment five | student1 | 70.00 | | Test assignment six | student1 | 30.00 | And I am on the "Course 1" "grades > course grade settings" page logged in as "teacher1" And I set the field "Show weightings" to "Show" And I set the field "Show contribution to course total" to "Show" And I press "Save changes" And I navigate to "Setup > Gradebook setup" in the course gradebook And I choose the "Add category" item in the "Add" action menu And I set the field "Category name" to "Sub category" And I click on "Save" "button" in the "New category" "dialogue" And I wait until the page is ready And I click on "Move" "link" in the "Test assignment six" "table_row" # This xpath finds the forth last row in the table. And I click on "Move to here" "link" in the "//tbody//tr[position()=last()-3]" "xpath_element" And I click on "Move" "link" in the "Test assignment five" "table_row" And I click on "Move to here" "link" in the "//tbody//tr[position()=last()-3]" "xpath_element" And I click on "Move" "link" in the "Test assignment four" "table_row" And I click on "Move to here" "link" in the "//tbody//tr[position()=last()-3]" "xpath_element" @javascript @skip_chrome_zerosize Scenario: Mean of grades aggregation And I set the following settings for grade item "Course 1" of type "course" on "setup" page: | Aggregation | Mean of grades | And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget # Check the values in the weights column. Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Contribution to course total | | Test assignment one | 25.00 % | 60.00 | 15.00 % | | Test assignment two | 25.00 % | 20.00 | 5.00 % | | Test assignment three | 25.00 % | 40.00 | 10.00 % | | Test assignment four | 33.33 % | 10.00 | 0.83 % | | Test assignment five | 33.33 % | 70.00 | 5.83 % | | Test assignment six | 33.33 % | 30.00 | 2.50 % | @javascript @skip_chrome_zerosize Scenario: Weighted mean of grades aggregation And I set the following settings for grade item "Course 1" of type "course" on "setup" page: | Aggregation | Weighted mean of grades | And I set the following settings for grade item "Test assignment one" of type "gradeitem" on "setup" page: | Item weight | 2.0 | And I set the following settings for grade item "Test assignment two" of type "gradeitem" on "setup" page: | Item weight | 1.0 | And I set the following settings for grade item "Test assignment three" of type "gradeitem" on "setup" page: | Item weight | 1.0 | And I set the following settings for grade item "Sub category" of type "category" on "setup" page: | Item weight | 1.0 | And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget # Check the values in the weights column. Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Contribution to course total | | Test assignment one | 40.00 % | 60.00 | 24.00 % | | Test assignment two | 20.00 % | 20.00 | 4.00 % | | Test assignment three | 20.00 % | 40.00 | 8.00 % | | Test assignment four | 33.33 % | 10.00 | 0.67 % | | Test assignment five | 33.33 % | 70.00 | 4.67 % | | Test assignment six | 33.33 % | 30.00 | 2.00 % | @javascript @skip_chrome_zerosize Scenario: Simple weighted mean of grades aggregation And I set the following settings for grade item "Course 1" of type "course" on "setup" page: | Aggregation | Simple weighted mean of grades | And I set the following settings for grade item "Sub category" of type "category" on "setup" page: | Aggregation | Simple weighted mean of grades | And I set the following settings for grade item "Test assignment three" of type "gradeitem" on "setup" page: | Extra credit | 1 | And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget # Check the values in the weights column. Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Contribution to course total | | Test assignment one | 33.33 % | 60.00 | 20.00 % | | Test assignment two | 33.33 % | 20.00 | 6.67 % | | Test assignment three | 33.33 %( Extra credit ) | 40.00 | 13.33 % | | Test assignment four | 33.33 % | 10.00 | 1.11 % | | Test assignment five | 33.33 % | 70.00 | 7.78 % | | Test assignment six | 33.33 % | 30.00 | 3.33 % | @javascript @skip_chrome_zerosize Scenario: Mean of grades (with extra credits) aggregation And I set the following settings for grade item "Course 1" of type "course" on "setup" page: | Aggregation | Mean of grades (with extra credits) | And I set the following settings for grade item "Test assignment three" of type "gradeitem" on "setup" page: | Extra credit weight | 1.0 | And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget # Check the values in the weights column. Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Contribution to course total | | Test assignment one | 33.33 % | 60.00 | 20.00 % | | Test assignment two | 33.33 % | 20.00 | 6.67 % | | Test assignment three | 33.33 %( Extra credit ) | 40.00 | 13.33 % | | Test assignment four | 33.33 % | 10.00 | 1.11 % | | Test assignment five | 33.33 % | 70.00 | 7.78 % | | Test assignment six | 33.33 % | 30.00 | 3.33 % | @javascript @skip_chrome_zerosize Scenario: Median of grades aggregation And I set the following settings for grade item "Course 1" of type "course" on "setup" page: | Aggregation | Median of grades | And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget # Check the values in the weights column. Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Contribution to course total | | Test assignment one | 0.00 % | 60.00 | 0.00 % | | Test assignment two | 0.00 % | 20.00 | 0.00 % | | Test assignment three | 50.00 % | 40.00 | 20.00 % | | Test assignment four | 33.33 % | 10.00 | 1.67 % | | Test assignment five | 33.33 % | 70.00 | 11.67 % | | Test assignment six | 33.33 % | 30.00 | 5.00 % | @javascript @skip_chrome_zerosize Scenario: Lowest grade aggregation And I set the following settings for grade item "Course 1" of type "course" on "setup" page: | Aggregation | Lowest grade | And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget # Check the values in the weights column. Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Contribution to course total | | Test assignment one | 0.00 % | 60.00 | 0.00 % | | Test assignment two | 100.00 % | 20.00 | 20.00 % | | Test assignment three | 0.00 % | 40.00 | 0.00 % | | Test assignment four | 33.33 % | 10.00 | 0.00 % | | Test assignment five | 33.33 % | 70.00 | 0.00 % | | Test assignment six | 33.33 % | 30.00 | 0.00 % | @javascript @skip_chrome_zerosize Scenario: Highest grade aggregation And I set the following settings for grade item "Course 1" of type "course" on "setup" page: | Aggregation | Highest grade | And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget # Check the values in the weights column. Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Contribution to course total | | Test assignment one | 100.00 % | 60.00 | 60.00 % | | Test assignment two | 0.00 % | 20.00 | 0.00 % | | Test assignment three | 0.00 % | 40.00 | 0.00 % | | Test assignment four | 33.33 % | 10.00 | 0.00 % | | Test assignment five | 33.33 % | 70.00 | 0.00 % | | Test assignment six | 33.33 % | 30.00 | 0.00 % | @javascript @skip_chrome_zerosize Scenario: Mode of grades aggregation And I set the following settings for grade item "Course 1" of type "course" on "setup" page: | Aggregation | Mode of grades | And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget # Check the values in the weights column. Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Contribution to course total | | Test assignment one | 100.00 % | 60.00 | 60.00 % | | Test assignment two | 0.00 % | 20.00 | 0.00 % | | Test assignment three | 0.00 % | 40.00 | 0.00 % | | Test assignment four | 33.33 % | 10.00 | 0.00 % | | Test assignment five | 33.33 % | 70.00 | 0.00 % | | Test assignment six | 33.33 % | 30.00 | 0.00 % | @javascript @skip_chrome_zerosize Scenario: View user report with mixed aggregation methods And I change window size to "large" And I set the following settings for grade item "Course 1" of type "course" on "setup" page: | Aggregation | Natural | And I set the following settings for grade item "Sub category" of type "category" on "setup" page: | Aggregation | Weighted mean of grades | And I set the following settings for grade item "Test assignment three" of type "gradeitem" on "setup" page: | aggregationcoef | 1 | And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget # Check the values in the weights column. Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Contribution to course total | | Test assignment one | 33.33 % | 60.00 | 20.00 % | | Test assignment two | 33.33 % | 20.00 | 6.67 % | | Test assignment three | 33.33 %( Extra credit ) | 40.00 | 13.33 % | | Test assignment four | 33.33 % | 10.00 | 1.11 % | | Test assignment five | 33.33 % | 70.00 | 7.78 % | | Test assignment six | 33.33 % | 30.00 | 3.33 % | | Sub category total | 33.33 % | 36.67 | - | | Course total | - | 156.67 | - | @javascript @skip_chrome_zerosize Scenario: View user report with natural aggregation And I set the following settings for grade item "Test assignment three" of type "gradeitem" on "setup" page: | Extra credit | 1 | And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget # Check the values in the weights column. Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Contribution to course total | | Test assignment one | 20.00 % | 60.00 | 12.00 % | | Test assignment two | 20.00 % | 20.00 | 4.00 % | | Test assignment three | 20.00 %( Extra credit ) | 40.00 | 8.00 % | | Test assignment four | 33.33 % | 10.00 | 2.00 % | | Test assignment five | 33.33 % | 70.00 | 14.00 % | | Test assignment six | 33.33 % | 30.00 | 6.00 % | | Sub category total | 60.00 % | 110.00 | - | | Course total | - | 230.00 | - | tests/behat/grade_hidden_items.feature 0000604 00000010144 15062070557 0014147 0 ustar 00 @core @core_grades @javascript Feature: Student and teacher's view of aggregated grade items is consistent when hidden grade items are present In order to calculate grade totals As an teacher I need to add aggregate columns to the gradebook Scenario: Natural aggregation of course categories with hidden items calculates correctly for teacher and student Given the following "courses" exist: | fullname | shortname | category | groupmode | | Course 1 | C1 | 0 | 1 | And the following "users" exist: | username | firstname | lastname | email | idnumber | | teacher1 | Teacher | 1 | teacher1@example.com | t1 | | student1 | Student | 1 | student1@example.com | s1 | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | And the following "grade categories" exist: | fullname | course | | Sub category 1 | C1 | | Sub category 2 | C1 | And the following "activities" exist: | activity | course | idnumber | name | intro | gradecategory | grade | | assign | C1 | a1 | Test assignment one | Submit something! | Sub category 1 | 100 | | assign | C1 | a2 | Test assignment two | Submit something! | Sub category 1 | 100 | | assign | C1 | a3 | Test assignment three | Submit something! | Sub category 2 | 100 | | assign | C1 | a4 | Test assignment four | Submit something! | Sub category 2 | 100 | And I am on the "Course 1" "grades > gradebook setup" page logged in as "admin" And I choose the "Add grade item" item in the "Add" action menu And I set the following fields to these values: | Item name | calculated | And I click on "Save" "button" in the "New grade item" "dialogue" And I set "=[[a4]]/2" calculation for grade item "calculated" with idnumbers: | Sub category 1 | sub1 | And I navigate to "Grades > Report settings > Overview report" in site administration And I set the field "s__grade_report_overview_showtotalsifcontainhidden" to "Show totals excluding hidden items" And I navigate to "Grades > Report settings > User report" in site administration And I set the field "s__grade_report_user_showtotalsifcontainhidden" to "Show totals excluding hidden items" And I press "Save changes" And I am on the "Course 1" "grades > Grader report > View" page logged in as "teacher1" And I turn editing mode on And I give the grade "50.00" to the user "Student 1" for the grade item "Test assignment one" And I give the grade "50.00" to the user "Student 1" for the grade item "Test assignment three" And I press "Save changes" And I set the following settings for grade item "Test assignment four" of type "gradeitem" on "grader" page: | Hidden | 1 | And I am on the "Course 1" "grades > User report > View" page And I click on "Student 1" in the "user" search widget And I set the field "View report as" to "Myself" Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | Test assignment one | 100.00 % | 50.00 | 0–100 | 50.00 % | 25.00 % | | Test assignment two | 0.00 %( Empty ) | - | 0–100 | - | 0.00 % | | Test assignment three | 100.00 % | 50.00 | 0–100 | 50.00 % | 25.00 % | | Course total | - | 100.00 | 0–200 | 50.00 % | - | When I am on the "Course 1" "grades > User report > View" page logged in as "student1" Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | Test assignment one | 100.00 % | 50.00 | 0–100 | 50.00 % | 25.00 % | | Test assignment two | -( Empty ) | - | 0–100 | - | - | | Test assignment three | 100.00 % | 50.00 | 0–100 | 50.00 % | 25.00 % | | Course total | - | 100.00 | 0–200 | 50.00 % | - | And I should not see "Test assignment four" in the "user-grade" "table" tests/behat/grade_hidden_items_locked_category.feature 0000604 00000010473 15062070557 0017372 0 ustar 00 @core @core_grades @javascript Feature: Hidden grade items should be hidden when grade category is locked, but should be visible in overridden category In order to verify existing grades items display as expected As an teacher I need to modify grade items and grade categories I need to ensure existing grades display in an expected manner Background: Given the following "courses" exist: | fullname | shortname | category | groupmode | | Course 1 | C1 | 0 | 1 | And the following "users" exist: | username | firstname | lastname | email | idnumber | | teacher1 | Teacher | 1 | teacher1@example.com | t1 | | student1 | Student | 1 | student1@example.com | s1 | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | And I am on the "Course 1" "grades > gradebook setup" page logged in as "admin" And I choose the "Add category" item in the "Add" action menu And I set the following fields to these values: | Category name | Test locked category | And I click on "Save" "button" in the "New category" "dialogue" And I wait until the page is ready And I choose the "Add grade item" item in the "Add" action menu And I set the following fields to these values: | Item name | Hidden item | | Hidden | 1 | | Grade category | Test locked category | And I click on "Save" "button" in the "New grade item" "dialogue" And I am on the "Course 1" "grades > Grader report > View" page logged in as "teacher1" And I turn editing mode on And I give the grade "50.00" to the user "Student 1" for the grade item "Hidden item" And I press "Save changes" And I navigate to "Setup > Gradebook setup" in the course gradebook And I set the following settings for grade item "Test locked category" of type "category" on "setup" page: | Locked | 1 | Scenario: Hidden grade items in locked category is hidden for teacher Given I am on the "Course 1" "grades > User report > View" page logged in as teacher1 And I click on "Student 1" in the "user" search widget When I set the field "View report as" to "Myself" Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | Test locked category total | 100.00 % | 50.00 | 0–100 | 50.00 % | - | | Course total | - | 50.00 | 0–100 | 50.00 % | - | Scenario: Hidden grade items in locked category is hidden for student When I am on the "Course 1" "grades > User report > View" page logged in as student1 Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | Test locked category total | 100.00 % | - | 0–100 | - | - | | Course total | - | - | 0–100 | - | - | And I should not see "Hidden item" Scenario: Hidden grade items in overridden category should show Given I am on the "Course 1" "grades > gradebook setup" page And I choose the "Add category" item in the "Add" action menu And I set the following fields to these values: | Category name | Test overridden category B| And I click on "Save" "button" in the "New category" "dialogue" And I wait until the page is ready And I choose the "Add grade item" item in the "Add" action menu And I set the following fields to these values: | Item name | Cat b item | | Grade category | Test overridden category B | And I click on "Save" "button" in the "New grade item" "dialogue" When I navigate to "View > Grader report" in the course gradebook And I turn editing mode on And I give the grade "50.00" to the user "Student 1" for the grade item "Test overridden category B total" And I press "Save changes" And I am on the "Course 1" "grades > User report > View" page logged in as "student1" Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | Test locked category total | 50.00 % | - | 0–100 | - | - | | Test overridden category B total | 50.00 % | 50.00 | 0–100 | 50.00 % | - | | Course total | - | - | 0–200 | - | - | tests/behat/grade_category_validation.feature 0000604 00000016241 15062070557 0015546 0 ustar 00 @core_grades @javascript Feature: Editing a grade item In order to ensure validation is provided to the teacher As a teacher I need to know why I can not add/edit values on the grade category form Background: Given the following "users" exist: | username | firstname | lastname | email | | student1 | Student | 1 | student1@example.com | | teacher1 | Teacher | 1 | teacher1@example.com | And the following "courses" exist: | fullname | shortname | category | groupmode | | Course 1 | C1 | 0 | 1 | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | And the following "scales" exist: | name | scale | | ABCDEF | F,E,D,C,B,A | | Letter scale | Disappointing, Good, Very good, Excellent | And the following "grade categories" exist: | fullname | course | aggregation | | Cat 1 | C1 | 6 | And the following "grade items" exist: | itemname | course | category | | Item 1 | C1 | Cat 1 | | Item 2 | C1 | Cat 1 | And I am on the "Course 1" "grades > gradebook setup" page logged in as "admin" Scenario: Being able to change the grade type, scale and maximum grade for a grade category when there are no overridden grades Given I click on grade item menu "Cat 1" of type "category" on "setup" page And I choose "Edit category" in the open action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" Then I should not see "This category has associated grade items which have been overridden. Therefore some grades have already been awarded" And I expand all fieldsets And I set the field "Grade type" to "Scale" And I press "Save changes" And I should see "Scale must be selected" And I set the field "Scale" to "ABCDEF" And I press "Save changes" And I should not see "You cannot change the type, as grades already exist for this item" And I click on grade item menu "Cat 1" of type "category" on "setup" page And I choose "Edit category" in the open action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" And I should not see "This category has associated grade items which have been overridden. Therefore some grades have already been awarded" And I expand all fieldsets And I set the field "Scale" to "Letter scale" And I press "Save changes" And I should not see "You cannot change the scale, as grades already exist for this item" Scenario: Attempting to change a category item's grade type when overridden grades already exist Given I navigate to "View > Grader report" in the course gradebook And I turn editing mode on And I give the grade "20.00" to the user "Student 1" for the grade item "Cat 1 total" And I press "Save changes" And I navigate to "Setup > Gradebook setup" in the course gradebook And I click on grade item menu "Cat 1" of type "category" on "setup" page And I choose "Edit category" in the open action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" And I expand all fieldsets Then I should see "This category has associated grade items which have been overridden. Therefore some grades have already been awarded, so the grade type cannot be changed. If you wish to change the maximum grade, you must first choose whether or not to rescale existing grades." And "//div[contains(concat(' ', normalize-space(@class), ' '), 'felement') and contains(text(), 'Value')]" "xpath_element" should exist Scenario: Attempting to change a category item's scale when overridden grades already exist Given I click on grade item menu "Cat 1" of type "category" on "setup" page And I choose "Edit category" in the open action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" And I expand all fieldsets And I set the field "Grade type" to "Scale" And I set the field "Scale" to "ABCDEF" And I press "Save changes" And I navigate to "View > Grader report" in the course gradebook And I turn editing mode on And I give the grade "C" to the user "Student 1" for the grade item "Cat 1 total" And I press "Save changes" And I navigate to "Setup > Gradebook setup" in the course gradebook And I click on grade item menu "Cat 1" of type "category" on "setup" page And I choose "Edit category" in the open action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" And I expand all fieldsets Then I should see "This category has associated grade items which have been overridden. Therefore some grades have already been awarded, so the grade type and scale cannot be changed." And "//div[contains(concat(' ', normalize-space(@class), ' '), 'felement') and contains(text(), 'ABCDEF')]" "xpath_element" should exist Scenario: Attempting to change a category item's maximum grade when no rescaling option has been chosen Given I navigate to "View > Grader report" in the course gradebook And I turn editing mode on And I give the grade "20.00" to the user "Student 1" for the grade item "Cat 1 total" And I press "Save changes" And I navigate to "Setup > Gradebook setup" in the course gradebook And I click on grade item menu "Cat 1" of type "category" on "setup" page And I choose "Edit category" in the open action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" And I expand all fieldsets Then I should see "This category has associated grade items which have been overridden. Therefore some grades have already been awarded, so the grade type cannot be changed. If you wish to change the maximum grade, you must first choose whether or not to rescale existing grades." And I should see "Choose" in the "Rescale overridden grades" "field" And the "Maximum grade" "field" should be disabled Scenario: Perform changes to a grade category with custom decimal separator Given the following "language customisations" exist: | component | stringid | value | | core_langconfig | decsep | # | And I navigate to "View > Grader report" in the course gradebook And I turn editing mode on And I give the grade "20#00" to the user "Student 1" for the grade item "Cat 1 total" And I press "Save changes" And I navigate to "Setup > Gradebook setup" in the course gradebook And I click on grade item menu "Cat 1" of type "category" on "setup" page And I choose "Edit category" in the open action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" And I expand all fieldsets And I set the field "Rescale overridden grades" to "Yes" And I set the field "Maximum grade" to "87#50" When I press "Save changes" And I navigate to "View > Grader report" in the course gradebook And I click on user menu "Student 1" And I choose "Single view for this user" in the open action menu Then I should see "Student 1" And the field "Grade for Category total" matches value "17#50" tests/behat/grade_calculated_grade_items_20150627.feature 0000604 00000026432 15062070557 0017154 0 ustar 00 @core @core_grades Feature: Gradebook calculations for calculated grade items before the fix 20150627 In order to make sure the grades are not changed after upgrade As a teacher I need to be able to freeze gradebook calculations Background: Given the following "courses" exist: | fullname | shortname | category | groupmode | | Course 1 | C1 | 0 | 1 | And gradebook calculations for the course "C1" are frozen at version "20150627" And the following "users" exist: | username | firstname | lastname | email | idnumber | | teacher1 | Teacher | 1 | teacher1@example.com | t1 | | student1 | Student | 1 | student1@example.com | s1 | | student2 | Student | 2 | student2@example.com | s2 | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | | student2 | C1 | student | And I am on the "Course 1" "grades > gradebook setup" page logged in as "admin" @javascript Scenario: The max grade for a category item, with a calculation using Natural aggregation, can be changed Given I choose the "Add category" item in the "Add" action menu And I set the following fields to these values: | Category name | Calc cat | And I click on "Save" "button" in the "New category" "dialogue" And I wait until the page is ready And I choose the "Add grade item" item in the "Add" action menu And I set the following fields to these values: | Item name | grade item 1 | | Grade category | Calc cat | And I click on "Save" "button" in the "New grade item" "dialogue" And I set "=[[gi1]]/2" calculation for grade category "Calc cat" with idnumbers: | grade item 1 | gi1 | And I set the following settings for grade item "Calc cat" of type "category" on "setup" page: | Maximum grade | 50 | And I navigate to "View > Grader report" in the course gradebook And I turn editing mode on And I give the grade "75.00" to the user "Student 1" for the grade item "grade item 1" And I press "Save changes" And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget And the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | grade item 1 | - | 75.00 | 0–100 | 75.00 % | - | | Calc cat total | 100.00 % | 37.50 | 0–100 | 37.50 % | - | | Course total | - | 37.50 | 0–100 | 37.50 % | - | @javascript Scenario: Changing max grade for a category item with a calculation that has existing grades will display the same points with the new max grade values immediately. Given I choose the "Add category" item in the "Add" action menu And I set the following fields to these values: | Category name | Calc cat | And I click on "Save" "button" in the "New category" "dialogue" And I wait until the page is ready And I choose the "Add grade item" item in the "Add" action menu And I set the following fields to these values: | Item name | grade item 1 | | Grade category | Calc cat | And I click on "Save" "button" in the "New grade item" "dialogue" And I set "=[[gi1]]/2" calculation for grade category "Calc cat" with idnumbers: | grade item 1 | gi1 | And I set the following settings for grade item "Calc cat" of type "category" on "setup" page: | Maximum grade | 50 | And I navigate to "View > Grader report" in the course gradebook And I turn editing mode on And I give the grade "75.00" to the user "Student 1" for the grade item "grade item 1" And I press "Save changes" And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget And the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | grade item 1 | - | 75.00 | 0–100 | 75.00 % | - | | Calc cat total | 100.00 % | 37.50 | 0–100 | 37.50 % | - | | Course total | - | 37.50 | 0–100 | 37.50 % | - | And I navigate to "Setup > Gradebook setup" in the course gradebook And I set the following settings for grade item "Calc cat" of type "category" on "setup" page: | Maximum grade | 40 | And I navigate to "View > Grader report" in the course gradebook And I give the grade "65.00" to the user "Student 2" for the grade item "grade item 1" And I press "Save changes" And I navigate to "View > User report" in the course gradebook When I click on "Student 1" in the "user" search widget Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | grade item 1 | - | 75.00 | 0–100 | 75.00 % | - | | Calc cat total | 100.00 % | 37.50 | 0–100 | 37.50 % | - | | Course total | - | 37.50 | 0–100 | 37.50 % | - | And I click on "Student 2" in the "user" search widget And the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | grade item 1 | - | 65.00 | 0–100 | 65.00 % | - | | Calc cat total | 100.00 % | 32.50 | 0–100 | 32.50 % | - | | Course total | - | 32.50 | 0–100 | 32.50 % | - | And I navigate to "Setup > Course grade settings" in the course gradebook And I set the following fields to these values: | Min and max grades used in calculation | Initial min and max grades | And I press "Save changes" And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget And the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | grade item 1 | - | 75.00 | 0–100 | 75.00 % | - | | Calc cat total | 100.00 % | 37.50 | 0–100 | 37.50 % | - | | Course total | - | 37.50 | 0–100 | 37.50 % | - | And I click on "Student 2" in the "user" search widget And the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | grade item 1 | - | 65.00 | 0–100 | 65.00 % | - | | Calc cat total | 100.00 % | 32.50 | 0–100 | 32.50 % | - | | Course total | - | 32.50 | 0–100 | 32.50 % | - | @javascript Scenario: Values in calculated grade items are not always out of one hundred Given I choose the "Add grade item" item in the "Add" action menu And I set the following fields to these values: | Item name | grade item 1 | And I click on "Save" "button" in the "New grade item" "dialogue" And I choose the "Add grade item" item in the "Add" action menu And I set the following fields to these values: | Item name | calc item | And I click on "Save" "button" in the "New grade item" "dialogue" And I set "=[[gi1]]/2" calculation for grade item "calc item" with idnumbers: | grade item 1 | gi1 | And I set the following settings for grade item "calc item" of type "gradeitem" on "setup" page: | Maximum grade | 50 | And I navigate to "Setup > Course grade settings" in the course gradebook And I set the following fields to these values: | Min and max grades used in calculation | Initial min and max grades | And I press "Save changes" And I navigate to "View > Grader report" in the course gradebook And I turn editing mode on And I give the grade "75.00" to the user "Student 1" for the grade item "grade item 1" And I press "Save changes" And I navigate to "View > User report" in the course gradebook When I click on "Student 1" in the "user" search widget Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | grade item 1 | 50.00 % | 75.00 | 0–100 | 75.00 % | 37.50 % | | calc item | 50.00 % | 37.50 | 0–100 | 37.50 % | 18.75 % | | Course total | - | 112.50 | 0–200 | 56.25 % | - | And I navigate to "Setup > Gradebook setup" in the course gradebook And I set the following settings for grade item "calc item" of type "gradeitem" on "setup" page: | Rescale existing grades | No | | Maximum grade | 40 | And I navigate to "View > Grader report" in the course gradebook And I give the grade "65.00" to the user "Student 2" for the grade item "grade item 1" And I press "Save changes" And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget And the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | grade item 1 | 50.00 % | 75.00 | 0–100 | 75.00 % | 37.50 % | | calc item | 50.00 % | 37.50 | 0–100 | 37.50 % | 18.75 % | | Course total | - | 112.50 | 0–200 | 56.25 % | - | And I click on "Student 2" in the "user" search widget And the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | grade item 1 | 50.00 % | 65.00 | 0–100 | 65.00 % | 32.50 % | | calc item | 50.00 % | 32.50 | 0–100 | 32.50 % | 16.25 % | | Course total | - | 97.50 | 0–200 | 48.75 % | - | tests/behat/siteadmin_grades_scale_breadcrumbs.feature 0000604 00000001770 15062070557 0017400 0 ustar 00 @core_grades @javascript Feature: Verify the breadcrumbs in grade scales site administration pages Whenever I navigate to grade scales page in site administration As an admin The breadcrumbs should be visible Background: Given I log in as "admin" @core_grades Scenario: Verify the breadcrumbs in scales page as an admin Given I navigate to "Grades > Scales" in site administration And I click on "Add a new scale" "button" And "Add a scale" "text" should exist in the ".breadcrumb" "css_element" And "Scales" "link" should exist in the ".breadcrumb" "css_element" And I press "Cancel" When I click on "Edit" "link" Then "Edit scale" "text" should exist in the ".breadcrumb" "css_element" And "Scales" "link" should exist in the ".breadcrumb" "css_element" And I press "Cancel" And I click on "Delete" "link" And "Delete scale" "text" should exist in the ".breadcrumb" "css_element" And "Scales" "link" should exist in the ".breadcrumb" "css_element" tests/behat/grade_natural_normalisation_20150619.feature 0000604 00000017250 15062070557 0017114 0 ustar 00 @core @core_grades Feature: Gradebook calculations for natural weights normalisation before the fix 20150619 In order to make sure the grades are not changed after upgrade As a teacher I need to be able to freeze gradebook calculations Background: Given the following "courses" exist: | fullname | shortname | category | groupmode | | Course 1 | C1 | 0 | 1 | And gradebook calculations for the course "C1" are frozen at version "20150619" And the following "users" exist: | username | firstname | lastname | email | idnumber | | teacher1 | Teacher | 1 | teacher1@example.com | t1 | | student1 | Student | 1 | student1@example.com | s1 | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | And the following "grade categories" exist: | fullname | course | | Sub category 1 | C1 | And the following "activities" exist: | activity | course | idnumber | name | intro | grade | | assign | C1 | a1 | Test assignment one | Submit something! | 300 | | assign | C1 | a2 | Test assignment two | Submit something! | 100 | | assign | C1 | a3 | Test assignment three | Submit something! | 150 | | assign | C1 | a4 | Test assignment four | Submit nothing! | 150 | And the following "activities" exist: | activity | course | idnumber | name | intro | gradecategory | grade | | assign | C1 | a5 | Test assignment five | Submit something! | Sub category 1 | 20 | | assign | C1 | a6 | Test assignment six | Submit something! | Sub category 1 | 10 | | assign | C1 | a7 | Test assignment seven | Submit nothing! | Sub category 1 | 15 | And I am on the "Course 1" "grades > gradebook setup" page logged in as "teacher1" @javascript Scenario: Grade items weights are normalised when all grade item weights are overridden (sum exactly 100). Extra credit is set to zero (before the fix 20150619). When I set the following settings for grade item "Test assignment seven" of type "gradeitem" on "setup" page: | Extra credit | 1 | And the field "Weight of Test assignment five" matches value "66.667" And the field "Weight of Test assignment six" matches value "33.333" And the field "Weight of Test assignment seven" matches value "50.0" And I set the field "Override weight of Test assignment five" to "1" And I set the field "Override weight of Test assignment six" to "1" And I set the field "Weight of Test assignment five" to "60" And I set the field "Weight of Test assignment six" to "40" And I press "Save changes" Then I should see "Your weights have been adjusted to total 100." And the field "Weight of Test assignment five" matches value "60.000" And the field "Weight of Test assignment six" matches value "40.000" And the field "Weight of Test assignment seven" matches value "0.0" # The weight of "seven" should be 15/30=50% (15 is the maxgrade for "seven" and 30 are max grades for this category (max grade of "five" plus max grade of "six") And I reset weights for grade category "Sub category 1" And the field "Weight of Test assignment five" matches value "66.667" And the field "Weight of Test assignment six" matches value "33.333" And the field "Weight of Test assignment seven" matches value "50.0" @javascript Scenario: Setting grade items weights is prevented when all grade item weights are overridden (sum over 100). Extra credit is set to zero (before the fix 20150619). When I set the following settings for grade item "Test assignment seven" of type "gradeitem" on "setup" page: | Extra credit | 1 | And I set the field "Override weight of Test assignment five" to "1" And I set the field "Override weight of Test assignment six" to "1" And I set the field "Weight of Test assignment five" to "60" And I set the field "Weight of Test assignment six" to "50" Then I should see "Weight total exceeds 100%." in the "Test assignment five" "table_row" And I should see "Weight total exceeds 100%." in the "Test assignment six" "table_row" And the field "Weight of Test assignment five" matches value "60.0" And the field "Weight of Test assignment six" matches value "50.0" And the field "Weight of Test assignment seven" matches value "0.0" And I start watching to see if a new page loads And I press "Save changes" And a new page should not have loaded since I started watching And I reset weights for grade category "Sub category 1" And the field "Weight of Test assignment five" matches value "66.667" And the field "Weight of Test assignment six" matches value "33.333" # The weight of "seven" should be 15/30=50% (15 is the maxgrade for "seven" and 30 are max grades for this category (max grade of "five" plus max grade of "six") And the field "Weight of Test assignment seven" matches value "50.0" @javascript Scenario: Setting grade items weights is prevented when all grade item weights are overridden (sum under 100). Extra credit is set to zero (before the fix 20150619). When I set the following settings for grade item "Test assignment seven" of type "gradeitem" on "setup" page: | Extra credit | 1 | And I set the field "Override weight of Test assignment five" to "1" And I set the field "Override weight of Test assignment six" to "1" And I set the field "Weight of Test assignment five" to "40" And I set the field "Weight of Test assignment six" to "30" Then I should see "Weight total is less than 100%." in the "Test assignment five" "table_row" And I should see "Weight total is less than 100%." in the "Test assignment six" "table_row" And the field "Weight of Test assignment five" matches value "40.0" And the field "Weight of Test assignment six" matches value "30.0" And the field "Weight of Test assignment seven" matches value "0.0" And I start watching to see if a new page loads And I press "Save changes" And a new page should not have loaded since I started watching And I reset weights for grade category "Sub category 1" And the field "Weight of Test assignment five" matches value "66.667" And the field "Weight of Test assignment six" matches value "33.333" # The weight of "seven" should be 15/30=50% (15 is the maxgrade for "seven" and 30 are max grades for this category (max grade of "five" plus max grade of "six") And the field "Weight of Test assignment seven" matches value "50.0" @javascript Scenario: Grade items weights are normalised when not all grade item weights are overridden. Extra credit is set respectful to non-overridden items (before the fix 20150619). When I set the following settings for grade item "Test assignment seven" of type "gradeitem" on "setup" page: | Extra credit | 1 | And I set the field "Override weight of Test assignment five" to "1" And I set the field "Weight of Test assignment five" to "40" And I press "Save changes" Then I should see "Your weights have been adjusted to total 100." And the field "Weight of Test assignment five" matches value "40.00" And the field "Weight of Test assignment six" matches value "60.000" And the field "Weight of Test assignment seven" matches value "90.0" # The weight of "seven" should be 15/30=50% (15 is the maxgrade for "seven" and 30 are max grades for this category (max grade of "five" plus max grade of "six") And I reset weights for grade category "Sub category 1" And the field "Weight of Test assignment five" matches value "66.667" And the field "Weight of Test assignment six" matches value "33.333" And the field "Weight of Test assignment seven" matches value "50.0" tests/behat/grade_grade_minmax_change.feature 0000604 00000007440 15062070557 0015460 0 ustar 00 @core @core_grades @javascript Feature: We can change the maximum and minimum number of points for manual items with existing grades In order to verify existing grades are modified as expected As an teacher I need to modify a grade item with exiting grades I need to ensure existing grades are modified in an expected manner Background: Given the following "courses" exist: | fullname | shortname | category | groupmode | | Course 1 | C1 | 0 | 1 | And the following "users" exist: | username | firstname | lastname | email | idnumber | | teacher1 | Teacher | 1 | teacher1@example.com | t1 | | student1 | Student | 1 | student1@example.com | s1 | | student2 | Student | 2 | student2@example.com | s2 | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | | student2 | C1 | student | And I am on the "Course 1" "grades > gradebook setup" page logged in as "teacher1" And I choose the "Add grade item" item in the "Add" action menu And I set the following fields to these values: | Item name | Manual item 1 | | Minimum grade | 0 | | Maximum grade | 100 | And I click on "Save" "button" in the "New grade item" "dialogue" And I navigate to "Setup > Course grade settings" in the course gradebook And I set the field "Show weightings" to "Show" And I set the field "Show contribution to course total" to "Show" And I press "Save changes" Scenario: Change maximum number of points on a graded item. Given I am on the "Course 1" "grades > Grader report > View" page And I turn editing mode on And I give the grade "10.00" to the user "Student 1" for the grade item "Manual item 1" And I give the grade "8.00" to the user "Student 2" for the grade item "Manual item 1" And I press "Save changes" When I navigate to "Setup > Gradebook setup" in the course gradebook And I set the following settings for grade item "Manual item 1" of type "gradeitem" on "setup" page: | Rescale existing grades | No | | Maximum grade | 10 | And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Contribution to course total | | Manual item 1 | 100.00 % | 10.00 | 100.00 % | And I click on "Student 2" in the "user" search widget And the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Contribution to course total | | Manual item 1 | 100.00 % | 8.00 | 80.00 % | And I navigate to "Setup > Gradebook setup" in the course gradebook And I click on grade item menu "Manual item 1" of type "gradeitem" on "setup" page And I choose "Edit grade item" in the open action menu And I set the following fields to these values: | Rescale existing grades | Yes | | Maximum grade | 20 | And I click on "Save" "button" in the "Edit grade item" "dialogue" And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget And the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Contribution to course total | | Manual item 1 | 100.00 % | 20.00 | 100.00 % | And I click on "Student 2" in the "user" search widget And the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Contribution to course total | | Manual item 1 | 100.00 % | 16.00 | 80.00 % | tests/behat/grade_letter_boundary_20160518.feature 0000604 00000004121 15062070557 0015701 0 ustar 00 @core @core_grades Feature: We can customise the letter boundary of a course in gradebook version 20160518. In order to change the letter boundary of a course As a teacher I need to add assessments to the gradebook. @javascript Scenario: I edit the letter boundaries of a course and grade a student. Given the following "courses" exist: | fullname | shortname | category | | Course 1 | C1 | 0 | And gradebook calculations for the course "C1" are frozen at version "20160518" And the following "users" exist: | username | firstname | lastname | email | idnumber | alternatename | | teacher1 | Teacher | 1 | teacher1@example.com | t1 | Terry | | student1 | Student | 1 | student1@example.com | s1 | Sally | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | And the following "activities" exist: | activity | course | idnumber | name | intro | grade | | assign | C1 | a1 | Test assignment one | Submit something! | 100 | And I am on the "Course 1" "grades > course grade settings" page logged in as "teacher1" And I set the following fields to these values: | Grade display type | Letter | And I press "Save changes" And I navigate to "More > Grade letters" in the course gradebook And I click on "Edit" "button" And I set the following fields to these values: | Override site defaults | 1 | | Letter grade boundary 10 | 57 | And I press "Save changes" And I navigate to "View > Grader report" in the course gradebook And I turn editing mode on And I give the grade "57" to the user "Student 1" for the grade item "Test assignment one" And I press "Save changes" And I am on "Course 1" course homepage with editing mode off And I navigate to "View > Grader report" in the course gradebook Then the following should exist in the "user-grades" table: | -1- | -1- | -3- | -4- | | Student 1 | student1@example.com | F | F | tests/behat/grade_average.feature 0000604 00000004454 15062070557 0013134 0 ustar 00 @core @core_grades @javascript Feature: Average grades are displayed in the gradebook In order to check the expected results are displayed As an admin I need to assign grades and check that they display correctly in the gradebook. Background: Given the following "courses" exist: | fullname | shortname | format | | Course 1 | C1 | topics | And the following "users" exist: | username | firstname | lastname | email | | teacher1 | Teacher | 1 | teacher1@example.com | | student1 | Student | 1 | student1@example.com | | student2 | Student | 2 | student2@example.com | | student3 | Student | 3 | student3@example.com | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | | student2 | C1 | student | | student3 | C1 | student | And the following "grade item" exists: | course | C1 | | itemname | Manual item 1 | And the following "grade grades" exist: | gradeitem | user | grade | | Manual item 1 | student1 | 50.00 | | Manual item 1 | student2 | 50.00 | | Manual item 1 | student3 | 50.00 | And the following "course enrolments" exist: | user | course | role | status | | student2 | C1 | student | suspended | # Enable averages And I am on the "Course 1" "grades > course grade settings" page logged in as "admin" And I set the following fields to these values: | Show average | Show | And I press "Save changes" Scenario: Grade a grade item and ensure the results display correctly in the gradebook # Check the admin grade table Given I am on the "Course 1" "grades > Grader report > View" page logged in as "admin" Then I should see "50.00" in the ".avg.r0.lastrow .c1" "css_element" Then I should see "50.00" in the ".avg.r0.lastrow .c2" "css_element" # Check the user grade table When I am on the "Course 1" "grades > user > View" page logged in as "student1" Then I should see "50.00" in the ".level2.column-grade" "css_element" Then I should see "50.00" in the ".level2.column-average" "css_element" tests/behat/grade_view.feature 0000604 00000012163 15062070557 0012470 0 ustar 00 @core @core_grades @javascript Feature: We can enter in grades and view reports from the gradebook In order to check the expected results are displayed As a teacher I need to assign grades and check that they display correctly in the gradebook. I need to enable grade weightings and check that they are displayed correctly. Background: Given the following "courses" exist: | fullname | shortname | format | | Course 1 | C1 | topics | And the following "users" exist: | username | firstname | lastname | email | | teacher1 | Teacher | 1 | teacher1@example.com | | student1 | Student | 1 | student1@example.com | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | And the following "activities" exist: | activity | name | course | idnumber | assignsubmission_onlinetext_enabled | | assign | Test assignment name 1 | C1 | assign1 | 1 | | assign | Test assignment name 2 | C1 | assign2 | 1 | And I log in as "admin" And I set the following administration settings values: | grade_aggregations_visible | Mean of grades,Weighted mean of grades,Simple weighted mean of grades,Mean of grades (with extra credits),Median of grades,Lowest grade,Highest grade,Mode of grades,Natural | And I am on the "Test assignment name 1" "assign activity" page logged in as student1 When I press "Add submission" And I set the following fields to these values: | Online text | This is a submission for assignment 1 | And I press "Save changes" And I press "Submit assignment" And I press "Continue" Then I should see "Submitted for grading" And I am on the "Test assignment name 2" "assign activity" page When I press "Add submission" And I set the following fields to these values: | Online text | This is a submission for assignment 2 | And I press "Save changes" And I press "Submit assignment" And I press "Continue" Then I should see "Submitted for grading" And I am on the "Course 1" "grades > Grader report > View" page logged in as "teacher1" And I turn editing mode on And I give the grade "80.00" to the user "Student 1" for the grade item "Test assignment name 1" And I give the grade "90.00" to the user "Student 1" for the grade item "Test assignment name 2" And I press "Save changes" Scenario: Grade a grade item and ensure the results display correctly in the gradebook When I navigate to "View > User report" in the course gradebook And the "Gradebook navigation menu" select menu should contain "Grader report" And I set the field "Search users" to "Student" And "View all results (1)" "list_item" should exist And I click on "View all results (1)" "option_role" And I log out And I log in as "student1" And I follow "Grades" in the user menu And I click on "Course 1" "link" in the "region-main" "region" Then the following should exist in the "user-grade" table: | Grade item | Grade | Range | Percentage | | Test assignment name 1 | 80.00 | 0–100 | 80.00 % | | Test assignment name 2 | 90.00 | 0–100 | 90.00 % | | Course total | 170.00 | 0–200 | 85.00 % | And the following should not exist in the "user-grade" table: | Grade item | Grade | Range | Percentage | | Course total | 90.00 | 0–100 | 90.00 % | And I follow "Grades" in the user menu And "Course 1" row "Grade" column of "overview-grade" table should contain "170.00" And "Course 1" row "Grade" column of "overview-grade" table should not contain "90.00" Scenario: We can add a weighting to a grade item and it is displayed properly in the user report When I navigate to "Setup > Gradebook setup" in the course gradebook And I set the following settings for grade item "Course 1" of type "course" on "setup" page: | Aggregation | Weighted mean of grades | And I set the field "Extra credit value for Test assignment name" to "0.72" And I press "Save changes" And I navigate to "Setup > Course grade settings" in the course gradebook And I set the following fields to these values: | Show weightings | Show | And I press "Save changes" And I log out And I log in as "student1" And I follow "Grades" in the user menu And I click on "Course 1" "link" in the "region-main" "region" Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | | Test assignment name 1 | 41.86 % | 80.00 | 0–100 | 80.00 % | | Test assignment name 2 | 58.14 % | 90.00 | 0–100 | 90.00 % | | Course total | - | 85.81 | 0–100 | 85.81 % | And the following should not exist in the "user-grade" table: | Grade item | Calculated weight | Percentage | | Test assignment name 1 | 0.72% | 0.72% | | Test assignment name 2 | 1.00% | 1.00% | | Course total | 1.00% | 1.00% | tests/behat/behat_grades.php 0000604 00000024730 15062070557 0012123 0 ustar 00 <?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/>. // NOTE: no MOODLE_INTERNAL test here, this file may be required by behat before including /config.php. require_once(__DIR__ . '/../../../lib/behat/behat_base.php'); /** * Behat grade related steps definitions. * * @package core_grades * @copyright 2022 Mathew May <mathew.solutions> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class behat_grades extends behat_base { /** * Return the list of partial named selectors. * * @return array */ public static function get_partial_named_selectors(): array { return [ new behat_component_named_selector( 'initials bar', [".//*[contains(concat(' ', @class, ' '), ' initialbar ')]//span[contains(., %locator%)]/parent::div"] ), new behat_component_named_selector( 'grade_actions', ["//td[count(//table[@id='user-grades']//th[contains(., %locator%)]/preceding-sibling::th)]//*[@data-type='grade']"] ), new behat_component_named_selector( 'gradeitem modal', [".//*[contains(concat(' ', @class, ' '), ' modal ')]"] ), ]; } /** * Convert page names to URLs for steps like 'When I am on the "[identifier]" "[page type]" page'. * * Recognised page names are: * | pagetype | name meaning | description | * | [report] view | Course name | The view page for the specified course and report | * | gradebook setup | Course name | The gradebook setup page for the specified course | * | course grade settings | Course name | The grade settings page | * | outcomes | Course name | The grade outcomes page | * | scales | Course name | The grade scales page | * * @param string $type identifies which type of page this is - for example "Grader > View" * @param string $identifier identifies the particular page - for example "Course name" * @return moodle_url the corresponding URL. */ protected function resolve_page_instance_url(string $type, string $identifier): moodle_url { $type = strtolower($type); if (strpos($type, '>') !== false) { [$pluginname, $type] = explode('>', $type); $pluginname = strtolower(trim($pluginname)); // Fetch the list of plugins. $plugins = \core_component::get_plugin_list('gradereport'); if (array_key_exists($pluginname, $plugins)) { $plugin = $pluginname; } else { $plugins = array_combine( array_keys($plugins), array_keys($plugins), ); // This plugin is not in the list of plugins. Check the pluginname string. $names = array_map(fn($name) => strtolower(get_string('pluginname', "gradereport_{$name}")), $plugins); $result = array_search($pluginname, $names); if ($result === false) { throw new \coding_exception("Unknown plugin '{$pluginname}'"); } $plugin = $result; } } $type = trim($type); switch ($type) { case 'view': return new moodle_url( "/grade/report/{$plugin}/index.php", ['id' => $this->get_course_id($identifier)] ); case 'gradebook setup': return new moodle_url( "/grade/edit/tree/index.php", ['id' => $this->get_course_id($identifier)] ); case 'course grade settings': return new moodle_url( "/grade/edit/settings/index.php", ['id' => $this->get_course_id($identifier)] ); case 'outcomes': return new moodle_url( "/grade/edit/outcome/course.php", ['id' => $this->get_course_id($identifier)] ); case 'scales': return new moodle_url( "/grade/edit/scale/index.php", ['id' => $this->get_course_id($identifier)] ); default: throw new \coding_exception( "Unknown page type '$type' for page identifier '$identifier'" ); } } /** * Select a given element within a specific container instance. * * @Given /^I select "(?P<input_value>(?:[^"]|\\")*)" in the "(?P<instance>(?:[^"]|\\")*)" "(?P<instance_type>(?:[^"]|\\")*)"$/ * @param string $value The Needle * @param string $element The Haystack to select within * @param string $selectortype What type of haystack we are looking in */ public function i_select_in_the($value, $element, $selectortype) { // Getting the container where the text should be found. $container = $this->get_selected_node($selectortype, $element); if ($this->getSession()->getPage()->find('xpath', './/input[@value="' . $value . '"]')) { $node = $this->find('xpath', './/input[@value="' . $value . '"]', false, $container); $node->click(); } else { $node = $this->find('xpath', './/button[@data-action="' . strtolower($value) . '"]', false, $container); $node->press(); } } /** * Gets the grade item id from its name. * * @throws Exception * @param string $itemname Item name * @return int */ protected function get_grade_item_id(string $itemname): int { global $DB; if ($id = $DB->get_field('grade_items', 'id', ['itemname' => $itemname])) { return $id; } // The course total is a special case. if ($itemname === "Course total") { if (!$id = $DB->get_field('grade_items', 'id', ['itemtype' => 'course'])) { throw new Exception('The specified grade_item with name "' . $itemname . '" does not exist'); } return $id; } // Find a category with the name. if ($catid = $DB->get_field('grade_categories', 'id', ['fullname' => $itemname])) { if ($id = $DB->get_field('grade_items', 'id', ['iteminstance' => $catid])) { return $id; } } throw new Exception('The specified grade_item with name "' . $itemname . '" does not exist'); } /** * Gets course grade category id from coursename. * * @throws Exception * @param string $coursename * @return int */ protected function get_course_grade_category_id(string $coursename): int { global $DB; $sql = "SELECT gc.id FROM {grade_categories} gc LEFT JOIN {course} c ON c.id = gc.courseid WHERE c.fullname = ? AND gc.depth = 1"; if ($id = $DB->get_field_sql($sql, [$coursename])) { return $id; } throw new Exception('The specified course grade category with course name "' . $coursename . '" does not exist'); } /** * Gets grade category id from its name. * * @throws Exception * @param string $categoryname * @return int */ protected function get_grade_category_id(string $categoryname): int { global $DB; $sql = "SELECT gc.id FROM {grade_categories} gc LEFT JOIN {course} c ON c.id = gc.courseid WHERE gc.fullname = ?"; if ($id = $DB->get_field_sql($sql, [$categoryname])) { return $id; } throw new Exception('The specified grade category with name "' . $categoryname . '" does not exist'); } /** * Clicks on given grade item menu. * * @Given /^I click on grade item menu "([^"]*)" of type "([^"]*)" on "([^"]*)" page$/ * @param string $itemname Item name * @param string $itemtype Item type - grade item, category or course * @param string $page Page - setup or grader * @throws Exception */ public function i_click_on_grade_item_menu(string $itemname, string $itemtype, string $page) { $this->execute("behat_navigation::i_close_block_drawer_if_open"); if ($itemtype == 'gradeitem') { $itemid = $this->get_grade_item_id($itemname); } else if ($itemtype == 'category') { $itemid = $this->get_grade_category_id($itemname); } else if ($itemtype == 'course') { $itemid = $this->get_course_grade_category_id($itemname); } else { throw new Exception('Unknown item type: ' . $itemtype); } $xpath = "//table[@id='grade_edit_tree_table']"; if (($page == 'grader') || ($page == 'setup')) { if ($page == 'grader') { $xpath = "//table[@id='user-grades']"; } if ($itemtype == 'gradeitem') { $xpath .= "//*[@data-type='item'][@data-id='" . $itemid . "']"; } else if (($itemtype == 'category') || ($itemtype == 'course')) { $xpath .= "//*[@data-type='category'][@data-id='" . $itemid . "']"; } else { throw new Exception('Unknown item type: ' . $itemtype); } } else { throw new Exception('Unknown page: ' . $page); } $node = $this->get_selected_node("xpath_element", $this->escape($xpath)); $this->execute_js_on_node($node, '{{ELEMENT}}.scrollIntoView({ block: "center", inline: "center" })'); $this->execute("behat_general::i_click_on", [$this->escape($xpath), "xpath_element"]); } } tests/behat/grade_scales_aggregation.feature 0000604 00000015031 15062070557 0015334 0 ustar 00 @core @core_grades @javascript Feature: Control the aggregation of the scales In order to use control the aggregation of the scales As an admin I can change use administration setting Background: Given the following "courses" exist: | fullname | shortname | | Course 1 | C1 | And the following "users" exist: | username | firstname | lastname | email | idnumber | | teacher1 | Teacher | 1 | teacher1@example.com | t1 | | student1 | Student | 1 | student1@example.com | s1 | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | And I log in as "admin" And I set the following administration settings values: | grade_aggregations_visible | Mean of grades,Weighted mean of grades,Simple weighted mean of grades,Mean of grades (with extra credits),Median of grades,Lowest grade,Highest grade,Mode of grades,Natural | | grade_report_user_showcontributiontocoursetotal | 1 | And I navigate to "Grades > Scales" in site administration And I press "Add a new scale" And I set the following fields to these values: | Name | Letterscale | | Scale | F,D,C,B,A | And I press "Save changes" And the following "grade items" exist: | itemname | course | | Grade me | C1 | And the following "grade items" exist: | itemname | course | scale | | Scale me | C1 | Letterscale | And the following config values are set as admin: | grade_includescalesinaggregation | 0 | Scenario Outline: Scales can be excluded from aggregation Given I am on the "Course 1" "grades > Grader report > View" page logged in as "teacher1" And I turn editing mode on When I give the grade "10" to the user "Student 1" for the grade item "Grade me" And I give the grade "B" to the user "Student 1" for the grade item "Scale me" And I press "Save changes" And I set the following settings for grade item "Course 1" of type "course" on "grader" page: | Aggregation | <aggregation> | And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget Then the following should exist in the "user-grade" table: | Grade item | Grade | Percentage | Contribution to course total | | Grade me | 10.00 | 10.00 % | <gradecontrib> | | Scale me | B | 75.00 % | <scalecontrib> | | Course total | <coursetotal> | <coursepc> | - | And I log out And I log in as "admin" And I set the following administration settings values: | grade_includescalesinaggregation | 1 | And I am on the "Course 1" "grades > User report > View" page logged in as "teacher1" And I click on "Student 1" in the "user" search widget And the following should exist in the "user-grade" table: | Grade item | Grade | Percentage | Contribution to course total | | Grade me | 10.00 | 10.00 % | <gradecontrib2> | | Scale me | B | 75.00 % | <scalecontrib2> | | Course total | <coursetotal2> | <coursepc2> | - | Examples: | aggregation | coursetotal | coursepc | gradecontrib | scalecontrib | coursetotal2 | coursepc2 | gradecontrib2 | scalecontrib2 | | Natural | 10.00 | 10.00 % | 10.00 | 0.00 | 14.00 | 13.33 % | 9.52 % | 3.81 % | | Mean of grades | 10.00 | 10.00 % | 10.00 | 0.00 | 42.50 | 42.50 % | 5.00 % | 37.50 % | | Weighted mean of grades | 10.00 | 10.00 % | 10.00 | 0.00 | 42.50 | 42.50 % | 5.00 % | 37.50 % | | Simple weighted mean of grades | 10.00 | 10.00 % | 10.00 | 0.00 | 12.50 | 12.50 % | 9.62 % | 2.88 % | | Mean of grades (with extra credits) | 10.00 | 10.00 % | 10.00 | 0.00 | 42.50 | 42.50 % | 5.00 % | 37.50 % | | Median of grades | 10.00 | 10.00 % | 10.00 | 0.00 | 42.50 | 42.50 % | 5.00 % | 37.50 % | | Lowest grade | 10.00 | 10.00 % | 10.00 | 0.00 | 10.00 | 10.00 % | 10.00 % | 0.00 % | | Highest grade | 10.00 | 10.00 % | 10.00 | 0.00 | 75.00 | 75.00 % | 0.00 % | 75.00 % | | Mode of grades | 10.00 | 10.00 % | 10.00 | 0.00 | 75.00 | 75.00 % | 0.00 % | 75.00 % | Scenario: Weights of scales cannot be edited when they are not aggregated Given I am on the "Course 1" "grades > Grader report > View" page logged in as "teacher1" And I turn editing mode on When I set the following settings for grade item "Course 1" of type "course" on "grader" page: | Aggregation | Natural | And I press "Save changes" And I navigate to "Setup > Gradebook setup" in the course gradebook And I set the field "Override weight of Grade me" to "1" Then the field "Override weight of Grade me" matches value "100.00" And I click on grade item menu "Scale me" of type "gradeitem" on "setup" page And I choose "Edit grade item" in the open action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" And I should not see "Weight adjusted" And I should not see "Weight" And the following config values are set as admin: | grade_includescalesinaggregation | 1 | And I am on "Course 1" course homepage And I navigate to "Setup > Gradebook setup" in the course gradebook And I set the field "Override weight of Grade me" to "1" And the field "Override weight of Grade me" matches value "95.238" And I set the field "Override weight of Scale me" to "1" And the field "Override weight of Scale me" matches value "4.8" And I click on grade item menu "Scale me" of type "gradeitem" on "setup" page And I choose "Edit grade item" in the open action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" And I should see "Weight adjusted" And I should see "Weight" tests/behat/grade_to_pass.feature 0000604 00000037770 15062070557 0013201 0 ustar 00 @core @core_grades @javascript Feature: We can set the grade to pass value In order to set the grade to pass value As a teacher I assign a grade to pass to an activity while editing the activity. I need to ensure that the grade to pass is visible in the gradebook. Background: Given the following "users" exist: | username | firstname | lastname | email | | teacher1 | Teacher | 1 | teacher1@example.com | And the following "courses" exist: | fullname | shortname | format | numsections | | Course 1 | C1 | weeks | 5 | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | And the following "scales" exist: | name | scale | | Test Scale 1 | Disappointing, Good, Very good, Excellent | And the following "activity" exists: | activity | assign | | course | C1 | | section | 1 | | idnumber | assign1 | | name | Test Assignment 1 | | intro | Submit your online text | | assignsubmission_onlinetext_enabled | 1 | And I am on the "Course 1" course page logged in as teacher1 Scenario: Validate that switching the type of grading used correctly disables grade to pass Given I turn editing mode on And I am on the "Test Assignment 1" "assign activity" page And I navigate to "Settings" in current page administration And I expand all fieldsets And I set the field "grade[modgrade_type]" to "Point" Then the "Grade to pass" "field" should be enabled And I set the field "grade[modgrade_type]" to "None" And the "Grade to pass" "field" should be disabled And I press "Save and return to course" Scenario: Create an activity with a Grade to pass value greater than the maximum grade When I turn editing mode on And I am on the "Test Assignment 1" "assign activity" page And I navigate to "Settings" in current page administration And I expand all fieldsets And I set the field "grade[modgrade_type]" to "Point" And I set the field "grade[modgrade_point]" to "50" And I set the field "Grade to pass" to "100" And I press "Save and return to course" Then I should see "The grade to pass can not be greater than the maximum possible grade 50" And I press "Cancel" Scenario: Set a valid grade to pass for an assignment activity using points When I turn editing mode on And I am on the "Test Assignment 1" "assign activity" page And I navigate to "Settings" in current page administration And I set the following fields to these values: | assignsubmission_onlinetext_enabled | 1 | | grade[modgrade_type] | Point | | grade[modgrade_point] | 50 | | Grade to pass | 25 | And I press "Save and return to course" And I navigate to "View > Grader report" in the course gradebook And I click on grade item menu "Test Assignment 1" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" Then the field "Grade to pass" matches value "25" And I am on "Course 1" course homepage And I am on the "Test Assignment 1" "assign activity" page And I navigate to "Settings" in current page administration And I expand all fieldsets And I set the field "Grade to pass" to "30" And I press "Save and return to course" And I navigate to "View > Grader report" in the course gradebook And I click on grade item menu "Test Assignment 1" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" And the field "Grade to pass" matches value "30" Scenario: Set a valid grade to pass for an assignment activity using scales When I turn editing mode on And I am on the "Test Assignment 1" "assign activity" page And I navigate to "Settings" in current page administration And I set the following fields to these values: | grade[modgrade_type] | Scale | | grade[modgrade_scale] | Test Scale 1 | | Grade to pass | 3 | And I press "Save and return to course" And I navigate to "View > Grader report" in the course gradebook And I click on grade item menu "Test Assignment 1" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" Then the field "Grade to pass" matches value "3" And I set the field "Grade to pass" to "4" And I press "Save changes" And I am on "Course 1" course homepage And I am on the "Test Assignment 1" "assign activity" page And I navigate to "Settings" in current page administration And the field "Grade to pass" matches value "4" Scenario: Set a invalid grade to pass for an assignment activity using scales When I turn editing mode on And I am on the "Test Assignment 1" "assign activity" page And I navigate to "Settings" in current page administration And I set the following fields to these values: | grade[modgrade_type] | Scale | | grade[modgrade_scale] | Test Scale 1 | | Grade to pass | 10 | And I press "Save and return to course" Then I should see "The grade to pass can not be greater than the maximum possible grade 4" Scenario: Set a valid grade to pass for workshop activity Given the following "activities" exist: | activity | name | course | idnumber | | workshop | Test Workshop 1 | C1 | workshop1 | And I am on "Course 1" course homepage with editing mode on And I am on the "Test Workshop 1" "workshop activity editing" page And I set the following fields to these values: | grade | 80 | | Submission grade to pass | 40 | | gradinggrade | 20 | | Assessment grade to pass | 10 | And I press "Save and return to course" And I navigate to "View > Grader report" in the course gradebook And I click on grade item menu "Test Workshop 1 (submission)" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" Then the field "Grade to pass" matches value "40" And I set the field "Grade to pass" to "45" And I press "Save changes" And I click on grade item menu "Test Workshop 1 (assessment)" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" And the field "Grade to pass" matches value "10" And I set the field "Grade to pass" to "15" And I press "Save changes" And I am on the "Test Workshop 1" "workshop activity editing" page And the field "Submission grade to pass" matches value "45" And the field "Assessment grade to pass" matches value "15" Scenario: Set an invalid grade to pass for workshop activity Given the following "activities" exist: | activity | name | course | idnumber | | workshop | Test Workshop 1 | C1 | workshop1 | And I am on "Course 1" course homepage with editing mode on And I am on the "Test Workshop 1" "workshop activity editing" page And I set the following fields to these values: | grade | 80 | | Submission grade to pass | 90 | | gradinggrade | 20 | | Assessment grade to pass | 30 | And I press "Save and return to course" Then "The grade to pass can not be greater than the maximum possible grade 80" "text" should exist in the "Submission grade to pass" "form_row" Then "The grade to pass can not be greater than the maximum possible grade 20" "text" should exist in the "Assessment grade to pass" "form_row" Scenario: Set a valid grade to pass for quiz activity Given the following "activities" exist: | activity | name | course | section | idnumber | | quiz | Test Quiz 1 | C1 | 1 | quiz1 | And I am on "Course 1" course homepage with editing mode on And I am on the "Test Quiz 1" "quiz activity" page And I navigate to "Settings" in current page administration And I set the following fields to these values: | Grade to pass | 9.5 | And I press "Save and return to course" And I navigate to "View > Grader report" in the course gradebook And I click on grade item menu "Test Quiz 1" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" Then the field "Grade to pass" matches value "9.5" And I set the field "Grade to pass" to "8" And I press "Save changes" And I am on "Course 1" course homepage And I am on the "Test Quiz 1" "quiz activity" page And I follow "Settings" And the field "Grade to pass" matches value "8.00" Scenario: Set a valid grade to pass for lesson activity Given the following "activities" exist: | activity | name | course | idnumber | | lesson | Test Lesson 1 | C1 | lesson1 | And I am on "Course 1" course homepage with editing mode on And I am on the "Test Lesson 1" "lesson activity editing" page And I set the following fields to these values: | Grade to pass | 90 | And I press "Save and return to course" And I navigate to "View > Grader report" in the course gradebook And I click on grade item menu "Test Lesson 1" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" Then the field "Grade to pass" matches value "90" And I set the field "Grade to pass" to "80" And I press "Save changes" And I am on the "Test Lesson 1" "lesson activity editing" page And the field "Grade to pass" matches value "80" Scenario: Set a valid grade to pass for lesson activity with custom decimal separator Given the following "activities" exist: | activity | name | course | idnumber | | lesson | Test Lesson 1 | C1 | lesson1 | And the following "language customisations" exist: | component | stringid | value | | core_langconfig | decsep | # | And I am on "Course 1" course homepage with editing mode on And I am on the "Test Lesson 1" "lesson activity editing" page And I set the following fields to these values: | Grade to pass | 90#50 | And I press "Save and return to course" And I navigate to "View > Grader report" in the course gradebook And I click on grade item menu "Test Lesson 1" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" Then the field "Grade to pass" matches value "90#50" And I set the field "Grade to pass" to "80" And I press "Save changes" And I am on the "Test Lesson 1" "lesson activity editing" page And the field "Grade to pass" matches value "80#00" Scenario: Set a valid grade to pass for database activity Given the following "activities" exist: | activity | name | intro | course | section | idnumber | | data | Test Database 1 | Test | C1 | 1 | data1 | And I am on "Course 1" course homepage with editing mode on And I am on the "Test Database 1" "data activity" page And I navigate to "Settings" in current page administration And I expand all fieldsets And I set the following fields to these values: | Ratings > Aggregate type | Average of ratings | | id_scale_modgrade_type | Point | | Ratings > Grade to pass | 90 | And I press "Save and return to course" And I navigate to "View > Grader report" in the course gradebook And I click on grade item menu "Test Database 1" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" Then the field "Grade to pass" matches value "90" And I set the field "Grade to pass" to "80" And I press "Save changes" And I am on "Course 1" course homepage And I am on the "Test Database 1" "data activity" page And I follow "Settings" And the field "Grade to pass" matches value "80" Scenario: Set an invalid grade to pass for forum activity Given the following "activities" exist: | activity | name | course | idnumber | | forum | Test Forum 1 | C1 | forum1 | And I am on the "Test Forum 1" "forum activity editing" page And I expand all fieldsets And I set the following fields to these values: | Ratings > Aggregate type | Average of ratings | | id_scale_modgrade_type | Point | | Ratings > Grade to pass | 90 | | Ratings > scale[modgrade_point] | 60 | And I press "Save and return to course" Then I should see "The grade to pass can not be greater than the maximum possible grade 60" Scenario: Set a valid grade to pass for forum activity Given the following "activities" exist: | activity | name | course | idnumber | | forum | Test Forum 1 | C1 | forum1 | And I am on "Course 1" course homepage with editing mode on And I am on the "Test Forum 1" "forum activity editing" page And I expand all fieldsets And I set the following fields to these values: | Ratings > Aggregate type | Average of ratings | | id_scale_modgrade_type | Point | | Ratings > Grade to pass | 90 | And I press "Save and return to course" And I navigate to "View > Grader report" in the course gradebook And I click on grade item menu "Test Forum 1 rating" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" Then the field "Grade to pass" matches value "90" And I set the field "Grade to pass" to "80" And I press "Save changes" And I am on the "Test Forum 1" "forum activity editing" page And the field "Ratings > Grade to pass" matches value "80" Scenario: Set a valid grade to pass for glossary activity Given the following "activities" exist: | activity | name | intro | course | section | idnumber | | glossary | Test Glossary 1 | Test | C1 | 1 | glossary1 | And I am on "Course 1" course homepage with editing mode on And I am on the "Test Glossary 1" "glossary activity" page And I navigate to "Settings" in current page administration And I set the following fields to these values: | Ratings > Aggregate type | Average of ratings | | id_scale_modgrade_type | Point | | Ratings > Grade to pass | 90 | And I press "Save and return to course" And I navigate to "View > Grader report" in the course gradebook And I click on grade item menu "Test Glossary 1" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" Then the field "Grade to pass" matches value "90" And I set the field "Grade to pass" to "80" And I press "Save changes" And I am on "Course 1" course homepage And I am on the "Test Glossary 1" "glossary activity" page And I follow "Settings" And the field "Grade to pass" matches value "80" tests/behat/behat_grade.php 0000604 00000055466 15062070557 0011752 0 ustar 00 <?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/>. /** * Behat grade related steps definitions. * * @package core_grades * @category test * @copyright 2014 Mark Nelson <markn@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ // NOTE: no MOODLE_INTERNAL test here, this file may be required by behat before including /config.php. require_once(__DIR__ . '/../../../lib/behat/behat_base.php'); use Behat\Gherkin\Node\TableNode as TableNode; class behat_grade extends behat_base { /** * Enters a grade via the gradebook for a specific grade item and user when viewing the 'Grader report' with editing mode turned on. * * @Given /^I give the grade "(?P<grade_number>(?:[^"]|\\")*)" to the user "(?P<username_string>(?:[^"]|\\")*)" for the grade item "(?P<grade_activity_string>(?:[^"]|\\")*)"$/ * @param int $grade * @param string $userfullname the user's fullname as returned by fullname() * @param string $itemname */ public function i_give_the_grade($grade, $userfullname, $itemname) { $this->execute('behat_navigation::i_close_block_drawer_if_open'); $gradelabel = $userfullname . ' ' . $itemname; $fieldstr = get_string('useractivitygrade', 'gradereport_grader', $gradelabel); $this->execute('behat_forms::i_set_the_field_to', array($this->escape($fieldstr), $grade)); } /** * Changes the settings of a grade item or category or the course. * * Teacher must be either on the grade setup page or on the Grader report page with editing mode turned on. * * @Given /^I set the following settings for grade item "(?P<grade_item_string>(?:[^"]|\\")*)" of type "([^"]*)" on "([^"]*)" page:$/ * @param string $gradeitem * @param string $type * @param string $page * @param TableNode $data */ public function i_set_the_following_settings_for_grade_item(string $gradeitem, string $type, string $page, TableNode $data) { $this->execute("behat_navigation::i_close_block_drawer_if_open"); if ($this->running_javascript()) { $this->execute("behat_grades::i_click_on_grade_item_menu", [$gradeitem, $type, $page]); } $linktext = $type == 'gradeitem' ? get_string('itemsedit', 'grades') : get_string('categoryedit', 'grades'); $this->execute("behat_action_menu::i_choose_in_the_open_action_menu", $linktext); if ($type !== 'gradeitem') { $this->execute('behat_general::i_click_on_in_the', [get_string('showmore', 'form'), 'link', '.modal-dialog', 'css_element']); } $this->execute("behat_forms::i_set_the_following_fields_to_these_values", $data); if ($this->getSession()->getPage()->find('xpath', './/button[@data-action="save"]')) { $container = $this->get_selected_node("core_grades > gradeitem modal", "form"); $node = $this->find('xpath', './/button[@data-action="save"]', false, $container); $node->press(); } else { $savechanges = get_string('savechanges', 'grades'); $this->execute('behat_forms::press_button', $this->escape($savechanges)); } } /** * Hids a grade item or category on gradebook setup or grader page. * * Teacher must be on the grade setup page. * * @Given /^I hide the grade item "(?P<grade_item_string>(?:[^"]|\\")*)" of type "([^"]*)" on "([^"]*)" page$/ * @param string $gradeitem * @param string $type * @param string $page */ public function i_hide_the_grade_item(string $gradeitem, string $type, string $page) { $linktext = get_string('hide'); if ($this->running_javascript()) { $this->execute("behat_grades::i_click_on_grade_item_menu", [$gradeitem, $type, $page]); } $this->execute("behat_action_menu::i_choose_in_the_open_action_menu", $linktext); } /** * Duplicates a grade item or category. * * Teacher must be on the grade setup page. * * @Given /^I duplicate the grade item "(?P<grade_item_string>(?:[^"]|\\")*)"$/ * @param string $gradeitem */ public function i_duplicate_the_grade_item(string $gradeitem) { $linktext = get_string('duplicate'); if ($this->running_javascript()) { $this->execute("behat_grades::i_click_on_grade_item_menu", [$gradeitem, 'gradeitem', 'setup']); } $this->execute("behat_action_menu::i_choose_in_the_open_action_menu", $linktext); } /** * Sets a calculated manual grade item. Needs a table with item name - idnumber relation. * The step requires you to be in the 'Gradebook setup' page. * * @Given /^I set "(?P<calculation_string>(?:[^"]|\\")*)" calculation for grade item "(?P<grade_item_string>(?:[^"]|\\")*)" with idnumbers:$/ * @param string $calculation The calculation. * @param string $gradeitem The grade item name. * @param TableNode $TableNode The grade item name - idnumbers relation. */ public function i_set_calculation_for_grade_item_with_idnumbers($calculation, $gradeitem, TableNode $data) { $edit = get_string('editcalculation', 'grades'); if ($this->running_javascript()) { $this->execute("behat_grades::i_click_on_grade_item_menu", [$gradeitem, 'gradeitem', 'setup']); } $this->execute("behat_action_menu::i_choose_in_the_open_action_menu", $edit); $savechanges = get_string('savechanges', 'grades'); // Mapping names to idnumbers. $datahash = $data->getRowsHash(); foreach ($datahash as $gradeitem => $idnumber) { // This xpath looks for course, categories and items with the provided name. // Grrr, we can't equal in categoryitem and courseitem because there is a line jump... $inputxpath = "//input[@class='idnumber'][" . "parent::li[@class='item'][text()='" . $gradeitem . "']" . " or " . "parent::li[@class='categoryitem' or @class='courseitem']" . "/parent::ul/parent::li[starts-with(text(),'" . $gradeitem . "')]" . "]"; $this->execute('behat_forms::i_set_the_field_with_xpath_to', [$inputxpath, $idnumber]); } $this->execute('behat_forms::press_button', get_string('addidnumbers', 'grades')); $this->execute('behat_forms::i_set_the_field_to', [get_string('calculation', 'grades'), $calculation]); $this->execute('behat_forms::press_button', $savechanges); } /** * Sets a calculated manual grade category total. Needs a table with item name - idnumber relation. * The step requires you to be in the 'Gradebook setup' page. * * @Given /^I set "(?P<calculation_string>(?:[^"]|\\")*)" calculation for grade category "(?P<grade_item_string>(?:[^"]|\\")*)" with idnumbers:$/ * @param string $calculation The calculation. * @param string $gradeitem The grade item name. * @param TableNode $data The grade item name - idnumbers relation. */ public function i_set_calculation_for_grade_category_with_idnumbers(string $calculation, string $gradeitem, TableNode $data) { $edit = get_string('editcalculation', 'grades'); if ($this->running_javascript()) { $this->execute("behat_grades::i_click_on_grade_item_menu", [$gradeitem, 'gradeitem', 'setup']); } $this->execute("behat_action_menu::i_choose_in_the_open_action_menu", $edit); $savechanges = get_string('savechanges', 'grades'); // Mapping names to idnumbers. $datahash = $data->getRowsHash(); foreach ($datahash as $gradeitem => $idnumber) { // This xpath looks for course, categories and items with the provided name. // Grrr, we can't equal in categoryitem and courseitem because there is a line jump... $inputxpath = "//input[@class='idnumber'][" . "parent::li[@class='item'][text()='" . $gradeitem . "']" . " | " . "parent::li[@class='categoryitem' or @class='courseitem']" . "/parent::ul/parent::li[starts-with(text(),'" . $gradeitem . "')]" . "]"; $this->execute('behat_forms::i_set_the_field_with_xpath_to', array($inputxpath, $idnumber)); } $this->execute('behat_forms::press_button', get_string('addidnumbers', 'grades')); $this->execute('behat_forms::i_set_the_field_to', [get_string('calculation', 'grades'), $calculation]); $this->execute('behat_forms::press_button', $savechanges); } /** * Resets the weights for the grade category * * Teacher must be on the grade setup page. * * @Given /^I reset weights for grade category "(?P<grade_item_string>(?:[^"]|\\")*)"$/ * @param string $gradeitem */ public function i_reset_weights_for_grade_category(string $gradeitem) { if ($this->running_javascript()) { $this->execute("behat_grades::i_click_on_grade_item_menu", [$gradeitem, 'category', 'setup']); } $linktext = get_string('resetweightsshort', 'grades'); $this->execute("behat_action_menu::i_choose_in_the_open_action_menu", [$this->escape($linktext), "link"]); } /** * Step allowing to test before-the-fix behaviour of the gradebook * * @Given /^gradebook calculations for the course "(?P<coursename_string>(?:[^"]|\\")*)" are frozen at version "(?P<version_string>(?:[^"]|\\")*)"$/ * @param string $coursename * @param string $version */ public function gradebook_calculations_for_the_course_are_frozen_at_version($coursename, $version) { global $DB; $courseid = $DB->get_field('course', 'id', array('shortname' => $coursename), MUST_EXIST); set_config('gradebook_calculations_freeze_' . $courseid, $version); } /** * Select the tab in the gradebook. We must be on one of the gradebook pages already. * * @deprecated since 4.0 - use behat_forms::i_set_the_field_to() instead. * @param string $gradepath examples: "View > User report", "Letters > View", "Scales" */ protected function select_in_gradebook_tabs($gradepath) { debugging('The function select_in_gradebook_tabs() is deprecated, please use ' . 'behat_forms::i_set_the_field_to() instead.', DEBUG_DEVELOPER); $gradepath = preg_split('/\s*>\s*/', trim($gradepath)); if (count($gradepath) > 2) { throw new coding_exception('Grade path is too long (must have no more than two items separated with ">")'); } $xpath = '//div[contains(@class,\'grade-navigation\')]'; // If the first row of the grade-navigation tabs does not have $gradepath[0] as active tab, click on it. $link = '\'' . $this->escape($gradepath[0]) . '\''; $xpathrow1 = $xpath . '//ul[1]//*[contains(@class,\'active\') and contains(normalize-space(.), ' . $link . ')]'; if (!$this->getSession()->getPage()->findAll('xpath', $xpathrow1)) { $this->find('xpath', $xpath . '//ul[1]/li/a[text()=' . $link . ']')->click(); $this->wait_for_pending_js(); } if (isset($gradepath[1])) { // If the second row of the grade-navigation tabs does not have $gradepath[1] as active tab, click on it. $link = '\'' . $this->escape($gradepath[1]) . '\''; $xpathrow2 = $xpath . '//ul[2]//*[contains(@class,\'active\') and contains(normalize-space(.), ' . $link . ')]'; if (!$this->getSession()->getPage()->findAll('xpath', $xpathrow2)) { $this->find('xpath', $xpath . '//ul[2]/li/a[text()=' . $link . ']')->click(); $this->wait_for_pending_js(); } } } /** * Navigates to the course gradebook and selects the specified item from the general grade navigation selector. * * Examples: * - I navigate to "Setup > Gradebook setup" in the course gradebook * - I navigate to "Scales" in the course gradebook * - I navigate to "More > Grade letters" in the course gradebook * * @Given /^I navigate to "(?P<gradepath_string>(?:[^"]|\\")*)" in the course gradebook$/ * @param string $gradepath The path string. If the path has two items (ex. "More > Grade letters"), the first item * ("More") will be used to identify an option group in the navigation selector, while the * second ("Grade letters") will be used to identify an option within that option group. * Otherwise, a single item in a path (ex. "Scales") will be used to identify an option in * the navigation selector regardless of the option group. */ public function i_navigate_to_in_the_course_gradebook($gradepath) { // If we are not on one of the gradebook pages already, follow "Grades" link in the navigation drawer. $xpath = '//div[contains(@class,\'grade-navigation\')]'; if (!$this->getSession()->getPage()->findAll('xpath', $xpath)) { $this->execute('behat_navigation::i_select_from_secondary_navigation', get_string('grades')); } $this->execute('behat_forms::i_set_the_field_to', [get_string('gradebooknavigationmenu', 'grades'), $gradepath]); } /** * Navigates to the imports page in the course gradebook and selects the specified import type from the grade * imports navigation selector. * * Examples: * - I navigate to "CSV file" import page in the course gradebook * * @Given /^I navigate to "(?P<importoption_string>(?:[^"]|\\")*)" import page in the course gradebook$/ * @param string $gradeimportoption The name of an existing grade import option. */ public function i_navigate_to_import_page_in_the_course_gradebook($gradeimportoption) { $this->i_navigate_to_in_the_course_gradebook("More > Import"); $this->execute('behat_forms::i_set_the_field_to', [get_string('importas', 'grades'), $gradeimportoption]); } /** * Navigates to the exports page in the course gradebook and selects the specified export type from the grade * exports navigation selector. * * Examples: * - I navigate to "XML file" export page in the course gradebook * * @Given /^I navigate to "(?P<exportoption_string>(?:[^"]|\\")*)" export page in the course gradebook$/ * @param string $gradeexportoption The name of an existing grade export option. */ public function i_navigate_to_export_page_in_the_course_gradebook($gradeexportoption) { $this->i_navigate_to_in_the_course_gradebook("More > Export"); $this->execute('behat_forms::i_set_the_field_to', [get_string('exportas', 'grades'), $gradeexportoption]); } /** * Select a given option from a navigation URL selector in the gradebook. We must be on one of the gradebook pages * already. * * @deprecated since 4.1 - use behat_forms::i_set_the_field_to() instead. * @param string $path The string path that is used to identify an item within the navigation selector. If the path * has two items (ex. "More > Grade letters"), the first item ("More") will be used to identify * an option group in the navigation selector, while the second ("Grade letters") will be used to * identify an option within that option group. Otherwise, a single item in a path (ex. "Scales") * will be used to identify an option in the navigation selector regardless of the option group. * @param string $formid The ID of the form element which contains the navigation URL selector element. */ protected function select_in_gradebook_navigation_selector(string $path, string $formid) { debugging('The function select_in_gradebook_navigation_selector() is deprecated, please use ' . 'behat_forms::i_set_the_field_to() instead.', DEBUG_DEVELOPER); // Split the path string by ">". $path = preg_split('/\s*>\s*/', trim($path)); // Make sure that the path does not have more than two items separated with ">". if (count($path) > 2) { throw new coding_exception('The path is too long (must have no more than two items separated with ">")'); } // Get the select element. $selectxpath = "//form[contains(@id,'{$formid}')]//select"; $select = $this->find('xpath', $selectxpath); // Define the xpath to the option element depending on the provided path. // If two items are provided in the path, the first item will be considered as an identifier of an existing // option group in the select select element, while the second item will identify an existing option within // that option group. // If one item is provided in the path, this item will identify any existing option in the select element // regardless of the option group. Also, this is useful when option elements are not a part of an option group // which is possible. if (count($path) === 2) { $optionxpath = $selectxpath . '/optgroup[@label="' . $this->escape($path[0]) . '"]' . '/option[contains(.,"' . $this->escape($path[1]) . '")]'; } else { $optionxpath = $selectxpath . '//option[contains(.,"' . $this->escape($path[0]) . '")]'; } // Get the option element that we are looking to select. $option = $this->find('xpath', $optionxpath); // Select the given option in the select element. $field = behat_field_manager::get_field_instance('select', $select, $this->getSession()); $field->set_value($this->escape($option->getValue())); if (!$this->running_javascript()) { $this->execute('behat_general::i_click_on_in_the', [get_string('go'), 'button', "#{$formid}", 'css_element']); } } /** * We tend to use this series of steps a bit so define em once. * * @param string $haystack What are we searching within? * @param string $needle What are we looking for? * @param bool $fieldset Do we want to set the search field at the same time? * @return string * @throws coding_exception */ private function get_dropdown_selector(string $haystack, string $needle, bool $fieldset = true): string { $this->execute("behat_general::wait_until_the_page_is_ready"); // Set the default field to search and handle any special preamble. $string = get_string('searchusers', 'core'); $selector = '.usersearchdropdown'; if (strtolower($haystack) === 'group') { $string = get_string('searchgroups', 'core'); $selector = '.groupsearchdropdown'; $trigger = ".groupsearchwidget"; $node = $this->find("css_element", $selector); if (!$node->isVisible()) { $this->execute("behat_general::i_click_on", [$trigger, "css_element"]); } } else if (strtolower($haystack) === 'grade') { $string = get_string('searchitems', 'core'); $selector = '.gradesearchdropdown'; $trigger = ".gradesearchwidget"; $node = $this->find("css_element", $selector); if (!$node->isVisible()) { $this->execute("behat_general::i_click_on", [$trigger, "css_element"]); } } if ($fieldset) { $this->execute("behat_forms::set_field_value", [$string, $needle]); $this->execute("behat_general::wait_until_exists", [$needle, "list_item"]); } return $selector; } /** * Confirm if a value is within the search widget within the gradebook. * * Examples: * - I confirm "User" in "user" search within the gradebook widget exists * - I confirm "Group" in "group" search within the gradebook widget exists * - I confirm "Grade item" in "grade" search within the gradebook widget exists * * @Given /^I confirm "(?P<needle>(?:[^"]|\\")*)" in "(?P<haystack>(?:[^"]|\\")*)" search within the gradebook widget exists$/ * @param string $needle The value to search for. * @param string $haystack The type of the search widget. */ public function i_confirm_in_search_within_the_gradebook_widget_exists($needle, $haystack) { $this->execute("behat_general::assert_element_contains_text", [$needle, $this->get_dropdown_selector($haystack, $needle, false), "css_element"]); } /** * Confirm if a value is not within the search widget within the gradebook. * * Examples: * - I confirm "User" in "user" search within the gradebook widget does not exist * - I confirm "Group" in "group" search within the gradebook widget does not exist * - I confirm "Grade item" in "grade" search within the gradebook widget does not exist * * @Given /^I confirm "(?P<needle>(?:[^"]|\\")*)" in "(?P<haystack>(?:[^"]|\\")*)" search within the gradebook widget does not exist$/ * @param string $needle The value to search for. * @param string $haystack The type of the search widget. */ public function i_confirm_in_search_within_the_gradebook_widget_does_not_exist($needle, $haystack) { $this->execute("behat_general::assert_element_not_contains_text", [$needle, $this->get_dropdown_selector($haystack, $needle, false), "css_element"]); } /** * Clicks on an option from the specified search widget in the current gradebook page. * * Examples: * - I click on "Student" in the "user" search widget * - I click on "Group" in the "group" search widget * - I click on "Grade item" in the "grade" search widget * * @Given /^I click on "(?P<needle>(?:[^"]|\\")*)" in the "(?P<haystack>(?:[^"]|\\")*)" search widget$/ * @param string $needle The value to search for. * @param string $haystack The type of the search widget. */ public function i_click_on_in_search_widget(string $needle, string $haystack) { $selector = $this->get_dropdown_selector($haystack, $needle); $this->execute('behat_general::i_click_on_in_the', [ $needle, "list_item", $selector, "css_element" ]); $this->execute("behat_general::i_wait_to_be_redirected"); } } tests/behat/grade_item_form_unhide.feature 0000604 00000012747 15062070557 0015043 0 ustar 00 @core @core_grades Feature: Teacher can unhide grades on the edit page allowing students to view their grades In order to show the grades of an activity to a student As a teacher I need to unhide an activity on the edit page Background: Given the following "courses" exist: | fullname | shortname | category | | Course 1 | C1 | 0 | And the following "users" exist: | username | firstname | lastname | email | | teacher1 | Teacher | 1 | teacher1@example.com | | student1 | Student | 1 | student1@example.com | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | And the following "activities" exist: | activity | course | idnumber | name | intro | assignfeedback_comments_enabled | | assign | C1 | assign1 | Test assignment name | Test assignment description | 1 | And I am on the "Test assignment name" "assign activity" page logged in as teacher1 And I follow "View all submissions" And I click on "Grade" "link" in the "Student 1" "table_row" And I set the following fields to these values: | Grade out of 100 | 50 | | Feedback comments | I'm the teacher feedback | And I press "Save changes" And I am on the "Test assignment name" "assign activity" page logged in as student1 And I should see "50.00" And I should see "I'm the teacher feedback" in the "Feedback comments" "table_row" And I am on the "Course 1" "grades > gradebook setup" page logged in as "teacher1" @javascript Scenario: Hiding the activity using the drop-down hide link and then unhiding the activity using the edit settings form page Given I hide the grade item "Test assignment name" of type "gradeitem" on "setup" page And I am on the "Test assignment name" "assign activity" page logged in as student1 And I should not see "50.00" And I should not see "I'm the teacher feedback" And I am on the "Course 1" "grades > gradebook setup" page logged in as "teacher1" And I click on grade item menu "Test assignment name" of type "gradeitem" on "setup" page And I choose "Edit grade item" in the open action menu And the field "Hidden" matches value "1" And I set the field "Hidden" to "0" And I click on "Save" "button" in the "Edit grade item" "dialogue" And I am on the "Test assignment name" "assign activity" page logged in as student1 Then I should see "50.00" And I should see "I'm the teacher feedback" in the "Feedback comments" "table_row" @javascript Scenario: Hiding the activity using the edit settings form page and then unhiding the activity using the drop-down show link Given I click on grade item menu "Test assignment name" of type "gradeitem" on "setup" page And I choose "Edit grade item" in the open action menu And I set the field "Hidden" to "1" And I click on "Save" "button" in the "Edit grade item" "dialogue" And I am on the "Test assignment name" "assign activity" page logged in as student1 And I should not see "50.00" And I should not see "I'm the teacher feedback" And I am on the "Course 1" "grades > gradebook setup" page logged in as "teacher1" And I click on grade item menu "Test assignment name" of type "gradeitem" on "setup" page And I choose "Show" in the open action menu And I am on the "Test assignment name" "assign activity" page logged in as student1 Then I should see "50.00" And I should see "I'm the teacher feedback" in the "Feedback comments" "table_row" @javascript Scenario: Hiding the category using the drop-down hide link and then unhiding the category using the edit settings form page Given I hide the grade item "Course 1" of type "course" on "setup" page And I am on the "Test assignment name" "assign activity" page logged in as student1 And I should not see "50.00" And I should not see "I'm the teacher feedback" And I am on the "Course 1" "grades > gradebook setup" page logged in as "teacher1" And I click on grade item menu "Course 1" of type "course" on "setup" page And I choose "Edit category" in the open action menu And the field "Hidden" matches value "1" And I set the field "Hidden" to "0" And I click on "Save" "button" in the "Edit category" "dialogue" And I am on the "Test assignment name" "assign activity" page logged in as student1 Then I should see "50.00" And I should see "I'm the teacher feedback" in the "Feedback comments" "table_row" @javascript Scenario: Hiding the category using the edit settings form page and then unhiding the category using the drop-down show link Given I set the following settings for grade item "Course 1" of type "course" on "setup" page: | Hidden | 1 | And I am on the "Test assignment name" "assign activity" page logged in as student1 And I should not see "50.00" And I should not see "I'm the teacher feedback" And I am on the "Course 1" "grades > gradebook setup" page logged in as "teacher1" And I click on grade item menu "Course 1" of type "course" on "setup" page And I choose "Show" in the open action menu And I am on the "Test assignment name" "assign activity" page logged in as student1 Then I should see "50.00" And I should see "I'm the teacher feedback" in the "Feedback comments" "table_row" tests/behat/grade_natural_exclude_empty_20150619.feature 0000604 00000052152 15062070557 0017104 0 ustar 00 @core @core_grades Feature: Gradebook calculations for extra credit items before the fix 20150619 In order to make sure the grades are not changed after upgrade As a teacher I need to be able to freeze gradebook calculations Background: Given the following "courses" exist: | fullname | shortname | category | groupmode | | Course 1 | C1 | 0 | 1 | And gradebook calculations for the course "C1" are frozen at version "20150619" And the following "users" exist: | username | firstname | lastname | email | idnumber | | teacher1 | Teacher | 1 | teacher1@example.com | t1 | | student1 | Student | 1 | student1@example.com | s1 | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | And the following "activities" exist: | activity | course | idnumber | name | intro | grade | | assign | C1 | a1 | Test assignment one | x | 100 | | assign | C1 | a2 | Test assignment two | x | 50 | | assign | C1 | a3 | Test assignment three | x | 200 | | assign | C1 | a4 | Test assignment four (extra) | x | 20 | | assign | C1 | a5 | Test assignment five (extra) | x | 10 | And I am on the "Course 1" "grades > gradebook setup" page logged in as "teacher1" And I set the following settings for grade item "Test assignment four (extra)" of type "gradeitem" on "setup" page: | Extra credit | 1 | And I set the following settings for grade item "Test assignment five (extra)" of type "gradeitem" on "setup" page: | Extra credit | 1 | @javascript Scenario: No weights are overridden and student has all grades present (before the fix 20150619) When I navigate to "View > Grader report" in the course gradebook And I turn editing mode on And I give the grade "80.00" to the user "Student 1" for the grade item "Test assignment one" And I give the grade "30.00" to the user "Student 1" for the grade item "Test assignment two" And I give the grade "150.00" to the user "Student 1" for the grade item "Test assignment three" And I give the grade "10.00" to the user "Student 1" for the grade item "Test assignment four (extra)" And I give the grade "8.00" to the user "Student 1" for the grade item "Test assignment five (extra)" And I press "Save changes" And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | Test assignment one | 28.57 % | 80.00 | 0–100 | 80.00 % | 22.86 % | | Test assignment two | 14.29 % | 30.00 | 0–50 | 60.00 % | 8.57 % | | Test assignment three | 57.14 % | 150.00 | 0–200 | 75.00 % | 42.86 % | | Test assignment four (extra) | 5.71 %( Extra credit ) | 10.00 | 0–20 | 50.00 % | 2.86 % | | Test assignment five (extra) | 2.86 %( Extra credit ) | 8.00 | 0–10 | 80.00 % | 2.29 % | | Course total | - | 278.00 | 0–350 | 79.43 % | - | And I log out @javascript Scenario: No weights are overridden, student has some grades present (before the fix 20150619) When I navigate to "View > Grader report" in the course gradebook And I turn editing mode on And I give the grade "80.00" to the user "Student 1" for the grade item "Test assignment one" And I give the grade "30.00" to the user "Student 1" for the grade item "Test assignment two" And I give the grade "10.00" to the user "Student 1" for the grade item "Test assignment four (extra)" And I give the grade "8.00" to the user "Student 1" for the grade item "Test assignment five (extra)" And I press "Save changes" And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | Test assignment one | 66.67 % | 80.00 | 0–100 | 80.00 % | 53.33 % | | Test assignment two | 33.33 % | 30.00 | 0–50 | 60.00 % | 20.00 % | | Test assignment three | 0.00 %( Empty ) | - | 0–200 | - | 0.00 % | | Test assignment four (extra) | 13.33 %( Extra credit ) | 10.00 | 0–20 | 50.00 % | 6.67 % | | Test assignment five (extra) | 6.67 %( Extra credit ) | 8.00 | 0–10 | 80.00 % | 5.33 % | | Course total | - | 128.00 | 0–150 | 85.33 % | - | And I log out @javascript Scenario: No weights are overridden, student has none grades present except for extra credit (before the fix 20150619) When I navigate to "View > Grader report" in the course gradebook And I turn editing mode on And I give the grade "10.00" to the user "Student 1" for the grade item "Test assignment four (extra)" And I give the grade "8.00" to the user "Student 1" for the grade item "Test assignment five (extra)" And I press "Save changes" And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | Test assignment one | 0.00 %( Empty ) | - | 0–100 | - | 0.00 % | | Test assignment two | 0.00 %( Empty ) | - | 0–50 | - | 0.00 % | | Test assignment three | 0.00 %( Empty ) | - | 0–200 | - | 0.00 % | | Test assignment four (extra) | 0.00 %( Extra credit ) | 10.00 | 0–20 | 50.00 % | 0.00 % | | Test assignment five (extra) | 0.00 %( Extra credit ) | 8.00 | 0–10 | 80.00 % | 0.00 % | | Course total | - | 0.00 | 0–0 | | - | And I log out @javascript Scenario: Make sure there are no errors when all items are marked as extra credit (before the fix 20150619) And I set the following settings for grade item "Test assignment one" of type "gradeitem" on "setup" page: | Extra credit | 1 | And I set the following settings for grade item "Test assignment two" of type "gradeitem" on "setup" page: | Extra credit | 1 | And I set the following settings for grade item "Test assignment three" of type "gradeitem" on "setup" page: | Extra credit | 1 | When I navigate to "View > Grader report" in the course gradebook And I turn editing mode on And I give the grade "80.00" to the user "Student 1" for the grade item "Test assignment one" And I give the grade "30.00" to the user "Student 1" for the grade item "Test assignment two" And I give the grade "10.00" to the user "Student 1" for the grade item "Test assignment four (extra)" And I give the grade "8.00" to the user "Student 1" for the grade item "Test assignment five (extra)" And I press "Save changes" And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | Test assignment one | 0.00 %( Extra credit ) | 80.00 | 0–100 | 80.00 % | 0.00 % | | Test assignment two | 0.00 %( Extra credit ) | 30.00 | 0–50 | 60.00 % | 0.00 % | | Test assignment three | 0.00 %( Empty ) | - | 0–200 | - | 0.00 % | | Test assignment four (extra) | 0.00 %( Extra credit ) | 10.00 | 0–20 | 50.00 % | 0.00 % | | Test assignment five (extra) | 0.00 %( Extra credit ) | 8.00 | 0–10 | 80.00 % | 0.00 % | | Course total | - | 0.0 | 0–0 | | - | And I log out @javascript Scenario: Weights are overridden and student has all grades present (before the fix 20150619) When I set the field "Override weight of Test assignment one" to "1" And I set the field "Weight of Test assignment one" to "50" And I press "Save changes" When I navigate to "View > Grader report" in the course gradebook And I turn editing mode on And I give the grade "80.00" to the user "Student 1" for the grade item "Test assignment one" And I give the grade "30.00" to the user "Student 1" for the grade item "Test assignment two" And I give the grade "150.00" to the user "Student 1" for the grade item "Test assignment three" And I give the grade "10.00" to the user "Student 1" for the grade item "Test assignment four (extra)" And I give the grade "8.00" to the user "Student 1" for the grade item "Test assignment five (extra)" And I press "Save changes" And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | Test assignment one | 50.00 % | 80.00 | 0–100 | 80.00 % | 40.00 % | | Test assignment two | 10.00 % | 30.00 | 0–50 | 60.00 % | 6.00 % | | Test assignment three | 40.00 % | 150.00 | 0–200 | 75.00 % | 30.00 % | | Test assignment four (extra) | 4.00 %( Extra credit ) | 10.00 | 0–20 | 50.00 % | 2.00 % | | Test assignment five (extra) | 2.00 %( Extra credit ) | 8.00 | 0–10 | 80.00 % | 1.60 % | | Course total | - | 278.60 | 0–350 | 79.60 % | - | # Contributions of extra credit "four" should be 20/350=5.71% and "five" 10/350=2.86% (350 is max grade for the course, 20 and 10 are max grades of "four" and "five") And I log out @javascript Scenario: Weights are overridden and student has some grades present (before the fix 20150619) When I set the field "Override weight of Test assignment one" to "1" And I set the field "Weight of Test assignment one" to "50" And I press "Save changes" When I navigate to "View > Grader report" in the course gradebook And I turn editing mode on And I give the grade "80.00" to the user "Student 1" for the grade item "Test assignment one" And I give the grade "30.00" to the user "Student 1" for the grade item "Test assignment two" And I give the grade "10.00" to the user "Student 1" for the grade item "Test assignment four (extra)" And I give the grade "8.00" to the user "Student 1" for the grade item "Test assignment five (extra)" And I press "Save changes" And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | Test assignment one | 83.33 % | 80.00 | 0–100 | 80.00 % | 66.67 % | | Test assignment two | 16.67 % | 30.00 | 0–50 | 60.00 % | 10.00 % | | Test assignment three | 0.00 %( Empty ) | - | 0–200 | - | 0.00 % | | Test assignment four (extra) | 6.67 %( Extra credit ) | 10.00 | 0–20 | 50.00 % | 3.33 % | | Test assignment five (extra) | 3.33 %( Extra credit ) | 8.00 | 0–10 | 80.00 % | 2.67 % | | Course total | - | 124.00 | 0–150 | 82.67 % | - | # Contributions of extra credit "four" should be 20/150=13.33% and "five" 10/150=6.67% (150 is max grade for the course, 20 and 10 are max grades of "four" and "five") And I log out @javascript Scenario: Weights are overridden, student has none grades present except for extra credit (before the fix 20150619) When I set the field "Override weight of Test assignment one" to "1" And I set the field "Weight of Test assignment one" to "50" And I press "Save changes" When I navigate to "View > Grader report" in the course gradebook And I turn editing mode on And I give the grade "10.00" to the user "Student 1" for the grade item "Test assignment four (extra)" And I give the grade "8.00" to the user "Student 1" for the grade item "Test assignment five (extra)" And I press "Save changes" And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | Test assignment one | 0.00 %( Empty ) | - | 0–100 | - | 0.00 % | | Test assignment two | 0.00 %( Empty ) | - | 0–50 | - | 0.00 % | | Test assignment three | 0.00 %( Empty ) | - | 0–200 | - | 0.00 % | | Test assignment four (extra) | 0.00 %( Extra credit ) | 10.00 | 0–20 | 50.00 % | 0.00 % | | Test assignment five (extra) | 0.00 %( Extra credit ) | 8.00 | 0–10 | 80.00 % | 0.00 % | | Course total | - | 0.00 | 0–0 | | - | And I log out @javascript Scenario: Weights are overridden, including extra credit, and student has all grades present (before the fix 20150619) When I set the field "Override weight of Test assignment one" to "1" And I set the field "Weight of Test assignment one" to "50" And I set the field "Override weight of Test assignment four (extra)" to "1" And I set the field "Weight of Test assignment four (extra)" to "10" And I press "Save changes" When I navigate to "View > Grader report" in the course gradebook And I turn editing mode on And I give the grade "80.00" to the user "Student 1" for the grade item "Test assignment one" And I give the grade "30.00" to the user "Student 1" for the grade item "Test assignment two" And I give the grade "150.00" to the user "Student 1" for the grade item "Test assignment three" And I give the grade "10.00" to the user "Student 1" for the grade item "Test assignment four (extra)" And I give the grade "8.00" to the user "Student 1" for the grade item "Test assignment five (extra)" And I press "Save changes" And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | Test assignment one | 50.00 % | 80.00 | 0–100 | 80.00 % | 40.00 % | | Test assignment two | 8.70 % | 30.00 | 0–50 | 60.00 % | 5.22 % | | Test assignment three | 34.78 % | 150.00 | 0–200 | 75.00 % | 26.09 % | | Test assignment four (extra) | 10.00 %( Extra credit ) | 10.00 | 0–20 | 50.00 % | 5.00 % | | Test assignment five (extra) | 1.74 %( Extra credit ) | 8.00 | 0–10 | 80.00 % | 1.39 % | | Course total | - | 271.93 | 0–350 | 77.70 % | - | # Which is absolutely terrible because weights of normal items do not add up to 100% And I log out @javascript Scenario: Weights are overridden, including extra credit, and student has some grades present (before the fix 20150619) When I set the field "Override weight of Test assignment one" to "1" And I set the field "Weight of Test assignment one" to "50" And I set the field "Override weight of Test assignment four (extra)" to "1" And I set the field "Weight of Test assignment four (extra)" to "10" And I press "Save changes" And I navigate to "View > Grader report" in the course gradebook And I turn editing mode on And I give the grade "80.00" to the user "Student 1" for the grade item "Test assignment one" And I give the grade "30.00" to the user "Student 1" for the grade item "Test assignment two" And I give the grade "10.00" to the user "Student 1" for the grade item "Test assignment four (extra)" And I give the grade "8.00" to the user "Student 1" for the grade item "Test assignment five (extra)" And I press "Save changes" And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | Test assignment one | 83.33 % | 80.00 | 0–100 | 80.00 % | 66.67 % | | Test assignment two | 0.00 % | 30.00 | 0–50 | 60.00 % | 0.00 % | | Test assignment three | 0.00 %( Empty ) | - | 0–200 | - | 0.00 % | | Test assignment four (extra) | 16.67 %( Extra credit ) | 10.00 | 0–20 | 50.00 % | 8.33 % | | Test assignment five (extra) | 0.00 %( Extra credit ) | 8.00 | 0–10 | 80.00 % | 0.00 % | | Course total | - | 112.50 | 0–150 | 75.00 % | - | # This is just ridiculous, the grades for "two" and "five" are 0 without any reason, and sum weight of normal items is not 100% again. And I log out @javascript Scenario: Weights are overridden, including extra credit, student has none grades present except for extra credit (before the fix 20150619) When I set the field "Override weight of Test assignment one" to "1" And I set the field "Weight of Test assignment one" to "50" And I set the field "Override weight of Test assignment four (extra)" to "1" And I set the field "Weight of Test assignment four (extra)" to "10" And I press "Save changes" When I navigate to "View > Grader report" in the course gradebook And I turn editing mode on And I give the grade "10.00" to the user "Student 1" for the grade item "Test assignment four (extra)" And I give the grade "8.00" to the user "Student 1" for the grade item "Test assignment five (extra)" And I press "Save changes" And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | Test assignment one | 0.00 %( Empty ) | - | 0–100 | - | 0.00 % | | Test assignment two | 0.00 %( Empty ) | - | 0–50 | - | 0.00 % | | Test assignment three | 0.00 %( Empty ) | - | 0–200 | - | 0.00 % | | Test assignment four (extra) | 0.00 %( Extra credit ) | 10.00 | 0–20 | 50.00 % | 0.00 % | | Test assignment five (extra) | 0.00 %( Extra credit ) | 8.00 | 0–10 | 80.00 % | 0.00 % | | Course total | - | 0.00 | 0–0 | | - | And I log out tests/behat/grade_item_pass_data_to_advanced_page.feature 0000604 00000016531 15062070557 0020021 0 ustar 00 @core @core_grades @javascript @testtt Feature: We carry over data from modal to advanced grade item settings In order to setup grade items quickly As an teacher I need to ensure data is carried over from modal to advanced grade item settings Background: Given the following "courses" exist: | fullname | shortname | category | groupmode | | Course 1 | C1 | 0 | 1 | And the following "users" exist: | username | firstname | lastname | email | idnumber | | teacher1 | Teacher | 1 | teacher1@example.com | t1 | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | And the following "grade categories" exist: | fullname | course | | Some cool grade category | C1 | And the following config values are set as admin: | enableoutcomes | 1 | And the following "scales" exist: | name | scale | | Test Scale | Disappointing, Good, Very good, Excellent | And the following "grade outcomes" exist: | fullname | shortname | course | scale | | Outcome 1 | OT1 | C1 | Test Scale | | Outcome 2 | OT2 | C1 | Test Scale | And the following "activities" exist: | activity | course | idnumber | name | intro | | assign | C1 | a1 | Test assignment 1 | Submit something! | And I log in as "admin" And I set the following administration settings values: | grade_aggregations_visible | Mean of grades,Weighted mean of grades,Simple weighted mean of grades,Mean of grades (with extra credits),Median of grades,Lowest grade,Highest grade,Mode of grades,Natural | And I log out And I am on the "Course 1" course page logged in as teacher1 And I navigate to "Setup > Gradebook setup" in the course gradebook And I choose the "Add grade item" item in the "Add" action menu Scenario: Defaults are used when creating a new grade item Given I click on "Show more..." "link" in the ".modal-dialog" "css_element" Then the following fields match these values: | Item name | | | Minimum grade | 0 | | Maximum grade | 100 | | Weight adjusted | 0 | | aggregationcoef2 | 0 | | Grade category | Course 1 | And I press "Cancel" And I wait until the page is ready And I choose the "Add category" item in the "Add" action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" And the following fields match these values: | Category name | | | Aggregation | Natural | | Weight adjusted | 0 | | grade_item_aggregationcoef2 | 0 | | Parent category | Course 1 | And I press "Cancel" And I wait until the page is ready And I choose the "Add outcome item" item in the "Add" action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" And the following fields match these values: | Item name | | | Outcome | Outcome 1 | | Linked activity | None | | Grade category | Course 1 | Scenario: We carry over data from modal to advanced grade item settings Given I set the following fields to these values: | Item name | Manual item 1 | | Minimum grade | 1 | | Maximum grade | 99 | | Weight adjusted | 1 | | aggregationcoef2 | 100 | | Grade category | Some cool grade category | When I click on "Show more..." "link" in the ".modal-dialog" "css_element" Then the following fields match these values: | Item name | Manual item 1 | | Minimum grade | 1 | | Maximum grade | 99 | | Weight adjusted | 1 | | aggregationcoef2 | 100 | | Grade category | Some cool grade category | And I press "Cancel" And I wait until the page is ready And I choose the "Add category" item in the "Add" action menu And I set the following fields to these values: | Category name | Category 1 | | Aggregation | Mean of grades | | Minimum grade | 1 | | Maximum grade | 99 | | Weight adjusted | 1 | | grade_item_aggregationcoef2 | 100 | | Parent category | Some cool grade category | And I click on "Show more..." "link" in the ".modal-dialog" "css_element" And the following fields match these values: | Category name | Category 1 | | Aggregation | Mean of grades | | Minimum grade | 1 | | Maximum grade | 99 | | Weight adjusted | 1 | | grade_item_aggregationcoef2 | 100 | | Parent category | Some cool grade category | And I press "Cancel" And I choose the "Add category" item in the "Add" action menu # Confirm that the form values are carried over even if some mandatory fields are missing (e.g. Category name). And I set the following fields to these values: | Aggregation | Mean of grades | | Minimum grade | 1 | | Maximum grade | 99 | | Weight adjusted | 1 | | grade_item_aggregationcoef2 | 100 | | Parent category | Some cool grade category | And I click on "Show more..." "link" in the ".modal-dialog" "css_element" And the following fields match these values: | Category name | | | Aggregation | Mean of grades | | Minimum grade | 1 | | Maximum grade | 99 | | Weight adjusted | 1 | | grade_item_aggregationcoef2 | 100 | | Parent category | Some cool grade category | And I press "Cancel" And I wait until the page is ready And I choose the "Add outcome item" item in the "Add" action menu And I set the following fields to these values: | Item name | Outcome item 1 | | Outcome | Outcome 2 | | Linked activity | Test assignment 1 | And I click on "Show more..." "link" in the ".modal-dialog" "css_element" And the following fields match these values: | Item name | Outcome item 1 | | Outcome | Outcome 2 | | Linked activity | Test assignment 1 | tests/behat/grade_edit_tree_bulk_actions.feature 0000604 00000035506 15062070557 0016225 0 ustar 00 @core @core_grades @javascript Feature: Teachers can perform bulk actions on grade items and categories in the gradebook setup In order to be able to easily organize my gradebook As a teacher I need to be able to select multiple grade items and categories and perform bulk actions on them Background: Given the following "courses" exist: | fullname | shortname | category | | Course | C1 | 0 | And the following "users" exist: | username | firstname | lastname | email | idnumber | | teacher1 | Teacher 1 | 1 | teacher1@example.com | t1 | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | And the following "grade categories" exist: | fullname | course | | Category 1 | C1 | And the following "grade categories" exist: | fullname | course | gradecategory | | Category 2 | C1 | Category 1 | | Category 3 | C1 | Category 2 | And the following "grade items" exist: | itemname | course | category | | Grade item 1 | C1 | ? | | Grade item 2 | C1 | Category 1 | | Grade item 3 | C1 | Category 1 | | Grade item 4 | C1 | Category 2 | And I log in as "teacher1" And I am on "Course" course homepage And I navigate to "Setup > Gradebook setup" in the course gradebook Scenario: A teacher can see bulk action options in the gradebook setup # Bulk action options should not be displayed until at least one grade item is selected. Given I should not see "Move" in the "sticky-footer" "region" When I set the field "Grade item 1" to "1" Then I should see "Move" in the "sticky-footer" "region" And I set the field "Grade item 2" to "1" And I should see "Move" in the "sticky-footer" "region" # Unchecking all grade items should hide the bulk action area. And I set the following fields to these values: | Grade item 1 | 0 | | Grade item 2 | 0 | And I should not see "Move" in the "sticky-footer" "region" Scenario: A teacher can see the number of selected grade items and categories in the bulk action area Given I set the field "Grade item 1" to "1" # Selecting a grade category should also select all grade items in that category. When I set the field "Category 2" to "1" Then I should see "4 selected" in the "sticky-footer" "region" And I set the field "Category 2" to "0" And I should see "1 selected" in the "sticky-footer" "region" And I set the field "All" to "1" And I should see "8 selected" in the "sticky-footer" "region" And I set the field "All" to "0" And I should not see "selected" in the "sticky-footer" "region" Scenario: A teacher can unselect all grade items and categories in the bulk action area Given I set the following fields to these values: | Grade item 1 | 1 | | Category 2 | 1 | And I should see "4 selected" in the "sticky-footer" "region" And "Close bulk edit" "button" should exist in the "sticky-footer" "region" When I click on "Close bulk edit" "button" in the "sticky-footer" "region" Then the following fields match these values: | All | 0 | | Grade item 1 | 0 | | Category 1 | 0 | | Grade item 2 | 0 | | Grade item 3 | 0 | | Category 2 | 0 | | Grade item 4 | 0 | | Category 3 | 0 | And "Close bulk edit" "button" should not exist in the "sticky-footer" "region" Scenario: A teacher can see bulk move modal with all available grade categories Given I set the field "Grade item 1" to "1" When I click on "Move" "button" in the "sticky-footer" "region" Then "Move items" "dialogue" should exist And "Course" "list_item" should exist in the "Move items" "dialogue" And "Category 1" "list_item" should exist in the "Move items" "dialogue" And "Category 2" "list_item" should exist in the "Move items" "dialogue" And "Category 3" "list_item" should exist in the "Move items" "dialogue" Scenario: A teacher can collapse grade categories in the bulk move modal Given I set the field "Grade item 1" to "1" And I click on "Move" "button" in the "sticky-footer" "region" # Collapse "Category 2" category. When I click on "Collapse" "link" in the "Category 2" "list_item" Then "Course" "list_item" in the "Move items" "dialogue" should be visible And "Category 1" "list_item" in the "Move items" "dialogue" should be visible And "Category 2" "list_item" in the "Move items" "dialogue" should be visible And "Category 3" "list_item" in the "Move items" "dialogue" should not be visible And "Expand" "link" should exist in the "Category 2" "list_item" # Collapse "Category 1" category. And I click on "Collapse" "link" in the "Category 1" "list_item" And "Course" "list_item" in the "Move items" "dialogue" should be visible And "Category 1" "list_item" in the "Move items" "dialogue" should be visible And "Category 2" "list_item" in the "Move items" "dialogue" should not be visible And "Category 3" "list_item" in the "Move items" "dialogue" should not be visible And "Expand" "link" should exist in the "Category 1" "list_item" # Expand "Category 1" category. And I click on "Expand" "link" in the "Category 1" "list_item" And "Course" "list_item" in the "Move items" "dialogue" should be visible And "Category 1" "list_item" in the "Move items" "dialogue" should be visible And "Category 2" "list_item" in the "Move items" "dialogue" should be visible And "Category 3" "list_item" in the "Move items" "dialogue" should not be visible And "Collapse" "link" should exist in the "Category 1" "list_item" # Expand "Category 2" category. And I click on "Expand" "link" in the "Category 2" "list_item" And "Course" "list_item" in the "Move items" "dialogue" should be visible And "Category 1" "list_item" in the "Move items" "dialogue" should be visible And "Category 2" "list_item" in the "Move items" "dialogue" should be visible And "Category 3" "list_item" in the "Move items" "dialogue" should be visible And "Collapse" "link" should exist in the "Category 2" "list_item" Scenario: A teacher can move multiple grade items to a category Given I set the following fields to these values: | Grade item 1 | 1 | | Grade item 2 | 1 | And I click on "Move" "button" in the "sticky-footer" "region" And I click on "Category 3" "list_item" in the "Move items" "dialogue" And I click on "Move" "button" in the "Move items" "dialogue" And I wait to be redirected # Confirm that 'Grade item 1' and 'Grade item 2' have been moved to 'Category 3' And I click on grade item menu "Grade item 1" of type "gradeitem" on "setup" page When I choose "Edit grade item" in the open action menu And "Edit grade item" "dialogue" should exist Then I should see "Category 3" in the "Grade category" "form_row" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Grade item 2" of type "gradeitem" on "setup" page And I choose "Edit grade item" in the open action menu And "Edit grade item" "dialogue" should exist And I should see "Category 3" in the "Grade category" "form_row" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" # Confirm that all other grade items have not been moved. And I click on grade item menu "Grade item 3" of type "gradeitem" on "setup" page When I choose "Edit grade item" in the open action menu And I wait until "Edit grade item" "dialogue" exists Then I should see "Category 1" in the "Grade category" "form_row" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Grade item 4" of type "gradeitem" on "setup" page And I choose "Edit grade item" in the open action menu And I wait until "Edit grade item" "dialogue" exists And I should see "Category 2" in the "Grade category" "form_row" @accessibility Scenario: A teacher can navigate through the grade categories in the bulk modal using the keyboard Given I set the field "Grade item 1" to "1" And I press tab key in "sticky-footer" "region" And the focused element is "Move" "button" in the "sticky-footer" "region" And I press enter And "Move items" "dialogue" should exist And I press tab And the focused element is "Close" "button" in the "Move items" "dialogue" And I press tab And the focused element is "Course" "list_item" in the "Move items" "dialogue" # Move to the next grade category. When I press the down key Then the focused element is "Category 1" "list_item" in the "Move items" "dialogue" And the page should meet accessibility standards with "wcag131, wcag141, wcag412" extra tests And I press the down key And the focused element is "Category 2" "list_item" in the "Move items" "dialogue" # Move to the previous grade category. And I press the up key And the focused element is "Category 1" "list_item" in the "Move items" "dialogue" And I press the up key And the focused element is "Course" "list_item" in the "Move items" "dialogue" # Move to the last grade category. And I press the end key And the focused element is "Category 3" "list_item" in the "Move items" "dialogue" # Move to the first grade category. And I press the home key And the focused element is "Course" "list_item" in the "Move items" "dialogue" @accessibility Scenario: A teacher can collapse and expand the grade categories in the bulk modal using the keyboard Given I set the field "Grade item 1" to "1" And I press tab key in "sticky-footer" "region" And the focused element is "Move" "button" in the "sticky-footer" "region" And I press enter And "Move items" "dialogue" should exist And I press tab And the focused element is "Close" "button" in the "Move items" "dialogue" And I press tab And the focused element is "Course" "list_item" in the "Move items" "dialogue" And I press the down key Then the focused element is "Category 1" "list_item" in the "Move items" "dialogue" And I press the down key And the focused element is "Category 2" "list_item" in the "Move items" "dialogue" And "Collapse" "link" should exist in the "Category 2" "list_item" # Collapse "Category 2" category. When I press the left key Then "Course" "list_item" in the "Move items" "dialogue" should be visible And "Category 1" "list_item" in the "Move items" "dialogue" should be visible And "Category 2" "list_item" in the "Move items" "dialogue" should be visible And "Category 3" "list_item" in the "Move items" "dialogue" should not be visible And "Expand" "link" should exist in the "Category 2" "list_item" And the page should meet accessibility standards with "wcag131, wcag141, wcag412" extra tests And the focused element is "Category 1" "list_item" in the "Move items" "dialogue" And "Collapse" "link" should exist in the "Category 2" "list_item" # Collapse "Category 1" category. And I press the left key And "Course" "list_item" in the "Move items" "dialogue" should be visible And "Category 1" "list_item" in the "Move items" "dialogue" should be visible And "Category 2" "list_item" in the "Move items" "dialogue" should not be visible And "Category 3" "list_item" in the "Move items" "dialogue" should not be visible And "Expand" "link" should exist in the "Category 1" "list_item" And I press the down key # Expand "Category 1" category. And I press the right key And "Course" "list_item" in the "Move items" "dialogue" should be visible And "Category 1" "list_item" in the "Move items" "dialogue" should be visible And "Category 2" "list_item" in the "Move items" "dialogue" should be visible And "Category 3" "list_item" in the "Move items" "dialogue" should not be visible And "Collapse" "link" should exist in the "Category 1" "list_item" And the focused element is "Category 2" "list_item" in the "Move items" "dialogue" # Expand "Category 2" category. And I press the right key And "Course" "list_item" in the "Move items" "dialogue" should be visible And "Category 1" "list_item" in the "Move items" "dialogue" should be visible And "Category 2" "list_item" in the "Move items" "dialogue" should be visible And "Category 3" "list_item" in the "Move items" "dialogue" should be visible And "Collapse" "link" should exist in the "Category 2" "list_item" @accessibility Scenario: A teacher can move multiple items to a category using the keyboard Given I set the following fields to these values: | Grade item 1 | 1 | | Grade item 2 | 1 | And I press tab key in "sticky-footer" "region" And the focused element is "Move" "button" in the "sticky-footer" "region" And I press enter And "Move items" "dialogue" should exist And I press tab And the focused element is "Close" "button" in the "Move items" "dialogue" And I press tab And the focused element is "Course" "list_item" in the "Move items" "dialogue" And I press the down key And the focused element is "Category 1" "list_item" in the "Move items" "dialogue" And I press the down key And the focused element is "Category 2" "list_item" in the "Move items" "dialogue" And I press the down key And the focused element is "Category 3" "list_item" in the "Move items" "dialogue" And the "data-selected" attribute of "Category 3" "list_item" should contain "false" # Select the grade category "Category 2". And I press enter And the "data-selected" attribute of "Category 3" "list_item" should contain "true" And the page should meet accessibility standards with "wcag131, wcag141, wcag412" extra tests And I press tab And the focused element is "Cancel" "button" in the "Move items" "dialogue" And I press tab And the focused element is "Move" "button" in the "Move items" "dialogue" When I press the enter key And I wait until the page is ready And I wait "2" seconds And I press tab key in "region-main" "region" # Confirm that 'Grade item 1' and 'Grade item 2' have been moved to 'Category 3' And I click on grade item menu "Grade item 1" of type "gradeitem" on "setup" page And I choose "Edit grade item" in the open action menu And I wait until "Edit grade item" "dialogue" exists Then I should see "Category 3" in the "Grade category" "form_row" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Grade item 2" of type "gradeitem" on "setup" page And I choose "Edit grade item" in the open action menu And I wait until "Edit grade item" "dialogue" exists And I should see "Category 3" in the "Grade category" "form_row" tests/behat/grade_aggregation_changes.feature 0000604 00000104026 15062070557 0015475 0 ustar 00 @core @core_grades @javascript Feature: Changing the aggregation of an item affects its weight and extra credit definition In order to switch to another aggregation method As an teacher I need to be able to edit the grade category settings Background: Given the following "courses" exist: | fullname | shortname | | Course 1 | C1 | And the following "grade categories" exist: | fullname | course | aggregation | | Cat mean | C1 | 0 | | Cat median | C1 | 2 | | Cat min | C1 | 4 | | Cat max | C1 | 6 | | Cat mode | C1 | 8 | | Cat weighted | C1 | 10 | | Cat weighted2 | C1 | 10 | | Cat simple | C1 | 11 | | Cat ec | C1 | 12 | | Cat natural & | C1 | 13 | And the following "grade items" exist: | itemname | course | category | aggregationcoef | aggregationcoef2 | weightoverride | | Item a1 | C1 | ? | 0 | 0 | 0 | | Item a2 | C1 | ? | 0 | 0.40 | 1 | | Item a3 | C1 | ? | 1 | 0.10 | 1 | | Item a4 | C1 | ? | 1 | 0 | 0 | | Item b1 | C1 | Cat natural & | 0 | 0 | 0 | | Item b2 | C1 | Cat natural & | 0 | 0.40 | 1 | | Item b3 | C1 | Cat natural & | 1 | 0.10 | 1 | | Item b4 | C1 | Cat natural & | 1 | 0 | 0 | And I log in as "admin" And I change window size to "large" And I set the following administration settings values: | grade_aggregations_visible | Mean of grades,Weighted mean of grades,Simple weighted mean of grades,Mean of grades (with extra credits),Median of grades,Lowest grade,Highest grade,Mode of grades,Natural | And I am on the "Course 1" "grades > Grader report > View" page And I turn editing mode on And I click on grade item menu "Cat mean" of type "category" on "grader" page And I choose "Edit category" in the open action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" And I set the following fields to these values: | Weight adjusted | 1 | | Weight | 20 | | Extra credit | 0 | And I press "Save changes" And I click on grade item menu "Cat median" of type "category" on "grader" page And I choose "Edit category" in the open action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" And I set the following fields to these values: | Weight adjusted | 1 | | Weight | 5 | | Extra credit | 0 | And I press "Save changes" And I click on grade item menu "Cat min" of type "category" on "grader" page And I choose "Edit category" in the open action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" And I set the following fields to these values: | Weight adjusted | 0 | | Weight | 0 | | Extra credit | 1 | And I press "Save changes" And I click on grade item menu "Item a1" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Weight adjusted" matches value "0" And the field "Extra credit" matches value "0" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item a2" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Weight adjusted" matches value "1" And the field "Weight" matches value "40.0" And the field "Extra credit" matches value "0" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item a3" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Weight adjusted" matches value "1" And the field "Weight" matches value "10.0" And the field "Extra credit" matches value "1" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item a4" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Weight adjusted" matches value "0" And the field "Extra credit" matches value "1" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item b1" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Weight adjusted" matches value "0" And the field "Extra credit" matches value "0" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item b2" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Weight adjusted" matches value "1" And the field "Weight" matches value "40.0" And the field "Extra credit" matches value "0" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item b3" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Weight adjusted" matches value "1" And the field "Weight" matches value "10.0" And the field "Extra credit" matches value "1" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item b4" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Weight adjusted" matches value "0" And the field "Extra credit" matches value "1" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" Scenario: Switching a category from Natural aggregation to Mean of grades and back Given I click on grade item menu "Course 1" of type "course" on "grader" page And I choose "Edit category" in the open action menu And I set the field "Aggregation" to "Mean of grades" When I click on "Save" "button" in the "Edit category" "dialogue" And I click on grade item menu "Item a1" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu Then I should not see "Weight adjusted" And I should not see "Weight" And I should not see "Extra credit" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item a2" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And I should not see "Weight adjusted" And I should not see "Weight" And I should not see "Extra credit" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item a3" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And I should not see "Weight adjusted" And I should not see "Weight" And I should not see "Extra credit" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item a4" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And I should not see "Weight adjusted" And I should not see "Weight" And I should not see "Extra credit" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Cat mean" of type "category" on "grader" page And I choose "Edit category" in the open action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" And I expand all fieldsets And I should not see "Weight adjusted" And I should not see "Weight" in the "#id_headerparent" "css_element" And I should not see "Extra credit" And I press "Cancel" And I click on grade item menu "Cat median" of type "category" on "grader" page And I choose "Edit category" in the open action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" And I expand all fieldsets And I should not see "Weight adjusted" And I should not see "Weight" in the "#id_headerparent" "css_element" And I should not see "Extra credit" And I press "Cancel" And I click on grade item menu "Cat min" of type "category" on "grader" page And I choose "Edit category" in the open action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" And I expand all fieldsets And I should not see "Weight adjusted" And I should not see "Weight" in the "#id_headerparent" "css_element" And I should not see "Extra credit" And I press "Cancel" And I click on grade item menu "Cat natural &" of type "category" on "grader" page And I choose "Edit category" in the open action menu And I set the field "Aggregation" to "Mean of grades" And I click on "Save" "button" in the "Edit category" "dialogue" And I wait until the page is ready And I click on grade item menu "Item b1" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And I should not see "Weight adjusted" And I should not see "Weight" And I should not see "Extra credit" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item b1" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And I should not see "Weight adjusted" And I should not see "Weight" And I should not see "Extra credit" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item b3" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And I should not see "Weight adjusted" And I should not see "Weight" And I should not see "Extra credit" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item b4" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And I should not see "Weight adjusted" And I should not see "Weight" And I should not see "Extra credit" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" # Switching back. And I click on grade item menu "Course 1" of type "course" on "grader" page And I choose "Edit category" in the open action menu And I set the field "Aggregation" to "Natural" And I click on "Save" "button" in the "Edit category" "dialogue" And I wait until the page is ready And I click on grade item menu "Item a1" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Weight adjusted" matches value "0" And the field "Extra credit" matches value "0" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item a2" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Weight adjusted" matches value "0" And the field "Extra credit" matches value "0" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item a3" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Weight adjusted" matches value "0" And the field "Extra credit" matches value "0" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item a4" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Weight adjusted" matches value "0" And the field "Extra credit" matches value "0" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Cat mean" of type "category" on "grader" page And I choose "Edit category" in the open action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" And I expand all fieldsets And the field "Weight adjusted" matches value "0" And the field "Extra credit" matches value "0" And I press "Cancel" And I click on grade item menu "Cat median" of type "category" on "grader" page And I choose "Edit category" in the open action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" And I expand all fieldsets And the field "Weight adjusted" matches value "0" And the field "Extra credit" matches value "0" And I press "Cancel" And I click on grade item menu "Cat min" of type "category" on "grader" page And I choose "Edit category" in the open action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" And I expand all fieldsets And the field "Weight adjusted" matches value "0" And the field "Extra credit" matches value "0" And I press "Cancel" And I click on grade item menu "Cat natural &" of type "category" on "grader" page And I choose "Edit category" in the open action menu And I set the field "Aggregation" to "Natural" And I click on "Save" "button" in the "Edit category" "dialogue" And I wait until the page is ready And I click on grade item menu "Item b1" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Weight adjusted" matches value "0" And the field "Extra credit" matches value "0" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item b2" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Weight adjusted" matches value "0" And the field "Extra credit" matches value "0" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item b3" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Weight adjusted" matches value "0" And the field "Extra credit" matches value "0" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item b4" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Weight adjusted" matches value "0" And the field "Extra credit" matches value "0" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" Scenario: Switching a category from Natural aggregation to Weighted mean of grades and back Given I click on grade item menu "Course 1" of type "course" on "grader" page And I choose "Edit category" in the open action menu And I set the field "Aggregation" to "Weighted mean of grades" And I click on "Save" "button" in the "Edit category" "dialogue" And I wait until the page is ready And I click on grade item menu "Item a1" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu Then I should not see "Weight adjusted" And I should not see "Extra credit" And the field "Item weight" matches value "1" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item a2" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And I should not see "Weight adjusted" And I should not see "Extra credit" And the field "Item weight" matches value "1" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item a3" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And I should not see "Weight adjusted" And I should not see "Extra credit" And the field "Item weight" matches value "1" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item a4" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And I should not see "Weight adjusted" And I should not see "Extra credit" And the field "Item weight" matches value "1" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Cat mean" of type "category" on "grader" page And I choose "Edit category" in the open action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" And I expand all fieldsets And I should not see "Weight adjusted" And I should not see "Extra credit" And the field "Item weight" matches value "1" And I press "Cancel" And I click on grade item menu "Cat median" of type "category" on "grader" page And I choose "Edit category" in the open action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" And I expand all fieldsets And I should not see "Weight adjusted" And I should not see "Extra credit" And the field "Item weight" matches value "1" And I press "Cancel" And I click on grade item menu "Cat min" of type "category" on "grader" page And I choose "Edit category" in the open action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" And I expand all fieldsets And I should not see "Weight adjusted" And I should not see "Extra credit" And the field "Item weight" matches value "1" And I press "Cancel" And I click on grade item menu "Cat natural &" of type "category" on "grader" page And I choose "Edit category" in the open action menu And I set the field "Aggregation" to "Weighted mean of grades" And I click on "Save" "button" in the "Edit category" "dialogue" And I wait until the page is ready And I click on grade item menu "Item b1" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And I should not see "Weight adjusted" And I should not see "Extra credit" And the field "Item weight" matches value "1" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item b2" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And I should not see "Weight adjusted" And I should not see "Extra credit" And the field "Item weight" matches value "1" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item b3" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And I should not see "Weight adjusted" And I should not see "Extra credit" And the field "Item weight" matches value "1" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item b4" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And I should not see "Weight adjusted" And I should not see "Extra credit" And the field "Item weight" matches value "1" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" # Switching back. And I click on grade item menu "Course 1" of type "course" on "grader" page And I choose "Edit category" in the open action menu And I set the field "Aggregation" to "Natural" And I click on "Save" "button" in the "Edit category" "dialogue" And I wait until the page is ready And I click on grade item menu "Item a1" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Weight adjusted" matches value "0" And the field "Extra credit" matches value "0" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item a2" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Weight adjusted" matches value "0" And the field "Extra credit" matches value "0" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item a3" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Weight adjusted" matches value "0" And the field "Extra credit" matches value "0" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item a4" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Weight adjusted" matches value "0" And the field "Extra credit" matches value "0" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Cat mean" of type "category" on "grader" page And I choose "Edit category" in the open action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" And I expand all fieldsets And the field "Weight adjusted" matches value "0" And the field "Extra credit" matches value "0" And I press "Cancel" And I click on grade item menu "Cat median" of type "category" on "grader" page And I choose "Edit category" in the open action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" And I expand all fieldsets And the field "Weight adjusted" matches value "0" And the field "Extra credit" matches value "0" And I press "Cancel" And I click on grade item menu "Cat min" of type "category" on "grader" page And I choose "Edit category" in the open action menu And I click on "Show more..." "link" in the ".modal-dialog" "css_element" And I expand all fieldsets And the field "Weight adjusted" matches value "0" And the field "Extra credit" matches value "0" And I press "Cancel" And I click on grade item menu "Cat natural &" of type "category" on "grader" page And I choose "Edit category" in the open action menu And I set the field "Aggregation" to "Natural" And I click on "Save" "button" in the "Edit category" "dialogue" And I wait until the page is ready And I click on grade item menu "Item b1" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Weight adjusted" matches value "0" And the field "Extra credit" matches value "0" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item b2" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Weight adjusted" matches value "0" And the field "Extra credit" matches value "0" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item b3" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Weight adjusted" matches value "0" And the field "Extra credit" matches value "0" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item b4" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Weight adjusted" matches value "0" And the field "Extra credit" matches value "0" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" Scenario: Switching grade items between categories # Move to same aggregation (Natural). Given I navigate to "Setup > Gradebook setup" in the course gradebook And I set the field "Select Item a1" to "1" And I set the field "Select Item a2" to "1" And I set the field "Select Item a3" to "1" And I set the field "Select Item a4" to "1" And I click on "Move" "button" in the "sticky-footer" "region" And I click on "Cat natural &" "list_item" in the "Move items" "dialogue" When I click on "Move" "button" in the "Move items" "dialogue" And I navigate to "View > Grader report" in the course gradebook And I click on grade item menu "Item a1" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu Then the field "Weight adjusted" matches value "0" And the field "Extra credit" matches value "0" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item a2" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Weight adjusted" matches value "1" And the field "Weight" matches value "40.0" And the field "Extra credit" matches value "0" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item a3" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Weight adjusted" matches value "1" And the field "Weight" matches value "10.0" And the field "Extra credit" matches value "1" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item a4" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Weight adjusted" matches value "0" And the field "Extra credit" matches value "1" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" # Move to Mean of grades (with extra credit). And I navigate to "Setup > Gradebook setup" in the course gradebook And I set the field "Select Item a1" to "1" And I set the field "Select Item a2" to "1" And I set the field "Select Item a3" to "1" And I set the field "Select Item a4" to "1" And I click on "Move" "button" in the "sticky-footer" "region" And I click on "Cat ec" "list_item" in the "Move items" "dialogue" And I click on "Move" "button" in the "Move items" "dialogue" And I navigate to "View > Grader report" in the course gradebook And I click on grade item menu "Item a1" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Extra credit" matches value "0" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item a2" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Extra credit" matches value "0" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item a3" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Extra credit" matches value "1" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item a4" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Extra credit" matches value "1" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" # Move to Simple weight mean of grades. And I navigate to "Setup > Gradebook setup" in the course gradebook And I set the field "Select Item a1" to "1" And I set the field "Select Item a2" to "1" And I set the field "Select Item a3" to "1" And I set the field "Select Item a4" to "1" And I click on "Move" "button" in the "sticky-footer" "region" And I click on "Cat simple" "list_item" in the "Move items" "dialogue" And I click on "Move" "button" in the "Move items" "dialogue" And I navigate to "View > Grader report" in the course gradebook And I click on grade item menu "Item a1" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Extra credit" matches value "0" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item a2" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Extra credit" matches value "0" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item a3" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Extra credit" matches value "1" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item a4" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Extra credit" matches value "1" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" # Move to Weighted mean of grades. And I navigate to "Setup > Gradebook setup" in the course gradebook And I set the field "Select Item a1" to "1" And I set the field "Select Item a2" to "1" And I set the field "Select Item a3" to "1" And I set the field "Select Item a4" to "1" And I click on "Move" "button" in the "sticky-footer" "region" And I click on "Cat weighted" "list_item" in the "Move items" "dialogue" And I click on "Move" "button" in the "Move items" "dialogue" And I navigate to "View > Grader report" in the course gradebook And I click on grade item menu "Item a1" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Item weight" matches value "1" And I set the field "Item weight" to "2" And I click on "Save" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item a2" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Item weight" matches value "1" And I set the field "Item weight" to "5" And I click on "Save" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item a3" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Item weight" matches value "1" And I set the field "Item weight" to "8" And I click on "Save" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item a4" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Item weight" matches value "1" And I set the field "Item weight" to "11" And I click on "Save" "button" in the "Edit grade item" "dialogue" # Move to same (Weighted mean of grades). And I navigate to "Setup > Gradebook setup" in the course gradebook And I set the field "Select Item a1" to "1" And I set the field "Select Item a2" to "1" And I set the field "Select Item a3" to "1" And I set the field "Select Item a4" to "1" And I click on "Move" "button" in the "sticky-footer" "region" And I click on "Cat weighted2" "list_item" in the "Move items" "dialogue" And I click on "Move" "button" in the "Move items" "dialogue" And I wait "2" seconds And I navigate to "View > Grader report" in the course gradebook And I click on grade item menu "Item a1" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Item weight" matches value "2" And I click on "Save" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item a2" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Item weight" matches value "5" And I click on "Save" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item a3" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Item weight" matches value "8" And I click on "Save" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item a4" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Item weight" matches value "11" And I click on "Save" "button" in the "Edit grade item" "dialogue" # Move back to Natural. And I navigate to "Setup > Gradebook setup" in the course gradebook And I set the field "Select Item a1" to "1" And I set the field "Select Item a2" to "1" And I set the field "Select Item a3" to "1" And I set the field "Select Item a4" to "1" And I click on "Move" "button" in the "sticky-footer" "region" And I click on "Cat natural &" "list_item" in the "Move items" "dialogue" And I click on "Move" "button" in the "Move items" "dialogue" And I navigate to "View > Grader report" in the course gradebook And I click on grade item menu "Item a1" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Weight adjusted" matches value "0" And the field "Extra credit" matches value "0" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item a2" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Weight adjusted" matches value "0" And the field "Extra credit" matches value "0" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item a3" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Weight adjusted" matches value "0" And the field "Extra credit" matches value "0" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" And I click on grade item menu "Item a4" of type "gradeitem" on "grader" page And I choose "Edit grade item" in the open action menu And the field "Weight adjusted" matches value "0" And the field "Extra credit" matches value "0" And I click on "Cancel" "button" in the "Edit grade item" "dialogue" tests/behat/grade_natural_exclude_empty.feature 0000604 00000050307 15062070557 0016115 0 ustar 00 @core @core_grades Feature: Weights in natural aggregation are adjusted if the items are excluded from user report In order to correctly display user report As a teacher I need to be able to exclude hidden grades. Background: Given the following "courses" exist: | fullname | shortname | category | groupmode | | Course 1 | C1 | 0 | 1 | And the following "users" exist: | username | firstname | lastname | email | idnumber | | teacher1 | Teacher | 1 | teacher1@example.com | t1 | | student1 | Student | 1 | student1@example.com | s1 | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | And the following "activities" exist: | activity | course | idnumber | name | intro | grade | | assign | C1 | a1 | Test assignment one | x | 100 | | assign | C1 | a2 | Test assignment two | x | 50 | | assign | C1 | a3 | Test assignment three | x | 200 | | assign | C1 | a4 | Test assignment four (extra) | x | 20 | | assign | C1 | a5 | Test assignment five (extra) | x | 10 | And I am on the "Course 1" "grades > gradebook setup" page logged in as "teacher1" And I set the following settings for grade item "Test assignment four (extra)" of type "gradeitem" on "setup" page: | Extra credit | 1 | And I set the following settings for grade item "Test assignment five (extra)" of type "gradeitem" on "setup" page: | Extra credit | 1 | @javascript Scenario: No weights are overridden and student has all grades present When I navigate to "View > Grader report" in the course gradebook And I turn editing mode on And I give the grade "80.00" to the user "Student 1" for the grade item "Test assignment one" And I give the grade "30.00" to the user "Student 1" for the grade item "Test assignment two" And I give the grade "150.00" to the user "Student 1" for the grade item "Test assignment three" And I give the grade "10.00" to the user "Student 1" for the grade item "Test assignment four (extra)" And I give the grade "8.00" to the user "Student 1" for the grade item "Test assignment five (extra)" And I press "Save changes" And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | Test assignment one | 28.57 % | 80.00 | 0–100 | 80.00 % | 22.86 % | | Test assignment two | 14.29 % | 30.00 | 0–50 | 60.00 % | 8.57 % | | Test assignment three | 57.14 % | 150.00 | 0–200 | 75.00 % | 42.86 % | | Test assignment four (extra) | 5.71 %( Extra credit ) | 10.00 | 0–20 | 50.00 % | 2.86 % | | Test assignment five (extra) | 2.86 %( Extra credit ) | 8.00 | 0–10 | 80.00 % | 2.29 % | | Course total | - | 278.00 | 0–350 | 79.43 % | - | And I log out @javascript Scenario: No weights are overridden, student has some grades present When I navigate to "View > Grader report" in the course gradebook And I turn editing mode on And I give the grade "80.00" to the user "Student 1" for the grade item "Test assignment one" And I give the grade "30.00" to the user "Student 1" for the grade item "Test assignment two" And I give the grade "10.00" to the user "Student 1" for the grade item "Test assignment four (extra)" And I give the grade "8.00" to the user "Student 1" for the grade item "Test assignment five (extra)" And I press "Save changes" And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | Test assignment one | 66.67 % | 80.00 | 0–100 | 80.00 % | 53.33 % | | Test assignment two | 33.33 % | 30.00 | 0–50 | 60.00 % | 20.00 % | | Test assignment three | 0.00 %( Empty ) | - | 0–200 | - | 0.00 % | | Test assignment four (extra) | 13.33 %( Extra credit ) | 10.00 | 0–20 | 50.00 % | 6.67 % | | Test assignment five (extra) | 6.67 %( Extra credit ) | 8.00 | 0–10 | 80.00 % | 5.33 % | | Course total | - | 128.00 | 0–150 | 85.33 % | - | And I log out @javascript Scenario: No weights are overridden, student has none grades present except for extra credit When I navigate to "View > Grader report" in the course gradebook And I turn editing mode on And I give the grade "10.00" to the user "Student 1" for the grade item "Test assignment four (extra)" And I give the grade "8.00" to the user "Student 1" for the grade item "Test assignment five (extra)" And I press "Save changes" And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | Test assignment one | 0.00 %( Empty ) | - | 0–100 | - | 0.00 % | | Test assignment two | 0.00 %( Empty ) | - | 0–50 | - | 0.00 % | | Test assignment three | 0.00 %( Empty ) | - | 0–200 | - | 0.00 % | | Test assignment four (extra) | 0.00 %( Extra credit ) | 10.00 | 0–20 | 50.00 % | 0.00 % | | Test assignment five (extra) | 0.00 %( Extra credit ) | 8.00 | 0–10 | 80.00 % | 0.00 % | | Course total | - | 0.00 | 0–0 | | - | And I log out @javascript Scenario: Make sure there are no errors when all items are marked as extra credit And I set the following settings for grade item "Test assignment one" of type "gradeitem" on "setup" page: | Extra credit | 1 | And I set the following settings for grade item "Test assignment two" of type "gradeitem" on "setup" page: | Extra credit | 1 | And I set the following settings for grade item "Test assignment three" of type "gradeitem" on "setup" page: | Extra credit | 1 | When I navigate to "View > Grader report" in the course gradebook And I turn editing mode on And I give the grade "80.00" to the user "Student 1" for the grade item "Test assignment one" And I give the grade "30.00" to the user "Student 1" for the grade item "Test assignment two" And I give the grade "10.00" to the user "Student 1" for the grade item "Test assignment four (extra)" And I give the grade "8.00" to the user "Student 1" for the grade item "Test assignment five (extra)" And I press "Save changes" And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | Test assignment one | 0.00 %( Extra credit ) | 80.00 | 0–100 | 80.00 % | 0.00 % | | Test assignment two | 0.00 %( Extra credit ) | 30.00 | 0–50 | 60.00 % | 0.00 % | | Test assignment three | 0.00 %( Empty ) | - | 0–200 | - | 0.00 % | | Test assignment four (extra) | 0.00 %( Extra credit ) | 10.00 | 0–20 | 50.00 % | 0.00 % | | Test assignment five (extra) | 0.00 %( Extra credit ) | 8.00 | 0–10 | 80.00 % | 0.00 % | | Course total | - | 0.0 | 0–0 | | - | And I log out @javascript Scenario: Weights are overridden and student has all grades present When I set the field "Override weight of Test assignment one" to "1" And I set the field "Weight of Test assignment one" to "50" And I press "Save changes" And I navigate to "View > Grader report" in the course gradebook And I turn editing mode on And I give the grade "80.00" to the user "Student 1" for the grade item "Test assignment one" And I give the grade "30.00" to the user "Student 1" for the grade item "Test assignment two" And I give the grade "150.00" to the user "Student 1" for the grade item "Test assignment three" And I give the grade "10.00" to the user "Student 1" for the grade item "Test assignment four (extra)" And I give the grade "8.00" to the user "Student 1" for the grade item "Test assignment five (extra)" And I press "Save changes" And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | Test assignment one | 50.00 % | 80.00 | 0–100 | 80.00 % | 40.00 % | | Test assignment two | 10.00 % | 30.00 | 0–50 | 60.00 % | 6.00 % | | Test assignment three | 40.00 % | 150.00 | 0–200 | 75.00 % | 30.00 % | | Test assignment four (extra) | 5.71 %( Extra credit ) | 10.00 | 0–20 | 50.00 % | 2.86 % | | Test assignment five (extra) | 2.86 %( Extra credit ) | 8.00 | 0–10 | 80.00 % | 2.29 % | | Course total | - | 284.00 | 0–350 | 81.14 % | - | And I log out @javascript Scenario: Weights are overridden and student has some grades present When I set the field "Override weight of Test assignment one" to "1" And I set the field "Weight of Test assignment one" to "50" And I press "Save changes" And I navigate to "View > Grader report" in the course gradebook And I turn editing mode on And I give the grade "80.00" to the user "Student 1" for the grade item "Test assignment one" And I give the grade "30.00" to the user "Student 1" for the grade item "Test assignment two" And I give the grade "10.00" to the user "Student 1" for the grade item "Test assignment four (extra)" And I give the grade "8.00" to the user "Student 1" for the grade item "Test assignment five (extra)" And I press "Save changes" And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | Test assignment one | 83.33 % | 80.00 | 0–100 | 80.00 % | 66.67 % | | Test assignment two | 16.67 % | 30.00 | 0–50 | 60.00 % | 10.00 % | | Test assignment three | 0.00 %( Empty ) | - | 0–200 | - | 0.00 % | | Test assignment four (extra) | 13.33 %( Extra credit ) | 10.00 | 0–20 | 50.00 % | 6.67 % | | Test assignment five (extra) | 6.67 %( Extra credit ) | 8.00 | 0–10 | 80.00 % | 5.33 % | | Course total | - | 133.00 | 0–150 | 88.67 % | - | And I log out @javascript Scenario: Weights are overridden, student has none grades present except for extra credit When I set the field "Override weight of Test assignment one" to "1" And I set the field "Weight of Test assignment one" to "50" And I press "Save changes" And I navigate to "View > Grader report" in the course gradebook And I turn editing mode on And I give the grade "10.00" to the user "Student 1" for the grade item "Test assignment four (extra)" And I give the grade "8.00" to the user "Student 1" for the grade item "Test assignment five (extra)" And I press "Save changes" And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | Test assignment one | 0.00 %( Empty ) | - | 0–100 | - | 0.00 % | | Test assignment two | 0.00 %( Empty ) | - | 0–50 | - | 0.00 % | | Test assignment three | 0.00 %( Empty ) | - | 0–200 | - | 0.00 % | | Test assignment four (extra) | 0.00 %( Extra credit ) | 10.00 | 0–20 | 50.00 % | 0.00 % | | Test assignment five (extra) | 0.00 %( Extra credit ) | 8.00 | 0–10 | 80.00 % | 0.00 % | | Course total | - | 0.00 | 0–0 | | - | And I log out @javascript Scenario: Weights are overridden, including extra credit, and student has all grades present When I set the field "Override weight of Test assignment one" to "1" And I set the field "Weight of Test assignment one" to "50" And I set the field "Override weight of Test assignment four (extra)" to "1" And I set the field "Weight of Test assignment four (extra)" to "10" And I press "Save changes" And I navigate to "View > Grader report" in the course gradebook And I turn editing mode on And I give the grade "80.00" to the user "Student 1" for the grade item "Test assignment one" And I give the grade "30.00" to the user "Student 1" for the grade item "Test assignment two" And I give the grade "150.00" to the user "Student 1" for the grade item "Test assignment three" And I give the grade "10.00" to the user "Student 1" for the grade item "Test assignment four (extra)" And I give the grade "8.00" to the user "Student 1" for the grade item "Test assignment five (extra)" And I press "Save changes" And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | Test assignment one | 50.00 % | 80.00 | 0–100 | 80.00 % | 40.00 % | | Test assignment two | 10.00 % | 30.00 | 0–50 | 60.00 % | 6.00 % | | Test assignment three | 40.00 % | 150.00 | 0–200 | 75.00 % | 30.00 % | | Test assignment four (extra) | 10.00 %( Extra credit ) | 10.00 | 0–20 | 50.00 % | 5.00 % | | Test assignment five (extra) | 2.86 %( Extra credit ) | 8.00 | 0–10 | 80.00 % | 2.29 % | | Course total | - | 291.50 | 0–350 | 83.29 % | - | And I log out @javascript Scenario: Weights are overridden, including extra credit, and student has some grades present When I set the field "Override weight of Test assignment one" to "1" And I set the field "Weight of Test assignment one" to "50" And I set the field "Override weight of Test assignment four (extra)" to "1" And I set the field "Weight of Test assignment four (extra)" to "10" And I press "Save changes" And I navigate to "View > Grader report" in the course gradebook And I turn editing mode on And I give the grade "80.00" to the user "Student 1" for the grade item "Test assignment one" And I give the grade "30.00" to the user "Student 1" for the grade item "Test assignment two" And I give the grade "10.00" to the user "Student 1" for the grade item "Test assignment four (extra)" And I give the grade "8.00" to the user "Student 1" for the grade item "Test assignment five (extra)" And I press "Save changes" And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | Test assignment one | 83.33 % | 80.00 | 0–100 | 80.00 % | 66.67 % | | Test assignment two | 16.67 % | 30.00 | 0–50 | 60.00 % | 10.00 % | | Test assignment three | 0.00 %( Empty ) | - | 0–200 | - | 0.00 % | | Test assignment four (extra) | 16.67 %( Extra credit ) | 10.00 | 0–20 | 50.00 % | 8.33 % | | Test assignment five (extra) | 6.67 %( Extra credit ) | 8.00 | 0–10 | 80.00 % | 5.33 % | | Course total | - | 135.50 | 0–150 | 90.33 % | - | And I log out @javascript Scenario: Weights are overridden, including extra credit, student has none grades present except for extra credit When I set the field "Override weight of Test assignment one" to "1" And I set the field "Weight of Test assignment one" to "50" And I set the field "Override weight of Test assignment four (extra)" to "1" And I set the field "Weight of Test assignment four (extra)" to "10" And I press "Save changes" And I navigate to "View > Grader report" in the course gradebook And I turn editing mode on And I give the grade "10.00" to the user "Student 1" for the grade item "Test assignment four (extra)" And I give the grade "8.00" to the user "Student 1" for the grade item "Test assignment five (extra)" And I press "Save changes" And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | Test assignment one | 0.00 %( Empty ) | - | 0–100 | - | 0.00 % | | Test assignment two | 0.00 %( Empty ) | - | 0–50 | - | 0.00 % | | Test assignment three | 0.00 %( Empty ) | - | 0–200 | - | 0.00 % | | Test assignment four (extra) | 0.00 %( Extra credit ) | 10.00 | 0–20 | 50.00 % | 0.00 % | | Test assignment five (extra) | 0.00 %( Extra credit ) | 8.00 | 0–10 | 80.00 % | 0.00 % | | Course total | - | 0.00 | 0–0 | | - | And I log out tests/behat/grade_override_letter.feature 0000604 00000030046 15062070557 0014714 0 ustar 00 @core @core_grades @javascript Feature: Grade letters can be overridden In order to test the grade letters functionality As a teacher I override site defaults and alter the grade letters/edit/letter/index.php Background: Given the following "courses" exist: | fullname | shortname | | Course 1 | C1 | And the following "users" exist: | username | firstname | lastname | email | idnumber | | teacher1 | Teacher | 1 | teacher1@example.com | t1 | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | And I log in as "teacher1" And I am on "Course 1" course homepage And I navigate to "More > Grade letters" in the course gradebook And I click on "Edit" "button" Scenario Outline: Grade letters can be completely overridden When I set the following fields to these values: | Override site defaults | 1 | | Grade letter 1 | <l1> | | Letter grade boundary 1| <b1> | | Grade letter 2 | <l2> | | Letter grade boundary 2| <b2> | | Grade letter 3 | <l3> | | Letter grade boundary 3| <b3> | | Grade letter 4 | <l4> | | Letter grade boundary 4| <b4> | | Grade letter 5 | <l5> | | Letter grade boundary 5| <b5> | | Grade letter 6 | <l6> | | Letter grade boundary 6| <b6> | | Grade letter 7 | <l7> | | Letter grade boundary 7| <b7> | | Grade letter 8 | <l8> | | Letter grade boundary 8| <b8> | | Grade letter 9 | <l9> | | Letter grade boundary 9| <b9> | | Grade letter 10 | | | Letter grade boundary 10| | | Grade letter 11 | | | Letter grade boundary 11| | And I press "Save changes" Then I should see "The default grade letters are currently overridden." And the following should exist in the "grade-letters-view" table: | Highest | Lowest | Letter | | <high1> | <low1> | <letter1> | | <high2> | <low2> | <letter2> | | <high3> | <low3> | <letter3> | | <high4> | <low4> | <letter4> | | <high5> | <low5> | <letter5> | | <high6> | <low6> | <letter6> | Examples: | l1 | b1 | l2 | b2 | l3 | b3 | l4 | b4 | l5 | b5 | l6 | b6 | l7 | b7 | l8 | b8 | l9 | b9 | high1 | low1 | letter1 | high2 | low2 | letter2 | high3 | low3 | letter3 | high4 | low4 | letter4 | high5 | low5 | letter5 | high6 | low6 | letter6 | | Z | 95 | Y | 85 | X | 75 | W | 65 | V | 55 | U | 45 | | | | | | | 100.00 % | 95.00 % | Z | 94.99 % | 85.00 % | Y | 84.99 % | 75.00 % | X | 74.99 % | 65.00 % | W | 64.99 % | 55.00 % | V | 54.99 % | 45.00 % | U | | 5 | 100 | 4 | 80 | 3 | 60 | 2 | 40 | 1 | 20 | 0 | 0 | | | | | | | 100.00 % | 100.00 % | 5 | 99.99 % | 80.00 % | 4 | 79.99 % | 60.00 % | 3 | 59.99 % | 40.00 % | 2 | 39.99 % | 20.00 % | 1 | 19.99 % | 0.00 % | 0 | | A | 95.25 | B | 76.75 | C | 50.01 | D | 40 | F | 0.01 | F- | 0 | | | | | | | 100.00 % | 95.25 % | A | 95.24 % | 76.75 % | B | 76.74 % | 50.01 % | C | 50.00 % | 40.00 % | D | 39.99 % | 0.01 % | F | 0.00 % | 0.00 % | F- | | | | | | | | A | 95.25 | B | 76.75 | C | 50.01 | D | 40 | F | 0.01 | F- | 0 | 100.00 % | 95.25 % | A | 95.24 % | 76.75 % | B | 76.74 % | 50.01 % | C | 50.00 % | 40.00 % | D | 39.99 % | 0.01 % | F | 0.00 % | 0.00 % | F- | | | | A | 95.25 | B | 76.75 | C | 50.01 | | | | | D | 40 | F | 0.01 | F- | 0 | 100.00 % | 95.25 % | A | 95.24 % | 76.75 % | B | 76.74 % | 50.01 % | C | 50.00 % | 40.00 % | D | 39.99 % | 0.01 % | F | 0.00 % | 0.00 % | F- | Scenario Outline: Define grade letters with custom decimal separator Given the following "language customisations" exist: | component | stringid | value | | core_langconfig | decsep | <decsep> | When I set the following fields to these values: | Override site defaults | 1 | | Grade letter 1 | <l1> | | Letter grade boundary 1| <b1> | | Grade letter 2 | <l2> | | Letter grade boundary 2| <b2> | | Grade letter 3 | <l3> | | Letter grade boundary 3| <b3> | | Grade letter 4 | | | Letter grade boundary 4| | | Grade letter 5 | | | Letter grade boundary 5| | | Grade letter 6 | | | Letter grade boundary 6| | | Grade letter 7 | | | Letter grade boundary 7| | | Grade letter 8 | | | Letter grade boundary 8| | | Grade letter 9 | | | Letter grade boundary 9| | | Grade letter 10 | | | Letter grade boundary 10| | | Grade letter 11 | | | Letter grade boundary 11| | And I press "Save changes" Then I should see "The default grade letters are currently overridden." And the following should exist in the "grade-letters-view" table: | Highest | Lowest | Letter | | <high1> | <low1> | <l1> | | <high2> | <low2> | <l2> | | <high3> | <low3> | <l3> | Examples: | decsep | l1 | b1 | l2 | b2 | l3 | b3 | high1 | low1 | high2 | low2 | high3 | low3 | | . | A | 88.88 | B | 50.00 | C | 0.00 | 100.00 % | 88.88 % | 88.87 % | 50.00 % | 49.99 % | 0.00 % | | # | A | 88#88 | B | 50#00 | C | 0#00 | 100#00 % | 88#88 % | 88#87 % | 50#00 % | 49#99 % | 0#00 % | Scenario: Define additional grade letters Given I set the field "Override site defaults" to "1" When I press "Add 3 field(s) to form" And I set the following fields to these values: | Grade letter 11 | E | | Letter grade boundary 11 | 50 | | Grade letter 12 | F | | Letter grade boundary 12 | 40 | | Grade letter 13 | G | | Letter grade boundary 13 | 30 | | Grade letter 14 | U | | Letter grade boundary 14 | 0 | And I press "Save changes" Then I should see "The default grade letters are currently overridden." And the following should exist in the "grade-letters-view" table: | Highest | Lowest | Letter | | 100.00 % | 93.00 % | A | | 92.99 % | 90.00 % | A- | | 89.99 % | 87.00 % | B+ | | 86.99 % | 83.00 % | B | | 82.99 % | 80.00 % | B- | | 79.99 % | 77.00 % | C+ | | 76.99 % | 73.00 % | C | | 72.99 % | 70.00 % | C- | | 69.99 % | 67.00 % | D+ | | 66.99 % | 60.00 % | D | | 59.99 % | 50.00 % | E | | 49.99 % | 40.00 % | F | | 39.99 % | 30.00 % | G | | 29.99 % | 0.00 % | U | Scenario: I delete a grade letter Given I set the following fields to these values: | Override site defaults | 1 | | Grade letter 1 | A | | Letter grade boundary 1| 90 | | Grade letter 2 | B | | Letter grade boundary 2| 80 | | Grade letter 3 | C | | Letter grade boundary 3| 50 | | Grade letter 4 | D | | Letter grade boundary 4| 40 | | Grade letter 5 | E | | Letter grade boundary 5| 20 | | Grade letter 6 | F | | Letter grade boundary 6| 0 | | Grade letter 7 | | | Letter grade boundary 7| | | Grade letter 8 | | | Letter grade boundary 8| | | Grade letter 9 | | | Letter grade boundary 9| | | Grade letter 10 | | | Letter grade boundary 10| | | Grade letter 11 | | | Letter grade boundary 11| | And I press "Save changes" And I should see "The default grade letters are currently overridden." And the following should exist in the "grade-letters-view" table: | Highest | Lowest | Letter | | 100.00 % | 90.00 % | A | | 89.99 % | 80.00 % | B | | 79.99 % | 50.00 % | C | | 49.99 % | 40.00 % | D | | 39.99 % | 20.00 % | E | | 19.99 % | 0.00 % | F | When I click on "Edit" "button" And I set the following fields to these values: | Override site defaults | 1 | | Grade letter 1 | A | | Letter grade boundary 1| 90 | | Grade letter 2 | B | | Letter grade boundary 2| 80 | | Grade letter 3 | C | | Letter grade boundary 3| 50 | | Grade letter 4 | D | | Letter grade boundary 4| 40 | | Grade letter 5 | | | Letter grade boundary 5| | | Grade letter 6 | F | | Letter grade boundary 6| 0 | And I press "Save changes" Then I should see "The default grade letters are currently overridden." And the following should exist in the "grade-letters-view" table: | Highest | Lowest | Letter | | 100.00 % | 90.00 % | A | | 89.99 % | 80.00 % | B | | 79.99 % | 50.00 % | C | | 49.99 % | 40.00 % | D | | 39.99 % | 0.00 % | F | Scenario: I override grade letters for a second time Given I set the following fields to these values: | Override site defaults | 1 | | Grade letter 1 | A+ | | Letter grade boundary 1| 90 | | Grade letter 2 | A | | Letter grade boundary 2| 80 | | Grade letter 3 | B+ | | Letter grade boundary 3| 70 | | Grade letter 4 | B | | Letter grade boundary 4| 60 | | Grade letter 5 | C | | Letter grade boundary 5| 50 | | Grade letter 6 | D | | Letter grade boundary 6| 40 | | Grade letter 7 | F | | Letter grade boundary 7| 0 | | Grade letter 8 | | | Letter grade boundary 8| | | Grade letter 9 | | | Letter grade boundary 9| | | Grade letter 10 | | | Letter grade boundary 10| | | Grade letter 11 | | | Letter grade boundary 11| | And I press "Save changes" And I should see "The default grade letters are currently overridden." And the following should exist in the "grade-letters-view" table: | Highest | Lowest | Letter | | 100.00 % | 90.00 % | A+ | | 89.99 % | 80.00 % | A | | 79.99 % | 70.00 % | B+ | | 69.99 % | 60.00 % | B | | 59.99 % | 50.00 % | C | | 49.99 % | 40.00 % | D | | 39.99 % | 0.00 % | F | When I click on "Edit" "button" And I set the following fields to these values: | Override site defaults | 1 | | Grade letter 1 | α | | Letter grade boundary 1| 95 | | Grade letter 2 | β | | Letter grade boundary 2| 85 | | Grade letter 3 | γ | | Letter grade boundary 3| 70 | | Grade letter 4 | δ | | Letter grade boundary 4| 55 | | Grade letter 5 | | | Letter grade boundary 5| | | Grade letter 6 | Ω | | Letter grade boundary 6| 0 | | Grade letter 7 | π | | Letter grade boundary 7| 90 | And I press "Save changes" Then I should see "The default grade letters are currently overridden." And the following should exist in the "grade-letters-view" table: | Highest | Lowest | Letter | | 100.00 % | 95.00 % | α | | 94.99 % | 90.00 % | π | | 89.99 % | 85.00 % | β | | 84.99 % | 70.00 % | γ | | 69.99 % | 55.00 % | δ | | 54.99 % | 0.00 % | Ω | tests/behat/grade_minmax.feature 0000604 00000026755 15062070557 0013023 0 ustar 00 @core @core_grades @javascript Feature: We can choose what min or max grade to use when aggregating grades. In order to what min or max grade to use As an teacher I can update modify a course setting Scenario: Changing the min or max grade to use updates the grades accordingly Given the following "courses" exist: | fullname | shortname | category | groupmode | | C1 | C1 | 0 | 1 | And the following "users" exist: | username | firstname | lastname | email | idnumber | | teacher1 | Teacher | 1 | teacher1@example.com | t1 | | student1 | Student | 1 | student1@example.com | s1 | | student2 | Student | 2 | student2@example.com | s2 | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | | student2 | C1 | student | And the following "grade categories" exist: | fullname | course | | CAT1 | C1 | And I log in as "admin" And I set the following administration settings values: | grade_minmaxtouse | Min and max grades as specified in grade item settings | And I am on the "C1" "grades > gradebook setup" page And I choose the "Add grade item" item in the "Add" action menu And I set the following fields to these values: | Item name | MI 1 | | Grade category | C1 | And I click on "Save" "button" in the "New grade item" "dialogue" And I choose the "Add grade item" item in the "Add" action menu And I set the following fields to these values: | Item name | MI 2 | | Grade category | C1 | And I click on "Save" "button" in the "New grade item" "dialogue" And I choose the "Add grade item" item in the "Add" action menu And I set the following fields to these values: | Item name | MI 3 | | Grade category | CAT1 | And I click on "Save" "button" in the "New grade item" "dialogue" And I choose the "Add grade item" item in the "Add" action menu And I set the following fields to these values: | Item name | MI 4 | | Grade category | CAT1 | And I click on "Save" "button" in the "New grade item" "dialogue" And I choose the "Add grade item" item in the "Add" action menu And I set the following fields to these values: | Item name | MI 5 | | Grade category | C1 | And I click on "Save" "button" in the "New grade item" "dialogue" And I set "=[[mi1]]+[[mi2]]+[[mi3]]" calculation for grade item "MI 5" with idnumbers: | MI 1 | mi1 | | MI 2 | mi2 | | MI 3 | mi3 | And I navigate to "Setup > Course grade settings" in the course gradebook And I set the field "Min and max grades used in calculation" to "Default (Min and max grades as specified in grade item settings)" And I set the field "Show weightings" to "Show" And I set the field "Show contribution to course total" to "Show" And I press "Save changes" And I navigate to "Setup > Gradebook setup" in the course gradebook And I set the following settings for grade item "CAT1" of type "category" on "setup" page: | Aggregation | Natural | And I am on the "C1" "grades > Grader report > View" page logged in as "teacher1" And I turn editing mode on And I give the grade "75.00" to the user "Student 1" for the grade item "MI 1" And I give the grade "25.00" to the user "Student 1" for the grade item "MI 2" And I give the grade "50.00" to the user "Student 1" for the grade item "MI 3" And I give the grade "100.00" to the user "Student 1" for the grade item "MI 4" And I give the grade "20.00" to the user "Student 2" for the grade item "MI 1" And I give the grade "10.00" to the user "Student 2" for the grade item "MI 3" And I press "Save changes" And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget And the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | MI 1 | 20.00 % | 75.00 | 0–100 | 75.00 % | 15.00 % | | MI 2 | 20.00 % | 25.00 | 0–100 | 25.00 % | 5.00 % | | MI 3 | 50.00 % | 50.00 | 0–100 | 50.00 % | 10.00 % | | MI 4 | 50.00 % | 100.00 | 0–100 | 100.00 % | 20.00 % | | MI 5 | 20.00 % | 100.00 | 0–100 | 100.00 % | 20.00 % | | CAT1 total | 40.00 % | 150.00 | 0–200 | 75.00 % | - | | Course total | - | 350.00 | 0–500 | 70.00 % | - | And I click on "Student 2" in the "user" search widget And the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | MI 1 | 33.33 % | 20.00 | 0–100 | 20.00 % | 6.67 % | | MI 2 | 0.00 % | - | 0–100 | - | 0.00 % | | MI 3 | 100.00 % | 10.00 | 0–100 | 10.00 % | 3.33 % | | MI 4 | 0.00 % | - | 0–100 | - | 0.00 % | | MI 5 | 33.33 % | 30.00 | 0–100 | 30.00 % | 10.00 % | | CAT1 total | 33.33 % | 10.00 | 0–100 | 10.00 % | - | | Course total | - | 60.00 | 0–300 | 20.00 % | - | And I navigate to "Setup > Gradebook setup" in the course gradebook And I set the following settings for grade item "MI 1" of type "gradeitem" on "setup" page: | Rescale existing grades | No | | Maximum grade | 50.00 | | Minimum grade | 5.00 | And I set the following settings for grade item "MI 3" of type "gradeitem" on "setup" page: | Rescale existing grades | No | | Maximum grade | 50.00 | | Minimum grade | 5.00 | And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget And the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | MI 1 | 12.50 % | 75.00 | 5–50 | 100.00 % | 18.75 % | | MI 2 | 25.00 % | 25.00 | 0–100 | 25.00 % | 6.25 % | | MI 3 | 33.33 % | 50.00 | 5–50 | 100.00 % | 12.50 % | | MI 4 | 66.67 % | 100.00 | 0–100 | 100.00 % | 25.00 % | | MI 5 | 25.00 % | 100.00 | 0–100 | 100.00 % | 25.00 % | | CAT1 total | 37.50 % | 150.00 | 0–150 | 100.00 % | - | | Course total | - | 350.00 | 0–400 | 87.50 % | - | And I click on "Student 2" in the "user" search widget And the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | MI 1 | 25.00 % | 20.00 | 5–50 | 33.33 % | 10.00 % | | MI 2 | 0.00 % | - | 0–100 | - | 0.00 % | | MI 3 | 100.00 % | 10.00 | 5–50 | 11.11 % | 5.00 % | | MI 4 | 0.00 % | - | 0–100 | - | 0.00 % | | MI 5 | 50.00 % | 30.00 | 0–100 | 30.00 % | 15.00 % | | CAT1 total | 25.00 % | 10.00 | 0–50 | 20.00 % | - | | Course total | - | 60.00 | 0–200 | 30.00 % | - | And I navigate to "Setup > Gradebook setup" in the course gradebook And I set the following settings for grade item "MI 5" of type "gradeitem" on "setup" page: | Rescale existing grades | No | | Maximum grade | 200.00 | And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget And the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | MI 5 | 40.00 % | 150.00 | 0–200 | 75.00 % | 30.00 % | | Course total | - | 400.00 | 0–500 | 80.00 % | - | And I click on "Student 2" in the "user" search widget And the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | MI 5 | 66.67 % | 30.00 | 0–200 | 15.00 % | 10.00 % | | Course total | - | 60.00 | 0–300 | 20.00 % | - | And I navigate to "Setup > Course grade settings" in the course gradebook When I set the field "Min and max grades used in calculation" to "Initial min and max grades" And I press "Save changes" And I navigate to "View > User report" in the course gradebook And I click on "Student 1" in the "user" search widget Then the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | MI 1 | 16.67 % | 75.00 | 0–100 | 75.00 % | 12.50 % | | MI 2 | 16.67 % | 25.00 | 0–100 | 25.00 % | 4.17 % | | MI 3 | 50.00 % | 50.00 | 0–100 | 50.00 % | 8.33 % | | MI 4 | 50.00 % | 100.00 | 0–100 | 100.00 % | 16.67 % | | MI 5 | 33.33 % | 150.00 | 0–200 | 75.00 % | 25.00 % | | CAT1 total | 33.33 % | 150.00 | 0–200 | 75.00 % | - | | Course total | - | 400.00 | 0–600 | 66.67 % | - | And I click on "Student 2" in the "user" search widget And the following should exist in the "user-grade" table: | Grade item | Calculated weight | Grade | Range | Percentage | Contribution to course total | | MI 1 | 25.00 % | 20.00 | 0–100 | 20.00 % | 5.00 % | | MI 2 | 0.00 % | - | 0–100 | - | 0.00 % | | MI 3 | 100.00 % | 10.00 | 0–100 | 10.00 % | 2.50 % | | MI 4 | 0.00 % | - | 0–100 | - | 0.00 % | | MI 5 | 50.00 % | 30.00 | 0–200 | 15.00 % | 7.50 % | | CAT1 total | 25.00 % | 10.00 | 0–100 | 10.00 % | - | | Course total | - | 60.00 | 0–400 | 15.00 % | - | tests/output/general_action_bar_test.php 0000604 00000030314 15062070557 0014620 0 ustar 00 <?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/>. namespace core_grades\output; use advanced_testcase; use grade_helper; use context_course; use moodle_url; /** * A test class used to test general_action_bar. * * @package core_grades * @copyright 2021 Mihail Geshoski <mihail@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class general_action_bar_test extends advanced_testcase { /** * Load required test libraries */ public static function setUpBeforeClass(): void { global $CFG; require_once("{$CFG->dirroot}/grade/lib.php"); } /** * Search array $options for an element which is an array containing 'name' => $name. * * @param array $options the array of options. * @param string $name the name to find. * @return array|null the particular option if found, else null. */ protected function find_option_by_name(array $options, string $name): ?array { foreach ($options as $option) { if ($option['name'] == $name) { return $option; } } return null; } /** * Test the exported data for the general action bar for different user roles and settings. * * @dataProvider export_for_template_provider * @param string $userrole The user role to test * @param bool $enableoutcomes Whether to enable outcomes * @param array $expectedoptions The expected options returned in the general action selector * @covers \core_grades\output\general_action_bar::export_for_template */ public function test_export_for_template(string $userrole, bool $enableoutcomes, array $expectedoptions): void { global $PAGE; // There may be additional plugins installed in the codebase where this // test is being run, therefore, we need to know which links can be // present in a standard Moodle install, and only check them. $allcorenavlinks = [ get_string('view') => [ get_string('pluginname', 'gradereport_grader'), get_string('pluginname', 'gradereport_history'), get_string('pluginname', 'gradereport_outcomes'), get_string('pluginname', 'gradereport_overview'), get_string('pluginname', 'gradereport_singleview'), get_string('pluginname', 'gradereport_summary'), get_string('pluginname', 'gradereport_user'), ], get_string('setup', 'grades') => [ get_string('gradebooksetup', 'grades'), get_string('coursegradesettings', 'grades'), get_string('preferences', 'grades') . ': ' . get_string('pluginname', 'gradereport_grader'), ], get_string('moremenu') => [ get_string('scales'), get_string('outcomes', 'grades'), get_string('gradeletters', 'grades'), get_string('import', 'grades'), get_string('export', 'grades'), ], ]; $this->resetAfterTest(); // Reset the cache. grade_helper::reset_caches(); // Create a course. $course = $this->getDataGenerator()->create_course(); $coursecontext = context_course::instance($course->id); if ($userrole === 'admin') { $this->setAdminUser(); } else { // Enrol user to the course. $user = $this->getDataGenerator()->create_and_enrol($course, $userrole); $this->setUser($user); } if ($enableoutcomes) { set_config('enableoutcomes', 1); } $generalactionbar = new general_action_bar($coursecontext, new moodle_url('/grade/report/user/index.php', ['id' => $course->id]), 'report', 'user'); $renderer = $PAGE->get_renderer('core'); $generalactionbardata = $generalactionbar->export_for_template($renderer); $this->assertCount(1, $generalactionbardata); $this->assertArrayHasKey('generalnavselector', $generalactionbardata); $generalnavselector = $generalactionbardata['generalnavselector']; // Assert that the right links are present in each group. foreach ($allcorenavlinks as $groupname => $corelinks) { $actualgroup = $this->find_option_by_name($generalnavselector->options, $groupname); if (!isset($expectedoptions[$groupname])) { // This group should not be present. $this->assertNull($actualgroup, "Nav link group '$groupname' should not be present, but is."); continue; } $this->assertNotNull($actualgroup, "Nav link group '$groupname' should be present, but is not."); $this->assertTrue($actualgroup['isgroup'], "the thing claiming to be nav link group '$groupname' is not a group."); foreach ($corelinks as $corelinkname) { $actuallink = $this->find_option_by_name($actualgroup['options'], $corelinkname); if (!in_array($corelinkname, $expectedoptions[$groupname])) { $this->assertNull($actuallink, "Nav link '$corelinkname' should not be present in group '$groupname', but is."); } else { $this->assertNotNull($actuallink, "Nav link '$corelinkname' should be present in group '$groupname', but is not."); } } } } /** * Data provider for the test_export_for_template test. * * @return array */ public function export_for_template_provider(): array { $graderpluginname = get_string('pluginname', 'gradereport_grader'); $historypluginname = get_string('pluginname', 'gradereport_history'); $outcomespluginname = get_string('pluginname', 'gradereport_outcomes'); $overviewpluginname = get_string('pluginname', 'gradereport_overview'); $singleviewpluginname = get_string('pluginname', 'gradereport_singleview'); $summarypluginname = get_string('pluginname', 'gradereport_summary'); $userpluginname = get_string('pluginname', 'gradereport_user'); $viewstr = get_string('view'); $setupstr = get_string('setup', 'grades'); $morestr = get_string('moremenu'); $gradebooksetupstr = get_string('gradebooksetup', 'grades'); $coursegradesettingsstr = get_string('coursegradesettings', 'grades'); $graderpreferencesstr = get_string('preferences', 'grades') . ': ' . get_string('pluginname', 'gradereport_grader'); $scalesstr = get_string('scales'); $outcomesstr = get_string('outcomes', 'grades'); $gradelettersstr = get_string('gradeletters', 'grades'); $importstr = get_string('import', 'grades'); $exportstr = get_string('export', 'grades'); return [ 'Gradebook general navigation for admin; outcomes disabled.' => [ 'admin', false, [ $viewstr => [ $graderpluginname, $historypluginname, $overviewpluginname, $singleviewpluginname, $summarypluginname, $userpluginname, ], $setupstr => [ $gradebooksetupstr, $coursegradesettingsstr, $graderpreferencesstr, ], $morestr => [ $scalesstr, $gradelettersstr, $importstr, $exportstr, ], ], ], 'Gradebook general navigation for admin; outcomes enabled.' => [ 'admin', true, [ $viewstr => [ $graderpluginname, $historypluginname, $outcomespluginname, $overviewpluginname, $singleviewpluginname, $summarypluginname, $userpluginname, ], $setupstr => [ $gradebooksetupstr, $coursegradesettingsstr, $graderpreferencesstr, ], $morestr => [ $scalesstr, $outcomesstr, $gradelettersstr, $importstr, $exportstr, ], ], ], 'Gradebook general navigation for editing teacher; outcomes disabled.' => [ 'editingteacher', false, [ $viewstr => [ $graderpluginname, $historypluginname, $overviewpluginname, $singleviewpluginname, $summarypluginname, $userpluginname, ], $setupstr => [ $gradebooksetupstr, $coursegradesettingsstr, $graderpreferencesstr, ], $morestr => [ $scalesstr, $gradelettersstr, $importstr, $exportstr, ], ], ], 'Gradebook general navigation for editing teacher; outcomes enabled.' => [ 'editingteacher', true, [ $viewstr => [ $graderpluginname, $historypluginname, $outcomespluginname, $overviewpluginname, $singleviewpluginname, $summarypluginname, $userpluginname, ], $setupstr => [ $gradebooksetupstr, $coursegradesettingsstr, $graderpreferencesstr, ], $morestr => [ $scalesstr, $outcomesstr, $gradelettersstr, $importstr, $exportstr, ], ], ], 'Gradebook general navigation for non-editing teacher; outcomes enabled.' => [ 'teacher', true, [ $viewstr => [ $graderpluginname, $historypluginname, $outcomespluginname, $overviewpluginname, $summarypluginname, $userpluginname, ], $setupstr => [ $graderpreferencesstr, ], $morestr => [ $exportstr, ], ], ], 'Gradebook general navigation for student; outcomes enabled.' => [ 'student', true, [ $viewstr => [ $overviewpluginname, $userpluginname, ], ], ], ]; } } tests/component_gradeitems_test.php 0000604 00000061331 15062070557 0013673 0 ustar 00 <?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/>. /** * Unit tests for core_grades\component_gradeitems; * * @package core_grades * @category test * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU Public License */ declare(strict_types = 1); namespace core_grades { use advanced_testcase; use core_grades\component_gradeitems; use coding_exception; /** * Unit tests for core_grades\component_gradeitems; * * @package core_grades * @category test * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class component_gradeitems_test extends advanced_testcase { /** * Ensure that a component which does not implement the mapping class excepts. */ public function test_get_itemname_mapping_for_component_does_not_exist(): void { $mappings = component_gradeitems::get_itemname_mapping_for_component('invalid_component'); $this->assertIsArray($mappings); $this->assertCount(1, $mappings); $this->assertArrayHasKey(0, $mappings); } /** * Ensure that a component which does not implement the mapping class correctly excepts. */ public function test_get_itemname_mapping_for_valid_component_invalid_mapping(): void { $this->expectException(coding_exception::class); component_gradeitems::get_itemname_mapping_for_component('tests\core_grades\component_gradeitems\invalid'); } /** * Ensure that a component which implements the mapping class correctly eets the correct set of mappings. */ public function test_get_itemname_mapping_for_valid_component_valid_mapping(): void { $mapping = component_gradeitems::get_itemname_mapping_for_component('tests\core_grades\component_gradeitems\valid'); $this->assertIsArray($mapping); $this->assertEquals([ 0 => 'rating', 1 => 'someother', ], $mapping); } /** * Data provider for is_valid_itemname tests. * * @return array */ public function is_valid_itemname_provider(): array { return [ 'valid' => [ 'someother', true, ], 'validnotadvanced' => [ 'rating', true, ], 'invalid' => [ 'doesnotexist', false, ], ]; } /** * Ensure that a component implementing advanced grading returns the correct areas. * * @dataProvider is_valid_itemname_provider * @param string $itemname * @param bool $isadvanced */ public function test_is_valid_itemname(string $itemname, bool $isadvanced): void { $this->assertEquals( $isadvanced, component_gradeitems::is_valid_itemname('tests\core_grades\component_gradeitems\valid_and_advanced', $itemname) ); } /** * Ensure that a component which does not implement the advancedgrading interface returns this. */ public function test_defines_advancedgrading_itemnames_for_component_does_not_exist(): void { $this->assertFalse(component_gradeitems::defines_advancedgrading_itemnames_for_component('invalid_component')); } /** * Ensure that a component which does not implement the advancedgrading interface returns this. */ public function test_defines_advancedgrading_itemnames_for_component_no_interfaces(): void { $this->assertFalse(component_gradeitems::defines_advancedgrading_itemnames_for_component('tests\core_grades\component_gradeitems\invalid')); } /** * Ensure that a component which implements the item mapping but not implement the advancedgrading interface returns this. */ public function test_defines_advancedgrading_itemnames_for_component_grading_no_interface(): void { $this->assertFalse(component_gradeitems::defines_advancedgrading_itemnames_for_component('tests\core_grades\component_gradeitems\valid')); } /** * Ensure that a component which implements the item mapping but not implement the advancedgrading interface returns this. */ public function test_defines_advancedgrading_itemnames_for_component_grading_has_interface(): void { $this->assertTrue(component_gradeitems::defines_advancedgrading_itemnames_for_component('tests\core_grades\component_gradeitems\valid_and_advanced')); } /** * Ensure that a component which does not implement the advancedgrading interface returns this. */ public function test_get_advancedgrading_itemnames_for_component_does_not_exist(): void { $this->expectException(coding_exception::class); component_gradeitems::get_advancedgrading_itemnames_for_component('invalid_component'); } /** * Ensure that a component which does not implement the advancedgrading interface returns this. */ public function test_get_advancedgrading_itemnames_for_component_no_interfaces(): void { $this->expectException(coding_exception::class); component_gradeitems::get_advancedgrading_itemnames_for_component('tests\core_grades\component_gradeitems\invalid'); } /** * Ensure that a component which implements the item mapping but not implement the advancedgrading interface returns this. */ public function test_get_advancedgrading_itemnames_for_component_grading_no_interface(): void { $this->expectException(coding_exception::class); component_gradeitems::get_advancedgrading_itemnames_for_component('tests\core_grades\component_gradeitems\valid'); } /** * Ensure that a component implementing advanced grading returns the correct areas. */ public function test_get_advancedgrading_itemnames_for_component(): void { $areas = component_gradeitems::get_advancedgrading_itemnames_for_component('tests\core_grades\component_gradeitems\valid_and_advanced'); $this->assertEquals(['someother'], $areas); } /** * Data provider for is_advancedgrading_itemname tests. * * @return array */ public function is_advancedgrading_itemname_provider(): array { return [ 'valid' => [ 'someother', true, ], 'validnotadvanced' => [ 'rating', false, ], 'invalid' => [ 'doesnotexist', false, ], ]; } /** * Ensure that a component implementing advanced grading returns the correct areas. * * @dataProvider is_advancedgrading_itemname_provider * @param string $itemname * @param bool $isadvanced */ public function test_is_advancedgrading_itemname(string $itemname, bool $isadvanced): void { $this->assertEquals( $isadvanced, component_gradeitems::is_advancedgrading_itemname('tests\core_grades\component_gradeitems\valid_and_advanced', $itemname) ); } /** * Data provider for get_field_name_for_itemnumber. * * @return array */ public function get_field_name_for_itemnumber_provider(): array { return [ 'Valid itemnumber 0 case 1' => [ 0, 'gradecat', 'gradecat', ], 'Valid itemnumber 0 case 2' => [ 0, 'melon', 'melon', ], 'Valid itemnumber 1 case 1' => [ 1, 'gradecat', 'gradecat_someother', ], 'Valid itemnumber 1 case 2' => [ 1, 'melon', 'melon_someother', ], ]; } /** * Ensure that valid field names are correctly mapped for a valid component. * * @dataProvider get_field_name_for_itemnumber_provider * @param int $itemnumber The item itemnumber to test * @param string $fieldname The field name being translated * @param string $expected The expected value */ public function test_get_field_name_for_itemnumber(int $itemnumber, string $fieldname, string $expected): void { $component = 'tests\core_grades\component_gradeitems\valid'; $this->assertEquals($expected, component_gradeitems::get_field_name_for_itemnumber($component, $itemnumber, $fieldname)); } /** * Ensure that an invalid itemnumber does not provide any field name. */ public function test_get_field_name_for_itemnumber_invalid_itemnumber(): void { $component = 'tests\core_grades\component_gradeitems\valid'; $this->expectException(coding_exception::class); component_gradeitems::get_field_name_for_itemnumber($component, 100, 'gradecat'); } /** * Ensure that a component which does not define a mapping can still get a mapping for itemnumber 0. */ public function test_get_field_name_for_itemnumber_component_not_defining_mapping_itemnumber_zero(): void { $component = 'tests\core_grades\othervalid'; $this->assertEquals('gradecat', component_gradeitems::get_field_name_for_itemnumber($component, 0, 'gradecat')); } /** * Ensure that a component which does not define a mapping cannot get a mapping for itemnumber 1+. */ public function test_get_field_name_for_itemnumber_component_not_defining_mapping_itemnumber_nonzero(): void { $component = 'tests\core_grades\othervalid'; $this->expectException(coding_exception::class); component_gradeitems::get_field_name_for_itemnumber($component, 100, 'gradecat'); } /** * Ensure that a component which incorrectly defines a mapping cannot get a mapping for itemnumber 1+. */ public function test_get_field_name_for_itemnumber_component_invalid_mapping_itemnumber_nonzero(): void { $component = 'tests\core_grades\component_gradeitems\invalid'; $this->expectException(coding_exception::class); component_gradeitems::get_field_name_for_itemnumber($component, 100, 'gradecat'); } /** * Data provider for get_field_name_for_itemname. * * @return array */ public function get_field_name_for_itemname_provider(): array { return [ 'Empty itemname empty case 1' => [ '', 'gradecat', 'gradecat', ], 'Empty itemname empty case 2' => [ '', 'melon', 'melon', ], 'First itemname empty case 1' => [ 'rating', 'gradecat', 'gradecat', ], 'First itemname empty case 2' => [ 'rating', 'melon', 'melon', ], 'Other itemname empty case 1' => [ 'someother', 'gradecat', 'gradecat_someother', ], 'Other itemname empty case 2' => [ 'someother', 'melon', 'melon_someother', ], ]; } /** * Ensure that valid field names are correctly mapped for a valid component. * * @dataProvider get_field_name_for_itemname_provider * @param string $itemname The item itemname to test * @param string $fieldname The field name being translated * @param string $expected The expected value */ public function test_get_field_name_for_itemname(string $itemname, string $fieldname, string $expected): void { $component = 'tests\core_grades\component_gradeitems\valid'; $this->assertEquals($expected, component_gradeitems::get_field_name_for_itemname($component, $itemname, $fieldname)); } /** * Ensure that an invalid itemname does not provide any field name. */ public function test_get_field_name_for_itemname_invalid_itemname(): void { $component = 'tests\core_grades\component_gradeitems\valid'; $this->expectException(coding_exception::class); component_gradeitems::get_field_name_for_itemname($component, 'typo', 'gradecat'); } /** * Ensure that an empty itemname provides a matching fieldname regardless of whether the component exists or * not. */ public function test_get_field_name_for_itemname_not_defining_mapping_empty_name(): void { $component = 'tests\core_grades\othervalid'; $this->assertEquals('gradecat', component_gradeitems::get_field_name_for_itemname($component, '', 'gradecat')); } /** * Ensure that an valid component with some itemname excepts. */ public function test_get_field_name_for_itemname_not_defining_mapping_with_name(): void { $component = 'tests\core_grades\othervalid'; $this->expectException(coding_exception::class); component_gradeitems::get_field_name_for_itemname($component, 'example', 'gradecat'); } /** * Ensure that an empty itemname provides a matching fieldname even if the mapping is invalid. */ public function test_get_field_name_for_itemname_invalid_mapping_empty_name(): void { $component = 'tests\core_grades\component_gradeitems\invalid'; $this->assertEquals('gradecat', component_gradeitems::get_field_name_for_itemname($component, '', 'gradecat')); } /** * Ensure that an invalid mapping with some itemname excepts. */ public function test_get_field_name_for_itemname_invalid_mapping_with_name(): void { $component = 'tests\core_grades\component_gradeitems\invalid'; $this->expectException(coding_exception::class); component_gradeitems::get_field_name_for_itemname($component, 'example', 'gradecat'); } /** * Data provider for get_itemname_from_itemnumber. * * @return array */ public function get_itemname_from_itemnumber_provider(): array { return [ 'Valid itemnumber 0' => [ 0, '', ], 'Valid itemnumber 1' => [ 1, 'someother', ], ]; } /** * Ensure that item names are correctly mapped for a valid component. * * @dataProvider get_itemname_from_itemnumber_provider * @param int $itemnumber The item itemnumber to test * @param string $expected The expected value */ public function test_get_itemname_from_itemnumber(int $itemnumber, string $expected): void { $component = 'tests\core_grades\component_gradeitems\valid'; $this->assertEquals($expected, component_gradeitems::get_itemname_from_itemnumber($component, $itemnumber)); } /** * Ensure that an itemnumber over 1000 is treated as itemnumber 0 for the purpose of outcomes. */ public function test_get_itemname_from_itemnumber_outcome_itemnumber(): void { $component = 'tests\core_grades\component_gradeitems\valid'; $this->assertEquals('', component_gradeitems::get_itemname_from_itemnumber($component, 1000)); } /** * Ensure that an invalid itemnumber does not provide any field name. */ public function test_get_itemname_from_itemnumber_invalid_itemnumber(): void { $component = 'tests\core_grades\component_gradeitems\valid'; $this->expectException(coding_exception::class); component_gradeitems::get_itemname_from_itemnumber($component, 100); } /** * Ensure that a component which does not define a mapping can still get a mapping for itemnumber 0. */ public function test_get_itemname_from_itemnumber_component_not_defining_mapping_itemnumber_zero(): void { $component = 'tests\core_grades\othervalid'; $this->assertEquals('', component_gradeitems::get_itemname_from_itemnumber($component, 0)); } /** * Ensure that a component which does not define a mapping cannot get a mapping for itemnumber 1+. */ public function test_get_itemname_from_itemnumber_component_not_defining_mapping_itemnumber_nonzero(): void { $component = 'tests\core_grades\othervalid'; $this->expectException(coding_exception::class); component_gradeitems::get_itemname_from_itemnumber($component, 100); } /** * Ensure that a component which incorrectly defines a mapping cannot get a mapping for itemnumber 1+. */ public function test_get_itemname_from_itemnumber_component_invalid_mapping_itemnumber_nonzero(): void { $component = 'tests\core_grades\component_gradeitems\invalid'; $this->expectException(coding_exception::class); component_gradeitems::get_itemname_from_itemnumber($component, 100); } /** * Data provider for get_itemname_from_itemnumber. * * @return array */ public function get_itemnumber_from_itemname_provider(): array { return [ 'Empty itemname empty' => [ '', 0, ], 'First itemname empty' => [ 'rating', 0, ], 'Other itemname empty' => [ 'someother', 1, ], ]; } /** * Ensure that valid item names are correctly mapped for a valid component. * * @dataProvider get_itemnumber_from_itemname_provider * @param string $itemname The item itemname to test * @param int $expected The expected value */ public function test_get_itemnumber_from_itemname(string $itemname, int $expected): void { $component = 'tests\core_grades\component_gradeitems\valid'; $this->assertEquals($expected, component_gradeitems::get_itemnumber_from_itemname($component, $itemname)); } /** * Ensure that an invalid itemname excepts. */ public function test_get_itemnumber_from_itemname_invalid_itemname(): void { $component = 'tests\core_grades\component_gradeitems\valid'; $this->expectException(coding_exception::class); component_gradeitems::get_itemnumber_from_itemname($component, 'typo'); } /** * Ensure that an empty itemname provides a correct itemnumber regardless of whether the component exists or * not. */ public function test_get_itemnumber_from_itemname_not_defining_mapping_empty_name(): void { $component = 'tests\core_grades\component_gradeitems\othervalid'; $this->assertEquals(0, component_gradeitems::get_itemnumber_from_itemname($component, '')); } /** * Ensure that an valid component with some itemname excepts. */ public function test_get_itemnumber_from_itemname_not_defining_mapping_with_name(): void { $component = 'tests\core_grades\component_gradeitems\othervalid'; $this->expectException(coding_exception::class); component_gradeitems::get_itemnumber_from_itemname($component, 'example'); } /** * Ensure that an empty itemname provides a matching fieldname even if the mapping is invalid. */ public function test_get_itemnumber_from_itemname_invalid_mapping_empty_name(): void { $component = 'tests\core_grades\component_gradeitems\invalid'; $this->assertEquals(0, component_gradeitems::get_itemnumber_from_itemname($component, '')); } /** * Ensure that an invalid mapping with some itemname excepts. */ public function test_get_itemnumber_from_itemname_invalid_mapping_with_name(): void { $component = 'tests\core_grades\component_gradeitems\invalid'; $this->expectException(coding_exception::class); component_gradeitems::get_itemnumber_from_itemname($component, 'example'); } } } namespace tests\core_grades\component_gradeitems\valid\grades { use core_grades\local\gradeitem\itemnumber_mapping; /** * Valid class for testing mappings. * * @package core_grades * @category test * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class gradeitems implements itemnumber_mapping { /** * Get the grade item mapping of item number to item name. * * @return array */ public static function get_itemname_mapping_for_component(): array { return [ 0 => 'rating', 1 => 'someother', ]; } } } namespace tests\core_grades\component_gradeitems\valid_and_advanced\grades { use core_grades\local\gradeitem\itemnumber_mapping; use core_grades\local\gradeitem\advancedgrading_mapping; /** * Valid class for testing mappings. * * @package core_grades * @category test * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class gradeitems implements itemnumber_mapping, advancedgrading_mapping { /** * Get the grade item mapping of item number to item name. * * @return array */ public static function get_itemname_mapping_for_component(): array { return [ 0 => 'rating', 1 => 'someother', ]; } /** * Get the list of items which define advanced grading. * * @return array */ public static function get_advancedgrading_itemnames(): array { return [ 'someother', ]; } } } namespace tests\core_grades\component_gradeitems\invalid\grades { use core_grades\local\gradeitem\itemnumber_mapping; /** * Invalid class for testing mappings. * * @package core_grades * @category test * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class gradeitems { /** * Get the grade item mapping of item number to item name. * * @return array */ public static function get_itemname_mapping_for_component(): array { return [ 0 => 'rating', 1 => 'someother', ]; } /** * Get the list of items which define advanced grading. * * @return array */ public static function get_advancedgrading_itemnames(): array { return [ 1 => 'someother', ]; } } } tests/importlib_test.php 0000604 00000026255 15062070557 0011474 0 ustar 00 <?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/>. namespace core_grades; use grade_item; /** * Tests grade_import_lib functions. * * @package core_grades * @category test * @copyright 2015 Adrian Greeve <adrian@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU Public License */ class importlib_test extends \advanced_testcase { /** * Load required test libraries */ public static function setUpBeforeClass(): void { global $CFG; require_once("{$CFG->dirroot}/grade/import/lib.php"); } /** * Import grades into 'grade_import_values' table. This is done differently in the various import plugins, * so there is no direct API to call. * * @param array $data Information to be inserted into the table. * @return int The insert ID of the sql statement. */ private function import_grades($data) { global $DB, $USER; $graderecord = new \stdClass(); $graderecord->importcode = $data['importcode']; if (isset($data['itemid'])) { $graderecord->itemid = $data['itemid']; } $graderecord->userid = $data['userid']; if (isset($data['importer'])) { $graderecord->importer = $data['importer']; } else { $graderecord->importer = $USER->id; } if (isset($data['finalgrade'])) { $graderecord->finalgrade = $data['finalgrade']; } else { $graderecord->finalgrade = rand(0, 100); } if (isset($data['feedback'])) { $graderecord->feedback = $data['feedback']; } if (isset($data['importonlyfeedback'])) { $graderecord->importonlyfeedback = $data['importonlyfeedback']; } else { $graderecord->importonlyfeedback = false; } if (isset($data['newgradeitem'])) { $graderecord->newgradeitem = $data['newgradeitem']; } return $DB->insert_record('grade_import_values', $graderecord); } /** * Tests for importing grades from an external source. * * @covers ::grade_import_commit */ public function test_grade_import_commit() { global $USER, $DB, $CFG; $this->resetAfterTest(); $importcode = get_new_importcode(); $user1 = $this->getDataGenerator()->create_user(); $user2 = $this->getDataGenerator()->create_user(); $course = $this->getDataGenerator()->create_course(); $assign = $this->getDataGenerator()->create_module('assign', array('course' => $course->id)); $itemname = $assign->name; $modulecontext = \context_module::instance($assign->cmid); // The generator returns a dummy object, lets get the real assign object. $assign = new \assign($modulecontext, false, false); $cm = $assign->get_course_module(); // Enrol users in the course. $this->getDataGenerator()->enrol_user($user1->id, $course->id); $this->getDataGenerator()->enrol_user($user2->id, $course->id); // Enter a new grade into an existing grade item. $gradeitem = \grade_item::fetch(array('courseid' => $course->id, 'itemtype' => 'mod')); // Keep this value around for a test further down. $originalgrade = 55; $this->import_grades(array( 'importcode' => $importcode, 'itemid' => $gradeitem->id, 'userid' => $user1->id, 'finalgrade' => $originalgrade )); $status = grade_import_commit($course->id, $importcode, false, false); $this->assertTrue($status); // Get imported grade_grade. $gradegrade = \grade_grade::fetch(array('itemid' => $gradeitem->id, 'userid' => $user1->id)); $this->assertEquals($originalgrade, $gradegrade->finalgrade); // Overriden field will be a timestamp and will evaluate out to true. $this->assertTrue($gradegrade->is_overridden()); // Create a new grade item and import into that. $importcode = get_new_importcode(); $record = new \stdClass(); $record->itemname = 'New grade item'; $record->importcode = $importcode; $record->importer = $USER->id; $insertid = $DB->insert_record('grade_import_newitem', $record); $finalgrade = 75; $this->import_grades(array( 'importcode' => $importcode, 'userid' => $user1->id, 'finalgrade' => $finalgrade, 'newgradeitem' => $insertid )); $status = grade_import_commit($course->id, $importcode, false, false); $this->assertTrue($status); // Check that we have a new \grade_item. $gradeitem = \grade_item::fetch(array('courseid' => $course->id, 'itemtype' => 'manual')); $this->assertEquals($record->itemname, $gradeitem->itemname); // Grades were imported. $gradegrade = \grade_grade::fetch(array('itemid' => $gradeitem->id, 'userid' => $user1->id)); $this->assertEquals($finalgrade, $gradegrade->finalgrade); // As this is a new item the grade has not been overridden. $this->assertFalse($gradegrade->is_overridden()); // Import feedback only. $importcode = get_new_importcode(); $gradeitem = \grade_item::fetch(array('courseid' => $course->id, 'itemtype' => 'mod')); $originalfeedback = 'feedback can be useful'; $this->import_grades(array( 'importcode' => $importcode, 'userid' => $user1->id, 'itemid' => $gradeitem->id, 'feedback' => $originalfeedback, 'importonlyfeedback' => true )); $status = grade_import_commit($course->id, $importcode, true, false); $this->assertTrue($status); $gradegrade = \grade_grade::fetch(array('itemid' => $gradeitem->id, 'userid' => $user1->id)); // The final grade should be the same as the first record further up. We are only altering the feedback. $this->assertEquals($originalgrade, $gradegrade->finalgrade); $this->assertTrue($gradegrade->is_overridden()); // Import grades only. $importcode = get_new_importcode(); $gradeitem = \grade_item::fetch(array('courseid' => $course->id, 'itemtype' => 'mod')); $finalgrade = 60; $this->import_grades(array( 'importcode' => $importcode, 'userid' => $user1->id, 'itemid' => $gradeitem->id, 'finalgrade' => $finalgrade, 'feedback' => 'feedback can still be useful' )); $status = grade_import_commit($course->id, $importcode, false, false); $this->assertTrue($status); $gradegrade = \grade_grade::fetch(array('itemid' => $gradeitem->id, 'userid' => $user1->id)); $this->assertEquals($finalgrade, $gradegrade->finalgrade); // The final feedback should not have changed. $this->assertEquals($originalfeedback, $gradegrade->feedback); $this->assertTrue($gradegrade->is_overridden()); // Check that printing of import status is correct. $importcode = get_new_importcode(); $gradeitem = \grade_item::fetch(array('courseid' => $course->id, 'itemtype' => 'mod')); $this->import_grades(array( 'importcode' => $importcode, 'userid' => $user1->id, 'itemid' => $gradeitem->id )); ob_start(); $status = grade_import_commit($course->id, $importcode); $output = ob_get_contents(); ob_end_clean(); $this->assertTrue($status); $this->assertStringContainsString("++ Grade import success ++", $output); } /** * Test grade import commit for users who aren't enrolled on the target course * * @covers ::grade_import_commit */ public function test_grade_import_commit_unenrolled_user(): void { $this->resetAfterTest(); $course = $this->getDataGenerator()->create_course(); $assign = $this->getDataGenerator()->create_module('assign', ['course' => $course->id]); $user = $this->getDataGenerator()->create_user(['firstname' => 'Lionel', 'lastname' => 'Doe']); // Enter a new grade into an existing grade item. $gradeitem = grade_item::fetch(['courseid' => $course->id, 'itemtype' => 'mod']); $importcode = get_new_importcode(); $this->import_grades([ 'importcode' => $importcode, 'itemid' => $gradeitem->id, 'userid' => $user->id, 'finalgrade' => 10, ]); ob_start(); $status = grade_import_commit($course->id, $importcode); $output = ob_get_contents(); ob_end_clean(); // Assert commit succeeded and we didn't receive debugging about lack of name fields. $this->assertTrue($status); $this->assertStringContainsString('This import included the following grades for users not currently' . ' enrolled in this course', $output); $this->assertStringContainsString('User ' . fullname($user), $output); $this->assertDebuggingNotCalled(); } /** * Test retrieving users included in impoty who aren't enrolled on the target course * * @covers ::get_unenrolled_users_in_import */ public function test_get_unenrolled_users_in_import(): void { $this->resetAfterTest(); $course = $this->getDataGenerator()->create_course(); $assign = $this->getDataGenerator()->create_module('assign', ['course' => $course->id, 'idnumber' => 'gid101']); $user = $this->getDataGenerator()->create_user(['idnumber' => 'uid101']); // Enter a new grade into an existing grade item. $gradeitem = grade_item::fetch(['courseid' => $course->id, 'itemtype' => 'mod']); $importcode = get_new_importcode(); $importgradeid = $this->import_grades([ 'importcode' => $importcode, 'itemid' => $gradeitem->id, 'userid' => $user->id, 'finalgrade' => 10, ]); $unenrolledusers = get_unenrolled_users_in_import($importcode, $course->id); $this->assertCount(1, $unenrolledusers); $unenrolleduser = reset($unenrolledusers); $this->assertEquals((object) [ 'id' => $importgradeid, 'firstnamephonetic' => $user->firstnamephonetic, 'lastnamephonetic' => $user->lastnamephonetic, 'middlename' => $user->middlename, 'alternatename' => $user->alternatename, 'firstname' => $user->firstname, 'lastname' => $user->lastname, 'useridnumber' => 'uid101', 'gradeidnumber' => 'gid101', ], $unenrolleduser); } } tests/report_graderlib_test.php 0000604 00000070056 15062070557 0013017 0 ustar 00 <?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/>. namespace core_grades; use grade_plugin_return; use grade_report_grader; use mod_quiz\quiz_settings; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once($CFG->dirroot.'/grade/lib.php'); require_once($CFG->dirroot.'/grade/report/grader/lib.php'); /** * Tests grade_report_grader (the grader report) * * @package core_grades * @covers \grade_report_grader * @category test * @copyright 2012 Andrew Davis * @license http://www.gnu.org/copyleft/gpl.html GNU Public License */ class report_graderlib_test extends \advanced_testcase { /** * Tests grade_report_grader::process_data() * * process_data() processes submitted grade and feedback data */ public function test_process_data() { global $DB, $CFG; $this->resetAfterTest(true); $course = $this->getDataGenerator()->create_course(); // Create and enrol a student. $student = $this->getDataGenerator()->create_user(array('username' => 'student_sam')); $role = $DB->get_record('role', array('shortname' => 'student'), '*', MUST_EXIST); $this->getDataGenerator()->enrol_user($student->id, $course->id, $role->id); // Test with limited grades. $CFG->unlimitedgrades = 0; $forummax = 80; $forum1 = $this->getDataGenerator()->create_module('forum', array('assessed' => 1, 'scale' => $forummax, 'course' => $course->id)); // Switch the stdClass instance for a grade item instance. $forum1 = \grade_item::fetch(array('itemtype' => 'mod', 'itemmodule' => 'forum', 'iteminstance' => $forum1->id, 'courseid' => $course->id)); $report = $this->create_report($course); $testgrade = 60.00; $data = new \stdClass(); $data->id = $course->id; $data->report = 'grader'; $data->timepageload = time(); $data->grade = array(); $data->grade[$student->id] = array(); $data->grade[$student->id][$forum1->id] = $testgrade; $warnings = $report->process_data($data); $this->assertEquals(count($warnings), 0); $studentgrade = \grade_grade::fetch(array('itemid' => $forum1->id, '' => $student->id)); $this->assertEquals($studentgrade->finalgrade, $testgrade); // Grade above max. Should be pulled down to max. $toobig = 200.00; $data->grade[$student->id][$forum1->id] = $toobig; $data->timepageload = time(); $warnings = $report->process_data($data); $this->assertEquals(count($warnings), 1); $studentgrade = \grade_grade::fetch(array('itemid' => $forum1->id, '' => $student->id)); $this->assertEquals($studentgrade->finalgrade, $forummax); // Grade below min. Should be pulled up to min. $toosmall = -10.00; $data->grade[$student->id][$forum1->id] = $toosmall; $data->timepageload = time(); $warnings = $report->process_data($data); $this->assertEquals(count($warnings), 1); $studentgrade = \grade_grade::fetch(array('itemid' => $forum1->id, '' => $student->id)); $this->assertEquals($studentgrade->finalgrade, 0); // Test unlimited grades so we can give a student a grade about max. $CFG->unlimitedgrades = 1; $data->grade[$student->id][$forum1->id] = $toobig; $data->timepageload = time(); $warnings = $report->process_data($data); $this->assertEquals(count($warnings), 0); $studentgrade = \grade_grade::fetch(array('itemid' => $forum1->id, '' => $student->id)); $this->assertEquals($studentgrade->finalgrade, $toobig); } public function test_collapsed_preferences() { $this->resetAfterTest(true); $emptypreferences = array('aggregatesonly' => array(), 'gradesonly' => array()); $user1 = $this->getDataGenerator()->create_user(); $course1 = $this->getDataGenerator()->create_course(); $course2 = $this->getDataGenerator()->create_course(); $course3 = $this->getDataGenerator()->create_course(); $this->setUser($user1); $report = $this->create_report($course1); $this->assertEquals($emptypreferences, $report->collapsed); // Validating preferences set/get for one course. $report->process_action('cg13', 'switch_minus'); $report = $this->create_report($course1); $this->assertEquals(array(13), $report->collapsed['aggregatesonly']); $this->assertEmpty($report->collapsed['gradesonly']); $report->process_action('cg13', 'switch_plus'); $report = $this->create_report($course1); $this->assertEmpty($report->collapsed['aggregatesonly']); $this->assertEquals(array(13), $report->collapsed['gradesonly']); $report->process_action('cg13', 'switch_whole'); $report = $this->create_report($course1); $this->assertEquals($emptypreferences, $report->collapsed); // Validating preferences set/get for several courses. $course1cats = $course2cats = $course3cats = array(); for ($i=0;$i<10;$i++) { $course1cats[] = $this->create_grade_category($course1)->id; $course2cats[] = $this->create_grade_category($course2)->id; $course3cats[] = $this->create_grade_category($course3)->id; } $report1 = $this->create_report($course1); foreach ($course1cats as $catid) { $report1->process_action('cg'.$catid, 'switch_minus'); } $report2 = $this->create_report($course2); foreach ($course2cats as $catid) { $report2->process_action('cg'.$catid, 'switch_minus'); $report2->process_action('cg'.$catid, 'switch_plus'); } $report3 = $this->create_report($course3); foreach ($course3cats as $catid) { $report3->process_action('cg'.$catid, 'switch_minus'); if (($i++)%2) { $report3->process_action('cg'.$catid, 'switch_plus'); } } $report1 = $this->create_report($course1); $this->assertEquals(10, count($report1->collapsed['aggregatesonly'])); $this->assertEquals(0, count($report1->collapsed['gradesonly'])); $report2 = $this->create_report($course2); $this->assertEquals(0, count($report2->collapsed['aggregatesonly'])); $this->assertEquals(10, count($report2->collapsed['gradesonly'])); $report3 = $this->create_report($course3); $this->assertEquals(5, count($report3->collapsed['aggregatesonly'])); $this->assertEquals(5, count($report3->collapsed['gradesonly'])); // Test upgrade script. // Combine data generated for user1 and set it in the old format for user2, Try to retrieve it and make sure it is converted. $user2 = $this->getDataGenerator()->create_user(); $alldata = array( 'aggregatesonly' => array_merge($report1->collapsed['aggregatesonly'], $report2->collapsed['aggregatesonly'], $report3->collapsed['aggregatesonly']), 'gradesonly' => array_merge($report1->collapsed['gradesonly'], $report2->collapsed['gradesonly'], $report3->collapsed['gradesonly']), ); set_user_preference('grade_report_grader_collapsed_categories', serialize($alldata), $user2); $this->setUser($user2); $convertedreport1 = $this->create_report($course1); $this->assertEquals($report1->collapsed, $convertedreport1->collapsed); $convertedreport2 = $this->create_report($course2); $this->assertEquals($report2->collapsed, $convertedreport2->collapsed); $convertedreport3 = $this->create_report($course3); $this->assertEquals($report3->collapsed, $convertedreport3->collapsed); // Make sure the old style user preference is removed now. $this->assertEmpty(get_user_preferences('grade_report_grader_collapsed_categories')); // Test overflowing the setting with non-existing categories (only validated if new setting size exceeds 1333 chars). $toobigvalue = $expectedvalue = $report1->collapsed; for ($i = 0; strlen(json_encode($toobigvalue)) < 1333; $i++) { $toobigvalue[($i < 7) ? 'gradesonly' : 'aggregatesonly'][] = $course1cats[9] + 1 + $i; } $lastvalue = array_pop($toobigvalue['gradesonly']); set_user_preference('grade_report_grader_collapsed_categories'.$course1->id, json_encode($toobigvalue)); $report1 = $this->create_report($course1); $report1->process_action('cg'.$lastvalue, 'switch_minus'); $report1 = $this->create_report($course1); $this->assertEquals($expectedvalue, $report1->collapsed); // Test overflowing the setting with existing categories. $toobigvalue = $report1->collapsed; for ($i = 0; strlen(json_encode($toobigvalue)) < 1333; $i++) { $catid = $this->create_grade_category($course1)->id; $toobigvalue[($i < 7) ? 'gradesonly' : 'aggregatesonly'][] = $catid; } $lastcatid = array_pop($toobigvalue['gradesonly']); set_user_preference('grade_report_grader_collapsed_categories'.$course1->id, json_encode($toobigvalue)); $toobigvalue['aggregatesonly'][] = $lastcatid; $report1 = $this->create_report($course1); $report1->process_action('cg'.$lastcatid, 'switch_minus'); // One last value should be removed from both arrays. $report1 = $this->create_report($course1); $this->assertEquals(count($toobigvalue['aggregatesonly']) - 1, count($report1->collapsed['aggregatesonly'])); $this->assertEquals(count($toobigvalue['gradesonly']) - 1, count($report1->collapsed['gradesonly'])); } /** * Test some special cases of the conversion from old preferences to new ones * * @covers \grade_report_grader::get_collapsed_preferences * @covers \grade_report_grader::filter_collapsed_categories */ public function test_old_collapsed_preferences() { $this->resetAfterTest(true); $user1 = $this->getDataGenerator()->create_user(); $course1 = $this->getDataGenerator()->create_course(); $course2 = $this->getDataGenerator()->create_course(); $course3 = $this->getDataGenerator()->create_course(); $course1cats = $course2cats = $course3cats = []; for ($i = 0; $i < 10; $i++) { $course1cats[] = $this->create_grade_category($course1)->id; $course2cats[] = $this->create_grade_category($course2)->id; $course3cats[] = $this->create_grade_category($course3)->id; } $report1 = $this->create_report($course1); // Collapse all the cats in course1. foreach ($course1cats as $catid) { $report1->process_action('cg'. $catid, 'switch_minus'); } // Expand all the cats in course2. $report2 = $this->create_report($course2); foreach ($course2cats as $catid) { $report2->process_action('cg'.$catid, 'switch_minus'); $report2->process_action('cg'.$catid, 'switch_plus'); } // Collapse odd cats and expand even cats in course3. $report3 = $this->create_report($course3); foreach ($course3cats as $catid) { $report3->process_action('cg'.$catid, 'switch_minus'); if (($i++) % 2) { $report3->process_action('cg'.$catid, 'switch_plus'); } } $report1 = $this->create_report($course1); $this->assertEquals(10, count($report1->collapsed['aggregatesonly'])); $this->assertEquals(0, count($report1->collapsed['gradesonly'])); $report2 = $this->create_report($course2); $this->assertEquals(0, count($report2->collapsed['aggregatesonly'])); $this->assertEquals(10, count($report2->collapsed['gradesonly'])); $report3 = $this->create_report($course3); $this->assertEquals(5, count($report3->collapsed['aggregatesonly'])); $this->assertEquals(5, count($report3->collapsed['gradesonly'])); // Use the preferences generated for user1 and set it in the old format for other users. // User2: both gradesonly and aggregatesonly. $user2 = $this->getDataGenerator()->create_user(); $alldata = [ 'gradesonly' => array_merge( $report1->collapsed['gradesonly'], $report2->collapsed['gradesonly'], $report3->collapsed['gradesonly']), 'aggregatesonly' => array_merge( $report1->collapsed['aggregatesonly'], $report2->collapsed['aggregatesonly'], $report3->collapsed['aggregatesonly']), ]; set_user_preference('grade_report_grader_collapsed_categories', serialize($alldata), $user2); $this->setUser($user2); $convertedreport1 = $this->create_report($course1); $this->assertEquals($report1->collapsed['gradesonly'], $convertedreport1->collapsed['gradesonly']); $this->assertEquals($report1->collapsed['aggregatesonly'], $convertedreport1->collapsed['aggregatesonly']); $newprefs1 = get_user_preferences('grade_report_grader_collapsed_categories' . $course1->id); // Also verify new prefs. $this->assertEquals($report1->collapsed['gradesonly'], json_decode($newprefs1, true)['gradesonly']); $this->assertEquals($report1->collapsed['aggregatesonly'], json_decode($newprefs1, true)['aggregatesonly']); $convertedreport2 = $this->create_report($course2); $this->assertEquals($report2->collapsed['gradesonly'], $convertedreport2->collapsed['gradesonly']); $this->assertEquals($report2->collapsed['aggregatesonly'], $convertedreport2->collapsed['aggregatesonly']); $newprefs2 = get_user_preferences('grade_report_grader_collapsed_categories' . $course2->id); // Also verify new prefs. $this->assertEquals($report2->collapsed['gradesonly'], json_decode($newprefs2, true)['gradesonly']); $this->assertEquals($report2->collapsed['aggregatesonly'], json_decode($newprefs2, true)['aggregatesonly']); $convertedreport3 = $this->create_report($course3); $this->assertEquals($report3->collapsed['gradesonly'], $convertedreport3->collapsed['gradesonly']); $this->assertEquals($report3->collapsed['aggregatesonly'], $convertedreport3->collapsed['aggregatesonly']); $newprefs3 = get_user_preferences('grade_report_grader_collapsed_categories' . $course3->id); // Also verify new prefs. $this->assertEquals($report3->collapsed['gradesonly'], json_decode($newprefs3, true)['gradesonly']); $this->assertEquals($report3->collapsed['aggregatesonly'], json_decode($newprefs3, true)['aggregatesonly']); // Make sure the old style user preference is removed now. $this->assertEmpty(get_user_preferences('grade_report_grader_collapsed_categories')); // User3: only gradesonly (missing aggregatesonly). $user3 = $this->getDataGenerator()->create_user(); $alldata = [ 'gradesonly' => array_merge( $report1->collapsed['gradesonly'], $report2->collapsed['gradesonly'], $report3->collapsed['gradesonly']), ]; set_user_preference('grade_report_grader_collapsed_categories', serialize($alldata), $user3); $this->setUser($user3); $convertedreport1 = $this->create_report($course1); $this->assertEquals($report1->collapsed['gradesonly'], $convertedreport1->collapsed['gradesonly']); $this->assertEquals([], $convertedreport1->collapsed['aggregatesonly']); $newprefs1 = get_user_preferences('grade_report_grader_collapsed_categories' . $course1->id); // Also verify new prefs. $this->assertNull($newprefs1); $convertedreport2 = $this->create_report($course2); $this->assertEquals($report2->collapsed['gradesonly'], $convertedreport2->collapsed['gradesonly']); $this->assertEquals([], $convertedreport2->collapsed['aggregatesonly']); $newprefs2 = get_user_preferences('grade_report_grader_collapsed_categories' . $course2->id); // Also verify new prefs. $this->assertEquals($report2->collapsed['gradesonly'], json_decode($newprefs2, true)['gradesonly']); $this->assertEquals([], json_decode($newprefs2, true)['aggregatesonly']); $convertedreport3 = $this->create_report($course3); $this->assertEquals($report3->collapsed['gradesonly'], $convertedreport3->collapsed['gradesonly']); $this->assertEquals([], $convertedreport3->collapsed['aggregatesonly']); $newprefs3 = get_user_preferences('grade_report_grader_collapsed_categories' . $course3->id); // Also verify new prefs. $this->assertEquals($report3->collapsed['gradesonly'], json_decode($newprefs3, true)['gradesonly']); $this->assertEquals([], json_decode($newprefs3, true)['aggregatesonly']); // Make sure the old style user preference is removed now. $this->assertEmpty(get_user_preferences('grade_report_grader_collapsed_categories')); // User4: only aggregatesonly (missing gradesonly). $user4 = $this->getDataGenerator()->create_user(); $alldata = [ 'aggregatesonly' => array_merge( $report1->collapsed['aggregatesonly'], $report2->collapsed['aggregatesonly'], $report3->collapsed['aggregatesonly']), ]; set_user_preference('grade_report_grader_collapsed_categories', serialize($alldata), $user4); $this->setUser($user4); $convertedreport1 = $this->create_report($course1); $this->assertEquals([], $convertedreport1->collapsed['gradesonly']); $this->assertEquals($report1->collapsed['aggregatesonly'], $convertedreport1->collapsed['aggregatesonly']); $newprefs1 = get_user_preferences('grade_report_grader_collapsed_categories' . $course1->id); // Also verify new prefs. $this->assertEquals([], json_decode($newprefs1, true)['gradesonly']); $this->assertEquals($report1->collapsed['aggregatesonly'], json_decode($newprefs1, true)['aggregatesonly']); $convertedreport2 = $this->create_report($course2); $this->assertEquals([], $convertedreport2->collapsed['gradesonly']); $this->assertEquals($report2->collapsed['aggregatesonly'], $convertedreport2->collapsed['aggregatesonly']); $newprefs2 = get_user_preferences('grade_report_grader_collapsed_categories' . $course2->id); // Also verify new prefs. $this->assertNull($newprefs2); $convertedreport3 = $this->create_report($course3); $this->assertEquals([], $convertedreport3->collapsed['gradesonly']); $this->assertEquals($report3->collapsed['aggregatesonly'], $convertedreport3->collapsed['aggregatesonly']); $newprefs3 = get_user_preferences('grade_report_grader_collapsed_categories' . $course3->id); // Also verify new prefs. $this->assertEquals([], json_decode($newprefs3, true)['gradesonly']); $this->assertEquals($report3->collapsed['aggregatesonly'], json_decode($newprefs3, true)['aggregatesonly']); // Make sure the old style user preference is removed now. $this->assertEmpty(get_user_preferences('grade_report_grader_collapsed_categories')); // User5: both missing gradesonly and aggregatesonly. $user5 = $this->getDataGenerator()->create_user(); $alldata = []; set_user_preference('grade_report_grader_collapsed_categories', serialize($alldata), $user5); $this->setUser($user5); $convertedreport1 = $this->create_report($course1); $this->assertEquals([], $convertedreport1->collapsed['gradesonly']); $this->assertEquals([], $convertedreport1->collapsed['aggregatesonly']); $newprefs1 = get_user_preferences('grade_report_grader_collapsed_categories' . $course1->id); // Also verify new prefs. $this->assertNull($newprefs1); $convertedreport2 = $this->create_report($course2); $this->assertEquals([], $convertedreport2->collapsed['gradesonly']); $this->assertEquals([], $convertedreport2->collapsed['aggregatesonly']); $newprefs2 = get_user_preferences('grade_report_grader_collapsed_categories' . $course2->id); // Also verify new prefs. $this->assertNull($newprefs2); $convertedreport3 = $this->create_report($course3); $this->assertEquals([], $convertedreport3->collapsed['gradesonly']); $this->assertEquals([], $convertedreport3->collapsed['aggregatesonly']); $newprefs3 = get_user_preferences('grade_report_grader_collapsed_categories' . $course3->id); // Also verify new prefs. $this->assertNull($newprefs3); // Make sure the old style user preference is removed now. $this->assertEmpty(get_user_preferences('grade_report_grader_collapsed_categories')); // User6: both empty gradesonly and aggregatesonly. $user6 = $this->getDataGenerator()->create_user(); $alldata = [ 'gradesonly' => [], 'aggregatesonly' => [] ]; set_user_preference('grade_report_grader_collapsed_categories', serialize($alldata), $user6); $this->setUser($user6); $convertedreport1 = $this->create_report($course1); $this->assertEquals([], $convertedreport1->collapsed['gradesonly']); $this->assertEquals([], $convertedreport1->collapsed['aggregatesonly']); $newprefs1 = get_user_preferences('grade_report_grader_collapsed_categories' . $course1->id); // Also verify new prefs. $this->assertNull($newprefs1); $convertedreport2 = $this->create_report($course2); $this->assertEquals([], $convertedreport2->collapsed['gradesonly']); $this->assertEquals([], $convertedreport2->collapsed['aggregatesonly']); $newprefs2 = get_user_preferences('grade_report_grader_collapsed_categories' . $course2->id); // Also verify new prefs. $this->assertNull($newprefs2); $convertedreport3 = $this->create_report($course3); $this->assertEquals([], $convertedreport3->collapsed['gradesonly']); $this->assertEquals([], $convertedreport3->collapsed['aggregatesonly']); $newprefs3 = get_user_preferences('grade_report_grader_collapsed_categories' . $course3->id); // Also verify new prefs. $this->assertNull($newprefs3); // Make sure the old style user preference is removed now. $this->assertEmpty(get_user_preferences('grade_report_grader_collapsed_categories')); } /** * Tests the get_right_rows function with one 'normal' and one 'ungraded' quiz. * * Previously, with an ungraded quiz (which results in a grade item with type GRADETYPE_NONE) * there was a bug in get_right_rows in some situations. */ public function test_get_right_rows() { global $USER, $DB; $this->resetAfterTest(true); // Create manager and student on a course. $generator = $this->getDataGenerator(); $manager = $generator->create_user(); $student = $generator->create_user(); $course = $generator->create_course(); $generator->enrol_user($manager->id, $course->id, 'manager'); $generator->enrol_user($student->id, $course->id, 'student'); // Create a couple of quizzes on the course. $normalquiz = $generator->create_module('quiz', array('course' => $course->id, 'name' => 'NormalQuiz')); $ungradedquiz = $generator->create_module('quiz', array('course' => $course->id, 'name' => 'UngradedQuiz')); // Set the grade for the second one to 0 (note, you have to do this after creating it, // otherwise it doesn't create an ungraded grade item). quiz_settings::create($ungradedquiz->id)->get_grade_calculator()->update_quiz_maximum_grade(0); // Set current user. $this->setUser($manager); $USER->editing = false; // Get the report. $report = $this->create_report($course); $report->load_users(); $report->load_final_grades(); $result = $report->get_right_rows(false); // There should be 3 rows (2 header rows, plus the grades for the first user). $this->assertCount(3, $result); // The second row should contain 2 cells - one for the graded quiz and course total. $this->assertCount(2, $result[1]->cells); $this->assertStringContainsString('NormalQuiz', $result[1]->cells[0]->text); $this->assertStringContainsString('Course total', $result[1]->cells[1]->text); // User row should contain grade values '-'. $this->assertCount(2, $result[2]->cells); $this->assertStringContainsString('>-<', $result[2]->cells[0]->text); $this->assertStringContainsString('>-<', $result[2]->cells[1]->text); // Supposing the user cannot view hidden grades, this shouldn't make any difference (due // to a bug, it previously did). $context = \context_course::instance($course->id); $managerroleid = $DB->get_field('role', 'id', array('shortname' => 'manager')); assign_capability('moodle/grade:viewhidden', CAP_PROHIBIT, $managerroleid, $context->id, true); $this->assertFalse(has_capability('moodle/grade:viewhidden', $context)); // Recreate the report. Confirm it returns successfully still. $report = $this->create_report($course); $report->load_users(); $report->load_final_grades(); $result = $report->get_right_rows(false); $this->assertCount(3, $result); } /** * Test loading report users when per page preferences are set */ public function test_load_users_paging_preference(): void { $this->resetAfterTest(); $course = $this->getDataGenerator()->create_course(); // The report users will default to sorting by their lastname. $user1 = $this->getDataGenerator()->create_and_enrol($course, 'student', ['lastname' => 'Apple']); $user2 = $this->getDataGenerator()->create_and_enrol($course, 'student', ['lastname' => 'Banana']); $user3 = $this->getDataGenerator()->create_and_enrol($course, 'student', ['lastname' => 'Carrot']); // Set to empty string. $report = $this->create_report($course); $report->set_pref('studentsperpage', ''); $users = $report->load_users(); $this->assertEquals([$user1->id, $user2->id, $user3->id], array_column($users, 'id')); // Set to valid value. $report = $this->create_report($course); $report->set_pref('studentsperpage', 2); $users = $report->load_users(); $this->assertEquals([$user1->id, $user2->id], array_column($users, 'id')); } /** * Test getting students per page report preference */ public function test_get_students_per_page(): void { $this->resetAfterTest(); $course = $this->getDataGenerator()->create_course(); $report = $this->create_report($course); $report->set_pref('studentsperpage', 10); $perpage = $report->get_students_per_page(); $this->assertSame(10, $perpage); } private function create_grade_category($course) { static $cnt = 0; $cnt++; $gradecat = new \grade_category(array('courseid' => $course->id, 'fullname' => 'Cat '.$cnt), false); $gradecat->apply_default_settings(); $gradecat->apply_forced_settings(); $gradecat->insert(); return $gradecat; } private function create_report($course) { $coursecontext = \context_course::instance($course->id); $gpr = new grade_plugin_return(array('type' => 'report', 'plugin'=>'grader', 'courseid' => $course->id)); $report = new grade_report_grader($course->id, $gpr, $coursecontext); return $report; } } tests/external/create_gradecategories_test.php 0000604 00000015663 15062070557 0015771 0 ustar 00 <?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/>. namespace core_grades\external; use core_grades\external\create_gradecategories; use core_external\external_api; defined('MOODLE_INTERNAL') || die; global $CFG; require_once($CFG->dirroot . '/webservice/tests/helpers.php'); /** * Unit tests for the core_grades\external\create_gradecategories webservice. * * @package core_grades * @category external * @copyright 2021 Peter Burnett <peterburnett@catalyst-au.net> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * @since Moodle 3.11 */ class create_gradecategories_test extends \externallib_advanced_testcase { /** * Test create_gradecategories. * * @return void */ public function test_create_gradecategories() { global $DB; $this->resetAfterTest(true); $course = $this->getDataGenerator()->create_course(); $this->setAdminUser(); // Test the most basic gradecategory creation. $status1 = create_gradecategories::execute($course->id, [['fullname' => 'Test Category 1', 'options' => []]]); $status1 = external_api::clean_returnvalue(create_gradecategories::execute_returns(), $status1); $courseparentcat = \grade_category::fetch_course_category($course->id); $record1 = $DB->get_record('grade_categories', ['id' => $status1['categoryids'][0]]); $this->assertEquals('Test Category 1', $record1->fullname); // Confirm that the parent category for this category is the top level category for the course. $this->assertEquals($courseparentcat->id, $record1->parent); $this->assertEquals(2, $record1->depth); // Now create a category as a child of the newly created category. $status2 = create_gradecategories::execute($course->id, [['fullname' => 'Test Category 2', 'options' => ['parentcategoryid' => $record1->id]]]); $status2 = external_api::clean_returnvalue(create_gradecategories::execute_returns(), $status2); $record2 = $DB->get_record('grade_categories', ['id' => $status2['categoryids'][0]]); $this->assertEquals($record1->id, $record2->parent); $this->assertEquals(3, $record2->depth); // Check the path is correct. $this->assertEquals('/' . implode('/', [$courseparentcat->id, $record1->id, $record2->id]) . '/', $record2->path); // Now create a category with some customised data and check the returns. This customises every value. $customopts = [ 'aggregation' => GRADE_AGGREGATE_MEAN, 'aggregateonlygraded' => 0, 'aggregateoutcomes' => 1, 'droplow' => 1, 'itemname' => 'item', 'iteminfo' => 'info', 'idnumber' => 'idnumber', 'gradetype' => GRADE_TYPE_TEXT, 'grademax' => 5, 'grademin' => 2, 'gradepass' => 3, 'display' => GRADE_DISPLAY_TYPE_LETTER, // Hack. This must be -2 to use the default setting. 'decimals' => 3, 'hiddenuntil' => time(), 'locktime' => time(), 'weightoverride' => 1, 'aggregationcoef2' => 20, 'parentcategoryid' => $record2->id ]; $status3 = create_gradecategories::execute($course->id, [['fullname' => 'Test Category 3', 'options' => $customopts]]); $status3 = external_api::clean_returnvalue(create_gradecategories::execute_returns(), $status3); $cat3 = new \grade_category(['courseid' => $course->id, 'id' => $status3['categoryids'][0]], true); $cat3->load_grade_item(); // Lets check all of the data is in the right shape. $this->assertEquals(GRADE_AGGREGATE_MEAN, $cat3->aggregation); $this->assertEquals(0, $cat3->aggregateonlygraded); $this->assertEquals(1, $cat3->aggregateoutcomes); $this->assertEquals(1, $cat3->droplow); $this->assertEquals('item', $cat3->grade_item->itemname); $this->assertEquals('info', $cat3->grade_item->iteminfo); $this->assertEquals('idnumber', $cat3->grade_item->idnumber); $this->assertEquals(GRADE_TYPE_TEXT, $cat3->grade_item->gradetype); $this->assertEquals(5, $cat3->grade_item->grademax); $this->assertEquals(2, $cat3->grade_item->grademin); $this->assertEquals(3, $cat3->grade_item->gradepass); $this->assertEquals(GRADE_DISPLAY_TYPE_LETTER, $cat3->grade_item->display); $this->assertEquals(3, $cat3->grade_item->decimals); $this->assertGreaterThanOrEqual($cat3->grade_item->hidden, time()); $this->assertGreaterThanOrEqual($cat3->grade_item->locktime, time()); $this->assertEquals(1, $cat3->grade_item->weightoverride); // Coefficient is converted to percentage. $this->assertEquals(0.2, $cat3->grade_item->aggregationcoef2); $this->assertEquals($record2->id, $cat3->parent); // Now test creating 2 in parallel, and nesting them. $status4 = create_gradecategories::execute($course->id, [ [ 'fullname' => 'Test Category 4', 'options' => [ 'idnumber' => 'secondlevel' ], ], [ 'fullname' => 'Test Category 5', 'options' => [ 'idnumber' => 'thirdlevel', 'parentcategoryidnumber' => 'secondlevel' ], ], ]); $status4 = external_api::clean_returnvalue(create_gradecategories::execute_returns(), $status4); $secondlevel = $DB->get_record('grade_categories', ['id' => $status4['categoryids'][0]]); $thirdlevel = $DB->get_record('grade_categories', ['id' => $status4['categoryids'][1]]); // Confirm that the parent category for secondlevel is the top level category for the course. $this->assertEquals($courseparentcat->id, $secondlevel->parent); $this->assertEquals(2, $record1->depth); // Confirm that the parent category for thirdlevel is the secondlevel category. $this->assertEquals($secondlevel->id, $thirdlevel->parent); $this->assertEquals(3, $thirdlevel->depth); // Check the path is correct. $this->assertEquals('/' . implode('/', [$courseparentcat->id, $secondlevel->id, $thirdlevel->id]) . '/', $thirdlevel->path); } } tests/external/get_feedback_test.php 0000604 00000014617 15062070557 0013677 0 ustar 00 <?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/>. namespace core_grades\external; defined('MOODLE_INTERNAL') || die; global $CFG; require_once($CFG->dirroot . '/webservice/tests/helpers.php'); /** * Unit tests for the core_grades\external\get_feedback webservice. * * @package core_grades * @category external * @copyright 2023 Kevin Percy <kevin.percy@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * @since Moodle 4.2 */ class get_feedback_test extends \externallib_advanced_testcase { /** * Test get_feedback. * * @covers ::get_feedback * @dataProvider get_feedback_provider * @param string|null $feedback The feedback text added for the grade item. * @param array $expected The expected feedback data. * @return void */ public function test_get_feedback(?string $feedback, array $expected) { $this->resetAfterTest(true); $course = $this->getDataGenerator()->create_course(); $user = $this->getDataGenerator()->create_user(['firstname' => 'John', 'lastname' => 'Doe', 'email' => 'johndoe@example.com']); $this->getDataGenerator()->enrol_user($user->id, $course->id); $gradeitem = $this->getDataGenerator()->create_grade_item(['itemname' => 'Grade item 1', 'courseid' => $course->id]); $gradegradedata = [ 'itemid' => $gradeitem->id, 'userid' => $user->id, ]; if ($feedback) { $gradegradedata['feedback'] = $feedback; } $this->getDataGenerator()->create_grade_grade($gradegradedata); $this->setAdminUser(); $feedbackdata = get_feedback::execute($course->id, $user->id, $gradeitem->id); $this->assertEquals($expected['feedbacktext'], $feedbackdata['feedbacktext']); $this->assertEquals($expected['title'], $feedbackdata['title']); $this->assertEquals($expected['fullname'], $feedbackdata['fullname']); $this->assertEquals($expected['additionalfield'], $feedbackdata['additionalfield']); } /** * Data provider for test_get_feedback(). * * @return array */ public function get_feedback_provider(): array { return [ 'Return when feedback is set.' => [ 'Test feedback', [ 'feedbacktext' => 'Test feedback', 'title' => 'Grade item 1', 'fullname' => 'John Doe', 'additionalfield' => 'johndoe@example.com' ] ], 'Return when feedback is not set.' => [ null, [ 'feedbacktext' => null, 'title' => 'Grade item 1', 'fullname' => 'John Doe', 'additionalfield' => 'johndoe@example.com' ] ] ]; } /** * Test get_feedback with invalid requests. * * @covers ::get_feedback * @dataProvider get_feedback_invalid_request_provider * @param string $loggeduserrole The role of the logged user. * @param bool $feedbacknotincourse Whether to request a feedback for a grade item which is not a part of the course. * @param array $expectedexception The expected exception. * @return void */ public function test_get_feedback_invalid_request(string $loggeduserrole, bool $feedbacknotincourse, array $expectedexception = []) { $this->resetAfterTest(true); // Create a course with a user and a grade item. $course = $this->getDataGenerator()->create_course(); $user = $this->getDataGenerator()->create_user(); $this->getDataGenerator()->enrol_user($user->id, $course->id); $gradeitem = $this->getDataGenerator()->create_grade_item(['courseid' => $course->id]); // Add feedback for the grade item in course. $gradegradedata = [ 'itemid' => $gradeitem->id, 'userid' => $user->id, 'feedback' => 'Test feedback', ]; $this->getDataGenerator()->create_grade_grade($gradegradedata); // Set the current user as specified. if ($loggeduserrole === 'user') { $this->setUser($user); } else if ($loggeduserrole === 'guest') { $this->setGuestUser(); } else { $this->setAdminUser(); } if ($feedbacknotincourse) { // Create a new course which will be later used in the feedback request call. $course = $this->getDataGenerator()->create_course(); } $this->expectException($expectedexception['exceptionclass']); if (!empty($expectedexception['exceptionmessage'])) { $this->expectExceptionMessage($expectedexception['exceptionmessage']); } get_feedback::execute($course->id, $user->id, $gradeitem->id); } /** * Data provider for test_get_feedback_invalid_request(). * * @return array */ public function get_feedback_invalid_request_provider(): array { return [ 'Logged user does not have permissions to view feedback.' => [ 'user', false, ['exceptionclass' => \required_capability_exception::class] ], 'Guest user cannot view feedback.' => [ 'guest', false, ['exceptionclass' => \require_login_exception::class] ], 'Request feedback for a grade item which is not a part of the course.' => [ 'admin', true, [ 'exceptionclass' => \invalid_parameter_exception::class, 'exceptionmessage' => 'Course ID and item ID mismatch', ] ] ]; } } tests/external/get_grade_tree_test.php 0000604 00000011760 15062070557 0014250 0 ustar 00 <?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/>. namespace core_grades\external; use core_external\external_api; defined('MOODLE_INTERNAL') || die; global $CFG; require_once($CFG->dirroot . '/webservice/tests/helpers.php'); /** * Unit tests for core_grades\external\get_grade_tree. * * @package core_grades * @category external * @copyright 2023 Mihail Geshoski <mihail@moodle.com> * @covers \core_grades\external\get_grade_tree */ class get_grade_tree_test extends \externallib_advanced_testcase { /** * Test the return value of the external function. * * @covers ::execute * @return void */ public function test_execute(): void { $this->resetAfterTest(); $this->setAdminUser(); $course = $this->getDataGenerator()->create_course(['fullname' => 'Course']); $coursegradecategory = \grade_category::fetch_course_category($course->id); // Create a grade item 'Grade item' and grade category 'Category 1' within the course grade category. $gradeitem = $this->getDataGenerator()->create_grade_item( ['courseid' => $course->id, 'itemname' => 'Grade item']); $gradecategory1 = $this->getDataGenerator()->create_grade_category( ['courseid' => $course->id, 'fullname' => 'Category 1']); // Create a grade item 'Grade item 1' and grade category 'Category 2' within 'Category 1'. $gradeitem1 = $this->getDataGenerator()->create_grade_item( ['courseid' => $course->id, 'itemname' => 'Grade item 1', 'categoryid' => $gradecategory1->id]); $gradecategory2 = $this->getDataGenerator()->create_grade_category( ['courseid' => $course->id, 'fullname' => 'Category 2', 'parent' => $gradecategory1->id]); // Create a grade item 'Grade item 2' and grade category 'Category 3' (with no children) within 'Category 2'. $gradeitem2 = $this->getDataGenerator()->create_grade_item( ['courseid' => $course->id, 'itemname' => 'Grade item 2', 'categoryid' => $gradecategory2->id]); $gradecategory3 = $this->getDataGenerator()->create_grade_category( ['courseid' => $course->id, 'fullname' => 'Category 3', 'parent' => $gradecategory2->id]); $result = get_grade_tree::execute($course->id); $result = external_api::clean_returnvalue(get_grade_tree::execute_returns(), $result); $expected = json_encode([ 'id' => $coursegradecategory->id, 'name' => 'Course', 'iscategory' => true, 'haschildcategories' => true, 'children' => [ [ 'id' => $gradeitem->id, 'name' => 'Grade item', 'iscategory' => false, 'children' => null ], [ 'id' => $gradecategory1->id, 'name' => 'Category 1', 'iscategory' => true, 'haschildcategories' => true, 'children' => [ [ 'id' => $gradeitem1->id, 'name' => 'Grade item 1', 'iscategory' => false, 'children' => null ], [ 'id' => $gradecategory2->id, 'name' => 'Category 2', 'iscategory' => true, 'haschildcategories' => true, 'children' => [ [ 'id' => $gradeitem2->id, 'name' => 'Grade item 2', 'iscategory' => false, 'children' => null ], [ 'id' => $gradecategory3->id, 'name' => 'Category 3', 'iscategory' => true, 'haschildcategories' => false, 'children' => null ] ] ] ] ] ] ]); $this->assertEquals($expected, $result); } } tests/external/get_gradeitems_test.php 0000604 00000005043 15062070557 0014270 0 ustar 00 <?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/>. namespace core_grades\external; use core_grades\external\get_gradeitems as get_gradeitems; use core_external\external_api; use grade_item; defined('MOODLE_INTERNAL') || die; global $CFG; require_once($CFG->dirroot . '/webservice/tests/helpers.php'); /** * Unit tests for the core_grades\external\get_gradeitems. * * @package core_grades * @category external * @copyright 2023 Mathew May <Mathew.solutions> * @covers \core_grades\external\get_gradeitems */ class get_gradeitems_test extends \externallib_advanced_testcase { public function test_execute(): void { $this->resetAfterTest(); $this->setAdminUser(); $course = $this->getDataGenerator()->create_course(); $this->getDataGenerator()->create_module('forum', ['course' => $course->id]); $this->getDataGenerator()->create_module('h5pactivity', ['course' => $course->id]); $this->getDataGenerator()->create_module('assign', ['course' => $course->id]); $result = get_gradeitems::execute($course->id); $result = external_api::clean_returnvalue(get_gradeitems::execute_returns(), $result); $allgradeitems = grade_item::fetch_all(['courseid' => $course->id]); $gradeitems = array_filter($allgradeitems, function($item) { $item->itemname = $item->get_name(); $item->category = $item->get_parent_category()->get_name(); return $item->gradetype != GRADE_TYPE_NONE && !$item->is_category_item() && !$item->is_course_item(); }); // Move back from grade items into an array of arrays. $mapped = array_map(function($item) { return [ 'id' => $item->id, 'itemname' => $item->itemname, 'category' => $item->category ]; }, array_values($gradeitems)); $this->assertEquals($mapped, $result['gradeItems']); } } tests/lib_test.php 0000604 00000104441 15062070557 0010233 0 ustar 00 <?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/>. /** * Unit tests for grade/lib.php. * * @package core_grades * @category test * @copyright 2016 Jun Pataleta * @license http://www.gnu.org/copyleft/gpl.html GNU Public License */ namespace core_grades; use assign; use cm_info; use grade_item; use grade_plugin_return; use grade_report_summary; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once($CFG->dirroot . '/grade/lib.php'); /** * Unit tests for grade/lib.php. * * @package core_grades * @category test * @copyright 2016 Jun Pataleta <jun@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class lib_test extends \advanced_testcase { /** * Test can_output_item. */ public function test_can_output_item() { $this->resetAfterTest(); $generator = $this->getDataGenerator(); // Course level grade category. $course = $generator->create_course(); // Grade tree looks something like: // - Test course (Rendered). $gradetree = \grade_category::fetch_course_tree($course->id); $this->assertTrue(\grade_tree::can_output_item($gradetree)); // Add a grade category with default settings. $generator->create_grade_category(array('courseid' => $course->id)); // Grade tree now looks something like: // - Test course n (Rendered). // -- Grade category n (Rendered). $gradetree = \grade_category::fetch_course_tree($course->id); $this->assertNotEmpty($gradetree['children']); foreach ($gradetree['children'] as $child) { $this->assertTrue(\grade_tree::can_output_item($child)); } // Add a grade category with grade type = None. $nototalcategory = 'No total category'; $nototalparams = [ 'courseid' => $course->id, 'fullname' => $nototalcategory, 'aggregation' => GRADE_AGGREGATE_WEIGHTED_MEAN ]; $nototal = $generator->create_grade_category($nototalparams); $catnototal = \grade_category::fetch(array('id' => $nototal->id)); // Set the grade type of the grade item associated to the grade category. $catitemnototal = $catnototal->load_grade_item(); $catitemnototal->gradetype = GRADE_TYPE_NONE; $catitemnototal->update(); // Grade tree looks something like: // - Test course n (Rendered). // -- Grade category n (Rendered). // -- No total category (Not rendered). $gradetree = \grade_category::fetch_course_tree($course->id); foreach ($gradetree['children'] as $child) { if ($child['object']->fullname == $nototalcategory) { $this->assertFalse(\grade_tree::can_output_item($child)); } else { $this->assertTrue(\grade_tree::can_output_item($child)); } } // Add another grade category with default settings under 'No total category'. $normalinnototalparams = [ 'courseid' => $course->id, 'fullname' => 'Normal category in no total category', 'parent' => $nototal->id ]; $generator->create_grade_category($normalinnototalparams); // Grade tree looks something like: // - Test course n (Rendered). // -- Grade category n (Rendered). // -- No total category (Rendered). // --- Normal category in no total category (Rendered). $gradetree = \grade_category::fetch_course_tree($course->id); foreach ($gradetree['children'] as $child) { // All children are now visible. $this->assertTrue(\grade_tree::can_output_item($child)); if (!empty($child['children'])) { foreach ($child['children'] as $grandchild) { $this->assertTrue(\grade_tree::can_output_item($grandchild)); } } } // Add a grade category with grade type = None. $nototalcategory2 = 'No total category 2'; $nototal2params = [ 'courseid' => $course->id, 'fullname' => $nototalcategory2, 'aggregation' => GRADE_AGGREGATE_WEIGHTED_MEAN ]; $nototal2 = $generator->create_grade_category($nototal2params); $catnototal2 = \grade_category::fetch(array('id' => $nototal2->id)); // Set the grade type of the grade item associated to the grade category. $catitemnototal2 = $catnototal2->load_grade_item(); $catitemnototal2->gradetype = GRADE_TYPE_NONE; $catitemnototal2->update(); // Add a category with no total under 'No total category'. $nototalinnototalcategory = 'Category with no total in no total category'; $nototalinnototalparams = [ 'courseid' => $course->id, 'fullname' => $nototalinnototalcategory, 'aggregation' => GRADE_AGGREGATE_WEIGHTED_MEAN, 'parent' => $nototal2->id ]; $nototalinnototal = $generator->create_grade_category($nototalinnototalparams); $catnototalinnototal = \grade_category::fetch(array('id' => $nototalinnototal->id)); // Set the grade type of the grade item associated to the grade category. $catitemnototalinnototal = $catnototalinnototal->load_grade_item(); $catitemnototalinnototal->gradetype = GRADE_TYPE_NONE; $catitemnototalinnototal->update(); // Grade tree looks something like: // - Test course n (Rendered). // -- Grade category n (Rendered). // -- No total category (Rendered). // --- Normal category in no total category (Rendered). // -- No total category 2 (Not rendered). // --- Category with no total in no total category (Not rendered). $gradetree = \grade_category::fetch_course_tree($course->id); foreach ($gradetree['children'] as $child) { if ($child['object']->fullname == $nototalcategory2) { $this->assertFalse(\grade_tree::can_output_item($child)); } else { $this->assertTrue(\grade_tree::can_output_item($child)); } if (!empty($child['children'])) { foreach ($child['children'] as $grandchild) { if ($grandchild['object']->fullname == $nototalinnototalcategory) { $this->assertFalse(\grade_tree::can_output_item($grandchild)); } else { $this->assertTrue(\grade_tree::can_output_item($grandchild)); } } } } } /** * Tests that ungraded_counts calculates count and sum of grades correctly when there are graded users. * * @covers \grade_report::ungraded_counts */ public function test_ungraded_counts_count_sumgrades() { global $DB; $this->resetAfterTest(true); $course1 = $this->getDataGenerator()->create_course(); $course2 = $this->getDataGenerator()->create_course(); $studentrole = $DB->get_record('role', ['shortname' => 'student'], '*', MUST_EXIST); $teacherrole = $DB->get_record('role', ['shortname' => 'editingteacher'], '*', MUST_EXIST); // Custom roles (gradable and non gradable). $gradeblerole = create_role('New student role', 'gradable', 'Gradable role', 'student'); $nongradeblerole = create_role('New student role', 'nongradable', 'Non gradable role', 'student'); // Set up gradable roles. set_config('gradebookroles', $studentrole->id . ',' . $gradeblerole); // Create users. // These will be gradable users. $student1 = $this->getDataGenerator()->create_user(['username' => 'student1']); $student2 = $this->getDataGenerator()->create_user(['username' => 'student2']); $student3 = $this->getDataGenerator()->create_user(['username' => 'student3']); $student5 = $this->getDataGenerator()->create_user(['username' => 'student5']); // These will be non-gradable users. $student4 = $this->getDataGenerator()->create_user(['username' => 'student4']); $student6 = $this->getDataGenerator()->create_user(['username' => 'student6']); $teacher = $this->getDataGenerator()->create_user(['username' => 'teacher']); // Enrol students. $this->getDataGenerator()->enrol_user($student1->id, $course1->id, $studentrole->id); $this->getDataGenerator()->enrol_user($student2->id, $course1->id, $studentrole->id); $this->getDataGenerator()->enrol_user($student3->id, $course1->id, $gradeblerole); $this->getDataGenerator()->enrol_user($student5->id, $course1->id, $nongradeblerole); $this->getDataGenerator()->enrol_user($student6->id, $course1->id, $studentrole->id); $this->getDataGenerator()->enrol_user($teacher->id, $course1->id, $teacherrole->id); // User that is enrolled in a different course. $this->getDataGenerator()->enrol_user($student4->id, $course2->id, $studentrole->id); // Mark user as deleted. $student6->deleted = 1; $DB->update_record('user', $student6); // Create grade items in course 1. $assign1 = $this->getDataGenerator()->create_module('assign', ['course' => $course1->id]); $assign2 = $this->getDataGenerator()->create_module('assign', ['course' => $course1->id]); $quiz1 = $this->getDataGenerator()->create_module('quiz', ['course' => $course1->id]); $manuaitem = new \grade_item($this->getDataGenerator()->create_grade_item([ 'itemname' => 'Grade item1', 'idnumber' => 'git1', 'courseid' => $course1->id, ])); // Create grade items in course 2. $assign3 = $this->getDataGenerator()->create_module('assign', ['course' => $course2->id]); // Grade users in first course. $cm = cm_info::create(get_coursemodule_from_instance('assign', $assign1->id)); $assigninstance = new assign($cm->context, $cm, $course1); $grade = $assigninstance->get_user_grade($student1->id, true); $grade->grade = 40; $assigninstance->update_grade($grade); $cm = cm_info::create(get_coursemodule_from_instance('assign', $assign2->id)); $assigninstance = new assign($cm->context, $cm, $course1); $grade = $assigninstance->get_user_grade($student3->id, true); $grade->grade = 50; $assigninstance->update_grade($grade); // Override grade for assignment in gradebook. $gi = \grade_item::fetch([ 'itemtype' => 'mod', 'itemmodule' => 'assign', 'iteminstance' => $cm->instance, 'courseid' => $course1->id ]); $gi->update_final_grade($student3->id, 55); // Grade user in second course. $cm = cm_info::create(get_coursemodule_from_instance('assign', $assign3->id)); $assigninstance = new assign($cm->context, $cm, $course2); $grade = $assigninstance->get_user_grade($student4->id, true); $grade->grade = 40; $assigninstance->update_grade($grade); $manuaitem->update_final_grade($student1->id, 1); $manuaitem->update_final_grade($student3->id, 2); // Trigger a regrade. grade_force_full_regrading($course1->id); grade_force_full_regrading($course2->id); grade_regrade_final_grades($course1->id); grade_regrade_final_grades($course2->id); // Initialise reports. $context1 = \context_course::instance($course1->id); $context2 = \context_course::instance($course2->id); $gpr1 = new grade_plugin_return( [ 'type' => 'report', 'plugin' => 'summary', 'course' => $course1, ] ); $gpr2 = new grade_plugin_return( [ 'type' => 'report', 'plugin' => 'summary', 'course' => $course2, ] ); $report1 = new grade_report_summary($course1->id, $gpr1, $context1); $report2 = new grade_report_summary($course2->id, $gpr2, $context2); $ungradedcounts = []; $ungradedcounts[$course1->id] = $report1->ungraded_counts(); $ungradedcounts[$course2->id] = $report2->ungraded_counts(); foreach ($ungradedcounts as $key => $ungradedcount) { $gradeitems = grade_item::fetch_all(['courseid' => $key]); if ($key == $course1->id) { $gradeitemkeys = array_keys($gradeitems); $ungradedcountskeys = array_keys($ungradedcount['ungradedcounts']); // For each grade item there is some student that is not graded yet in course 1. $this->assertEmpty(array_diff_key($gradeitemkeys, $ungradedcountskeys)); // Only quiz does not have any grades, the remaning 4 grade items should have some. // We can do more and match by gradeitem id numbers. But feels like overengeneering. $this->assertEquals(4, count($ungradedcount['sumarray'])); } else { // In course 2 there is one student, and he is graded. $this->assertEmpty($ungradedcount['ungradedcounts']); // There are 2 grade items and they both have some grades. $this->assertEquals(2, count($ungradedcount['sumarray'])); } foreach ($gradeitems as $gradeitem) { $sumgrades = null; if (array_key_exists($gradeitem->id, $ungradedcount['ungradedcounts'])) { $ungradeditem = $ungradedcount['ungradedcounts'][$gradeitem->id]; if ($gradeitem->itemtype === 'course') { $this->assertEquals(1, $ungradeditem->count); } else if ($gradeitem->itemmodule === 'assign') { $this->assertEquals(2, $ungradeditem->count); } else if ($gradeitem->itemmodule === 'quiz') { $this->assertEquals(3, $ungradeditem->count); } else if ($gradeitem->itemtype === 'manual') { $this->assertEquals(1, $ungradeditem->count); } } if (array_key_exists($gradeitem->id, $ungradedcount['sumarray'])) { $sumgrades = $ungradedcount['sumarray'][$gradeitem->id]; if ($gradeitem->itemtype === 'course') { if ($key == $course1->id) { $this->assertEquals('98.00000', $sumgrades); // 40 + 55 + 1 + 2 } else { $this->assertEquals('40.00000', $sumgrades); } } else if ($gradeitem->itemmodule === 'assign') { if (($gradeitem->itemname === $assign1->name) || ($gradeitem->itemname === $assign3->name)) { $this->assertEquals('40.00000', $sumgrades); } else { $this->assertEquals('55.00000', $sumgrades); } } else if ($gradeitem->itemtype === 'manual') { $this->assertEquals('3.00000', $sumgrades); } } } } } /** * Tests that ungraded_counts calculates count and sum of grades correctly for groups when there are graded users. * * @covers \grade_report::ungraded_counts */ public function test_ungraded_count_sumgrades_groups() { global $DB; $this->resetAfterTest(true); $course = $this->getDataGenerator()->create_course(); $studentrole = $DB->get_record('role', ['shortname' => 'student'], '*', MUST_EXIST); // Create users. $student1 = $this->getDataGenerator()->create_user(['username' => 'student1']); $student2 = $this->getDataGenerator()->create_user(['username' => 'student2']); $student3 = $this->getDataGenerator()->create_user(['username' => 'student3']); // Enrol students. $this->getDataGenerator()->enrol_user($student1->id, $course->id, $studentrole->id); $this->getDataGenerator()->enrol_user($student2->id, $course->id, $studentrole->id); $this->getDataGenerator()->enrol_user($student3->id, $course->id, $studentrole->id); $group1 = $this->getDataGenerator()->create_group(['courseid' => $course->id]); $group2 = $this->getDataGenerator()->create_group(['courseid' => $course->id]); $this->getDataGenerator()->create_group_member(['userid' => $student1->id, 'groupid' => $group1->id]); $this->getDataGenerator()->create_group_member(['userid' => $student2->id, 'groupid' => $group2->id]); $this->getDataGenerator()->create_group_member(['userid' => $student3->id, 'groupid' => $group2->id]); $DB->set_field('course', 'groupmode', SEPARATEGROUPS, ['id' => $course->id]); // Create grade items in course 1. $assign1 = $this->getDataGenerator()->create_module('assign', ['course' => $course->id]); $assign2 = $this->getDataGenerator()->create_module('assign', ['course' => $course->id]); $quiz1 = $this->getDataGenerator()->create_module('quiz', ['course' => $course->id]); $manuaitem = new \grade_item($this->getDataGenerator()->create_grade_item([ 'itemname' => 'Grade item1', 'idnumber' => 'git1', 'courseid' => $course->id, ])); // Grade users in first course. $cm = cm_info::create(get_coursemodule_from_instance('assign', $assign1->id)); $assigninstance = new assign($cm->context, $cm, $course); $grade = $assigninstance->get_user_grade($student1->id, true); $grade->grade = 40; $assigninstance->update_grade($grade); $cm = cm_info::create(get_coursemodule_from_instance('assign', $assign2->id)); $assigninstance = new assign($cm->context, $cm, $course); $grade = $assigninstance->get_user_grade($student3->id, true); $grade->grade = 50; $assigninstance->update_grade($grade); $manuaitem->update_final_grade($student1->id, 1); $manuaitem->update_final_grade($student3->id, 2); // Trigger a regrade. grade_force_full_regrading($course->id); grade_regrade_final_grades($course->id); // Initialise report. $context = \context_course::instance($course->id); $gpr1 = new grade_plugin_return( [ 'type' => 'report', 'plugin' => 'summary', 'course' => $course, 'groupid' => $group1->id, ] ); $gpr2 = new grade_plugin_return( [ 'type' => 'report', 'plugin' => 'summary', 'course' => $course, 'groupid' => $group2->id, ] ); $report1 = new grade_report_summary($course->id, $gpr1, $context); $report2 = new grade_report_summary($course->id, $gpr2, $context); $ungradedcounts = []; $ungradedcounts[$group1->id] = $report1->ungraded_counts(); $ungradedcounts[$group2->id] = $report2->ungraded_counts(); $gradeitems = grade_item::fetch_all(['courseid' => $course->id]); // In group1 there is 1 student and assign1 and quiz1 are not graded for him. $this->assertEquals(2, count($ungradedcounts[$group1->id]['ungradedcounts'])); // In group1 manual grade item, assign1 and course total have some grades. $this->assertEquals(3, count($ungradedcounts[$group1->id]['sumarray'])); // In group2 student2 has no grades at all so all 5 grade items should present. $this->assertEquals(5, count($ungradedcounts[$group2->id]['ungradedcounts'])); // In group2 manual grade item, assign2 and course total have some grades. $this->assertEquals(3, count($ungradedcounts[$group2->id]['sumarray'])); foreach ($gradeitems as $gradeitem) { $sumgrades = null; foreach ($ungradedcounts as $key => $ungradedcount) { if (array_key_exists($gradeitem->id, $ungradedcount['ungradedcounts'])) { $ungradeditem = $ungradedcount['ungradedcounts'][$gradeitem->id]; if ($key == $group1->id) { // Both assign2 and quiz1 are not graded for student1. $this->assertEquals(1, $ungradeditem->count); } else { if ($gradeitem->itemtype === 'course') { $this->assertEquals(1, $ungradeditem->count); } else if ($gradeitem->itemmodule === 'assign') { if ($gradeitem->itemname === $assign1->name) { // In group2 assign1 is not graded for anyone. $this->assertEquals(2, $ungradeditem->count); } else { // In group2 assign2 is graded for student3. $this->assertEquals(1, $ungradeditem->count); } } else if ($gradeitem->itemmodule === 'quiz') { $this->assertEquals(2, $ungradeditem->count); } else if ($gradeitem->itemtype === 'manual') { $this->assertEquals(1, $ungradeditem->count); } } } if (array_key_exists($gradeitem->id, $ungradedcount['sumarray'])) { $sumgrades = $ungradedcount['sumarray'][$gradeitem->id]; if ($key == $group1->id) { if ($gradeitem->itemtype === 'course') { $this->assertEquals('41.00000', $sumgrades); } else if ($gradeitem->itemmodule === 'assign') { $this->assertEquals('40.00000', $sumgrades); } else if ($gradeitem->itemtype === 'manual') { $this->assertEquals('1.00000', $sumgrades); } } else { if ($gradeitem->itemtype === 'course') { $this->assertEquals('52.00000', $sumgrades); } else if ($gradeitem->itemmodule === 'assign') { $this->assertEquals('50.00000', $sumgrades); } else if ($gradeitem->itemtype === 'manual') { $this->assertEquals('2.00000', $sumgrades); } } } } } } /** * Tests for calculate_average. * @dataProvider calculate_average_data() * @param int $meanselection Whether to inlcude all grades or non-empty grades in aggregation. * @param array $expectedmeancount expected meancount value * @param array $expectedaverage expceted average value * * @covers \grade_report::calculate_average */ public function test_calculate_average(int $meanselection, array $expectedmeancount, array $expectedaverage) { global $DB; $this->resetAfterTest(true); $course = $this->getDataGenerator()->create_course(); $student1 = $this->getDataGenerator()->create_user(['username' => 'student1']); $student2 = $this->getDataGenerator()->create_user(['username' => 'student2']); $student3 = $this->getDataGenerator()->create_user(['username' => 'student3']); $studentrole = $DB->get_record('role', ['shortname' => 'student'], '*', MUST_EXIST); // Enrol students. $this->getDataGenerator()->enrol_user($student1->id, $course->id, $studentrole->id); $this->getDataGenerator()->enrol_user($student2->id, $course->id, $studentrole->id); $this->getDataGenerator()->enrol_user($student3->id, $course->id, $studentrole->id); // Create activities. $assign1 = $this->getDataGenerator()->create_module('assign', ['course' => $course->id]); $assign2 = $this->getDataGenerator()->create_module('assign', ['course' => $course->id]); $quiz1 = $this->getDataGenerator()->create_module('quiz', ['course' => $course->id]); // Grade users. $cm = cm_info::create(get_coursemodule_from_instance('assign', $assign1->id)); $assigninstance = new assign($cm->context, $cm, $course); $grade = $assigninstance->get_user_grade($student1->id, true); $grade->grade = 40; $assigninstance->update_grade($grade); $grade = $assigninstance->get_user_grade($student2->id, true); $grade->grade = 30; $assigninstance->update_grade($grade); $cm = cm_info::create(get_coursemodule_from_instance('assign', $assign2->id)); $assigninstance = new assign($cm->context, $cm, $course); $grade = $assigninstance->get_user_grade($student3->id, true); $grade->grade = 50; $assigninstance->update_grade($grade); $grade = $assigninstance->get_user_grade($student1->id, true); $grade->grade = 100; $assigninstance->update_grade($grade); // Make a manual grade items. $manuaitem = new \grade_item($this->getDataGenerator()->create_grade_item([ 'itemname' => 'Grade item1', 'idnumber' => 'git1', 'courseid' => $course->id, ])); $manuaitem->update_final_grade($student1->id, 1); $manuaitem->update_final_grade($student3->id, 2); // Initialise report. $context = \context_course::instance($course->id); $gpr = new grade_plugin_return( [ 'type' => 'report', 'plugin' => 'summary', 'course' => $course, ] ); $report = new grade_report_summary($course->id, $gpr, $context); $ungradedcounts = $report->ungraded_counts(); $ungradedcounts['report']['meanselection'] = $meanselection; $gradeitems = grade_item::fetch_all(['courseid' => $course->id]); foreach ($gradeitems as $gradeitem) { $name = $gradeitem->itemname . ' ' . $gradeitem->itemtype; $aggr = $report->calculate_average($gradeitem, $ungradedcounts); $this->assertEquals($expectedmeancount[$name], $aggr['meancount']); $this->assertEquals($expectedaverage[$name], $aggr['average']); } } /** * Data provider for test_calculate_average * * @return array of testing scenarios */ public function calculate_average_data() : array { return [ 'Non-empty grades' => [ 'meanselection' => 1, 'expectedmeancount' => [' course' => 3, 'Assignment 1 mod' => 2, 'Assignment 2 mod' => 2, 'Quiz 1 mod' => 0, 'Grade item1 manual' => 2], 'expectedaverage' => [' course' => 73.33333333333333, 'Assignment 1 mod' => 35.0, 'Assignment 2 mod' => 75.0, 'Quiz 1 mod' => null, 'Grade item1 manual' => 1.5], ], 'All grades' => [ 'meanselection' => 0, 'expectedmeancount' => [' course' => 3, 'Assignment 1 mod' => 3, 'Assignment 2 mod' => 3, 'Quiz 1 mod' => 3, 'Grade item1 manual' => 3], 'expectedaverage' => [' course' => 73.33333333333333, 'Assignment 1 mod' => 23.333333333333332, 'Assignment 2 mod' => 50.0, 'Quiz 1 mod' => null, 'Grade item1 manual' => 1.0], ], ]; } /** * Tests for item types. * * @covers \grade_report::item_types */ public function test_item_types() { $this->resetAfterTest(true); $course1 = $this->getDataGenerator()->create_course(); $course2 = $this->getDataGenerator()->create_course(); // Create activities. $this->getDataGenerator()->create_module('assign', ['course' => $course1->id]); $this->getDataGenerator()->create_module('assign', ['course' => $course1->id]); $this->getDataGenerator()->create_module('quiz', ['course' => $course1->id]); $this->getDataGenerator()->create_module('assign', ['course' => $course2->id]); // Create manual grade items. new \grade_item($this->getDataGenerator()->create_grade_item([ 'itemname' => 'Grade item1', 'idnumber' => 'git1', 'courseid' => $course1->id, ])); new \grade_item($this->getDataGenerator()->create_grade_item([ 'itemname' => 'Grade item2', 'idnumber' => 'git2', 'courseid' => $course2->id, ])); // Create a grade category (it should not be fetched by item_types). new \grade_category($this->getDataGenerator() ->create_grade_category(['courseid' => $course1->id]), false); // Initialise reports. $context = \context_course::instance($course1->id); $gpr = new grade_plugin_return( [ 'type' => 'report', 'plugin' => 'summary', 'course' => $course1, ] ); $report1 = new grade_report_summary($course1->id, $gpr, $context); $context = \context_course::instance($course2->id); $gpr = new grade_plugin_return( [ 'type' => 'report', 'plugin' => 'summary', 'course' => $course2, ] ); $report2 = new grade_report_summary($course2->id, $gpr, $context); $gradeitems1 = $report1->item_types(); $gradeitems2 = $report2->item_types(); $this->assertEquals(3, count($gradeitems1)); $this->assertEquals(2, count($gradeitems2)); $this->assertArrayHasKey('assign', $gradeitems1); $this->assertArrayHasKey('quiz', $gradeitems1); $this->assertArrayHasKey('manual', $gradeitems1); $this->assertArrayHasKey('assign', $gradeitems2); $this->assertArrayHasKey('manual', $gradeitems2); } /** * Test get_gradable_users() function. * * @covers ::get_gradable_users */ public function test_get_gradable_users() { global $DB; $this->setAdminUser(); $this->resetAfterTest(true); $roleteacher = $DB->get_record('role', ['shortname' => 'teacher'], '*', MUST_EXIST); // Create a course. $course = $this->getDataGenerator()->create_course(); $coursecontext = \context_course::instance($course->id); // Create groups. $group1 = $this->getDataGenerator()->create_group(['courseid' => $course->id]); $group2 = $this->getDataGenerator()->create_group(['courseid' => $course->id]); // Create and enrol a teacher and some students into the course. $teacher = $this->getDataGenerator()->create_and_enrol($course, 'teacher'); $student1 = $this->getDataGenerator()->create_and_enrol($course, 'student'); $student2 = $this->getDataGenerator()->create_and_enrol($course, 'student'); $student3 = $this->getDataGenerator()->create_and_enrol($course, 'student'); // Add student1 and student2 to group1. $this->getDataGenerator()->create_group_member(['groupid' => $group1->id, 'userid' => $student1->id]); $this->getDataGenerator()->create_group_member(['groupid' => $group1->id, 'userid' => $student2->id]); // Add student3 to group2. $this->getDataGenerator()->create_group_member(['groupid' => $group2->id, 'userid' => $student3->id]); // Perform a regrade before creating the report. grade_regrade_final_grades($course->id); // Should return all gradable users (only students). $gradableusers = get_gradable_users($course->id); $this->assertEqualsCanonicalizing([$student1->id, $student2->id, $student3->id], array_keys($gradableusers)); // Now, let's suspend the enrolment of student2. $this->getDataGenerator()->enrol_user($student2->id, $course->id, 'student', 'manual', 0, 0, ENROL_USER_SUSPENDED); // Should return only the active gradable users (student1 and student3). $gradableusers = get_gradable_users($course->id); $this->assertEqualsCanonicalizing([$student1->id, $student3->id], array_keys($gradableusers)); // Give teacher 'viewsuspendedusers' capability and set a preference to display suspended users. assign_capability('moodle/course:viewsuspendedusers', CAP_ALLOW, $roleteacher->id, $coursecontext, true); set_user_preference('grade_report_showonlyactiveenrol', false, $teacher); accesslib_clear_all_caches_for_unit_testing(); $this->setUser($teacher); // Should return all gradable users (including suspended enrolments). $gradableusers = get_gradable_users($course->id); $this->assertEqualsCanonicalizing([$student1->id, $student2->id, $student3->id], array_keys($gradableusers)); // Reactivate the course enrolment of student2. $this->getDataGenerator()->enrol_user($student2->id, $course->id, 'student', 'manual', 0, 0, ENROL_USER_ACTIVE); $this->setAdminUser(); // Should return all gradable users from group1 (student1 and student2). $gradableusers = get_gradable_users($course->id, $group1->id); $this->assertEqualsCanonicalizing([$student1->id, $student2->id], array_keys($gradableusers)); // Should return all gradable users from group2 (student3). $gradableusers = get_gradable_users($course->id, $group2->id); $this->assertEqualsCanonicalizing([$student3->id], array_keys($gradableusers)); } } tests/privacy/provider_test.php 0000604 00000235601 15062070557 0012777 0 ustar 00 <?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/>. /** * Data provider tests. * * @package core_grades * @category test * @copyright 2018 Frédéric Massart * @author Frédéric Massart <fred@branchup.tech> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace core_grades\privacy; defined('MOODLE_INTERNAL') || die(); global $CFG; use core_privacy\tests\provider_testcase; use core_privacy\local\request\approved_contextlist; use core_privacy\local\request\transform; use core_privacy\local\request\writer; use core_grades\privacy\provider; require_once($CFG->libdir . '/gradelib.php'); /** * Data provider testcase class. * * @package core_grades * @category test * @copyright 2018 Frédéric Massart * @author Frédéric Massart <fred@branchup.tech> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class provider_test extends provider_testcase { public function setUp(): void { global $PAGE; $this->resetAfterTest(); $PAGE->get_renderer('core'); } public function test_get_contexts_for_userid_gradebook_edits() { $dg = $this->getDataGenerator(); $c1 = $dg->create_course(); $c2 = $dg->create_course(); $u1 = $dg->create_user(); $u2 = $dg->create_user(); $u3 = $dg->create_user(); $u4 = $dg->create_user(); $u5 = $dg->create_user(); $u6 = $dg->create_user(); $u7 = $dg->create_user(); $u8 = $dg->create_user(); $u9 = $dg->create_user(); $u10 = $dg->create_user(); $u11 = $dg->create_user(); $sysctx = \context_system::instance(); $c1ctx = \context_course::instance($c1->id); $c2ctx = \context_course::instance($c2->id); // Create some stuff. $gi1a = new \grade_item($dg->create_grade_item(['courseid' => $c1->id]), false); $gi1b = new \grade_item($dg->create_grade_item(['courseid' => $c1->id]), false); $gi2a = new \grade_item($dg->create_grade_item(['courseid' => $c2->id]), false); $gc1a = new \grade_category($dg->create_grade_category(['courseid' => $c1->id]), false); $gc1b = new \grade_category($dg->create_grade_category(['courseid' => $c1->id]), false); $gc2a = new \grade_category($dg->create_grade_category(['courseid' => $c2->id]), false); $go2 = new \grade_outcome($dg->create_grade_outcome(['courseid' => $c2->id, 'shortname' => 'go2', 'fullname' => 'go2']), false); // Nothing as of now. foreach ([$u1, $u2, $u3, $u4, $u5, $u6, $u7, $u8, $u9, $u10, $u11] as $u) { $contexts = array_flip(provider::get_contexts_for_userid($u->id)->get_contextids()); $this->assertEmpty($contexts); } $go0 = new \grade_outcome(['shortname' => 'go0', 'fullname' => 'go0', 'usermodified' => $u1->id]); $go0->insert(); $go1 = new \grade_outcome(['shortname' => 'go1', 'fullname' => 'go1', 'courseid' => $c1->id, 'usermodified' => $u11->id]); $go1->insert(); // Create scales. $s1 = new \grade_scale(['name' => 's1', 'scale' => 'a,b', 'userid' => $u7->id, 'courseid' => 0, 'description' => '']); $s1->insert(); $s2 = new \grade_scale(['name' => 's2', 'scale' => 'a,b', 'userid' => $u8->id, 'courseid' => $c1->id, 'description' => '']); $s2->insert(); // User 2 creates history. $this->setUser($u2); $go0->shortname .= ' edited'; $go0->update(); $gc1a->fullname .= ' edited'; $gc1a->update(); // User 3 creates history. $this->setUser($u3); $go1->shortname .= ' edited'; $go1->update(); $gc2a->fullname .= ' a'; $gc2a->update(); // User 4 updates an outcome in course (creates history). $this->setUser($u4); $go2->shortname .= ' edited'; $go2->update(); // User 5 updates an item. $this->setUser($u5); $gi1a->itemname .= ' edited'; $gi1a->update(); // User 6 creates history. $this->setUser($u6); $gi2a->delete(); // User 9 creates history. $this->setUser($u9); $s1->name .= ' edited'; $s1->update(); // Assert contexts. $contexts = array_flip(provider::get_contexts_for_userid($u1->id)->get_contextids()); $this->assertCount(1, $contexts); $this->assertArrayHasKey($sysctx->id, $contexts); $contexts = array_flip(provider::get_contexts_for_userid($u11->id)->get_contextids()); $this->assertCount(1, $contexts); $this->assertArrayHasKey($c1ctx->id, $contexts); $contexts = array_flip(provider::get_contexts_for_userid($u2->id)->get_contextids()); $this->assertCount(2, $contexts); $this->assertArrayHasKey($sysctx->id, $contexts); $this->assertArrayHasKey($c1ctx->id, $contexts); $contexts = array_flip(provider::get_contexts_for_userid($u3->id)->get_contextids()); $this->assertCount(2, $contexts); $this->assertArrayHasKey($c1ctx->id, $contexts); $this->assertArrayHasKey($c2ctx->id, $contexts); $contexts = array_flip(provider::get_contexts_for_userid($u4->id)->get_contextids()); $this->assertCount(1, $contexts); $this->assertArrayHasKey($c2ctx->id, $contexts); $contexts = array_flip(provider::get_contexts_for_userid($u5->id)->get_contextids()); $this->assertCount(1, $contexts); $this->assertArrayHasKey($c1ctx->id, $contexts); $contexts = array_flip(provider::get_contexts_for_userid($u6->id)->get_contextids()); $this->assertCount(1, $contexts); $this->assertArrayHasKey($c2ctx->id, $contexts); $contexts = array_flip(provider::get_contexts_for_userid($u7->id)->get_contextids()); $this->assertCount(1, $contexts); $this->assertArrayHasKey($sysctx->id, $contexts); $contexts = array_flip(provider::get_contexts_for_userid($u8->id)->get_contextids()); $this->assertCount(1, $contexts); $this->assertArrayHasKey($c1ctx->id, $contexts); $contexts = array_flip(provider::get_contexts_for_userid($u9->id)->get_contextids()); $this->assertCount(1, $contexts); $this->assertArrayHasKey($sysctx->id, $contexts); // User 10 creates history. $this->setUser($u10); $s2->delete(); $contexts = array_flip(provider::get_contexts_for_userid($u10->id)->get_contextids()); $this->assertCount(1, $contexts); $this->assertArrayHasKey($c1ctx->id, $contexts); } public function test_get_contexts_for_userid_grades_and_history() { $dg = $this->getDataGenerator(); $c1 = $dg->create_course(); $c2 = $dg->create_course(); $u1 = $dg->create_user(); $u2 = $dg->create_user(); $u3 = $dg->create_user(); $u4 = $dg->create_user(); $u5 = $dg->create_user(); $u6 = $dg->create_user(); $sysctx = \context_system::instance(); $c1ctx = \context_course::instance($c1->id); $c2ctx = \context_course::instance($c2->id); // Create some stuff. $gi1a = new \grade_item($dg->create_grade_item(['courseid' => $c1->id]), false); $gi1b = new \grade_item($dg->create_grade_item(['courseid' => $c1->id]), false); $gi2a = new \grade_item($dg->create_grade_item(['courseid' => $c2->id]), false); $gi2b = new \grade_item($dg->create_grade_item(['courseid' => $c2->id]), false); // Nothing as of now. foreach ([$u1, $u2, $u3, $u4, $u5, $u6] as $u) { $contexts = array_flip(provider::get_contexts_for_userid($u->id)->get_contextids()); $this->assertEmpty($contexts); } // User 1 is graded in course 1. $gi1a->update_final_grade($u1->id, 1, 'test'); // User 2 is graded in course 2. $gi2a->update_final_grade($u2->id, 10, 'test'); // User 3 is set as modifier. $gi1a->update_final_grade($u1->id, 1, 'test', '', FORMAT_MOODLE, $u3->id); // User 4 is set as modifier, and creates history.. $this->setUser($u4); $gi1a->update_final_grade($u2->id, 1, 'test'); // User 5 creates history, user 6 is the known modifier, and we delete the item. $this->setUser($u5); $gi2b->update_final_grade($u2->id, 1, 'test', '', FORMAT_PLAIN, $u6->id); $gi2b->delete(); // Assert contexts. $contexts = array_flip(provider::get_contexts_for_userid($u1->id)->get_contextids()); $this->assertCount(1, $contexts); $this->assertArrayHasKey($c1ctx->id, $contexts); $contexts = array_flip(provider::get_contexts_for_userid($u2->id)->get_contextids()); $this->assertCount(3, $contexts); $this->assertArrayHasKey($c1ctx->id, $contexts); $this->assertArrayHasKey($c2ctx->id, $contexts); $this->assertArrayHasKey(\context_user::instance($u2->id)->id, $contexts); $contexts = array_flip(provider::get_contexts_for_userid($u3->id)->get_contextids()); $this->assertCount(1, $contexts); $this->assertArrayHasKey($c1ctx->id, $contexts); $contexts = array_flip(provider::get_contexts_for_userid($u4->id)->get_contextids()); $this->assertCount(1, $contexts); $this->assertArrayHasKey($c1ctx->id, $contexts); $contexts = array_flip(provider::get_contexts_for_userid($u5->id)->get_contextids()); $this->assertCount(2, $contexts); $this->assertArrayHasKey($c2ctx->id, $contexts); $this->assertArrayHasKey(\context_user::instance($u2->id)->id, $contexts); $contexts = array_flip(provider::get_contexts_for_userid($u6->id)->get_contextids()); $this->assertCount(1, $contexts); $this->assertArrayHasKey(\context_user::instance($u2->id)->id, $contexts); } /** * Test that the appropriate user IDs are returned for a given context. */ public function test_get_users_in_context_gradebook_edits() { $dg = $this->getDataGenerator(); $c1 = $dg->create_course(); $c2 = $dg->create_course(); $u1 = $dg->create_user(); $u2 = $dg->create_user(); $u3 = $dg->create_user(); $u4 = $dg->create_user(); $u5 = $dg->create_user(); $u6 = $dg->create_user(); $u7 = $dg->create_user(); $u8 = $dg->create_user(); $u9 = $dg->create_user(); $u10 = $dg->create_user(); $u11 = $dg->create_user(); $sysctx = \context_system::instance(); $c1ctx = \context_course::instance($c1->id); $c2ctx = \context_course::instance($c2->id); // Create some stuff. $gi1a = new \grade_item($dg->create_grade_item(['courseid' => $c1->id]), false); $gi1b = new \grade_item($dg->create_grade_item(['courseid' => $c1->id]), false); $gi2a = new \grade_item($dg->create_grade_item(['courseid' => $c2->id]), false); $gc1a = new \grade_category($dg->create_grade_category(['courseid' => $c1->id]), false); $gc1b = new \grade_category($dg->create_grade_category(['courseid' => $c1->id]), false); $gc2a = new \grade_category($dg->create_grade_category(['courseid' => $c2->id]), false); $go2 = new \grade_outcome($dg->create_grade_outcome(['courseid' => $c2->id, 'shortname' => 'go2', 'fullname' => 'go2']), false); $go0 = new \grade_outcome(['shortname' => 'go0', 'fullname' => 'go0', 'usermodified' => $u1->id]); $go0->insert(); $go1 = new \grade_outcome(['shortname' => 'go1', 'fullname' => 'go1', 'courseid' => $c1->id, 'usermodified' => $u11->id]); $go1->insert(); // Create scales. $s1 = new \grade_scale(['name' => 's1', 'scale' => 'a,b', 'userid' => $u7->id, 'courseid' => 0, 'description' => '']); $s1->insert(); $s2 = new \grade_scale(['name' => 's2', 'scale' => 'a,b', 'userid' => $u8->id, 'courseid' => $c1->id, 'description' => '']); $s2->insert(); // User 2 creates history. $this->setUser($u2); $go0->shortname .= ' edited'; $go0->update(); $gc1a->fullname .= ' edited'; $gc1a->update(); // User 3 creates history. $this->setUser($u3); $go1->shortname .= ' edited'; $go1->update(); $gc2a->fullname .= ' a'; $gc2a->update(); // User 4 updates an outcome in course (creates history). $this->setUser($u4); $go2->shortname .= ' edited'; $go2->update(); // User 5 updates an item. $this->setUser($u5); $gi1a->itemname .= ' edited'; $gi1a->update(); // User 6 creates history. $this->setUser($u6); $gi2a->delete(); // User 9 creates history. $this->setUser($u9); $s1->name .= ' edited'; $s1->update(); $userlist = new \core_privacy\local\request\userlist($sysctx, 'core_grades'); provider::get_users_in_context($userlist); $systemcontextuserids = [$u1->id, $u2->id, $u7->id, $u9->id]; $this->assertEquals($systemcontextuserids, $userlist->get_userids()); $userlist = new \core_privacy\local\request\userlist($c1ctx, 'core_grades'); provider::get_users_in_context($userlist); $course1userids = [$u11->id, $u3->id, $u8->id, $u5->id, $u2->id]; $this->assertEquals($course1userids, $userlist->get_userids()); $userlist = new \core_privacy\local\request\userlist($c2ctx, 'core_grades'); provider::get_users_in_context($userlist); $course2userids = [$u4->id, $u6->id, $u3->id]; $this->assertEquals($course2userids, $userlist->get_userids()); } /** * Test that the appropriate user IDs are returned for a given context. */ public function test_get_users_in_context_grades_and_history() { $dg = $this->getDataGenerator(); $c1 = $dg->create_course(); $c2 = $dg->create_course(); $u1 = $dg->create_user(); $u2 = $dg->create_user(); $u3 = $dg->create_user(); $u4 = $dg->create_user(); $u5 = $dg->create_user(); $u6 = $dg->create_user(); $c1ctx = \context_course::instance($c1->id); $c2ctx = \context_course::instance($c2->id); $u2ctx = \context_user::instance($u2->id); // Create some stuff. $gi1a = new \grade_item($dg->create_grade_item(['courseid' => $c1->id]), false); $gi1b = new \grade_item($dg->create_grade_item(['courseid' => $c1->id]), false); $gi2a = new \grade_item($dg->create_grade_item(['courseid' => $c2->id]), false); $gi2b = new \grade_item($dg->create_grade_item(['courseid' => $c2->id]), false); // User 1 is graded in course 1. $gi1a->update_final_grade($u1->id, 1, 'test'); // User 2 is graded in course 2. $gi2a->update_final_grade($u2->id, 10, 'test'); // User 3 is set as modifier. $gi1a->update_final_grade($u1->id, 1, 'test', '', FORMAT_MOODLE, $u3->id); // User 4 is set as modifier, and creates history.. $this->setUser($u4); $gi1a->update_final_grade($u2->id, 1, 'test'); // User 5 creates history, user 6 is the known modifier, and we delete the item. $this->setUser($u5); $gi2b->update_final_grade($u2->id, 1, 'test', '', FORMAT_PLAIN, $u6->id); $gi2b->delete(); $userlist = new \core_privacy\local\request\userlist($c1ctx, 'core_grades'); provider::get_users_in_context($userlist); $course1userids = [$u1->id, $u2->id, $u3->id, $u4->id]; $this->assertEqualsCanonicalizing($course1userids, $userlist->get_userids()); $userlist = new \core_privacy\local\request\userlist($c2ctx, 'core_grades'); provider::get_users_in_context($userlist); $course2userids = [$u5->id, $u2->id]; $this->assertEqualsCanonicalizing($course2userids, $userlist->get_userids()); $userlist = new \core_privacy\local\request\userlist($u2ctx, 'core_grades'); provider::get_users_in_context($userlist); $this->assertEquals([$u2->id], $userlist->get_userids()); } public function test_delete_data_for_all_users_in_context() { global $DB; $fs = new \file_storage(); $dg = $this->getDataGenerator(); $c1 = $dg->create_course(); $c2 = $dg->create_course(); $u1 = $dg->create_user(); $u2 = $dg->create_user(); $u1ctx = \context_user::instance($u1->id); $c1ctx = \context_course::instance($c1->id); $c2ctx = \context_course::instance($c2->id); $a1 = $dg->create_module('assign', ['course' => $c1->id]); $a2 = $dg->create_module('assign', ['course' => $c1->id]); $a3 = $dg->create_module('assign', ['course' => $c2->id]); $a4 = $dg->create_module('assign', ['course' => $c2->id]); $a1context = \context_module::instance($a1->cmid); $a2context = \context_module::instance($a2->cmid); $a3context = \context_module::instance($a3->cmid); $a4context = \context_module::instance($a4->cmid); // Create some stuff. $gi1a = new \grade_item($dg->create_grade_item( [ 'courseid' => $c1->id, 'itemtype' => 'mod', 'itemmodule' => 'assign', 'iteminstance' => $a1->id ] ), false); $gi1b = new \grade_item($dg->create_grade_item( [ 'courseid' => $c1->id, 'itemtype' => 'mod', 'itemmodule' => 'assign', 'iteminstance' => $a2->id ] ), false); $gi2a = new \grade_item($dg->create_grade_item( [ 'courseid' => $c2->id, 'itemtype' => 'mod', 'itemmodule' => 'assign', 'iteminstance' => $a3->id ] ), false); $gi2b = new \grade_item($dg->create_grade_item( [ 'courseid' => $c2->id, 'itemtype' => 'mod', 'itemmodule' => 'assign', 'iteminstance' => $a4->id ] ), false); $this->add_feedback_file_to_copy(); $grades['feedback'] = 'Nice feedback!'; $grades['feedbackformat'] = FORMAT_MOODLE; $grades['feedbackfiles'] = [ 'contextid' => 1, 'component' => 'test', 'filearea' => 'testarea', 'itemid' => 1 ]; $grades['userid'] = $u1->id; grade_update('mod/assign', $gi1a->courseid, $gi1a->itemtype, $gi1a->itemmodule, $gi1a->iteminstance, $gi1a->itemnumber, $grades); $grades['userid'] = $u2->id; grade_update('mod/assign', $gi1a->courseid, $gi1a->itemtype, $gi1a->itemmodule, $gi1a->iteminstance, $gi1a->itemnumber, $grades); $grades['userid'] = $u1->id; grade_update('mod/assign', $gi1b->courseid, $gi1b->itemtype, $gi1b->itemmodule, $gi1b->iteminstance, $gi1b->itemnumber, $grades); $grades['userid'] = $u1->id; grade_update('mod/assign', $gi2a->courseid, $gi2a->itemtype, $gi2a->itemmodule, $gi2a->iteminstance, $gi2a->itemnumber, $grades); $grades['userid'] = $u2->id; grade_update('mod/assign', $gi2a->courseid, $gi2a->itemtype, $gi2a->itemmodule, $gi2a->iteminstance, $gi2a->itemnumber, $grades); $grades['userid'] = $u1->id; grade_update('mod/assign', $gi2b->courseid, $gi2b->itemtype, $gi2b->itemmodule, $gi2b->iteminstance, $gi2b->itemnumber, $grades); $grades['userid'] = $u2->id; grade_update('mod/assign', $gi2b->courseid, $gi2b->itemtype, $gi2b->itemmodule, $gi2b->iteminstance, $gi2b->itemnumber, $grades); $gi2b->delete(); // Feedback file area. $files = $fs->get_area_files($a1context->id, GRADE_FILE_COMPONENT, GRADE_FEEDBACK_FILEAREA); $this->assertEquals(4, count($files)); $files = $fs->get_area_files($a2context->id, GRADE_FILE_COMPONENT, GRADE_FEEDBACK_FILEAREA); $this->assertEquals(2, count($files)); $files = $fs->get_area_files($a3context->id, GRADE_FILE_COMPONENT, GRADE_FEEDBACK_FILEAREA); $this->assertEquals(4, count($files)); // Grade item 2 was deleted, so the associated files were as well. $files = $fs->get_area_files($a4context->id, GRADE_FILE_COMPONENT, GRADE_FEEDBACK_FILEAREA); $this->assertEquals(0, count($files)); // History file area. $files = $fs->get_area_files($a1context->id, GRADE_FILE_COMPONENT, GRADE_HISTORY_FEEDBACK_FILEAREA); $this->assertEquals(4, count($files)); $files = $fs->get_area_files($a2context->id, GRADE_FILE_COMPONENT, GRADE_HISTORY_FEEDBACK_FILEAREA); $this->assertEquals(2, count($files)); $files = $fs->get_area_files($a3context->id, GRADE_FILE_COMPONENT, GRADE_HISTORY_FEEDBACK_FILEAREA); $this->assertEquals(4, count($files)); // Grade item 2 was deleted, so the associated files were as well. $files = $fs->get_area_files($a4context->id, GRADE_FILE_COMPONENT, GRADE_HISTORY_FEEDBACK_FILEAREA); $this->assertEquals(0, count($files)); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u1->id, 'itemid' => $gi1a->id])); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u2->id, 'itemid' => $gi1a->id])); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u1->id, 'itemid' => $gi1b->id])); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u1->id, 'itemid' => $gi2a->id])); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u2->id, 'itemid' => $gi2a->id])); $this->assertTrue($DB->record_exists('grade_grades_history', ['userid' => $u1->id, 'itemid' => $gi2b->id])); $this->assertTrue($DB->record_exists('grade_grades_history', ['userid' => $u2->id, 'itemid' => $gi2b->id])); provider::delete_data_for_all_users_in_context($c1ctx); $this->assertFalse($DB->record_exists('grade_grades', ['userid' => $u1->id, 'itemid' => $gi1a->id])); $this->assertFalse($DB->record_exists('grade_grades', ['userid' => $u2->id, 'itemid' => $gi1a->id])); $this->assertFalse($DB->record_exists('grade_grades', ['userid' => $u1->id, 'itemid' => $gi1b->id])); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u1->id, 'itemid' => $gi2a->id])); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u2->id, 'itemid' => $gi2a->id])); $this->assertTrue($DB->record_exists('grade_grades_history', ['userid' => $u1->id, 'itemid' => $gi2b->id])); $this->assertTrue($DB->record_exists('grade_grades_history', ['userid' => $u2->id, 'itemid' => $gi2b->id])); // Feedback file area. $files = $fs->get_area_files($a1context->id, GRADE_FILE_COMPONENT, GRADE_FEEDBACK_FILEAREA); $this->assertEquals(0, count($files)); $files = $fs->get_area_files($a2context->id, GRADE_FILE_COMPONENT, GRADE_FEEDBACK_FILEAREA); $this->assertEquals(0, count($files)); $files = $fs->get_area_files($a3context->id, GRADE_FILE_COMPONENT, GRADE_FEEDBACK_FILEAREA); $this->assertEquals(4, count($files)); // Grade item 2 was deleted, so the associated files were as well. $files = $fs->get_area_files($a4context->id, GRADE_FILE_COMPONENT, GRADE_FEEDBACK_FILEAREA); $this->assertEquals(0, count($files)); // History file area. $files = $fs->get_area_files($a1context->id, GRADE_FILE_COMPONENT, GRADE_HISTORY_FEEDBACK_FILEAREA); $this->assertEquals(0, count($files)); $files = $fs->get_area_files($a2context->id, GRADE_FILE_COMPONENT, GRADE_HISTORY_FEEDBACK_FILEAREA); $this->assertEquals(0, count($files)); $files = $fs->get_area_files($a3context->id, GRADE_FILE_COMPONENT, GRADE_HISTORY_FEEDBACK_FILEAREA); $this->assertEquals(4, count($files)); // Grade item 2 was deleted, so the associated files were as well. $files = $fs->get_area_files($a4context->id, GRADE_FILE_COMPONENT, GRADE_HISTORY_FEEDBACK_FILEAREA); $this->assertEquals(0, count($files)); provider::delete_data_for_all_users_in_context($u1ctx); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u1->id, 'itemid' => $gi2a->id])); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u2->id, 'itemid' => $gi2a->id])); $this->assertFalse($DB->record_exists('grade_grades_history', ['userid' => $u1->id, 'itemid' => $gi2b->id])); $this->assertTrue($DB->record_exists('grade_grades_history', ['userid' => $u2->id, 'itemid' => $gi2b->id])); // Feedback file area. $files = $fs->get_area_files($a1context->id, GRADE_FILE_COMPONENT, GRADE_FEEDBACK_FILEAREA); $this->assertEquals(0, count($files)); $files = $fs->get_area_files($a2context->id, GRADE_FILE_COMPONENT, GRADE_FEEDBACK_FILEAREA); $this->assertEquals(0, count($files)); // The user context is only reported when there are orphan historical grades, so we only delete those files. $files = $fs->get_area_files($a3context->id, GRADE_FILE_COMPONENT, GRADE_FEEDBACK_FILEAREA); $this->assertEquals(4, count($files)); // Grade item 2 was deleted, so the associated files were as well. $files = $fs->get_area_files($a4context->id, GRADE_FILE_COMPONENT, GRADE_FEEDBACK_FILEAREA); $this->assertEquals(0, count($files)); // History file area. $files = $fs->get_area_files($a1context->id, GRADE_FILE_COMPONENT, GRADE_HISTORY_FEEDBACK_FILEAREA); $this->assertEquals(0, count($files)); $files = $fs->get_area_files($a2context->id, GRADE_FILE_COMPONENT, GRADE_HISTORY_FEEDBACK_FILEAREA); $this->assertEquals(0, count($files)); // User 2 still has historical files. $files = $fs->get_area_files($a3context->id, GRADE_FILE_COMPONENT, GRADE_HISTORY_FEEDBACK_FILEAREA); $this->assertEquals(2, count($files)); // Grade item 2 was deleted, so the associated files were as well. $files = $fs->get_area_files($a4context->id, GRADE_FILE_COMPONENT, GRADE_HISTORY_FEEDBACK_FILEAREA); $this->assertEquals(0, count($files)); provider::delete_data_for_all_users_in_context($c2ctx); $this->assertFalse($DB->record_exists('grade_grades', ['userid' => $u1->id, 'itemid' => $gi2a->id])); $this->assertFalse($DB->record_exists('grade_grades', ['userid' => $u2->id, 'itemid' => $gi2a->id])); $this->assertTrue($DB->record_exists('grade_grades_history', ['userid' => $u2->id, 'itemid' => $gi2b->id])); // Feedback file area. $files = $fs->get_area_files($a1context->id, GRADE_FILE_COMPONENT, GRADE_FEEDBACK_FILEAREA); $this->assertEquals(0, count($files)); $files = $fs->get_area_files($a2context->id, GRADE_FILE_COMPONENT, GRADE_FEEDBACK_FILEAREA); $this->assertEquals(0, count($files)); $files = $fs->get_area_files($a3context->id, GRADE_FILE_COMPONENT, GRADE_FEEDBACK_FILEAREA); $this->assertEquals(0, count($files)); $files = $fs->get_area_files($a4context->id, GRADE_FILE_COMPONENT, GRADE_FEEDBACK_FILEAREA); $this->assertEquals(0, count($files)); // History file area. $files = $fs->get_area_files($a1context->id, GRADE_FILE_COMPONENT, GRADE_HISTORY_FEEDBACK_FILEAREA); $this->assertEquals(0, count($files)); $files = $fs->get_area_files($a2context->id, GRADE_FILE_COMPONENT, GRADE_HISTORY_FEEDBACK_FILEAREA); $this->assertEquals(0, count($files)); $files = $fs->get_area_files($a3context->id, GRADE_FILE_COMPONENT, GRADE_HISTORY_FEEDBACK_FILEAREA); $this->assertEquals(0, count($files)); $files = $fs->get_area_files($a4context->id, GRADE_FILE_COMPONENT, GRADE_HISTORY_FEEDBACK_FILEAREA); $this->assertEquals(0, count($files)); } public function test_delete_data_for_user() { global $DB; $fs = new \file_storage(); $dg = $this->getDataGenerator(); $c1 = $dg->create_course(); $c2 = $dg->create_course(); $u1 = $dg->create_user(); $u2 = $dg->create_user(); $u1ctx = \context_user::instance($u1->id); $u2ctx = \context_user::instance($u2->id); $c1ctx = \context_course::instance($c1->id); $c2ctx = \context_course::instance($c2->id); $a1 = $dg->create_module('assign', ['course' => $c1->id]); $a2 = $dg->create_module('assign', ['course' => $c1->id]); $a3 = $dg->create_module('assign', ['course' => $c2->id]); $a4 = $dg->create_module('assign', ['course' => $c2->id]); $a1context = \context_module::instance($a1->cmid); $a2context = \context_module::instance($a2->cmid); $a3context = \context_module::instance($a3->cmid); $a4context = \context_module::instance($a4->cmid); // Create some stuff. $gi1a = new \grade_item($dg->create_grade_item( [ 'courseid' => $c1->id, 'itemtype' => 'mod', 'itemmodule' => 'assign', 'iteminstance' => $a1->id ] ), false); $gi1b = new \grade_item($dg->create_grade_item( [ 'courseid' => $c1->id, 'itemtype' => 'mod', 'itemmodule' => 'assign', 'iteminstance' => $a2->id ] ), false); $gi2a = new \grade_item($dg->create_grade_item( [ 'courseid' => $c2->id, 'itemtype' => 'mod', 'itemmodule' => 'assign', 'iteminstance' => $a3->id ] ), false); $gi2b = new \grade_item($dg->create_grade_item( [ 'courseid' => $c2->id, 'itemtype' => 'mod', 'itemmodule' => 'assign', 'iteminstance' => $a4->id ] ), false); $this->add_feedback_file_to_copy(); $grades['feedback'] = 'Nice feedback!'; $grades['feedbackfiles'] = [ 'contextid' => 1, 'component' => 'test', 'filearea' => 'testarea', 'itemid' => 1 ]; $grades['userid'] = $u1->id; grade_update('mod/assign', $gi1a->courseid, $gi1a->itemtype, $gi1a->itemmodule, $gi1a->iteminstance, $gi1a->itemnumber, $grades); $grades['userid'] = $u2->id; grade_update('mod/assign', $gi1a->courseid, $gi1a->itemtype, $gi1a->itemmodule, $gi1a->iteminstance, $gi1a->itemnumber, $grades); $grades['userid'] = $u1->id; grade_update('mod/assign', $gi1b->courseid, $gi1b->itemtype, $gi1b->itemmodule, $gi1b->iteminstance, $gi1b->itemnumber, $grades); $grades['userid'] = $u1->id; grade_update('mod/assign', $gi2a->courseid, $gi2a->itemtype, $gi2a->itemmodule, $gi2a->iteminstance, $gi2a->itemnumber, $grades); $grades['userid'] = $u2->id; grade_update('mod/assign', $gi2a->courseid, $gi2a->itemtype, $gi2a->itemmodule, $gi2a->iteminstance, $gi2a->itemnumber, $grades); $grades['userid'] = $u1->id; grade_update('mod/assign', $gi2b->courseid, $gi2b->itemtype, $gi2b->itemmodule, $gi2b->iteminstance, $gi2b->itemnumber, $grades); $grades['userid'] = $u2->id; grade_update('mod/assign', $gi2b->courseid, $gi2b->itemtype, $gi2b->itemmodule, $gi2b->iteminstance, $gi2b->itemnumber, $grades); $gi2b->delete(); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u1->id, 'itemid' => $gi1a->id])); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u2->id, 'itemid' => $gi1a->id])); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u1->id, 'itemid' => $gi1b->id])); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u1->id, 'itemid' => $gi2a->id])); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u2->id, 'itemid' => $gi2a->id])); $this->assertTrue($DB->record_exists('grade_grades_history', ['userid' => $u1->id, 'itemid' => $gi2b->id])); $this->assertTrue($DB->record_exists('grade_grades_history', ['userid' => $u2->id, 'itemid' => $gi2b->id])); // Feedback file area. $files = $fs->get_area_files($a1context->id, GRADE_FILE_COMPONENT, GRADE_FEEDBACK_FILEAREA); $this->assertEquals(4, count($files)); $files = $fs->get_area_files($a2context->id, GRADE_FILE_COMPONENT, GRADE_FEEDBACK_FILEAREA); $this->assertEquals(2, count($files)); $files = $fs->get_area_files($a3context->id, GRADE_FILE_COMPONENT, GRADE_FEEDBACK_FILEAREA); $this->assertEquals(4, count($files)); // Grade item 2 was deleted, so the associated files were as well. $files = $fs->get_area_files($a4context->id, GRADE_FILE_COMPONENT, GRADE_FEEDBACK_FILEAREA); $this->assertEquals(0, count($files)); // History file area. $files = $fs->get_area_files($a1context->id, GRADE_FILE_COMPONENT, GRADE_HISTORY_FEEDBACK_FILEAREA); $this->assertEquals(4, count($files)); $files = $fs->get_area_files($a2context->id, GRADE_FILE_COMPONENT, GRADE_HISTORY_FEEDBACK_FILEAREA); $this->assertEquals(2, count($files)); $files = $fs->get_area_files($a3context->id, GRADE_FILE_COMPONENT, GRADE_HISTORY_FEEDBACK_FILEAREA); $this->assertEquals(4, count($files)); // Grade item 2 was deleted, so the associated files were as well. $files = $fs->get_area_files($a4context->id, GRADE_FILE_COMPONENT, GRADE_HISTORY_FEEDBACK_FILEAREA); $this->assertEquals(0, count($files)); provider::delete_data_for_user(new approved_contextlist($u1, 'core_grades', [$c1ctx->id])); $this->assertFalse($DB->record_exists('grade_grades', ['userid' => $u1->id, 'itemid' => $gi1a->id])); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u2->id, 'itemid' => $gi1a->id])); $this->assertFalse($DB->record_exists('grade_grades', ['userid' => $u1->id, 'itemid' => $gi1b->id])); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u1->id, 'itemid' => $gi2a->id])); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u2->id, 'itemid' => $gi2a->id])); $this->assertTrue($DB->record_exists('grade_grades_history', ['userid' => $u1->id, 'itemid' => $gi2b->id])); $this->assertTrue($DB->record_exists('grade_grades_history', ['userid' => $u2->id, 'itemid' => $gi2b->id])); // Feedback file area. $files = $fs->get_area_files($a1context->id, GRADE_FILE_COMPONENT, GRADE_FEEDBACK_FILEAREA); $this->assertEquals(2, count($files)); $files = $fs->get_area_files($a2context->id, GRADE_FILE_COMPONENT, GRADE_FEEDBACK_FILEAREA); $this->assertEquals(0, count($files)); $files = $fs->get_area_files($a3context->id, GRADE_FILE_COMPONENT, GRADE_FEEDBACK_FILEAREA); $this->assertEquals(4, count($files)); // Grade item 2 was deleted, so the associated files were as well. $files = $fs->get_area_files($a4context->id, GRADE_FILE_COMPONENT, GRADE_FEEDBACK_FILEAREA); $this->assertEquals(0, count($files)); // History file area. $files = $fs->get_area_files($a1context->id, GRADE_FILE_COMPONENT, GRADE_HISTORY_FEEDBACK_FILEAREA); $this->assertEquals(2, count($files)); $files = $fs->get_area_files($a2context->id, GRADE_FILE_COMPONENT, GRADE_HISTORY_FEEDBACK_FILEAREA); $this->assertEquals(0, count($files)); $files = $fs->get_area_files($a3context->id, GRADE_FILE_COMPONENT, GRADE_HISTORY_FEEDBACK_FILEAREA); $this->assertEquals(4, count($files)); // Grade item 2 was deleted, so the associated files were as well. $files = $fs->get_area_files($a4context->id, GRADE_FILE_COMPONENT, GRADE_HISTORY_FEEDBACK_FILEAREA); $this->assertEquals(0, count($files)); provider::delete_data_for_user(new approved_contextlist($u1, 'core_grades', [$u1ctx->id])); $this->assertFalse($DB->record_exists('grade_grades', ['userid' => $u1->id, 'itemid' => $gi1a->id])); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u2->id, 'itemid' => $gi1a->id])); $this->assertFalse($DB->record_exists('grade_grades', ['userid' => $u1->id, 'itemid' => $gi1b->id])); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u1->id, 'itemid' => $gi2a->id])); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u2->id, 'itemid' => $gi2a->id])); $this->assertFalse($DB->record_exists('grade_grades_history', ['userid' => $u1->id, 'itemid' => $gi2b->id])); $this->assertTrue($DB->record_exists('grade_grades_history', ['userid' => $u2->id, 'itemid' => $gi2b->id])); // Feedback file area. $files = $fs->get_area_files($a1context->id, GRADE_FILE_COMPONENT, GRADE_FEEDBACK_FILEAREA); $this->assertEquals(2, count($files)); $files = $fs->get_area_files($a2context->id, GRADE_FILE_COMPONENT, GRADE_FEEDBACK_FILEAREA); $this->assertEquals(0, count($files)); $files = $fs->get_area_files($a3context->id, GRADE_FILE_COMPONENT, GRADE_FEEDBACK_FILEAREA); $this->assertEquals(4, count($files)); // Grade item 2 was deleted, so the associated files were as well. $files = $fs->get_area_files($a4context->id, GRADE_FILE_COMPONENT, GRADE_FEEDBACK_FILEAREA); $this->assertEquals(0, count($files)); // History file area. $files = $fs->get_area_files($a1context->id, GRADE_FILE_COMPONENT, GRADE_HISTORY_FEEDBACK_FILEAREA); $this->assertEquals(2, count($files)); $files = $fs->get_area_files($a2context->id, GRADE_FILE_COMPONENT, GRADE_HISTORY_FEEDBACK_FILEAREA); $this->assertEquals(0, count($files)); $files = $fs->get_area_files($a3context->id, GRADE_FILE_COMPONENT, GRADE_HISTORY_FEEDBACK_FILEAREA); $this->assertEquals(2, count($files)); // Grade item 2 was deleted, so the associated files were as well. $files = $fs->get_area_files($a4context->id, GRADE_FILE_COMPONENT, GRADE_HISTORY_FEEDBACK_FILEAREA); $this->assertEquals(0, count($files)); provider::delete_data_for_user(new approved_contextlist($u1, 'core_grades', [$u2ctx->id, $c2ctx->id])); $this->assertFalse($DB->record_exists('grade_grades', ['userid' => $u1->id, 'itemid' => $gi1a->id])); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u2->id, 'itemid' => $gi1a->id])); $this->assertFalse($DB->record_exists('grade_grades', ['userid' => $u1->id, 'itemid' => $gi1b->id])); $this->assertFalse($DB->record_exists('grade_grades', ['userid' => $u1->id, 'itemid' => $gi2a->id])); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u2->id, 'itemid' => $gi2a->id])); $this->assertFalse($DB->record_exists('grade_grades_history', ['userid' => $u1->id, 'itemid' => $gi2b->id])); $this->assertTrue($DB->record_exists('grade_grades_history', ['userid' => $u2->id, 'itemid' => $gi2b->id])); // Feedback file area. $files = $fs->get_area_files($a1context->id, GRADE_FILE_COMPONENT, GRADE_FEEDBACK_FILEAREA); $this->assertEquals(2, count($files)); $files = $fs->get_area_files($a2context->id, GRADE_FILE_COMPONENT, GRADE_FEEDBACK_FILEAREA); $this->assertEquals(0, count($files)); $files = $fs->get_area_files($a3context->id, GRADE_FILE_COMPONENT, GRADE_FEEDBACK_FILEAREA); $this->assertEquals(2, count($files)); // Grade item 2 was deleted, so the associated files were as well. $files = $fs->get_area_files($a4context->id, GRADE_FILE_COMPONENT, GRADE_FEEDBACK_FILEAREA); $this->assertEquals(0, count($files)); // History file area. $files = $fs->get_area_files($a1context->id, GRADE_FILE_COMPONENT, GRADE_HISTORY_FEEDBACK_FILEAREA); $this->assertEquals(2, count($files)); $files = $fs->get_area_files($a2context->id, GRADE_FILE_COMPONENT, GRADE_HISTORY_FEEDBACK_FILEAREA); $this->assertEquals(0, count($files)); $files = $fs->get_area_files($a3context->id, GRADE_FILE_COMPONENT, GRADE_HISTORY_FEEDBACK_FILEAREA); $this->assertEquals(2, count($files)); // Grade item 2 was deleted, so the associated files were as well. $files = $fs->get_area_files($a4context->id, GRADE_FILE_COMPONENT, GRADE_HISTORY_FEEDBACK_FILEAREA); $this->assertEquals(0, count($files)); } /** * Test deleting multiple users for a context works. */ public function test_delete_data_for_users() { global $DB; $dg = $this->getDataGenerator(); $c1 = $dg->create_course(); $c2 = $dg->create_course(); $u1 = $dg->create_user(); $u2 = $dg->create_user(); $u3 = $dg->create_user(); $u4 = $dg->create_user(); $u1ctx = \context_user::instance($u1->id); $u2ctx = \context_user::instance($u2->id); $c1ctx = \context_course::instance($c1->id); $c2ctx = \context_course::instance($c2->id); // Create some stuff. $gi1a = new \grade_item($dg->create_grade_item(['courseid' => $c1->id]), false); $gi1b = new \grade_item($dg->create_grade_item(['courseid' => $c1->id]), false); $gi2a = new \grade_item($dg->create_grade_item(['courseid' => $c2->id]), false); $gi2b = new \grade_item($dg->create_grade_item(['courseid' => $c2->id]), false); $gi1a->update_final_grade($u1->id, 1, 'test'); $gi1a->update_final_grade($u2->id, 1, 'test'); $gi1a->update_final_grade($u3->id, 1, 'test'); $gi1b->update_final_grade($u1->id, 1, 'test'); $gi1b->update_final_grade($u4->id, 1, 'test'); $gi2a->update_final_grade($u1->id, 1, 'test'); $gi2a->update_final_grade($u2->id, 1, 'test'); $gi2a->update_final_grade($u4->id, 1, 'test'); $gi2b->update_final_grade($u1->id, 1, 'test'); $gi2b->update_final_grade($u2->id, 1, 'test'); $gi2b->update_final_grade($u3->id, 1, 'test'); $gi2b->delete(); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u1->id, 'itemid' => $gi1a->id])); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u2->id, 'itemid' => $gi1a->id])); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u3->id, 'itemid' => $gi1a->id])); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u1->id, 'itemid' => $gi1b->id])); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u4->id, 'itemid' => $gi1b->id])); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u1->id, 'itemid' => $gi2a->id])); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u2->id, 'itemid' => $gi2a->id])); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u4->id, 'itemid' => $gi2a->id])); $this->assertFalse($DB->record_exists('grade_grades', ['userid' => $u1->id, 'itemid' => $gi2b->id])); $this->assertFalse($DB->record_exists('grade_grades', ['userid' => $u2->id, 'itemid' => $gi2b->id])); $this->assertFalse($DB->record_exists('grade_grades', ['userid' => $u3->id, 'itemid' => $gi2b->id])); $userlist = new \core_privacy\local\request\approved_userlist($c1ctx, 'core_grades', [$u1->id, $u2->id]); provider::delete_data_for_users($userlist); $this->assertFalse($DB->record_exists('grade_grades', ['userid' => $u1->id, 'itemid' => $gi1a->id])); $this->assertFalse($DB->record_exists('grade_grades', ['userid' => $u2->id, 'itemid' => $gi1a->id])); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u3->id, 'itemid' => $gi1a->id])); $this->assertFalse($DB->record_exists('grade_grades', ['userid' => $u1->id, 'itemid' => $gi1b->id])); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u4->id, 'itemid' => $gi1b->id])); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u1->id, 'itemid' => $gi2a->id])); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u2->id, 'itemid' => $gi2a->id])); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u4->id, 'itemid' => $gi2a->id])); $userlist = new \core_privacy\local\request\approved_userlist($c2ctx, 'core_grades', [$u2->id, $u4->id]); provider::delete_data_for_users($userlist); $this->assertFalse($DB->record_exists('grade_grades', ['userid' => $u1->id, 'itemid' => $gi1a->id])); $this->assertFalse($DB->record_exists('grade_grades', ['userid' => $u2->id, 'itemid' => $gi1a->id])); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u3->id, 'itemid' => $gi1a->id])); $this->assertFalse($DB->record_exists('grade_grades', ['userid' => $u1->id, 'itemid' => $gi1b->id])); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u4->id, 'itemid' => $gi1b->id])); $this->assertTrue($DB->record_exists('grade_grades', ['userid' => $u1->id, 'itemid' => $gi2a->id])); $this->assertFalse($DB->record_exists('grade_grades', ['userid' => $u2->id, 'itemid' => $gi2a->id])); $this->assertFalse($DB->record_exists('grade_grades', ['userid' => $u4->id, 'itemid' => $gi2a->id])); } public function test_export_data_for_user_about_grades_and_history() { $dg = $this->getDataGenerator(); $c1 = $dg->create_course(); $c2 = $dg->create_course(); // Users being graded. $ug1 = $dg->create_user(); $ug2 = $dg->create_user(); $ug3 = $dg->create_user(); // Users performing actions. $ua1 = $dg->create_user(); $ua2 = $dg->create_user(); $ua3 = $dg->create_user(); $ug1ctx = \context_user::instance($ug1->id); $ug2ctx = \context_user::instance($ug2->id); $c1ctx = \context_course::instance($c1->id); $c2ctx = \context_course::instance($c2->id); $rootpath = [get_string('grades', 'core_grades')]; $relatedtomepath = array_merge($rootpath, [get_string('privacy:path:relatedtome', 'core_grades')]); // Create the course minimal stuff. \grade_category::fetch_course_category($c1->id); $ci1 = \grade_item::fetch_course_item($c1->id); \grade_category::fetch_course_category($c2->id); $ci2 = \grade_item::fetch_course_item($c2->id); $this->add_feedback_file_to_copy(); $grades['feedbackfiles'] = [ 'contextid' => 1, 'component' => 'test', 'filearea' => 'testarea', 'itemid' => 1 ]; $a1 = $dg->create_module('assign', ['course' => $c1->id]); // Create data that will sit in the user context because we will delete the grate item. $gi1 = new \grade_item($dg->create_grade_item( [ 'courseid' => $c1->id, 'itemtype' => 'mod', 'itemmodule' => 'assign', 'iteminstance' => $a1->id, 'aggregationcoef2' => 1 ] ), false); $grades['feedback'] = 'Well done!'; $grades['feedbackformat'] = FORMAT_PLAIN; $grades['userid'] = $ug1->id; $grades['usermodified'] = $ua2->id; $grades['rawgrade'] = 100; grade_update('mod/assign', $gi1->courseid, $gi1->itemtype, $gi1->itemmodule, $gi1->iteminstance, $gi1->itemnumber, $grades); $grades['feedback'] = 'Hi'; $grades['userid'] = $ug1->id; $grades['usermodified'] = $ua2->id; $grades['rawgrade'] = 1; grade_update('mod/assign', $gi1->courseid, $gi1->itemtype, $gi1->itemmodule, $gi1->iteminstance, $gi1->itemnumber, $grades); $grades['feedback'] = 'Hello'; $grades['userid'] = $ug3->id; $grades['usermodified'] = $ua2->id; $grades['rawgrade'] = 12; grade_update('mod/assign', $gi1->courseid, $gi1->itemtype, $gi1->itemmodule, $gi1->iteminstance, $gi1->itemnumber, $grades); // Create another set for another user. $a2 = $dg->create_module('assign', ['course' => $c2->id]); $a3 = $dg->create_module('assign', ['course' => $c2->id]); $gi2a = new \grade_item($dg->create_grade_item( [ 'courseid' => $c2->id, 'itemtype' => 'mod', 'itemmodule' => 'assign', 'iteminstance' => $a2->id ] ), false); $gi2b = new \grade_item($dg->create_grade_item( [ 'courseid' => $c2->id, 'itemtype' => 'mod', 'itemmodule' => 'assign', 'iteminstance' => $a3->id ] ), false); $grades['feedback'] = ''; $grades['userid'] = $ug1->id; $grades['usermodified'] = $ua2->id; $grades['rawgrade'] = 15; grade_update('mod/assign', $gi2a->courseid, $gi2a->itemtype, $gi2a->itemmodule, $gi2a->iteminstance, $gi2a->itemnumber, $grades); $grades['feedback'] = 'Well played!'; $grades['userid'] = $ug1->id; $grades['usermodified'] = $ua2->id; $grades['rawgrade'] = 30; grade_update('mod/assign', $gi2b->courseid, $gi2b->itemtype, $gi2b->itemmodule, $gi2b->iteminstance, $gi2b->itemnumber, $grades); // Export action user 1 everywhere. provider::export_user_data(new approved_contextlist($ua1, 'core_grades', [$ug1ctx->id, $ug2ctx->id, $c1ctx->id, $c2ctx->id])); $this->assert_context_has_no_data($ug1ctx); $this->assert_context_has_no_data($ug2ctx); $this->assert_context_has_no_data($c1ctx); $this->assert_context_has_no_data($c2ctx); // Export action user 2 in course 1. writer::reset(); provider::export_user_data(new approved_contextlist($ua2, 'core_grades', [$c1ctx->id])); $this->assert_context_has_no_data($ug1ctx); $this->assert_context_has_no_data($ug2ctx); $this->assert_context_has_no_data($c2ctx); $data = writer::with_context($c1ctx)->get_data($rootpath); $this->assertEmpty($data); // Here we are testing the export of grades that we've changed. $data = writer::with_context($c1ctx)->get_related_data($relatedtomepath, 'grades'); $this->assertCount(2, $data->grades); $this->assertEquals($gi1->get_name(), $data->grades[0]['item']); $this->assertEquals(1, $data->grades[0]['grade']); $this->assertEquals('Hi', $data->grades[0]['feedback']); $this->assertEquals(transform::yesno(true), $data->grades[0]['created_or_modified_by_you']); $this->assertEquals($gi1->get_name(), $data->grades[1]['item']); $this->assertEquals(12, $data->grades[1]['grade']); $this->assertEquals('Hello', $data->grades[1]['feedback']); $this->assertEquals(transform::yesno(true), $data->grades[1]['created_or_modified_by_you']); $pathtofiles = [ get_string('grades', 'core_grades'), get_string('feedbackfiles', 'core_grades') ]; $file = writer::with_context($gi1->get_context())->get_files($pathtofiles)['feedback1.txt']; $this->assertInstanceOf('stored_file', $file); $this->assertEquals('feedback1.txt', $file->get_filename()); $relatedtomepath = array_merge($rootpath, [get_string('privacy:path:relatedtome', 'core_grades')]); // Here we are testing the export of history of grades that we've changed. $data = writer::with_context($c1ctx)->get_related_data($relatedtomepath, 'grades_history'); $this->assertCount(3, $data->modified_records); $grade = $data->modified_records[0]; $this->assertEquals($ug1->id, $grade['userid']); $this->assertEquals($gi1->get_name(), $grade['item']); $this->assertEquals(100, $grade['grade']); $this->assertEquals('Well done!', $grade['feedback']); $this->assertEquals(transform::yesno(false), $grade['logged_in_user_was_you']); $this->assertEquals(transform::yesno(true), $grade['author_of_change_was_you']); $grade = $data->modified_records[1]; $this->assertEquals($ug1->id, $grade['userid']); $this->assertEquals($gi1->get_name(), $grade['item']); $this->assertEquals(1, $grade['grade']); $this->assertEquals('Hi', $grade['feedback']); $this->assertEquals(transform::yesno(false), $grade['logged_in_user_was_you']); $this->assertEquals(transform::yesno(true), $grade['author_of_change_was_you']); $grade = $data->modified_records[2]; $this->assertEquals($ug3->id, $grade['userid']); $this->assertEquals($gi1->get_name(), $grade['item']); $this->assertEquals(12, $grade['grade']); $this->assertEquals('Hello', $grade['feedback']); $this->assertEquals(transform::yesno(false), $grade['logged_in_user_was_you']); $this->assertEquals(transform::yesno(true), $grade['author_of_change_was_you']); $pathtofiles = [ get_string('grades', 'core_grades'), get_string('feedbackhistoryfiles', 'core_grades') ]; $file = writer::with_context($gi1->get_context())->get_files($pathtofiles)['feedback1.txt']; $this->assertInstanceOf('stored_file', $file); $this->assertEquals('feedback1.txt', $file->get_filename()); // Create a history record with logged user. $this->setUser($ua3); $gi1->update_final_grade($ug3->id, 50, 'test', '...', FORMAT_PLAIN, $ua2->id); writer::reset(); provider::export_user_data(new approved_contextlist($ua3, 'core_grades', [$c1ctx->id])); $data = writer::with_context($c1ctx)->get_related_data($relatedtomepath, 'grades_history'); $this->assertCount(1, $data->modified_records); $grade = $data->modified_records[0]; $this->assertEquals($ug3->id, $grade['userid']); $this->assertEquals($gi1->get_name(), $grade['item']); $this->assertEquals(50, $grade['grade']); $this->assertEquals('...', $grade['feedback']); $this->assertEquals(transform::yesno(true), $grade['logged_in_user_was_you']); $this->assertEquals(transform::yesno(false), $grade['author_of_change_was_you']); // Test that we export our own grades. writer::reset(); provider::export_user_data(new approved_contextlist($ug1, 'core_grades', [$c1ctx->id])); $data = writer::with_context($c1ctx)->get_data($rootpath); $this->assert_context_has_no_data($c2ctx); $this->assertCount(3, $data->grades); $grade = $data->grades[0]; $this->assertEquals($ci1->get_name(), $grade['item']); $this->assertEquals(1, $grade['grade']); $grade = $data->grades[2]; $this->assertEquals($gi1->get_name(), $grade['item']); $this->assertEquals(1, $grade['grade']); $this->assertEquals('Hi', $grade['feedback']); // Test that we export our own grades in two courses. writer::reset(); provider::export_user_data(new approved_contextlist($ug1, 'core_grades', [$ug1ctx->id, $c1ctx->id, $c2ctx->id])); $this->assert_context_has_no_data($ug1ctx); $data = writer::with_context($c1ctx)->get_data($rootpath); $this->assertCount(3, $data->grades); $grade = $data->grades[0]; $this->assertEquals($ci1->get_name(), $grade['item']); $this->assertEquals(1, $grade['grade']); $grade = $data->grades[2]; $this->assertEquals($gi1->get_name(), $grade['item']); $this->assertEquals(1, $grade['grade']); $this->assertEquals('Hi', $grade['feedback']); $data = writer::with_context($c2ctx)->get_data($rootpath); $this->assertCount(5, $data->grades); $grade = $data->grades[0]; $this->assertEquals($ci2->get_name(), $grade['item']); $grade = $data->grades[3]; $this->assertEquals($gi2a->get_name(), $grade['item']); $this->assertEquals(15, $grade['grade']); $this->assertEquals('', $grade['feedback']); $grade = $data->grades[4]; $this->assertEquals($gi2b->get_name(), $grade['item']); $this->assertEquals(30, $grade['grade']); $this->assertEquals('Well played!', $grade['feedback']); // Delete a grade item. $this->setUser($ua3); $gi1->delete(); // Now, we should find history of grades in our own context. writer::reset(); provider::export_user_data(new approved_contextlist($ug1, 'core_grades', [$ug1ctx->id, $c1ctx->id, $c2ctx->id])); $data = writer::with_context($c1ctx)->get_data($rootpath); $this->assertCount(2, $data->grades); $this->assertEquals($ci1->get_name(), $data->grades[0]['item']); $data = writer::with_context($c2ctx)->get_data($rootpath); $this->assertCount(5, $data->grades); $data = writer::with_context($ug1ctx)->get_related_data($rootpath, 'history'); $this->assertCount(3, $data->grades); $grade = $data->grades[0]; $this->assertEquals(get_string('privacy:request:unknowndeletedgradeitem', 'core_grades'), $grade['name']); $this->assertEquals(100, $grade['grade']); $this->assertEquals('Well done!', $grade['feedback']); $this->assertEquals(transform::yesno(true), $grade['graded_user_was_you']); $this->assertEquals(transform::yesno(false), $grade['logged_in_user_was_you']); $this->assertEquals(transform::yesno(false), $grade['author_of_change_was_you']); $this->assertEquals(get_string('privacy:request:historyactioninsert', 'core_grades'), $grade['action']); $grade = $data->grades[1]; $this->assertEquals(get_string('privacy:request:unknowndeletedgradeitem', 'core_grades'), $grade['name']); $this->assertEquals(1, $grade['grade']); $this->assertEquals('Hi', $grade['feedback']); $this->assertEquals(transform::yesno(true), $grade['graded_user_was_you']); $this->assertEquals(transform::yesno(false), $grade['logged_in_user_was_you']); $this->assertEquals(transform::yesno(false), $grade['author_of_change_was_you']); $this->assertEquals(get_string('privacy:request:historyactionupdate', 'core_grades'), $grade['action']); $grade = $data->grades[2]; $this->assertEquals(get_string('privacy:request:unknowndeletedgradeitem', 'core_grades'), $grade['name']); $this->assertEquals(1, $grade['grade']); $this->assertEquals('Hi', $grade['feedback']); $this->assertEquals(transform::yesno(true), $grade['graded_user_was_you']); $this->assertEquals(transform::yesno(false), $grade['logged_in_user_was_you']); $this->assertEquals(transform::yesno(false), $grade['author_of_change_was_you']); $this->assertEquals(get_string('privacy:request:historyactiondelete', 'core_grades'), $grade['action']); // The action user 3 should have a record of the deletion in the user's context. writer::reset(); provider::export_user_data(new approved_contextlist($ua3, 'core_grades', [$ug1ctx->id])); $data = writer::with_context($ug1ctx)->get_related_data($rootpath, 'history'); $this->assertCount(1, $data->grades); $grade = $data->grades[0]; $this->assertEquals(get_string('privacy:request:unknowndeletedgradeitem', 'core_grades'), $grade['name']); $this->assertEquals(1, $grade['grade']); $this->assertEquals('Hi', $grade['feedback']); $this->assertEquals(transform::yesno(true), $grade['logged_in_user_was_you']); $this->assertEquals(transform::yesno(false), $grade['author_of_change_was_you']); $this->assertEquals(get_string('privacy:request:historyactiondelete', 'core_grades'), $grade['action']); // The action user 2 should have a record of their edits in the user's context. writer::reset(); provider::export_user_data(new approved_contextlist($ua2, 'core_grades', [$ug1ctx->id])); $data = writer::with_context($ug1ctx)->get_related_data($rootpath, 'history'); $this->assertCount(3, $data->grades); $grade = $data->grades[0]; $this->assertEquals(get_string('privacy:request:unknowndeletedgradeitem', 'core_grades'), $grade['name']); $this->assertEquals(100, $grade['grade']); $this->assertEquals('Well done!', $grade['feedback']); $this->assertEquals(transform::yesno(false), $grade['logged_in_user_was_you']); $this->assertEquals(transform::yesno(true), $grade['author_of_change_was_you']); $this->assertEquals(get_string('privacy:request:historyactioninsert', 'core_grades'), $grade['action']); $grade = $data->grades[1]; $this->assertEquals(get_string('privacy:request:unknowndeletedgradeitem', 'core_grades'), $grade['name']); $this->assertEquals(1, $grade['grade']); $this->assertEquals('Hi', $grade['feedback']); $this->assertEquals(transform::yesno(false), $grade['logged_in_user_was_you']); $this->assertEquals(transform::yesno(true), $grade['author_of_change_was_you']); $this->assertEquals(get_string('privacy:request:historyactionupdate', 'core_grades'), $grade['action']); $grade = $data->grades[2]; $this->assertEquals(get_string('privacy:request:unknowndeletedgradeitem', 'core_grades'), $grade['name']); $this->assertEquals(1, $grade['grade']); $this->assertEquals('Hi', $grade['feedback']); $this->assertEquals(transform::yesno(false), $grade['logged_in_user_was_you']); $this->assertEquals(transform::yesno(true), $grade['author_of_change_was_you']); $this->assertEquals(get_string('privacy:request:historyactiondelete', 'core_grades'), $grade['action']); } public function test_export_data_for_user_with_scale() { global $DB; $dg = $this->getDataGenerator(); $c1 = $dg->create_course(); $scale = $dg->create_scale(['scale' => 'Awesome,OK,Reasonable,Bad']); $u1 = $dg->create_user(); $u2 = $dg->create_user(); $u1ctx = \context_user::instance($u1->id); $c1ctx = \context_course::instance($c1->id); $rootpath = [get_string('grades', 'core_grades')]; // Create another set for another user. $gi1 = new \grade_item($dg->create_grade_item(['courseid' => $c1->id, 'scaleid' => $scale->id]), false); $gi1->update_final_grade($u1->id, 1, 'test', '', FORMAT_PLAIN, $u2->id); $gi2 = new \grade_item($dg->create_grade_item(['courseid' => $c1->id, 'scaleid' => $scale->id]), false); $gi2->update_final_grade($u1->id, 3, 'test', '', FORMAT_PLAIN, $u2->id); // Export user's data. writer::reset(); provider::export_user_data(new approved_contextlist($u1, 'core_grades', [$c1ctx->id])); $data = writer::with_context($c1ctx)->get_data($rootpath); $this->assertCount(3, $data->grades); $this->assertEquals(\grade_item::fetch_course_item($c1->id)->get_name(), $data->grades[0]['item']); $this->assertEquals($gi1->get_name(), $data->grades[1]['item']); $this->assertEquals(1, $data->grades[1]['grade']); $this->assertEquals('Awesome', $data->grades[1]['grade_formatted']); $this->assertEquals($gi2->get_name(), $data->grades[2]['item']); $this->assertEquals(3, $data->grades[2]['grade']); $this->assertEquals('Reasonable', $data->grades[2]['grade_formatted']); } public function test_export_data_for_user_about_gradebook_edits() { global $DB; $dg = $this->getDataGenerator(); $c1 = $dg->create_course(); $c2 = $dg->create_course(); $u1 = $dg->create_user(); $u2 = $dg->create_user(); $u3 = $dg->create_user(); $u4 = $dg->create_user(); $u5 = $dg->create_user(); $u6 = $dg->create_user(); $u7 = $dg->create_user(); $u8 = $dg->create_user(); $u9 = $dg->create_user(); $u10 = $dg->create_user(); $sysctx = \context_system::instance(); $u1ctx = \context_user::instance($u1->id); $u2ctx = \context_user::instance($u2->id); $u3ctx = \context_user::instance($u3->id); $u4ctx = \context_user::instance($u4->id); $u5ctx = \context_user::instance($u5->id); $u6ctx = \context_user::instance($u6->id); $c1ctx = \context_course::instance($c1->id); $c2ctx = \context_course::instance($c2->id); $rootpath = [get_string('grades', 'core_grades')]; $relatedtomepath = array_merge($rootpath, [get_string('privacy:path:relatedtome', 'core_grades')]); $allcontexts = [$sysctx->id, $c1ctx->id, $c2ctx->id, $u1ctx->id, $u2ctx->id, $u3ctx->id, $u4ctx->id, $u5ctx->id, $u6ctx->id]; $updateactionstr = get_string('privacy:request:historyactionupdate', 'core_grades'); // Create some stuff. $gi1a = new \grade_item($dg->create_grade_item(['courseid' => $c1->id]), false); $gi1b = new \grade_item($dg->create_grade_item(['courseid' => $c1->id]), false); $gi2a = new \grade_item($dg->create_grade_item(['courseid' => $c2->id]), false); $gc1a = new \grade_category($dg->create_grade_category(['courseid' => $c1->id]), false); $gc1b = new \grade_category($dg->create_grade_category(['courseid' => $c1->id]), false); $gc2a = new \grade_category($dg->create_grade_category(['courseid' => $c2->id]), false); $go2 = new \grade_outcome($dg->create_grade_outcome(['courseid' => $c2->id, 'shortname' => 'go2', 'fullname' => 'go2']), false); $go0 = new \grade_outcome(['shortname' => 'go0', 'fullname' => 'go0', 'usermodified' => $u1->id]); $go0->insert(); $go1 = new \grade_outcome(['shortname' => 'go1', 'fullname' => 'go1', 'courseid' => $c1->id, 'usermodified' => $u1->id]); $go1->insert(); // Create scales. $s1 = new \grade_scale(['name' => 's1', 'scale' => 'a,b', 'userid' => $u7->id, 'courseid' => 0, 'description' => '']); $s1->insert(); $s2 = new \grade_scale(['name' => 's2', 'scale' => 'a,b', 'userid' => $u8->id, 'courseid' => $c1->id, 'description' => '']); $s2->insert(); $s3 = new \grade_scale(['name' => 's3', 'scale' => 'a,b', 'userid' => $u8->id, 'courseid' => $c2->id, 'description' => '']); $s3->insert(); // User 2 creates history. $this->setUser($u2); $go0->shortname .= ' edited'; $go0->update(); $gc1a->fullname .= ' edited'; $gc1a->update(); // User 3 creates history. $this->setUser($u3); $go1->shortname .= ' edited'; $go1->update(); $gc2a->fullname .= ' a'; $gc2a->update(); // User 4 updates an outcome in course (creates history). $this->setUser($u4); $go2->shortname .= ' edited'; $go2->update(); // User 5 updates an item. $this->setUser($u5); $gi1a->itemname .= ' edited'; $gi1a->update(); // User 6 creates history. $this->setUser($u6); $gi2a->delete(); // User 9 creates history. $this->setUser($u9); $s1->name .= ' edited'; $s1->update(); // User 10 creates history. $this->setUser($u10); $s3->delete(); $this->setAdminUser(); // Export data for u1. writer::reset(); provider::export_user_data(new approved_contextlist($u1, 'core_grades', $allcontexts)); $data = writer::with_context($sysctx)->get_related_data($relatedtomepath, 'outcomes'); $this->assertCount(1, $data->outcomes); $this->assertEquals($go0->shortname, $data->outcomes[0]['shortname']); $this->assertEquals($go0->fullname, $data->outcomes[0]['fullname']); $this->assertEquals(transform::yesno(true), $data->outcomes[0]['created_or_modified_by_you']); $data = writer::with_context($c1ctx)->get_related_data($relatedtomepath, 'outcomes'); $this->assertCount(1, $data->outcomes); $this->assertEquals($go1->shortname, $data->outcomes[0]['shortname']); $this->assertEquals($go1->fullname, $data->outcomes[0]['fullname']); $this->assertEquals(transform::yesno(true), $data->outcomes[0]['created_or_modified_by_you']); $data = writer::with_context($sysctx)->get_related_data($relatedtomepath, 'outcomes_history'); $this->assertEmpty($data); $data = writer::with_context($c1ctx)->get_related_data($relatedtomepath, 'outcomes_history'); $this->assertEmpty($data); // Export data for u2. writer::reset(); provider::export_user_data(new approved_contextlist($u2, 'core_grades', $allcontexts)); $data = writer::with_context($sysctx)->get_related_data($relatedtomepath, 'outcomes'); $this->assertEmpty($data); $data = writer::with_context($c1ctx)->get_related_data($relatedtomepath, 'outcomes'); $this->assertEmpty($data); $data = writer::with_context($sysctx)->get_related_data($relatedtomepath, 'outcomes_history'); $this->assertCount(1, $data->modified_records); $this->assertEquals($go0->shortname, $data->modified_records[0]['shortname']); $this->assertEquals($go0->fullname, $data->modified_records[0]['fullname']); $this->assertEquals(transform::yesno(true), $data->modified_records[0]['logged_in_user_was_you']); $this->assertEquals($updateactionstr, $data->modified_records[0]['action']); $data = writer::with_context($c1ctx)->get_related_data($relatedtomepath, 'categories_history'); $this->assertCount(1, $data->modified_records); $this->assertEquals($gc1a->fullname, $data->modified_records[0]['name']); $this->assertEquals(transform::yesno(true), $data->modified_records[0]['logged_in_user_was_you']); $this->assertEquals($updateactionstr, $data->modified_records[0]['action']); // Export data for u3. writer::reset(); provider::export_user_data(new approved_contextlist($u3, 'core_grades', $allcontexts)); $data = writer::with_context($c1ctx)->get_related_data($relatedtomepath, 'outcomes_history'); $this->assertCount(1, $data->modified_records); $this->assertEquals($go1->shortname, $data->modified_records[0]['shortname']); $this->assertEquals($go1->fullname, $data->modified_records[0]['fullname']); $this->assertEquals(transform::yesno(true), $data->modified_records[0]['logged_in_user_was_you']); $this->assertEquals($updateactionstr, $data->modified_records[0]['action']); $data = writer::with_context($c2ctx)->get_related_data($relatedtomepath, 'categories_history'); $this->assertCount(1, $data->modified_records); $this->assertEquals($gc2a->fullname, $data->modified_records[0]['name']); $this->assertEquals(transform::yesno(true), $data->modified_records[0]['logged_in_user_was_you']); $this->assertEquals($updateactionstr, $data->modified_records[0]['action']); // Export data for u4. writer::reset(); provider::export_user_data(new approved_contextlist($u4, 'core_grades', $allcontexts)); $data = writer::with_context($c2ctx)->get_related_data($relatedtomepath, 'outcomes_history'); $this->assertCount(1, $data->modified_records); $this->assertEquals($go2->shortname, $data->modified_records[0]['shortname']); $this->assertEquals($go2->fullname, $data->modified_records[0]['fullname']); $this->assertEquals(transform::yesno(true), $data->modified_records[0]['logged_in_user_was_you']); $this->assertEquals($updateactionstr, $data->modified_records[0]['action']); // Export data for u5. writer::reset(); provider::export_user_data(new approved_contextlist($u5, 'core_grades', $allcontexts)); $data = writer::with_context($c1ctx)->get_related_data($relatedtomepath, 'items_history'); $this->assertCount(1, $data->modified_records); $this->assertEquals($gi1a->itemname, $data->modified_records[0]['name']); $this->assertEquals(transform::yesno(true), $data->modified_records[0]['logged_in_user_was_you']); $this->assertEquals($updateactionstr, $data->modified_records[0]['action']); // Export data for u6. writer::reset(); provider::export_user_data(new approved_contextlist($u6, 'core_grades', $allcontexts)); $data = writer::with_context($c1ctx)->get_related_data($relatedtomepath, 'items_history'); $this->assertEmpty($data); $data = writer::with_context($c2ctx)->get_related_data($relatedtomepath, 'items_history'); $this->assertCount(1, $data->modified_records); $this->assertEquals($gi2a->itemname, $data->modified_records[0]['name']); $this->assertEquals(transform::yesno(true), $data->modified_records[0]['logged_in_user_was_you']); $this->assertEquals(get_string('privacy:request:historyactiondelete', 'core_grades'), $data->modified_records[0]['action']); // Export data for u7. writer::reset(); provider::export_user_data(new approved_contextlist($u7, 'core_grades', $allcontexts)); $data = writer::with_context($c1ctx)->get_related_data($relatedtomepath, 'scales'); $this->assertEmpty($data); $data = writer::with_context($sysctx)->get_related_data($relatedtomepath, 'scales'); $this->assertCount(1, $data->scales); $this->assertEquals($s1->name, $data->scales[0]['name']); $this->assertEquals(transform::yesno(true), $data->scales[0]['created_or_modified_by_you']); // Export data for u8. writer::reset(); provider::export_user_data(new approved_contextlist($u8, 'core_grades', $allcontexts)); $data = writer::with_context($sysctx)->get_related_data($relatedtomepath, 'scales'); $this->assertEmpty($data); $data = writer::with_context($c1ctx)->get_related_data($relatedtomepath, 'scales'); $this->assertCount(1, $data->scales); $this->assertEquals($s2->name, $data->scales[0]['name']); $this->assertEquals(transform::yesno(true), $data->scales[0]['created_or_modified_by_you']); $data = writer::with_context($c2ctx)->get_related_data($relatedtomepath, 'scales_history'); $this->assertCount(2, $data->modified_records); $this->assertEquals($s3->name, $data->modified_records[0]['name']); $this->assertEquals(transform::yesno(true), $data->modified_records[0]['author_of_change_was_you']); $this->assertEquals(transform::yesno(false), $data->modified_records[0]['author_of_action_was_you']); $this->assertEquals(get_string('privacy:request:historyactioninsert', 'core_grades'), $data->modified_records[0]['action']); $this->assertEquals($s3->name, $data->modified_records[1]['name']); $this->assertEquals(transform::yesno(true), $data->modified_records[1]['author_of_change_was_you']); $this->assertEquals(transform::yesno(false), $data->modified_records[1]['author_of_action_was_you']); $this->assertEquals(get_string('privacy:request:historyactiondelete', 'core_grades'), $data->modified_records[1]['action']); // Export data for u9. writer::reset(); provider::export_user_data(new approved_contextlist($u9, 'core_grades', $allcontexts)); $data = writer::with_context($c1ctx)->get_related_data($relatedtomepath, 'scales'); $this->assertEmpty($data); $data = writer::with_context($sysctx)->get_related_data($relatedtomepath, 'scales'); $this->assertEmpty($data); $data = writer::with_context($sysctx)->get_related_data($relatedtomepath, 'scales_history'); $this->assertCount(1, $data->modified_records); $this->assertEquals($s1->name, $data->modified_records[0]['name']); $this->assertEquals(transform::yesno(false), $data->modified_records[0]['author_of_change_was_you']); $this->assertEquals(transform::yesno(true), $data->modified_records[0]['author_of_action_was_you']); $this->assertEquals(get_string('privacy:request:historyactionupdate', 'core_grades'), $data->modified_records[0]['action']); // Export data for u10. writer::reset(); provider::export_user_data(new approved_contextlist($u10, 'core_grades', $allcontexts)); $data = writer::with_context($c1ctx)->get_related_data($relatedtomepath, 'scales'); $this->assertEmpty($data); $data = writer::with_context($c2ctx)->get_related_data($relatedtomepath, 'scales'); $this->assertEmpty($data); $data = writer::with_context($sysctx)->get_related_data($relatedtomepath, 'scales'); $this->assertEmpty($data); $data = writer::with_context($c1ctx)->get_related_data($relatedtomepath, 'scales_history'); $this->assertEmpty($data); $data = writer::with_context($sysctx)->get_related_data($relatedtomepath, 'scales_history'); $this->assertEmpty($data); $data = writer::with_context($c2ctx)->get_related_data($relatedtomepath, 'scales_history'); $this->assertCount(1, $data->modified_records); $this->assertEquals($s3->name, $data->modified_records[0]['name']); $this->assertEquals(transform::yesno(false), $data->modified_records[0]['author_of_change_was_you']); $this->assertEquals(transform::yesno(true), $data->modified_records[0]['author_of_action_was_you']); $this->assertEquals(get_string('privacy:request:historyactiondelete', 'core_grades'), $data->modified_records[0]['action']); } /** * Assert there is no grade data in the context. * * @param context $context The context. * @return void */ protected function assert_context_has_no_data(\context $context) { $rootpath = [get_string('grades', 'core_grades')]; $relatedtomepath = array_merge($rootpath, [get_string('privacy:path:relatedtome', 'core_grades')]); $data = writer::with_context($context)->get_data($rootpath); $this->assertEmpty($data); $data = writer::with_context($context)->get_related_data($rootpath, 'history'); $this->assertEmpty($data); $files = ['categories_history', 'items_history', 'outcomes', 'outcomes_history', 'grades', 'grades_history', 'history']; foreach ($files as $file) { $data = writer::with_context($context)->get_related_data($relatedtomepath, $file); $this->assertEmpty($data); } } /** * Creates a feedback file to copy to the gradebook area. */ private function add_feedback_file_to_copy() { $dummy = array( 'contextid' => 1, 'component' => 'test', 'filearea' => 'testarea', 'itemid' => 1, 'filepath' => '/', 'filename' => 'feedback1.txt' ); $fs = get_file_storage(); $fs->create_file_from_string($dummy, ''); } } tests/reportuserlib_test.php 0000604 00000020666 15062070557 0012374 0 ustar 00 <?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/>. namespace core_grades; use grade_plugin_return; use gradereport_user\report\user as user_report; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once($CFG->dirroot.'/grade/lib.php'); require_once($CFG->dirroot.'/grade/report/user/lib.php'); /** * Tests grade_report_user (the gradebook's user report) * * @package core_grades * @category test * @copyright 2012 Andrew Davis * @license http://www.gnu.org/copyleft/gpl.html GNU Public License */ class reportuserlib_test extends \advanced_testcase { /** * Tests grade_report_user::inject_rowspans() * * inject_rowspans() returns the count of the number of elements, sets maxdepth on the * report object and sets the rowspan property on any element that has children. */ public function test_inject_rowspans() { global $CFG, $USER, $DB; parent::setUp(); $this->resetAfterTest(true); $CFG->enableavailability = 1; $CFG->enablecompletion = 1; // Create a course. $course = $this->getDataGenerator()->create_course(); $coursecategory = \grade_category::fetch_course_category($course->id); $coursecontext = \context_course::instance($course->id); // Create and enrol test users. $student = $this->getDataGenerator()->create_user(array('username' => 'student_sam')); $role = $DB->get_record('role', array('shortname' => 'student'), '*', MUST_EXIST); $this->getDataGenerator()->enrol_user($student->id, $course->id, $role->id); $teacher = $this->getDataGenerator()->create_user(array('username' => 'teacher_t')); $role = $DB->get_record('role', array('shortname' => 'editingteacher'), '*', MUST_EXIST); $this->getDataGenerator()->enrol_user($teacher->id, $course->id, $role->id); // An array so we can test with both users in a loop. $users = array($student, $teacher); // Make the student the current user. $this->setUser($student); // Test an empty course. $report = $this->create_report($course, $student, $coursecontext); // a lead column that spans all children + course grade item = 2 $this->assertEquals(2, $report->inject_rowspans($report->gtree->top_element)); $this->assertEquals(2, $report->gtree->top_element['rowspan']); $this->assertEquals(2, $report->maxdepth); // Only elements with children should have rowspan set. if (array_key_exists('rowspan', $report->gtree->top_element['children'][1])) { $this->fail('Elements without children should not have rowspan set'); } // Add 2 activities. $data1 = $this->getDataGenerator()->create_module('data', array('assessed' => 1, 'scale' => 100, 'course' => $course->id)); $forum1 = $this->getDataGenerator()->create_module('forum', array('assessed' => 1, 'scale' => 100, 'course' => $course->id)); $forum1cm = get_coursemodule_from_id('forum', $forum1->cmid); // Switch the stdClass instance for a grade item instance so \grade_item::set_parent() is available. $forum1 = \grade_item::fetch(array('itemtype' => 'mod', 'itemmodule' => 'forum', 'iteminstance' => $forum1->id, 'courseid' => $course->id)); $report = $this->create_report($course, $student, $coursecontext); // Lead column + course + (2 x activity) = 4 $this->assertEquals(4, $report->inject_rowspans($report->gtree->top_element)); $this->assertEquals(4, $report->gtree->top_element['rowspan']); // Lead column + 1 level (course + 2 activities) = 2 $this->assertEquals(2, $report->maxdepth); // Only elements with children should have rowspan set. if (array_key_exists('rowspan', $report->gtree->top_element['children'][1])) { $this->fail('Elements without children should not have rowspan set'); } // Hide the forum activity. set_coursemodule_visible($forum1cm->id, 0); foreach ($users as $user) { $this->setUser($user); $message = 'Testing with ' . $user->username; accesslib_clear_all_caches_for_unit_testing(); $report = $this->create_report($course, $user, $coursecontext); // Lead column + course + (2 x activity) = 4 (element count isn't affected by hiding) $this->assertEquals(4, $report->inject_rowspans($report->gtree->top_element), $message); $this->assertEquals(4, $report->gtree->top_element['rowspan'], $message); // Lead column -> 1 level containing the course + 2 activities = 2 $this->assertEquals(2, $report->maxdepth, $message); } // Unhide the forum activity. set_coursemodule_visible($forum1cm->id, 1); // Create a category and put the forum in it. $params = new \stdClass(); $params->courseid = $course->id; $params->fullname = 'unittestcategory'; $params->parent = $coursecategory->id; $gradecategory = new \grade_category($params, false); $gradecategory->insert(); $forum1->set_parent($gradecategory->id); $report = $this->create_report($course, $student, $coursecontext); // Lead column + course + (category + lead column + category grade item) + (2 x activity) = 7. $this->assertEquals(7, $report->inject_rowspans($report->gtree->top_element)); $this->assertEquals(7, $report->gtree->top_element['rowspan']); // Lead column -> the category -> the forum activity = 3 $this->assertEquals(3, $report->maxdepth); // Check rowspan on the category. The category itself + category grade item + forum = 3 $this->assertEquals(3, $report->gtree->top_element['children'][4]['rowspan']); // check the forum doesn't have rowspan set if (array_key_exists('rowspan', $report->gtree->top_element['children'][4]['children'][3])) { $this->fail('The forum has no children so should not have rowspan set'); } // Conditional activity tests. // Note: I have ported this test to the new conditional availability // system, but it does not appear to actually test anything - in fact, // if you remove the code that sets the condition, it still passes // because it apparently is intended to have the same number of rows // even when some are hidden. The same is true of the // set_coursemodule_visible test above. I don't feel this is a very // good test; somebody with more knowledge of this report might want to // fix it to check that the row actually is being hidden. $DB->set_field('course_modules', 'availability', '{"op":"|","show":false,"c":[' . '{"type":"grade","min":5.5,"id":37}]}', array('id' => $forum1cm->id)); get_fast_modinfo($course->id, 0, true); foreach ($users as $user) { $this->setUser($user); $message = 'Testing with ' . $user->username; accesslib_clear_all_caches_for_unit_testing(); $report = $this->create_report($course, $user, $coursecontext); // Lead column + course + (category + lead column + category grade item) + (2 x activity) = 7. $this->assertEquals(7, $report->inject_rowspans($report->gtree->top_element), $message); $this->assertEquals(7, $report->gtree->top_element['rowspan'], $message); // Lead column -> the category -> the forum activity = 3 $this->assertEquals(3, $report->maxdepth, $message); } } private function create_report($course, $user, $coursecontext) { $gpr = new grade_plugin_return(array('type' => 'report', 'plugin'=>'user', 'courseid' => $course->id, 'userid' => $user->id)); $report = new user_report($course->id, $gpr, $coursecontext, $user->id); return $report; } } tests/reportlib_test.php 0000604 00000025730 15062070557 0011472 0 ustar 00 <?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/>. /** * Unit tests for grade/report/lib.php. * * @package core_grades * @category phpunit * @author Andrew Davis * @license http://www.gnu.org/copyleft/gpl.html GNU Public License */ defined('MOODLE_INTERNAL') || die(); global $CFG; require_once($CFG->dirroot.'/grade/lib.php'); require_once($CFG->dirroot.'/grade/report/lib.php'); /** * A test class used to test grade_report, the abstract grade report parent class */ class grade_report_mock extends grade_report { public function __construct($courseid, $gpr, $context, $user) { parent::__construct($courseid, $gpr, $context); $this->user = $user; } /** * A wrapper around blank_hidden_total_and_adjust_bounds() to allow test code to call it directly */ public function blank_hidden_total_and_adjust_bounds($courseid, $courseitem, $finalgrade) { return parent::blank_hidden_total_and_adjust_bounds($courseid, $courseitem, $finalgrade); } /** * Implementation of the abstract method process_data() */ public function process_data($data) { } /** * Implementation of the abstract method process_action() */ public function process_action($target, $action) { } } /** * Tests grade_report, the parent class for all grade reports. */ class reportlib_test extends advanced_testcase { /** * Tests grade_report::blank_hidden_total_and_adjust_bounds() */ public function test_blank_hidden_total_and_adjust_bounds() { global $DB; $this->resetAfterTest(true); $student = $this->getDataGenerator()->create_user(); $this->setUser($student); // Create a course and two activities. // One activity will be hidden. $course = $this->getDataGenerator()->create_course(); $coursegradeitem = grade_item::fetch_course_item($course->id); $coursecontext = context_course::instance($course->id); $data = $this->getDataGenerator()->create_module('data', array('assessed' => 1, 'scale' => 100, 'course' => $course->id)); $datacm = get_coursemodule_from_id('data', $data->cmid); $forum = $this->getDataGenerator()->create_module('forum', array('assessed' => 1, 'scale' => 100, 'course' => $course->id)); $forumcm = get_coursemodule_from_id('forum', $forum->cmid); // Insert student grades for the two activities. $gi = grade_item::fetch(array('itemtype' => 'mod', 'itemmodule' => 'data', 'iteminstance' => $data->id, 'courseid' => $course->id)); $datagrade = 50; $grade_grade = new grade_grade(); $grade_grade->itemid = $gi->id; $grade_grade->userid = $student->id; $grade_grade->rawgrade = $datagrade; $grade_grade->finalgrade = $datagrade; $grade_grade->rawgrademax = 100; $grade_grade->rawgrademin = 0; $grade_grade->timecreated = time(); $grade_grade->timemodified = time(); $grade_grade->insert(); $gi = grade_item::fetch(array('itemtype' => 'mod', 'itemmodule' => 'forum', 'iteminstance' => $forum->id, 'courseid' => $course->id)); $forumgrade = 70; $grade_grade = new grade_grade(); $grade_grade->itemid = $gi->id; $grade_grade->userid = $student->id; $grade_grade->rawgrade = $forumgrade; $grade_grade->finalgrade = $forumgrade; $grade_grade->rawgrademax = 100; $grade_grade->rawgrademin = 0; $grade_grade->timecreated = time(); $grade_grade->timemodified = time(); $grade_grade->insert(); // Hide the database activity. set_coursemodule_visible($datacm->id, 0); $gpr = new grade_plugin_return(array('type' => 'report', 'courseid' => $course->id)); $report = new grade_report_mock($course->id, $gpr, $coursecontext, $student); // Should return the supplied student total grade regardless of hiding. $report->showtotalsifcontainhidden = array($course->id => GRADE_REPORT_SHOW_REAL_TOTAL_IF_CONTAINS_HIDDEN); $result = $report->blank_hidden_total_and_adjust_bounds($course->id, $coursegradeitem, $datagrade + $forumgrade); $this->assertEquals(array('grade' => $datagrade + $forumgrade, 'grademax' => $coursegradeitem->grademax, 'grademin' => $coursegradeitem->grademin, 'aggregationstatus' => 'unknown', 'aggregationweight' => null), $result); // Should blank the student total as course grade depends on a hidden item. $report->showtotalsifcontainhidden = array($course->id => GRADE_REPORT_HIDE_TOTAL_IF_CONTAINS_HIDDEN); $result = $report->blank_hidden_total_and_adjust_bounds($course->id, $coursegradeitem, $datagrade + $forumgrade); $this->assertEquals(array('grade' => null, 'grademax' => $coursegradeitem->grademax, 'grademin' => $coursegradeitem->grademin, 'aggregationstatus' => 'unknown', 'aggregationweight' => null), $result); // Should return the course total minus the hidden database activity grade. $report->showtotalsifcontainhidden = array($course->id => GRADE_REPORT_SHOW_TOTAL_IF_CONTAINS_HIDDEN); $result = $report->blank_hidden_total_and_adjust_bounds($course->id, $coursegradeitem, $datagrade + $forumgrade); $this->assertEquals(array('grade' => floatval($forumgrade), 'grademax' => $coursegradeitem->grademax, 'grademin' => $coursegradeitem->grademin, 'aggregationstatus' => 'unknown', 'aggregationweight' => null), $result); // Note: we cannot simply hide modules and call $report->blank_hidden_total() again. // It stores grades in a static variable so $report->blank_hidden_total() will return incorrect totals // In practice this isn't a problem. Grade visibility isn't altered mid-request outside of the unit tests. // Add a second course to test: // 1) How a course with no visible activities behaves. // 2) That $report->blank_hidden_total() correctly moves on to the new course. $course = $this->getDataGenerator()->create_course(); $coursegradeitem = grade_item::fetch_course_item($course->id); $coursecontext = context_course::instance($course->id); $data = $this->getDataGenerator()->create_module('data', array('assessed' => 1, 'scale' => 100, 'course' => $course->id)); $datacm = get_coursemodule_from_id('data', $data->cmid); $forum = $this->getDataGenerator()->create_module('forum', array('assessed' => 1, 'scale' => 100, 'course' => $course->id)); $forumcm = get_coursemodule_from_id('forum', $forum->cmid); $gi = grade_item::fetch(array('itemtype' => 'mod', 'itemmodule' => 'data', 'iteminstance' => $data->id, 'courseid' => $course->id)); $datagrade = 50; $grade_grade = new grade_grade(); $grade_grade->itemid = $gi->id; $grade_grade->userid = $student->id; $grade_grade->rawgrade = $datagrade; $grade_grade->finalgrade = $datagrade; $grade_grade->rawgrademax = 100; $grade_grade->rawgrademin = 0; $grade_grade->timecreated = time(); $grade_grade->timemodified = time(); $grade_grade->insert(); $gi = grade_item::fetch(array('itemtype' => 'mod', 'itemmodule' => 'forum', 'iteminstance' => $forum->id, 'courseid' => $course->id)); $forumgrade = 70; $grade_grade = new grade_grade(); $grade_grade->itemid = $gi->id; $grade_grade->userid = $student->id; $grade_grade->rawgrade = $forumgrade; $grade_grade->finalgrade = $forumgrade; $grade_grade->rawgrademax = 100; $grade_grade->rawgrademin = 0; $grade_grade->timecreated = time(); $grade_grade->timemodified = time(); $grade_grade->insert(); // Hide both activities. set_coursemodule_visible($datacm->id, 0); set_coursemodule_visible($forumcm->id, 0); $gpr = new grade_plugin_return(array('type' => 'report', 'courseid' => $course->id)); $report = new grade_report_mock($course->id, $gpr, $coursecontext, $student); // Should return the supplied student total grade regardless of hiding. $report->showtotalsifcontainhidden = array($course->id => GRADE_REPORT_SHOW_REAL_TOTAL_IF_CONTAINS_HIDDEN); $result = $report->blank_hidden_total_and_adjust_bounds($course->id, $coursegradeitem, $datagrade + $forumgrade); $this->assertEquals(array('grade' => $datagrade + $forumgrade, 'grademax' => $coursegradeitem->grademax, 'grademin' => $coursegradeitem->grademin, 'aggregationstatus' => 'unknown', 'aggregationweight' => null), $result); // Should blank the student total as course grade depends on a hidden item. $report->showtotalsifcontainhidden = array($course->id => GRADE_REPORT_HIDE_TOTAL_IF_CONTAINS_HIDDEN); $result = $report->blank_hidden_total_and_adjust_bounds($course->id, $coursegradeitem, $datagrade + $forumgrade); $this->assertEquals(array('grade' => null, 'grademax' => $coursegradeitem->grademax, 'grademin' => $coursegradeitem->grademin, 'aggregationstatus' => 'unknown', 'aggregationweight' => null), $result); // Should return the course total minus the hidden activity grades. // They are both hidden so should return null. $report->showtotalsifcontainhidden = array($course->id => GRADE_REPORT_SHOW_TOTAL_IF_CONTAINS_HIDDEN); $result = $report->blank_hidden_total_and_adjust_bounds($course->id, $coursegradeitem, $datagrade + $forumgrade); $this->assertEquals(array('grade' => null, 'grademax' => $coursegradeitem->grademax, 'grademin' => $coursegradeitem->grademin, 'aggregationstatus' => 'unknown', 'aggregationweight' => null), $result); } } tests/querylib_test.php 0000604 00000005037 15062070557 0011322 0 ustar 00 <?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/>. namespace core_grades; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once($CFG->libdir.'/gradelib.php'); require_once($CFG->dirroot.'/grade/querylib.php'); /** * Unit tests for grade quering * * @package core_grades * @category test * @copyright 2011 Petr Skoda {@link http://skodak.org} * @license http://www.gnu.org/copyleft/gpl.html GNU Public License */ class querylib_test extends \advanced_testcase { public function test_grade_get_gradable_activities() { $this->resetAfterTest(true); $course = $this->getDataGenerator()->create_course(); $data1 = $this->getDataGenerator()->create_module('data', array('assessed'=>1, 'scale'=>100, 'course'=>$course->id)); $data2 = $this->getDataGenerator()->create_module('data', array('assessed'=>0, 'course'=>$course->id)); $forum1 = $this->getDataGenerator()->create_module('forum', array('assessed'=>1, 'scale'=>100, 'course'=>$course->id)); $forum2 = $this->getDataGenerator()->create_module('forum', array('assessed'=>0, 'course'=>$course->id)); $cms = grade_get_gradable_activities($course->id); $this->assertEquals(2, count($cms)); $this->assertTrue(isset($cms[$data1->cmid])); $this->assertTrue(isset($cms[$forum1->cmid])); $cms = grade_get_gradable_activities($course->id, 'forum'); $this->assertEquals(1, count($cms)); $this->assertTrue(isset($cms[$forum1->cmid])); } public function test_grade_get_grade_items_for_activity() { $this->resetAfterTest(true); $course = $this->getDataGenerator()->create_course(); $forum = $this->getDataGenerator()->create_module('forum', array('course'=>$course->id)); $cm = get_coursemodule_from_id('forum', $forum->cmid, $forum->course); unset($cm->modname); $grade = grade_get_grade_items_for_activity($cm); } } tests/export_test.php 0000604 00000014542 15062070557 0011010 0 ustar 00 <?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/>. namespace core_grades; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once($CFG->dirroot.'/grade/lib.php'); require_once($CFG->dirroot.'/grade/export/lib.php'); /** * A test class used to test grade_report, the abstract grade report parent class * * @package core_grades * @category test * @copyright Andrew Nicols <andrew@nicols.co.uk> * @license http://www.gnu.org/copyleft/gpl.html GNU Public License */ class export_test extends \advanced_testcase { /** * Ensure that feedback is correct formatted. Test the default implementation of format_feedback * * @dataProvider format_feedback_provider * @param string $input The input string to test * @param int $inputformat The format of the input string * @param string $expected The expected result of the format. */ public function test_format_feedback($input, $inputformat, $expected) { $feedback = $this->getMockForAbstractClass( \grade_export::class, [], '', false ); $this->assertEquals( $expected, $feedback->format_feedback((object) [ 'feedback' => $input, 'feedbackformat' => $inputformat, ]) ); } /** * Ensure that feedback is correctly formatted. Test augmented functionality to handle file links */ public function test_format_feedback_with_grade() { $this->resetAfterTest(); $dg = $this->getDataGenerator(); $c1 = $dg->create_course(); $u1 = $dg->create_user(); $gi1a = new \grade_item($dg->create_grade_item(['courseid' => $c1->id]), false); $gi1a->update_final_grade($u1->id, 1, 'test'); $contextid = $gi1a->get_context()->id; $gradeid = $gi1a->id; $tests = [ 'Has server based image (HTML)' => [ '<p>See this reference: <img src="@@PLUGINFILE@@/test.img"></p>', FORMAT_HTML, "See this reference: " ], 'Has server based image and more (HTML)' => [ '<p>See <img src="@@PLUGINFILE@@/test.img"> for <em>reference</em></p>', FORMAT_HTML, "See for reference" ], 'Has server based video and more (HTML)' => [ '<p>See <video src="@@PLUGINFILE@@/test.img">video of a duck</video> for <em>reference</em></p>', FORMAT_HTML, 'See video of a duck for reference' ], 'Has server based video with text and more (HTML)' => [ '<p>See <video src="@@PLUGINFILE@@/test.img">@@PLUGINFILE@@/test.img</video> for <em>reference</em></p>', FORMAT_HTML, "See https://www.example.com/moodle/pluginfile.php/$contextid/grade/feedback/$gradeid/test.img for reference" ], 'Multiple videos (HTML)' => [ '<p>See <video src="@@PLUGINFILE@@/test.img">video of a duck</video> and '. '<video src="http://example.com/myimage.jpg">video of a cat</video> for <em>reference</em></p>', FORMAT_HTML, 'See video of a duck and video of a cat for reference' ], ]; $feedback = $this->getMockForAbstractClass( \grade_export::class, [], '', false ); foreach ($tests as $key => $testdetails) { $expected = $testdetails[2]; $input = $testdetails[0]; $inputformat = $testdetails[1]; $this->assertEquals( $expected, $feedback->format_feedback((object) [ 'feedback' => $input, 'feedbackformat' => $inputformat, ], $gi1a), $key ); } } /** * Data provider for the format_feedback tests. * * @return array */ public function format_feedback_provider() : array { return [ 'Basic string (PLAIN)' => [ 'This is an example string', FORMAT_PLAIN, 'This is an example string', ], 'Basic string (HTML)' => [ '<p>This is an example string</p>', FORMAT_HTML, 'This is an example string', ], 'Has image (HTML)' => [ '<p>See this reference: <img src="http://example.com/myimage.jpg"></p>', FORMAT_HTML, 'See this reference: ', ], 'Has image and more (HTML)' => [ '<p>See <img src="http://example.com/myimage.jpg"> for <em>reference</em></p>', FORMAT_HTML, 'See for reference', ], 'Has video and more (HTML)' => [ '<p>See <video src="http://example.com/myimage.jpg">video of a duck</video> for <em>reference</em></p>', FORMAT_HTML, 'See video of a duck for reference', ], 'Multiple videos (HTML)' => [ '<p>See <video src="http://example.com/myimage.jpg">video of a duck</video> and '. '<video src="http://example.com/myimage.jpg">video of a cat</video> for <em>reference</em></p>', FORMAT_HTML, 'See video of a duck and video of a cat for reference' ], 'HTML Looking tags in PLAIN' => [ 'The way you have written the <img thing looks pretty fun >', FORMAT_PLAIN, 'The way you have written the <img thing looks pretty fun >', ], ]; } } tests/event/events_test.php 0000604 00000016606 15062070557 0012117 0 ustar 00 <?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/>. /** * Unit tests for events found in /grade/letter and /grade/scale. * * @package core_grades * @category test * @copyright 2017 Stephen Bourget * @license http://www.gnu.org/copyleft/gpl.html GNU Public License */ namespace core_grades\event; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once($CFG->dirroot . '/grade/lib.php'); /** * Unit tests for grade events. * * @package core_grades * @category test * @copyright 2017 Stephen Bourget * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class events_test extends \advanced_testcase { /** @var stdClass the course used for testing */ private $course; /** * Test set up. * * This is executed before running any test in this file. */ public function setUp(): void { $this->resetAfterTest(); $this->setAdminUser(); $this->course = $this->getDataGenerator()->create_course(); } /** * Test the grade letter created event. * * There is no external API for triggering this event, so the unit test will simply * create and trigger the event and ensure the data is returned as expected. */ public function test_grade_letter_created() { // Create a grade letter created event. $event = \core\event\grade_letter_created::create(array( 'objectid' => 10, 'context' => \context_course::instance($this->course->id) )); // Trigger and capture the event. $sink = $this->redirectEvents(); $event->trigger(); $events = $sink->get_events(); $event = reset($events); // Check that the event data is valid. $this->assertInstanceOf('\core\event\grade_letter_created', $event); $this->assertEquals(\context_course::instance($this->course->id), $event->get_context()); } /** * Test the grade letter deleted event. * * There is no external API for triggering this event, so the unit test will simply * create and trigger the event and ensure the data is returned as expected. */ public function test_grade_letter_deleted() { // Create a grade letter deleted event. $event = \core\event\grade_letter_deleted::create(array( 'objectid' => 10, 'context' => \context_course::instance($this->course->id) )); // Trigger and capture the event. $sink = $this->redirectEvents(); $event->trigger(); $events = $sink->get_events(); $event = reset($events); // Check that the event data is valid. $this->assertInstanceOf('\core\event\grade_letter_deleted', $event); $this->assertEquals(\context_course::instance($this->course->id), $event->get_context()); } /** * Test the grade letter updated event. * * There is no external API for triggering this event, so the unit test will simply * create and trigger the event and ensure the data is returned as expected. */ public function test_grade_letter_updated() { // Create a grade letter updated event. $event = \core\event\grade_letter_updated::create(array( 'objectid' => 10, 'context' => \context_course::instance($this->course->id) )); // Trigger and capture the event. $sink = $this->redirectEvents(); $event->trigger(); $events = $sink->get_events(); $event = reset($events); // Check that the event data is valid. $this->assertInstanceOf('\core\event\grade_letter_updated', $event); $this->assertEquals(\context_course::instance($this->course->id), $event->get_context()); } /** * Test the scale created event. */ public function test_scale_created() { $gradescale = new \grade_scale(); $gradescale->name = 'unittestscale3'; $gradescale->courseid = $this->course->id; $gradescale->userid = 317; $gradescale->scale = 'Distinction, Very Good, Good, Pass, Fail'; $gradescale->description = 'This scale is used to mark standard assignments.'; $url = new \moodle_url('/grade/edit/scale/index.php', array('id' => $this->course->id)); // Trigger and capture the event. $sink = $this->redirectEvents(); $id = $gradescale->insert(); $events = $sink->get_events(); $event = reset($events); // Check that the event data is valid. $this->assertInstanceOf('\core\event\scale_created', $event); $this->assertEquals($id, $event->objectid); $this->assertEquals($url, $event->get_url()); $this->assertEquals(\context_course::instance($this->course->id), $event->get_context()); } /** * Test the scale deleted event. */ public function test_scale_deleted() { $gradescale = new \grade_scale(); $gradescale->name = 'unittestscale3'; $gradescale->courseid = $this->course->id; $gradescale->userid = 317; $gradescale->scale = 'Distinction, Very Good, Good, Pass, Fail'; $gradescale->description = 'This scale is used to mark standard assignments.'; $gradescale->insert(); // Trigger and capture the event. $sink = $this->redirectEvents(); $gradescale->delete(); $events = $sink->get_events(); $event = reset($events); // Check that the event data is valid. $this->assertInstanceOf('\core\event\scale_deleted', $event); $this->assertEquals(\context_course::instance($this->course->id), $event->get_context()); } /** * Test the scale updated event. */ public function test_scale_updated() { $gradescale = new \grade_scale(); $gradescale->name = 'unittestscale3'; $gradescale->courseid = $this->course->id; $gradescale->userid = 317; $gradescale->scale = 'Distinction, Very Good, Good, Pass, Fail'; $gradescale->description = 'This scale is used to mark standard assignments.'; $id = $gradescale->insert(); $gradescale->name = 'Updated info for this unittest grade_scale'; $url = new \moodle_url('/grade/edit/scale/index.php', array('id' => $this->course->id)); // Trigger and capture the event. $sink = $this->redirectEvents(); $gradescale->update(); $events = $sink->get_events(); $event = reset($events); // Check that the event data is valid. $this->assertInstanceOf('\core\event\scale_updated', $event); $this->assertEquals($id, $event->objectid); $this->assertEquals($url, $event->get_url()); $this->assertEquals(\context_course::instance($this->course->id), $event->get_context()); } } tests/component_gradeitem_test.php 0000604 00000022470 15062070557 0013511 0 ustar 00 <?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/>. /** * Unit tests for the class component_gradeitem. * * @package core_grades * @category test * @copyright 2021 Mark Nelson <marknelson@catalyst-au.net> * @license http://www.gnu.org/copyleft/gpl.html GNU Public License */ namespace core_grades; use advanced_testcase; use mod_forum\local\container; use mod_forum\local\entities\forum as forum_entity; /** * Unit tests for the class component_gradeitem. * * @package core_grades * @category test * @copyright 2021 Mark Nelson <marknelson@catalyst-au.net> * @license http://www.gnu.org/copyleft/gpl.html GNU Public License * @coversDefaultClass \core_grades\component_gradeitem */ class component_gradeitem_test extends advanced_testcase { /** * Test get_formatted_grade_for_user with points. * * @covers ::get_formatted_grade_for_user */ public function test_get_formatted_grade_for_user_with_points() { $grade = $this->initialise_test_and_get_grade_item(5, 4); $this->assertEquals(4, $grade->grade); $this->assertEquals('4.00 / 5.00', $grade->usergrade); $this->assertEquals(5, $grade->maxgrade); } /** * Test get_formatted_grade_for_user with letters. * * @covers ::get_formatted_grade_for_user */ public function test_get_formatted_grade_for_user_with_letters() { $grade = $this->initialise_test_and_get_grade_item(5, 4, GRADE_DISPLAY_TYPE_LETTER); $this->assertEquals(4, $grade->grade); $this->assertEquals('B-', $grade->usergrade); $this->assertEquals(5, $grade->maxgrade); } /** * Test get_formatted_grade_for_user with percentage. * * @covers ::get_formatted_grade_for_user */ public function test_get_formatted_grade_for_user_with_percentage() { $grade = $this->initialise_test_and_get_grade_item(5, 4, GRADE_DISPLAY_TYPE_PERCENTAGE); $this->assertEquals(4, $grade->grade); $this->assertEquals('80.00 %', $grade->usergrade); $this->assertEquals(5, $grade->maxgrade); } /** * Test get_formatted_grade_for_user with points and letter. * * @covers ::get_formatted_grade_for_user */ public function test_get_formatted_grade_for_user_with_points_letter() { $grade = $this->initialise_test_and_get_grade_item(5, 4, GRADE_DISPLAY_TYPE_REAL_LETTER); $this->assertEquals(4, $grade->grade); $this->assertEquals('4.00 (B-)', $grade->usergrade); $this->assertEquals(5, $grade->maxgrade); } /** * Test get_formatted_grade_for_user with scales. * * @covers ::get_formatted_grade_for_user */ public function test_get_formatted_grade_for_user_with_scales() { $grade = $this->initialise_test_and_get_grade_item(-2, 2); $this->assertEquals(2, $grade->grade); $this->assertEquals('Competent', $grade->usergrade); $this->assertEquals(2, $grade->maxgrade); } /** * Test get_formatted_grade_for_user with rubric. * * @covers ::get_formatted_grade_for_user */ public function test_get_formatted_grade_for_user_with_rubric() { $this->resetAfterTest(); $generator = \testing_util::get_data_generator(); $rubricgenerator = $generator->get_plugin_generator('gradingform_rubric'); $forum = $this->get_forum_instance(); $course = $forum->get_course_record(); $teacher = $this->getDataGenerator()->create_and_enrol($course, 'teacher'); $student = $this->getDataGenerator()->create_and_enrol($course); $this->setUser($teacher); $controller = $rubricgenerator->get_test_rubric($forum->get_context(), 'forum', 'forum'); // In the situation of mod_forum this would be the id from forum_grades. $itemid = 1; $instance = $controller->create_instance($student->id, $itemid); $spellingscore = 1; $spellingremark = 'Too many mistakes. Please try again.'; $picturescore = 2; $pictureremark = 'Great number of pictures. Well done.'; $submissiondata = $rubricgenerator->get_test_form_data( $controller, (int) $student->id, $spellingscore, $spellingremark, $picturescore, $pictureremark ); $gradeitem = component_gradeitem::instance('mod_forum', $forum->get_context(), 'forum'); $gradeitem->store_grade_from_formdata($student, $teacher, (object) [ 'instanceid' => $instance->get_id(), 'advancedgrading' => $submissiondata, ]); $this->setUser($student); $result = $gradeitem->get_formatted_grade_for_user($student, $teacher); $this->assertEquals(75, $result->grade); $this->assertEquals('75.00 / 100.00', $result->usergrade); $this->assertEquals(100, $result->maxgrade); } /** * Test get_formatted_grade_for_user with a marking guide. * * @covers ::get_formatted_grade_for_user */ public function test_get_formatted_grade_for_user_with_marking_guide() { $this->resetAfterTest(); $generator = \testing_util::get_data_generator(); $guidegenerator = $generator->get_plugin_generator('gradingform_guide'); $forum = $this->get_forum_instance(); $course = $forum->get_course_record(); $teacher = $this->getDataGenerator()->create_and_enrol($course, 'teacher'); $student = $this->getDataGenerator()->create_and_enrol($course); $this->setUser($teacher); $controller = $guidegenerator->get_test_guide($forum->get_context(), 'forum', 'forum'); // In the situation of mod_forum this would be the id from forum_grades. $itemid = 1; $instance = $controller->create_instance($student->id, $itemid); $spellingscore = 10; $spellingremark = 'Propper good speling'; $picturescore = 0; $pictureremark = 'ASCII art is not a picture'; $submissiondata = $guidegenerator->get_test_form_data($controller, $itemid, $spellingscore, $spellingremark, $picturescore, $pictureremark ); $gradeitem = component_gradeitem::instance('mod_forum', $forum->get_context(), 'forum'); $gradeitem->store_grade_from_formdata($student, $teacher, (object) [ 'instanceid' => $instance->get_id(), 'advancedgrading' => $submissiondata, ]); $this->setUser($student); $result = $gradeitem->get_formatted_grade_for_user($student, $teacher); $this->assertEquals(25, $result->grade); $this->assertEquals('25.00 / 100.00', $result->usergrade); $this->assertEquals(100, $result->maxgrade); } /** * Initialise test and returns the grade item. * * @param int $gradeforum The grade_forum value for the forum. * @param int $gradegiven The grade given by the teacher. * @param int|null $displaytype The display type of the grade. * @return \stdClass|null */ protected function initialise_test_and_get_grade_item(int $gradeforum, int $gradegiven, int $displaytype = null): \stdClass { $this->resetAfterTest(); $forum = $this->get_forum_instance([ // Negative numbers mean a scale, positive numbers represent the maximum mark. 'grade_forum' => $gradeforum, ]); $course = $forum->get_course_record(); $teacher = $this->getDataGenerator()->create_and_enrol($course, 'teacher'); $student = $this->getDataGenerator()->create_and_enrol($course); $this->setUser($teacher); // Get the grade item. $gradeitem = component_gradeitem::instance('mod_forum', $forum->get_context(), 'forum'); // Grade the student. $gradeitem->store_grade_from_formdata($student, $teacher, (object) ['grade' => $gradegiven]); // Change the 'Grade display type' if specified. if ($displaytype) { grade_set_setting($course->id, 'displaytype', $displaytype); } return $gradeitem->get_formatted_grade_for_user($student, $teacher); } /** * Get a forum instance. * * @param array $config * @return forum_entity */ protected function get_forum_instance(array $config = []): forum_entity { $this->resetAfterTest(); $datagenerator = $this->getDataGenerator(); $course = $datagenerator->create_course(); $forum = $datagenerator->create_module('forum', array_merge(['course' => $course->id, 'grade_forum' => 100], $config)); $vaultfactory = container::get_vault_factory(); $vault = $vaultfactory->get_forum_vault(); return $vault->get_from_id((int) $forum->id); } } db/caches.php 0000604 00000002756 15062123207 0007074 0 ustar 00 <?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/>. /** * Cache definitions. * * @package availability_grade * @copyright 2014 The Open University * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ $definitions = array( // Used to cache user grades for conditional availability purposes. 'scores' => array( 'mode' => cache_store::MODE_APPLICATION, 'staticacceleration' => true, 'staticaccelerationsize' => 2, // Should not be required for more than one user at a time. 'ttl' => 3600, ), // Used to cache course grade items for conditional availability purposes. 'items' => array( 'mode' => cache_store::MODE_APPLICATION, 'staticacceleration' => true, 'staticaccelerationsize' => 2, // Should not be required for more than one course at a time. 'ttl' => 3600, ), ); version.php 0000604 00000001752 15062123207 0006741 0 ustar 00 <?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/>. /** * Version info. * * @package availability_grade * @copyright 2014 The Open University * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); $plugin->version = 2023100900; $plugin->requires = 2023100400; $plugin->component = 'availability_grade'; yui/src/form/meta/form.json 0000604 00000000237 15062123207 0011664 0 ustar 00 { "moodle-availability_grade-form": { "requires": [ "base", "node", "event", "moodle-core_availability-form" ] } } yui/src/form/build.json 0000604 00000000235 15062123207 0011070 0 ustar 00 { "name": "moodle-availability_grade-form", "builds": { "moodle-availability_grade-form": { "jsfiles": [ "form.js" ] } } } yui/src/form/js/form.js 0000604 00000013637 15062123207 0011025 0 ustar 00 /** * JavaScript for form editing grade conditions. * * @module moodle-availability_grade-form */ M.availability_grade = M.availability_grade || {}; /** * @class M.availability_grade.form * @extends M.core_availability.plugin */ M.availability_grade.form = Y.Object(M.core_availability.plugin); /** * Grade items available for selection. * * @property grades * @type Array */ M.availability_grade.form.grades = null; /** * Initialises this plugin. * * @method initInner * @param {Array} grades Array of objects containing gradeid => name */ M.availability_grade.form.initInner = function(grades) { this.grades = grades; this.nodesSoFar = 0; }; M.availability_grade.form.getNode = function(json) { // Increment number used for unique ids. this.nodesSoFar++; // Create HTML structure. var html = '<label class="form-group"><span class="pr-3">' + M.util.get_string('title', 'availability_grade') + '</span> ' + '<span class="availability-group">' + '<select name="id" class="custom-select"><option value="0">' + M.util.get_string('choosedots', 'moodle') + '</option>'; for (var i = 0; i < this.grades.length; i++) { var grade = this.grades[i]; // String has already been escaped using format_string. html += '<option value="' + grade.id + '">' + grade.name + '</option>'; } html += '</select></span></label> <br><span class="availability-group form-group">' + '<label><input type="checkbox" class="form-check-input mx-1" name="min"/>' + M.util.get_string('option_min', 'availability_grade') + '</label> <label><span class="accesshide">' + M.util.get_string('label_min', 'availability_grade') + '</span><input type="text" class="form-control mx-1" name="minval" title="' + M.util.get_string('label_min', 'availability_grade') + '"/></label>%</span><br>' + '<span class="availability-group form-group">' + '<label><input type="checkbox" class="form-check-input mx-1" name="max"/>' + M.util.get_string('option_max', 'availability_grade') + '</label> <label><span class="accesshide">' + M.util.get_string('label_max', 'availability_grade') + '</span><input type="text" class="form-control mx-1" name="maxval" title="' + M.util.get_string('label_max', 'availability_grade') + '"/></label>%</span>'; var node = Y.Node.create('<div class="d-inline-block form-inline">' + html + '</div>'); // Set initial values. if (json.id !== undefined && node.one('select[name=id] > option[value=' + json.id + ']')) { node.one('select[name=id]').set('value', '' + json.id); } if (json.min !== undefined) { node.one('input[name=min]').set('checked', true); node.one('input[name=minval]').set('value', json.min); } if (json.max !== undefined) { node.one('input[name=max]').set('checked', true); node.one('input[name=maxval]').set('value', json.max); } // Disables/enables text input fields depending on checkbox. var updateCheckbox = function(check, focus) { var input = check.ancestor('label').next('label').one('input'); var checked = check.get('checked'); input.set('disabled', !checked); if (focus && checked) { input.focus(); } return checked; }; node.all('input[type=checkbox]').each(updateCheckbox); // Add event handlers (first time only). if (!M.availability_grade.form.addedEvents) { M.availability_grade.form.addedEvents = true; var root = Y.one('.availability-field'); root.delegate('change', function() { // For the grade item, just update the form fields. M.core_availability.form.update(); }, '.availability_grade select[name=id]'); root.delegate('click', function() { updateCheckbox(this, true); M.core_availability.form.update(); }, '.availability_grade input[type=checkbox]'); root.delegate('valuechange', function() { // For grade values, just update the form fields. M.core_availability.form.update(); }, '.availability_grade input[type=text]'); } return node; }; M.availability_grade.form.fillValue = function(value, node) { value.id = parseInt(node.one('select[name=id]').get('value'), 10); if (node.one('input[name=min]').get('checked')) { value.min = this.getValue('minval', node); } if (node.one('input[name=max]').get('checked')) { value.max = this.getValue('maxval', node); } }; /** * Gets the numeric value of an input field. Supports decimal points (using * dot or comma). * * @method getValue * @return {Number|String} Value of field as number or string if not valid */ M.availability_grade.form.getValue = function(field, node) { // Get field value. var value = node.one('input[name=' + field + ']').get('value'); // If it is not a valid positive number, return false. if (!(/^[0-9]+([.,][0-9]+)?$/.test(value))) { return value; } // Replace comma with dot and parse as floating-point. var result = parseFloat(value.replace(',', '.')); if (result < 0 || result > 100) { return value; } else { return result; } }; M.availability_grade.form.fillErrors = function(errors, node) { var value = {}; this.fillValue(value, node); // Check grade item id. if (value.id === 0) { errors.push('availability_grade:error_selectgradeid'); } // Check numeric values. if ((value.min !== undefined && typeof (value.min) === 'string') || (value.max !== undefined && typeof (value.max) === 'string')) { errors.push('availability_grade:error_invalidnumber'); } else if (value.min !== undefined && value.max !== undefined && value.min >= value.max) { errors.push('availability_grade:error_backwardrange'); } }; yui/build/moodle-availability_grade-form/moodle-availability_grade-form-debug.js 0000604 00000014074 15062123207 0024157 0 ustar 00 YUI.add('moodle-availability_grade-form', function (Y, NAME) { /** * JavaScript for form editing grade conditions. * * @module moodle-availability_grade-form */ M.availability_grade = M.availability_grade || {}; /** * @class M.availability_grade.form * @extends M.core_availability.plugin */ M.availability_grade.form = Y.Object(M.core_availability.plugin); /** * Grade items available for selection. * * @property grades * @type Array */ M.availability_grade.form.grades = null; /** * Initialises this plugin. * * @method initInner * @param {Array} grades Array of objects containing gradeid => name */ M.availability_grade.form.initInner = function(grades) { this.grades = grades; this.nodesSoFar = 0; }; M.availability_grade.form.getNode = function(json) { // Increment number used for unique ids. this.nodesSoFar++; // Create HTML structure. var html = '<label class="form-group"><span class="pr-3">' + M.util.get_string('title', 'availability_grade') + '</span> ' + '<span class="availability-group">' + '<select name="id" class="custom-select"><option value="0">' + M.util.get_string('choosedots', 'moodle') + '</option>'; for (var i = 0; i < this.grades.length; i++) { var grade = this.grades[i]; // String has already been escaped using format_string. html += '<option value="' + grade.id + '">' + grade.name + '</option>'; } html += '</select></span></label> <br><span class="availability-group form-group">' + '<label><input type="checkbox" class="form-check-input mx-1" name="min"/>' + M.util.get_string('option_min', 'availability_grade') + '</label> <label><span class="accesshide">' + M.util.get_string('label_min', 'availability_grade') + '</span><input type="text" class="form-control mx-1" name="minval" title="' + M.util.get_string('label_min', 'availability_grade') + '"/></label>%</span><br>' + '<span class="availability-group form-group">' + '<label><input type="checkbox" class="form-check-input mx-1" name="max"/>' + M.util.get_string('option_max', 'availability_grade') + '</label> <label><span class="accesshide">' + M.util.get_string('label_max', 'availability_grade') + '</span><input type="text" class="form-control mx-1" name="maxval" title="' + M.util.get_string('label_max', 'availability_grade') + '"/></label>%</span>'; var node = Y.Node.create('<div class="d-inline-block form-inline">' + html + '</div>'); // Set initial values. if (json.id !== undefined && node.one('select[name=id] > option[value=' + json.id + ']')) { node.one('select[name=id]').set('value', '' + json.id); } if (json.min !== undefined) { node.one('input[name=min]').set('checked', true); node.one('input[name=minval]').set('value', json.min); } if (json.max !== undefined) { node.one('input[name=max]').set('checked', true); node.one('input[name=maxval]').set('value', json.max); } // Disables/enables text input fields depending on checkbox. var updateCheckbox = function(check, focus) { var input = check.ancestor('label').next('label').one('input'); var checked = check.get('checked'); input.set('disabled', !checked); if (focus && checked) { input.focus(); } return checked; }; node.all('input[type=checkbox]').each(updateCheckbox); // Add event handlers (first time only). if (!M.availability_grade.form.addedEvents) { M.availability_grade.form.addedEvents = true; var root = Y.one('.availability-field'); root.delegate('change', function() { // For the grade item, just update the form fields. M.core_availability.form.update(); }, '.availability_grade select[name=id]'); root.delegate('click', function() { updateCheckbox(this, true); M.core_availability.form.update(); }, '.availability_grade input[type=checkbox]'); root.delegate('valuechange', function() { // For grade values, just update the form fields. M.core_availability.form.update(); }, '.availability_grade input[type=text]'); } return node; }; M.availability_grade.form.fillValue = function(value, node) { value.id = parseInt(node.one('select[name=id]').get('value'), 10); if (node.one('input[name=min]').get('checked')) { value.min = this.getValue('minval', node); } if (node.one('input[name=max]').get('checked')) { value.max = this.getValue('maxval', node); } }; /** * Gets the numeric value of an input field. Supports decimal points (using * dot or comma). * * @method getValue * @return {Number|String} Value of field as number or string if not valid */ M.availability_grade.form.getValue = function(field, node) { // Get field value. var value = node.one('input[name=' + field + ']').get('value'); // If it is not a valid positive number, return false. if (!(/^[0-9]+([.,][0-9]+)?$/.test(value))) { return value; } // Replace comma with dot and parse as floating-point. var result = parseFloat(value.replace(',', '.')); if (result < 0 || result > 100) { return value; } else { return result; } }; M.availability_grade.form.fillErrors = function(errors, node) { var value = {}; this.fillValue(value, node); // Check grade item id. if (value.id === 0) { errors.push('availability_grade:error_selectgradeid'); } // Check numeric values. if ((value.min !== undefined && typeof (value.min) === 'string') || (value.max !== undefined && typeof (value.max) === 'string')) { errors.push('availability_grade:error_invalidnumber'); } else if (value.min !== undefined && value.max !== undefined && value.min >= value.max) { errors.push('availability_grade:error_backwardrange'); } }; }, '@VERSION@', {"requires": ["base", "node", "event", "moodle-core_availability-form"]}); yui/build/moodle-availability_grade-form/moodle-availability_grade-form.js 0000604 00000014074 15062123207 0023073 0 ustar 00 YUI.add('moodle-availability_grade-form', function (Y, NAME) { /** * JavaScript for form editing grade conditions. * * @module moodle-availability_grade-form */ M.availability_grade = M.availability_grade || {}; /** * @class M.availability_grade.form * @extends M.core_availability.plugin */ M.availability_grade.form = Y.Object(M.core_availability.plugin); /** * Grade items available for selection. * * @property grades * @type Array */ M.availability_grade.form.grades = null; /** * Initialises this plugin. * * @method initInner * @param {Array} grades Array of objects containing gradeid => name */ M.availability_grade.form.initInner = function(grades) { this.grades = grades; this.nodesSoFar = 0; }; M.availability_grade.form.getNode = function(json) { // Increment number used for unique ids. this.nodesSoFar++; // Create HTML structure. var html = '<label class="form-group"><span class="pr-3">' + M.util.get_string('title', 'availability_grade') + '</span> ' + '<span class="availability-group">' + '<select name="id" class="custom-select"><option value="0">' + M.util.get_string('choosedots', 'moodle') + '</option>'; for (var i = 0; i < this.grades.length; i++) { var grade = this.grades[i]; // String has already been escaped using format_string. html += '<option value="' + grade.id + '">' + grade.name + '</option>'; } html += '</select></span></label> <br><span class="availability-group form-group">' + '<label><input type="checkbox" class="form-check-input mx-1" name="min"/>' + M.util.get_string('option_min', 'availability_grade') + '</label> <label><span class="accesshide">' + M.util.get_string('label_min', 'availability_grade') + '</span><input type="text" class="form-control mx-1" name="minval" title="' + M.util.get_string('label_min', 'availability_grade') + '"/></label>%</span><br>' + '<span class="availability-group form-group">' + '<label><input type="checkbox" class="form-check-input mx-1" name="max"/>' + M.util.get_string('option_max', 'availability_grade') + '</label> <label><span class="accesshide">' + M.util.get_string('label_max', 'availability_grade') + '</span><input type="text" class="form-control mx-1" name="maxval" title="' + M.util.get_string('label_max', 'availability_grade') + '"/></label>%</span>'; var node = Y.Node.create('<div class="d-inline-block form-inline">' + html + '</div>'); // Set initial values. if (json.id !== undefined && node.one('select[name=id] > option[value=' + json.id + ']')) { node.one('select[name=id]').set('value', '' + json.id); } if (json.min !== undefined) { node.one('input[name=min]').set('checked', true); node.one('input[name=minval]').set('value', json.min); } if (json.max !== undefined) { node.one('input[name=max]').set('checked', true); node.one('input[name=maxval]').set('value', json.max); } // Disables/enables text input fields depending on checkbox. var updateCheckbox = function(check, focus) { var input = check.ancestor('label').next('label').one('input'); var checked = check.get('checked'); input.set('disabled', !checked); if (focus && checked) { input.focus(); } return checked; }; node.all('input[type=checkbox]').each(updateCheckbox); // Add event handlers (first time only). if (!M.availability_grade.form.addedEvents) { M.availability_grade.form.addedEvents = true; var root = Y.one('.availability-field'); root.delegate('change', function() { // For the grade item, just update the form fields. M.core_availability.form.update(); }, '.availability_grade select[name=id]'); root.delegate('click', function() { updateCheckbox(this, true); M.core_availability.form.update(); }, '.availability_grade input[type=checkbox]'); root.delegate('valuechange', function() { // For grade values, just update the form fields. M.core_availability.form.update(); }, '.availability_grade input[type=text]'); } return node; }; M.availability_grade.form.fillValue = function(value, node) { value.id = parseInt(node.one('select[name=id]').get('value'), 10); if (node.one('input[name=min]').get('checked')) { value.min = this.getValue('minval', node); } if (node.one('input[name=max]').get('checked')) { value.max = this.getValue('maxval', node); } }; /** * Gets the numeric value of an input field. Supports decimal points (using * dot or comma). * * @method getValue * @return {Number|String} Value of field as number or string if not valid */ M.availability_grade.form.getValue = function(field, node) { // Get field value. var value = node.one('input[name=' + field + ']').get('value'); // If it is not a valid positive number, return false. if (!(/^[0-9]+([.,][0-9]+)?$/.test(value))) { return value; } // Replace comma with dot and parse as floating-point. var result = parseFloat(value.replace(',', '.')); if (result < 0 || result > 100) { return value; } else { return result; } }; M.availability_grade.form.fillErrors = function(errors, node) { var value = {}; this.fillValue(value, node); // Check grade item id. if (value.id === 0) { errors.push('availability_grade:error_selectgradeid'); } // Check numeric values. if ((value.min !== undefined && typeof (value.min) === 'string') || (value.max !== undefined && typeof (value.max) === 'string')) { errors.push('availability_grade:error_invalidnumber'); } else if (value.min !== undefined && value.max !== undefined && value.min >= value.max) { errors.push('availability_grade:error_backwardrange'); } }; }, '@VERSION@', {"requires": ["base", "node", "event", "moodle-core_availability-form"]}); yui/build/moodle-availability_grade-form/moodle-availability_grade-form-min.js 0000604 00000006674 15062123207 0023663 0 ustar 00 YUI.add("moodle-availability_grade-form",function(r,a){M.availability_grade=M.availability_grade||{},M.availability_grade.form=r.Object(M.core_availability.plugin),M.availability_grade.form.grades=null,M.availability_grade.form.initInner=function(a){this.grades=a,this.nodesSoFar=0},M.availability_grade.form.getNode=function(a){var e,i,l,t,n;for(this.nodesSoFar++,e='<label class="form-group"><span class="pr-3">'+M.util.get_string("title","availability_grade")+'</span> <span class="availability-group"><select name="id" class="custom-select"><option value="0">'+M.util.get_string("choosedots","moodle")+"</option>",i=0;i<this.grades.length;i++)e+='<option value="'+(l=this.grades[i]).id+'">'+l.name+"</option>";return e+='</select></span></label> <br><span class="availability-group form-group"><label><input type="checkbox" class="form-check-input mx-1" name="min"/>'+M.util.get_string("option_min","availability_grade")+'</label> <label><span class="accesshide">'+M.util.get_string("label_min","availability_grade")+'</span><input type="text" class="form-control mx-1" name="minval" title="'+M.util.get_string("label_min","availability_grade")+'"/></label>%</span><br><span class="availability-group form-group"><label><input type="checkbox" class="form-check-input mx-1" name="max"/>'+M.util.get_string("option_max","availability_grade")+'</label> <label><span class="accesshide">'+M.util.get_string("label_max","availability_grade")+'</span><input type="text" class="form-control mx-1" name="maxval" title="'+M.util.get_string("label_max","availability_grade")+'"/></label>%</span>',t=r.Node.create('<div class="d-inline-block form-inline">'+e+"</div>"),a.id!==undefined&&t.one("select[name=id] > option[value="+a.id+"]")&&t.one("select[name=id]").set("value",""+a.id),a.min!==undefined&&(t.one("input[name=min]").set("checked",!0),t.one("input[name=minval]").set("value",a.min)),a.max!==undefined&&(t.one("input[name=max]").set("checked",!0),t.one("input[name=maxval]").set("value",a.max)),n=function(a,e){var i=a.ancestor("label").next("label").one("input"),a=a.get("checked");return i.set("disabled",!a),e&&a&&i.focus(),a},t.all("input[type=checkbox]").each(n),M.availability_grade.form.addedEvents||(M.availability_grade.form.addedEvents=!0,(a=r.one(".availability-field")).delegate("change",function(){M.core_availability.form.update()},".availability_grade select[name=id]"),a.delegate("click",function(){n(this,!0),M.core_availability.form.update()},".availability_grade input[type=checkbox]"),a.delegate("valuechange",function(){M.core_availability.form.update()},".availability_grade input[type=text]")),t},M.availability_grade.form.fillValue=function(a,e){a.id=parseInt(e.one("select[name=id]").get("value"),10),e.one("input[name=min]").get("checked")&&(a.min=this.getValue("minval",e)),e.one("input[name=max]").get("checked")&&(a.max=this.getValue("maxval",e))},M.availability_grade.form.getValue=function(a,e){a=e.one("input[name="+a+"]").get("value");return!/^[0-9]+([.,][0-9]+)?$/.test(a)||(e=parseFloat(a.replace(",",".")))<0||100<e?a:e},M.availability_grade.form.fillErrors=function(a,e){var i={};this.fillValue(i,e),0===i.id&&a.push("availability_grade:error_selectgradeid"),i.min!==undefined&&"string"==typeof i.min||i.max!==undefined&&"string"==typeof i.max?a.push("availability_grade:error_invalidnumber"):i.min!==undefined&&i.max!==undefined&&i.max<=i.min&&a.push("availability_grade:error_backwardrange")}},"@VERSION@",{requires:["base","node","event","moodle-core_availability-form"]}); tests/condition_test.php 0000604 00000024751 15062123207 0011447 0 ustar 00 <?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/>. namespace availability_grade; /** * Unit tests for the grade condition. * * @package availability_grade * @copyright 2014 The Open University * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class condition_test extends \advanced_testcase { /** * Tests constructing and using grade condition. */ public function test_usage() { global $USER, $CFG; require_once($CFG->dirroot . '/mod/assign/locallib.php'); $this->resetAfterTest(); $CFG->enableavailability = true; // Make a test course and user. $course = $this->getDataGenerator()->create_course(); $user = $this->getDataGenerator()->create_user(); $this->getDataGenerator()->enrol_user($user->id, $course->id); // Make assign module. $assignrow = $this->getDataGenerator()->create_module('assign', array( 'course' => $course->id, 'name' => 'Test!')); $assign = new \assign(\context_module::instance($assignrow->cmid), false, false); $modinfo = get_fast_modinfo($course); $cm = $modinfo->get_cm($assignrow->cmid); $info = new \core_availability\info_module($cm); // Get the actual grade item. $item = $assign->get_grade_item(); // Construct tree with grade condition (any grade, specified item). $structure = (object)array('type' => 'grade', 'id' => (int)$item->id); $cond = new condition($structure); // Check if available (not available). $this->assertFalse($cond->is_available(false, $info, true, $user->id)); $information = $cond->get_description(false, false, $info); $information = \core_availability\info::format_info($information, $course); $this->assertMatchesRegularExpression('~have a grade.*Test!~', $information); $this->assertTrue($cond->is_available(true, $info, true, $user->id)); // Add grade and check available. self::set_grade($assignrow, $user->id, 37.2); $this->assertTrue($cond->is_available(false, $info, true, $user->id)); $this->assertFalse($cond->is_available(true, $info, true, $user->id)); $information = $cond->get_description(false, true, $info); $information = \core_availability\info::format_info($information, $course); $this->assertMatchesRegularExpression('~do not have a grade.*Test!~', $information); // Construct directly and test remaining conditions; first, min grade (fail). self::set_grade($assignrow, $user->id, 29.99999); $structure->min = 30.0; $cond = new condition($structure); $this->assertFalse($cond->is_available(false, $info, true, $user->id)); $information = $cond->get_description(false, false, $info); $information = \core_availability\info::format_info($information, $course); $this->assertMatchesRegularExpression('~achieve higher than.*Test!~', $information); $this->assertTrue($cond->is_available(true, $info, true, $user->id)); // Min grade (success). self::set_grade($assignrow, $user->id, 30); $this->assertTrue($cond->is_available(false, $info, true, $user->id)); $this->assertFalse($cond->is_available(true, $info, true, $user->id)); $information = $cond->get_description(false, true, $info); $information = \core_availability\info::format_info($information, $course); $this->assertMatchesRegularExpression('~do not get certain scores.*Test!~', $information); // Max grade (fail). unset($structure->min); $structure->max = 30.0; $cond = new condition($structure); $this->assertFalse($cond->is_available(false, $info, true, $user->id)); $information = $cond->get_description(false, false, $info); $information = \core_availability\info::format_info($information, $course); $this->assertMatchesRegularExpression('~achieve lower than a certain score in.*Test!~', $information); $this->assertTrue($cond->is_available(true, $info, true, $user->id)); // Max grade (success). self::set_grade($assignrow, $user->id, 29.99999); $this->assertTrue($cond->is_available(false, $info, true, $user->id)); $this->assertFalse($cond->is_available(true, $info, true, $user->id)); $information = $cond->get_description(false, true, $info); $information = \core_availability\info::format_info($information, $course); $this->assertMatchesRegularExpression('~do not get certain scores.*Test!~', $information); // Max and min (fail). $structure->min = 30.0; $structure->max = 34.12345; $cond = new condition($structure); $this->assertFalse($cond->is_available(false, $info, true, $user->id)); $information = $cond->get_description(false, false, $info); $information = \core_availability\info::format_info($information, $course); $this->assertMatchesRegularExpression('~achieve a score within a certain range.*Test!~', $information); $this->assertTrue($cond->is_available(true, $info, true, $user->id)); // Still fail (other end). self::set_grade($assignrow, $user->id, 34.12345); $this->assertFalse($cond->is_available(false, $info, true, $user->id)); // Success (top end). self::set_grade($assignrow, $user->id, 34.12344); $this->assertTrue($cond->is_available(false, $info, true, $user->id)); $this->assertFalse($cond->is_available(true, $info, true, $user->id)); $information = $cond->get_description(false, true, $info); $information = \core_availability\info::format_info($information, $course); $this->assertMatchesRegularExpression('~do not get certain scores.*Test!~', $information); // Success (bottom end). self::set_grade($assignrow, $user->id, 30.0); $this->assertTrue($cond->is_available(false, $info, true, $user->id)); $this->assertFalse($cond->is_available(true, $info, true, $user->id)); $information = $cond->get_description(false, true, $info); $information = \core_availability\info::format_info($information, $course); $this->assertMatchesRegularExpression('~do not get certain scores.*Test!~', $information); } /** * Tests the constructor including error conditions. Also tests the * string conversion feature (intended for debugging only). */ public function test_constructor() { // No parameters. $structure = new \stdClass(); try { $cond = new condition($structure); $this->fail(); } catch (\coding_exception $e) { $this->assertStringContainsString('Missing or invalid ->id', $e->getMessage()); } // Invalid id (not int). $structure->id = 'bourne'; try { $cond = new condition($structure); $this->fail(); } catch (\coding_exception $e) { $this->assertStringContainsString('Missing or invalid ->id', $e->getMessage()); } // Invalid min (not number). $structure->id = 42; $structure->min = 'ute'; try { $cond = new condition($structure); $this->fail(); } catch (\coding_exception $e) { $this->assertStringContainsString('Missing or invalid ->min', $e->getMessage()); } // Invalid max (not number). $structure->min = 3.89; $structure->max = '9000'; try { $cond = new condition($structure); $this->fail(); } catch (\coding_exception $e) { $this->assertStringContainsString('Missing or invalid ->max', $e->getMessage()); } // All valid. $structure->max = 4.0; $cond = new condition($structure); $this->assertEquals('{grade:#42 >= 3.89000, < 4.00000}', (string)$cond); // No max. unset($structure->max); $cond = new condition($structure); $this->assertEquals('{grade:#42 >= 3.89000}', (string)$cond); // No min. unset($structure->min); $structure->max = 32.768; $cond = new condition($structure); $this->assertEquals('{grade:#42 < 32.76800}', (string)$cond); // No nothing (only requires that grade exists). unset($structure->max); $cond = new condition($structure); $this->assertEquals('{grade:#42}', (string)$cond); } /** * Tests the save() function. */ public function test_save() { $structure = (object)array('id' => 19); $cond = new condition($structure); $structure->type = 'grade'; $this->assertEquals($structure, $cond->save()); $structure = (object)array('id' => 19, 'min' => 4.12345, 'max' => 90); $cond = new condition($structure); $structure->type = 'grade'; $this->assertEquals($structure, $cond->save()); } /** * Updates the grade of a user in the given assign module instance. * * @param \stdClass $assignrow Assignment row from database * @param int $userid User id * @param float $grade Grade */ protected static function set_grade($assignrow, $userid, $grade) { $grades = array(); $grades[$userid] = (object)array( 'rawgrade' => $grade, 'userid' => $userid); $assignrow->cmidnumber = null; assign_grade_item_update($assignrow, $grades); } /** * Tests the update_dependency_id() function. */ public function test_update_dependency_id() { $cond = new condition((object)array('id' => 123)); $this->assertFalse($cond->update_dependency_id('frogs', 123, 456)); $this->assertFalse($cond->update_dependency_id('grade_items', 12, 34)); $this->assertTrue($cond->update_dependency_id('grade_items', 123, 456)); $after = $cond->save(); $this->assertEquals(456, $after->id); } } tests/behat/availability_grade.feature 0000604 00000015155 15062123207 0014163 0 ustar 00 @availability @availability_grade Feature: availability_grade In order to control student access to activities As a teacher I need to set date conditions which prevent student access Background: Given the following "courses" exist: | fullname | shortname | format | enablecompletion | | Course 1 | C1 | topics | 1 | And the following "users" exist: | username | email | | teacher1 | t@example.com | | student1 | s@example.com | And the following "course enrolments" exist: | user | course | role | | teacher1 | C1 | editingteacher | | student1 | C1 | student | # Add an assignment. And the following "activities" exist: | activity | course | name | assignsubmission_onlinetext_enabled | | assign | C1 | A1 | 1 | | page | C1 | P1 | | | page | C1 | P2 | | | page | C1 | P3 | | | page | C1 | P4 | | @javascript Scenario: Test condition Given I am on the "P2" "page activity editing" page logged in as "teacher1" And I expand all fieldsets And I click on "Add restriction..." "button" And I click on "Grade" "button" in the "Add restriction..." "dialogue" And I click on ".availability-item .availability-eye img" "css_element" And I set the field "Grade" to "A1" And I press "Save and return to course" # Add a Page with a grade condition for 50%. And I am on the "P3" "page activity editing" page And I expand all fieldsets And I click on "Add restriction..." "button" And I click on "Grade" "button" in the "Add restriction..." "dialogue" And I click on ".availability-item .availability-eye img" "css_element" And I set the field "Grade" to "A1" And I click on "min" "checkbox" in the ".availability-item" "css_element" And I set the field "Minimum grade percentage (inclusive)" to "50" And I click on "max" "checkbox" in the ".availability-item" "css_element" And I set the field "Maximum grade percentage (exclusive)" to "80" And I press "Save and return to course" # Check if disabling a part of the restriction is get saved. And I am on the "P3" "page activity editing" page And I expand all fieldsets And I click on "max" "checkbox" in the ".availability-item" "css_element" And I press "Save and return to course" And I am on the "P3" "page activity editing" page And the field "Maximum grade percentage (exclusive)" matches value "" And I am on "Course 1" course homepage # Add a Page with a grade condition for 10%. And I am on the "P4" "page activity editing" page And I expand all fieldsets And I click on "Add restriction..." "button" And I click on "Grade" "button" in the "Add restriction..." "dialogue" And I click on ".availability-item .availability-eye img" "css_element" And I set the field "Grade" to "A1" And I click on "min" "checkbox" in the ".availability-item" "css_element" And I set the field "Minimum grade percentage (inclusive)" to "10" And I press "Save and return to course" # Log in as student without a grade yet. When I am on the "A1" "assign activity" page logged in as student1 # Do the assignment. And I click on "Add submission" "button" And I set the field "Online text" to "Q" And I click on "Save changes" "button" And I am on "Course 1" course homepage # None of the pages should appear (check assignment though). Then I should not see "P2" in the "region-main" "region" And I should not see "P3" in the "region-main" "region" And I should not see "P4" in the "region-main" "region" And I should see "A1" in the "region-main" "region" # Log back in as teacher. When I am on the "A1" "assign activity" page logged in as teacher1 # Give the assignment 40%. And I follow "View all submissions" # Pick the grade link in the row that has s@example.com in it. And I click on "Grade" "link" in the "s@example.com" "table_row" And I set the field "Grade out of 100" to "40" And I click on "Save changes" "button" And I click on "Edit settings" "link" And I log out # Log back in as student. And I am on the "Course 1" course page logged in as student1 # Check pages are visible. Then I should see "P2" in the "region-main" "region" And I should see "P4" in the "region-main" "region" And I should not see "P3" in the "region-main" "region" @javascript Scenario: Condition display with filters # Teacher sets up a restriction on group G1, using multilang filter. Given the following "activity" exists: | activity | assign | | name | <span lang="en" class="multilang">A-One</span><span lang="fr" class="multilang">A-Un</span> | | intro | Test | | course | C1 | | idnumber | 0001 | | section | 1 | And the "multilang" filter is "on" And the "multilang" filter applies to "content and headings" # The activity names filter is enabled because it triggered a bug in older versions. And the "activitynames" filter is "on" And the "activitynames" filter applies to "content and headings" And I am on the "C1" "Course" page logged in as "teacher1" And I turn editing mode on And I am on the "P1" "page activity editing" page And I expand all fieldsets And I click on "Add restriction..." "button" And I click on "Grade" "button" in the "Add restriction..." "dialogue" And I set the field "Grade" to "A-One" And I click on "min" "checkbox" in the ".availability-item" "css_element" And I set the field "Minimum grade percentage (inclusive)" to "10" And I press "Save and return to course" And I log out # Student sees information about no access to group, with group name in correct language. When I am on the "C1" "Course" page logged in as "student1" Then I should see "Not available unless: You achieve higher than a certain score in A-One" And I should not see "A-Un" lang/en/availability_grade.php 0000604 00000004476 15062123207 0012421 0 ustar 00 <?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/>. /** * Language strings. * * @package availability_grade * @copyright 2014 The Open University * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ $string['cachedef_items'] = 'Grade items cached for evaluating conditional availability'; $string['cachedef_scores'] = 'User grades cached for evaluating conditional availability'; $string['description'] = 'Require students to achieve a specified grade.'; $string['error_backwardrange'] = 'When specifying a grade range, the minimum must be lower than the maximum.'; $string['error_invalidnumber'] = 'Grade ranges must be specified with valid percentages.'; $string['error_selectgradeid'] = 'You must select a grade item for the grade condition.'; $string['label_min'] = 'Minimum grade percentage (inclusive)'; $string['label_max'] = 'Maximum grade percentage (exclusive)'; $string['option_min'] = 'must be ≥'; $string['option_max'] = 'must be <'; $string['pluginname'] = 'Restriction by grades'; $string['requires_any'] = 'You have a grade in <strong>{$a}</strong>'; $string['requires_max'] = 'You achieve lower than a certain score in <strong>{$a}</strong>'; $string['requires_min'] = 'You achieve higher than a certain score in <strong>{$a}</strong>'; $string['requires_notany'] = 'You do not have a grade in <strong>{$a}</strong>'; $string['requires_notgeneral'] = 'You do not get certain scores in <strong>{$a}</strong>'; $string['requires_range'] = 'You achieve a score within a certain range in <strong>{$a}</strong>'; $string['missing'] = '(missing activity)'; $string['title'] = 'Grade'; $string['privacy:metadata'] = 'The Restriction by grades plugin does not store any personal data.'; classes/condition.php 0000604 00000031105 15062123207 0010672 0 ustar 00 <?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/>. /** * Condition on grades of current user. * * @package availability_grade * @copyright 2014 The Open University * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace availability_grade; defined('MOODLE_INTERNAL') || die(); /** * Condition on grades of current user. * * @package availability_grade * @copyright 2014 The Open University * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class condition extends \core_availability\condition { /** @var int Grade item id */ private $gradeitemid; /** @var float|null Min grade (must be >= this) or null if none */ private $min; /** @var float|null Max grade (must be < this) or null if none */ private $max; /** * Constructor. * * @param \stdClass $structure Data structure from JSON decode * @throws \coding_exception If invalid data structure. */ public function __construct($structure) { // Get grade item id. if (isset($structure->id) && is_int($structure->id)) { $this->gradeitemid = $structure->id; } else { throw new \coding_exception('Missing or invalid ->id for grade condition'); } // Get min and max. if (!property_exists($structure, 'min')) { $this->min = null; } else if (is_float($structure->min) || is_int($structure->min)) { $this->min = $structure->min; } else { throw new \coding_exception('Missing or invalid ->min for grade condition'); } if (!property_exists($structure, 'max')) { $this->max = null; } else if (is_float($structure->max) || is_int($structure->max)) { $this->max = $structure->max; } else { throw new \coding_exception('Missing or invalid ->max for grade condition'); } } public function save() { $result = (object)array('type' => 'grade', 'id' => $this->gradeitemid); if (!is_null($this->min)) { $result->min = $this->min; } if (!is_null($this->max)) { $result->max = $this->max; } return $result; } /** * Returns a JSON object which corresponds to a condition of this type. * * Intended for unit testing, as normally the JSON values are constructed * by JavaScript code. * * @param int $gradeitemid Grade item id * @param number|null $min Min grade (or null if no min) * @param number|null $max Max grade (or null if no max) * @return stdClass Object representing condition */ public static function get_json($gradeitemid, $min = null, $max = null) { $result = (object)array('type' => 'grade', 'id' => (int)$gradeitemid); if (!is_null($min)) { $result->min = $min; } if (!is_null($max)) { $result->max = $max; } return $result; } public function is_available($not, \core_availability\info $info, $grabthelot, $userid) { $course = $info->get_course(); $score = $this->get_cached_grade_score($this->gradeitemid, $course->id, $grabthelot, $userid); $allow = $score !== false && (is_null($this->min) || $score >= $this->min) && (is_null($this->max) || $score < $this->max); if ($not) { $allow = !$allow; } return $allow; } public function get_description($full, $not, \core_availability\info $info) { $course = $info->get_course(); // String depends on type of requirement. We are coy about // the actual numbers, in case grades aren't released to // students. if (is_null($this->min) && is_null($this->max)) { $string = 'any'; } else if (is_null($this->max)) { $string = 'min'; } else if (is_null($this->min)) { $string = 'max'; } else { $string = 'range'; } if ($not) { // The specific strings don't make as much sense with 'not'. if ($string === 'any') { $string = 'notany'; } else { $string = 'notgeneral'; } } // We cannot get the name at this point because it requires format_string which is not // allowed here. Instead, get it later with the callback function below. $name = $this->description_callback([$this->gradeitemid]); return get_string('requires_' . $string, 'availability_grade', $name); } /** * Gets the grade name at display time. * * @param \course_modinfo $modinfo Modinfo * @param \context $context Context * @param string[] $params Parameters (just grade item id) * @return string Text value */ public static function get_description_callback_value( \course_modinfo $modinfo, \context $context, array $params): string { if (count($params) !== 1 || !is_number($params[0])) { return '<!-- Invalid grade description callback -->'; } $gradeitemid = (int)$params[0]; return self::get_cached_grade_name($modinfo->get_course_id(), $gradeitemid); } protected function get_debug_string() { $out = '#' . $this->gradeitemid; if (!is_null($this->min)) { $out .= ' >= ' . sprintf('%.5f', $this->min); } if (!is_null($this->max)) { if (!is_null($this->min)) { $out .= ','; } $out .= ' < ' . sprintf('%.5f', $this->max); } return $out; } /** * Obtains the name of a grade item, also checking that it exists. Uses a * cache. The name returned is suitable for display. * * @param int $courseid Course id * @param int $gradeitemid Grade item id * @return string Grade name or empty string if no grade with that id */ private static function get_cached_grade_name($courseid, $gradeitemid) { global $DB, $CFG; require_once($CFG->libdir . '/gradelib.php'); // Get all grade item names from cache, or using db query. $cache = \cache::make('availability_grade', 'items'); if (($cacheditems = $cache->get($courseid)) === false) { // We cache the whole items table not the name; the format_string // call for the name might depend on current user (e.g. multilang) // and this is a shared cache. $cacheditems = $DB->get_records('grade_items', array('courseid' => $courseid)); $cache->set($courseid, $cacheditems); } // Return name from cached item or a lang string. if (!array_key_exists($gradeitemid, $cacheditems)) { return get_string('missing', 'availability_grade'); } $gradeitemobj = $cacheditems[$gradeitemid]; $item = new \grade_item; \grade_object::set_properties($item, $gradeitemobj); return $item->get_name(); } /** * Obtains a grade score. Note that this score should not be displayed to * the user, because gradebook rules might prohibit that. It may be a * non-final score subject to adjustment later. * * @param int $gradeitemid Grade item ID we're interested in * @param int $courseid Course id * @param bool $grabthelot If true, grabs all scores for current user on * this course, so that later ones come from cache * @param int $userid Set if requesting grade for a different user (does * not use cache) * @return float Grade score as a percentage in range 0-100 (e.g. 100.0 * or 37.21), or false if user does not have a grade yet */ protected static function get_cached_grade_score($gradeitemid, $courseid, $grabthelot=false, $userid=0) { global $USER, $DB; if (!$userid) { $userid = $USER->id; } $cache = \cache::make('availability_grade', 'scores'); if (($cachedgrades = $cache->get($userid)) === false) { $cachedgrades = array(); } if (!array_key_exists($gradeitemid, $cachedgrades)) { if ($grabthelot) { // Get all grades for the current course. $rs = $DB->get_recordset_sql(' SELECT gi.id,gg.finalgrade,gg.rawgrademin,gg.rawgrademax FROM {grade_items} gi LEFT JOIN {grade_grades} gg ON gi.id=gg.itemid AND gg.userid=? WHERE gi.courseid = ?', array($userid, $courseid)); foreach ($rs as $record) { // This function produces division by zero error warnings when rawgrademax and rawgrademin // are equal. Below change does not affect function behavior, just avoids the warning. if (is_null($record->finalgrade) || $record->rawgrademax == $record->rawgrademin) { // No grade = false. $cachedgrades[$record->id] = false; } else { // Otherwise convert grade to percentage. $cachedgrades[$record->id] = (($record->finalgrade - $record->rawgrademin) * 100) / ($record->rawgrademax - $record->rawgrademin); } } $rs->close(); // And if it's still not set, well it doesn't exist (eg // maybe the user set it as a condition, then deleted the // grade item) so we call it false. if (!array_key_exists($gradeitemid, $cachedgrades)) { $cachedgrades[$gradeitemid] = false; } } else { // Just get current grade. $record = $DB->get_record('grade_grades', array( 'userid' => $userid, 'itemid' => $gradeitemid)); // This function produces division by zero error warnings when rawgrademax and rawgrademin // are equal. Below change does not affect function behavior, just avoids the warning. if ($record && !is_null($record->finalgrade) && $record->rawgrademax != $record->rawgrademin) { $score = (($record->finalgrade - $record->rawgrademin) * 100) / ($record->rawgrademax - $record->rawgrademin); } else { // Treat the case where row exists but is null, same as // case where row doesn't exist. $score = false; } $cachedgrades[$gradeitemid] = $score; } $cache->set($userid, $cachedgrades); } return $cachedgrades[$gradeitemid]; } public function update_after_restore($restoreid, $courseid, \base_logger $logger, $name) { global $DB; $rec = \restore_dbops::get_backup_ids_record($restoreid, 'grade_item', $this->gradeitemid); if (!$rec || !$rec->newitemid) { // If we are on the same course (e.g. duplicate) then we can just // use the existing one. if ($DB->record_exists('grade_items', array('id' => $this->gradeitemid, 'courseid' => $courseid))) { return false; } // Otherwise it's a warning. $this->gradeitemid = 0; $logger->process('Restored item (' . $name . ') has availability condition on grade that was not restored', \backup::LOG_WARNING); } else { $this->gradeitemid = (int)$rec->newitemid; } return true; } public function update_dependency_id($table, $oldid, $newid) { if ($table === 'grade_items' && (int)$this->gradeitemid === (int)$oldid) { $this->gradeitemid = $newid; return true; } else { return false; } } } classes/callbacks.php 0000604 00000003411 15062123207 0010622 0 ustar 00 <?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/>. /** * Observer handling events. * * @package availability_grade * @copyright 2014 The Open University * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace availability_grade; defined('MOODLE_INTERNAL') || die(); /** * Callbacks handling grade changes (to clear cache). * * This ought to use the hooks system, but it doesn't exist - calls are * hard-coded. (The new event system is not suitable for this type of use.) * * @package availability_grade * @copyright 2014 The Open University * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class callbacks { /** * A user grade has been updated in gradebook. * * @param int $userid User ID */ public static function grade_changed($userid) { \cache::make('availability_grade', 'scores')->delete($userid); } /** * A grade item has been updated in gradebook. * * @param int $courseid Course id */ public static function grade_item_changed($courseid) { \cache::make('availability_grade', 'items')->delete($courseid); } } classes/frontend.php 0000604 00000005262 15062123207 0010530 0 ustar 00 <?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/>. /** * Front-end class. * * @package availability_grade * @copyright 2014 The Open University * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ namespace availability_grade; defined('MOODLE_INTERNAL') || die(); /** * Front-end class. * * @package availability_grade * @copyright 2014 The Open University * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class frontend extends \core_availability\frontend { protected function get_javascript_strings() { return array('option_min', 'option_max', 'label_min', 'label_max'); } protected function get_javascript_init_params($course, \cm_info $cm = null, \section_info $section = null) { global $DB, $CFG; require_once($CFG->libdir . '/gradelib.php'); require_once($CFG->dirroot . '/course/lib.php'); // Get grades as basic associative array. $gradeoptions = array(); $items = \grade_item::fetch_all(array('courseid' => $course->id)); // For some reason the fetch_all things return null if none. $items = $items ? $items : array(); foreach ($items as $id => $item) { // Don't include the grade item if it's linked with a module that is being deleted. if (course_module_instance_pending_deletion($item->courseid, $item->itemmodule, $item->iteminstance)) { continue; } // Do not include grades for current item. if ($cm && $cm->instance == $item->iteminstance && $cm->modname == $item->itemmodule && $item->itemtype == 'mod') { continue; } $gradeoptions[$id] = $item->get_name(true); } \core_collator::asort($gradeoptions); // Change to JS array format and return. $jsarray = array(); foreach ($gradeoptions as $id => $name) { $jsarray[] = (object)array('id' => $id, 'name' => $name); } return array($jsarray); } }
| ver. 1.4 |
Github
|
.
| PHP 8.1.33 | Генерация страницы: 0.12 |
proxy
|
phpinfo
|
Настройка
