[Summary view]

Differences Between: [Versions 401 and 402] [Versions 401 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 restored 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 restored event class.
  30   *
  31   * @property-read array $other {
  32   *      Extra information about event.
  33   *
  34   *      - int pageid: id wiki page.
  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_restored extends \core\event\base {
  43      /**
  44       * Init method.
  45       *
  46       * @return void
  47       */
  48      protected function init() {
  49          $this->data['crud'] = 'u';
  50          $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
  51          $this->data['objecttable'] = 'wiki_versions';
  52      }
  53  
  54      /**
  55       * Return localised event name.
  56       *
  57       * @return string
  58       */
  59      public static function get_name() {
  60          return get_string('eventversionrestored', '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' restored version '$this->objectid' for the page with id '{$this->other['pageid']}' " .
  70              "for the wiki with 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', 'restore',
  80              'view.php?pageid=' . $this->other['pageid'], $this->other['pageid'], $this->contextinstanceid));
  81      }
  82  
  83      /**
  84       * Get URL related to the action.
  85       *
  86       * @return \moodle_url
  87       */
  88      public function get_url() {
  89          return new \moodle_url('/mod/wiki/viewversion.php', array('pageid' => $this->other['pageid'],
  90              'versionid' => $this->objectid));
  91      }
  92  
  93      /**
  94       * Custom validation.
  95       *
  96       * @throws \coding_exception
  97       * @return void
  98       */
  99      protected function validate_data() {
 100          parent::validate_data();
 101          if (!isset($this->other['pageid'])) {
 102              throw new \coding_exception('The pageid needs to be set in $other');
 103          }
 104      }
 105  
 106      public static function get_objectid_mapping() {
 107          return array('db' => 'wiki_versions', 'restore' => 'wiki_version');
 108      }
 109  
 110      public static function get_other_mapping() {
 111          $othermapped = array();
 112          $othermapped['pageid'] = array('db' => 'wiki_pages', 'restore' => 'wiki_page');
 113  
 114          return $othermapped;
 115      }
 116  }