Zend Framework » \Zend\View\Helper\HeadStyle

Helper for setting and retrieving stylesheets

Allows the following method calls:

Methods

Overload method calls

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

Proxy to container methods

Parameters

$method

string

$args

array

Exceptions

`\Zend\View\Exception\BadMethodCallException`	When no $content provided or invalid method

Constructor

__construct()

Set separator to PHP_EOL.

Overloading: retrieve property

__get(string $key) : mixed

Inherited

inherited_from	\Zend\View\Helper\Placeholder\Container\AbstractStandalone::__get()

Parameters

$key

string

Returns

mixed

Return headStyle object

__invoke(string $content, string $placement, string | array $attributes) : \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

Overloading: check if property is set

__isset(string $key) : bool

Inherited

inherited_from	\Zend\View\Helper\Placeholder\Container\AbstractStandalone::__isset()

Parameters

$key

string

Returns

bool

Overloading: set property value

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

Inherited

inherited_from	\Zend\View\Helper\Placeholder\Container\AbstractStandalone::__set()

Parameters

$key

string

$value

mixed

Cast to string representation

__toString() : string

Inherited

inherited_from	\Zend\View\Helper\Placeholder\Container\AbstractStandalone::__toString()

Returns

string

Overloading: unset property

__unset(string $key) : void

Inherited

inherited_from	\Zend\View\Helper\Placeholder\Container\AbstractStandalone::__unset()

Parameters

$key

string

Override append to enforce style creation

append(mixed $value) : void

Parameters

$value

mixed

Exceptions

`\Zend\View\Exception\InvalidArgumentException`

)

appendStyle( $content, $attributes =) : \Zend\View\Helper\HeadStyle

magic
method	)

Parameters

$content

=

$attributes

Returns

\Zend\View\Helper\HeadStyle

End capture action and store

captureEnd() : void

Start capture action

captureStart(string $type, string $attrs) : void

Parameters

$type

string

$attrs

string

Exceptions

`\Zend\View\Exception\RuntimeException`

Countable

count() : int

Inherited

inherited_from	\Zend\View\Helper\Placeholder\Container\AbstractStandalone::count()

Returns

int

Create data item for use in stack

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

Parameters

$content

string

$attributes

array

Returns

\stdClass

Delete a container

deleteContainer() : bool

Inherited

inherited_from	\Zend\View\Helper\Placeholder\Container\AbstractStandalone::deleteContainer()

Returns

bool

Return whether autoEscaping is enabled or disabled

getAutoEscape()

Inherited

return bool

inherited_from	\Zend\View\Helper\Placeholder\Container\AbstractStandalone::getAutoEscape()

Retrieve placeholder container

getContainer() : \Zend\View\Helper\Placeholder\Container\AbstractContainer

Inherited

inherited_from	\Zend\View\Helper\Placeholder\Container\AbstractStandalone::getContainer()

Returns

\Zend\View\Helper\Placeholder\Container\AbstractContainer

Retrieve the container class

getContainerClass() : string

Inherited

inherited_from	\Zend\View\Helper\Placeholder\Container\AbstractStandalone::getContainerClass()

Returns

string

Get Escaper instance

getEscaper(string | null $enc) : mixed

Inherited

Lazy-loads one if none available

inherited_from	\Zend\View\Helper\Placeholder\Container\AbstractStandalone::getEscaper()

Parameters

$enc

stringnull

Encoding to use

Returns

mixed

IteratorAggregate: get Iterator

getIterator() : \Iterator

Inherited

inherited_from	\Zend\View\Helper\Placeholder\Container\AbstractStandalone::getIterator()

Returns

\Iterator

Get the view object

getView() : null | \Zend\View\Renderer\RendererInterface

Inherited

inherited_from	\Zend\View\Helper\AbstractHelper::getView()
inherited_from	\Zend\View\Helper\Placeholder\Container\AbstractStandalone::getView()

Returns

null\Zend\View\Renderer\RendererInterface

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 | int $offset) : bool

Inherited

inherited_from	\Zend\View\Helper\Placeholder\Container\AbstractStandalone::offsetExists()

Parameters

$offset

stringint

Returns

bool

ArrayAccess: offsetGet

offsetGet(string | int $offset) : mixed

Inherited

inherited_from	\Zend\View\Helper\Placeholder\Container\AbstractStandalone::offsetGet()

Parameters

$offset

stringint

Returns

mixed

Override offsetSet to enforce style creation

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

Parameters

$index

stringint

$value

mixed

Exceptions

`\Zend\View\Exception\InvalidArgumentException`

)

offsetSetStyle( $index,  $content, $attributes =) : \Zend\View\Helper\HeadStyle

magic
method	)

Parameters

$index

$content

=

$attributes

Returns

\Zend\View\Helper\HeadStyle

