Helper for setting and retrieving title element for HTML head

uses
package Zend_View
subpackage Helper
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License
inherited_from \Zend_View_Helper_Placeholder_Container_Standalone

 Methods

Overload

__call(string $method, array $args) : mixed
Inherited

Proxy to container methods

Parameters

$method

string

$args

array

Returns

mixed

Constructor

__construct() : void
Inherited

Overloading: retrieve property

__get(string $key) : mixed
Inherited

Parameters

$key

string

Returns

mixed

Overloading: check if property is set

__isset(string $key) : boolean
Inherited

Parameters

$key

string

Returns

boolean

Overloading: set property value

__set(string $key, mixed $value) : void
Inherited

Parameters

$key

string

$value

mixed

Cast to string representation

__toString() : string
Inherited

Returns

string

Overloading: unset property

__unset(string $key) : void
Inherited

Parameters

$key

string

Countable

count() : integer
Inherited

Returns

integer

Strategy pattern: currently unutilized

direct() : void
Inherited
inherited_from \Zend_View_Helper_Interface::direct()

Disables translation

disableTranslation() : \Zend_View_Helper_HeadTitle

Returns

\Zend_View_Helper_HeadTitle

Enables translation

enableTranslation() : \Zend_View_Helper_HeadTitle

Returns

\Zend_View_Helper_HeadTitle

Return whether autoEscaping is enabled or disabled

getAutoEscape() 
Inherited

return bool

Retrieve placeholder container

getContainer() : \Zend_View_Helper_Placeholder_Container_Abstract
Inherited

Returns

\Zend_View_Helper_Placeholder_Container_Abstract

Get the default attach order, if any.

getDefaultAttachOrder() : mixed

Returns

mixed

IteratorAggregate: get Iterator

getIterator() : \Iterator
Inherited

Returns

\Iterator

Retrieve registry

getRegistry() : \Zend_View_Helper_Placeholder_Registry
Inherited

Returns

\Zend_View_Helper_Placeholder_Registry

Retrieve translation object

getTranslator() : \Zend_Translate_Adapter | null

If none is currently registered, attempts to pull it from the registry using the key 'Zend_Translate'.

Returns

\Zend_Translate_Adapternull

Retrieve placeholder for title element and optionally set state

headTitle(string $title = null, string $setType = null) : \Zend_View_Helper_HeadTitle

Parameters

$title

string

$setType

string

Returns

\Zend_View_Helper_HeadTitle

ArrayAccess: offsetExists

offsetExists(string|integer $offset) : boolean
Inherited

Parameters

$offset

stringinteger

Returns

boolean

ArrayAccess: offsetGet

offsetGet(string|integer $offset) : mixed
Inherited

Parameters

$offset

stringinteger

Returns

mixed

ArrayAccess: offsetSet

offsetSet(string|integer $offset, mixed $value) : void
Inherited

Parameters

$offset

stringinteger

$value

mixed

ArrayAccess: offsetUnset

offsetUnset(string|integer $offset) : void
Inherited

Parameters

$offset

stringinteger

Set whether or not auto escaping should be used

setAutoEscape(boolean $autoEscape = true) : \Zend_View_Helper_Placeholder_Container_Standalone
Inherited

Parameters

$autoEscape

boolean

whether or not to auto escape output

Returns

\Zend_View_Helper_Placeholder_Container_Standalone

Set container on which to operate

setContainer(\Zend_View_Helper_Placeholder_Container_Abstract $container) : \Zend_View_Helper_Placeholder_Container_Standalone
Inherited

Parameters

$container

\Zend_View_Helper_Placeholder_Container_Abstract

Returns

\Zend_View_Helper_Placeholder_Container_Standalone

Set a default order to add titles

setDefaultAttachOrder(string $setType) 

Parameters

$setType

string

Set registry object

setRegistry(\Zend_View_Helper_Placeholder_Registry $registry) : \Zend_View_Helper_Placeholder_Container_Standalone
Inherited

Parameters

$registry

\Zend_View_Helper_Placeholder_Registry

Returns

\Zend_View_Helper_Placeholder_Container_Standalone

Sets a translation Adapter for translation

setTranslator(\Zend_Translate|\Zend_Translate_Adapter $translate) : \Zend_View_Helper_HeadTitle

Parameters

$translate

\Zend_Translate\Zend_Translate_Adapter

Returns

\Zend_View_Helper_HeadTitle

Set the View object

setView(\Zend_View_Interface $view) : \Zend_View_Helper_Abstract
Inherited
inherited_from \Zend_View_Helper_Interface::setView()

Parameters

$view

\Zend_View_Interface

Returns

\Zend_View_Helper_Abstract

Turn helper into string

toString(string|null $indent = null, string|null $locale = null) : string
inherited_from \Zend_View_Helper_Placeholder_Container_Standalone::toString()

Parameters

$indent

stringnull

$locale

stringnull

Returns

string

String representation

toString() : string
Inherited

Returns

string

Escape a string

_escape(string $string) : string
Inherited

Parameters

$string

string

Returns

string

 Properties

 

View object

$view : \Zend_View_Interface

Default

null
 

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

$_autoEscape : \book

Default

true
 

$_container

$_container : \Zend_View_Helper_Placeholder_Container_Abstract

Default

 

Default title rendering order (i.e. order in which each title attached)

$_defaultAttachOrder : string

Default

null
 

Registry key for placeholder

$_regKey : string

Default

'Zend_View_Helper_HeadTitle'
inherited_from \Zend_View_Helper_Placeholder_Container_Standalone::_regKey
 

Registry key under which container registers itself

$_regKey : string

Default

 

$_registry

$_registry : \Zend_View_Helper_Placeholder_Registry

Default

 

Whether or not auto-translation is enabled

$_translate : boolean

Default

false
 

Translation object

$_translator : \Zend_Translate_Adapter

Default