[Summary view]

Differences Between: [Versions 401 and 402] [Versions 401 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 viewing the list of course resources.
  19   *
  20   * @package    core
  21   * @copyright  2014 Marina Glancy
  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   * Event for viewing the list of course resources.
  30   *
  31   * @package    core
  32   * @since      Moodle 2.7
  33   * @copyright  2014 Marina Glancy
  34   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  class course_resources_list_viewed extends base {
  37  
  38      /** @var array list of resource types for legacy logging */
  39      private $resourceslist = null;
  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_OTHER;
  49      }
  50  
  51      /**
  52       * Returns description of what happened.
  53       *
  54       * @return string
  55       */
  56      public function get_description() {
  57          return "The user with id '$this->userid' viewed the list of resources in the course with id '$this->courseid'.";
  58      }
  59  
  60      /**
  61       * Return localised event name.
  62       *
  63       * @return string
  64       */
  65      public static function get_name() {
  66          return get_string('eventcoursemoduleinstancelistviewed', 'core');
  67      }
  68  
  69      /**
  70       * Get URL related to the action.
  71       *
  72       * @return \moodle_url
  73       */
  74      public function get_url() {
  75          return new \moodle_url("/course/resources.php", array('id' => $this->courseid));
  76      }
  77  
  78      /**
  79       * List of resource types enabled in the system. This is used for legacy logging to log one record for each resource type.
  80       *
  81       * There is no public getter for this data because it does not depend on the
  82       * course. It always includes the list of all resource types in the system
  83       * even when some of them are not present in the course.
  84       *
  85       * @param array $data
  86       */
  87      public function set_legacy_logdata($data) {
  88          $this->resourceslist = $data;
  89      }
  90  
  91      /**
  92       * Return the legacy event log data.
  93       *
  94       * @return array|null
  95       */
  96      protected function get_legacy_logdata() {
  97          if (empty($this->resourceslist)) {
  98              return null;
  99          }
 100          $logs = array();
 101          foreach ($this->resourceslist as $resourcename) {
 102              $logs[] = array($this->courseid, $resourcename, 'view all', 'index.php?id=' . $this->courseid, '');
 103          }
 104          return $logs;
 105      }
 106  
 107      /**
 108       * Custom validation.
 109       *
 110       * @throws \coding_exception
 111       * @return void
 112       */
 113      protected function validate_data() {
 114          if ($this->contextlevel != CONTEXT_COURSE) {
 115              throw new \coding_exception('Context passed must be course context.');
 116          }
 117      }
 118  }