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
|
<?php
/**
* webtrees: online genealogy
* Copyright (C) 2018 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/>.
*/
namespace Fisharebest\Webtrees\Controller;
use Fisharebest\Webtrees\Tree;
/**
* Base controller for all other controllers
*/
class BaseController {
// The controller accumulates Javascript (inline and external), and renders it in the footer
const JS_PRIORITY_HIGH = 0;
const JS_PRIORITY_NORMAL = 1;
const JS_PRIORITY_LOW = 2;
/** @var string[][] Inline JavaScript to add to the page. */
private $inline_javascript = [
self::JS_PRIORITY_HIGH => [],
self::JS_PRIORITY_NORMAL => [],
self::JS_PRIORITY_LOW => [],
];
/** @var Tree Create a page for which tree */
private $tree;
/**
* Startup activity
*/
public function __construct() {
global $WT_TREE;
$this->tree = $WT_TREE;
}
/**
* Create a page for this tree.
*
* @return Tree
*/
public function tree() {
return $this->tree;
}
/**
* Make a list of inline Javascript, so we can render them in the footer
* NOTE: there is no need to use "$(document).ready(function(){...})", etc.
* as this Javascript won’t be inserted until the very end of the page.
*
* @param string $script
* @param int $priority
*
* @return $this
*/
public function addInlineJavascript($script, $priority = self::JS_PRIORITY_NORMAL) {
$tmp = &$this->inline_javascript[$priority];
$tmp[] = $script;
return $this;
}
/**
* We've collected up Javascript fragments while rendering the page.
* Now display them in order.
*
* @return string
*/
public function getJavascript() {
$javascript1 = '';
$javascript2 = '';
$javascript3 = '';
// Inline (high priority) javascript
foreach ($this->inline_javascript[self::JS_PRIORITY_HIGH] as $script) {
$javascript1 .= $script;
}
// Inline (lower priority) javascript
foreach ($this->inline_javascript as $priority => $scripts) {
if ($priority !== self::JS_PRIORITY_HIGH) {
foreach ($scripts as $script) {
$javascript3 .= $script;
}
}
}
// We could, in theory, inject JS at any point in the page (not just the bottom) - prepare for next time
$this->inline_javascript = [
self::JS_PRIORITY_HIGH => [],
self::JS_PRIORITY_NORMAL => [],
self::JS_PRIORITY_LOW => [],
];
return '<script>' . $javascript1 . '</script>' . $javascript2 . '<script>' . $javascript3 . '</script>';
}
/**
* Print the page header, using the theme
*
* @return $this
*/
public function pageHeader() {
// We've displayed the header - display the footer automatically
register_shutdown_function([$this, 'pageFooter']);
return $this;
}
/**
* Print the page footer, using the theme
*/
public function pageFooter() {
echo $this->getJavascript();
}
}
|
