Helper for setting and retrieving title element for HTML head

package Default
inherited_from \Zend\View\Helper\Placeholder\Container\AbstractStandalone

 Methods

Overload

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

Proxy to container methods

Parameters

$method

string

$args

array

Exceptions

\Zend\View\Exception\BadMethodCallException

Returns

mixed

Constructor

__construct() 
Inherited

Overloading: retrieve property

__get(string $key) : mixed
Inherited

Parameters

$key

string

Returns

mixed

Retrieve placeholder for title element and optionally set state

__invoke(string $title = null, string $setType = null) : \Zend\View\Helper\HeadTitle

Parameters

$title

string

$setType

string

Returns

\Zend\View\Helper\HeadTitle

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

Delete a container

deleteContainer() : boolean
Inherited

Returns

boolean

Return whether autoEscaping is enabled or disabled

getAutoEscape() 
Inherited

return bool

Retrieve placeholder container

getContainer() : \Zend\View\Helper\Placeholder\Container\AbstractContainer
Inherited

Returns

\Zend\View\Helper\Placeholder\Container\AbstractContainer

Retrieve the container class

getContainerClass() : string
Inherited

Returns

string

Get the default attach order, if any.

getDefaultAttachOrder() : mixed

Returns

mixed

Get Escaper instance

getEscaper(string|null $enc = 'UTF-8') : mixed
Inherited

Lazy-loads one if none available

Parameters

$enc

stringnull

Encoding to use

Returns

mixed

IteratorAggregate: get Iterator

getIterator() : \Iterator
Inherited

Returns

\Iterator

Returns translator used in helper

getTranslator() : \Zend\I18n\Translator\TranslatorInterface | null
inherited_from \Zend\I18n\Translator\TranslatorAwareInterface::getTranslator()

Returns

\Zend\I18n\Translator\TranslatorInterfacenull

Return the translation text domain

getTranslatorTextDomain() : string
inherited_from \Zend\I18n\Translator\TranslatorAwareInterface::getTranslatorTextDomain()

Returns

string

Get the view object

getView() : null | \Zend\View\Renderer\RendererInterface
Inherited
inherited_from \Zend\View\Helper\HelperInterface::getView()

Returns

null\Zend\View\Renderer\RendererInterface

Checks if the helper has a translator

hasTranslator() : boolean
inherited_from \Zend\I18n\Translator\TranslatorAwareInterface::hasTranslator()

Returns

boolean

Returns whether translator is enabled and should be used

isTranslatorEnabled() : boolean
inherited_from \Zend\I18n\Translator\TranslatorAwareInterface::isTranslatorEnabled()

Returns

boolean

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

Render title string

renderTitle() : string

Returns

string

Set whether or not auto escaping should be used

setAutoEscape(boolean $autoEscape = true) : \Zend\View\Helper\Placeholder\Container\AbstractStandalone
Inherited

Parameters

$autoEscape

boolean

whether or not to auto escape output

Returns

\Zend\View\Helper\Placeholder\Container\AbstractStandalone

Set container on which to operate

setContainer(\Zend\View\Helper\Placeholder\Container\AbstractContainer $container) : \Zend\View\Helper\Placeholder\Container\AbstractStandalone
Inherited

Parameters

$container

\Zend\View\Helper\Placeholder\Container\AbstractContainer

Returns

\Zend\View\Helper\Placeholder\Container\AbstractStandalone

Set the container class to use

setContainerClass(string $name) : \Zend\View\Helper\Placeholder\Container\AbstractStandalone
Inherited

Parameters

$name

string

Exceptions

\Zend\View\Exception\InvalidArgumentException
\Zend\View\Exception\DomainException

Returns

\Zend\View\Helper\Placeholder\Container\AbstractStandalone

Set a default order to add titles

setDefaultAttachOrder(string $setType) : \Zend\View\Helper\HeadTitle

Parameters

$setType

string

Exceptions

\Zend\View\Exception\DomainException

Returns

\Zend\View\Helper\HeadTitle

Set Escaper instance

setEscaper(\Zend\Escaper\Escaper $escaper) : \Zend\View\Helper\Placeholder\Container\AbstractStandalone
Inherited

Parameters

$escaper

\Zend\Escaper\Escaper

Returns

\Zend\View\Helper\Placeholder\Container\AbstractStandalone

Sets translator to use in helper

setTranslator(\Zend\I18n\Translator\TranslatorInterface $translator = null, string $textDomain = null) : \Zend\View\Helper\HeadTitle
inherited_from \Zend\I18n\Translator\TranslatorAwareInterface::setTranslator()

Parameters

$translator

\Zend\I18n\Translator\TranslatorInterface

[optional] translator. Default is null, which sets no translator.

$textDomain

string

[optional] text domain Default is null, which skips setTranslatorTextDomain

Returns

\Zend\View\Helper\HeadTitle

Sets whether translator is enabled and should be used

setTranslatorEnabled(boolean $enabled = true) : \Zend\View\Helper\HeadTitle
inherited_from \Zend\I18n\Translator\TranslatorAwareInterface::setTranslatorEnabled()

Parameters

$enabled

boolean

[optional] whether translator should be used. Default is true.

Returns

\Zend\View\Helper\HeadTitle

Set translation text domain

setTranslatorTextDomain(string $textDomain = 'default') : \Zend\View\Helper\HeadTitle
inherited_from \Zend\I18n\Translator\TranslatorAwareInterface::setTranslatorTextDomain()

Parameters

$textDomain

string

Returns

\Zend\View\Helper\HeadTitle

Set the View object

setView(\Zend\View\Renderer\RendererInterface $view) : \Zend\View\Helper\AbstractHelper
Inherited
inherited_from \Zend\View\Helper\HelperInterface::setView()

Parameters

$view

\Zend\View\Renderer\RendererInterface

Returns

\Zend\View\Helper\AbstractHelper

Render title (wrapped by title tag)

toString(string|null $indent = null) : string
inherited_from \Zend\View\Helper\Placeholder\Container\AbstractStandalone::toString()

Parameters

$indent

stringnull

Returns

string

String representation

toString() : string
Inherited

Returns

string

Escape a string

escape(string $string) : string
Inherited

Parameters

$string

string

Returns

string

 Properties

 

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

$autoEscape : boolean

Default

true
 

$container

$container : \Zend\View\Helper\Placeholder\Container\AbstractContainer

Default

 

Default container class

$containerClass : string

Default

'Zend\View\Helper\Placeholder\Container'
 

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

$defaultAttachOrder : string

Default

null
 

$escapers

$escapers : array<mixed,\Zend\Escaper\Escaper>

Default

array()
 

Registry key for placeholder

$regKey : string

Default

'Zend_View_Helper_HeadTitle'
 

Translator (optional)

$translator : \Zend\I18n\Translator\TranslatorInterface

Default

 

Whether translator should be used

$translatorEnabled : boolean

Default

true
 

Translator text domain (optional)

$translatorTextDomain : string

Default

'default'
 

View object instance

$view : \Zend\View\Renderer\RendererInterface

Default

null