View/Helper/HeadMeta.php

Show: inherited
Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_View  
Subpackage
Helper  
Version
$Id: HeadMeta.php 24776 2012-05-08 18:36:40Z adamlundrigan $  

\Zend_View_Helper_HeadMeta

Package: Zend\View\Helper

Zend_Layout_View_Helper_HeadMeta

Parent(s)
\Zend_View_Helper_Placeholder_Container_Standalone < \Zend_View_Helper_Abstract
See
\global\http://www.w3.org/TR/xhtml1/dtds.html  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Uses
\global\Zend_View_Helper_Placeholder_Container_Standalone  

Properties

Propertyprotected\book $_autoEscape = true
inherited

Flag wheter to automatically escape output, must also be enforced in the child class if __toString/toString is overriden

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::$$_autoEscape
Default valuetrueDetails
Type
\book
Inherited_from
\Zend_View_Helper_Placeholder_Container_Standalone::$$_autoEscape  
Propertyprotected\Zend_View_Helper_Placeholder_Container_Abstract $_container =
Propertyprotected$_modifierKeys = array('lang', 'scheme')
Default valuearray('lang', 'scheme')Details
Type
n/a
Propertyprotectedstring $_regKey = 'Zend_View_Helper_HeadMeta'
<p>registry key</p>

Registry key under which container registers itself

Default value'Zend_View_Helper_HeadMeta'Details
Type
string
Propertyprotected\Zend_View_Helper_Placeholder_Registry $_registry =
Propertyprotected$_requiredKeys = array('content')
Default valuearray('content')Details
Type
n/a
Propertyprotectedarray $_typeKeys = array('name', 'http-equiv', 'charset', 'property')

Types of attributes

Default valuearray('name', 'http-equiv', 'charset', 'property')Details
Type
array
Propertypublic\Zend_View_Interface $view = null

Methods

methodpublic__call(string $method, array $args) : \Zend_View_Helper_HeadMeta

Overload method access

Allows the following 'virtual' methods: - appendName($keyValue, $content, $modifiers = array()) - offsetGetName($index, $keyValue, $content, $modifers = array()) - prependName($keyValue, $content, $modifiers = array()) - setName($keyValue, $content, $modifiers = array()) - appendHttpEquiv($keyValue, $content, $modifiers = array()) - offsetGetHttpEquiv($index, $keyValue, $content, $modifers = array()) - prependHttpEquiv($keyValue, $content, $modifiers = array()) - setHttpEquiv($keyValue, $content, $modifiers = array()) - appendProperty($keyValue, $content, $modifiers = array()) - offsetGetProperty($index, $keyValue, $content, $modifiers = array()) - prependProperty($keyValue, $content, $modifiers = array()) - setProperty($keyValue, $content, $modifiers = array())

Parameters
Name Type Description
$method string
$args array
Returns
Type Description
\Zend_View_Helper_HeadMeta
methodpublic__construct() : void

Constructor

Set separator to PHP_EOL

methodpublic__get(string $key) : mixed
inherited

Overloading: retrieve property

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__get()
Parameters
Name Type Description
$key string
Returns
Type Description
mixed
methodpublic__isset(string $key) : bool
inherited

Overloading: check if property is set

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__isset()
Parameters
Name Type Description
$key string
Returns
Type Description
bool
methodpublic__set(string $key, mixed $value) : void
inherited

Overloading: set property value

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__set()
Parameters
Name Type Description
$key string
$value mixed
methodpublic__toString() : string
inherited

Cast to string representation

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__toString()
Returns
Type Description
string
methodpublic__unset(string $key) : void
inherited

Overloading: unset property

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__unset()
Parameters
Name Type Description
$key string
methodprotected_escape(string $string) : string
inherited

Escape a string

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::_escape()
Parameters
Name Type Description
$string string
Returns
Type Description
string
methodprotected_isValid(mixed $item) : boolean

Determine if item is valid

