Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.

Differences Between: [Versions 402 and 403]

   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  namespace core_grades\output;
  18  
  19  use moodle_url;
  20  
  21  /**
  22   * Renderable class for the action bar elements in the gradebook setup pages.
  23   *
  24   * @package    core_grades
  25   * @copyright  2021 Mihail Geshoski <mihail@moodle.com>
  26   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  27   */
  28  class gradebook_setup_action_bar extends action_bar {
  29  
  30      /**
  31       * Returns the template for the action bar.
  32       *
  33       * @return string
  34       */
  35      public function get_template(): string {
  36          return 'core_grades/gradebook_setup_action_bar';
  37      }
  38  
  39      /**
  40       * Export the data for the mustache template.
  41       *
  42       * @param \renderer_base $output renderer to be used to render the action bar elements.
  43       * @return array
  44       */
  45      public function export_for_template(\renderer_base $output): array {
  46          global $CFG;
  47  
  48          if ($this->context->contextlevel !== CONTEXT_COURSE) {
  49              return [];
  50          }
  51          $courseid = $this->context->instanceid;
  52          // Get the data used to output the general navigation selector.
  53          $generalnavselector = new general_action_bar($this->context,
  54              new moodle_url('/grade/edit/tree/index.php', ['id' => $courseid]), 'settings', 'setup');
  55          $data = $generalnavselector->export_for_template($output);
  56  
  57          // Add a button to the action bar with a link to the 'add grade item' page.
  58          $addgradeitemlink = new moodle_url('/grade/edit/tree/item.php', ['courseid' => $courseid]);
  59          $addgradeitembutton = new \single_button($addgradeitemlink, get_string('additem', 'grades'), 'get');
  60          $data['addgradeitembutton'] = $addgradeitembutton->export_for_template($output);
  61  
  62          // If outcomes are enabled, add a button to the action bar with a link to the 'add outcome item' page.
  63          if (!empty($CFG->enableoutcomes)) {
  64              $addoutcomeitemlink = new moodle_url('/grade/edit/tree/outcomeitem.php', ['courseid' => $courseid]);
  65              $addoutcomeitembutton = new \single_button($addoutcomeitemlink, get_string('addoutcomeitem', 'grades'),
  66                  'get');
  67              $data['addoutcomeitembutton'] = $addoutcomeitembutton->export_for_template($output);
  68          }
  69  
  70          // Add a button to the action bar with a link to the 'add category' page.
  71          $addcategorylink = new moodle_url('/grade/edit/tree/category.php', ['courseid' => $courseid]);
  72          $addcategorybutton = new \single_button($addcategorylink, get_string('addcategory', 'grades'), 'get');
  73          $data['addcategorybutton'] = $addcategorybutton->export_for_template($output);
  74  
  75          return $data;
  76      }
  77  }