Zend\View\Helper\HeadTitle
Helper for setting and retrieving title element for HTML head
Synopsis
class HeadTitle
extends AbstractStandalone
implements
TranslatorAwareInterface
{
- // members
- protected string $regKey;
- protected string $defaultAttachOrder;
- protected TranslatorInterface $translator;
- protected string $translatorTextDomain;
- protected bool $translatorEnabled;
- // Inherited members from AbstractStandalone
- protected bool $autoEscape;
- protected AbstractContainer $container;
- protected string $containerClass;
- protected array $escapers;
- // Inherited members from AbstractHelper
- protected RendererInterface $view;
- // methods
- public HeadTitle __invoke()
- public string toString()
- public string renderTitle()
- public HeadTitle setDefaultAttachOrder()
- public mixed getDefaultAttachOrder()
- public HeadTitle setTranslator()
- public Translator|null getTranslator()
- public bool hasTranslator()
- public HeadTitle setTranslatorEnabled()
- public bool isTranslatorEnabled()
- public HeadTitle setTranslatorTextDomain()
- public string getTranslatorTextDomain()
- // Inherited methods from AbstractStandalone
- public void __construct()
- public mixed __call()
- public void __set()
- public mixed __get()
- public bool __isset()
- public void __unset()
- public string __toString()
- public string toString()
- protected string escape()
- public AbstractStandalone setAutoEscape()
- public void getAutoEscape()
- public AbstractStandalone setContainer()
- public AbstractContainer getContainer()
- public bool deleteContainer()
- public AbstractStandalone setContainerClass()
- public string getContainerClass()
- public AbstractStandalone setEscaper()
- public mixed getEscaper()
- public int count()
- public bool offsetExists()
- public mixed offsetGet()
- public void offsetSet()
- public void offsetUnset()
- public Iterator getIterator()
- // Inherited methods from AbstractHelper
- public AbstractHelper setView()
- public null|Renderer getView()
Hierarchy
Extends
Implements
Members
protected
- $autoEscape
—
Zend\View\Helper\Placeholder\Container\bool
Flag whether to automatically escape output, must also be enforced in the child class if __toString/toString is overridden - $container — Zend\View\Helper\Placeholder\Container\AbstractContainer
- $containerClass
—
string
Default container class - $defaultAttachOrder
—
string
Default title rendering order (i.e. order in which each title attached) - $escapers — array
- $regKey
—
string
Registry key for placeholder - $translator
—
Zend\I18n\Translator\TranslatorInterface
Translator (optional) - $translatorEnabled
—
Zend\View\Helper\bool
Whether translator should be used - $translatorTextDomain
—
string
Translator text domain (optional) - $view
—
Zend\View\Renderer\RendererInterface
View object instance
Methods
public
- __invoke() — Retrieve placeholder for title element and optionally set state
- getDefaultAttachOrder() — Get the default attach order, if any.
- getTranslator() — Returns translator used in helper
- getTranslatorTextDomain() — Return the translation text domain
- hasTranslator() — Checks if the helper has a translator
- isTranslatorEnabled() — Returns whether translator is enabled and should be used
- renderTitle() — Render title string
- setDefaultAttachOrder() — Set a default order to add titles
- setTranslator() — Sets translator to use in helper
- setTranslatorEnabled() — Sets whether translator is enabled and should be used
- setTranslatorTextDomain() — Set translation text domain
- toString() — Render title (wrapped by title tag)
Inherited from Zend\View\Helper\Placeholder\Container\AbstractStandalone
protected
- escape() — Escape a string
public
- __call() — Overload
- __get() — Overloading: retrieve property
- __isset() — Overloading: check if property is set
- __set() — Overloading: set property value
- __toString() — Cast to string representation
- __unset() — Overloading: unset property
- count() — Countable
- deleteContainer() — Delete a container
- getAutoEscape() — Return whether autoEscaping is enabled or disabled
- getContainer() — Retrieve placeholder container
- getContainerClass() — Retrieve the container class
- getEscaper() — Get Escaper instance
- getIterator() — IteratorAggregate: get Iterator
- offsetExists() — ArrayAccess: offsetExists
- offsetGet() — ArrayAccess: offsetGet
- offsetSet() — ArrayAccess: offsetSet
- offsetUnset() — ArrayAccess: offsetUnset
- setAutoEscape() — Set whether or not auto escaping should be used
- setContainer() — Set container on which to operate
- setContainerClass() — Set the container class to use
- setEscaper() — Set Escaper instance
- toString() — String representation