API Documentation

Zend/View/Helper/HeadStyle.php

Show: inherited
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 license@zend.com 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 24594 2012-01-05 21:27:01Z matthew $  

\Zend_View_Helper_HeadStyle

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
\Zend_View_Helper_Placeholder_Container_Standalone  

Properties

Propertyprotectedstring  $_captureAttrs= 'null'

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

Default valuenullDetails
Type
string
Propertyprotectedbool  $_captureLock= ''

Capture lock

Details
Type
bool
Propertyprotectedstring  $_captureType= ''

Capture type (append, prepend, set)

Details
Type
string
Propertyprotectedarray  $_mediaTypes= 'array( 'all''

Allowed media types

Default valuearray( 'all'Details
Type
array
Propertyprotectedarray  $_optionalAttributes= 'array('lang''

Allowed optional attributes

Default valuearray('lang'Details
Type
array
Propertyprotectedstring  $_regKey= ''Zend_View_Helper_HeadStyle''

Registry key for placeholder

Default value'Zend_View_Helper_HeadStyle'Details
Type
string

Methods

methodpublic__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
methodpublic__construct( ) : void

Constructor

Set separator to PHP_EOL.

methodprotected_isValid( mixed $value ) : boolean

Determine if a value is a valid style tag

Parameters
Name Type Description
$value mixed
Returns
Type Description
boolean
methodpublicappend( mixed $value ) : void

Override append to enforce style creation

Parameters
Name Type Description
$value mixed
methodpubliccaptureEnd( ) : void

End capture action and store

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

Start capture action

Parameters
Name Type Description
$type
$attrs
methodpubliccreateData( string $content, array $attributes ) : \stdClass

Create data item for use in stack

Parameters
Name Type Description
$content string
$attributes array
Returns
Type Description
\stdClass
methodpublicheadStyle( 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
methodpublicitemToString( \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
methodpublicoffsetSet( string|int $index, mixed $value ) : void

Override offsetSet to enforce style creation

Parameters
Name Type Description
$index string|int
$value mixed
methodpublicprepend( mixed $value ) : void

Override prepend to enforce style creation

Parameters
Name Type Description
$value mixed
methodpublicset( mixed $value ) : void

Override set to enforce style creation

Parameters
Name Type Description
$value mixed
methodpublictoString( string|int $indent = null ) : string

Create string representation of placeholder

Parameters
Name Type Description
$indent string|int
Returns
Type Description
string
Documentation was generated by DocBlox 0.15.1.