Helper for setting and retrieving script elements for HTML head section

uses
package Zend_View
subpackage Helper
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License
inherited_from \Zend_View_Helper_Placeholder_Container_Standalone

 Methods

$this appendFile($src, $type = 'text/javascript', array $attrs = array())

() : 
magic
method $this appendFile($src, $type = 'text/javascript', array $attrs = array())

Returns

$this appendScript($script, $type = 'text/javascript', array $attrs = array())

() : 
magic
method $this appendScript($script, $type = 'text/javascript', array $attrs = array())

Returns

$this offsetSetFile($index, $src, $type = 'text/javascript', array $attrs = array())

() : 
magic
method $this offsetSetFile($index, $src, $type = 'text/javascript', array $attrs = array())

Returns

$this offsetSetScript($index, $script, $type = 'text/javascript', array $attrs = array())

() : 
magic
method $this offsetSetScript($index, $script, $type = 'text/javascript', array $attrs = array())

Returns

$this prependFile($src, $type = 'text/javascript', array $attrs = array())

() : 
magic
method $this prependFile($src, $type = 'text/javascript', array $attrs = array())

Returns

$this prependScript($script, $type = 'text/javascript', array $attrs = array())

() : 
magic
method $this prependScript($script, $type = 'text/javascript', array $attrs = array())

Returns

$this setFile($src, $type = 'text/javascript', array $attrs = array())

() : 
magic
method $this setFile($src, $type = 'text/javascript', array $attrs = array())

Returns

$this setScript($script, $type = 'text/javascript', array $attrs = array())

() : 
magic
method $this setScript($script, $type = 'text/javascript', array $attrs = array())

Returns

Overload method access

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

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())
inherited_from \Zend_View_Helper_Placeholder_Container_Standalone::__call()

Parameters

$method

string

$args

array

Exceptions

\Zend_View_Exception if too few arguments or invalid method

Returns

\Zend_View_Helper_HeadScript

Overload

__call(string $method, array $args) : mixed
Inherited

Proxy to container methods

Parameters

$method

string

$args

array

Returns

mixed

Constructor

__construct() : void

Set separator to PHP_EOL.

inherited_from \Zend_View_Helper_Placeholder_Container_Standalone::__construct()

Constructor

__construct() : void
Inherited

Overloading: retrieve property

__get(string $key) : mixed
Inherited

Parameters

$key

string

Returns

mixed

Overloading: check if property is set

__isset(string $key) : boolean
Inherited

Parameters

$key

string

Returns

boolean

Overloading: set property value

__set(string $key, mixed $value) : void
Inherited

Parameters

$key

string

$value

mixed

Cast to string representation

__toString() : string
Inherited

Returns

string

Overloading: unset property

__unset(string $key) : void
Inherited

Parameters

$key

string

Override append

append(string $value) : void

Parameters

$value

string

Are arbitrary attributes allowed?

arbitraryAttributesAllowed() : boolean

Returns

boolean

End capture action and store

captureEnd() : void

Start capture action

captureStart(mixed $captureType = \Zend_View_Helper_Placeholder_Container_Abstract::APPEND, $type = 'text/javascript', $attrs = array()) : void

Parameters

$captureType

mixed

$type

$attrs

Countable

count() : integer
Inherited

Returns

integer

Create data item containing all necessary components of script

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

Parameters

$type

string

$attributes

array

$content

string

Returns

\stdClass

Strategy pattern: currently unutilized

direct() : void
Inherited
inherited_from \Zend_View_Helper_Interface::direct()

Return whether autoEscaping is enabled or disabled

getAutoEscape() 
Inherited

return bool

Retrieve placeholder container

getContainer() : \Zend_View_Helper_Placeholder_Container_Abstract
Inherited

Returns

\Zend_View_Helper_Placeholder_Container_Abstract

IteratorAggregate: get Iterator

getIterator() : \Iterator
Inherited

Returns

\Iterator

Retrieve registry

getRegistry() : \Zend_View_Helper_Placeholder_Registry
Inherited

Returns

\Zend_View_Helper_Placeholder_Registry

Return headScript object

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

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

Parameters

$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

Returns

\Zend_View_Helper_HeadScript

Create script HTML

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

Parameters

$item

$indent

stringinteger

$escapeStart

$escapeEnd

Returns

string

ArrayAccess: offsetExists

