View/Helper/HeadTitle.php

Show:

inherited

Classes
- \Zend_View_Helper_HeadTitle

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 [email protected] 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

\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

\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

string $_defaultAttachOrder = null

Default title rendering order (i.e.

order in which each title attached)

Default valuenullDetails

Type: string

string $_regKey = 'Zend_View_Helper_HeadTitle'

Registry key for placeholder

Default value'Zend_View_Helper_HeadTitle'Details

Type: string

\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

boolean $_translate = false

Whether or not auto-translation is enabled

Default valuefalseDetails

Type: boolean

\Zend_Translate_Adapter $_translator =

Translation object

Details

Type: \Zend_Translate_Adapter

\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

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

inherited

Overload

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__call()

Proxy to container methods

Parameters

Name	Type	Description
$method	string
$args	array

Returns

Type	Description
mixed

__construct() : void

inherited

Constructor

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__construct()

__get(string $key) : mixed

inherited

Overloading: retrieve property

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__get()

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
mixed

__isset(string $key) : bool

inherited

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

__set(string $key, mixed $value) : void

inherited

Overloading: set property value

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__set()

Parameters

Name	Type	Description
$key	string
$value	mixed

__toString() : string

inherited

Cast to string representation

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__toString()

Returns

Type	Description
string

__unset(string $key) : void

inherited

Overloading: unset property

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__unset()

Parameters

Name	Type	Description
$key	string

_escape(string $string) : string

inherited

Escape a string

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::_escape()

Parameters

Name	Type	Description
$string	string

Returns

Type	Description
string

count() : int

inherited

Countable

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::count()

Returns

Type	Description
int

direct() : void

inherited

Strategy pattern: currently unutilized

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

disableTranslation() : \Zend_View_Helper_HeadTitle

Disables translation

Returns

Type	Description
\Zend_View_Helper_HeadTitle

enableTranslation() : \Zend_View_Helper_HeadTitle

Enables translation

Returns

Type	Description
\Zend_View_Helper_HeadTitle

getAutoEscape() : void

inherited

Return whether autoEscaping is enabled or disabled

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::getAutoEscape()

return bool

getContainer() : \Zend_View_Helper_Placeholder_Container_Abstract

inherited

Retrieve placeholder container

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::getContainer()

Returns

Type	Description
\Zend_View_Helper_Placeholder_Container_Abstract

getDefaultAttachOrder() : mixed

Get the default attach order, if any.

Returns

Type	Description
mixed

getIterator() : \Iterator

inherited

IteratorAggregate: get Iterator

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::getIterator()

Returns

Type	Description
\Iterator

getRegistry() : \Zend_View_Helper_Placeholder_Registry

inherited

Retrieve registry

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::getRegistry()

Returns

Type	Description
\Zend_View_Helper_Placeholder_Registry

getTranslator() : \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

headTitle(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

offsetExists(string | int $offset) : bool

inherited

ArrayAccess: offsetExists

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::offsetExists()

Parameters

Name	Type	Description
$offset	string \| int

Returns

Type	Description
bool

offsetGet(string | int $offset) : mixed

inherited

ArrayAccess: offsetGet

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::offsetGet()

Parameters

Name	Type	Description
$offset	string \| int

Returns

Type	Description
mixed

offsetSet(string | int $offset, mixed $value) : void

inherited

ArrayAccess: offsetSet

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::offsetSet()

Parameters

Name	Type	Description
$offset	string \| int
$value	mixed

offsetUnset(string | int $offset) : void

inherited

ArrayAccess: offsetUnset

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::offsetUnset()

Parameters

Name	Type	Description
$offset	string \| int

setAutoEscape(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

Name	Type	Description
$autoEscape	bool	whether or not to auto escape output

Returns

Type	Description
\Zend_View_Helper_Placeholder_Container_Standalone

setContainer(\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

Name	Type	Description
$container	\Zend_View_Helper_Placeholder_Container_Abstract

Returns

Type	Description
\Zend_View_Helper_Placeholder_Container_Standalone

setDefaultAttachOrder(string $setType) : void

Set a default order to add titles

Parameters

Name	Type	Description
$setType	string

setRegistry(\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

Name	Type	Description
$registry	\Zend_View_Helper_Placeholder_Registry

Returns

Type	Description
\Zend_View_Helper_Placeholder_Container_Standalone

setTranslator(\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

setView(\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

Name	Type	Description
$view	\Zend_View_Interface

Returns

Type	Description
\Zend_View_Helper_Abstract

toString(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

View/Helper/HeadTitle.php

\Zend_View_Helper_HeadTitlejump to top

Properties

Methods

\Zend_View_Helper_HeadTitle
jump to top