[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   * Course category viewed event.
  19   *
  20   * @package    core
  21   * @copyright  2016 Stephen Bourget
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core\event;
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  /**
  29   * Course category viewed event class.
  30   *
  31   * @package    core
  32   * @since      Moodle 3.2
  33   * @copyright  2016 Stephen Bourget
  34   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  class course_category_viewed extends base {
  37  
  38      /**
  39       * Initialise the event data.
  40       */
  41      protected function init() {
  42          $this->data['objecttable'] = 'course_categories';
  43          $this->data['crud'] = 'r';
  44          $this->data['edulevel'] = self::LEVEL_OTHER;
  45      }
  46  
  47      /**
  48       * Returns localised general event name.
  49       *
  50       * @return string
  51       */
  52      public static function get_name() {
  53          return get_string('eventcoursecategoryviewed');
  54      }
  55  
  56      /**
  57       * Returns relevant URL.
  58       *
  59       * @return \moodle_url
  60       */
  61      public function get_url() {
  62          return new \moodle_url('/course/index.php', array('categoryid' => $this->objectid));
  63      }
  64  
  65      /**
  66       * Returns non-localised description of what happened.
  67       *
  68       * @return string
  69       */
  70      public function get_description() {
  71          return "The user with id '$this->userid' viewed the course category with id '$this->objectid'.";
  72      }
  73  
  74      /**
  75       * Used for maping events on restore
  76       *
  77       * @return bool
  78       */
  79      public static function get_objectid_mapping() {
  80          // Categories are not backed up, so no need to map them on restore.
  81          return array('db' => 'course_categories', 'restore' => base::NOT_MAPPED);
  82      }
  83  }