Proyectos de Subversion Moodle

Rev

| Ultima modificación | Ver Log |

Rev Autor Línea Nro. Línea
1441 ariadna 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
 * Class after_http_headers
21
 *
22
 * @package    core
23
 * @copyright  2024 Huong Nguyen <huongnv13@gmail.com>
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 make changes after headers are sent')]
29
class after_http_headers {
30
    /**
31
     * Hook to allow subscribers to modify the process after headers are sent.
32
     *
33
     * @param \renderer_base $renderer
34
     * @param string $output
35
     */
36
    public function __construct(
37
        /** @var \renderer_base The page renderer object */
38
        public readonly \renderer_base $renderer,
39
        /** @var string The collected output */
40
        private string $output = '',
41
    ) {
42
    }
43
 
44
    /**
45
     * Plugins implementing callback can add any HTML after headers content.
46
     *
47
     * Must be a string containing valid html content.
48
     *
49
     * @param null|string $output
50
     */
51
    public function add_html(?string $output): void {
52
        if ($output) {
53
            $this->output .= $output;
54
        }
55
    }
56
 
57
    /**
58
     * Returns all HTML added by the plugins
59
     *
60
     * @return string
61
     */
62
    public function get_output(): string {
63
        return $this->output;
64
    }
65
}