Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.

Differences Between: [Versions 310 and 311] [Versions 310 and 400] [Versions 310 and 401] [Versions 310 and 402] [Versions 310 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 activity send an xAPI tracking statement.
  19   *
  20   * @package     mod_h5pactivity
  21   * @copyright   2020 Ferran Recio <ferran@moodle.com>
  22   * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace mod_h5pactivity\event;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * The statement_received event class.
  31   *
  32   * @package    mod_h5pactivity
  33   * @copyright  2020 Ferran Recio <ferran@moodle.com>
  34   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  class statement_received extends \core\event\base {
  37  
  38      /**
  39       * Init method.
  40       *
  41       * @return void
  42       */
  43      protected function init(): void {
  44          $this->data['objecttable'] = 'h5pactivity';
  45          $this->data['crud'] = 'u';
  46          $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
  47      }
  48  
  49      /**
  50       * Returns localised general event name.
  51       *
  52       * @return string
  53       */
  54      public static function get_name() {
  55          return get_string('statement_received', 'mod_h5pactivity');
  56      }
  57  
  58      /**
  59       * Replace add_to_log() statement.
  60       *
  61       * @return array of parameters to be passed to legacy add_to_log() function.
  62       */
  63      protected function get_legacy_logdata() {
  64          return [$this->courseid, 'h5pactivity', 'statement received', 'grade.php?user=' . $this->userid,
  65              0, $this->contextinstanceid];
  66      }
  67  
  68      /**
  69       * Returns non-localised description of what happened.
  70       *
  71       * @return string
  72       */
  73      public function get_description() {
  74          return "The user with the id '$this->userid' send a tracking statement " .
  75                  "for a H5P activity with the course module id '$this->contextinstanceid'.";
  76      }
  77  
  78      /**
  79       * Get URL related to the action
  80       *
  81       * @return \moodle_url
  82       */
  83      public function get_url() {
  84          return new \moodle_url('/mod/h5pactivity/grade.php',
  85                  ['id' => $this->contextinstanceid, 'user' => $this->userid]);
  86      }
  87  
  88      /**
  89       * This is used when restoring course logs where it is required that we
  90       * map the objectid to it's new value in the new course.
  91       *
  92       * @return array
  93       */
  94      public static function get_objectid_mapping() {
  95          return ['db' => 'h5pactivity', 'restore' => 'h5pactivity'];
  96      }
  97  }