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 inclusion in HTML body section

__call(
string $method, array $args
)
:
\Zend_View_Helper_HeadScript
Overload method access
Inherited from: \Zend_View_Helper_HeadScript::__call()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 |

__construct(
)
:
void
Constructor
Inherited from: \Zend_View_Helper_HeadScript::__construct()Set separator to PHP_EOL.

__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?
Inherited from: \Zend_View_Helper_HeadScript::_isDuplicate()Name | Type | Description |
---|---|---|
$file | string |
Type | Description |
---|---|
bool |

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

append(
string $value
)
:
void
Override append
Inherited from: \Zend_View_Helper_HeadScript::append()Name | Type | Description |
---|---|---|
$value | string |

arbitraryAttributesAllowed(
)
:
bool
Are arbitrary attributes allowed?
Inherited from: \Zend_View_Helper_HeadScript::arbitraryAttributesAllowed()Type | Description |
---|---|
bool |

captureEnd(
)
:
void
End capture action and store
Inherited from: \Zend_View_Helper_HeadScript::captureEnd()
captureStart(
mixed $captureType
=
Zend_View_Helper_Placeholder_Container_Abstract, $type
=
text/javascript, $attrs
=
array
)
:
void
Start capture action
Inherited from: \Zend_View_Helper_HeadScript::captureStart()Name | Type | Description |
---|---|---|
$captureType | mixed | |
$type | ||
$attrs |

count(
)
:
int
Countable
Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::count()Type | Description |
---|---|
int |

createData(
string $type, array $attributes, string $content
=
null
)
:
\stdClass
Create data item containing all necessary components of script
Inherited from: \Zend_View_Helper_HeadScript::createData()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()
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, string $spec
=
null, string $placement
=
APPEND, array $attrs
=
array, string $type
=
text/javascript
)
:
\Zend_View_Helper_HeadScript
Return headScript object
Inherited from: \Zend_View_Helper_HeadScript::headScript()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 |

inlineScript(
string $mode
=
Zend_View_Helper_HeadScript, string $spec
=
null, string $placement
=
APPEND, array $attrs
=
array, string $type
=
text/javascript
)
:
\Zend_View_Helper_InlineScript
Return InlineScript object
Returns InlineScript 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_InlineScript |

itemToString(
$item, string|int $indent, $escapeStart, $escapeEnd
)
:
string
Create script HTML
Inherited from: \Zend_View_Helper_HeadScript::itemToString()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
Inherited from: \Zend_View_Helper_HeadScript::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 |

prepend(
string $value
)
:
void
Override prepend
Inherited from: \Zend_View_Helper_HeadScript::prepend()Name | Type | Description |
---|---|---|
$value | string |

set(
string $value
)
:
void
Override set
Inherited from: \Zend_View_Helper_HeadScript::set()Name | Type | Description |
---|---|---|
$value | string |

setAllowArbitraryAttributes(
bool $flag
)
:
\Zend_View_Helper_HeadScript
Set flag indicating if arbitrary attributes are allowed
Inherited from: \Zend_View_Helper_HeadScript::setAllowArbitraryAttributes()
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()Name | Type | Description |
---|---|---|
$view | \Zend_View_Interface |
Type | Description |
---|---|
\Zend_View_Helper_Abstract |

toString(
string|int $indent
=
null
)
:
string
Retrieve string representation
Inherited from: \Zend_View_Helper_HeadScript::toString()Name | Type | Description |
---|---|---|
$indent | string|int |
Type | Description |
---|---|
string |