View/Helper/HeadTitle.php

Show: PublicProtectedPrivateinherited
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 24593 2012-01-05 20:35:02Z matthew $  

\Zend_View_Helper_HeadTitle
jump to top

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
\global\Zend_View_Helper_Placeholder_Container_Standalone  

Properties

>VPropertyprotected\book $_autoEscape = true
inherited
Flag wheter to automatically escape output, must also be enforced in the child class if __toString/toString is overriden
Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::$$_autoEscape
Default valuetrueDetails
Type
\book
Inherited_from
\Zend_View_Helper_Placeholder_Container_Standalone::$$_autoEscape  
>VPropertyprotected\Zend_View_Helper_Placeholder_Container_Abstract $_container
inherited
Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::$$_container
Details
Type
\Zend_View_Helper_Placeholder_Container_Abstract
Inherited_from
\Zend_View_Helper_Placeholder_Container_Standalone::$$_container  
>VPropertyprotectedstring $_defaultAttachOrder = null
Default title rendering order (i.e.

order in which each title attached)

Default valuenullDetails
Type
string
>VPropertyprotectedstring $_regKey = 'Zend_View_Helper_HeadTitle'
Registry key for placeholder
Default value'Zend_View_Helper_HeadTitle'Details
Type
string
>VPropertyprotected\Zend_View_Helper_Placeholder_Registry $_registry
inherited
Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::$$_registry
Details
Type
\Zend_View_Helper_Placeholder_Registry
Inherited_from
\Zend_View_Helper_Placeholder_Container_Standalone::$$_registry  
>VPropertyprotectedboolean $_translate = false
Whether or not auto-translation is enabled
Default valuefalseDetails
Type
boolean
>VPropertyprotected\Zend_Translate_Adapter $_translator
Translation object
Details
Type
\Zend_Translate_Adapter
>VPropertypublic\Zend_View_Interface $view = null
inherited
View object
Inherited from: \Zend_View_Helper_Abstract::$$view\Zend_View_Helper_Placeholder_Container_Standalone::$$view
Default valuenullDetails
Type
\Zend_View_Interface
Inherited_from
\Zend_View_Helper_Abstract::$$view  
Inherited_from
\Zend_View_Helper_Placeholder_Container_Standalone::$$view  

Methods

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

Overload

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__call()

Proxy to container methods

Parameters
NameTypeDescription
$methodstring
$argsarray
Returns
TypeDescription
mixed
methodpublic__construct() : void
inherited

Constructor

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__construct()
methodpublic__get(string $key) : mixed
inherited

Overloading: retrieve property

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__get()
Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
mixed
methodpublic__isset(string $key) : bool
inherited

Overloading: check if property is set

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__isset()
Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
bool
methodpublic__set(string $key, mixed $value) : void
inherited

Overloading: set property value

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__set()
Parameters
NameTypeDescription
$keystring
$valuemixed
methodpublic__toString() : string
inherited

Cast to string representation

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__toString()
Returns
TypeDescription
string
methodpublic__unset(string $key) : void
inherited

Overloading: unset property

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__unset()
Parameters
NameTypeDescription
$keystring
methodprotected_escape(string $string) : string
inherited

Escape a string

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::_escape()
Parameters
NameTypeDescription
$stringstring
Returns
TypeDescription
string
methodpubliccount() : int
inherited

Countable

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::count()
Returns
TypeDescription
int
methodpublicdirect() : void
inherited

Strategy pattern: currently unutilized

Inherited from: \Zend_View_Helper_Abstract::direct()\Zend_View_Helper_Placeholder_Container_Standalone::direct()
methodpublicdisableTranslation() : \Zend_View_Helper_HeadTitle

Disables translation

Returns
TypeDescription
\Zend_View_Helper_HeadTitle
methodpublicenableTranslation() : \Zend_View_Helper_HeadTitle

Enables translation

Returns
TypeDescription
\Zend_View_Helper_HeadTitle
methodpublicgetAutoEscape() : void
inherited

Return whether autoEscaping is enabled or disabled

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::getAutoEscape()

return bool

