View/Helper/HeadStyle.php

Show:

inherited

Classes
- \Zend_View_Helper_HeadStyle

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 [email protected] 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: HeadStyle.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_View_Helper_HeadStyle
jump to top

Package: Zend\View\Helper

Helper for setting and retrieving stylesheets

Parent(s): \Zend_View_Helper_Placeholder_Container_Standalone < \Zend_View_Helper_Abstract
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

\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

string $_captureAttrs = null

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

Default valuenullDetails

Type: string

bool $_captureLock =

Capture lock

Details

Type: bool

string $_captureType =

Capture type (append, prepend, set)

Details

Type: string

\Zend_View_Helper_Placeholder_Container_Abstract $_container =

inherited

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::$$_container

Details

Type: \Zend_View_Helper_Placeholder_Container_Abstract
Inherited_from: \Zend_View_Helper_Placeholder_Container_Standalone::$$_container

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

Allowed media types

Default valuearray('all', 'aural', 'braille', 'handheld', 'print', 'projection', 'screen', 'tty', 'tv')Details

Type: array

array $_optionalAttributes = array('lang', 'title', 'media', 'dir')

Allowed optional attributes

Default valuearray('lang', 'title', 'media', 'dir')Details

Type: array

string $_regKey = 'Zend_View_Helper_HeadStyle'

Registry key for placeholder

Default value'Zend_View_Helper_HeadStyle'Details

Type: string

\Zend_View_Helper_Placeholder_Registry $_registry =

inherited

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::$$_registry

Details

Type: \Zend_View_Helper_Placeholder_Registry
Inherited_from: \Zend_View_Helper_Placeholder_Container_Standalone::$$_registry

\Zend_View_Interface $view = null

inherited

View object

Inherited from: \Zend_View_Helper_Abstract::$$view \Zend_View_Helper_Placeholder_Container_Standalone::$$view

Default valuenullDetails

Type: \Zend_View_Interface
Inherited_from: \Zend_View_Helper_Abstract::$$view
Inherited_from: \Zend_View_Helper_Placeholder_Container_Standalone::$$view

Methods

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

Overload method calls

Allows the following method calls: - appendStyle($content, $attributes = array()) - offsetSetStyle($index, $content, $attributes = array()) - prependStyle($content, $attributes = array()) - setStyle($content, $attributes = array())

Parameters

Name	Type	Description
$method	string
$args	array

Throws

Exception	Description
\Zend_View_Exception	When no $content provided or invalid method

__construct() : void

Constructor

Set separator to PHP_EOL.

__get(string $key) : mixed

inherited

Overloading: retrieve property

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__get()

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
mixed

__isset(string $key) : bool

inherited

Overloading: check if property is set

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__isset()

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
bool

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

inherited

Overloading: set property value

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__set()

Parameters

Name	Type	Description
$key	string
$value	mixed

__toString() : string

inherited

Cast to string representation

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__toString()

Returns

Type	Description
string

__unset(string $key) : void

inherited

Overloading: unset property

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__unset()

Parameters

Name	Type	Description
$key	string

_escape(string $string) : string

inherited

Escape a string

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::_escape()

Parameters

Name	Type	Description
$string	string

Returns

Type	Description
string

_isValid(mixed $value) : boolean

Determine if a value is a valid style tag

Parameters

Name	Type	Description
$value	mixed

Returns

Type	Description
boolean

append(mixed $value) : void

Override append to enforce style creation

Parameters

Name	Type	Description
$value	mixed

captureEnd() : void

End capture action and store

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

Start capture action

Parameters

Name	Type	Description
$type
$attrs

count() : int

inherited

Countable

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::count()

Returns

Type	Description
int

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

Create data item for use in stack

Parameters

Name	Type	Description
$content	string
$attributes	array

Returns

Type	Description
\stdClass

direct() : void

inherited

Strategy pattern: currently unutilized

Inherited from: \Zend_View_Helper_Abstract::direct()\Zend_View_Helper_Placeholder_Container_Standalone::direct()

getAutoEscape() : void

inherited

Return whether autoEscaping is enabled or disabled

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::getAutoEscape()

return bool

getContainer() : \Zend_View_Helper_Placeholder_Container_Abstract

inherited

Retrieve placeholder container

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::getContainer()

Returns

Type	Description
\Zend_View_Helper_Placeholder_Container_Abstract

getIterator() : \Iterator

inherited

IteratorAggregate: get Iterator

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::getIterator()

Returns

Type	Description
\Iterator

getRegistry() : \Zend_View_Helper_Placeholder_Registry

inherited

Retrieve registry

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::getRegistry()

Returns

Type	Description
\Zend_View_Helper_Placeholder_Registry

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

Return headStyle object

Returns headStyle helper object; optionally, allows specifying

Parameters

Name	Type	Description
$content	string	Stylesheet contents
$placement	string	Append, prepend, or set
$attributes	string \| array	Optional attributes to utilize

Returns

Type	Description
\Zend_View_Helper_HeadStyle

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

Convert content and attributes into valid style tag

Parameters

Name	Type	Description
$item	\stdClass	Item to render
$indent	string	Indentation to use

Returns

Type	Description
string

offsetExists(string | int $offset) : bool

inherited

ArrayAccess: offsetExists

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::offsetExists()

Parameters

Name	Type	Description
$offset	string \| int

Returns

Type	Description
bool

offsetGet(string | int $offset) : mixed

inherited

ArrayAccess: offsetGet

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::offsetGet()

Parameters

Name	Type	Description
$offset	string \| int

Returns

Type	Description
mixed

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

Override offsetSet to enforce style creation

Parameters

Name	Type	Description
$index	string \| int
$value	mixed

offsetUnset(string | int $offset) : void

inherited

ArrayAccess: offsetUnset

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::offsetUnset()

Parameters

Name	Type	Description
$offset	string \| int

prepend(mixed $value) : void

Override prepend to enforce style creation

Parameters

Name	Type	Description
$value	mixed

set(mixed $value) : void

Override set to enforce style creation

Parameters

Name	Type	Description
$value	mixed

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

Name	Type	Description
$autoEscape	bool	whether or not to auto escape output

Returns

Type	Description
\Zend_View_Helper_Placeholder_Container_Standalone

setContainer(\Zend_View_Helper_Placeholder_Container_Abstract $container) : \Zend_View_Helper_Placeholder_Container_Standalone

inherited

Set container on which to operate

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::setContainer()

Parameters

Name	Type	Description
$container	\Zend_View_Helper_Placeholder_Container_Abstract

Returns

Type	Description
\Zend_View_Helper_Placeholder_Container_Standalone

setRegistry(\Zend_View_Helper_Placeholder_Registry $registry) : \Zend_View_Helper_Placeholder_Container_Standalone

inherited

Set registry object

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::setRegistry()

Parameters

Name	Type	Description
$registry	\Zend_View_Helper_Placeholder_Registry

Returns

Type	Description
\Zend_View_Helper_Placeholder_Container_Standalone

setView(\Zend_View_Interface $view) : \Zend_View_Helper_Abstract

inherited

Set the View object

Inherited from: \Zend_View_Helper_Abstract::setView()\Zend_View_Helper_Placeholder_Container_Standalone::setView()

Parameters

Name	Type	Description
$view	\Zend_View_Interface

Returns

Type	Description
\Zend_View_Helper_Abstract

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

Create string representation of placeholder

Parameters

Name	Type	Description
$indent	string \| int

Returns

Type	Description
string

View/Helper/HeadStyle.php

\Zend_View_Helper_HeadStylejump to top

Properties

Methods

\Zend_View_Helper_HeadStyle
jump to top