[Summary view]

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