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