View/Helper/HeadMeta.php
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
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

\book $_autoEscape = trueFlag 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::$$_autoEscapetrueDetails- Type
- \book
- Inherited_from
- \Zend_View_Helper_Placeholder_Container_Standalone::$$_autoEscape

\Zend_View_Helper_Placeholder_Container_Abstract $_container = 
string $_regKey = 'Zend_View_Helper_HeadMeta'Registry key under which container registers itself
'Zend_View_Helper_HeadMeta'Details- Type
- string

\Zend_View_Helper_Placeholder_Registry $_registry = 
array $_typeKeys = array('name', 'http-equiv', 'charset', 'property')Types of attributes
array('name', 'http-equiv', 'charset', 'property')Details- Type
- array

\Zend_View_Interface $view = nullView object
Inherited from: \Zend_View_Helper_Abstract::$$view\Zend_View_Helper_Placeholder_Container_Standalone::$$viewnullDetails- Type
- \Zend_View_Interface
- Inherited_from
- \Zend_View_Helper_Abstract::$$view
- Inherited_from
- \Zend_View_Helper_Placeholder_Container_Standalone::$$view
Methods

__call(string $method, array $args) : \Zend_View_Helper_HeadMetaOverload 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())
| Name | Type | Description |
|---|---|---|
| $method | string | |
| $args | array |
| Type | Description |
|---|---|
| \Zend_View_Helper_HeadMeta |

__get(string $key) : mixedOverloading: retrieve property
Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__get()| Name | Type | Description |
|---|---|---|
| $key | string |
| Type | Description |
|---|---|
| mixed |

__isset(string $key) : boolOverloading: check if property is set
Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__isset()| Name | Type | Description |
|---|---|---|
| $key | string |
| Type | Description |
|---|---|
| bool |

__set(string $key, mixed $value) : voidOverloading: set property value
Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__set()| Name | Type | Description |
|---|---|---|
| $key | string | |
| $value | mixed |

__toString() : stringCast to string representation
Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__toString()| Type | Description |
|---|---|
| string |

__unset(string $key) : voidOverloading: unset property
Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__unset()| Name | Type | Description |
|---|---|---|
| $key | string |

_escape(string $string) : stringEscape a string
Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::_escape()| Name | Type | Description |
|---|---|---|
| $string | string |
| Type | Description |
|---|---|
| string |

_isValid(mixed $item) : booleanDetermine if item is valid
| Name | Type | Description |
|---|---|---|
| $item | mixed |
| Type | Description |
|---|---|
| boolean |

append(string $value) : voidAppend
| Name | Type | Description |
|---|---|---|
| $value | string |
| Exception | Description |
|---|---|
| \Zend_View_Exception |

createData(string $type, string $typeValue, string $content, array $modifiers) : \stdClassCreate data item for inserting into stack
| Name | Type | Description |
|---|---|---|
| $type | string | |
| $typeValue | string | |
| $content | string | |
| $modifiers | array |
| Type | Description |
|---|---|
| \stdClass |

direct() : voidStrategy pattern: currently unutilized
Inherited from: \Zend_View_Helper_Abstract::direct()\Zend_View_Helper_Placeholder_Container_Standalone::direct()
getAutoEscape() : voidReturn whether autoEscaping is enabled or disabled
Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::getAutoEscape()return bool

getContainer() : \Zend_View_Helper_Placeholder_Container_AbstractRetrieve placeholder container
Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::getContainer()| Type | Description |
|---|---|
| \Zend_View_Helper_Placeholder_Container_Abstract |

getIterator() : \IteratorIteratorAggregate: get Iterator
Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::getIterator()| Type | Description |
|---|---|
| \Iterator |

getRegistry() : \Zend_View_Helper_Placeholder_RegistryRetrieve registry
Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::getRegistry()| Type | Description |
|---|---|
| \Zend_View_Helper_Placeholder_Registry |

headMeta(string $content = null, string $keyValue = null, string $keyType = 'name', array $modifiers = array(), string $placement = \Zend_View_Helper_Placeholder_Container_Abstract::APPEND) : \Zend_View_Helper_HeadMetaRetrieve object instance; optionally add meta tag
| Name | Type | Description |
|---|---|---|
| $content | string | |
| $keyValue | string | |
| $keyType | string | |
| $modifiers | array | |
| $placement | string |
| Type | Description |
|---|---|
| \Zend_View_Helper_HeadMeta |

itemToString( $item) : stringBuild meta HTML string
| Name | Type | Description |
|---|---|---|
| $item |
| Type | Description |
|---|---|
| string |

offsetExists(string | int $offset) : boolArrayAccess: offsetExists
Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::offsetExists()| Name | Type | Description |
|---|---|---|
| $offset | string | int |
| Type | Description |
|---|---|
| bool |

offsetGet(string | int $offset) : mixedArrayAccess: offsetGet
Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::offsetGet()| Name | Type | Description |
|---|---|---|
| $offset | string | int |
| Type | Description |
|---|---|
| mixed |

offsetSet(string | int $index, string $value) : voidOffsetSet
| Name | Type | Description |
|---|---|---|
| $index | string | int | |
| $value | string |
| Exception | Description |
|---|---|
| \Zend_View_Exception |

offsetUnset(string | int $index) : voidOffsetUnset
| Name | Type | Description |
|---|---|---|
| $index | string | int |
| Exception | Description |
|---|---|
| \Zend_View_Exception |

prepend(string $value) : voidPrepend
| Name | Type | Description |
|---|---|---|
| $value | string |
| Exception | Description |
|---|---|
| \Zend_View_Exception |

set(string $value) : voidSet
| Name | Type | Description |
|---|---|---|
| $value | string |
| Exception | Description |
|---|---|
| \Zend_View_Exception |

setAutoEscape(bool $autoEscape = true) : \Zend_View_Helper_Placeholder_Container_StandaloneSet whether or not auto escaping should be used
Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::setAutoEscape()| Name | Type | Description |
|---|---|---|
| $autoEscape | bool | whether or not to auto escape output |
| Type | Description |
|---|---|
| \Zend_View_Helper_Placeholder_Container_Standalone |

setCharset(string $charset) : \Zend_View_Helper_HeadMetaCreate an HTML5-style meta charset tag.
Something like
Not valid in a non-HTML5 doctype
| Name | Type | Description |
|---|---|---|
| $charset | string |
| Type | Description |
|---|---|
| \Zend_View_Helper_HeadMeta | Provides a fluent interface |

setContainer(\Zend_View_Helper_Placeholder_Container_Abstract $container) : \Zend_View_Helper_Placeholder_Container_StandaloneSet container on which to operate
Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::setContainer()| Name | Type | Description |
|---|---|---|
| $container | \Zend_View_Helper_Placeholder_Container_Abstract |
| Type | Description |
|---|---|
| \Zend_View_Helper_Placeholder_Container_Standalone |

setRegistry(\Zend_View_Helper_Placeholder_Registry $registry) : \Zend_View_Helper_Placeholder_Container_StandaloneSet registry object
Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::setRegistry()| Name | Type | Description |
|---|---|---|
| $registry | \Zend_View_Helper_Placeholder_Registry |
| Type | Description |
|---|---|
| \Zend_View_Helper_Placeholder_Container_Standalone |

setView(\Zend_View_Interface $view) : \Zend_View_Helper_AbstractSet the View object
Inherited from: \Zend_View_Helper_Abstract::setView()\Zend_View_Helper_Placeholder_Container_Standalone::setView()| Name | Type | Description |
|---|---|---|
| $view | \Zend_View_Interface |
| Type | Description |
|---|---|
| \Zend_View_Helper_Abstract |