xref: /webtrees/app/Module/ModuleGlobalInterface.php (revision d11be7027e34e3121be11cc025421873364403f9)
1abafa13cSGreg Roach<?php
23976b470SGreg Roach
3abafa13cSGreg Roach/**
4abafa13cSGreg Roach * webtrees: online genealogy
5*d11be702SGreg Roach * Copyright (C) 2023 webtrees development team
6abafa13cSGreg Roach * This program is free software: you can redistribute it and/or modify
7abafa13cSGreg Roach * it under the terms of the GNU General Public License as published by
8abafa13cSGreg Roach * the Free Software Foundation, either version 3 of the License, or
9abafa13cSGreg Roach * (at your option) any later version.
10abafa13cSGreg Roach * This program is distributed in the hope that it will be useful,
11abafa13cSGreg Roach * but WITHOUT ANY WARRANTY; without even the implied warranty of
12abafa13cSGreg Roach * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13abafa13cSGreg Roach * GNU General Public License for more details.
14abafa13cSGreg Roach * You should have received a copy of the GNU General Public License
1589f7189bSGreg Roach * along with this program. If not, see <https://www.gnu.org/licenses/>.
16abafa13cSGreg Roach */
17fcfa147eSGreg Roach
18abafa13cSGreg Roachdeclare(strict_types=1);
19abafa13cSGreg Roach
20abafa13cSGreg Roachnamespace Fisharebest\Webtrees\Module;
21abafa13cSGreg Roach
22abafa13cSGreg Roach/**
23abafa13cSGreg Roach * Interface ModuleGlobalInterface - Add global content to the page layout.
24abafa13cSGreg Roach */
25abafa13cSGreg Roachinterface ModuleGlobalInterface extends ModuleInterface
26abafa13cSGreg Roach{
27abafa13cSGreg Roach    /**
28abafa13cSGreg Roach     * Raw content, to be added at the end of the <body> element.
29abafa13cSGreg Roach     * Typically, this will be <script> elements.
30abafa13cSGreg Roach     *
31abafa13cSGreg Roach     * @return string
32abafa13cSGreg Roach     */
33abafa13cSGreg Roach    public function bodyContent(): string;
348d6560c4SGreg Roach
358d6560c4SGreg Roach    /**
368d6560c4SGreg Roach     * Raw content, to be added at the end of the <head> element.
378d6560c4SGreg Roach     * Typically, this will be <link> and <meta> elements.
388d6560c4SGreg Roach     *
398d6560c4SGreg Roach     * @return string
408d6560c4SGreg Roach     */
418d6560c4SGreg Roach    public function headContent(): string;
42abafa13cSGreg Roach}
43