[Summary view]

Differences Between: [Versions 39 and 400] [Versions 39 and 401] [Versions 39 and 402] [Versions 39 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  /**
  18   * Grade report viewed event.
  19   *
  20   * @package    core
  21   * @copyright  2016 Zane Karl <zkarl@oid.ucla.edu>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core\event;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * Grade report viewed event class.
  31   *
  32   * @package    core
  33   * @since      Moodle 3.2
  34   * @copyright  2016 Zane Karl <zkarl@oid.ucla.edu>
  35   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36   */
  37  abstract class grade_exported extends base {
  38  
  39      /**
  40       * Initialise the event data.
  41       */
  42      protected function init() {
  43          if (!($this instanceof grade_exported)) {
  44              throw new Exception('grade_exported abstract is NOT extended by a valid component.');
  45          }
  46          $this->data['crud'] = 'r';
  47          $this->data['edulevel'] = self::LEVEL_TEACHING;
  48      }
  49  
  50      /**
  51       * Returns localised export type.
  52       *
  53       * @return string
  54       */
  55      public static function get_export_type() {
  56          $classname = explode('\\', get_called_class());
  57          $exporttype = explode('_', $classname[0]);
  58          return $exporttype[1];
  59      }
  60  
  61      /**
  62       * Returns localised general event name.
  63       *
  64       * @return string
  65       */
  66      public static function get_name() {
  67          return get_string('eventgradeexported', 'gradeexport_'. self::get_export_type());
  68      }
  69  
  70      /**
  71       * Returns non-localised description of what happened.
  72       *
  73       * @return string
  74       */
  75      public function get_description() {
  76          return "The user with id '$this->userid'"
  77                  . " exported grades using the ".
  78                  $this->get_export_type() ." export in the gradebook.";
  79      }
  80  
  81      /**
  82       * Returns relevant URL.
  83       *
  84       * @return \moodle_url
  85       */
  86      public function get_url() {
  87          $url = '/grade/export/' . $this->get_export_type() . '/export.php';
  88          return new \moodle_url($url, array('id' => $this->courseid));
  89      }
  90  }