Zend Framework API Documentation » \Zend_View_Helper

Helper for setting and retrieving stylesheets

uses
package	Zend_View
subpackage	Helper
copyright	Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license	New BSD License
inherited_from	\Zend_View_Helper_Placeholder_Container_Standalone

Methods

$this appendStyle($content, array $attributes = array())

() :

magic
method	$this appendStyle($content, array $attributes = array())

Returns

$this offsetSetStyle($index, $content, array $attributes = array())

() :

magic
method	$this offsetSetStyle($index, $content, array $attributes = array())

Returns

$this prependStyle($content, array $attributes = array())

() :

magic
method	$this prependStyle($content, array $attributes = array())

Returns

$this setStyle($content, array $attributes = array())

() :

magic
method	$this setStyle($content, array $attributes = array())

Returns

Overload method calls

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

Allows the following method calls:

appendStyle($content, $attributes = array())
offsetSetStyle($index, $content, $attributes = array())
prependStyle($content, $attributes = array())
setStyle($content, $attributes = array())

inherited_from	\Zend_View_Helper_Placeholder_Container_Standalone::__call()

Parameters

$method

string

$args

array

Exceptions

`\Zend_View_Exception`	When no $content provided or invalid method

Overload

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

Inherited

Proxy to container methods

Parameters

$method

string

$args

array

Returns

mixed

Constructor

__construct() : void

Set separator to PHP_EOL.

inherited_from	\Zend_View_Helper_Placeholder_Container_Standalone::__construct()

Constructor

__construct() : void

Inherited

Overloading: retrieve property

__get(string $key) : mixed

Inherited

Parameters

$key

string

Returns

mixed

Overloading: check if property is set

__isset(string $key) : boolean

Inherited

Parameters

$key

string

Returns

boolean

Overloading: set property value

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

Inherited

Parameters

$key

string

$value

mixed

Cast to string representation

__toString() : string

Inherited

Returns

string

Overloading: unset property

__unset(string $key) : void

Inherited

Parameters

$key

string

Override append to enforce style creation

append(mixed $value) : void

Parameters

$value

mixed

End capture action and store

captureEnd() : void

Start capture action

captureStart($type = \Zend_View_Helper_Placeholder_Container_Abstract::APPEND, $attrs = null) : void

Parameters

$type

$attrs

Countable

count() : integer

Inherited

Returns

integer

Create data item for use in stack

createData(string $content, array $attributes) : \stdClass

Parameters

$content

string

$attributes

array

Returns

\stdClass

Strategy pattern: currently unutilized

direct() : void

Inherited

inherited_from	\Zend_View_Helper_Interface::direct()

Return whether autoEscaping is enabled or disabled

getAutoEscape()

Inherited

return bool

Retrieve placeholder container

getContainer() : \Zend_View_Helper_Placeholder_Container_Abstract

Inherited

Returns

\Zend_View_Helper_Placeholder_Container_Abstract

IteratorAggregate: get Iterator

getIterator() : \Iterator

Inherited

Returns

\Iterator

Retrieve registry

getRegistry() : \Zend_View_Helper_Placeholder_Registry

Inherited

Returns

\Zend_View_Helper_Placeholder_Registry

Return headStyle object

headStyle(string $content = null, string $placement = 'APPEND', string|array $attributes = array()) : \Zend_View_Helper_HeadStyle

Returns headStyle helper object; optionally, allows specifying

Parameters

$content

string

Stylesheet contents

$placement

string

Append, prepend, or set

$attributes

stringarray

Optional attributes to utilize

Returns

\Zend_View_Helper_HeadStyle

Convert content and attributes into valid style tag

itemToString(\stdClass $item, string $indent) : string

Parameters

$item

\stdClass

Item to render

$indent

string

Indentation to use

Returns

string

ArrayAccess: offsetExists

offsetExists(string|integer $offset) : boolean

Inherited

Parameters

$offset

stringinteger

Returns

boolean

ArrayAccess: offsetGet

offsetGet(string|integer $offset) : mixed

Inherited

Parameters

$offset

stringinteger

Returns

mixed

Override offsetSet to enforce style creation

offsetSet(string|integer $index, mixed $value) : void

inherited_from	\Zend_View_Helper_Placeholder_Container_Standalone::offsetSet()

Parameters

$index

stringinteger

$value

mixed

ArrayAccess: offsetSet

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

Inherited

Parameters

$offset

stringinteger

$value

mixed

ArrayAccess: offsetUnset

offsetUnset(string|integer $offset) : void

Inherited

Parameters

$offset

stringinteger

Override prepend to enforce style creation

prepend(mixed $value) : void

Parameters

$value

mixed

Override set to enforce style creation

set(mixed $value) : void

Parameters

$value

mixed

Set whether or not auto escaping should be used

setAutoEscape(boolean $autoEscape = true) : \Zend_View_Helper_Placeholder_Container_Standalone

Inherited

Parameters

$autoEscape

boolean

whether or not to auto escape output

Returns

\Zend_View_Helper_Placeholder_Container_Standalone

Set container on which to operate

setContainer(\Zend_View_Helper_Placeholder_Container_Abstract $container) : \Zend_View_Helper_Placeholder_Container_Standalone

Inherited

Parameters

$container

\Zend_View_Helper_Placeholder_Container_Abstract

Returns

\Zend_View_Helper_Placeholder_Container_Standalone

Set registry object

setRegistry(\Zend_View_Helper_Placeholder_Registry $registry) : \Zend_View_Helper_Placeholder_Container_Standalone

Inherited

Parameters

$registry

\Zend_View_Helper_Placeholder_Registry

Returns

\Zend_View_Helper_Placeholder_Container_Standalone

Set the View object

setView(\Zend_View_Interface $view) : \Zend_View_Helper_Abstract

Inherited

inherited_from	\Zend_View_Helper_Interface::setView()

Parameters

$view

\Zend_View_Interface

Returns

\Zend_View_Helper_Abstract

Create string representation of placeholder

toString(string|integer $indent = null) : string

inherited_from	\Zend_View_Helper_Placeholder_Container_Standalone::toString()

Parameters

$indent

stringinteger

Returns

string

String representation

toString() : string

Inherited

Returns

string

Escape a string

_escape(string $string) : string

Inherited

Parameters

$string

string

Returns

string

Determine if a value is a valid style tag

_isValid(mixed $value) : boolean

Parameters

$value

mixed

Returns

boolean

Properties

View object

$view : \Zend_View_Interface

Default

null

Flag wheter to automatically escape output, must also be enforced in the child class if __toString/toString is overriden

$_autoEscape : \book

Default

true

Capture type and/or attributes (used for hinting during capture)

$_captureAttrs : string

Default

null

Capture lock

$_captureLock : boolean

Default

Capture type (append, prepend, set)

$_captureType : string

Default

$_container

$_container : \Zend_View_Helper_Placeholder_Container_Abstract

Default

Allowed media types

$_mediaTypes : array

Default

array('all', 'aural', 'braille', 'handheld', 'print', 'projection', 'screen', 'tty', 'tv')

Allowed optional attributes

$_optionalAttributes : array

Default

array('lang', 'title', 'media', 'dir')

Registry key for placeholder

$_regKey : string

Default

'Zend_View_Helper_HeadStyle'

inherited_from	\Zend_View_Helper_Placeholder_Container_Standalone::_regKey

Registry key under which container registers itself

$_regKey : string

Default

$_registry

$_registry : \Zend_View_Helper_Placeholder_Registry