[Summary view]

Differences Between: [Versions 400 and 402] [Versions 400 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_glossary entry viwed event.
  19   *
  20   * @package    mod_glossary
  21   * @copyright  2014 Marina Glancy
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace mod_glossary\event;
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  /**
  29   * The mod_glossary entry viewed event class.
  30   *
  31   * Triggered when glossary entry is autolinked and viewed by user from another context.
  32   *
  33   * @package    mod_glossary
  34   * @since      Moodle 2.7
  35   * @copyright  2014 Marina Glancy
  36   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  37   */
  38  class entry_viewed extends \core\event\base {
  39      /**
  40       * Init method
  41       */
  42      protected function init() {
  43          $this->data['crud'] = 'r';
  44          $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
  45          $this->data['objecttable'] = 'glossary_entries';
  46      }
  47  
  48      /**
  49       * Returns localised general event name.
  50       *
  51       * @return string
  52       */
  53      public static function get_name() {
  54          return get_string('evententryviewed', 'mod_glossary');
  55      }
  56  
  57      /**
  58       * Returns non-localised event description with id's for admin use only.
  59       *
  60       * @return string
  61       */
  62      public function get_description() {
  63          return "The user with id '$this->userid' has viewed the glossary entry with id '$this->objectid' in " .
  64              "the glossary activity with course module id '$this->contextinstanceid'.";
  65      }
  66  
  67      /**
  68       * Get URL related to the action.
  69       *
  70       * @return \moodle_url
  71       */
  72      public function get_url() {
  73          return new \moodle_url("/mod/glossary/showentry.php",
  74                  array('eid' => $this->objectid));
  75      }
  76  
  77      /**
  78       * Return the legacy event log data.
  79       *
  80       * @return array|null
  81       */
  82      public function get_legacy_logdata() {
  83          return array($this->courseid, 'glossary', 'view entry',
  84              "showentry.php?eid={$this->objectid}",
  85              $this->objectid, $this->contextinstanceid);
  86      }
  87  
  88      /**
  89       * Custom validation.
  90       *
  91       * @throws \coding_exception
  92       * @return void
  93       */
  94      protected function validate_data() {
  95          parent::validate_data();
  96          // Make sure this class is never used without proper object details.
  97          if (!$this->contextlevel === CONTEXT_MODULE) {
  98              throw new \coding_exception('Context level must be CONTEXT_MODULE.');
  99          }
 100      }
 101  
 102      public static function get_objectid_mapping() {
 103          return array('db' => 'glossary_entries', 'restore' => 'glossary_entry');
 104      }
 105  }
 106