View/Helper/HeadLink.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: HeadLink.php 24858 2012-06-01 01:24:17Z adamlundrigan $  

\Zend_View_Helper_HeadLink

Package: Zend\View\Helper
Zend_Layout_View_Helper_HeadLink
Parent(s)
\Zend_View_Helper_Placeholder_Container_Standalone < \Zend_View_Helper_Abstract
See
\global\http://www.w3.org/TR/xhtml1/dtds.html  
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  
>VPropertyprotectedarray $_itemKeys = array('charset', 'href', 'hreflang', 'id', 'media', 'rel', 'rev', 'type', 'title', 'extras', 'sizes')
$_validAttributes
Default valuearray('charset', 'href', 'hreflang', 'id', 'media', 'rel', 'rev', 'type', 'title', 'extras', 'sizes')Details
Type
array
>VPropertyprotectedstring $_regKey = 'Zend_View_Helper_HeadLink'
Registry key under which container registers itself
Default value'Zend_View_Helper_HeadLink'Details
Type
string

Methods

methodpublic__call(mixed $method, mixed $args) : void

Overload method access

Creates the following virtual methods: - appendStylesheet($href, $media, $conditionalStylesheet, $extras) - offsetSetStylesheet($index, $href, $media, $conditionalStylesheet, $extras) - prependStylesheet($href, $media, $conditionalStylesheet, $extras) - setStylesheet($href, $media, $conditionalStylesheet, $extras) - appendAlternate($href, $type, $title, $extras) - offsetSetAlternate($index, $href, $type, $title, $extras) - prependAlternate($href, $type, $title, $extras) - setAlternate($href, $type, $title, $extras)

Items that may be added in the future: - Navigation? need to find docs on this - public function appendStart() - public function appendContents() - public function appendPrev() - public function appendNext() - public function appendIndex() - public function appendEnd() - public function appendGlossary() - public function appendAppendix() - public function appendHelp() - public function appendBookmark() - Other? - public function appendCopyright() - public function appendChapter() - public function appendSection() - public function appendSubsection()

Parameters
NameTypeDescription
$methodmixed
$argsmixed
methodpublic__construct() : void

Constructor

Use PHP_EOL as separator

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_applyExtras(array $attributes) : array

Apply any overrides specified in the 'extras' array

Parameters
NameTypeDescription
$attributesarray
Returns
TypeDescription
array
methodprotected_escape(string $string) : string
Parameters
NameTypeDescription
$stringstring
Returns
TypeDescription
string
methodprotected_isDuplicateStylesheet(string $uri) : bool

Is the linked stylesheet a duplicate?

Parameters
NameTypeDescription
$uristring
Returns
TypeDescription
bool
methodprotected_isValid(mixed $value) : boolean

Check if value is valid

Parameters
NameTypeDescription
$valuemixed
Returns
TypeDescription
boolean
methodpublicappend(array $value) : void

append()

Parameters
NameTypeDescription
$valuearray
methodpubliccount() : int
Returns
TypeDescription
int
methodpubliccreateData(array $attributes) : \stdClass

Create data item for stack

Parameters
NameTypeDescription
$attributesarray
Returns
TypeDescription
\stdClass
methodpubliccreateDataAlternate(array $args) : \stdClass

Create item for alternate link item

Parameters
NameTypeDescription
$argsarray
Returns
TypeDescription
\stdClass
methodpubliccreateDataStylesheet(array $args) : \stdClass | false

Create item for stylesheet link item

Parameters
NameTypeDescription
$argsarray
Returns
TypeDescription
\stdClass | falseReturns fals if stylesheet is a duplicate
methodpublicdirect() : void
methodpublicgetAutoEscape() : void
inherited

Return whether autoEscaping is enabled or disabled

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::getAutoEscape()

return bool

methodpublicgetIterator() : \Iterator
inherited

IteratorAggregate: get Iterator

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::getIterator()
Returns
TypeDescription
\Iterator
methodpublicheadLink( $attributes = null,  $placement = \Zend_View_Helper_Placeholder_Container_Abstract::APPEND) : \Zend_View_Helper_HeadLink

headLink() - View Helper Method

Returns current object instance. Optionally, allows passing array of values to build link.

Parameters
NameTypeDescription
$attributes
$placement
Returns
TypeDescription
\Zend_View_Helper_HeadLink
methodpublicitemToString(\stdClass $item) : string

Create HTML link element from data item

Parameters
NameTypeDescription
$item\stdClass
Returns
TypeDescription
string
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 $index, array $value) : void

offsetSet()

Parameters
NameTypeDescription
$indexstring | int
$valuearray
methodpublicoffsetUnset(string | int $offset) : void
inherited

ArrayAccess: offsetUnset

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::offsetUnset()
Parameters
NameTypeDescription
$offsetstring | int
methodpublicprepend(array $value) : \Zend_Layout_ViewHelper_HeadLink

prepend()

Parameters
NameTypeDescription
$valuearray
Returns
TypeDescription
\Zend_Layout_ViewHelper_HeadLink
methodpublicset(array $value) : \Zend_Layout_ViewHelper_HeadLink

set()

Parameters
NameTypeDescription
$valuearray
Returns
TypeDescription
\Zend_Layout_ViewHelper_HeadLink
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
methodpublictoString(string | int $indent = null) : string

Render link elements as string

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