cb4e621ce9
Co-authored-by: Matt Porritt <pozze30@gmail.com>
66 lines
2.0 KiB
PHP
66 lines
2.0 KiB
PHP
<?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 after_http_headers
|
|
*
|
|
* @package core
|
|
* @copyright 2024 Huong Nguyen <huongnv13@gmail.com>
|
|
* @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 after headers are sent')]
|
|
class after_http_headers {
|
|
/**
|
|
* Hook to allow subscribers to modify the process after headers are sent.
|
|
*
|
|
* @param \renderer_base $renderer
|
|
* @param string $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 after headers content.
|
|
*
|
|
* Must be a string containing valid html 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;
|
|
}
|
|
}
|