3 Migrate output callbacks to hooks

classes/local/hook_callbacks.php

@@ -0,0 +1,67 @@
+<?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 local_examguard\local;
+
+use core\hook\output\before_standard_top_of_body_html_generation;
+use local_examguard\manager;
+
+/**
+ * Hook callbacks for local_examguard.
+ * @package    local_examguard
+ * @copyright  2024 onwards University College London {@link https://www.ucl.ac.uk/}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @author     Leon Stringer <[email protected]>
+ */
+class hook_callbacks {
+    /**
+     * Function to add notification to the top of the page if the exam is in
+     * progress.
+     *
+     * @param before_standard_top_of_body_html_generation $hook
+     * @return void
+     */
+    public static function before_standard_top_of_body_html_generation(before_standard_top_of_body_html_generation $hook): void {
+        global $PAGE, $USER;
+
+        // Check if the current page is a course view page or a module view page.
+        if ((str_contains($PAGE->pagetype, 'course-view') || preg_match('/mod-(.+?)-view/', $PAGE->pagetype))
+            && $PAGE->course->id != SITEID) {
+            try {
+                // Exam guard is enabled.
+                if (get_config('local_examguard', 'enabled')) {
+
+                    // Do nothing if the current user is not an editing role, e.g. student.
+                    if (!manager::user_has_an_editing_role($PAGE->course->id, $USER->id)) {
+                        return;
+                    }
+
+                    // Ban course editing if the exam is in progress / release course editing if the exam is finished.
+                    list($editingbanned, $activeexamactivities) = manager::check_course_exam_status($PAGE->course->id);
+
+                    // Add notification if course editing is banned.
+                    if ($editingbanned) {
+                        manager::show_notfication_banner($activeexamactivities);
+                    }
+                }
+            } catch (Exception $e) {
+                notification::add($e->getMessage(), notification::ERROR);
+            }
+        }
+
+        return;
+    }
+}

classes/observer.php

@@ -13,6 +13,7 @@
 //
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
 use local_examguard\manager;
 
 /**

db/hooks.php

@@ -0,0 +1,33 @@
+<?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/>.
+
+/**
+ * Hooks for local_examguard.
+ *
+ * @package    local_examguard
+ * @copyright  2024 onwards University College London {@link https://www.ucl.ac.uk/}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @author     Leon Stringer <[email protected]>
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+$callbacks = [
+    [
+        'hook' => \core\hook\output\before_standard_top_of_body_html_generation::class,
+        'callback' => \local_examguard\local\hook_callbacks::class . '::before_standard_top_of_body_html_generation',
+    ],
+];

lib.php

@@ -26,42 +26,6 @@
  * @author     Alex Yeung <[email protected]>
  */
 
-/**
- * Function to add notification to the top of the page if the exam is in progress.
- *
- * @return string
- */
-function local_examguard_before_standard_top_of_body_html(): string {
-    global $PAGE, $USER;
-
-    // Check if the current page is a course view page or a module view page.
-    if ((str_contains($PAGE->pagetype, 'course-view') || preg_match('/mod-(.+?)-view/', $PAGE->pagetype))
-        && $PAGE->course->id != SITEID) {
-        try {
-            // Exam guard is enabled.
-            if (get_config('local_examguard', 'enabled')) {
-
-                // Do nothing if the current user is not an editing role, e.g. student.
-                if (!manager::user_has_an_editing_role($PAGE->course->id, $USER->id)) {
-                    return '';
-                }
-
-                // Ban course editing if the exam is in progress / release course editing if the exam is finished.
-                list($editingbanned, $activeexamactivities) = manager::check_course_exam_status($PAGE->course->id);
-
-                // Add notification if course editing is banned.
-                if ($editingbanned) {
-                    manager::show_notfication_banner($activeexamactivities);
-                }
-            }
-        } catch (Exception $e) {
-            notification::add($e->getMessage(), notification::ERROR);
-        }
-    }
-
-    return '';
-}
-
 /**
  * Validate the data in the new field when the form is submitted
  *

version.php

@@ -26,7 +26,7 @@
 defined('MOODLE_INTERNAL') || die();
 
 $plugin->component = 'local_examguard';
-$plugin->release = '0.1.0';
-$plugin->version = 2024041000;
-$plugin->requires = 2023100900;
+$plugin->release = '0.1.1';
+$plugin->version = 2024070400;
+$plugin->requires = 2024042200; // Moodle 4.4.
 $plugin->maturity = MATURITY_ALPHA;