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