| 1 |
efrain |
1 |
<?php
|
|
|
2 |
// This file is part of Moodle - http://moodle.org/
|
|
|
3 |
//
|
|
|
4 |
// Moodle is free software: you can redistribute it and/or modify
|
|
|
5 |
// it under the terms of the GNU General Public License as published by
|
|
|
6 |
// the Free Software Foundation, either version 3 of the License, or
|
|
|
7 |
// (at your option) any later version.
|
|
|
8 |
//
|
|
|
9 |
// Moodle is distributed in the hope that it will be useful,
|
|
|
10 |
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
11 |
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
12 |
// GNU General Public License for more details.
|
|
|
13 |
//
|
|
|
14 |
// You should have received a copy of the GNU General Public License
|
|
|
15 |
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
16 |
|
|
|
17 |
namespace core\hook\output;
|
|
|
18 |
|
|
|
19 |
/**
|
|
|
20 |
* Hook to allow subscribers to add HTML content to the top of the page body.
|
|
|
21 |
*
|
|
|
22 |
* @package core
|
|
|
23 |
* @copyright 2024 Andrew Lyons <andrew@nicols.co.uk>
|
|
|
24 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
25 |
* @property-read \renderer_base $renderer The page renderer object
|
|
|
26 |
*/
|
|
|
27 |
#[\core\attribute\tags('output')]
|
|
|
28 |
#[\core\attribute\label('Allows plugins to add any elements to the page <head> html tag.')]
|
|
|
29 |
#[\core\attribute\hook\replaces_callbacks('before_standard_top_of_body_html')]
|
|
|
30 |
final class before_standard_top_of_body_html_generation {
|
|
|
31 |
/**
|
|
|
32 |
* Hook to allow subscribers to add HTML content to the top of the page body.
|
|
|
33 |
*
|
|
|
34 |
* @param \renderer_base $renderer
|
|
|
35 |
* @param string $output Initial output
|
|
|
36 |
*/
|
|
|
37 |
public function __construct(
|
|
|
38 |
/** @var \renderer_base The page renderer object */
|
|
|
39 |
public readonly \renderer_base $renderer,
|
|
|
40 |
/** @var string The collected output */
|
|
|
41 |
private string $output = '',
|
|
|
42 |
) {
|
|
|
43 |
}
|
|
|
44 |
|
|
|
45 |
|
|
|
46 |
/**
|
|
|
47 |
* Plugins implementing callback can add any HTML to the top of the body.
|
|
|
48 |
*
|
|
|
49 |
* Must be a string containing valid html head content.
|
|
|
50 |
*
|
|
|
51 |
* @param null|string $output
|
|
|
52 |
*/
|
|
|
53 |
public function add_html(?string $output): void {
|
|
|
54 |
if ($output) {
|
|
|
55 |
$this->output .= $output;
|
|
|
56 |
}
|
|
|
57 |
}
|
|
|
58 |
|
|
|
59 |
/**
|
|
|
60 |
* Returns all HTML added by the plugins
|
|
|
61 |
*
|
|
|
62 |
* @return string
|
|
|
63 |
*/
|
|
|
64 |
public function get_output(): string {
|
|
|
65 |
return $this->output;
|
|
|
66 |
}
|
|
|
67 |
|
|
|
68 |
/**
|
|
|
69 |
* Process legacy callbacks.
|
|
|
70 |
*
|
|
|
71 |
* Legacy callback 'before_standard_top_of_body_html' is deprecated since Moodle 4.4
|
|
|
72 |
*/
|
|
|
73 |
public function process_legacy_callbacks(): void {
|
|
|
74 |
// Give subsystems an opportunity to inject extra html content. The callback
|
|
|
75 |
// must always return a string containing valid html.
|
|
|
76 |
foreach (\core_component::get_core_subsystems() as $name => $path) {
|
|
|
77 |
if ($path) {
|
|
|
78 |
$this->add_html(
|
|
|
79 |
component_callback(
|
|
|
80 |
component: $name,
|
|
|
81 |
function: 'before_standard_top_of_body_html',
|
|
|
82 |
default: '',
|
|
|
83 |
migratedtohook: true,
|
|
|
84 |
),
|
|
|
85 |
);
|
|
|
86 |
}
|
|
|
87 |
}
|
|
|
88 |
|
|
|
89 |
// Give plugins an opportunity to inject extra html content. The callback
|
|
|
90 |
// must always return a string containing valid html.
|
|
|
91 |
$pluginswithfunction = get_plugins_with_function(
|
|
|
92 |
function: 'before_standard_top_of_body_html',
|
|
|
93 |
migratedtohook: true,
|
|
|
94 |
);
|
|
|
95 |
foreach ($pluginswithfunction as $plugins) {
|
|
|
96 |
foreach ($plugins as $function) {
|
|
|
97 |
$this->add_html($function() ?? '');
|
|
|
98 |
}
|
|
|
99 |
}
|
|
|
100 |
}
|
|
|
101 |
}
|