grade/report/singleview/amd/src/group.js

  1. // This file is part of Moodle - http://moodle.org/
  2. //
  3. // Moodle is free software: you can redistribute it and/or modify
  4. // it under the terms of the GNU General Public License as published by
  5. // the Free Software Foundation, either version 3 of the License, or
  6. // (at your option) any later version.
  7. //
  8. // Moodle is distributed in the hope that it will be useful,
  9. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11. // GNU General Public License for more details.
  12. //
  13. // You should have received a copy of the GNU General Public License
  14. // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16. /**
  17.  * Allow the user to search for groups within the singleview report.
  18.  *
  19.  * @module    gradereport_singleview/group
  20.  * @copyright 2023 Mathew May <mathew.solutions>
  21.  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  22.  * @deprecated since Moodle 4.5 - please use core_course/actionbar/group instead.
  23.  * @todo       Final deprecation in Moodle 6.0. See MDL-82116.
  24.  */
  25. import GroupSearch from 'core_group/comboboxsearch/group';
  26. import Url from 'core/url';
  28. export default class Group extends GroupSearch {
  30.     courseID;
  32.     item = null;
  34.     /**
  35.      * Construct the class.
  36.      *
  37.      * @param {string} item The page type we are currently on.
  38.      */
  39.     constructor(item) {
  40.         window.console.warn(
  41.             'The gradereport_singleview/group module has been deprecated since Moodle 4.5.' +
  42.             ' Please use core_course/actionbar/group instead.',
  43.         );
  45.         super();
  46.         this.item = item;
  48.         // Define our standard lookups.
  49.         this.selectors = {...this.selectors,
  50.             courseid: '[data-region="courseid"]',
  51.         };
  52.         const component = document.querySelector(this.componentSelector());
  53.         this.courseID = component.querySelector(this.selectors.courseid).dataset.courseid;
  54.     }
  56.     /**
  57.      * Allow the class to be invoked via PHP.
  58.      *
  59.      * @param {string} item The page type we are currently on.
  60.      * @returns {Group}
  61.      */
  62.     static init(item) {
  63.         return new Group(item);
  64.     }
  66.     /**
  67.      * Build up the link that is dedicated to a particular result.
  68.      *
  69.      * @param {Number} groupID The ID of the group selected.
  70.      * @returns {string|*}
  71.      */
  72.     selectOneLink(groupID) {
  73.         return Url.relativeUrl('/grade/report/singleview/index.php', {
  74.             id: this.courseID,
  75.             groupsearchvalue: this.getSearchTerm(),
  76.             group: groupID,
  77.             item: this.item
  78.         }, false);
  79.     }
  80. }