Summary

Fully Qualified Name:	Laminas\View\Helper\HeadLink
Extends:	AbstractStandalone

Description

Methods

Name	Description	Defined By
__call()	Overload method access	HeadLink
__construct()	Constructor	HeadLink
__get()	Overloading: retrieve property	AbstractStandalone
__invoke()	headLink() - View Helper Method	HeadLink
__isset()	Overloading: check if property is set	AbstractStandalone
__set()	Overloading: set property value	AbstractStandalone
__toString()	Cast to string representation	AbstractStandalone
__unset()	Overloading: unset property	AbstractStandalone
append()	append()	HeadLink
count()	Countable	AbstractStandalone
createData()	Create data item for stack	HeadLink
createDataAlternate()	Create item for alternate link item	HeadLink
createDataNext()	Create item for a prev relationship (mainly used for pagination)	HeadLink
createDataPrev()	Create item for a prev relationship (mainly used for pagination)	HeadLink
createDataStylesheet()	Create item for stylesheet link item	HeadLink
deleteContainer()	Delete a container	AbstractStandalone
getAutoEscape()	Return whether autoEscaping is enabled or disabled	AbstractStandalone
getContainer()	Retrieve placeholder container	AbstractStandalone
getContainerClass()	Retrieve the container class	AbstractStandalone
getEscaper()	Get Escaper instance	AbstractStandalone
getIterator()	IteratorAggregate: get Iterator	AbstractStandalone
getView()	Get the view object	AbstractHelper
headLink()	Proxy to __invoke()	HeadLink
itemToString()	Create HTML link element from data item	HeadLink
offsetExists()	ArrayAccess: offsetExists	AbstractStandalone
offsetGet()	ArrayAccess: offsetGet	AbstractStandalone
offsetSet()	offsetSet()	HeadLink
offsetUnset()	ArrayAccess: offsetUnset	AbstractStandalone
prepend()	prepend()	HeadLink
set()	set()	HeadLink
setAutoEscape()	Set whether or not auto escaping should be used	AbstractStandalone
setContainer()	Set container on which to operate	AbstractStandalone
setContainerClass()	Set the container class to use	AbstractStandalone
setEscaper()	Set Escaper instance	AbstractStandalone
setView()	Set the View object	AbstractHelper
toString()	Render link elements as string	HeadLink

Method Details

__call()

Overload method access

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

Parameter Name	Type	Description
$method	mixed
$args	mixed

Returns: void

__construct()

Constructor

Use PHP_EOL as separator

Returns:

__get()

Overloading: retrieve property

Parameter Name	Type	Description
$key	string

Returns: mixed

__invoke()

headLink() - View Helper Method

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

Parameter Name	Type	Description
$attributes	array
$placement	string

Returns: \HeadLink

__isset()

Overloading: check if property is set

Parameter Name	Type	Description
$key	string

Returns: bool

__set()

Overloading: set property value

Parameter Name	Type	Description
$key	string
$value	mixed

Returns: void

__toString()

Cast to string representation

Returns: string

__unset()

Overloading: unset property

Parameter Name	Type	Description
$key	string

Returns: void

append()

append()

Parameter Name	Type	Description
$value	array

Returns: void

count()

Countable

Returns: int

createData()

Create data item for stack

Parameter Name	Type	Description
$attributes	array

Returns: \stdClass

createDataAlternate()

Create item for alternate link item

Parameter Name	Type	Description
$args	array

Returns: \stdClass

createDataNext()

Create item for a prev relationship (mainly used for pagination)

Parameter Name	Type	Description
$args	array

Returns: \stdClass

createDataPrev()

Create item for a prev relationship (mainly used for pagination)

Parameter Name	Type	Description
$args	array

Returns: \stdClass

createDataStylesheet()

Create item for stylesheet link item

Parameter Name	Type	Description
$args	array

Returns: \stdClass|bool Returns false if stylesheet is a duplicate

deleteContainer()

Delete a container

Returns: bool

getAutoEscape()

Return whether autoEscaping is enabled or disabled

return bool

Returns:

getContainer()

Retrieve placeholder container

Returns: \AbstractContainer

getContainerClass()

Retrieve the container class

Returns: string

getEscaper()

Get Escaper instance

Lazy-loads one if none available

Parameter Name	Type	Description
$enc	string|null	Encoding

Returns: mixed

getIterator()

IteratorAggregate: get Iterator

Returns: \Iterator

getView()

Get the view object

Returns: null|\Renderer

headLink()

Proxy to __invoke()

Allows calling $helper->headLink(), but, more importantly, chaining calls like ->appendStylesheet()->headLink().

Parameter Name	Type	Description
$attributes	array
$placement	string

Returns: \HeadLink

itemToString()

Create HTML link element from data item

Parameter Name	Type	Description
$item	\stdClass

Returns: string

offsetExists()

ArrayAccess: offsetExists

Parameter Name	Type	Description
$offset	string|int

Returns: bool

offsetGet()

ArrayAccess: offsetGet

Parameter Name	Type	Description
$offset	string|int

Returns: mixed

offsetSet()

offsetSet()

Parameter Name	Type	Description
$index	string|int
$value	array

Returns: void

offsetUnset()

ArrayAccess: offsetUnset

Parameter Name	Type	Description
$offset	string|int

Returns: void

prepend()

prepend()

Parameter Name	Type	Description
$value	array

Returns: \HeadLink

set()

set()

Parameter Name	Type	Description
$value	array

Returns: \HeadLink

setAutoEscape()

Set whether or not auto escaping should be used

Parameter Name	Type	Description
$autoEscape	bool	whether

Returns: \AbstractStandalone

setContainer()

Set container on which to operate

Parameter Name	Type	Description
$container	\AbstractContainer

Returns: \AbstractStandalone

setContainerClass()

Set the container class to use

Parameter Name	Type	Description
$name	string

Returns: \Laminas\View\Helper\Placeholder\Container\AbstractStandalone

setEscaper()

Set Escaper instance

Parameter Name	Type	Description
$escaper	\Escaper

Returns: \AbstractStandalone

setView()

Set the View object

Parameter Name	Type	Description
$view	\Renderer

Returns: \AbstractHelper

toString()

Render link elements as string

Parameter Name	Type	Description
$indent	string|int

Returns: string