[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   * Event for when a new note entry viewed.
  19   *
  20   * @package    core
  21   * @copyright  2013 Ankit Agarwal
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core\event;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * Class note_viewed
  31   *
  32   * Class for event to be triggered when a note is viewed.
  33   *
  34   * @package    core
  35   * @since      Moodle 2.6
  36   * @copyright  2013 Ankit Agarwal
  37   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  38   */
  39  class notes_viewed extends base {
  40  
  41      /**
  42       * Set basic properties for the event.
  43       */
  44      protected function init() {
  45          $this->data['crud'] = 'r';
  46          $this->data['edulevel'] = self::LEVEL_OTHER;
  47      }
  48  
  49      /**
  50       * Returns localised general event name.
  51       *
  52       * @return string
  53       */
  54      public static function get_name() {
  55          return get_string("eventnotesviewed", "core_notes");
  56      }
  57  
  58      /**
  59       * Returns non-localised event description with id's for admin use only.
  60       *
  61       * @return string
  62       */
  63      public function get_description() {
  64          if (!empty($this->relateduserid)) {
  65              return "The user with id '$this->userid' viewed the notes for the user with id '$this->relateduserid'.";
  66          }
  67  
  68          return "The user with id '$this->userid' viewed the notes for the course with id '$this->courseid'.";
  69      }
  70  
  71      /**
  72       * Returns relevant URL.
  73       *
  74       * @return \moodle_url
  75       */
  76      public function get_url() {
  77          return new \moodle_url('/notes/index.php', array('course' => $this->courseid, 'user' => $this->relateduserid));
  78      }
  79  
  80      /**
  81       * replace add_to_log() statement.
  82       *
  83       * @return array of parameters to be passed to legacy add_to_log() function.
  84       */
  85      protected function get_legacy_logdata() {
  86          return array($this->courseid, 'notes', 'view', 'index.php?course=' . $this->courseid.'&amp;user=' . $this->relateduserid,
  87              'view notes');
  88      }
  89  }