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
|
<?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;
use Exception;
/**
* Simple view/template class.
*/
class View
{
/**
* @var string The (file) name of the view.
*/
private $name;
/**
* @var mixed[] Data to be inserted into the view.
*/
private $data;
/**
* @var mixed[] Data to be inserted into all views.
*/
private static $shared_data = [];
/**
* @var string Implementation of Blade "stacks".
*/
private static $stack;
/**
* @var array[] Implementation of Blade "stacks".
*/
private static $stacks = [];
/**
* Createa view from a template name and optional data.
*
* @param string $name
* @param array $data
*/
public function __construct(string $name, $data = [])
{
$this->name = $name;
$this->data = $data;
}
/**
* Shared data that is available to all views.
*
* @param string $key
* @param mixed $value
*
* @return void
*/
public static function share(string $key, $value)
{
self::$shared_data[$key] = $value;
}
/**
* Implementation of Blade "stacks".
*
* @see https://laravel.com/docs/5.5/blade#stacks
*
* @param string $stack
*
* @return void
*/
public static function push(string $stack)
{
self::$stack = $stack;
ob_start();
}
/**
* Implementation of Blade "stacks".
*
* @return void
*/
public static function endpush()
{
self::$stacks[self::$stack][] = ob_get_clean();
}
/**
* Implementation of Blade "stacks".
*
* @param string $stack
*
* @return string
*/
public static function stack(string $stack): string
{
$content = implode('', self::$stacks[$stack] ?? []);
self::$stacks[$stack] = [];
return $content;
}
/**
* Render a view.
*
* @return string
*/
public function render(): string
{
extract($this->data + self::$shared_data);
ob_start();
// Do not use require, so we can catch errors for missing files
include $this->getFilenameForView($this->name);
return ob_get_clean();
}
/**
* Allow a theme to override the default views.
*
* @param string $view_name
*
* @return string
* @throws Exception
*/
public function getFilenameForView($view_name): string
{
foreach ($this->paths() as $path) {
$view_file = $path . '/' . $view_name . '.php';
if (is_file($view_file)) {
return $view_file;
}
}
throw new Exception('View not found: ' . e($view_name));
}
/**
* Cerate and render a view in a single operation.
*
* @param string $name
* @param mixed[] $data
*
* @return string
*/
public static function make($name, $data = []): string
{
$view = new static($name, $data);
DebugBar::addView($name, $data);
return $view->render();
}
/**
* @return string[]
*/
private function paths(): array
{
static $paths = [];
if (empty($paths)) {
// Module views
// @TODO - this includes disabled modules.
$paths = glob(WT_ROOT . WT_MODULES_DIR . '*/resources/views');
// Theme views
$paths[] = WT_ROOT . WT_THEMES_DIR . Theme::theme()->themeId() . '/resources/views';
// Core views
$paths[] = WT_ROOT . 'resources/views';
$paths = array_filter($paths, function (string $path): bool {
return is_dir($path);
});
}
return $paths;
}
}
|
