[Summary view]

   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   * Course backup created event.
  19   *
  20   * @package    core
  21   * @copyright  2017 Stephen Bourget
  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   * Course backup created event class.
  31   *
  32   * @property-read array $other {
  33   *      Extra information about event.
  34   *
  35   *      - string format: Format of backup (moodle, imscc)
  36   *      - int mode: execution mode.
  37   *      - boolean interactive: Interactive mode (yes/no)
  38   *      - string type: backup type
  39   * }
  40   *
  41   * @package    core
  42   * @since      Moodle 3.4
  43   * @copyright  2017 Stephen Bourget
  44   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  45   */
  46  class course_backup_created extends base {
  47  
  48      /**
  49       * Initialise the event data.
  50       */
  51      protected function init() {
  52          $this->data['objecttable'] = 'course';
  53          $this->data['crud'] = 'c';
  54          $this->data['edulevel'] = self::LEVEL_TEACHING;
  55      }
  56  
  57      /**
  58       * Returns localised general event name.
  59       *
  60       * @return string
  61       */
  62      public static function get_name() {
  63          return get_string('eventcoursebackupcreated');
  64      }
  65  
  66      /**
  67       * Returns non-localised description of what happened.
  68       *
  69       * @return string
  70       */
  71      public function get_description() {
  72          return "The user with id '$this->userid' created a backup of the course with the id '$this->objectid'.";
  73      }
  74  
  75      /**
  76       * Returns relevant URL.
  77       *
  78       * @return \moodle_url
  79       */
  80      public function get_url() {
  81          return new \moodle_url('/course/view.php', array('id' => $this->objectid));
  82      }
  83  
  84      /**
  85       * Custom validation.
  86       *
  87       * @throws \coding_exception
  88       * @return void
  89       */
  90      protected function validate_data() {
  91          parent::validate_data();
  92  
  93          if (!isset($this->other['format'])) {
  94              throw new \coding_exception('The \'format\' value must be set in other.');
  95          }
  96  
  97          if (!isset($this->other['mode'])) {
  98              throw new \coding_exception('The \'mode\' value must be set in other.');
  99          }
 100  
 101          if (!isset($this->other['interactive'])) {
 102              throw new \coding_exception('The \'interactive\' value must be set in other.');
 103          }
 104  
 105          if (!isset($this->other['type'])) {
 106              throw new \coding_exception('The \'type\' value must be set in other.');
 107          }
 108      }
 109  
 110      public static function get_objectid_mapping() {
 111          return array('db' => 'course', 'restore' => 'course');
 112      }
 113  
 114      public static function get_other_mapping() {
 115          // No need to map anything.
 116          return false;
 117      }
 118  }