lib/classes/event/course_module_instance_list_viewed.php

   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 module instance list viewed event.
  19  *
  20  * @package    core
  21  * @copyright  2013 onwards Ankit Agarwal
  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 module instance list viewed event class.
  30  *
  31  * This is an abstract to guide the developers in using this event name for their events.
  32  * It is intended to be used when the user viewes the list of all the instances of a module
  33  * in a course. This replaces the historical 'view all' log entry generated in mod/somemod/index.php.
  34  *
  35  * Example:
  36  *
  37  *     \mod_chat\event\course_module_instance_list_viewed extends \core\event\course_module_instance_list_viewed
  38  *
  39  * @package    core
  40  * @since      Moodle 2.7
  41  * @copyright  2013 onwards Ankit Agarwal
  42  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  43  */
  44 abstract class course_module_instance_list_viewed extends base{
  45
  46     /** @var string protected var to store mod name */
  47     protected $modname;
  48
  49     /**
  50      * Init method.
  51      *
  52      * @throws \coding_exception
  53      * @return void
  54      */
  55     protected function init() {
  56         $this->data['crud'] = 'r';
  57         $this->data['edulevel'] = self::LEVEL_OTHER;
  58         if (strstr($this->component, 'mod_') === false) {
  59             throw new \coding_exception('The event name or namespace is invalid.');
  60         } else {
  61             $this->modname = str_replace('mod_', '', $this->component);
  62         }
  63     }
  64
  65     /**
  66      * Returns description of what happened.
  67      *
  68      * @return string
  69      */
  70     public function get_description() {
  71         return "The user with id '$this->userid' viewed the instance list for the module '$this->modname' in the course " .
  72             "with id '$this->courseid'.";
  73     }
  74
  75     /**
  76      * Return localised event name.
  77      *
  78      * @return string
  79      */
  80     public static function get_name() {
  81         return get_string('eventcoursemoduleinstancelistviewed', 'core');
  82     }
  83
  84     /**
  85      * Get URL related to the action.
  86      *
  87      * @return \moodle_url
  88      */
  89     public function get_url() {
  90         return new \moodle_url("/mod/$this->modname/index.php", array('id' => $this->courseid));
  91     }
  92
  93     /**
  94      * Return the legacy event log data.
  95      *
  96      * @return array|null
  97      */
  98     protected function get_legacy_logdata() {
  99         return array($this->courseid, $this->modname, 'view all', 'index.php?id=' . $this->courseid, '');
 100     }
 101
 102
 103     /**
 104      * Custom validation.
 105      *
 106      * @throws \coding_exception
 107      * @return void
 108      */
 109     protected function validate_data() {
 110         parent::validate_data();
 111         if ($this->contextlevel != CONTEXT_COURSE) {
 112             throw new \coding_exception('Context level must be CONTEXT_COURSE.');
 113         }
 114     }
 115 }