[Summary view] [Print] [Text 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_wiki page viewed event.
  19   *
  20   * @package    mod_wiki
  21   * @copyright  2013 Rajesh Taneja <[email protected]>
  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 page viewed event class.
  30   *
  31   * @package    mod_wiki
  32   * @since      Moodle 2.7
  33   * @copyright  2013 Rajesh Taneja <[email protected]>
  34   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  class page_viewed extends \core\event\base {
  37      /**
  38       * Init method.
  39       *
  40       * @return void
  41       */
  42      protected function init() {
  43          $this->data['crud'] = 'r';
  44          $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
  45          $this->data['objecttable'] = 'wiki_pages';
  46      }
  47  
  48      /**
  49       * Return localised event name.
  50       *
  51       * @return string
  52       */
  53      public static function get_name() {
  54          return get_string('eventpageviewed', 'mod_wiki');
  55      }
  56  
  57      /**
  58       * Returns description of what happened.
  59       *
  60       * @return string
  61       */
  62      public function get_description() {
  63          return "The user with id '$this->userid' viewed the page with id '$this->objectid' for the wiki with " .
  64              "course module id '$this->contextinstanceid'.";
  65      }
  66  
  67      /**
  68       * Return the legacy event log data.
  69       *
  70       * @return array
  71       */
  72      protected function get_legacy_logdata() {
  73          if (!empty($this->other['wid'])) {
  74              return(array($this->courseid, 'wiki', 'view',
  75                  'view.php?wid=' . $this->data['other']['wid'] . '&title=' . $this->data['other']['title'],
  76                  $this->data['other']['wid'], $this->contextinstanceid));
  77          } else if (!empty($this->other['prettyview'])) {
  78              return(array($this->courseid, 'wiki', 'view',
  79                  'prettyview.php?pageid=' . $this->objectid, $this->objectid, $this->contextinstanceid));
  80          } else {
  81              return(array($this->courseid, 'wiki', 'view',
  82                  'view.php?pageid=' . $this->objectid, $this->objectid, $this->contextinstanceid));
  83          }
  84      }
  85  
  86      /**
  87       * Get URL related to the action.
  88       *
  89       * @return \moodle_url
  90       */
  91      public function get_url() {
  92          if (!empty($this->data['other']['wid'])) {
  93              return new \moodle_url('/mod/wiki/view.php', array('wid' => $this->data['other']['wid'],
  94                      'title' => $this->data['other']['title'],
  95                      'uid' => $this->relateduserid,
  96                      'groupanduser' => $this->data['other']['groupanduser'],
  97                      'group' => $this->data['other']['group']
  98                  ));
  99          } else if (!empty($this->other['prettyview'])) {
 100              return new \moodle_url('/mod/wiki/prettyview.php', array('pageid' => $this->objectid));
 101          } else {
 102              return new \moodle_url('/mod/wiki/view.php', array('pageid' => $this->objectid));
 103          }
 104      }
 105  }