-
Notifications
You must be signed in to change notification settings - Fork 9.3k
/
Template.php
376 lines (344 loc) · 11.7 KB
/
Template.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
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
<?php
/**
* Copyright © 2015 Magento. All rights reserved.
* See COPYING.txt for license details.
*/
/**
* Template constructions filter
*/
namespace Magento\Framework\Filter;
class Template implements \Zend_Filter_Interface
{
/**
* Construction regular expression
*/
const CONSTRUCTION_PATTERN = '/{{([a-z]{0,10})(.*?)}}/si';
/**#@+
* Construction logic regular expression
*/
const CONSTRUCTION_DEPEND_PATTERN = '/{{depend\s*(.*?)}}(.*?){{\\/depend\s*}}/si';
const CONSTRUCTION_IF_PATTERN = '/{{if\s*(.*?)}}(.*?)({{else}}(.*?))?{{\\/if\s*}}/si';
const CONSTRUCTION_TEMPLATE_PATTERN = '/{{(template)(.*?)}}/si';
/**#@-*/
/**
* Callbacks that will be applied after filtering
*
* @var array
*/
private $afterFilterCallbacks = [];
/**
* Assigned template variables
*
* @var array
*/
protected $templateVars = [];
/**
* Template processor
*
* @var callable|null
*/
protected $templateProcessor = null;
/**
* @var \Magento\Framework\Stdlib\StringUtils
*/
protected $string;
/**
* @param \Magento\Framework\Stdlib\StringUtils $string
* @param array $variables
*/
public function __construct(\Magento\Framework\Stdlib\StringUtils $string, $variables = [])
{
$this->string = $string;
$this->setVariables($variables);
}
/**
* Sets template variables that's can be called through {var ...} statement
*
* @param array $variables
* @return \Magento\Framework\Filter\Template
*/
public function setVariables(array $variables)
{
foreach ($variables as $name => $value) {
$this->templateVars[$name] = $value;
}
return $this;
}
/**
* Sets the processor for template directive.
*
* @param callable $callback it must return string
* @return $this
*/
public function setTemplateProcessor(callable $callback)
{
$this->templateProcessor = $callback;
return $this;
}
/**
* Sets the processor for template directive.
*
* @return callable|null
*/
public function getTemplateProcessor()
{
return is_callable($this->templateProcessor) ? $this->templateProcessor : null;
}
/**
* Filter the string as template.
*
* @param string $value
* @return string
* @throws \Exception
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
*/
public function filter($value)
{
// "depend", "if", and "template" directives should be first
foreach ([
self::CONSTRUCTION_DEPEND_PATTERN => 'dependDirective',
self::CONSTRUCTION_IF_PATTERN => 'ifDirective',
self::CONSTRUCTION_TEMPLATE_PATTERN => 'templateDirective',
] as $pattern => $directive) {
if (preg_match_all($pattern, $value, $constructions, PREG_SET_ORDER)) {
foreach ($constructions as $construction) {
$callback = [$this, $directive];
if (!is_callable($callback)) {
continue;
}
try {
$replacedValue = call_user_func($callback, $construction);
} catch (\Exception $e) {
throw $e;
}
$value = str_replace($construction[0], $replacedValue, $value);
}
}
}
if (preg_match_all(self::CONSTRUCTION_PATTERN, $value, $constructions, PREG_SET_ORDER)) {
foreach ($constructions as $construction) {
$callback = [$this, $construction[1] . 'Directive'];
if (!is_callable($callback)) {
continue;
}
try {
$replacedValue = call_user_func($callback, $construction);
} catch (\Exception $e) {
throw $e;
}
$value = str_replace($construction[0], $replacedValue, $value);
}
}
$value = $this->afterFilter($value);
return $value;
}
/**
* Runs callbacks that have been added to filter content after directive processing is finished.
*
* @param string $value
* @return string
*/
protected function afterFilter($value)
{
foreach ($this->afterFilterCallbacks as $callback) {
$value = call_user_func($callback, $value);
}
// Since a single instance of this class can be used to filter content multiple times, reset callbacks to
// prevent callbacks running for unrelated content (e.g., email subject and email body)
$this->resetAfterFilterCallbacks();
return $value;
}
/**
* Adds a callback to run after main filtering has happened. Callback must accept a single argument and return
* a string of the processed value.
*
* @param callable $afterFilterCallback
* @return $this
*/
public function addAfterFilterCallback(callable $afterFilterCallback)
{
// Only add callback if it doesn't already exist
if (in_array($afterFilterCallback, $this->afterFilterCallbacks)) {
return $this;
}
$this->afterFilterCallbacks[] = $afterFilterCallback;
return $this;
}
/**
* Resets the after filter callbacks
*
* @return $this
*/
protected function resetAfterFilterCallbacks()
{
$this->afterFilterCallbacks = [];
return $this;
}
/**
* @param string[] $construction
* @return string
*/
public function varDirective($construction)
{
if (count($this->templateVars) == 0) {
// If template prepossessing
return $construction[0];
}
$replacedValue = $this->getVariable($construction[2], '');
return $replacedValue;
}
/**
* Allows templates to be included inside other templates
*
* Usage:
*
* {{template config_path="<PATH>"}}
*
* <PATH> equals the XPATH to the system configuration value that contains the value of the template.
* This directive is useful to include things like a global header/footer.
*
* @param string[] $construction
* @return mixed
*/
public function templateDirective($construction)
{
// Processing of {template config_path=... [...]} statement
$templateParameters = $this->getParameters($construction[2]);
if (!isset($templateParameters['config_path']) or !$this->getTemplateProcessor()) {
// Not specified template or not set include processor
$replacedValue = '{Error in template processing}';
} else {
// Including of template
$configPath = $templateParameters['config_path'];
unset($templateParameters['config_path']);
$templateParameters = array_merge_recursive($templateParameters, $this->templateVars);
$replacedValue = call_user_func($this->getTemplateProcessor(), $configPath, $templateParameters);
}
return $replacedValue;
}
/**
* @param string[] $construction
* @return string
*/
public function dependDirective($construction)
{
if (count($this->templateVars) == 0) {
// If template processing
return $construction[0];
}
if ($this->getVariable($construction[1], '') == '') {
return '';
} else {
return $construction[2];
}
}
/**
* @param string[] $construction
* @return string
*/
public function ifDirective($construction)
{
if (count($this->templateVars) == 0) {
return $construction[0];
}
if ($this->getVariable($construction[1], '') == '') {
if (isset($construction[3]) && isset($construction[4])) {
return $construction[4];
}
return '';
} else {
return $construction[2];
}
}
/**
* Return associative array of parameters.
*
* @param string $value raw parameters
* @return array
*/
protected function getParameters($value)
{
$tokenizer = new Template\Tokenizer\Parameter();
$tokenizer->setString($value);
$params = $tokenizer->tokenize();
foreach ($params as $key => $value) {
if (substr($value, 0, 1) === '$') {
$params[$key] = $this->getVariable(substr($value, 1), null);
}
}
return $params;
}
/**
* Return variable value for var construction
*
* @param string $value raw parameters
* @param string $default default value
* @return string
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
*/
protected function getVariable($value, $default = '{no_value_defined}')
{
\Magento\Framework\Profiler::start('email_template_processing_variables');
$tokenizer = new Template\Tokenizer\Variable();
$tokenizer->setString($value);
$stackVars = $tokenizer->tokenize();
$result = $default;
$last = 0;
for ($i = 0; $i < count($stackVars); $i++) {
if ($i == 0 && isset($this->templateVars[$stackVars[$i]['name']])) {
// Getting of template value
$stackVars[$i]['variable'] = & $this->templateVars[$stackVars[$i]['name']];
} elseif (
isset($stackVars[$i - 1]['variable'])
&& $stackVars[$i - 1]['variable'] instanceof \Magento\Framework\DataObject
) {
// If object calling methods or getting properties
if ($stackVars[$i]['type'] == 'property') {
$caller = 'get' . $this->string->upperCaseWords($stackVars[$i]['name'], '_', '');
$stackVars[$i]['variable'] = method_exists(
$stackVars[$i - 1]['variable'],
$caller
) ? $stackVars[$i - 1]['variable']->{$caller}() : $stackVars[$i - 1]['variable']->getData(
$stackVars[$i]['name']
);
} elseif ($stackVars[$i]['type'] == 'method') {
// Calling of object method
if (
method_exists($stackVars[$i - 1]['variable'], $stackVars[$i]['name'])
|| substr($stackVars[$i]['name'], 0, 3) == 'get'
) {
$stackVars[$i]['args'] = $this->getStackArgs($stackVars[$i]['args']);
$stackVars[$i]['variable'] = call_user_func_array(
[$stackVars[$i - 1]['variable'], $stackVars[$i]['name']],
$stackVars[$i]['args']
);
}
}
$last = $i;
}
}
if (isset($stackVars[$last]['variable'])) {
// If value for construction exists set it
$result = $stackVars[$last]['variable'];
}
\Magento\Framework\Profiler::stop('email_template_processing_variables');
return $result;
}
/**
* Loops over a set of stack args to process variables into array argument values
*
* @param array $stack
* @return array
*/
protected function getStackArgs($stack)
{
foreach ($stack as $i => $value) {
if (is_array($value)) {
$stack[$i] = $this->getStackArgs($value);
} elseif (substr($value, 0, 1) === '$') {
$stack[$i] = $this->getVariable(substr($value, 1), null);
}
}
return $stack;
}
}