Mod Wiki

src/transformer/events/mod_wiki/comment_created.php

@@ -0,0 +1,82 @@
+<?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 wiki discussion comment created 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\mod_wiki;
+
+use src\transformer\utils as utils;
+
+/**
+ * Transformer fn for wiki discussion comment created event.
+ *
+ * @param array $config The transformer config settings.
+ * @param \stdClass $event The event to be transformed.
+ * @return array
+ */
+
+function comment_created(array $config, \stdClass $event) {
+    $repo = $config['repo'];
+    $user = $repo->read_record_by_id('user', $event->userid);
+    $course = $repo->read_record_by_id('course', $event->courseid);
+    $comment = $repo->read_record_by_id('comments', $event->objectid);
+    $wikipage = $repo->read_record_by_id('wiki_pages', $comment->itemid);
+    $lang = utils\get_course_lang($course);
+
+    return[[
+        'actor' => utils\get_user($config, $user),
+        'verb' => [
+            'id' => 'http://adlnet.gov/expapi/verbs/commented',
+            'display' => [
+                'en' => 'Commented'
+            ],
+        ],
+        'object' => utils\get_activity\wiki_discussion(
+            $config, $course, $wikipage
+        ),
+        'result' => [
+            'response' => utils\get_string_html_removed($comment->content),
+        ],
+        'context' => [
+            'language' => $lang,
+            'extensions' => utils\extensions\base($config, $event, $course),
+            'contextActivities' => [
+                'parent' => [
+                    utils\get_activity\wiki_page(
+                        $config,
+                        $course,
+                        $wikipage
+                    ),
+                    ...utils\context_activities\get_parent(
+                        $config,
+                        $event->contextinstanceid,
+                        true
+                    ),
+                ],
+                'category' => [
+                    utils\get_activity\site($config),
+                ],
+            ],
+        ]
+    ]];
+}

src/transformer/events/mod_wiki/comment_deleted.php

@@ -0,0 +1,95 @@
+<?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 wiki discussion comment deleted 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\mod_wiki;
+
+use src\transformer\utils as utils;
+
+/**
+ * Transformer fn for wiki discussion comment deleted event.
+ *
+ * @param array $config The transformer config settings.
+ * @param \stdClass $event The event to be transformed.
+ * @return array
+ */
+
+function comment_deleted(array $config, \stdClass $event) {
+    $repo = $config['repo'];
+    $user = $repo->read_record_by_id('user', $event->userid);
+    $course = $repo->read_record_by_id('course', $event->courseid);
+    $wikipage = $repo->read_record_by_id(
+        'wiki_pages',
+        (int) unserialize($event->other)['itemid']
+    );
+    $lang = utils\get_course_lang($course);
+
+    return[[
+        'actor' => utils\get_user($config, $user),
+        'verb' => [
+            'id' => 'http://activitystrea.ms/delete',
+            'display' => [
+                'en' => 'Deleted'
+            ],
+        ],
+        'object' => [
+            'id' => $config['app_url']
+                . '/mod/wiki/instancecomments.php?commentid=' . $event->objectid
+                . '&pageid=' . $wikipage->id,
+            'objectType' => 'Activity',
+            'definition' => [
+                'type' => 'http://activitystrea.ms/comment',
+                'name' => [
+                    'en' => 'Comment',
+                ],
+            ],
+        ],
+        'context' => [
+            'language' => $lang,
+            'extensions' => utils\extensions\base($config, $event, $course),
+            'contextActivities' => [
+                'parent' => [
+                    utils\get_activity\wiki_discussion(
+                        $config,
+                        $course,
+                        $wikipage
+                    ),
+                    utils\get_activity\wiki_page(
+                        $config,
+                        $course,
+                        $wikipage
+                    ),
+                    ...utils\context_activities\get_parent(
+                        $config,
+                        $event->contextinstanceid,
+                        true
+                    ),
+                ],
+                'category' => [
+                    utils\get_activity\site($config),
+                ],
+            ],
+        ]
+    ]];
+}

src/transformer/events/mod_wiki/comments_viewed.php