Parameters
Name Type Description
$item mixed
Returns
Type Description
boolean
methodprotected_normalizeType( $type) : void

Parameters
Name Type Description
$type
methodpublicappend(string $value) : void

Append

Parameters
Name Type Description
$value string
Throws
Exception Description
\Zend_View_Exception
methodpubliccount() : int
Returns
Type Description
int
methodpubliccreateData(string $type, string $typeValue, string $content, array $modifiers) : \stdClass

Create data item for inserting into stack

Parameters
Name Type Description
$type string
$typeValue string
$content string
$modifiers array
Returns
Type Description
\stdClass
methodpublicdirect() : void
inherited

Strategy pattern: currently unutilized

Inherited from: \Zend_View_Helper_Abstract::direct()\Zend_View_Helper_Placeholder_Container_Standalone::direct()
methodpublicgetAutoEscape() : void
inherited

Return whether autoEscaping is enabled or disabled

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::getAutoEscape()

return bool

methodpublicgetIterator() : \Iterator
inherited

IteratorAggregate: get Iterator

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::getIterator()
Returns
Type Description
\Iterator
methodpublicheadMeta(string $content = null, string $keyValue = null, string $keyType = 'name', array $modifiers = array(), string $placement = \Zend_View_Helper_Placeholder_Container_Abstract::APPEND) : \Zend_View_Helper_HeadMeta

Retrieve object instance; optionally add meta tag

Parameters
Name Type Description
$content string
$keyValue string
$keyType string
$modifiers array
$placement string
Returns
Type Description
\Zend_View_Helper_HeadMeta
methodpublicitemToString( $item) : string

Build meta HTML string

Parameters
Name Type Description
$item
Returns
Type Description
string
methodpublicoffsetExists(string | int $offset) : bool
inherited

ArrayAccess: offsetExists

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::offsetExists()
Parameters
Name Type Description
$offset string | int
Returns
Type Description
bool
methodpublicoffsetGet(string | int $offset) : mixed
inherited

ArrayAccess: offsetGet

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::offsetGet()
Parameters
Name Type Description
$offset string | int
Returns
Type Description
mixed
methodpublicoffsetSet(string | int $index, string $value) : void

OffsetSet

Parameters
Name Type Description
$index string | int
$value string
Throws
Exception Description
\Zend_View_Exception
methodpublicoffsetUnset(string | int $index) : void

OffsetUnset

Parameters
Name Type Description
$index string | int
Throws
Exception Description
\Zend_View_Exception
methodpublicprepend(string $value) : void

Prepend

Parameters
Name Type Description
$value string
Throws
Exception Description
\Zend_View_Exception
methodpublicset(string $value) : void

Set

Parameters
Name Type Description
$value string
Throws
Exception Description
\Zend_View_Exception
methodpublicsetAutoEscape(bool $autoEscape = true) : \Zend_View_Helper_Placeholder_Container_Standalone
inherited

Set whether or not auto escaping should be used

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::setAutoEscape()
Parameters
Name Type Description
$autoEscape bool

whether or not to auto escape output

Returns
Type Description
\Zend_View_Helper_Placeholder_Container_Standalone
methodpublicsetCharset(string $charset) : \Zend_View_Helper_HeadMeta

Create an HTML5-style meta charset tag.

Something like

Not valid in a non-HTML5 doctype

Parameters
Name Type Description
$charset string
Returns
Type Description
\Zend_View_Helper_HeadMeta Provides a fluent interface
methodpublicsetView(\Zend_View_Interface $view) : \Zend_View_Helper_Abstract
Parameters
Name Type Description
$view \Zend_View_Interface
Returns
Type Description
\Zend_View_Helper_Abstract
methodpublictoString(string | int $indent = null) : string

Render placeholder as string

Parameters
Name Type Description
$indent string | int
Returns
Type Description
string
Documentation was generated by phpDocumentor 2.0.0a8.