methodpublicgetContainer() : \Zend_View_Helper_Placeholder_Container_Abstract
inherited

Retrieve placeholder container

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::getContainer()
Returns
TypeDescription
\Zend_View_Helper_Placeholder_Container_Abstract
methodpublicgetDefaultAttachOrder() : mixed

Get the default attach order, if any.

Returns
TypeDescription
mixed
methodpublicgetIterator() : \Iterator
inherited

IteratorAggregate: get Iterator

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::getIterator()
Returns
TypeDescription
\Iterator
methodpublicgetRegistry() : \Zend_View_Helper_Placeholder_Registry
inherited

Retrieve registry

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::getRegistry()
Returns
TypeDescription
\Zend_View_Helper_Placeholder_Registry
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
TypeDescription
\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
NameTypeDescription
$titlestring
$setTypestring
Returns
TypeDescription
\Zend_View_Helper_HeadTitle
methodpublicoffsetExists(string | int $offset) : bool
inherited

ArrayAccess: offsetExists

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::offsetExists()
Parameters
NameTypeDescription
$offsetstring | int
Returns
TypeDescription
bool
methodpublicoffsetGet(string | int $offset) : mixed
inherited

ArrayAccess: offsetGet

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::offsetGet()
Parameters
NameTypeDescription
$offsetstring | int
Returns
TypeDescription
mixed
methodpublicoffsetSet(string | int $offset, mixed $value) : void
inherited

ArrayAccess: offsetSet

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::offsetSet()
Parameters
NameTypeDescription
$offsetstring | int
$valuemixed
methodpublicoffsetUnset(string | int $offset) : void
inherited

ArrayAccess: offsetUnset

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::offsetUnset()
Parameters
NameTypeDescription
$offsetstring | int
methodpublicsetAutoEscape(bool $autoEscape = true) : \Zend_View_Helper_Placeholder_Container_Standalone
inherited

Set whether or not auto escaping should be used

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::setAutoEscape()
Parameters
NameTypeDescription
$autoEscapebool

whether or not to auto escape output

Returns
TypeDescription
\Zend_View_Helper_Placeholder_Container_Standalone
methodpublicsetContainer(\Zend_View_Helper_Placeholder_Container_Abstract $container) : \Zend_View_Helper_Placeholder_Container_Standalone
inherited

Set container on which to operate

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::setContainer()
Parameters
NameTypeDescription
$container\Zend_View_Helper_Placeholder_Container_Abstract
Returns
TypeDescription
\Zend_View_Helper_Placeholder_Container_Standalone
methodpublicsetDefaultAttachOrder(string $setType) : void

Set a default order to add titles

Parameters
NameTypeDescription
$setTypestring
methodpublicsetRegistry(\Zend_View_Helper_Placeholder_Registry $registry) : \Zend_View_Helper_Placeholder_Container_Standalone
inherited

Set registry object

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::setRegistry()
Parameters
NameTypeDescription
$registry\Zend_View_Helper_Placeholder_Registry
Returns
TypeDescription
\Zend_View_Helper_Placeholder_Container_Standalone
methodpublicsetTranslator(\Zend_Translate | \Zend_Translate_Adapter $translate) : \Zend_View_Helper_HeadTitle

Sets a translation Adapter for translation

Parameters
NameTypeDescription
$translate\Zend_Translate | \Zend_Translate_Adapter
Returns
TypeDescription
\Zend_View_Helper_HeadTitle
methodpublicsetView(\Zend_View_Interface $view) : \Zend_View_Helper_Abstract
inherited

Set the View object

Inherited from: \Zend_View_Helper_Abstract::setView()\Zend_View_Helper_Placeholder_Container_Standalone::setView()
Parameters
NameTypeDescription
$view\Zend_View_Interface
Returns
TypeDescription
\Zend_View_Helper_Abstract
methodpublictoString(string | null $indent = null, string | null $locale = null) : string

Turn helper into string

Parameters
NameTypeDescription
$indentstring | null
$localestring | null
Returns
TypeDescription
string
Documentation was generated by phpDocumentor 2.0.0a12.