first commit

lib/classes/hook/output/after_standard_main_region_html_generation.php

@@ -0,0 +1,81 @@
+<?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 core\hook\output;
+
+/**
+ * Hook to allow subscribers to add HTML content after the main region content has been generated.
+ *
+ * @package    core
+ * @copyright  2024 Andrew Lyons <andrew@nicols.co.uk>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @property-read \renderer_base $renderer The page renderer object
+ */
+#[\core\attribute\tags('output')]
+#[\core\attribute\label('Allows plugins to add any elements to the footer before JS is finalized')]
+#[\core\attribute\hook\replaces_callbacks('standard_after_main_region_html')]
+final class after_standard_main_region_html_generation {
+    /**
+     * Hook to allow subscribers to add HTML content after the main region content has been generated.
+     *
+     * @param renderer_base $renderer
+     * @param string $output Initial output
+     */
+    public function __construct(
+        /** @var \renderer_base The page renderer object */
+        public readonly \renderer_base $renderer,
+        /** @var string The collected output */
+        private string $output = '',
+    ) {
+    }
+
+    /**
+     * Plugins implementing callback can add any HTML to the top of the body.
+     *
+     * Must be a string containing valid html head content.
+     *
+     * @param null|string $output
+     */
+    public function add_html(?string $output): void {
+        if ($output) {
+            $this->output .= $output;
+        }
+    }
+
+    /**
+     * Returns all HTML added by the plugins
+     *
+     * @return string
+     */
+    public function get_output(): string {
+        return $this->output;
+    }
+
+    /**
+     * Process legacy callbacks.
+     */
+    public function process_legacy_callbacks(): void {
+        $pluginswithfunction = get_plugins_with_function(function: 'standard_after_main_region_html', migratedtohook: true);
+        foreach ($pluginswithfunction as $plugins) {
+            foreach ($plugins as $function) {
+                $extrafooter = $function();
+                if (is_string($extrafooter)) {
+                    $this->add_html($extrafooter);
+                }
+            }
+        }
+    }
+}

lib/classes/hook/output/before_footer_html_generation.php

@@ -0,0 +1,81 @@
+<?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 core\hook\output;
+
+/**
+ * Hook to allow subscribers to add HTML content to the footer.
+ *
+ * @package    core
+ * @copyright  2024 Andrew Lyons <andrew@nicols.co.uk>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @property-read \renderer_base $renderer The page renderer object
+ */
+#[\core\attribute\tags('output')]
+#[\core\attribute\label('Allows plugins to add any elements to the footer before JS is finalized')]
+#[\core\attribute\hook\replaces_callbacks('before_footer')]
+final class before_footer_html_generation {
+    /**
+     * Hook to allow subscribers to add HTML content to the footer.
+     *
+     * @param \renderer_base $renderer
+     * @param string $output Initial output
+     */
+    public function __construct(
+        /** @var \renderer_base The page renderer object */
+        public readonly \renderer_base $renderer,
+        /** @var string The collected output */
+        private string $output = '',
+    ) {
+    }
+
+    /**
+     * Plugins implementing callback can add any HTML to the top of the body.
+     *
+     * Must be a string containing valid html head content.
+     *
+     * @param null|string $output
+     */
+    public function add_html(?string $output): void {
+        if ($output) {
+            $this->output .= $output;
+        }
+    }
+
+    /**
+     * Returns all HTML added by the plugins
+     *
+     * @return string
+     */
+    public function get_output(): string {
+        return $this->output;
+    }
+
+    /**
+     * Process legacy callbacks.
+     */
+    public function process_legacy_callbacks(): void {
+        $pluginswithfunction = get_plugins_with_function(function: 'before_footer', migratedtohook: true);
+        foreach ($pluginswithfunction as $plugins) {
+            foreach ($plugins as $function) {
+                $extrafooter = $function();
+                if (is_string($extrafooter)) {
+                    $this->add_html($extrafooter);
+                }
+            }
+        }
+    }
+}

lib/classes/hook/output/before_html_attributes.php

