Helper for setting and retrieving title element for HTML head

 Methods

Overload

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

Proxy to container methods

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractStandalone::__call()

Parameters

$method

string

$args

array

Exceptions

\Zend\View\Exception\BadMethodCallException

Returns

mixed

Constructor

__construct() 
Inherited

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractStandalone::__construct()

Overloading: retrieve property

__get(string $key) : mixed
Inherited

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractStandalone::__get()

Parameters

$key

string

Returns

mixed

Retrieve placeholder for title element and optionally set state

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

Parameters

$title

string

$setType

string

Returns

Overloading: check if property is set

__isset(string $key) : bool
Inherited

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractStandalone::__isset()

Parameters

$key

string

Returns

bool

Overloading: set property value

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

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractStandalone::__set()

Parameters

$key

string

$value

mixed

Cast to string representation

__toString() : string
Inherited

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractStandalone::__toString()

Returns

string

Overloading: unset property

__unset(string $key) : void
Inherited

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractStandalone::__unset()

Parameters

$key

string

Countable

count() : int
Inherited

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractStandalone::count()

Returns

int

Return whether autoEscaping is enabled or disabled

getAutoEscape() 
Inherited

return bool

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractStandalone::getAutoEscape()

Retrieve placeholder container

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

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractStandalone::getContainer()

Returns

Get the default attach order, if any.

getDefaultAttachOrder() : mixed

Returns

mixed

Get Escaper instance

getEscaper(string | null $enc) : mixed
Inherited

Lazy-loads one if none available

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractStandalone::getEscaper()

Parameters

$enc

stringnull

Encoding to use

Returns

mixed

IteratorAggregate: get Iterator

getIterator() : \Iterator
Inherited

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractStandalone::getIterator()

Returns

\Iterator

Retrieve registry

getRegistry() : \Zend\View\Helper\Placeholder\Registry
Inherited

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractStandalone::getRegistry()

Returns

Returns translator used in helper

getTranslator() : \Zend\I18n\Translator\Translator | null

Return the translation text domain

getTranslatorTextDomain() : string

Returns

string

Get the view object

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

inherited_from \Zend\View\Helper\AbstractHelper::getView()
inherited_from \Zend\View\Helper\Placeholder\Container\AbstractStandalone::getView()

Returns

Checks if the helper has a translator

hasTranslator() : bool

Returns

bool

Returns whether translator is enabled and should be used

isTranslatorEnabled() : bool

Returns

bool

ArrayAccess: offsetExists

offsetExists(string | int $offset) : bool
Inherited

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractStandalone::offsetExists()

Parameters

$offset

stringint

Returns

bool

ArrayAccess: offsetGet

offsetGet(string | int $offset) : mixed
Inherited

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractStandalone::offsetGet()

Parameters

$offset

stringint

Returns

mixed

ArrayAccess: offsetSet

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

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractStandalone::offsetSet()

Parameters

$offset

stringint

$value

mixed

ArrayAccess: offsetUnset

offsetUnset(string | int $offset) : void
Inherited

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractStandalone::offsetUnset()

Parameters

$offset

stringint

Set whether or not auto escaping should be used

setAutoEscape(bool $autoEscape) : \Zend\View\Helper\Placeholder\Container\AbstractStandalone
Inherited

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractStandalone::setAutoEscape()

Parameters

$autoEscape

bool

whether or not to auto escape output

Returns

Set container on which to operate

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

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractStandalone::setContainer()

Parameters

Returns

Set a default order to add titles

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

Parameters

$setType

string

Exceptions

\Zend\View\Exception\DomainException

Returns

Set Escaper instance

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

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractStandalone::setEscaper()

Parameters

Returns

Set registry object

setRegistry(\Zend\View\Helper\Placeholder\Registry $registry) : \Zend\View\Helper\Placeholder\Container\AbstractStandalone
Inherited

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractStandalone::setRegistry()

Parameters

Returns

Sets translator to use in helper

setTranslator(\Zend\I18n\Translator\Translator $translator, string $textDomain) : \Zend\View\Helper\HeadTitle

Parameters

$translator

\Zend\I18n\Translator\Translator

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

$textDomain

string

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

Returns

Sets whether translator is enabled and should be used

setTranslatorEnabled(bool $enabled) : \Zend\View\Helper\HeadTitle

Parameters

$enabled

bool

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

Returns

Set translation text domain

setTranslatorTextDomain(string $textDomain) : \Zend\View\Helper\HeadTitle

Parameters

$textDomain

string

Returns

Set the View object

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

inherited_from \Zend\View\Helper\AbstractHelper::setView()
inherited_from \Zend\View\Helper\Placeholder\Container\AbstractStandalone::setView()

Parameters

Returns

Turn helper into string

toString(string | null $indent) : string

Parameters

$indent

stringnull

Returns

string

Escape a string

escape(string $string) : string
Inherited

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractStandalone::escape()

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 : bool
Inherited

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractStandalone::$$autoEscape
 

$container

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

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractStandalone::$$container
 

Default title rendering order (i.e.

$defaultAttachOrder : string

order in which each title attached)

 

$escapers

$escapers : \Zend\Escaper\Escaper[]
Inherited

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractStandalone::$$escapers
 

Registry key for placeholder

$regKey : string

 

$registry

$registry : \Zend\View\Helper\Placeholder\Registry
Inherited

inherited_from \Zend\View\Helper\Placeholder\Container\AbstractStandalone::$$registry
 

Translator (optional)

$translator : \Zend\I18n\Translator\Translator

 

Whether translator should be used

$translatorEnabled : bool

 

Translator text domain (optional)

$translatorTextDomain : string

 

View object

$view : \Zend\View\Renderer\RendererInterface
Inherited

inherited_from \Zend\View\Helper\AbstractHelper::$$view
inherited_from \Zend\View\Helper\Placeholder\Container\AbstractStandalone::$$view