View/Helper/HeadTitle.php
Show:
inherited
inherited
Classes
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-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_View
- Subpackage
- Helper
- Version
- $Id$
\Zend_View_Helper_HeadTitle
Package: Zend_View\Helper
Helper for setting and retrieving title element for HTML head
- Parent(s)
- \Zend_View_Helper_Placeholder_Container_Standalone < \Zend_View_Helper_Abstract
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Uses
Properties
string $_defaultAttachOrder = nullDefault title rendering order (i.e. order in which each title attached)
Default value
nullDetails- Type
- string
string $_regKey = 'Zend_View_Helper_HeadTitle'Registry key for placeholder
Default value
'Zend_View_Helper_HeadTitle'Details- Type
- string
boolean $_translate = falseWhether or not auto-translation is enabled
Default value
falseDetails- Type
- boolean
Methods
disableTranslation() : \Zend_View_Helper_HeadTitleDisables translation
Returns
| Type | Description |
|---|---|
| \Zend_View_Helper_HeadTitle |
enableTranslation() : \Zend_View_Helper_HeadTitleEnables translation
Returns
| Type | Description |
|---|---|
| \Zend_View_Helper_HeadTitle |
getDefaultAttachOrder() : mixedGet the default attach order, if any.
Returns
| Type | Description |
|---|---|
| mixed |
getTranslator() : \Zend_Translate_Adapter | nullRetrieve translation object
If none is currently registered, attempts to pull it from the registry
using the key 'Zend_Translate'.
Returns| Type | Description |
|---|---|
| \Zend_Translate_Adapter | null |
headTitle(string $title = null, string $setType = null) : \Zend_View_Helper_HeadTitleRetrieve placeholder for title element and optionally set state
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $title | string | |
| $setType | string |
| Type | Description |
|---|---|
| \Zend_View_Helper_HeadTitle |
setDefaultAttachOrder(string $setType) : voidSet a default order to add titles
Parameters
| Name | Type | Description |
|---|---|---|
| $setType | string |
setTranslator(\Zend_Translate | \Zend_Translate_Adapter $translate) : \Zend_View_Helper_HeadTitleSets a translation Adapter for translation
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $translate | \Zend_Translate | \Zend_Translate_Adapter |
| Type | Description |
|---|---|
| \Zend_View_Helper_HeadTitle |
toString(string | null $indent = null, string | null $locale = null) : stringTurn helper into string
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $indent | string | null | |
| $locale | string | null |
| Type | Description |
|---|---|
| string |