@@ -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/>.
+
+namespace core\hook\output;
+
+/**
+ * Class before_html_attributes
+ *
+ * @package    core
+ * @copyright  2024 Andrew Lyons <andrew@nicols.co.uk>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @property-read \renderer_base $renderer The page renderer object
+ * @property array $attributes The list of HTML attributes to be added to the tag.
+ */
+#[\core\attribute\tags('output')]
+#[\core\attribute\label('Allows plugins to add, remove or modify any attributes of the html tag.')]
+#[\core\attribute\hook\replaces_callbacks('add_htmlattributes')]
+final class before_html_attributes {
+    /**
+     * Constructor for the before_html_attributes hook.
+     *
+     * @param \renderer_base $renderer The page renderer object
+     * @param array $attributes The list of HTML attributes initially on the tag
+     */
+    public function __construct(
+        /** @var \renderer_base The page renderer */
+        public readonly \renderer_base $renderer,
+        /** @var array The list of HTML attributes initially on the tag */
+        private array $attributes = [],
+    ) {
+    }
+
+    /**
+     * Add an HTML attribute to the list.
+     *
+     * @param string $name
+     * @param string $value
+     */
+    public function add_attribute(string $name, string $value): void {
+        $this->attributes[$name] = $value;
+    }
+
+    /**
+     * Get the list of attributes.
+     *
+     * @return array
+     */
+    public function get_attributes(): array {
+        return $this->attributes;
+    }
+
+    /**
+     * Remove an HTML attribute from the list.
+     *
+     * @param string $name
+     */
+    public function remove_attribute(string $name): void {
+        unset($this->attributes[$name]);
+    }
+
+    /**
+     * Process legacy callbacks.
+     */
+    public function process_legacy_callbacks(): void {
+        // Legacy callback 'add_htmlattributes' is deprecated since Moodle 4.4.
+
+        // This function should return an array of html attribute names => values.
+        $pluginswithfunction = get_plugins_with_function(
+            function: 'add_htmlattributes',
+            migratedtohook: true,
+        );
+        foreach ($pluginswithfunction as $plugins) {
+            foreach ($plugins as $function) {
+                $newattrs = $function();
+                unset($newattrs['dir']);
+                unset($newattrs['lang']);
+                unset($newattrs['xmlns']);
+                unset($newattrs['xml:lang']);
+                foreach ($newattrs as $name => $value) {
+                    $this->add_attribute($name, $value);
+                }
+            }
+        }
+    }
+}

lib/classes/hook/output/before_http_headers.php

@@ -0,0 +1,54 @@
+<?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 core\hook\output;
+
+/**
+ * Class before_http_headers
+ *
+ * @package    core
+ * @copyright  2024 Andrew Lyons <andrew@nicols.co.uk>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @property-read \renderer_base $renderer The page renderer object
+ */
+#[\core\attribute\tags('output')]
+#[\core\attribute\label('Allows plugins to make changes before headers are sent')]
+#[\core\attribute\hook\replaces_callbacks('before_http_headers')]
+class before_http_headers {
+    /**
+     * Hook to allow subscribers to modify the process before headers are sent.
+     *
+     * @param \renderer_base $renderer
+     */
+    public function __construct(
+        /** @var \renderer_base The page renderer object */
+        public readonly \renderer_base $renderer,
+    ) {
+    }
+
+
+    /**
+     * Process legacy callbacks.
+     */
+    public function process_legacy_callbacks(): void {
+        $pluginswithfunction = get_plugins_with_function(function: 'before_http_headers', migratedtohook: true);
+        foreach ($pluginswithfunction as $plugins) {
+            foreach ($plugins as $function) {
+                $function();
+            }
+        }
+    }
+}

lib/classes/hook/output/before_standard_footer_html_generation.php

@@ -0,0 +1,83 @@
+<?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 core\hook\output;
+
+use renderer_base;
+
+/**
+ * Hook to allow subscribers to add HTML content to the footer.
+ *
+ * @package    core
+ * @copyright  2024 Andrew Lyons <andrew@nicols.co.uk>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+#[\core\attribute\tags('output')]
+#[\core\attribute\label('Allows plugins to add any elements to the page footer.')]
+#[\core\attribute\hook\replaces_callbacks('standard_footer_html')]
+final class before_standard_footer_html_generation {
+    /**
+     * Hook to allow subscribers to add HTML content before the footer.
+     *
+     * @param renderer_base $renderer
+     * @param string $output Initial output
+     */
+    public function __construct(
+        /** @var renderer_base The page renderer object */
+        public readonly renderer_base $renderer,
+        /** @var string The collected output */
+        private string $output = '',
+    ) {
+    }
+
+    /**
+     * Plugins implementing callback can add any HTML to the top of the body.
+     *
+     * Must be a string containing valid html head content.
+     *
+     * @param null|string $output
+     */
+    public function add_html(?string $output): void {
+        if ($output) {
+            $this->output .= $output;
+        }
+    }
+
+    /**
+     * Returns all HTML added by the plugins
+     *
+     * @return string
+     */
+    public function get_output(): string {
+        return $this->output;
+    }
+
+    /**
+     * Process legacy callbacks.
+     *
+     * Legacy callback 'standard_footer_html' is deprecated since Moodle 4.4
+     */
+    public function process_legacy_callbacks(): void {
+        // Give plugins an opportunity to add any footer elements.
+        // The callback must always return a string containing valid html footer content.
+        $pluginswithfunction = get_plugins_with_function(function: 'standard_footer_html', migratedtohook: true);
+        foreach ($pluginswithfunction as $plugins) {
+            foreach ($plugins as $function) {
+                $this->add_html($function());
+            }
+        }
+    }
+}

