From c1a2436cb5401085e6f736d3d26eeae0e8e12d0d Mon Sep 17 00:00:00 2001 From: Shamim Rezaie Date: Sun, 26 May 2024 18:41:02 +1000 Subject: [PATCH] MDL-80745 core_grades: deprecate core_grades_renderer::group_selector --- .upgradenotes/MDL-80745-2024060602320785.yml | 23 +++++++++++++++++++ grade/renderer.php | 9 ++++++++ grade/report/grader/amd/build/group.min.js | 2 +- .../report/grader/amd/build/group.min.js.map | 2 +- grade/report/grader/amd/src/group.js | 7 ++++++ .../grader/classes/output/action_bar.php | 6 ++++- grade/report/grader/index.php | 3 ++- .../report/singleview/amd/build/group.min.js | 2 +- .../singleview/amd/build/group.min.js.map | 2 +- grade/report/singleview/amd/src/group.js | 7 ++++++ .../singleview/classes/report/singleview.php | 8 ++++--- grade/report/singleview/index.php | 3 ++- grade/report/user/amd/build/group.min.js | 2 +- grade/report/user/amd/build/group.min.js.map | 2 +- grade/report/user/amd/src/group.js | 7 ++++++ .../report/user/classes/output/action_bar.php | 6 ++++- grade/report/user/index.php | 3 ++- 17 files changed, 80 insertions(+), 14 deletions(-) create mode 100644 .upgradenotes/MDL-80745-2024060602320785.yml diff --git a/.upgradenotes/MDL-80745-2024060602320785.yml b/.upgradenotes/MDL-80745-2024060602320785.yml new file mode 100644 index 00000000000..886ca56498c --- /dev/null +++ b/.upgradenotes/MDL-80745-2024060602320785.yml @@ -0,0 +1,23 @@ +issueNumber: MDL-80745 +notes: + core_grades: + - message: > + The `core_grades_renderer::group_selector()` method has been deprecated. + Please use `\core_course\output\actionbar\renderer` to render a + `group_selector` renderable instead. + type: deprecated + gradereport_grader: + - message: > + The `gradereport_grader/group` ESM has been deprecated. Please use + `core_course/actionbar/group` instead. + type: deprecated + gradereport_singleview: + - message: > + The `gradereport_singleview/group` ESM has been deprecated. Please use + `core_course/actionbar/group` instead. + type: deprecated + gradereport_user: + - message: > + The `gradereport_user/group` ESM has been deprecated. Please use + `core_course/actionbar/group` instead. + type: deprecated diff --git a/grade/renderer.php b/grade/renderer.php index 8beccd2549f..d3f772d7f7b 100644 --- a/grade/renderer.php +++ b/grade/renderer.php @@ -47,10 +47,19 @@ class core_grades_renderer extends plugin_renderer_base { * @param object $course The course object. * @param string|null $groupactionbaseurl This parameter has been deprecated since 4.4 and should not be used anymore. * @return string|null The raw HTML to render. + * @deprecated since 4.5. Use \core_course\output\actionbar\renderer' instead. + * @todo Final deprecation in Moodle 6.0. See MDL-82116. */ + #[\core\attribute\deprecated( + replacement: null, + since: '4.5', + reason: 'Moved to \core_course\output\actionbar\renderer.' + )] public function group_selector(object $course, ?string $groupactionbaseurl = null): ?string { global $USER; + \core\deprecation::emit_deprecation_if_present([$this, __FUNCTION__]); + if ($groupactionbaseurl !== null) { debugging( 'The $groupactionbaseurl argument has been deprecated. Please remove it from your method calls.', diff --git a/grade/report/grader/amd/build/group.min.js b/grade/report/grader/amd/build/group.min.js index 759e108fad6..f7a49354103 100644 --- a/grade/report/grader/amd/build/group.min.js +++ b/grade/report/grader/amd/build/group.min.js @@ -1,3 +1,3 @@ -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})); +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;window.console.warn("The gradereport_grader/group module has been deprecated since Moodle 4.5. Please use core_course/actionbar/group instead."),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 \ No newline at end of file diff --git a/grade/report/grader/amd/build/group.min.js.map b/grade/report/grader/amd/build/group.min.js.map index d3833d64d78..8d578e41dd2 100644 --- a/grade/report/grader/amd/build/group.min.js.map +++ b/grade/report/grader/amd/build/group.min.js.map @@ -1 +1 @@ -{"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 .\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 \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 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"} \ No newline at end of file +{"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 .\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 \n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n * @deprecated since Moodle 4.5 - please use core_course/actionbar/group instead.\n * @todo Final deprecation in Moodle 6.0. See MDL-82116.\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 window.console.warn(\n 'The gradereport_grader/group module has been deprecated since Moodle 4.5.' +\n ' Please use core_course/actionbar/group instead.',\n );\n\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 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","window","console","warn","selectors","this","courseid","component","document","querySelector","componentSelector","courseID","dataset","selectOneLink","groupID","Url","relativeUrl","id","groupsearchvalue","getSearchTerm","group"],"mappings":"2WA2BqBA,cAAcC,eAI/BC,gCACIC,OAAOC,QAAQC,KACX,0RAOCC,UAAY,IAAIC,KAAKD,UACtBE,SAAU,kCAERC,UAAYC,SAASC,cAAcJ,KAAKK,0BACzCC,SAAWJ,UAAUE,cAAcJ,KAAKD,UAAUE,UAAUM,QAAQN,8BAIlE,IAAIR,MASfe,cAAcC,gBACHC,aAAIC,YAAY,iCAAkC,CACrDC,GAAIZ,KAAKM,SACTO,iBAAkBb,KAAKc,gBACvBC,MAAON,UACR"} \ No newline at end of file diff --git a/grade/report/grader/amd/src/group.js b/grade/report/grader/amd/src/group.js index 1a22571c641..c97f52456e6 100644 --- a/grade/report/grader/amd/src/group.js +++ b/grade/report/grader/amd/src/group.js @@ -19,6 +19,8 @@ * @module gradereport_grader/group * @copyright 2023 Mathew May * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @deprecated since Moodle 4.5 - please use core_course/actionbar/group instead. + * @todo Final deprecation in Moodle 6.0. See MDL-82116. */ import GroupSearch from 'core_group/comboboxsearch/group'; import Url from 'core/url'; @@ -28,6 +30,11 @@ export default class Group extends GroupSearch { courseID; constructor() { + window.console.warn( + 'The gradereport_grader/group module has been deprecated since Moodle 4.5.' + + ' Please use core_course/actionbar/group instead.', + ); + super(); // Define our standard lookups. diff --git a/grade/report/grader/classes/output/action_bar.php b/grade/report/grader/classes/output/action_bar.php index 240ef44face..e7fa25e1008 100644 --- a/grade/report/grader/classes/output/action_bar.php +++ b/grade/report/grader/classes/output/action_bar.php @@ -110,7 +110,11 @@ class action_bar extends \core_grades\output\action_bar { ]) ); $data['initialselector'] = $initialselector->export_for_template($output); - $data['groupselector'] = $gradesrenderer->group_selector($course); + + if ($course->groupmode) { + $actionbarrenderer = $PAGE->get_renderer('core_course', 'actionbar'); + $data['groupselector'] = $actionbarrenderer->render(new \core_course\output\actionbar\group_selector($course)); + } $resetlink = new moodle_url('/grade/report/grader/index.php', ['id' => $courseid]); $searchinput = $OUTPUT->render_from_template('core_user/comboboxsearch/user_selector', [ diff --git a/grade/report/grader/index.php b/grade/report/grader/index.php index a4641213b7a..ad44a4683d0 100644 --- a/grade/report/grader/index.php +++ b/grade/report/grader/index.php @@ -60,7 +60,8 @@ if (!$course = $DB->get_record('course', array('id' => $courseid))) { // Conditionally add the group JS if we have groups enabled. if ($course->groupmode) { - $PAGE->requires->js_call_amd('gradereport_grader/group', 'init'); + $baseurl = new moodle_url('/grade/report/grader/index.php', ['id' => $courseid]); + $PAGE->requires->js_call_amd('core_course/actionbar/group', 'init', [$baseurl->out(false)]); } require_login($course); diff --git a/grade/report/singleview/amd/build/group.min.js b/grade/report/singleview/amd/build/group.min.js index ac6fb23657f..aca008d88ee 100644 --- a/grade/report/singleview/amd/build/group.min.js +++ b/grade/report/singleview/amd/build/group.min.js @@ -1,3 +1,3 @@ -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})); +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){window.console.warn("The gradereport_singleview/group module has been deprecated since Moodle 4.5. Please use core_course/actionbar/group instead."),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 \ No newline at end of file diff --git a/grade/report/singleview/amd/build/group.min.js.map b/grade/report/singleview/amd/build/group.min.js.map index aac4a97824c..d70ba16f88b 100644 --- a/grade/report/singleview/amd/build/group.min.js.map +++ b/grade/report/singleview/amd/build/group.min.js.map @@ -1 +1 @@ -{"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 .\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 \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 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"} \ No newline at end of file +{"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 .\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 \n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n * @deprecated since Moodle 4.5 - please use core_course/actionbar/group instead.\n * @todo Final deprecation in Moodle 6.0. See MDL-82116.\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 window.console.warn(\n 'The gradereport_singleview/group module has been deprecated since Moodle 4.5.' +\n ' Please use core_course/actionbar/group instead.',\n );\n\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 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","window","console","warn","selectors","this","courseid","component","document","querySelector","componentSelector","courseID","dataset","selectOneLink","groupID","Url","relativeUrl","id","groupsearchvalue","getSearchTerm","group"],"mappings":"mhBA2BqBA,cAAcC,eAW/BC,YAAYC,MACRC,OAAOC,QAAQC,KACX,6MATD,WAcEH,KAAOA,UAGPI,UAAY,IAAIC,KAAKD,UACtBE,SAAU,kCAERC,UAAYC,SAASC,cAAcJ,KAAKK,0BACzCC,SAAWJ,UAAUE,cAAcJ,KAAKD,UAAUE,UAAUM,QAAQN,qBASjEN,aACD,IAAIH,MAAMG,MASrBa,cAAcC,gBACHC,aAAIC,YAAY,qCAAsC,CACzDC,GAAIZ,KAAKM,SACTO,iBAAkBb,KAAKc,gBACvBC,MAAON,QACPd,KAAMK,KAAKL,OACZ"} \ No newline at end of file diff --git a/grade/report/singleview/amd/src/group.js b/grade/report/singleview/amd/src/group.js index acd0f80f9ad..10d4ffd8ce4 100644 --- a/grade/report/singleview/amd/src/group.js +++ b/grade/report/singleview/amd/src/group.js @@ -19,6 +19,8 @@ * @module gradereport_singleview/group * @copyright 2023 Mathew May * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @deprecated since Moodle 4.5 - please use core_course/actionbar/group instead. + * @todo Final deprecation in Moodle 6.0. See MDL-82116. */ import GroupSearch from 'core_group/comboboxsearch/group'; import Url from 'core/url'; @@ -35,6 +37,11 @@ export default class Group extends GroupSearch { * @param {string} item The page type we are currently on. */ constructor(item) { + window.console.warn( + 'The gradereport_singleview/group module has been deprecated since Moodle 4.5.' + + ' Please use core_course/actionbar/group instead.', + ); + super(); this.item = item; diff --git a/grade/report/singleview/classes/report/singleview.php b/grade/report/singleview/classes/report/singleview.php index a2d3df6b701..23b10e9620c 100644 --- a/grade/report/singleview/classes/report/singleview.php +++ b/grade/report/singleview/classes/report/singleview.php @@ -131,7 +131,9 @@ class singleview extends grade_report { protected function setup_groups() { parent::setup_groups(); - $this->group_selector = static::groups_course_menu($this->course); + if ($this->groupmode) { + $this->group_selector = static::groups_course_menu($this->course); + } } /** @@ -144,8 +146,8 @@ class singleview extends grade_report { protected static function groups_course_menu(stdClass $course) { global $PAGE; - $renderer = $PAGE->get_renderer('core_grades'); - return $renderer->group_selector($course); + $renderer = $PAGE->get_renderer('core_course', 'actionbar'); + return $renderer->render(new \core_course\output\actionbar\group_selector($course)); } /** diff --git a/grade/report/singleview/index.php b/grade/report/singleview/index.php index f0bdeafff0e..dd1034330e1 100644 --- a/grade/report/singleview/index.php +++ b/grade/report/singleview/index.php @@ -175,7 +175,8 @@ if ($itemtype == 'user' || $itemtype == 'user_select') { ['id' => $courseid]), 'report', 'singleview'); } if ($course->groupmode && $itemtype !== 'select') { - $PAGE->requires->js_call_amd('gradereport_singleview/group', 'init', [$itemtype]); + $baseurl = new moodle_url('/grade/report/singleview/index.php', ['id' => $courseid, 'item' => $itemtype]); + $PAGE->requires->js_call_amd('core_course/actionbar/group', 'init', [$baseurl->out(false)]); } if ($itemtype == 'user') { diff --git a/grade/report/user/amd/build/group.min.js b/grade/report/user/amd/build/group.min.js index a8f95c01734..a17814d20b1 100644 --- a/grade/report/user/amd/build/group.min.js +++ b/grade/report/user/amd/build/group.min.js @@ -1,3 +1,3 @@ -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})); +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;window.console.warn("The gradereport_user/group module has been deprecated since Moodle 4.5. Please use core_course/actionbar/group instead."),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 \ No newline at end of file diff --git a/grade/report/user/amd/build/group.min.js.map b/grade/report/user/amd/build/group.min.js.map index e9e7f723a9b..defa719c447 100644 --- a/grade/report/user/amd/build/group.min.js.map +++ b/grade/report/user/amd/build/group.min.js.map @@ -1 +1 @@ -{"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 .\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 \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 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"} \ No newline at end of file +{"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 .\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 \n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n * @deprecated since Moodle 4.5 - please use core_course/actionbar/group instead.\n * @todo Final deprecation in Moodle 6.0. See MDL-82116.\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 window.console.warn(\n 'The gradereport_user/group module has been deprecated since Moodle 4.5.' +\n ' Please use core_course/actionbar/group instead.',\n );\n\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 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","window","console","warn","selectors","this","courseid","component","document","querySelector","componentSelector","courseID","dataset","selectOneLink","groupID","Url","relativeUrl","id","groupsearchvalue","getSearchTerm","group"],"mappings":"yWA2BqBA,cAAcC,eAI/BC,gCACIC,OAAOC,QAAQC,KACX,wRAOCC,UAAY,IAAIC,KAAKD,UACtBE,SAAU,kCAERC,UAAYC,SAASC,cAAcJ,KAAKK,0BACzCC,SAAWJ,UAAUE,cAAcJ,KAAKD,UAAUE,UAAUM,QAAQN,8BAIlE,IAAIR,MASfe,cAAcC,gBACHC,aAAIC,YAAY,+BAAgC,CACnDC,GAAIZ,KAAKM,SACTO,iBAAkBb,KAAKc,gBACvBC,MAAON,UACR"} \ No newline at end of file diff --git a/grade/report/user/amd/src/group.js b/grade/report/user/amd/src/group.js index afd2f0dc33c..da953219766 100644 --- a/grade/report/user/amd/src/group.js +++ b/grade/report/user/amd/src/group.js @@ -19,6 +19,8 @@ * @module gradereport_user/group * @copyright 2023 Mathew May * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @deprecated since Moodle 4.5 - please use core_course/actionbar/group instead. + * @todo Final deprecation in Moodle 6.0. See MDL-82116. */ import GroupSearch from 'core_group/comboboxsearch/group'; import Url from 'core/url'; @@ -28,6 +30,11 @@ export default class Group extends GroupSearch { courseID; constructor() { + window.console.warn( + 'The gradereport_user/group module has been deprecated since Moodle 4.5.' + + ' Please use core_course/actionbar/group instead.', + ); + super(); // Define our standard lookups. diff --git a/grade/report/user/classes/output/action_bar.php b/grade/report/user/classes/output/action_bar.php index f096d829763..254c4e049cc 100644 --- a/grade/report/user/classes/output/action_bar.php +++ b/grade/report/user/classes/output/action_bar.php @@ -81,7 +81,11 @@ class action_bar extends \core_grades\output\action_bar { // 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)); + $course = get_course($courseid); + if ($course->groupmode) { + $groupselector = new \core_course\output\actionbar\group_selector($course); + $data['groupselector'] = $PAGE->get_renderer('core_course', 'actionbar')->render($groupselector); + } $data['userselector'] = [ 'courseid' => $courseid, 'content' => $userreportrenderer->users_selector(get_course($courseid), $this->userid, $this->currentgroupid) diff --git a/grade/report/user/index.php b/grade/report/user/index.php index 2c9aea19f5c..d5cd825223c 100644 --- a/grade/report/user/index.php +++ b/grade/report/user/index.php @@ -95,7 +95,8 @@ if (has_capability('moodle/grade:viewall', $context)) { $currentgroup = $gpr->groupid; // Conditionally add the group JS if we have groups enabled. if ($groupmode) { - $PAGE->requires->js_call_amd('gradereport_user/group', 'init'); + $baseurl = new moodle_url('/grade/report/user/index.php', ['id' => $courseid]); + $PAGE->requires->js_call_amd('core_course/actionbar/group', 'init', [$baseurl->out(false)]); } // To make some other functions work better later.