View/Helper/HeadStyle.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_View
subpackage: Helper
version: $Id: HeadStyle.php 20104 2010-01-06 21:26:01Z matthew $
Classes: Zend_View_Helper_HeadStyle

Description

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.

Zend_View_Helper_HeadStyle
jump to top

Extends from: Zend_View_Helper_Placeholder_Container_Standalone
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_View
subpackage: Helper
uses: Zend_View_Helper_Placeholder_Container_Standalone
Properties: $_regKey; $_optionalAttributes; $_mediaTypes; $_captureAttrs; $_captureLock; $_captureType
Methods: __construct; headStyle; __call; _isValid; append; offsetSet; prepend; set; captureStart; captureEnd; itemToString; toString; createData

Description

Helper for setting and retrieving stylesheets

Properties

$_captureAttrs
jump to class

string $_captureAttrs = 'null'

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

Details

$_captureAttrs: string
visibility: protected
default: null
final: false
static: false

$_captureLock
jump to class

bool $_captureLock = ''

Capture lock

Details

$_captureLock: bool
visibility: protected
default
final: false
static: false

$_captureType
jump to class

string $_captureType = ''

Capture type (append, prepend, set)

Details

$_captureType: string
visibility: protected
default
final: false
static: false

$_mediaTypes
jump to class

array $_mediaTypes = 'array'

Allowed media types

Details

$_mediaTypes: array
visibility: protected
default: array
final: false
static: false

$_optionalAttributes
jump to class

array $_optionalAttributes = 'array'

Allowed optional attributes

Details

$_optionalAttributes: array
visibility: protected
default: array
final: false
static: false

$_regKey
jump to class

string $_regKey = 'Zend_View_Helper_HeadStyle'

Registry key for placeholder

Details

$_regKey: string
visibility: protected
default: Zend_View_Helper_HeadStyle
final: false
static: false

Methods

__call
jump to class

__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())

Arguments

$method: string
$args: array

Details

visibility: public
final: false
static: false
throws: When no $content provided or invalid method

__construct
jump to class

__construct(
          
          )
        
        :
        void

Constructor

Set separator to PHP_EOL.

Details

visibility: public
final: false
static: false

_isValid
jump to class

_isValid(
          mixed $value
          )
        
        :
        boolean

Determine if a value is a valid style tag

Arguments

$value: mixed

Output

boolean

Details

visibility: protected
final: false
static: false

append
jump to class

append(
          mixed $value
          )
        
        :
        void

Override append to enforce style creation

Arguments

$value: mixed

Details

visibility: public
final: false
static: false

captureEnd
jump to class

captureEnd(
          
          )
        
        :
        void

End capture action and store

Details

visibility: public
final: false
static: false

captureStart
jump to class

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

Start capture action

Arguments

$type
$attrs

Details

visibility: public
final: false
static: false

createData
jump to class

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

Create data item for use in stack

Arguments

$content: string
$attributes: array

Output

stdClass

Details

visibility: public
final: false
static: false

headStyle
jump to class

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

Arguments

$content: string
Stylesheet contents
$placement: string
Append, prepend, or set
$attributes: stringarray
Optional attributes to utilize

Output

Zend_View_Helper_HeadStyle

Details

visibility: public
final: false
static: false

itemToString
jump to class

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

Convert content and attributes into valid style tag

Arguments

$item: stdClass
Item to render
$indent: string
Indentation to use

Output

string

Details

visibility: public
final: false
static: false

offsetSet
jump to class

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

Override offsetSet to enforce style creation

Arguments

$index: stringint
$value: mixed

Details

visibility: public
final: false
static: false

prepend
jump to class

prepend(
          mixed $value
          )
        
        :
        void

Override prepend to enforce style creation

Arguments

$value: mixed

Details

visibility: public
final: false
static: false

set
jump to class

set(
          mixed $value
          )
        
        :
        void

Override set to enforce style creation

Arguments

$value: mixed

Details

visibility: public
final: false
static: false

toString
jump to class

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

Create string representation of placeholder

Arguments

$indent: stringint

Output

string

Details

visibility: public
final: false
static: false

API Documentation

View/Helper/HeadStyle.php

Description

Zend_View_Helper_HeadStylejump to top

Description

Properties

$_captureAttrsjump to class

Details

$_captureLockjump to class

Details

$_captureTypejump to class

Details

$_mediaTypesjump to class

Details

$_optionalAttributesjump to class

Details

$_regKeyjump to class

Details

Methods

__calljump to class

Arguments

Details

__constructjump to class

Details

_isValidjump to class

Arguments

Output

Details

appendjump to class

Arguments

Details

captureEndjump to class

Details

captureStartjump to class

Arguments

Details

createDatajump to class

Arguments

Output

Details

headStylejump to class

Arguments

Output

Details

itemToStringjump to class

Arguments

Output

Details

offsetSetjump to class

Arguments

Details

prependjump to class

Arguments

Details

setjump to class

Arguments

Details

toStringjump to class

Arguments

Output

Details

Zend_View_Helper_HeadStyle
jump to top

$_captureAttrs
jump to class

$_captureLock
jump to class

$_captureType
jump to class

$_mediaTypes
jump to class

$_optionalAttributes
jump to class

$_regKey
jump to class

__call
jump to class

__construct
jump to class

_isValid
jump to class

append
jump to class

captureEnd
jump to class

captureStart
jump to class

createData
jump to class

headStyle
jump to class

itemToString
jump to class

offsetSet
jump to class

prepend
jump to class

set
jump to class

toString
jump to class