[Summary view]

Differences Between: [Versions 311 and 402] [Versions 311 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   * The mod_wiki diff viewed event.
  19   *
  20   * @package    mod_wiki
  21   * @copyright  2013 Rajesh Taneja <rajesh@moodle.com>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace mod_wiki\event;
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  /**
  29   * The mod_wiki diff viewed event class.
  30   *
  31   * @property-read array $other {
  32   *      Extra information about event.
  33   *
  34   *      - int comparewith: version number to compare with.
  35   *      - int compare: version number to compare.
  36   * }
  37   *
  38   * @package    mod_wiki
  39   * @since      Moodle 2.7
  40   * @copyright  2013 Rajesh Taneja <rajesh@moodle.com>
  41   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  42   */
  43  class page_diff_viewed extends \core\event\base {
  44      /**
  45       * Init method.
  46       *
  47       * @return void
  48       */
  49      protected function init() {
  50          $this->data['crud'] = 'r';
  51          $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
  52          $this->data['objecttable'] = 'wiki_pages';
  53      }
  54  
  55      /**
  56       * Return localised event name.
  57       *
  58       * @return string
  59       */
  60      public static function get_name() {
  61          return get_string('eventdiffviewed', 'mod_wiki');
  62      }
  63  
  64      /**
  65       * Returns description of what happened.
  66       *
  67       * @return string
  68       */
  69      public function get_description() {
  70          return "The user with id '$this->userid' viewed the diff for the page with id '$this->objectid' for the wiki with " .
  71              "course module id '$this->contextinstanceid'.";
  72      }
  73  
  74      /**
  75       * Return the legacy event log data.
  76       *
  77       * @return array
  78       */
  79      protected function get_legacy_logdata() {
  80          return(array($this->courseid, 'wiki', 'diff', 'diff.php?pageid=' . $this->objectid . '&comparewith=' .
  81              $this->other['comparewith'] . '&compare=' .  $this->other['compare'], $this->objectid,
  82              $this->contextinstanceid));
  83      }
  84  
  85      /**
  86       * Get URL related to the action.
  87       *
  88       * @return \moodle_url
  89       */
  90      public function get_url() {
  91          return new \moodle_url('/mod/wiki/diff.php', array(
  92              'pageid' => $this->objectid,
  93              'comparewith' => $this->other['comparewith'],
  94              'compare' => $this->other['compare']
  95              ));
  96      }
  97  
  98      /**
  99       * Custom validation.
 100       *
 101       * @throws \coding_exception
 102       * @return void
 103       */
 104      protected function validate_data() {
 105          parent::validate_data();
 106          if (!isset($this->other['comparewith'])) {
 107              throw new \coding_exception('The \'comparewith\' value must be set in other.');
 108          }
 109          if (!isset($this->other['compare'])) {
 110              throw new \coding_exception('The \'compare\' value must be set in other.');
 111          }
 112      }
 113  
 114      public static function get_objectid_mapping() {
 115          return array('db' => 'wiki_pages', 'restore' => 'wiki_page');
 116      }
 117  
 118      public static function get_other_mapping() {
 119          // Nothing to map.
 120          return false;
 121      }
 122  }