search results viewed (#36)

src/transformer/events/core/search_results_viewed.php

@@ -0,0 +1,75 @@
+<?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/>.
+
+/**
+ * Transformer fn for search results viewed event.
+ *
+ * @package   logstore_xapi
+ * @copyright Milt Reder <[email protected]>
+ *
+ * @license   https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace src\transformer\events\core;
+
+use src\transformer\utils as utils;
+
+/**
+ * Transformer fn for search results viewed event.
+ *
+ * @param array $config The transformer config settings.
+ * @param \stdClass $event The event to be transformed.
+ * @return array
+ */
+
+function search_results_viewed(array $config, \stdClass $event) {
+    $repo = $config['repo'];
+    $user = $repo->read_record_by_id('user', $event->userid);
+    $lang = $config['source_lang'];
+    $info = unserialize($event->other);
+
+    return [[
+        'actor' => utils\get_user($config, $user),
+        'verb' => [
+            'id' => 'https://w3id.org/xapi/acrossx/verbs/searched',
+            'display' => [
+                $lang => 'Searched'
+            ],
+        ],
+        'object' => [
+            'id' => $config['app_url'] . '/search/index.php',
+            'objectType' => 'Activity',
+            'definition' => [
+                'type' => 'https://w3id.org/xapi/acrossx/activities/webpage',
+                'name' => [
+                    $lang => 'Global Search'
+                ],
+            ],
+        ],
+        'result' => [
+            'response' => $info['q'],
+        ],
+        'context' => [
+            'extensions' => utils\extensions\base($config, $event, null),
+            'contextActivities' => [
+                'category' => [
+                    utils\get_activity\site($config),
+                ],
+            ],
+        ],
+    ]];
+
+}

src/transformer/get_event_function_map.php

@@ -59,6 +59,7 @@ function get_event_function_map() {
         '\core\event\user_loggedout' => 'core\user_loggedout',
         '\core\event\course_module_created' => 'core\course_module_created',
         '\core\event\course_module_completion_updated' => 'core\course_module_completion_updated',
+        '\core\event\search_results_viewed' => 'core\search_results_viewed',
         '\core\event\question_created' => 'core\question_created',
         '\mod_assign\event\assessable_submitted' => 'mod_assign\assignment_submitted',
         '\mod_assign\event\submission_graded' => 'mod_assign\assignment_graded',

tests/core/search_results_viewed/user_viewed_search_results/data.json

@@ -0,0 +1 @@
+{}

tests/core/search_results_viewed/user_viewed_search_results/event.json

@@ -0,0 +1,10 @@
+{
+  "courseid": null,
+  "eventname": "\\core\\event\\search_results_viewed",
+  "id": 1,
+  "objectid": null,
+  "objecttable": null,
+  "timecreated": 1433946701,
+  "userid": 1,
+  "other": "a:7:{s:1:\"q\";s:5:\"query\";s:4:\"page\";i:0;s:5:\"title\";s:0:\"\";s:7:\"areaids\";a:0:{}s:9:\"courseids\";a:0:{}s:9:\"timestart\";i:0;s:7:\"timeend\";i:0;}"
+}

tests/core/search_results_viewed/user_viewed_search_results/statements.json

@@ -0,0 +1,53 @@
+[
+  {
+    "actor": {
+      "account": {
+        "homePage": "http://www.example.org",
+        "name": "1"
+      },
+      "name": "test_fullname"
+    },
+    "verb": {
+      "id": "https://w3id.org/xapi/acrossx/verbs/searched",
+      "display": {
+        "en": "Searched"
+      }
+    },
+    "object": {
+      "id": "http://www.example.org/search/index.php",
+      "objectType": "Activity",
+      "definition": {
+        "type": "https://w3id.org/xapi/acrossx/activities/webpage",
+        "name": {
+          "en": "Global Search"
+        }
+      }
+    },
+    "result": {
+      "response": "query"
+    },
+    "context": {
+      "contextActivities": {
+        "category": [
+          {
+            "id": "http://www.example.org",
+            "definition": {
+              "type": "http://id.tincanapi.com/activitytype/lms",
+              "name": {
+                "en": "test_name"
+              }
+            }
+          }
+        ]
+      },
+      "extensions": {
+        "http://lrs.learninglocker.net/define/extensions/info": {
+          "event_function": "\\src\\transformer\\events\\core\\search_results_viewed",
+          "event_name": "\\core\\event\\search_results_viewed",
+          "http://moodle.org": "1.0.0",
+          "https://github.com/xAPI-vle/moodle-logstore_xapi": "0.0.0-development"
+        }
+      }
+    }
+  }
+]

tests/core/search_results_viewed/user_viewed_search_results/user_viewed_search_results_test.php

@@ -0,0 +1,70 @@
+<?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/>.
+
+namespace logstore_xapi\core\search_results_viewed\user_viewed_search_results;
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+
+require_once($CFG->dirroot . '/admin/tool/log/store/xapi/tests/xapi_test_case.php');
+
+/**
+ * Unit test for search_results_viewed event
+ *
+ * @package   logstore_xapi
+ * @copyright Milt Reder <[email protected]>
+ * @license   https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class user_viewed_search_results_test extends \logstore_xapi\xapi_test_case {
+
+    /**
+     * Retrieve the directory of the unit test.
+     *
+     * @return string
+     */
+    protected function get_test_dir() {
+        return __DIR__;
+    }
+
+    /**
+     * Retrieve the plugin type being tested.
+     *
+     * @return string
+     */
+    protected function get_plugin_type() {
+        return "core";
+    }
+
+    /**
+     * Retrieve the plugin name being tested.
+     *
+     * @return string
+     */
+    protected function get_plugin_name() {
+        return "core";
+    }
+
+    /**
+     * Appease auto-detecting of test cases. xapi_test_case has default test cases.
+     *
+     * @covers ::attempt_submitted
+     * @return void
+     */
+    public function test_init() {
+
+    }
+}