[Summary 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   * Abstract comments viewed event.
  19   *
  20   * @package    core
  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 core\event;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * Abstract comments viewed event class.
  31   *
  32   * This class has to be extended by any event which is triggered while viewing comment.
  33   *
  34   * @package    core
  35   * @since      Moodle 2.7
  36   * @copyright  2013 Rajesh Taneja <rajesh@moodle.com>
  37   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  38   */
  39  abstract class comments_viewed extends base {
  40  
  41      /**
  42       * Init method.
  43       *
  44       * @return void
  45       */
  46      protected function init() {
  47          $this->data['crud'] = 'r';
  48          $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
  49      }
  50  
  51      /**
  52       * Return localised event name.
  53       *
  54       * @return string
  55       */
  56      public static function get_name() {
  57          return get_string('eventcommentsviewed', 'moodle');
  58      }
  59  
  60      /**
  61       * Returns description of what happened.
  62       *
  63       * @return string
  64       */
  65      public function get_description() {
  66          return "The user with id '$this->userid' viewed the comments for '$this->component' with instance id '$this->objectid'.";
  67      }
  68  
  69      /**
  70       * Get URL related to the action.
  71       *
  72       * @return \moodle_url
  73       */
  74      public function get_url() {
  75          $context = $this->get_context();
  76          if ($context) {
  77              return $context->get_url();
  78          } else {
  79              return null;
  80          }
  81      }
  82  }