lib/classes/hook/output/before_standard_head_html_generation.php

@@ -0,0 +1,81 @@
+<?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 core\hook\output;
+
+/**
+ * Allows plugins to add any elements to the page <head> html tag
+ *
+ * @package    core
+ * @copyright  2023 Marina Glancy
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+#[\core\attribute\tags('output')]
+#[\core\attribute\label('Allows plugins to add any elements to the page &lt;head&gt; html tag.')]
+#[\core\attribute\hook\replaces_callbacks('before_standard_html_head')]
+final class before_standard_head_html_generation {
+    /**
+     * Hook to allow subscribers to add HTML content to page head tag.
+     *
+     * @param renderer_base $renderer
+     * @param string $output Initial output
+     */
+    public function __construct(
+        /** @var \renderer_base The core_renderer instance used for the generation */
+        public readonly \renderer_base $renderer,
+        /** @var string The collected output */
+        private string $output = '',
+    ) {
+    }
+
+
+    /**
+     * Plugins implementing callback can add any HTML to the page.
+     *
+     * Must be a string containing valid html head content
+     *
+     * @param null|string $output
+     */
+    public function add_html(?string $output): void {
+        if ($output) {
+            $this->output .= $output;
+        }
+    }
+
+    /**
+     * Returns all HTML added by the plugins
+     *
+     * @return string
+     */
+    public function get_output(): string {
+        return $this->output;
+    }
+
+    /**
+     * Process legacy callbacks.
+     *
+     * Legacy callback 'before_standard_html_head' is deprecated since Moodle 4.4
+     */
+    public function process_legacy_callbacks(): void {
+        $pluginswithfunction = get_plugins_with_function('before_standard_html_head', 'lib.php', true, true);
+        foreach ($pluginswithfunction as $plugins) {
+            foreach ($plugins as $function) {
+                $output = $function();
+                $this->add_html((string)$output);
+            }
+        }
+    }
+}

lib/classes/hook/output/before_standard_top_of_body_html_generation.php

@@ -0,0 +1,101 @@
+<?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 core\hook\output;
+
+/**
+ * Hook to allow subscribers to add HTML content to the top of the page body.
+ *
+ * @package    core
+ * @copyright  2024 Andrew Lyons <andrew@nicols.co.uk>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @property-read \renderer_base $renderer The page renderer object
+ */
+#[\core\attribute\tags('output')]
+#[\core\attribute\label('Allows plugins to add any elements to the page &lt;head&gt; html tag.')]
+#[\core\attribute\hook\replaces_callbacks('before_standard_top_of_body_html')]
+final class before_standard_top_of_body_html_generation {
+    /**
+     * Hook to allow subscribers to add HTML content to the top of the page body.
+     *
+     * @param \renderer_base $renderer
+     * @param string $output Initial output
+     */
+    public function __construct(
+        /** @var \renderer_base The page renderer object */
+        public readonly \renderer_base $renderer,
+        /** @var string The collected output */
+        private string $output = '',
+    ) {
+    }
+
+
+    /**
+     * Plugins implementing callback can add any HTML to the top of the body.
+     *
+     * Must be a string containing valid html head content.
+     *
+     * @param null|string $output
+     */
+    public function add_html(?string $output): void {
+        if ($output) {
+            $this->output .= $output;
+        }
+    }
+
+    /**
+     * Returns all HTML added by the plugins
+     *
+     * @return string
+     */
+    public function get_output(): string {
+        return $this->output;
+    }
+
+    /**
+     * Process legacy callbacks.
+     *
+     * Legacy callback 'before_standard_top_of_body_html' is deprecated since Moodle 4.4
+     */
+    public function process_legacy_callbacks(): void {
+        // Give subsystems an opportunity to inject extra html content. The callback
+        // must always return a string containing valid html.
+        foreach (\core_component::get_core_subsystems() as $name => $path) {
+            if ($path) {
+                $this->add_html(
+                    component_callback(
+                        component: $name,
+                        function: 'before_standard_top_of_body_html',
+                        default: '',
+                        migratedtohook: true,
+                    ),
+                );
+            }
+        }
+
+        // Give plugins an opportunity to inject extra html content. The callback
+        // must always return a string containing valid html.
+        $pluginswithfunction = get_plugins_with_function(
+            function: 'before_standard_top_of_body_html',
+            migratedtohook: true,
+        );
+        foreach ($pluginswithfunction as $plugins) {
+            foreach ($plugins as $function) {
+                $this->add_html($function() ?? '');
+            }
+        }
+    }
+}