MDL-68076 core: log user's click on feedback links
authorShamim Rezaie <shamim@moodle.com>
Tue, 19 May 2020 01:14:20 +0000 (11:14 +1000)
committerShamim Rezaie <shamim@moodle.com>
Thu, 4 Jun 2020 01:57:26 +0000 (11:57 +1000)
lang/en/moodle.php
lib/amd/build/userfeedback.min.js
lib/amd/build/userfeedback.min.js.map
lib/amd/src/userfeedback.js
lib/classes/event/userfeedback_give.php [new file with mode: 0644]
lib/classes/event/userfeedback_remind.php [new file with mode: 0644]
lib/classes/external/userfeedback/record_action.php
lib/tests/external/userfeedback/record_action_test.php
version.php

index 497fdb0..a5754a7 100644 (file)
@@ -805,6 +805,8 @@ $string['eventsearchresultsviewed'] = 'Search results viewed';
 $string['eventunknownlogged'] = 'Unknown event';
 $string['eventusercreated'] = 'User created';
 $string['eventuserdeleted'] = 'User deleted';
+$string['eventuserfeedbackgiven'] = 'Feedback link clicked';
+$string['eventuserfeedbackremind'] = 'Remind me later feedback link clicked';
 $string['eventuserlistviewed'] = 'User list viewed';
 $string['eventuserloggedout'] = 'User logged out';
 $string['eventuserpasswordpolicyfailed'] = 'User password failed password policy';
index 5eb8d7c..3eee54b 100644 (file)
Binary files a/lib/amd/build/userfeedback.min.js and b/lib/amd/build/userfeedback.min.js differ
index 5f74d58..2a4225f 100644 (file)
Binary files a/lib/amd/build/userfeedback.min.js.map and b/lib/amd/build/userfeedback.min.js.map differ
index a74bf4e..c1b1a7f 100644 (file)
@@ -92,6 +92,7 @@ const recordAction = clickedItem => {
             methodname: 'core_create_userfeedback_action_record',
             args: {
                 action: clickedItem.dataset.action,
+                contextid: M.cfg.contextid,
             }
         }])[0];
     }
diff --git a/lib/classes/event/userfeedback_give.php b/lib/classes/event/userfeedback_give.php
new file mode 100644 (file)
index 0000000..e0b89df
--- /dev/null
@@ -0,0 +1,63 @@
+<?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/>.
+
+/**
+ * Feedback given.
+ *
+ * @package    core
+ * @copyright  2020 Shamim Rezaie <shamim@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace core\event;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Class userfeedback_give
+ *
+ * @package    core
+ * @copyright  2020 Shamim Rezaie <shamim@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class userfeedback_give extends base {
+
+    /**
+     * Initialise required event data properties.
+     */
+    protected function init() {
+        $this->data['crud'] = 'r';
+        $this->data['edulevel'] = self::LEVEL_OTHER;
+    }
+
+    /**
+     * Returns description of what happened.
+     *
+     * @return string
+     */
+    public function get_description() {
+        return "The user with id '$this->userid' clicked on the give feedback link";
+    }
+
+    /**
+     * Return localised event name.
+     *
+     * @return string
+     */
+    public static function get_name() {
+        return get_string('eventuserfeedbackgiven');
+    }
+
+}
diff --git a/lib/classes/event/userfeedback_remind.php b/lib/classes/event/userfeedback_remind.php
new file mode 100644 (file)
index 0000000..e30205c
--- /dev/null
@@ -0,0 +1,63 @@
+<?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/>.
+
+/**
+ * Feedback remind.
+ *
+ * @package    core
+ * @copyright  2020 Shamim Rezaie <shamim@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace core\event;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Class userfeedback_remind
+ *
+ * @package    core
+ * @copyright  2020 Shamim Rezaie <shamim@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class userfeedback_remind extends base {
+
+    /**
+     * Initialise required event data properties.
+     */
+    protected function init() {
+        $this->data['crud'] = 'r';
+        $this->data['edulevel'] = self::LEVEL_OTHER;
+    }
+
+    /**
+     * Returns description of what happened.
+     *
+     * @return string
+     */
+    public function get_description() {
+        return "The user with id '$this->userid' clicked on the remind later to feedback link";
+    }
+
+    /**
+     * Return localised event name.
+     *
+     * @return string
+     */
+    public static function get_name() {
+        return get_string('eventuserfeedbackremind');
+    }
+
+}
index 26f79fe..e8950f5 100644 (file)
@@ -47,6 +47,7 @@ class record_action extends external_api {
     public static function execute_parameters() {
         return new external_function_parameters([
             'action' => new external_value(PARAM_ALPHA, 'The action taken by user'),
+            'contextid' => new external_value(PARAM_INT, 'The context id of the page the user is in'),
         ]);
     }
 
@@ -54,17 +55,28 @@ class record_action extends external_api {
      * Record users action to the feedback CTA
      *
      * @param string $action The action the user took
+     * @param int $contextid The context id
      * @throws \invalid_parameter_exception
      */
-    public static function execute(string $action) {
-        external_api::validate_parameters(self::execute_parameters(), ['action' => $action]);
+    public static function execute(string $action, int $contextid) {
+        external_api::validate_parameters(self::execute_parameters(), [
+            'action' => $action,
+            'contextid' => $contextid,
+        ]);
+
+        $context = \context::instance_by_id($contextid);
+        self::validate_context($context);
 
         switch ($action) {
             case 'give':
                 set_user_preference('core_userfeedback_give', time());
+                $event = \core\event\userfeedback_give::create(['context' => $context]);
+                $event->trigger();
                 break;
             case 'remind':
                 set_user_preference('core_userfeedback_remind', time());
+                $event = \core\event\userfeedback_remind::create(['context' => $context]);
+                $event->trigger();
                 break;
             default:
                 throw new \invalid_parameter_exception('Invalid value for action parameter (value: ' . $action . '),' .
index 610acad..f67cf57 100644 (file)
@@ -69,6 +69,7 @@ class record_action_testcase extends externallib_advanced_testcase {
         $context = context_system::instance();
         $user = $this->getDataGenerator()->create_user();
         $this->setUser($user);
+        $eventsink = $this->redirectEvents();
 
         $now = time();
 
@@ -78,5 +79,10 @@ class record_action_testcase extends externallib_advanced_testcase {
 
         $preference = get_user_preferences('core_userfeedback_' . $action);
         $this->assertGreaterThanOrEqual($now, $preference);
+
+        $events = $eventsink->get_events();
+        $this->assertCount(1, $events);
+        $this->assertInstanceOf('\core\event\userfeedback_' . $action, $events[0]);
+        $eventsink->clear();
     }
 }
index 9dec882..e89cfb9 100644 (file)
@@ -29,7 +29,7 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-$version  = 2020052900.02;              // YYYYMMDD      = weekly release date of this DEV branch.
+$version  = 2020052900.03;              // YYYYMMDD      = weekly release date of this DEV branch.
                                         //         RR    = release increments - 00 in DEV branches.
                                         //           .XX = incremental changes.
 $release  = '3.9dev+ (Build: 20200529)'; // Human-friendly version name