[Summary view] [Print] [Text 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 viewed event.
  19   *
  20   * @package    core
  21   * @copyright  2014 Adrian Greeve <[email protected]>
  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 viewed event class.
  30   *
  31   * Class for event to be triggered when a course is viewed.
  32   *
  33   * @property-read array $other {
  34   *      Extra information about the event.
  35   *
  36   *      - int coursesectionid: (optional) The course section ID.
  37   * }
  38   *
  39   * @package    core
  40   * @since      Moodle 2.7
  41   * @copyright  2014 Adrian Greeve <[email protected]>
  42   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  43   */
  44  class course_viewed extends base {
  45  
  46      /**
  47       * Init method.
  48       *
  49       * @return void
  50       */
  51      protected function init() {
  52          $this->data['crud'] = 'r';
  53          $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
  54      }
  55  
  56      /**
  57       * Returns description of what happened.
  58       *
  59       * @return string
  60       */
  61      public function get_description() {
  62  
  63          $sectionstr = '';
  64          if (!empty($this->other['coursesectionid'])) {
  65              $sectionstr = "section number '{$this->other['coursesectionid']}' of the ";
  66          }
  67          $description = "The user with id '$this->userid' viewed the " . $sectionstr . "course with id '$this->courseid'.";
  68          return $description;
  69      }
  70  
  71      /**
  72       * Return localised event name.
  73       *
  74       * @return string
  75       */
  76      public static function get_name() {
  77          return get_string('eventcourseviewed', 'core');
  78      }
  79  
  80      /**
  81       * Get URL related to the action.
  82       *
  83       * @return \moodle_url|null
  84       */
  85      public function get_url() {
  86          global $CFG;
  87          $sectionid = null;
  88          if (isset($this->other['coursesectionid'])) {
  89              $sectionid = $this->other['coursesectionid'];
  90          }
  91          require_once($CFG->dirroot . '/course/lib.php');
  92          try {
  93              return course_get_url($this->courseid, $sectionid);
  94          } catch (\Exception $e) {
  95              return null;
  96          }
  97      }
  98  
  99      /**
 100       * Return the legacy event log data.
 101       *
 102       * @return array|null
 103       */
 104      protected function get_legacy_logdata() {
 105          if ($this->courseid == SITEID and !isloggedin()) {
 106              // We did not log frontpage access in older Moodle versions.
 107              return null;
 108          }
 109  
 110          if (isset($this->other['coursesectionid'])) {
 111              return array($this->courseid, 'course', 'view section', 'view.php?id=' . $this->courseid . '&amp;section='
 112                      . $this->other['coursesectionid'], $this->other['coursesectionid']);
 113          }
 114          return array($this->courseid, 'course', 'view', 'view.php?id=' . $this->courseid, $this->courseid);
 115      }
 116  
 117      /**
 118       * Custom validation.
 119       *
 120       * @throws \coding_exception
 121       * @return void
 122       */
 123      protected function validate_data() {
 124          parent::validate_data();
 125  
 126          if ($this->contextlevel != CONTEXT_COURSE) {
 127              throw new \coding_exception('Context level must be CONTEXT_COURSE.');
 128          }
 129      }
 130  }