<?php
/**
* Zend Framework (http://framework.zend.com/)
*
* @link http://github.com/zendframework/zf2 for the canonical source repository
* @copyright Copyright (c) 2005-2014 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 = array('name', 'http-equiv', 'charset', 'property', 'itemprop');
/**
* Required attributes for meta tag
*
* @var array
*/
protected $requiredKeys = array('content');
/**
* Allowed modifier keys
*
* @var array
*/
protected $modifierKeys = array('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 = array(), $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[] = array();
}
$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 = array();
$this->getContainer()->ksort();
try {
foreach ($this as $item) {
$items[] = $this->itemToString($item);
}
} 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']))
{
$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 mixed $item
* @return bool
*/
protected function isValid($item)
{
if ((!$item instanceof stdClass)
|| !isset($item->type)
|| !isset($item->modifiers)
) {
return false;
}
if (!isset($item->content)
&& (! $this->view->plugin('doctype')->isHtml5()
|| (! $this->view->plugin('doctype')->isHtml5() && $item->type !== 'charset'))
) {
return false;
}
// <meta itemprop= ... /> is only supported with doctype html
if (! $this->view->plugin('doctype')->isHtml5()
&& $item->type === 'itemprop'
) {
return false;
}
// <meta property= ... /> is only supported with doctype RDFa
if (!$this->view->plugin('doctype')->isRdfa()
&& $item->type === 'property'
) {
return false;
}
return true;
}
/**
* Append
*
* @param string $value
* @return void
* @throws Exception\InvalidArgumentException
*/
public function append($value)
{
if (!$this->isValid($value)) {
throw new Exception\InvalidArgumentException(
'Invalid value passed to append; please use appendMeta()'
);
}
return $this->getContainer()->append($value);
}
/**
* OffsetSet
*
* @param string|int $index
* @param string $value
* @throws Exception\InvalidArgumentException
* @return void
*/
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
* @return void
*/
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 string $value
* @throws Exception\InvalidArgumentException
* @return void
*/
public function prepend($value)
{
if (!$this->isValid($value)) {
throw new Exception\InvalidArgumentException(
'Invalid value passed to prepend; please use prependMeta()'
);
}
return $this->getContainer()->prepend($value);
}
/**
* Set
*
* @param string $value
* @throws Exception\InvalidArgumentException
* @return void
*/
public function set($value)
{
if (!$this->isValid($value)) {
throw new Exception\InvalidArgumentException('Invalid value passed to set; please use setMeta()');
}
$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
* @return HeadMeta Provides a fluent interface
*/
public function setCharset($charset)
{
$item = new stdClass;
$item->type = 'charset';
$item->charset = $charset;
$item->content = null;
$item->modifiers = array();
$this->set($item);
return $this;
}
}