[Summary view]

Differences Between: [Versions 401 and 402] [Versions 401 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 manage outcomes page.
  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 manage_outcomes_action_bar extends action_bar {
  29  
  30      /** @var bool $hasoutcomes Whether there are existing outcomes. */
  31      protected $hasoutcomes;
  32  
  33      /**
  34       * The class constructor.
  35       *
  36       * @param \context $context The context object.
  37       * @param bool $hasoutcomes Whether there are existing outcomes.
  38       */
  39      public function __construct(\context $context, bool $hasoutcomes) {
  40          parent::__construct($context);
  41          $this->hasoutcomes = $hasoutcomes;
  42      }
  43  
  44      /**
  45       * Returns the template for the action bar.
  46       *
  47       * @return string
  48       */
  49      public function get_template(): string {
  50          return 'core_grades/manage_outcomes_action_bar';
  51      }
  52  
  53      /**
  54       * Export the data for the mustache template.
  55       *
  56       * @param \renderer_base $output renderer to be used to render the action bar elements.
  57       * @return array
  58       */
  59      public function export_for_template(\renderer_base $output): array {
  60          $data = [];
  61          $courseid = 0;
  62          // Display the following buttons only if the user is in course gradebook.
  63          if ($this->context->contextlevel === CONTEXT_COURSE) {
  64              $courseid = $this->context->instanceid;
  65              // Add a button to the action bar with a link to the 'course outcomes' page.
  66              $backlink = new moodle_url('/grade/edit/outcome/course.php', ['id' => $courseid]);
  67              $backbutton = new \single_button($backlink, get_string('back'), 'get');
  68              $data['backbutton'] = $backbutton->export_for_template($output);
  69  
  70              // Add a button to the action bar with a link to the 'import outcomes' page. The import outcomes
  71              // functionality is currently only available in the course context.
  72              $importoutcomeslink = new moodle_url('/grade/edit/outcome/import.php', ['courseid' => $courseid]);
  73              $importoutcomesbutton = new \single_button($importoutcomeslink, get_string('importoutcomes', 'grades'),
  74                  'get');
  75              $data['importoutcomesbutton'] = $importoutcomesbutton->export_for_template($output);
  76          }
  77  
  78          // Add a button to the action bar with a link to the 'add new outcome' page.
  79          $addoutcomelink = new moodle_url('/grade/edit/outcome/edit.php', ['courseid' => $courseid]);
  80          $addoutcomebutton = new \single_button($addoutcomelink, get_string('outcomecreate', 'grades'),
  81              'get', true);
  82          $data['addoutcomebutton'] = $addoutcomebutton->export_for_template($output);
  83  
  84          if ($this->hasoutcomes) {
  85              // Add a button to the action bar which enables export of all existing outcomes.
  86              $exportoutcomeslink = new moodle_url('/grade/edit/outcome/export.php',
  87                  ['id' => $courseid, 'sesskey' => sesskey()]);
  88              $exportoutcomesbutton = new \single_button($exportoutcomeslink, get_string('exportalloutcomes', 'grades'),
  89                  'get');
  90              $data['exportoutcomesbutton'] = $exportoutcomesbutton->export_for_template($output);
  91          }
  92  
  93          return $data;
  94      }
  95  }