-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
StringTemplate.php
276 lines (253 loc) · 7.23 KB
/
StringTemplate.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
<?php
/**
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @since 3.0.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\View;
use Cake\Configure\Engine\PhpConfig;
use Cake\Core\InstanceConfigTrait;
/**
* Provides an interface for registering and inserting
* content into simple logic-less string templates.
*
* Used by several helpers to provide simple flexible templates
* for generating HTML and other content.
*/
class StringTemplate {
use InstanceConfigTrait {
config as get;
}
/**
* List of attributes that can be made compact.
*
* @var array
*/
protected $_compactAttributes = array(
'compact', 'checked', 'declare', 'readonly', 'disabled', 'selected',
'defer', 'ismap', 'nohref', 'noshade', 'nowrap', 'multiple', 'noresize',
'autoplay', 'controls', 'loop', 'muted', 'required', 'novalidate', 'formnovalidate'
);
/**
* The default templates this instance holds.
*
* @var array
*/
protected $_defaultConfig = [
'attribute' => '{{name}}="{{value}}"',
'compactAttribute' => '{{name}}="{{value}}"',
];
/**
* A stack of template sets that have been stashed temporarily.
*
* @var array
*/
protected $_configStack = [];
/**
* Contains the list of compiled templates
*
* @var array
*/
protected $_compiled = [];
/**
* Constructor.
*
* @param array $config A set of templates to add.
*/
public function __construct(array $config = []) {
$this->config($config);
}
/**
* Push the current templates onto the template stack.
*
* @return void
*/
public function push() {
$this->_configStack[] = $this->_config;
}
/**
* Restore the most recently pushed set of templates.
*
* Restoring templates will invalidate all compiled templates.
*
* @return void
*/
public function pop() {
if (empty($this->_configStack)) {
return;
}
$this->_config = array_pop($this->_configStack);
$this->_compiled = [];
}
/**
* Registers a list of templates by name
*
* ### Example:
*
* {{{
* $templater->add([
* 'link' => '<a href="{{url}}">{{title}}</a>'
* 'button' => '<button>{{text}}</button>'
* ]);
* }}}
*
* @param array $templates An associative list of named templates.
* @return $this
*/
public function add(array $templates) {
$this->config($templates);
$this->_compiled = array_diff_key($this->_compiled, $templates);
return $this;
}
/**
* Load a config file containing templates.
*
* Template files should define a `$config` variable containing
* all the templates to load. Loaded templates will be merged with existing
* templates.
*
* @param string $file The file to load
* @return void
*/
public function load($file) {
$loader = new PhpConfig(APP . 'Config/');
$templates = $loader->read($file);
$this->add($templates);
}
/**
* Remove the named template.
*
* @param string $name The template to remove.
* @return void
*/
public function remove($name) {
$this->config($name, null);
unset($this->_compiled[$name]);
}
/**
* Returns an array containing the compiled template to be used with
* the sprintf function and a list of placeholder names that were found
* in the template in the order that they should be replaced.
*
* @param string $name The compiled template info
* @return array
*/
public function compile($name) {
if (isset($this->_compiled[$name])) {
return $this->_compiled[$name];
}
$template = $this->get($name);
if ($template === null) {
return $this->_compiled[$name] = [null, null];
}
preg_match_all('#\{\{(\w+)\}\}#', $template, $matches);
return $this->_compiled[$name] = [
str_replace($matches[0], '%s', $template),
$matches[1]
];
}
/**
* Format a template string with $data
*
* @param string $name The template name.
* @param array $data The data to insert.
* @return string
*/
public function format($name, array $data) {
list($template, $placeholders) = $this->compile($name);
if ($template === null) {
return '';
}
$replace = [];
foreach ($placeholders as $placeholder) {
$replace[] = isset($data[$placeholder]) ? $data[$placeholder] : null;
}
return vsprintf($template, $replace);
}
/**
* Returns a space-delimited string with items of the $options array. If a key
* of $options array happens to be one of those listed
* in `StringTemplate::$_compactAttributes` and its value is one of:
*
* - '1' (string)
* - 1 (integer)
* - true (boolean)
* - 'true' (string)
*
* Then the value will be reset to be identical with key's name.
* If the value is not one of these 4, the parameter is not output.
*
* 'escape' is a special option in that it controls the conversion of
* attributes to their html-entity encoded equivalents. Set to false to disable html-encoding.
*
* If value for any option key is set to `null` or `false`, that option will be excluded from output.
*
* This method uses the 'attribute' and 'compactAttribute' templates. Each of
* these templates uses the `name` and `value` variables. You can modify these
* templates to change how attributes are formatted.
*
* @param array $options Array of options.
* @param null|array $exclude Array of options to be excluded, the options here will not be part of the return.
* @return string Composed attributes.
*/
public function formatAttributes($options, $exclude = null) {
$insertBefore = ' ';
$options = (array)$options + ['escape' => true];
if (!is_array($exclude)) {
$exclude = [];
}
$exclude = ['escape' => true, 'idPrefix' => true] + array_flip($exclude);
$escape = $options['escape'];
$attributes = [];
foreach ($options as $key => $value) {
if (!isset($exclude[$key]) && $value !== false && $value !== null) {
$attributes[] = $this->_formatAttribute($key, $value, $escape);
}
}
$out = trim(implode(' ', $attributes));
return $out ? $insertBefore . $out : '';
}
/**
* Formats an individual attribute, and returns the string value of the composed attribute.
* Works with minimized attributes that have the same value as their name such as 'disabled' and 'checked'
*
* @param string $key The name of the attribute to create
* @param string|array $value The value of the attribute to create.
* @param bool $escape Define if the value must be escaped
* @return string The composed attribute.
*/
protected function _formatAttribute($key, $value, $escape = true) {
if (is_array($value)) {
$value = implode(' ', $value);
}
if (is_numeric($key)) {
return $this->format('compactAttribute', [
'name' => $value,
'value' => $value
]);
}
$truthy = [1, '1', true, 'true', $key];
$isMinimized = in_array($key, $this->_compactAttributes);
if ($isMinimized && in_array($value, $truthy, true)) {
return $this->format('compactAttribute', [
'name' => $key,
'value' => $key
]);
}
if ($isMinimized) {
return '';
}
return $this->format('attribute', [
'name' => $key,
'value' => $escape ? h($value) : $value
]);
}
}