[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 page_added 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 page_updated 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 page_updated extends \core\event\base {
  44  
  45      /**
  46       * Create instance of event.
  47       *
  48       * @param \lesson_page $lessonpage
  49       * @param \context_module $context
  50       * @return page_updated
  51       */
  52      public static function create_from_lesson_page(\lesson_page $lessonpage, \context_module $context) {
  53          $data = array(
  54              'context' => $context,
  55              'objectid' => $lessonpage->properties()->id,
  56              'other' => array(
  57                  'pagetype' => $lessonpage->get_typestring()
  58              )
  59          );
  60          return self::create($data);
  61      }
  62  
  63  
  64      /**
  65       * Set basic properties for the event.
  66       */
  67      protected function init() {
  68          $this->data['objecttable'] = 'lesson_pages';
  69          $this->data['crud'] = 'u';
  70          $this->data['edulevel'] = self::LEVEL_TEACHING;
  71      }
  72  
  73      /**
  74       * Returns localised general event name.
  75       *
  76       * @return string
  77       */
  78      public static function get_name() {
  79          return get_string('eventpageupdated', 'mod_lesson');
  80      }
  81  
  82      /**
  83       * Get URL related to the action.
  84       *
  85       * @return \moodle_url
  86       */
  87      public function get_url() {
  88          return new \moodle_url('/mod/lesson/view.php', array('id' => $this->contextinstanceid, 'pageid' => $this->objectid));
  89      }
  90  
  91      /**
  92       * Returns non-localised event description with id's for admin use only.
  93       *
  94       * @return string
  95       */
  96      public function get_description() {
  97          return "The user with id '$this->userid' has updated the ".$this->other['pagetype']." page with the ".
  98                  "id '$this->objectid' in the lesson activity with course module id '$this->contextinstanceid'.";
  99      }
 100  
 101      /**
 102       * Custom validations.
 103       *
 104       * @throws \coding_exception when validation fails.
 105       * @return void
 106       */
 107      protected function validate_data() {
 108          parent::validate_data();
 109          // Make sure this class is never used without proper object details.
 110          if (!$this->contextlevel === CONTEXT_MODULE) {
 111              throw new \coding_exception('Context level must be CONTEXT_MODULE.');
 112          }
 113          if (!isset($this->other['pagetype'])) {
 114              throw new \coding_exception('The \'pagetype\' value must be set in other.');
 115          }
 116      }
 117  
 118      public static function get_objectid_mapping() {
 119          return array('db' => 'lesson_pages', 'restore' => 'lesson_page');
 120      }
 121  
 122      public static function get_other_mapping() {
 123          // Nothing to map.
 124          return false;
 125      }
 126  }