[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   * The mod_lesson true / false question answered event class.
  19   *
  20   * @package    mod_lesson
  21   * @copyright  2015 Stephen Bourget
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
  23   */
  24  
  25  namespace mod_lesson\event;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * The mod_lesson question answered event class.
  31   *
  32   * @property-read array $other {
  33   *     Extra information about event.
  34   *
  35   *     - string pagetype: the name of the pagetype as defined in the individual page class
  36   * }
  37   *
  38   * @package    mod_lesson
  39   * @since      Moodle 2.9
  40   * @copyright  2015 Stephen Bourget
  41   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
  42   */
  43  class question_answered extends \core\event\base {
  44  
  45      /**
  46       * Set basic properties for the event.
  47       */
  48      protected function init() {
  49          $this->data['objecttable'] = 'lesson_pages';
  50          $this->data['crud'] = 'c';
  51          $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
  52      }
  53  
  54      /**
  55       * Returns localised general event name.
  56       *
  57       * @return string
  58       */
  59      public static function get_name() {
  60          return get_string('eventquestionanswered', 'mod_lesson');
  61      }
  62  
  63      /**
  64       * Get URL related to the action.
  65       *
  66       * @return \moodle_url
  67       */
  68      public function get_url() {
  69          return new \moodle_url('/mod/lesson/view.php', array('id' => $this->contextinstanceid, 'pageid' => $this->objectid));
  70      }
  71  
  72      /**
  73       * Returns non-localised event description with id's for admin use only.
  74       *
  75       * @return string
  76       */
  77      public function get_description() {
  78          return "The user with id '$this->userid' has answered the ".$this->other['pagetype'] .
  79              " question with id '$this->objectid' in the lesson activity with course module id '$this->contextinstanceid'.";
  80      }
  81  
  82      /**
  83       * Custom validations.
  84       *
  85       * @throws \coding_exception when validation fails.
  86       * @return void
  87       */
  88      protected function validate_data() {
  89          parent::validate_data();
  90          // Make sure this class is never used without proper object details.
  91          if (!$this->contextlevel === CONTEXT_MODULE) {
  92              throw new \coding_exception('Context level must be CONTEXT_MODULE.');
  93          }
  94          if (!isset($this->other['pagetype'])) {
  95              throw new \coding_exception('The \'pagetype\' value must be set in other.');
  96          }
  97      }
  98  
  99      public static function get_objectid_mapping() {
 100          return array('db' => 'lesson_pages', 'restore' => 'lesson_page');
 101      }
 102  
 103      public static function get_other_mapping() {
 104          // Nothing to map.
 105          return false;
 106      }
 107  }