@@ -0,0 +1,78 @@
+<?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 wiki discussion comments 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\mod_wiki;
+
+use src\transformer\utils as utils;
+
+/**
+ * Transformer fn for wiki discussion comments viewed event.
+ *
+ * @param array $config The transformer config settings.
+ * @param \stdClass $event The event to be transformed.
+ * @return array
+ */
+
+function comments_viewed(array $config, \stdClass $event) {
+    $repo = $config['repo'];
+    $user = $repo->read_record_by_id('user', $event->userid);
+    $course = $repo->read_record_by_id('course', $event->courseid);
+    $wikipage = $repo->read_record_by_id('wiki_pages', $event->objectid);
+    $lang = utils\get_course_lang($course);
+
+    return[[
+        'actor' => utils\get_user($config, $user),
+        'verb' => [
+            'id' => 'http://id.tincanapi.com/verb/viewed',
+            'display' => [
+                'en' => 'Viewed'
+            ],
+        ],
+        'object' => utils\get_activity\wiki_discussion(
+            $config, $course, $wikipage
+        ),
+        'context' => [
+            'language' => $lang,
+            'extensions' => utils\extensions\base($config, $event, $course),
+            'contextActivities' => [
+                'parent' => [
+                    utils\get_activity\wiki_page(
+                        $config,
+                        $course,
+                        $wikipage
+                    ),
+                    ...utils\context_activities\get_parent(
+                        $config,
+                        $event->contextinstanceid,
+                        true
+                    ),
+                ],
+                'category' => [
+                    utils\get_activity\site($config),
+                ],
+            ],
+        ]
+    ]];
+}

src/transformer/events/mod_wiki/page_viewed.php

@@ -0,0 +1,73 @@
+<?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 wiki page 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\mod_wiki;
+
+use src\transformer\utils as utils;
+
+/**
+ * Transformer fn for wiki page viewed event.
+ *
+ * @param array $config The transformer config settings.
+ * @param \stdClass $event The event to be transformed.
+ * @return array
+ */
+
+function page_viewed(array $config, \stdClass $event) {
+    $repo = $config['repo'];
+    $user = $repo->read_record_by_id('user', $event->userid);
+    $course = $repo->read_record_by_id('course', $event->courseid);
+    $wikipage = $repo->read_record_by_id('wiki_pages', $event->objectid);
+    $lang = utils\get_course_lang($course);
+
+    return[[
+        'actor' => utils\get_user($config, $user),
+        'verb' => [
+            'id' => 'http://id.tincanapi.com/verb/viewed',
+            'display' => [
+                'en' => 'Viewed'
+            ],
+        ],
+        'object' => utils\get_activity\wiki_page(
+            $config,
+            $course,
+            $wikipage
+        ),
+        'context' => [
+            'language' => $lang,
+            'extensions' => utils\extensions\base($config, $event, $course),
+            'contextActivities' => [
+                'parent' => utils\context_activities\get_parent(
+                    $config,
+                    $event->contextinstanceid,
+                    true
+                ),
+                'category' => [
+                    utils\get_activity\site($config),
+                ],
+            ],
+        ]
+    ]];
+}

src/transformer/get_event_function_map.php

@@ -137,6 +137,10 @@ function get_event_function_map() {
         '\mod_survey\event\course_module_viewed' => 'all\course_module_viewed',
         '\mod_url\event\course_module_viewed' => 'all\course_module_viewed',
         '\mod_wiki\event\course_module_viewed' => 'all\course_module_viewed',
+        '\mod_wiki\event\comment_created' => 'mod_wiki\comment_created',
+        '\mod_wiki\event\comment_deleted' => 'mod_wiki\comment_deleted',
+        '\mod_wiki\event\comments_viewed' => 'mod_wiki\comments_viewed',
+        '\mod_wiki\event\page_viewed' => 'mod_wiki\page_viewed',
         '\mod_workshop\event\course_module_viewed' => 'all\course_module_viewed',
         '\totara_program\event\program_assigned' => 'totara_program\program_assigned'
 

src/transformer/utils/get_activity/course_module.php

@@ -69,6 +69,19 @@ function course_module(array $config, \stdClass $course, int $cmid) {
         );
     }
 
+    // Wiki
+    if ($module->name === 'wiki') {
+        $def = [
+            'type' => $activitytype,
+            'name' => [
+                $courselang => $instancename,
+            ],
+            'description' => [
+                $courselang => utils\get_string_html_removed($instance->intro),
+            ]
+        ];
+    }
+
     $object = [
         'id' => $coursemoduleurl,
         'definition' => $def,