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
<?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;
/**
* Zend\View\Helper\HeadMeta
*
* @see http://www.w3.org/TR/xhtml1/dtds.html
*
* Allows the following 'virtual' methods:
* @method HeadMeta appendName($keyValue, $content, $modifiers = array())
* @method HeadMeta offsetGetName($index, $keyValue, $content, $modifiers = array())
* @method HeadMeta prependName($keyValue, $content, $modifiers = array())
* @method HeadMeta setName($keyValue, $content, $modifiers = array())
* @method HeadMeta appendHttpEquiv($keyValue, $content, $modifiers = array())
* @method HeadMeta offsetGetHttpEquiv($index, $keyValue, $content, $modifiers = array())
* @method HeadMeta prependHttpEquiv($keyValue, $content, $modifiers = array())
* @method HeadMeta setHttpEquiv($keyValue, $content, $modifiers = array())
* @method HeadMeta appendProperty($keyValue, $content, $modifiers = array())
* @method HeadMeta offsetGetProperty($index, $keyValue, $content, $modifiers = array())
* @method HeadMeta prependProperty($keyValue, $content, $modifiers = array())
* @method HeadMeta setProperty($keyValue, $content, $modifiers = array())
*/
class HeadMeta extends Placeholder\Container\AbstractStandalone
{
/**
* Allowed key types
*
* @var array
*/
protected $typeKeys = ['name', 'http-equiv', 'charset', 'property', 'itemprop'];
/**
* Required attributes for meta tag
*
* @var array
*/
protected $requiredKeys = ['content'];
/**
* Allowed modifier keys
*
* @var array
*/
protected $modifierKeys = ['lang', 'scheme'];
/**
* Registry key for placeholder
*
* @var string
*/
protected $regKey = 'Zend_View_Helper_HeadMeta';
/**
* Constructor
*
* Set separator to PHP_EOL
*
*/
public function __construct()
{
parent::__construct();
$this->setSeparator(PHP_EOL);
}
/**
* Retrieve object instance; optionally add meta tag
*
* @param string $content
* @param string $keyValue
* @param string $keyType
* @param array $modifiers
* @param string $placement
* @return HeadMeta
*/
public function __invoke(
$content = null,
$keyValue = null,
$keyType = 'name',
$modifiers = [],
$placement = Placeholder\Container\AbstractContainer::APPEND
) {
if ((null !== $content) && (null !== $keyValue)) {
$item = $this->createData($keyType, $keyValue, $content, $modifiers);
$action = strtolower($placement);
switch ($action) {
case 'append':
case 'prepend':
case 'set':
$this->$action($item);
break;
default:
$this->append($item);
break;
}
}
return $this;
}
/**
* Overload method access
*
* @param string $method
* @param array $args
* @throws Exception\BadMethodCallException
* @return HeadMeta
*/
public function __call($method, $args)
{
if (preg_match(
'/^(?P<action>set|(pre|ap)pend|offsetSet)(?P<type>Name|HttpEquiv|Property|Itemprop)$/',
$method,
$matches
)) {
$action = $matches['action'];
$type = $this->normalizeType($matches['type']);
$argc = count($args);
$index = null;
if ('offsetSet' == $action) {
if (0 < $argc) {
$index = array_shift($args);
--$argc;
}
}
if (2 > $argc) {
throw new Exception\BadMethodCallException(
'Too few arguments provided; requires key value, and content'
);
}
if (3 > $argc) {
$args[] = [];
}
$item = $this->createData($type, $args[0], $args[1], $args[2]);
if ('offsetSet' == $action) {
return $this->offsetSet($index, $item);
}
$this->$action($item);
return $this;
}
return parent::__call($method, $args);
}
/**
* Render placeholder as string
*
* @param string|int $indent
* @return string
*/
public function toString($indent = null)
{
$indent = (null !== $indent)
? $this->getWhitespace($indent)
: $this->getIndent();
$items = [];
$this->getContainer()->ksort();
$isHtml5 = $this->view->plugin('doctype')->isHtml5();
try {
foreach ($this as $item) {
$content = $this->itemToString($item);
if ($isHtml5 && $item->type == 'charset') {
array_unshift($items, $content);
continue;
}
$items[] = $content;
}
} catch (Exception\InvalidArgumentException $e) {
trigger_error($e->getMessage(), E_USER_WARNING);
return '';
}
return $indent . implode($this->escape($this->getSeparator()) . $indent, $items);
}
/**
* Create data item for inserting into stack
*
* @param string $type
* @param string $typeValue
* @param string $content
* @param array $modifiers
* @return stdClass
*/
public function createData($type, $typeValue, $content, array $modifiers)
{
$data = new stdClass;
$data->type = $type;
$data->$type = $typeValue;
$data->content = $content;
$data->modifiers = $modifiers;
return $data;
}
/**
* Build meta HTML string
*
* @param stdClass $item
* @throws Exception\InvalidArgumentException
* @return string
*/
public function itemToString(stdClass $item)
{
if (! in_array($item->type, $this->typeKeys)) {
throw new Exception\InvalidArgumentException(sprintf(
'Invalid type "%s" provided for meta',
$item->type
));
}
$type = $item->type;
$modifiersString = '';
foreach ($item->modifiers as $key => $value) {
if ($this->view->plugin('doctype')->isHtml5()
&& $key == 'scheme'
) {
throw new Exception\InvalidArgumentException(
'Invalid modifier "scheme" provided; not supported by HTML5'
);
}
if (! in_array($key, $this->modifierKeys)) {
continue;
}
$modifiersString .= $key . '="' . $this->escape($value) . '" ';
}
$modifiersString = rtrim($modifiersString);
if ('' != $modifiersString) {
$modifiersString = ' ' . $modifiersString;
}
if (method_exists($this->view, 'plugin')) {
if ($this->view->plugin('doctype')->isHtml5()
&& $type == 'charset'
) {
$tpl = ($this->view->plugin('doctype')->isXhtml())
? '<meta %s="%s"/>'
: '<meta %s="%s">';
} elseif ($this->view->plugin('doctype')->isXhtml()) {
$tpl = '<meta %s="%s" content="%s"%s />';
} else {
$tpl = '<meta %s="%s" content="%s"%s>';
}
} else {
$tpl = '<meta %s="%s" content="%s"%s />';
}
$meta = sprintf(
$tpl,
$type,
$this->escape($item->$type),
$this->escape($item->content),
$modifiersString
);
if (isset($item->modifiers['conditional'])
&& ! empty($item->modifiers['conditional'])
&& is_string($item->modifiers['conditional'])
) {
// inner wrap with comment end and start if !IE
if (str_replace(' ', '', $item->modifiers['conditional']) === '!IE') {
$meta = '<!-->' . $meta . '<!--';
}
$meta = '<!--[if ' . $this->escape($item->modifiers['conditional']) . ']>' . $meta . '<![endif]-->';
}
return $meta;
}
/**
* Normalize type attribute of meta
*
* @param string $type type in CamelCase
* @throws Exception\DomainException
* @return string
*/
protected function normalizeType($type)
{
switch ($type) {
case 'Name':
return 'name';
case 'HttpEquiv':
return 'http-equiv';
case 'Property':
return 'property';
case 'Itemprop':
return 'itemprop';
default:
throw new Exception\DomainException(sprintf(
'Invalid type "%s" passed to normalizeType',
$type
));
}
}
/**
* Determine if item is valid
*
* @param stdClass $item
* @return bool
*/
protected function isValid($item)
{
if ((! $item instanceof stdClass)
|| ! isset($item->type)
|| ! isset($item->modifiers)
) {
return false;
}
$doctype = $this->view->plugin('doctype');
if ($item->type === 'charset' && $doctype->isXhtml()) {
return false;
}
if (! isset($item->content)
&& (! $doctype->isHtml5()
|| (! $doctype->isHtml5() && $item->type !== 'charset'))
) {
return false;
}
// <meta itemprop= ... /> is only supported with doctype html
if (! $doctype->isHtml5()
&& $item->type === 'itemprop'
) {
return false;
}
// <meta property= ... /> is only supported with doctype RDFa
if (! $doctype->isRdfa()
&& $item->type === 'property'
) {
return false;
}
return true;
}
/**
* Append
*
* @param stdClass $value
* @return View\Helper\Placeholder\Container\AbstractContainer
* @throws Exception\InvalidArgumentException
*/
public function append($value)
{
if (! $this->isValid($value)) {
throw new Exception\InvalidArgumentException(
'Invalid value passed to append'
);
}
return $this->getContainer()->append($value);
}
/**
* OffsetSet
*
* @param string|int $index
* @param string $value
* @throws Exception\InvalidArgumentException
*/
public function offsetSet($index, $value)
{
if (! $this->isValid($value)) {
throw new Exception\InvalidArgumentException(
'Invalid value passed to offsetSet; please use offsetSetName() or offsetSetHttpEquiv()'
);
}
return $this->getContainer()->offsetSet($index, $value);
}
/**
* OffsetUnset
*
* @param string|int $index
* @throws Exception\InvalidArgumentException
*/
public function offsetUnset($index)
{
if (! in_array($index, $this->getContainer()->getKeys())) {
throw new Exception\InvalidArgumentException('Invalid index passed to offsetUnset()');
}
return $this->getContainer()->offsetUnset($index);
}
/**
* Prepend
*
* @param stdClass $value
* @throws Exception\InvalidArgumentException
* @return View\Helper\Placeholder\Container\AbstractContainer
*/
public function prepend($value)
{
if (! $this->isValid($value)) {
throw new Exception\InvalidArgumentException(
'Invalid value passed to prepend'
);
}
return $this->getContainer()->prepend($value);
}
/**
* Set
*
* @param stdClass $value
* @throws Exception\InvalidArgumentException
* @return View\Helper\Placeholder\Container\AbstractContainer
*/
public function set($value)
{
if (! $this->isValid($value)) {
throw new Exception\InvalidArgumentException('Invalid value passed to set');
}
$container = $this->getContainer();
foreach ($container->getArrayCopy() as $index => $item) {
if ($item->type == $value->type && $item->{$item->type} == $value->{$value->type}) {
$this->offsetUnset($index);
}
}
return $this->append($value);
}
/**
* Create an HTML5-style meta charset tag. Something like <meta charset="utf-8">
*
* Not valid in a non-HTML5 doctype
*
* @param string $charset
* @param Exception\InvalidArgumentException
* @return HeadMeta Provides a fluent interface
*/
public function setCharset($charset)
{
$item = new stdClass;
$item->type = 'charset';
$item->charset = $charset;
$item->content = null;
$item->modifiers = [];
if (! $this->isValid($item)) {
throw new Exception\InvalidArgumentException(
'XHTML* doctype has no attribute charset; please use appendHttpEquiv()'
);
}
$this->set($item);
return $this;
}
}