[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   * The tool_usertours tour_started event.
  19   *
  20   * @package    tool_usertours
  21   * @copyright  2016 Andrew Nicols <andrew@nicols.co.uk>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace tool_usertours\event;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * The tool_usertours tour_started event.
  31   *
  32   * @package    tool_usertours
  33   * @copyright  2016 Andrew Nicols <andrew@nicols.co.uk>
  34   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   *
  36   * @property-read array $other {
  37   *      Extra information about the event.
  38   *
  39   *      - int       tourid:     The id of the tour
  40   *      - string    pageurl:    The URL of the page viewing the tour
  41   * }
  42   */
  43  class tour_started extends \core\event\base {
  44  
  45      /**
  46       * Init method.
  47       */
  48      protected function init() {
  49          $this->data['crud'] = 'r';
  50          $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
  51          $this->data['objecttable'] = 'tool_usertours_tours';
  52      }
  53  
  54      /**
  55       * Returns localised general event name.
  56       *
  57       * @return string
  58       */
  59      public static function get_name() {
  60          return get_string('event_tour_started', 'tool_usertours');
  61      }
  62  
  63      /**
  64       * Custom validation.
  65       *
  66       * @throws \coding_exception
  67       * @return void
  68       */
  69      protected function validate_data() {
  70          parent::validate_data();
  71  
  72          if (!isset($this->other['pageurl'])) {
  73              throw new \coding_exception('The \'pageurl\' value must be set in other.');
  74          }
  75      }
  76  
  77      /**
  78       * This is used when restoring course logs where it is required that we
  79       * map the information in 'other' to it's new value in the new course.
  80       *
  81       * Does nothing in the base class except display a debugging message warning
  82       * the user that the event does not contain the required functionality to
  83       * map this information. For events that do not store any other information this
  84       * won't be called, so no debugging message will be displayed.
  85       *
  86       * @return array an array of other values and their corresponding mapping
  87       */
  88      public static function get_other_mapping() {
  89          return [
  90              'pageurl'   => \core\event\base::NOT_MAPPED,
  91          ];
  92      }
  93  
  94      /**
  95       * This is used when restoring course logs where it is required that we
  96       * map the objectid to it's new value in the new course.
  97       *
  98       * Does nothing in the base class except display a debugging message warning
  99       * the user that the event does not contain the required functionality to
 100       * map this information. For events that do not store an objectid this won't
 101       * be called, so no debugging message will be displayed.
 102       *
 103       * @return string the name of the restore mapping the objectid links to
 104       */
 105      public static function get_objectid_mapping() {
 106          return [
 107              'db'        => 'tool_usertours_tours',
 108              'restore'   => \core\event\base::NOT_MAPPED,
 109          ];
 110      }
 111  
 112      /**
 113       * Returns non-localised event description with id's for admin use only.
 114       *
 115       * @return string
 116       */
 117      public function get_description() {
 118          return "The user with id '{$this->userid}' " .
 119              "has started the tour with id '{$this->objectid}' " .
 120              "on the page with URL '{$this->other['pageurl']}'.";
 121      }
 122  
 123      /**
 124       * Returns relevant URL.
 125       *
 126       * @return \moodle_url
 127       */
 128      public function get_url() {
 129          return \tool_usertours\helper::get_view_tour_link($this->objectid);
 130      }
 131  }