MDL-66404 core_h5p: Add new h5p_viewed event
authorcescobedo <carlos.escobedo@gmail.com>
Tue, 5 Nov 2019 19:47:06 +0000 (20:47 +0100)
committercescobedo <carlos.escobedo@gmail.com>
Thu, 7 Nov 2019 09:43:13 +0000 (10:43 +0100)
h5p/classes/event/h5p_viewed.php [new file with mode: 0644]
h5p/classes/player.php
h5p/tests/event_h5p_viewed.php [new file with mode: 0644]
lang/en/h5p.php

diff --git a/h5p/classes/event/h5p_viewed.php b/h5p/classes/event/h5p_viewed.php
new file mode 100644 (file)
index 0000000..ef7015c
--- /dev/null
@@ -0,0 +1,97 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * H5P viewed event class.
+ *
+ * @package    core
+ * @since      Moodle 3.8
+ * @copyright  2019 Carlos Escobedo <carlos@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace core_h5p\event;
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * H5P viewed event class.
+ *
+ * @package    core_h5p
+ * @since      Moodle 3.8
+ * @copyright  2019 Carlos Escobedo <carlos@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class h5p_viewed extends \core\event\base {
+
+    /**
+     * Initialise event parameters.
+     */
+    protected function init() {
+        $this->data['objecttable'] = 'h5p';
+        $this->data['crud'] = 'r';
+        $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
+    }
+
+    /**
+     * Returns localised event name.
+     *
+     * @return string
+     */
+    public static function get_name() {
+        return get_string('eventh5pviewed', 'h5p');
+    }
+
+    /**
+     * Returns non-localised event description with id's for admin use only.
+     *
+     * @return string
+     */
+    public function get_description() {
+        return "The user with id '$this->userid' has viewed the H5P with the id '$this->objectid'.";
+    }
+
+    /**
+     * Custom validations.
+     *
+     * @throws \coding_exception
+     * @return void
+     */
+    protected function validate_data() {
+        parent::validate_data();
+        if (!isset($this->objectid)) {
+            throw new \coding_exception('The \'objectid\' must be set.');
+        }
+    }
+
+    /**
+     * Returns relevant URL.
+     *
+     * @return \moodle_url
+     */
+    public function get_url() {
+        // There is no url since the previous event already has the url where the h5p content has been displayed.
+        return null;
+    }
+
+    /**
+     * Return the legacy event name.
+     *
+     * @return string
+     */
+    public static function get_legacy_eventname() {
+        return 'core_h5p_viewed';
+    }
+}
\ No newline at end of file
index 5605a97..8413cf8 100644 (file)
@@ -174,15 +174,28 @@ class player {
      * @return string The HTML code to display this H5P content.
      */
     public function output() : string {
-        global $OUTPUT;
+        global $OUTPUT, $USER;
 
         $template = new \stdClass();
         $template->h5pid = $this->h5pid;
         if ($this->embedtype === 'div') {
-            return $OUTPUT->render_from_template('core_h5p/h5pdiv', $template);
+            $h5phtml = $OUTPUT->render_from_template('core_h5p/h5pdiv', $template);
         } else {
-            return $OUTPUT->render_from_template('core_h5p/h5piframe', $template);
+            $h5phtml = $OUTPUT->render_from_template('core_h5p/h5piframe', $template);
         }
+
+        // Trigger capability_assigned event.
+        \core_h5p\event\h5p_viewed::create([
+            'objectid' => $this->h5pid,
+            'userid' => $USER->id,
+            'context' => $this->context,
+            'other' => [
+                'url' => $this->url->out(),
+                'time' => time()
+            ]
+        ])->trigger();
+
+        return $h5phtml;
     }
 
     /**
diff --git a/h5p/tests/event_h5p_viewed.php b/h5p/tests/event_h5p_viewed.php
new file mode 100644 (file)
index 0000000..451ba4e
--- /dev/null
@@ -0,0 +1,98 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Tests for h5p viewed event.
+ *
+ * @package    core_h5p
+ * @category   test
+ * @copyright  2019 Carlos Escobedo <carlos@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since      Moodle 3.8
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+use core_h5p\autoloader;
+
+/**
+ * Tests for h5p viewed event.
+ *
+ * @package    core_h5p
+ * @category   test
+ * @copyright  2019 Carlos Escobedo <carlos@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since      Moodle 3.8
+ */
+class core_h5p_event_h5p_viewed_testcase extends advanced_testcase {
+
+    /**
+     * Setup test.
+     */
+    protected function setUp() {
+        parent::setUp();
+        autoloader::register();
+    }
+
+    /**
+     * test_event_h5p_viewed description
+     * @runInSeparateProcess
+     */
+    public function test_event_h5p_viewed() {
+        $this->resetAfterTest(true);
+
+        $user = $this->getDataGenerator()->create_user();
+        $course = $this->getDataGenerator()->create_course();
+        $page = $this->getDataGenerator()->create_module('page', array('course' => $course->id));
+        $pagecontext = \context_module::instance($page->cmid);
+        // Url dummy just for testing proposal.
+        $url  = \moodle_url::make_pluginfile_url(
+            $pagecontext->id,
+            \core_h5p\file_storage::COMPONENT,
+            'unittest',
+            0,
+            '/',
+            'h5pfiletest.h5p'
+        );
+        // Dummy H5P id for testing proposal. We don't need a real h5p.
+        $dummyh5pid = 111;
+        $now = time();
+        // Event parameters for testing.
+        $params = [
+            'objectid' => $dummyh5pid,
+            'userid' => $user->id,
+            'context' => $pagecontext,
+            'other' => [
+                'url' => $url->out(),
+                'time' => $now
+            ]
+        ];
+        // Prepare redirect Events.
+        $sink = $this->redirectEvents();
+        // Test the event H5P viewed.
+        $event = \core_h5p\event\h5p_viewed::create($params);
+        $event->trigger();
+        $result = $sink->get_events();
+        $event = reset($result);
+        $sink->close();
+        // Check the event info.
+        $this->assertEquals($dummyh5pid, $event->objectid);
+        $this->assertEquals($user->id, $event->userid);
+        $this->assertEquals($pagecontext->id, $event->contextid);
+        $this->assertEquals($url->out(), $event->other['url']);
+        $this->assertEquals($now, $event->other['time']);
+    }
+}
index a65724f..2fcf32f 100644 (file)
@@ -71,6 +71,7 @@ $string['downloadtitle'] = 'Download this content as a H5P file.';
 $string['editor'] = 'Editor';
 $string['embed'] = 'Embed';
 $string['embedtitle'] = 'View the embed code for this content.';
+$string['eventh5pviewed'] = 'H5P viewed';
 $string['fileExceedsMaxSize'] = 'One of the files inside the package exceeds the maximum file size allowed. ({$a->%file} {$a->%used} > {$a->%max})';
 $string['fullscreen'] = 'Fullscreen';
 $string['gpl'] = 'General Public License v3';
@@ -135,6 +136,7 @@ $string['originator'] = 'Originator';
 $string['pd'] = 'Public Domain';
 $string['pddl'] = 'Public Domain Dedication and Licence';
 $string['pdm'] = 'Public Domain Mark (PDM)';
+$string['pluginname'] = 'H5P Package';
 $string['privacy:metadata'] = 'H5P subsystem does not store any personal data.';
 $string['resizescript'] = 'Include this script on your website if you want dynamic sizing of the embedded content:';
 $string['resubmitScores'] = 'Attempting to submit stored results.';