API Documentation

View/Helper/HeadTitle.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_View  
subpackage
Helper  
version
$Id: HeadTitle.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_View_Helper_HeadTitle

Helper for setting and retrieving title element for HTML head

Extends from
\Zend_View_Helper_Placeholder_Container_Standalone
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_View  
subpackage
Helper  
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 valueZend_View_Helper_HeadTitleDetails
Type
string
Propertyprotectedboolean  $_translate= 'false'

Whether or not auto-translation is enabled

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

Translation object

Methods

methodpublic__call( string $method, array $args ) : mixed

Proxy to container methods

Parameters
Name Type Description
$method string
$args array
Returns
Type Description
mixed
methodpublic__construct( ) : void
methodpublic__get( string $key ) : mixed

Overloading: retrieve property

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__get()
Parameters
Name Type Description
$key string
Returns
Type Description
mixed
methodpublic__isset( string $key ) : bool

Overloading: check if property is set

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__isset()
Parameters
Name Type Description
$key string
Returns
Type Description
bool
methodpublic__set( string $key, mixed $value ) : void

Overloading: set property value

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__set()
Parameters
Name Type Description
$key string
$value mixed
methodpublic__toString( ) : string

Cast to string representation

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__toString()
Returns
Type Description
string
methodpublic__unset( string $key ) : void

Overloading: unset property

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__unset()
Parameters
Name Type Description
$key string
methodprotected_escape( string $string ) : string
Parameters
Name Type Description
$string string
Returns
Type Description
string
methodpubliccount( ) : int
Returns
Type Description
int
methodpublicdirect( ) : void

Strategy pattern: currently unutilized

Inherited from: \Zend_View_Helper_Abstract::direct()
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
methodpublicgetAutoEscape( ) : void

Return whether autoEscaping is enabled or disabled

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::getAutoEscape()

return bool

methodpublicgetDefaultAttachOrder( ) : mixed

Get the default attach order, if any.

Returns
Type Description
mixed
methodpublicgetIterator( ) : \Iterator

IteratorAggregate: get Iterator

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::getIterator()
Returns
Type Description
\Iterator
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_Adapternull
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
methodpublicoffsetExists( string|int $offset ) : bool

ArrayAccess: offsetExists

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::offsetExists()
Parameters
Name Type Description
$offset string|int
Returns
Type Description
bool
methodpublicoffsetGet( string|int $offset ) : mixed
Parameters
Name Type Description
$offset string|int
Returns
Type Description
mixed
methodpublicoffsetSet( string|int $offset, mixed $value ) : void
Parameters
Name Type Description
$offset string|int
$value mixed
methodpublicoffsetUnset( string|int $offset ) : void
Parameters
Name Type Description
$offset string|int
methodpublicsetAutoEscape( bool $autoEscape = true ) : \Zend_View_Helper_Placeholder_Container_Standalone

Set whether or not auto escaping should be used

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::setAutoEscape()
Parameters
Name Type Description
$autoEscape bool whether or not to auto escape output
Returns
Type Description
\Zend_View_Helper_Placeholder_Container_Standalone
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
methodpublicsetView( \Zend_View_Interface $view ) : \Zend_View_Helper_Abstract

Set the View object

Inherited from: \Zend_View_Helper_Abstract::setView()
Parameters
Name Type Description
$view \Zend_View_Interface
Returns
Type Description
\Zend_View_Helper_Abstract
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.13.3.