-
Notifications
You must be signed in to change notification settings - Fork 36
/
TwigUtil.php
322 lines (232 loc) · 7.37 KB
/
TwigUtil.php
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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
<?php
/*!
* Twig Util Class
*
* Copyright (c) 2015 Dave Olsen, http://dmolsen.com
* Licensed under the MIT license
*
* Various utility methods for the Twig PatternEngine
*
*/
namespace PatternLab\PatternEngine\Twig;
use \PatternLab\Config;
use \PatternLab\Console;
use \Symfony\Component\Finder\Finder;
class TwigUtil {
protected static $instance = '';
protected static $loaders = array();
/**
* Get an instance of the Twig environment
*
* @return {Instance} an instance of the Twig environment
*/
public static function getInstance() {
if (empty(self::$instance)) {
return false;
}
return self::$instance;
}
/**
* Set an instance of the Twig environment
* @param {Instance} an instance of the Twig environment
*/
public static function setInstance($instance = "") {
if (empty($instance) || !method_exists($instance,'addGlobal')) {
Console::writeError("please set the instance");
}
self::$instance = $instance;
}
/**
* Get an instance of the Twig loaders
*
* @return {Array} List of Twig Loaders
*/
public static function getLoaders() {
if (empty(self::$loaders)) {
return false;
}
return self::$loaders;
}
/**
* Set an instance of the Twig loaders
* @param {Array} List of Twig Loaders
*/
public static function setLoaders($loaders = array()) {
if (empty($loaders)) {
Console::writeError("please set the loaders");
}
self::$loaders = $loaders;
}
/**
* Add a loader to the Twig Loaders array
* @param {Loader} A Twig Loader
*/
public static function addLoader($loader) {
self::$loaders[] = $loader;
}
/**
* Registering each directory under `_patterns/` as a namespace. For example, `_patterns/00-atoms/` as `@atoms`
* @param {Instance} an instance of the filesystem Loader
* @param {String} the path to the pattern directory
*
* @return {Instance} an instance of the filesystem Loader
*/
public static function addPaths($filesystemLoader, $patternSourceDir) {
$finder = new Finder();
$finder->directories()->depth(0)->in($patternSourceDir);
foreach ($finder as $file) {
$pattern = $file->getRelativePathName();
$patternBits = explode("-",$pattern,2);
$patternTypePath = (((int)$patternBits[0] != 0) || ($patternBits[0] == '00')) ? $patternBits[1] : $pattern;
$filesystemLoader->addPath($file->getPathName(), $patternTypePath);
}
return $filesystemLoader;
}
/**
* Load custom date formats for Twig
*/
public static function loadDateFormats() {
$dateFormat = Config::getOption("twigDefaultDateFormat");
$intervalFormat = Config::getOption("twigDefaultIntervalFormat");
if ($dateFormat && $intervalFormat && !empty($dateFormat) && !empty($intervalFormat)) {
self::$instance->getExtension("core")->setDateFormat($dateFormat, $intervalFormat);
}
}
/**
* Enable the debug options for Twig
*/
public static function loadDebug() {
if (Config::getOption("twigDebug")) {
self::$instance->addExtension(new \Twig_Extension_Debug());
}
}
/**
* Load filters for the Twig PatternEngine
*/
public static function loadFilters() {
// load defaults
$filterDir = Config::getOption("sourceDir").DIRECTORY_SEPARATOR."_twig-components/filters";
$filterExt = Config::getOption("twigFilterExt");
$filterExt = $filterExt ? $filterExt : "filter.php";
if (is_dir($filterDir)) {
// loop through the filter dir...
$finder = new Finder();
$finder->files()->name("*\.".$filterExt)->in($filterDir);
$finder->sortByName();
foreach ($finder as $file) {
// see if the file should be ignored or not
$baseName = $file->getBasename();
if ($baseName[0] != "_") {
include($file->getPathname());
// $filter should be defined in the included file
if (isset($filter)) {
self::$instance->addFilter($filter);
unset($filter);
}
}
}
}
}
/**
* Load functions for the Twig PatternEngine
*/
public static function loadFunctions() {
// load defaults
$functionDir = Config::getOption("sourceDir").DIRECTORY_SEPARATOR."_twig-components/functions";
$functionExt = Config::getOption("twigFunctionExt");
$functionExt = $functionExt ? $functionExt : "function.php";
if (is_dir($functionDir)) {
// loop through the function dir...
$finder = new Finder();
$finder->files()->name("*\.".$functionExt)->in($functionDir);
$finder->sortByName();
foreach ($finder as $file) {
// see if the file should be ignored or not
$baseName = $file->getBasename();
if ($baseName[0] != "_") {
include($file->getPathname());
// $function should be defined in the included file
if (isset($function)) {
self::$instance->addFunction($function);
unset($function);
}
}
}
}
}
/**
* Load macros for the Twig PatternEngine
*/
public static function loadMacros() {
// load defaults
$macroDir = Config::getOption("sourceDir").DIRECTORY_SEPARATOR."_macros";
$macroExt = Config::getOption("twigMacroExt");
$macroExt = $macroExt ? $macroExt : "macro.twig";
if (is_dir($macroDir)) {
// loop through some macro containing dir and run...
$finder = new Finder();
$finder->files()->name("*.".$macroExt)->in($macroDir);
$finder->sortByName();
foreach ($finder as $file) {
// see if the file should be ignored
$baseName = $file->getBasename();
if ($baseName[0] != "_") {
// add the macro to the global context
self::$instance->addGlobal($file->getBasename(".".$macroExt), self::$instance->loadTemplate($baseName));
}
}
}
}
/**
* Load tags for the Twig PatternEngine
*/
public static function loadTags() {
// load defaults
$tagDir = Config::getOption("sourceDir").DIRECTORY_SEPARATOR."_twig-components/tags";
$tagExt = Config::getOption("twigTagExt");
$tagExt = $tagExt ? $tagExt : "tag.php";
if (is_dir($tagDir)) {
// loop through the tags and instantiate the class...
$finder = new Finder();
$finder->files()->name("*\.".$tagExt)->in($tagDir);
$finder->sortByName();
foreach ($finder as $file) {
// see if the file should be ignored or not
$baseName = $file->getBasename();
if ($baseName[0] != "_") {
include($file->getPathname());
// Project_{filenameBase}_TokenParser should be defined in the include
$className = "Project_".$file->getBasename(".".$tagExt)."_TokenParser";
self::$instance->addTokenParser(new $className());
}
}
}
}
/**
* Load functions for the Twig PatternEngine
*/
public static function loadTests() {
// load defaults
$testDir = Config::getOption("sourceDir").DIRECTORY_SEPARATOR."_twig-components/tests";
$testExt = Config::getOption("twigTestExt");
$testExt = $testExt ? $testExt : "test.php";
if (is_dir($testDir)) {
// loop through the test dir...
$finder = new Finder();
$finder->files()->name("*\.".$testExt)->in($testDir);
$finder->sortByName();
foreach ($finder as $file) {
// see if the file should be ignored or not
$baseName = $file->getBasename();
if ($baseName[0] != "_") {
include($file->getPathname());
// $test should be defined in the included file
if (isset($test)) {
self::$instance->addTest($test);
unset($test);
}
}
}
}
}
}