Zend Framework  3.0
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
HeadLink Class Reference

Zend_Layout_View_Helper_HeadLink. More...

Public Member Functions

 __construct ()
 Constructor.
 
 headLink (array $attributes=null, $placement=Placeholder\Container\AbstractContainer::APPEND)
 Proxy to __invoke()
 
 __invoke (array $attributes=null, $placement=Placeholder\Container\AbstractContainer::APPEND)
 headLink() - View Helper Method
 
 __call ($method, $args)
 Overload method access.
 
 append ($value)
 append()
 
 offsetSet ($index, $value)
 offsetSet()
 
 prepend ($value)
 prepend()
 
 set ($value)
 set()
 
 itemToString (stdClass $item)
 Create HTML link element from data item.
 
 toString ($indent=null)
 Render link elements as string.
 
 createData (array $attributes)
 Create data item for stack.
 
 createDataStylesheet (array $args)
 Create item for stylesheet link item.
 
 createDataAlternate (array $args)
 Create item for alternate link item.
 
 createDataPrev (array $args)
 Create item for a prev relationship (mainly used for pagination)
 
 createDataNext (array $args)
 Create item for a prev relationship (mainly used for pagination)
 
- Public Member Functions inherited from AbstractStandalone
 __construct ()
 Constructor.
 
 __call ($method, $args)
 Overload.
 
 __set ($key, $value)
 Overloading: set property value.
 
 __get ($key)
 Overloading: retrieve property.
 
 __isset ($key)
 Overloading: check if property is set.
 
 __unset ($key)
 Overloading: unset property.
 
 __toString ()
 Cast to string representation.
 
 toString ()
 String representation.
 
 setAutoEscape ($autoEscape=true)
 Set whether or not auto escaping should be used.
 
 getAutoEscape ()
 Return whether autoEscaping is enabled or disabled.
 
 setContainer (AbstractContainer $container)
 Set container on which to operate.
 
 getContainer ()
 Retrieve placeholder container.
 
 deleteContainer ()
 Delete a container.
 
 setContainerClass ($name)
 Set the container class to use.
 
 getContainerClass ()
 Retrieve the container class.
 
 setEscaper (Escaper $escaper)
 Set Escaper instance.
 
 getEscaper ($enc= 'UTF-8')
 Get Escaper instance.
 
 count ()
 Countable.
 
 offsetExists ($offset)
 ArrayAccess: offsetExists.
 
 offsetGet ($offset)
 ArrayAccess: offsetGet.
 
 offsetSet ($offset, $value)
 ArrayAccess: offsetSet.
 
 offsetUnset ($offset)
 ArrayAccess: offsetUnset.
 
 getIterator ()
 IteratorAggregate: get Iterator.
 
- Public Member Functions inherited from AbstractHelper
 setView (Renderer $view)
 Set the View object.
 
 getView ()
 Get the view object.
 

Protected Member Functions

 isValid ($value)
 Check if value is valid.
 
 isDuplicateStylesheet ($uri)
 Is the linked stylesheet a duplicate?
 
- Protected Member Functions inherited from AbstractStandalone
 escape ($string)
 Escape a string.
 

Protected Attributes

 $itemKeys
 
 $regKey = 'Zend_View_Helper_HeadLink'
 
- Protected Attributes inherited from AbstractStandalone
 $autoEscape = true
 
 $container
 
 $containerClass = 'Zend\View\Helper\Placeholder\Container'
 
 $escapers = []
 
- Protected Attributes inherited from AbstractHelper
 $view = null
 

Detailed Description

Zend_Layout_View_Helper_HeadLink.

See Also
http://www.w3.org/TR/xhtml1/dtds.html

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

Constructor & Destructor Documentation

__construct ( )

Constructor.

Use PHP_EOL as separator

Member Function Documentation

__call (   $method,
  $args 
)

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()
Parameters
mixed$method
mixed$args
Exceptions
Exception\BadMethodCallException
Returns
void
__invoke ( array  $attributes = null,
  $placement = Placeholder\Container\AbstractContainer::APPEND 
)

headLink() - View Helper Method

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

Parameters
array$attributes
string$placement
Returns
HeadLink
append (   $value)

append()

Parameters
array$value
Exceptions
Exception\InvalidArgumentException
Returns
void
createData ( array  $attributes)

Create data item for stack.

Parameters
array$attributes
Returns
stdClass
createDataAlternate ( array  $args)

Create item for alternate link item.

Parameters
array$args
Exceptions
Exception\InvalidArgumentException
Returns
stdClass
createDataNext ( array  $args)

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

Parameters
array$args
Returns
stdClass
createDataPrev ( array  $args)

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

Parameters
array$args
Returns
stdClass
createDataStylesheet ( array  $args)

Create item for stylesheet link item.

Parameters
array$args
Returns
stdClass|false Returns false if stylesheet is a duplicate
headLink ( array  $attributes = null,
  $placement = Placeholder\Container\AbstractContainer::APPEND 
)

Proxy to __invoke()

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

Parameters
array$attributes
string$placement
Returns
HeadLink
isDuplicateStylesheet (   $uri)
protected

Is the linked stylesheet a duplicate?

Parameters
string$uri
Returns
bool
isValid (   $value)
protected

Check if value is valid.

Parameters
mixed$value
Returns
bool
itemToString ( stdClass  $item)

Create HTML link element from data item.

Parameters
stdClass$item
Returns
string
offsetSet (   $index,
  $value 
)

offsetSet()

Parameters
string | int$index
array$value
Exceptions
Exception\InvalidArgumentException
Returns
void
prepend (   $value)

prepend()

Parameters
array$value
Exceptions
Exception\InvalidArgumentException
Returns
HeadLink
set (   $value)

set()

Parameters
array$value
Exceptions
Exception\InvalidArgumentException
Returns
HeadLink
toString (   $indent = null)

Render link elements as string.

Parameters
string | int$indent
Returns
string

Member Data Documentation

$itemKeys
protected
Initial value:
= [
'charset',
'href',
'hreflang',
'id',
'media',
'rel',
'rev',
'sizes',
'type',
'title',
'extras',
'itemprop'
]
$regKey = 'Zend_View_Helper_HeadLink'
protected