[Summary view]

Differences Between: [Versions 311 and 402] [Versions 311 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   * The mod_choice report viewed event.
  19   *
  20   * @package mod_choice
  21   * @copyright 2013 Adrian Greeve <adrian@moodle.com>
  22   * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace mod_choice\event;
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  /**
  29   * The mod_choice report viewed event class.
  30   *
  31   * @property-read array $other {
  32   *      Extra information about the event.
  33   *
  34   *      - string content: (optional) The content we are viewing.
  35   * }
  36   *
  37   * @package    mod_choice
  38   * @since      Moodle 2.6
  39   * @copyright  2013 Adrian Greeve
  40   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  41   */
  42  class report_viewed extends \core\event\base {
  43  
  44      /**
  45       * Init method.
  46       */
  47      protected function init() {
  48          $this->data['crud'] = 'r';
  49          $this->data['edulevel'] = self::LEVEL_TEACHING;
  50          $this->data['objecttable'] = 'choice';
  51      }
  52  
  53      /**
  54       * Returns localised general event name.
  55       *
  56       * @return string
  57       */
  58      public static function get_name() {
  59          return get_string('eventreportviewed', 'mod_choice');
  60      }
  61  
  62      /**
  63       * Returns description of what happened.
  64       *
  65       * @return string
  66       */
  67      public function get_description() {
  68          return "The user with id '$this->userid' has viewed the report for the choice activity with course module id
  69              '$this->contextinstanceid'";
  70      }
  71  
  72      /**
  73       * Returns relevant URL.
  74       * @return \moodle_url
  75       */
  76      public function get_url() {
  77          return new \moodle_url('/mod/choice/report.php', array('id' => $this->contextinstanceid));
  78      }
  79  
  80      /**
  81       * replace add_to_log() statement.
  82       *
  83       * @return array of parameters to be passed to legacy add_to_log() function.
  84       */
  85      protected function get_legacy_logdata() {
  86          $url = new \moodle_url('report.php', array('id' => $this->contextinstanceid));
  87          return array($this->courseid, 'choice', 'report', $url->out(), $this->objectid, $this->contextinstanceid);
  88      }
  89  
  90      public static function get_objectid_mapping() {
  91          return array('db' => 'choice', 'restore' => 'choice');
  92      }
  93  
  94      public static function get_other_mapping() {
  95          // No need to map the 'content' value.
  96          return false;
  97      }
  98  }