ArrayAccess: offsetUnset

offsetUnset(string | int $offset) : void

Inherited

inherited_from	\Zend\View\Helper\Placeholder\Container\AbstractStandalone::offsetUnset()

Parameters

$offset

stringint

Override prepend to enforce style creation

prepend(mixed $value) : void

Parameters

$value

mixed

Exceptions

`\Zend\View\Exception\InvalidArgumentException`

)

prependStyle( $content, $attributes =) : \Zend\View\Helper\HeadStyle

magic
method	)

Parameters

$content

=

$attributes

Returns

\Zend\View\Helper\HeadStyle

Override set to enforce style creation

set(mixed $value) : void

Parameters

$value

mixed

Exceptions

`\Zend\View\Exception\InvalidArgumentException`

Set whether or not auto escaping should be used

setAutoEscape(bool $autoEscape) : \Zend\View\Helper\Placeholder\Container\AbstractStandalone

Inherited

inherited_from	\Zend\View\Helper\Placeholder\Container\AbstractStandalone::setAutoEscape()

Parameters

$autoEscape

bool

whether or not to auto escape output

Returns

\Zend\View\Helper\Placeholder\Container\AbstractStandalone

Set container on which to operate

setContainer(\Zend\View\Helper\Placeholder\Container\AbstractContainer $container) : \Zend\View\Helper\Placeholder\Container\AbstractStandalone

Inherited

inherited_from	\Zend\View\Helper\Placeholder\Container\AbstractStandalone::setContainer()

Parameters

$container

\Zend\View\Helper\Placeholder\Container\AbstractContainer

Returns

\Zend\View\Helper\Placeholder\Container\AbstractStandalone

Set the container class to use

setContainerClass(string $name) : \Zend\View\Helper\Placeholder\Container\AbstractStandalone

Inherited

inherited_from	\Zend\View\Helper\Placeholder\Container\AbstractStandalone::setContainerClass()

Parameters

$name

string

Exceptions

`\Zend\View\Exception\InvalidArgumentException`
`\Zend\View\Exception\DomainException`

Returns

\Zend\View\Helper\Placeholder\Container\AbstractStandalone

Set Escaper instance

setEscaper(\Zend\Escaper\Escaper $escaper) : \Zend\View\Helper\Placeholder\Container\AbstractStandalone

Inherited

inherited_from	\Zend\View\Helper\Placeholder\Container\AbstractStandalone::setEscaper()

Parameters

$escaper

\Zend\Escaper\Escaper

Returns

\Zend\View\Helper\Placeholder\Container\AbstractStandalone

)

setStyle( $content, $attributes =) : \Zend\View\Helper\HeadStyle

magic
method	)

Parameters

$content

=

$attributes

Returns

\Zend\View\Helper\HeadStyle

Set the View object

setView(\Zend\View\Renderer\RendererInterface $view) : \Zend\View\Helper\AbstractHelper

Inherited

inherited_from	\Zend\View\Helper\AbstractHelper::setView()
inherited_from	\Zend\View\Helper\Placeholder\Container\AbstractStandalone::setView()

Parameters

$view

\Zend\View\Renderer\RendererInterface

Returns

\Zend\View\Helper\AbstractHelper

Create string representation of placeholder

toString(string | int $indent) : string

Parameters

$indent

stringint

Returns

string

Escape a string

escape(string $string) : string

Inherited

inherited_from	\Zend\View\Helper\Placeholder\Container\AbstractStandalone::escape()

Parameters

$string

string

Returns

string

Determine if a value is a valid style tag

isValid(mixed $value) : bool

Parameters

$value

mixed

Returns

bool

Properties

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

$autoEscape : bool

Inherited

inherited_from	\Zend\View\Helper\Placeholder\Container\AbstractStandalone::$$autoEscape

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

$captureAttrs : string

Capture lock

$captureLock : bool

Capture type (append, prepend, set)

$captureType : string

$container

$container : \Zend\View\Helper\Placeholder\Container\AbstractContainer

Inherited

inherited_from	\Zend\View\Helper\Placeholder\Container\AbstractStandalone::$$container

Default container class

$containerClass : string

Inherited

inherited_from	\Zend\View\Helper\Placeholder\Container\AbstractStandalone::$$containerClass

$escapers

$escapers : \Zend\Escaper\Escaper[]

Inherited

inherited_from	\Zend\View\Helper\Placeholder\Container\AbstractStandalone::$$escapers

Allowed media types

$mediaTypes : array

Allowed optional attributes

$optionalAttributes : array

Registry key for placeholder

$regKey : string

View object instance

$view : \Zend\View\Renderer\RendererInterface

Inherited

inherited_from	\Zend\View\Helper\AbstractHelper::$$view
inherited_from	\Zend\View\Helper\Placeholder\Container\AbstractStandalone::$$view