API Documentation

Zend/View/Helper/HeadTitle.php

Show: inherited
Table of Contents

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 license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_View  
Subpackage
Helper  
Version
$Id: HeadTitle.php 24594 2012-01-05 21:27:01Z matthew $  

\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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Uses
\Zend_View_Helper_Placeholder_Container_Standalone  

Properties

Propertyprotectedstring  $_defaultAttachOrder= 'null'

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

Default valuenullDetails
Type
string
Propertyprotectedstring  $_regKey= ''Zend_View_Helper_HeadTitle''

Registry key for placeholder

Default value'Zend_View_Helper_HeadTitle'Details
Type
string
Propertyprotectedboolean  $_translate= 'false'

Whether or not auto-translation is enabled

Default valuefalseDetails
Type
boolean
Propertyprotected\Zend_Translate_Adapter  $_translator= ''

Translation object

Methods

methodpublicdisableTranslation( ) : \Zend_View_Helper_HeadTitle

Disables translation

Returns
Type Description
\Zend_View_Helper_HeadTitle
methodpublicenableTranslation( ) : \Zend_View_Helper_HeadTitle

Enables translation

Returns
Type Description
\Zend_View_Helper_HeadTitle
methodpublicgetDefaultAttachOrder( ) : mixed

Get the default attach order, if any.

Returns
Type Description
mixed
methodpublicgetTranslator( ) : \Zend_Translate_Adapter|null

Retrieve 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
methodpublicheadTitle( string $title = null, string $setType = null ) : \Zend_View_Helper_HeadTitle

Retrieve placeholder for title element and optionally set state

Parameters
Name Type Description
$title string
$setType string
Returns
Type Description
\Zend_View_Helper_HeadTitle
methodpublicsetDefaultAttachOrder( string $setType ) : void

Set a default order to add titles

Parameters
Name Type Description
$setType string
methodpublicsetTranslator( \Zend_Translate|\Zend_Translate_Adapter $translate ) : \Zend_View_Helper_HeadTitle

Sets a translation Adapter for translation

Parameters
Name Type Description
$translate \Zend_Translate|\Zend_Translate_Adapter
Returns
Type Description
\Zend_View_Helper_HeadTitle
methodpublictoString( string|null $indent = null, string|null $locale = null ) : string

Turn helper into string

Parameters
Name Type Description
$indent string|null
$locale string|null
Returns
Type Description
string
Documentation was generated by DocBlox 0.15.1.