1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
|
<?php
namespace Fisharebest\Webtrees\Theme;
/**
* webtrees: online genealogy
* Copyright (C) 2015 webtrees development team
* This program 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.
* This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
*/
use Fisharebest\Webtrees\Auth;
use Fisharebest\Webtrees\Controller\PageController;
use Fisharebest\Webtrees\Database;
use Fisharebest\Webtrees\Fact;
use Fisharebest\Webtrees\Filter;
use Fisharebest\Webtrees\FlashMessages;
use Fisharebest\Webtrees\Functions\Functions;
use Fisharebest\Webtrees\GedcomRecord;
use Fisharebest\Webtrees\GedcomTag;
use Fisharebest\Webtrees\HitCounter;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Individual;
use Fisharebest\Webtrees\Menu;
use Fisharebest\Webtrees\Module;
use Fisharebest\Webtrees\Module\FamilyTreeFavoritesModule;
use Fisharebest\Webtrees\Module\UserFavoritesModule;
use Fisharebest\Webtrees\Site;
use Fisharebest\Webtrees\Theme;
use Fisharebest\Webtrees\Tree;
use Fisharebest\Webtrees\User;
/**
* Specification for a theme.
*/
interface ThemeInterface {
/**
* Where are our CSS, JS and other assets?
*
* @return string A relative path, such as "themes/foo/"
*/
public function assetUrl();
/**
* Create the top of the <body>.
*
* @return string
*/
public function bodyHeader();
/**
* Create the top of the <body> (for popup windows).
*
* @return string
*/
public function bodyHeaderPopupWindow();
/**
* Create a contact link for a user.
*
* @param User $user
*
* @return string
*/
public function contactLink(User $user);
/**
* Create the <DOCTYPE> tag.
*
* @return string
*/
public function doctype();
/**
* Close the main content and create the <footer> tag.
*
* @return string
*/
public function footerContainer();
/**
* Close the main content.
* Note that popup windows are deprecated
*
* @return string
*/
public function footerContainerPopupWindow();
/**
* Format the contents of a variable-height home-page block.
*
* @param string $id
* @param string $title
* @param string $class
* @param string $content
*
* @return string
*/
public function formatBlock($id, $title, $class, $content);
/**
* Create the <head> tag.
*
* @param PageController $controller The current controller
*
* @return string
*/
public function head(PageController $controller);
/**
* Allow themes to do things after initialization (since they cannot use
* the constructor).
*/
public function hookAfterInit();
/**
* Allow themes to add extra scripts to the page footer.
*
* @return string
*/
public function hookFooterExtraJavascript();
/**
* Allow themes to add extra content to the page header.
* Typically this will be additional CSS.
*
* @return string
*/
public function hookHeaderExtraContent();
/**
* Create the <html> tag.
*
* @return string
*/
public function html();
/**
* Add HTML markup to create an alert
*
* @param string $html The content of the alert
* @param string $level One of 'success', 'info', 'warning', 'danger'
* @param bool $dismissible If true, add a close button.
*
* @return string
*/
public function htmlAlert($html, $level, $dismissible);
/**
* Display an icon for this fact.
*
* @param Fact $fact
*
* @return string
*/
public function icon(Fact $fact);
/**
* Display an individual in a box - for charts, etc.
*
* @param Individual $individual
*
* @return string
*/
public function individualBox(Individual $individual);
/**
* Display an empty box - for a missing individual in a chart.
*
* @return string
*/
public function individualBoxEmpty();
/**
* Display an individual in a box - for charts, etc.
*
* @param Individual $individual
*
* @return string
*/
public function individualBoxLarge(Individual $individual);
/**
* Display an individual in a box - for charts, etc.
*
* @param Individual $individual
*
* @return string
*/
public function individualBoxSmall(Individual $individual);
/**
* Display an individual in a box - for charts, etc.
*
* @return string
*/
public function individualBoxSmallEmpty();
/**
* Initialise the theme. We cannot pass these in a constructor, as the construction
* happens in a theme file, and we need to be able to change it.
*
* @param Tree|null $tree The current tree (if there is one).
*/
public function init(Tree $tree = null);
/**
* Themes menu.
*
* @return Menu|null
*/
public function menuThemes();
/**
* Misecellaneous dimensions, fonts, styles, etc.
*
* @param string $parameter_name
*
* @return string|int|float
*/
public function parameter($parameter_name);
/**
* Send any HTTP headers.
*/
public function sendHeaders();
/**
* A fixed string to identify this theme, in settings, etc.
*
* @return string
*/
public function themeId();
/**
* What is this theme called?
*
* @return string
*/
public function themeName();
}
|
