View/Helper/HeadScript.php
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: HeadScript.php 24960 2012-06-15 14:09:34Z adamlundrigan $
\Zend_View_Helper_HeadScript
- Parent(s)
- \Zend_View_Helper_Placeholder_Container_Standalone < \Zend_View_Helper_Abstract
- Children
- \Zend_View_Helper_InlineScript
- 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
Constants
Properties


bool $_arbitraryAttributes = false
false
Details- Type
- bool


\book $_autoEscape = true
true
Details- Type
- \book
- Inherited_from
- \Zend_View_Helper_Placeholder_Container_Standalone::$$_autoEscape


\Zend_View_Helper_Placeholder_Container_Abstract $_container


array $_optionalAttributes = array('charset', 'defer', 'language', 'src')
array('charset', 'defer', 'language', 'src')
Details- Type
- array


string $_regKey = 'Zend_View_Helper_HeadScript'
'Zend_View_Helper_HeadScript'
Details- Type
- string


\Zend_View_Helper_Placeholder_Registry $_registry


string $_requiredAttributes = array('type')
array('type')
Details- Type
- string


bool $useCdata = false
false
Details- Type
- bool


\Zend_View_Interface $view = null
null
Details- 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) : \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())
Name | Type | Description |
---|---|---|
$method | string | |
$args | array |
Type | Description |
---|---|
\Zend_View_Helper_HeadScript |
Exception | Description |
---|---|
\Zend_View_Exception | if too few arguments or invalid method |


__get(string $key) : mixed
Overloading: retrieve property
Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__get()Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
mixed |


__isset(string $key) : bool
Overloading: check if property is set
Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__isset()Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
bool |


__set(string $key, mixed $value) : void
Overloading: set property value
Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__set()Name | Type | Description |
---|---|---|
$key | string | |
$value | mixed |


__toString() : string
Cast to string representation
Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__toString()Type | Description |
---|---|
string |


__unset(string $key) : void
Overloading: unset property
Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__unset()Name | Type | Description |
---|---|---|
$key | string |


_escape(string $string) : string
Escape a string
Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::_escape()Name | Type | Description |
---|---|---|
$string | string |
Type | Description |
---|---|
string |


_isDuplicate(string $file) : bool
Is the file specified a duplicate?
Name | Type | Description |
---|---|---|
$file | string |
Type | Description |
---|---|
bool |


_isValid(mixed $value) : bool
Is the script provided valid?
Name | Type | Description |
---|---|---|
$value | mixed |
Type | Description |
---|---|
bool |


captureStart(mixed $captureType = \Zend_View_Helper_Placeholder_Container_Abstract::APPEND, $type = 'text/javascript', $attrs = array()) : void
Start capture action
Name | Type | Description |
---|---|---|
$captureType | mixed | |
$type | ||
$attrs |


createData(string $type, array $attributes, string $content = null) : \stdClass
Create data item containing all necessary components of script
Name | Type | Description |
---|---|---|
$type | string | |
$attributes | array | |
$content | string |
Type | Description |
---|---|
\stdClass |


direct() : void
Strategy pattern: currently unutilized
Inherited from: \Zend_View_Helper_Abstract::direct()\Zend_View_Helper_Placeholder_Container_Standalone::direct()

getAutoEscape() : void
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
Retrieve placeholder container
Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::getContainer()Type | Description |
---|---|
\Zend_View_Helper_Placeholder_Container_Abstract |


getIterator() : \Iterator
IteratorAggregate: get Iterator
Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::getIterator()Type | Description |
---|---|
\Iterator |


getRegistry() : \Zend_View_Helper_Placeholder_Registry
Retrieve registry
Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::getRegistry()Type | Description |
---|---|
\Zend_View_Helper_Placeholder_Registry |


headScript(string $mode = \Zend_View_Helper_HeadScript::FILE, 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.
Name | Type | Description |
---|---|---|
$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 |
Type | Description |
---|---|
\Zend_View_Helper_HeadScript |


itemToString( $item, string | int $indent, $escapeStart, $escapeEnd) : string
Create script HTML
Name | Type | Description |
---|---|---|
$item | ||
$indent | string | int | |
$escapeStart | ||
$escapeEnd |
Type | Description |
---|---|
string |


offsetExists(string | int $offset) : bool
ArrayAccess: offsetExists
Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::offsetExists()Name | Type | Description |
---|---|---|
$offset | string | int |
Type | Description |
---|---|
bool |


offsetGet(string | int $offset) : mixed
ArrayAccess: offsetGet
Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::offsetGet()Name | Type | Description |
---|---|---|
$offset | string | int |
Type | Description |
---|---|
mixed |


offsetSet(string | int $index, mixed $value) : void
Override offsetSet
Name | Type | Description |
---|---|---|
$index | string | int | |
$value | mixed |


offsetUnset(string | int $offset) : void
ArrayAccess: offsetUnset
Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::offsetUnset()Name | Type | Description |
---|---|---|
$offset | string | int |


setAllowArbitraryAttributes(bool $flag) : \Zend_View_Helper_HeadScript
Set flag indicating if arbitrary attributes are allowed
Name | Type | Description |
---|---|---|
$flag | bool |
Type | Description |
---|---|
\Zend_View_Helper_HeadScript |


setAutoEscape(bool $autoEscape = true) : \Zend_View_Helper_Placeholder_Container_Standalone
Set whether or not auto escaping should be used
Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::setAutoEscape()Name | Type | Description |
---|---|---|
$autoEscape | bool | whether or not to auto escape output |
Type | Description |
---|---|
\Zend_View_Helper_Placeholder_Container_Standalone |


setContainer(\Zend_View_Helper_Placeholder_Container_Abstract $container) : \Zend_View_Helper_Placeholder_Container_Standalone
Set container on which to operate
Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::setContainer()Name | Type | Description |
---|---|---|
$container | \Zend_View_Helper_Placeholder_Container_Abstract |
Type | Description |
---|---|
\Zend_View_Helper_Placeholder_Container_Standalone |


setRegistry(\Zend_View_Helper_Placeholder_Registry $registry) : \Zend_View_Helper_Placeholder_Container_Standalone
Set registry object
Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::setRegistry()Name | Type | Description |
---|---|---|
$registry | \Zend_View_Helper_Placeholder_Registry |
Type | Description |
---|---|
\Zend_View_Helper_Placeholder_Container_Standalone |


setView(\Zend_View_Interface $view) : \Zend_View_Helper_Abstract
Set the View object
Inherited from: \Zend_View_Helper_Abstract::setView()\Zend_View_Helper_Placeholder_Container_Standalone::setView()Name | Type | Description |
---|---|---|
$view | \Zend_View_Interface |
Type | Description |
---|---|
\Zend_View_Helper_Abstract |