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.
Helper for setting and retrieving script elements for HTML head section

bool
$_arbitraryAttributes= 'false'
Are arbitrary attributes allowed?
false
Details
array
$_optionalAttributes= 'array(
'charset''
Optional allowed attributes for script tag
array(
'charset'
Details
string
$_regKey= ''Zend_View_Helper_HeadScript''
Registry key for placeholder
'Zend_View_Helper_HeadScript'
Details
string
$_requiredAttributes= 'array('type')'
Required attributes for script tag
array('type')
Details
__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 |

_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 |

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 |

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

setAllowArbitraryAttributes(
bool $flag
)
:
\Zend_View_Helper_HeadScript
Set flag indicating if arbitrary attributes are allowed