[Summary view]

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401]

   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   * Questions exported event.
  19   *
  20   * @package    core
  21   * @copyright  2019 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   * Question category exported event class.
  31   *
  32   * @property-read array $other {
  33   *      Extra information about the event.
  34   *
  35   *      - int categoryid: The ID of the category where the question resides
  36   *      - string format: The format of file export
  37   * }
  38   *
  39   * @package    core
  40   * @since      Moodle 3.7
  41   * @copyright  2019 Stephen Bourget
  42   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  43   */
  44  class questions_exported extends question_base {
  45  
  46      /**
  47       * Init method.
  48       */
  49      protected function init() {
  50          $this->data['crud'] = 'r';
  51          $this->data['edulevel'] = self::LEVEL_TEACHING;
  52      }
  53  
  54      /**
  55       * Returns localised general event name.
  56       *
  57       * @return string
  58       */
  59      public static function get_name() {
  60          return get_string('eventquestionsexported', 'question');
  61      }
  62  
  63      /**
  64       * Returns description of what happened.
  65       *
  66       * @return string
  67       */
  68      public function get_description() {
  69          return "The user with id '$this->userid' exported questions in '" . $this->other['format'] .
  70                  "' format from the category with id '" . $this->other['categoryid'] . "'.";
  71      }
  72  
  73      /**
  74       * Returns relevant URL.
  75       *
  76       * @return \moodle_url
  77       */
  78      public function get_url() {
  79          $cat = $this->other['categoryid'] . ',' . $this->contextid;
  80          if ($this->courseid) {
  81              if ($this->contextlevel == CONTEXT_MODULE) {
  82                  return new \moodle_url('/question/edit.php', ['cmid' => $this->contextinstanceid, 'cat' => $cat]);
  83              }
  84              return new \moodle_url('/question/edit.php', ['courseid' => $this->courseid, 'cat' => $cat]);
  85          }
  86          return new \moodle_url('/question/edit.php',
  87                                  ['courseid' => SITEID, 'cat' => $cat]);
  88      }
  89  
  90      /**
  91       * Custom validations.
  92       *
  93       * other['categoryid'] and other['format'] is required.
  94       *
  95       * @throws \coding_exception
  96       * @return void
  97       */
  98      protected function validate_data() {
  99          parent::validate_data();
 100  
 101          if (!isset($this->other['format'])) {
 102              throw new \coding_exception('The \'format\' must be set in \'other\'.');
 103          }
 104      }
 105  
 106      /**
 107       * Returns DB mappings used with backup / restore.
 108       * This is needed to override the function in question_base
 109       *
 110       * @return array
 111       */
 112      public static function get_objectid_mapping() {
 113          // No mappings.
 114          return [];
 115      }
 116  
 117  }