[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   * H5P viewed event class.
  19   *
  20   * @package    core
  21   * @since      Moodle 3.8
  22   * @copyright  2019 Carlos Escobedo <carlos@moodle.com>
  23   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  
  26  namespace core_h5p\event;
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * H5P viewed event class.
  31   *
  32   * @package    core_h5p
  33   * @since      Moodle 3.8
  34   * @copyright  2019 Carlos Escobedo <carlos@moodle.com>
  35   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36   */
  37  class h5p_viewed extends \core\event\base {
  38  
  39      /**
  40       * Initialise event parameters.
  41       */
  42      protected function init() {
  43          $this->data['objecttable'] = 'h5p';
  44          $this->data['crud'] = 'r';
  45          $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
  46      }
  47  
  48      /**
  49       * Returns localised event name.
  50       *
  51       * @return string
  52       */
  53      public static function get_name() {
  54          return get_string('eventh5pviewed', 'h5p');
  55      }
  56  
  57      /**
  58       * Returns non-localised event description with id's for admin use only.
  59       *
  60       * @return string
  61       */
  62      public function get_description() {
  63          return "The user with id '$this->userid' has viewed the H5P with the id '$this->objectid'.";
  64      }
  65  
  66      /**
  67       * Custom validations.
  68       *
  69       * @throws \coding_exception
  70       * @return void
  71       */
  72      protected function validate_data() {
  73          parent::validate_data();
  74          if (!isset($this->objectid)) {
  75              throw new \coding_exception('The \'objectid\' must be set.');
  76          }
  77      }
  78  
  79      /**
  80       * Returns relevant URL.
  81       *
  82       * @return \moodle_url
  83       */
  84      public function get_url() {
  85          // There is no url since the previous event already has the url where the h5p content has been displayed.
  86          return null;
  87      }
  88  
  89      /**
  90       * Return the legacy event name.
  91       *
  92       * @return string
  93       */
  94      public static function get_legacy_eventname() {
  95          return 'core_h5p_viewed';
  96      }
  97  }