API Documentation

View/Helper/HeadScript.php

Includes Classes 
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: HeadScript.php 20364 2010-01-17 23:00:14Z mabe $
Classes
Zend_View_Helper_HeadScript

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_HeadScript
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
Constants
FILE
SCRIPT
Properties
$_regKey
$_arbitraryAttributes
$_captureLock
$_captureScriptType
$_captureScriptAttrs
$_captureType
$_optionalAttributes
$_requiredAttributes
$useCdata
Methods
__construct
headScript
captureStart
captureEnd
__call
_isDuplicate
_isValid
append
prepend
set
offsetSet
setAllowArbitraryAttributes
arbitraryAttributesAllowed
itemToString
toString
createData

Description

Helper for setting and retrieving script elements for HTML head section

Constants

FILE
jump to class

 FILE = 'FILE'

Details

value
FILE

SCRIPT
jump to class

 SCRIPT = 'SCRIPT'

Details

value
SCRIPT

Properties

$_arbitraryAttributes
jump to class

bool $_arbitraryAttributes = 'false'

Are arbitrary attributes allowed?

Details

$_arbitraryAttributes
bool
visibility
protected
default
false
final
false
static
false

$_captureLock
jump to class

 $_captureLock = ''

Details

visibility
protected
default
final
false
static
false

$_captureScriptAttrs
jump to class

 $_captureScriptAttrs = 'null'

Details

visibility
protected
default
null
final
false
static
false

$_captureScriptType
jump to class

 $_captureScriptType = 'null'

Details

visibility
protected
default
null
final
false
static
false

$_captureType
jump to class

 $_captureType = ''

Details

visibility
protected
default
final
false
static
false

$_optionalAttributes
jump to class

array $_optionalAttributes = 'array'

Optional allowed attributes for script tag

Details

$_optionalAttributes
array
visibility
protected
default
array
final
false
static
false

$_regKey
jump to class

string $_regKey = 'Zend_View_Helper_HeadScript'

Registry key for placeholder

Details

$_regKey
string
visibility
protected
default
Zend_View_Helper_HeadScript
final
false
static
false

$_requiredAttributes
jump to class

string $_requiredAttributes = 'array'

Required attributes for script tag

Details

$_requiredAttributes
string
visibility
protected
default
array
final
false
static
false

$useCdata
jump to class

bool $useCdata = 'false'

Whether or not to format scripts using CDATA; used only if doctype helper is not accessible

Details

$useCdata
bool
visibility
public
default
false
final
false
static
false

Methods

__call
jump to class

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

Overload method access

Allows the following method calls: - appendFile($src, $type = 'text/javascript', $attrs = array()) - offsetSetFile($index, $src, $type = 'text/javascript', $attrs = array()) - prependFile($src, $type = 'text/javascript', $attrs = array()) - setFile($src, $type = 'text/javascript', $attrs = array()) - appendScript($script, $type = 'text/javascript', $attrs = array()) - offsetSetScript($index, $src, $type = 'text/javascript', $attrs = array()) - prependScript($script, $type = 'text/javascript', $attrs = array()) - setScript($script, $type = 'text/javascript', $attrs = array())

Arguments
$method
string
$args
array
Output
Zend_View_Helper_HeadScript
Details
visibility
public
final
false
static
false
throws
if too few arguments or invalid method

__construct
jump to class

__construct( ) : void

Constructor

Set separator to PHP_EOL.

Details
visibility
public
final
false
static
false

_isDuplicate
jump to class

_isDuplicate( string $file ) : bool

Is the file specified a duplicate?

Arguments
$file
string
Output
bool
Details
visibility
protected
final
false
static
false

_isValid
jump to class

_isValid( mixed $value ) : bool

Is the script provided valid?

Arguments
$value
mixed
Output
bool
Details
visibility
protected
final
false
static
false

append
jump to class

append( string $value ) : void

Override append

Arguments
$value
string
Details
visibility
public
final
false
static
false

arbitraryAttributesAllowed
jump to class

arbitraryAttributesAllowed( ) : bool

Are arbitrary attributes allowed?

Output
bool
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( mixed $captureType = Zend_View_Helper_Placeholder_Container_Abstract,  $type = text/javascript,  $attrs = array ) : void

Start capture action

Arguments
$captureType
mixed
$type
$attrs
Details
visibility
public
final
false
static
false

createData
jump to class

createData( string $type, array $attributes, string $content = null ) : stdClass

Create data item containing all necessary components of script

Arguments
$type
string
$attributes
array
$content
string
Output
stdClass
Details
visibility
public
final
false
static
false

headScript
jump to class

headScript( string $mode = Zend_View_Helper_HeadScript, string $spec = null, string $placement = APPEND, array $attrs = array, string $type = text/javascript ) : Zend_View_Helper_HeadScript

Return headScript object

Returns headScript helper object; optionally, allows specifying a script or script file to include.

Arguments
$mode
string
Script or file
$spec
string
Script/url
$placement
string
Append, prepend, or set
$attrs
array
Array of script attributes
$type
string
Script type and/or array of script attributes
Output
Zend_View_Helper_HeadScript
Details
visibility
public
final
false
static
false

itemToString
jump to class

itemToString(  $item, string|int $indent,  $escapeStart,  $escapeEnd ) : string

Create script HTML

Arguments
$item
$indent
stringint
$escapeStart
$escapeEnd
Output
string
Details
visibility
public
final
false
static
false

offsetSet
jump to class

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

Override offsetSet

Arguments
$index
stringint
$value
mixed
Details
visibility
public
final
false
static
false

prepend
jump to class

prepend( string $value ) : void

Override prepend

Arguments
$value
string
Details
visibility
public
final
false
static
false

set
jump to class

set( string $value ) : void

Override set

Arguments
$value
string
Details
visibility
public
final
false
static
false

setAllowArbitraryAttributes
jump to class

setAllowArbitraryAttributes( bool $flag ) : Zend_View_Helper_HeadScript

Set flag indicating if arbitrary attributes are allowed

Arguments
$flag
bool
Output
Zend_View_Helper_HeadScript
Details
visibility
public
final
false
static
false

toString
jump to class

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

Retrieve string representation

Arguments
$indent
stringint
Output
string
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.