[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_moved 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_moved 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   *     - int prevpageid: the id of the previous lesson page
  37   *     - int nextpageid: the id of the next lesson page
  38   * }
  39   *
  40   * @package    mod_lesson
  41   * @since      Moodle 2.9
  42   * @copyright  2015 Stephen Bourget
  43   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
  44   */
  45  class page_moved extends \core\event\base {
  46  
  47      /**
  48       * Set basic properties for the event.
  49       */
  50      protected function init() {
  51          $this->data['objecttable'] = 'lesson_pages';
  52          $this->data['crud'] = 'u';
  53          $this->data['edulevel'] = self::LEVEL_TEACHING;
  54      }
  55  
  56      /**
  57       * Returns localised general event name.
  58       *
  59       * @return string
  60       */
  61      public static function get_name() {
  62          return get_string('eventpagemoved', 'mod_lesson');
  63      }
  64  
  65      /**
  66       * Get URL related to the action.
  67       *
  68       * @return \moodle_url
  69       */
  70      public function get_url() {
  71          return new \moodle_url('/mod/lesson/view.php', array('id' => $this->contextinstanceid, 'pageid' => $this->objectid));
  72      }
  73  
  74      /**
  75       * Returns non-localised event description with id's for admin use only.
  76       *
  77       * @return string
  78       */
  79      public function get_description() {
  80          return "The user with id '$this->userid' has moved a ".$this->other['pagetype']." page with the ".
  81                  "id '$this->objectid' to the slot after the page with the id '".$this->other['prevpageid'].
  82                  "' and before the page with the id '".$this->other['nextpageid'].
  83                  "' in the lesson activity with course module id '$this->contextinstanceid'.";
  84      }
  85  
  86      /**
  87       * Custom validations.
  88       *
  89       * @throws \coding_exception when validation fails.
  90       * @return void
  91       */
  92      protected function validate_data() {
  93          parent::validate_data();
  94          // Make sure this class is never used without proper object details.
  95          if (!$this->contextlevel === CONTEXT_MODULE) {
  96              throw new \coding_exception('Context level must be CONTEXT_MODULE.');
  97          }
  98          if (!isset($this->other['pagetype'])) {
  99              throw new \coding_exception('The \'pagetype\' value must be set in other.');
 100          }
 101          if (!isset($this->other['prevpageid'])) {
 102              throw new \coding_exception('The \'prevpageid\' value must be set in other.');
 103          }
 104          if (!isset($this->other['nextpageid'])) {
 105              throw new \coding_exception('The \'nextpageid\' value must be set in other.');
 106          }
 107      }
 108  
 109      public static function get_objectid_mapping() {
 110          return array('db' => 'lesson_pages', 'restore' => 'lesson_page');
 111      }
 112  
 113      public static function get_other_mapping() {
 114          $othermapped = array();
 115          $othermapped['prevpageid'] = array('db' => 'lesson_pages', 'restore' => 'lesson_page');
 116          $othermapped['nextpageid'] = array('db' => 'lesson_pages', 'restore' => 'lesson_page');
 117  
 118          return $othermapped;
 119      }
 120  }