[Summary view]

Differences Between: [Versions 310 and 400] [Versions 310 and 401] [Versions 310 and 402] [Versions 310 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   * Base class for question events.
  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   * Base class for question events.
  31   *
  32   * @package    core
  33   * @since      Moodle 3.7
  34   * @copyright  2019 Stephen Bourget
  35   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36   */
  37  abstract class question_base extends base {
  38  
  39      /**
  40       * Init method.
  41       */
  42      protected function init() {
  43          $this->data['objecttable'] = 'question';
  44          $this->data['edulevel'] = self::LEVEL_TEACHING;
  45      }
  46  
  47      /**
  48       * Returns relevant URL.
  49       *
  50       * @return \moodle_url
  51       */
  52      public function get_url() {
  53          if ($this->courseid) {
  54              $cat = $this->other['categoryid'] . ',' . $this->contextid;
  55              if ($this->contextlevel == CONTEXT_MODULE) {
  56                  return new \moodle_url('/question/edit.php',
  57                          ['cmid' => $this->contextinstanceid, 'cat' => $cat, 'lastchanged' => $this->objectid]);
  58              }
  59              return new \moodle_url('/question/edit.php',
  60                      ['courseid' => $this->courseid, 'cat' => $cat, 'lastchanged' => $this->objectid]);
  61          }
  62          // Lets try viewing from the frontpage for contexts above course.
  63          return new \moodle_url('/question/category.php',
  64                  ['courseid' => SITEID, 'edit' => $this->other['categoryid'], 'lastchanged' => $this->objectid]);
  65      }
  66  
  67      /**
  68       * Custom validations.
  69       *
  70       * @throws \coding_exception
  71       * @return void
  72       */
  73      protected function validate_data() {
  74          parent::validate_data();
  75  
  76          if (!isset($this->other['categoryid'])) {
  77              throw new \coding_exception('The \'categoryid\' must be set in \'other\'.');
  78          }
  79      }
  80  
  81      /**
  82       * Returns DB mappings used with backup / restore.
  83       *
  84       * @return array
  85       */
  86      public static function get_objectid_mapping() {
  87          return ['db' => 'question', 'restore' => 'question'];
  88      }
  89  
  90      /**
  91       * Used for maping events on restore
  92       *
  93       * @return array
  94       */
  95      public static function get_other_mapping() {
  96  
  97          $othermapped = [];
  98          $othermapped['categoryid'] = ['db' => 'question_categories', 'restore' => 'question_categories'];
  99          return $othermapped;
 100      }
 101  
 102      /**
 103       * Create a event from question object
 104       *
 105       * @param object $question
 106       * @param object|null $context
 107       * @param array|null $other will override the categoryid pre-filled out on the first line.
 108       * @return base
 109       * @throws \coding_exception
 110       */
 111      public static function create_from_question_instance($question, $context = null, $other = null) {
 112  
 113          $params = ['objectid' => $question->id, 'other' => ['categoryid' => $question->category]];
 114  
 115          if (!empty($question->contextid)) {
 116              $params['contextid'] = $question->contextid;
 117          }
 118  
 119          $params['context'] = $context;
 120  
 121          if (!empty($other)) {
 122              $params['other'] = $other;
 123          }
 124  
 125          $event = self::create($params);
 126          return $event;
 127      }
 128  }
 129