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
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
<?php
/**
* Zend Framework (http://framework.zend.com/)
*
* @link http://github.com/zendframework/zf2 for the canonical source repository
* @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
namespace Zend\View\Helper;
use stdClass;
use Zend\View;
use Zend\View\Exception;
/**
* Helper for setting and retrieving script elements for HTML head section
*
* Allows the following method calls:
* @method HeadScript appendFile($src, $type = 'text/javascript', $attrs = [])
* @method HeadScript offsetSetFile($index, $src, $type = 'text/javascript', $attrs = [])
* @method HeadScript prependFile($src, $type = 'text/javascript', $attrs = [])
* @method HeadScript setFile($src, $type = 'text/javascript', $attrs = [])
* @method HeadScript appendScript($script, $type = 'text/javascript', $attrs = [])
* @method HeadScript offsetSetScript($index, $src, $type = 'text/javascript', $attrs = [])
* @method HeadScript prependScript($script, $type = 'text/javascript', $attrs = [])
* @method HeadScript setScript($script, $type = 'text/javascript', $attrs = [])
*/
class HeadScript extends Placeholder\Container\AbstractStandalone
{
/**
* Script type constants
*
* @const string
*/
const FILE = 'FILE';
const SCRIPT = 'SCRIPT';
/**
* Registry key for placeholder
*
* @var string
*/
protected $regKey = 'Zend_View_Helper_HeadScript';
/**
* Are arbitrary attributes allowed?
*
* @var bool
*/
protected $arbitraryAttributes = false;
/**
* Is capture lock?
*
* @var bool
*/
protected $captureLock;
/**
* Capture type
*
* @var string
*/
protected $captureScriptType;
/**
* Capture attributes
*
* @var null|array
*/
protected $captureScriptAttrs = null;
/**
* Capture type (append, prepend, set)
*
* @var string
*/
protected $captureType;
/**
* Optional allowed attributes for script tag
*
* @var array
*/
protected $optionalAttributes = [
'charset',
'integrity',
'crossorigin',
'defer',
'async',
'language',
'src',
'id',
];
/**
* Required attributes for script tag
*
* @var string
*/
protected $requiredAttributes = ['type'];
/**
* Whether or not to format scripts using CDATA; used only if doctype
* helper is not accessible
*
* @var bool
*/
public $useCdata = false;
/**
* Constructor
*
* Set separator to PHP_EOL.
*/
public function __construct()
{
parent::__construct();
$this->setSeparator(PHP_EOL);
}
/**
* Return headScript object
*
* Returns headScript helper object; optionally, allows specifying a script
* or script file to include.
*
* @param string $mode Script or file
* @param string $spec Script/url
* @param string $placement Append, prepend, or set
* @param array $attrs Array of script attributes
* @param string $type Script type and/or array of script attributes
* @return HeadScript
*/
public function __invoke(
$mode = self::FILE,
$spec = null,
$placement = 'APPEND',
array $attrs = [],
$type = 'text/javascript'
) {
if ((null !== $spec) && is_string($spec)) {
$action = ucfirst(strtolower($mode));
$placement = strtolower($placement);
switch ($placement) {
case 'set':
case 'prepend':
case 'append':
$action = $placement . $action;
break;
default:
$action = 'append' . $action;
break;
}
$this->$action($spec, $type, $attrs);
}
return $this;
}
/**
* Overload method access
*
* @param string $method Method to call
* @param array $args Arguments of method
* @throws Exception\BadMethodCallException if too few arguments or invalid method
* @return HeadScript
*/
public function __call($method, $args)
{
if (preg_match('/^(?P<action>set|(ap|pre)pend|offsetSet)(?P<mode>File|Script)$/', $method, $matches)) {
if (1 > count($args)) {
throw new Exception\BadMethodCallException(sprintf(
'Method "%s" requires at least one argument',
$method
));
}
$action = $matches['action'];
$mode = strtolower($matches['mode']);
$type = 'text/javascript';
$attrs = [];
if ('offsetSet' == $action) {
$index = array_shift($args);
if (1 > count($args)) {
throw new Exception\BadMethodCallException(sprintf(
'Method "%s" requires at least two arguments, an index and source',
$method
));
}
}
$content = $args[0];
if (isset($args[1])) {
$type = (string) $args[1];
}
if (isset($args[2])) {
$attrs = (array) $args[2];
}
switch ($mode) {
case 'script':
$item = $this->createData($type, $attrs, $content);
if ('offsetSet' == $action) {
$this->offsetSet($index, $item);
} else {
$this->$action($item);
}
break;
case 'file':
default:
if (! $this->isDuplicate($content)) {
$attrs['src'] = $content;
$item = $this->createData($type, $attrs);
if ('offsetSet' == $action) {
$this->offsetSet($index, $item);
} else {
$this->$action($item);
}
}
break;
}
return $this;
}
return parent::__call($method, $args);
}
/**
* Retrieve string representation
*
* @param string|int $indent Amount of whitespaces or string to use for indention
* @return string
*/
public function toString($indent = null)
{
$indent = (null !== $indent)
? $this->getWhitespace($indent)
: $this->getIndent();
if ($this->view) {
$useCdata = $this->view->plugin('doctype')->isXhtml();
} else {
$useCdata = $this->useCdata;
}
$escapeStart = ($useCdata) ? '//<![CDATA[' : '//<!--';
$escapeEnd = ($useCdata) ? '//]]>' : '//-->';
$items = [];
$this->getContainer()->ksort();
foreach ($this as $item) {
if (! $this->isValid($item)) {
continue;
}
$items[] = $this->itemToString($item, $indent, $escapeStart, $escapeEnd);
}
return implode($this->getSeparator(), $items);
}
/**
* Start capture action
*
* @param mixed $captureType Type of capture
* @param string $type Type of script
* @param array $attrs Attributes of capture
* @throws Exception\RuntimeException
* @return void
*/
public function captureStart(
$captureType = Placeholder\Container\AbstractContainer::APPEND,
$type = 'text/javascript',
$attrs = []
) {
if ($this->captureLock) {
throw new Exception\RuntimeException('Cannot nest headScript captures');
}
$this->captureLock = true;
$this->captureType = $captureType;
$this->captureScriptType = $type;
$this->captureScriptAttrs = $attrs;
ob_start();
}
/**
* End capture action and store
*
* @return void
*/
public function captureEnd()
{
$content = ob_get_clean();
$type = $this->captureScriptType;
$attrs = $this->captureScriptAttrs;
$this->captureScriptType = null;
$this->captureScriptAttrs = null;
$this->captureLock = false;
switch ($this->captureType) {
case Placeholder\Container\AbstractContainer::SET:
case Placeholder\Container\AbstractContainer::PREPEND:
case Placeholder\Container\AbstractContainer::APPEND:
$action = strtolower($this->captureType) . 'Script';
break;
default:
$action = 'appendScript';
break;
}
$this->$action($content, $type, $attrs);
}
/**
* Create data item containing all necessary components of script
*
* @param string $type Type of data
* @param array $attributes Attributes of data
* @param string $content Content of data
* @return stdClass
*/
public function createData($type, array $attributes, $content = null)
{
$data = new stdClass();
$data->type = $type;
$data->attributes = $attributes;
$data->source = $content;
return $data;
}
/**
* Is the file specified a duplicate?
*
* @param string $file Name of file to check
* @return bool
*/
protected function isDuplicate($file)
{
foreach ($this->getContainer() as $item) {
if (($item->source === null)
&& array_key_exists('src', $item->attributes)
&& ($file == $item->attributes['src'])
) {
return true;
}
}
return false;
}
/**
* Is the script provided valid?
*
* @param mixed $value Is the given script valid?
* @return bool
*/
protected function isValid($value)
{
if ((! $value instanceof stdClass)
|| ! isset($value->type)
|| (! isset($value->source)
&& ! isset($value->attributes))
) {
return false;
}
return true;
}
/**
* Create script HTML
*
* @param mixed $item Item to convert
* @param string $indent String to add before the item
* @param string $escapeStart Starting sequence
* @param string $escapeEnd Ending sequence
* @return string
*/
public function itemToString($item, $indent, $escapeStart, $escapeEnd)
{
$attrString = '';
if (! empty($item->attributes)) {
foreach ($item->attributes as $key => $value) {
if ((! $this->arbitraryAttributesAllowed() && ! in_array($key, $this->optionalAttributes))
|| in_array($key, ['conditional', 'noescape'])) {
continue;
}
if ('defer' == $key) {
$value = 'defer';
}
if ('async' == $key) {
$value = 'async';
}
$attrString .= sprintf(' %s="%s"', $key, ($this->autoEscape) ? $this->escape($value) : $value);
}
}
$addScriptEscape = ! (isset($item->attributes['noescape'])
&& filter_var($item->attributes['noescape'], FILTER_VALIDATE_BOOLEAN));
if (empty($item->type) && $this->view && $this->view->plugin('doctype')->isHtml5()) {
$html = '<script ' . $attrString . '>';
} else {
$type = ($this->autoEscape) ? $this->escape($item->type) : $item->type;
$html = '<script type="' . $type . '"' . $attrString . '>';
}
if (! empty($item->source)) {
$html .= PHP_EOL;
if ($addScriptEscape) {
$html .= $indent . ' ' . $escapeStart . PHP_EOL;
}
$html .= $indent . ' ' . $item->source;
if ($addScriptEscape) {
$html .= PHP_EOL . $indent . ' ' . $escapeEnd;
}
$html .= PHP_EOL . $indent;
}
$html .= '</script>';
if (isset($item->attributes['conditional'])
&& ! empty($item->attributes['conditional'])
&& is_string($item->attributes['conditional'])
) {
// inner wrap with comment end and start if !IE
if (str_replace(' ', '', $item->attributes['conditional']) === '!IE') {
$html = '<!-->' . $html . '<!--';
}
$html = $indent . '<!--[if ' . $item->attributes['conditional'] . ']>' . $html . '<![endif]-->';
} else {
$html = $indent . $html;
}
return $html;
}
/**
* Override append
*
* @param string $value Append script or file
* @throws Exception\InvalidArgumentException
* @return void
*/
public function append($value)
{
if (! $this->isValid($value)) {
throw new Exception\InvalidArgumentException(
'Invalid argument passed to append(); '
. 'please use one of the helper methods, appendScript() or appendFile()'
);
}
return $this->getContainer()->append($value);
}
/**
* Override prepend
*
* @param string $value Prepend script or file
* @throws Exception\InvalidArgumentException
* @return void
*/
public function prepend($value)
{
if (! $this->isValid($value)) {
throw new Exception\InvalidArgumentException(
'Invalid argument passed to prepend(); '
. 'please use one of the helper methods, prependScript() or prependFile()'
);
}
return $this->getContainer()->prepend($value);
}
/**
* Override set
*
* @param string $value Set script or file
* @throws Exception\InvalidArgumentException
* @return void
*/
public function set($value)
{
if (! $this->isValid($value)) {
throw new Exception\InvalidArgumentException(
'Invalid argument passed to set(); please use one of the helper methods, setScript() or setFile()'
);
}
return $this->getContainer()->set($value);
}
/**
* Override offsetSet
*
* @param string|int $index Set script of file offset
* @param mixed $value
* @throws Exception\InvalidArgumentException
* @return void
*/
public function offsetSet($index, $value)
{
if (! $this->isValid($value)) {
throw new Exception\InvalidArgumentException(
'Invalid argument passed to offsetSet(); '
. 'please use one of the helper methods, offsetSetScript() or offsetSetFile()'
);
}
return $this->getContainer()->offsetSet($index, $value);
}
/**
* Set flag indicating if arbitrary attributes are allowed
*
* @param bool $flag Set flag
* @return HeadScript
*/
public function setAllowArbitraryAttributes($flag)
{
$this->arbitraryAttributes = (bool) $flag;
return $this;
}
/**
* Are arbitrary attributes allowed?
*
* @return bool
*/
public function arbitraryAttributesAllowed()
{
return $this->arbitraryAttributes;
}
}