|
1
|
|
|
<?php |
|
2
|
|
|
/** |
|
3
|
|
|
* @package WPEmerge |
|
4
|
|
|
* @author Atanas Angelov <[email protected]> |
|
5
|
|
|
* @copyright 2018 Atanas Angelov |
|
6
|
|
|
* @license https://www.gnu.org/licenses/gpl-2.0.html GPL-2.0 |
|
7
|
|
|
* @link https://wpemerge.com/ |
|
8
|
|
|
*/ |
|
9
|
|
|
|
|
10
|
|
|
namespace WPEmerge\View; |
|
11
|
|
|
|
|
12
|
|
|
use WPEmerge\Helpers\MixedType; |
|
13
|
|
|
|
|
14
|
|
|
/** |
|
15
|
|
|
* Render view files with php. |
|
16
|
|
|
*/ |
|
17
|
|
|
class PhpViewEngine implements ViewEngineInterface { |
|
18
|
|
|
/** |
|
19
|
|
|
* Custom views directory to check first. |
|
20
|
|
|
* |
|
21
|
|
|
* @var string |
|
22
|
|
|
*/ |
|
23
|
|
|
protected $directory = ''; |
|
24
|
|
|
|
|
25
|
|
|
/** |
|
26
|
|
|
* Constructor. |
|
27
|
|
|
* |
|
28
|
|
|
* @codeCoverageIgnore |
|
29
|
|
|
* @param string $directory |
|
30
|
|
|
*/ |
|
31
|
|
|
public function __construct( $directory = '' ) { |
|
32
|
|
|
$this->setDirectory( $directory ); |
|
33
|
|
|
} |
|
34
|
|
|
|
|
35
|
|
|
/** |
|
36
|
|
|
* Get the custom views directory. |
|
37
|
|
|
* |
|
38
|
|
|
* @codeCoverageIgnore |
|
39
|
|
|
* @return string |
|
40
|
|
|
*/ |
|
41
|
|
|
public function getDirectory() { |
|
42
|
|
|
return $this->directory; |
|
43
|
|
|
} |
|
44
|
|
|
|
|
45
|
|
|
/** |
|
46
|
|
|
* Set the custom views directory. |
|
47
|
|
|
* |
|
48
|
|
|
* @codeCoverageIgnore |
|
49
|
|
|
* @param string $directory |
|
50
|
|
|
* @return void |
|
51
|
|
|
*/ |
|
52
|
|
|
public function setDirectory( $directory ) { |
|
53
|
|
|
$this->directory = MixedType::removeTrailingSlash( $directory ); |
|
54
|
|
|
} |
|
55
|
|
|
|
|
56
|
|
|
/** |
|
57
|
|
|
* {@inheritDoc} |
|
58
|
|
|
*/ |
|
59
|
1 |
|
public function exists( $view ) { |
|
60
|
1 |
|
$file = $this->resolveFilepath( $view ); |
|
61
|
1 |
|
return strlen( $file ) > 0; |
|
62
|
|
|
} |
|
63
|
|
|
|
|
64
|
|
|
/** |
|
65
|
|
|
* {@inheritDoc} |
|
66
|
|
|
*/ |
|
67
|
1 |
|
public function canonical( $view ) { |
|
68
|
1 |
|
$root = realpath( MixedType::normalizePath( get_template_directory() ) ) . DIRECTORY_SEPARATOR; |
|
69
|
1 |
|
$match_root = '/^' . preg_quote( $root, '/' ) . '/'; |
|
70
|
1 |
|
return preg_replace( $match_root, '', $this->resolveFilepath( $view ) ); |
|
71
|
|
|
} |
|
72
|
|
|
|
|
73
|
|
|
/** |
|
74
|
|
|
* {@inheritDoc} |
|
75
|
|
|
* @throws ViewNotFoundException |
|
76
|
|
|
*/ |
|
77
|
2 |
|
public function make( $views ) { |
|
78
|
2 |
|
foreach ( $views as $view ) { |
|
79
|
2 |
|
if ( $this->exists( $view ) ) { |
|
80
|
1 |
|
$filepath = $this->resolveFilepath( $view ); |
|
81
|
1 |
|
return $this->makeView( $view, $filepath ); |
|
82
|
|
|
} |
|
83
|
1 |
|
} |
|
84
|
|
|
|
|
85
|
1 |
|
throw new ViewNotFoundException( 'View not found for "' . implode( ', ', $views ) . '"' ); |
|
86
|
|
|
} |
|
87
|
|
|
|
|
88
|
|
|
/** |
|
89
|
|
|
* Create a view instance. |
|
90
|
|
|
* |
|
91
|
|
|
* @param string $name |
|
92
|
|
|
* @param string $filepath |
|
93
|
|
|
* @return ViewInterface |
|
94
|
|
|
* @throws ViewNotFoundException |
|
95
|
|
|
*/ |
|
96
|
2 |
|
protected function makeView( $name, $filepath ) { |
|
97
|
2 |
|
$view = (new PhpView()) |
|
98
|
2 |
|
->setName( $name ) |
|
99
|
2 |
|
->setFilepath( $filepath ); |
|
100
|
|
|
|
|
101
|
2 |
|
$layout = $this->getViewLayout( $view ); |
|
102
|
|
|
|
|
103
|
2 |
|
if ( $layout !== null ) { |
|
104
|
1 |
|
$view->setLayout( $layout ); |
|
105
|
1 |
|
} |
|
106
|
|
|
|
|
107
|
2 |
|
return $view; |
|
108
|
|
|
} |
|
109
|
|
|
|
|
110
|
|
|
/** |
|
111
|
|
|
* Create a view instance for the given view's layout header, if any. |
|
112
|
|
|
* |
|
113
|
|
|
* @param PhpView $view |
|
114
|
|
|
* @return ViewInterface |
|
115
|
|
|
* @throws ViewNotFoundException |
|
116
|
|
|
*/ |
|
117
|
2 |
|
protected function getViewLayout( PhpView $view ) { |
|
118
|
2 |
|
$layout_headers = array_filter( get_file_data( |
|
119
|
2 |
|
$view->getFilepath(), |
|
120
|
2 |
|
['App Layout'] |
|
121
|
2 |
|
) ); |
|
122
|
|
|
|
|
123
|
2 |
|
if ( empty( $layout_headers ) ) { |
|
124
|
1 |
|
return null; |
|
125
|
|
|
} |
|
126
|
|
|
|
|
127
|
2 |
|
$layout_file = trim( $layout_headers[0] ); |
|
128
|
|
|
|
|
129
|
2 |
|
if ( ! $this->exists( $layout_file ) ) { |
|
130
|
1 |
|
throw new ViewNotFoundException( 'View layout not found for "' . $layout_file . '"' ); |
|
131
|
|
|
} |
|
132
|
|
|
|
|
133
|
1 |
|
return $this->makeView( $this->canonical( $layout_file ), $this->resolveFilepath( $layout_file ) ); |
|
134
|
|
|
} |
|
135
|
|
|
|
|
136
|
|
|
/** |
|
137
|
|
|
* Resolve a view name to an absolute filepath. |
|
138
|
|
|
* |
|
139
|
|
|
* @param string $view |
|
140
|
|
|
* @return string |
|
141
|
|
|
*/ |
|
142
|
1 |
|
protected function resolveFilepath( $view ) { |
|
143
|
1 |
|
$file = $this->resolveFromCustomFilepath( $view ); |
|
144
|
|
|
|
|
145
|
1 |
|
if ( ! $file ) { |
|
146
|
1 |
|
$file = $this->resolveFromThemeFilepath( $view ); |
|
147
|
1 |
|
} |
|
148
|
|
|
|
|
149
|
1 |
|
if ( ! $file ) { |
|
150
|
1 |
|
$file = $this->resolveFromAbsoluteFilepath( $view ); |
|
151
|
1 |
|
} |
|
152
|
|
|
|
|
153
|
1 |
|
if ( $file ) { |
|
154
|
1 |
|
$file = realpath( $file ); |
|
155
|
1 |
|
} |
|
156
|
|
|
|
|
157
|
1 |
|
return $file; |
|
158
|
|
|
} |
|
159
|
|
|
|
|
160
|
|
|
/** |
|
161
|
|
|
* Resolve a view if it exists in the custom views directory. |
|
162
|
|
|
* |
|
163
|
|
|
* @param string $view |
|
164
|
|
|
* @return string |
|
165
|
|
|
*/ |
|
166
|
1 |
|
protected function resolveFromCustomFilepath( $view ) { |
|
167
|
1 |
|
$directory = $this->getDirectory(); |
|
168
|
|
|
|
|
169
|
1 |
|
if ( $directory === '' ) { |
|
170
|
|
|
return ''; |
|
171
|
|
|
} |
|
172
|
|
|
|
|
173
|
|
|
// Normalize to ensure there are no doubled separators. |
|
174
|
1 |
|
$file = MixedType::normalizePath( $directory . DIRECTORY_SEPARATOR . $view ); |
|
175
|
|
|
|
|
176
|
1 |
|
if ( ! file_exists( $file ) ) { |
|
177
|
|
|
// Try adding a .php extension. |
|
178
|
1 |
|
$file .= '.php'; |
|
179
|
1 |
|
}; |
|
180
|
|
|
|
|
181
|
1 |
|
return file_exists( $file ) ? $file : ''; |
|
182
|
|
|
} |
|
183
|
|
|
|
|
184
|
|
|
/** |
|
185
|
|
|
* Resolve a view if it exists in the current theme. |
|
186
|
|
|
* |
|
187
|
|
|
* @param string $view |
|
188
|
|
|
* @return string |
|
189
|
|
|
*/ |
|
190
|
1 |
|
protected function resolveFromThemeFilepath( $view ) { |
|
191
|
1 |
|
$file = locate_template( $view, false ); |
|
192
|
|
|
|
|
193
|
1 |
|
if ( ! $file ) { |
|
194
|
|
|
// Try adding a .php extension. |
|
195
|
1 |
|
$file = locate_template( $view . '.php', false ); |
|
196
|
1 |
|
} |
|
197
|
|
|
|
|
198
|
1 |
|
return $file; |
|
199
|
|
|
} |
|
200
|
|
|
|
|
201
|
|
|
/** |
|
202
|
|
|
* Resolve a view if it exists on the filesystem. |
|
203
|
|
|
* |
|
204
|
|
|
* @param string $view |
|
205
|
|
|
* @return string |
|
206
|
|
|
*/ |
|
207
|
1 |
|
protected function resolveFromAbsoluteFilepath( $view ) { |
|
208
|
1 |
|
return file_exists( $view ) ? $view : ''; |
|
209
|
|
|
} |
|
210
|
|
|
} |
|
211
|
|
|
|
htmlburger /
wpemerge