offsetExists(string|integer $offset) : boolean
Inherited

Parameters

$offset

stringinteger

Returns

boolean

ArrayAccess: offsetGet

offsetGet(string|integer $offset) : mixed
Inherited

Parameters

$offset

stringinteger

Returns

mixed

Override offsetSet

offsetSet(string|integer $index, mixed $value) : void
inherited_from \Zend_View_Helper_Placeholder_Container_Standalone::offsetSet()

Parameters

$index

stringinteger

$value

mixed

ArrayAccess: offsetSet

offsetSet(string|integer $offset, mixed $value) : void
Inherited

Parameters

$offset

stringinteger

$value

mixed

ArrayAccess: offsetUnset

offsetUnset(string|integer $offset) : void
Inherited

Parameters

$offset

stringinteger

Override prepend

prepend(string $value) : void

Parameters

$value

string

Override set

set(string $value) : void

Parameters

$value

string

Set flag indicating if arbitrary attributes are allowed

setAllowArbitraryAttributes(boolean $flag) : \Zend_View_Helper_HeadScript

Parameters

$flag

boolean

Returns

\Zend_View_Helper_HeadScript

Set whether or not auto escaping should be used

setAutoEscape(boolean $autoEscape = true) : \Zend_View_Helper_Placeholder_Container_Standalone
Inherited

Parameters

$autoEscape

boolean

whether or not to auto escape output

Returns

\Zend_View_Helper_Placeholder_Container_Standalone

Set container on which to operate

setContainer(\Zend_View_Helper_Placeholder_Container_Abstract $container) : \Zend_View_Helper_Placeholder_Container_Standalone
Inherited

Parameters

$container

\Zend_View_Helper_Placeholder_Container_Abstract

Returns

\Zend_View_Helper_Placeholder_Container_Standalone

Set registry object

setRegistry(\Zend_View_Helper_Placeholder_Registry $registry) : \Zend_View_Helper_Placeholder_Container_Standalone
Inherited

Parameters

$registry

\Zend_View_Helper_Placeholder_Registry

Returns

\Zend_View_Helper_Placeholder_Container_Standalone

Set the View object

setView(\Zend_View_Interface $view) : \Zend_View_Helper_Abstract
Inherited
inherited_from \Zend_View_Helper_Interface::setView()

Parameters

$view

\Zend_View_Interface

Returns

\Zend_View_Helper_Abstract

Retrieve string representation

toString(string|integer $indent = null) : string
inherited_from \Zend_View_Helper_Placeholder_Container_Standalone::toString()

Parameters

$indent

stringinteger

Returns

string

String representation

toString() : string
Inherited

Returns

string

Escape a string

_escape(string $string) : string
Inherited

Parameters

$string

string

Returns

string

Is the file specified a duplicate?

_isDuplicate(string $file) : boolean

Parameters

$file

string

Returns

boolean

Is the script provided valid?

_isValid(mixed $value) : boolean

Parameters

$value

mixed

Returns

boolean

 Properties

 

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

$useCdata : boolean

Default

false
 

View object

$view : \Zend_View_Interface

Default

null
 

Are arbitrary attributes allowed?

$_arbitraryAttributes : boolean

Default

false
 

Flag wheter to automatically escape output, must also be enforced in the child class if __toString/toString is overriden

$_autoEscape : \book

Default

true
 

$_captureLock

$_captureLock 

Default

 

$_captureScriptAttrs

$_captureScriptAttrs 

Default

null
 

$_captureScriptType

$_captureScriptType 

Default

null
 

$_captureType

$_captureType 

Default

 

$_container

$_container : \Zend_View_Helper_Placeholder_Container_Abstract

Default

 

Optional allowed attributes for script tag

$_optionalAttributes : array

Default

array('charset', 'defer', 'language', 'src')
 

Registry key for placeholder

$_regKey : string

Default

'Zend_View_Helper_HeadScript'
inherited_from \Zend_View_Helper_Placeholder_Container_Standalone::_regKey
 

Registry key under which container registers itself

$_regKey : string

Default

 

$_registry

$_registry : \Zend_View_Helper_Placeholder_Registry

Default

 

Required attributes for script tag

$_requiredAttributes : string

Default

array('type')

 Constants

 

FILE

FILE = 'FILE' 
 

SCRIPT

SCRIPT = 'SCRIPT'