View/Helper/InlineScript.php

Show: PublicProtectedPrivateinherited
Table of Contents
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.

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: InlineScript.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_View_Helper_InlineScript

Package: Zend\View\Helper
Helper for setting and retrieving script elements for inclusion in HTML body section
Parent(s)
\Zend_View_Helper_HeadScript < \Zend_View_Helper_Placeholder_Container_Standalone < \Zend_View_Helper_Abstract
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Uses
\global\Zend_View_Helper_Head_Script  

Constants

>VConstant  FILE = 'FILE'
inheritedInherited from: \Zend_View_Helper_HeadScript::FILE
>VConstant  SCRIPT = 'SCRIPT'
inheritedInherited from: \Zend_View_Helper_HeadScript::SCRIPT

Properties

>VPropertyprotectedbool $_arbitraryAttributes = false
inherited
Are arbitrary attributes allowed?
Inherited from: \Zend_View_Helper_HeadScript::$$_arbitraryAttributes
Default valuefalseDetails
Type
bool
Inherited_from
\Zend_View_Helper_HeadScript::$$_arbitraryAttributes  
>VPropertyprotected\book $_autoEscape = true
inherited
Flag wheter to automatically escape output, must also be enforced in the child class if __toString/toString is overriden
Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::$$_autoEscape\Zend_View_Helper_HeadScript::$$_autoEscape
>VPropertyprotected$_captureLock
Details
Type
n/a
Inherited_from
\Zend_View_Helper_HeadScript::$$_captureLock  
>VPropertyprotected$_captureScriptAttrs = null
Default valuenullDetails
Type
n/a
Inherited_from
\Zend_View_Helper_HeadScript::$$_captureScriptAttrs  
>VPropertyprotected$_captureScriptType = null
Default valuenullDetails
Type
n/a
Inherited_from
\Zend_View_Helper_HeadScript::$$_captureScriptType  
>VPropertyprotected$_captureType
Details
Type
n/a
Inherited_from
\Zend_View_Helper_HeadScript::$$_captureType  
>VPropertyprotectedarray $_optionalAttributes = array('charset', 'defer', 'language', 'src')
inherited
Optional allowed attributes for script tag
Inherited from: \Zend_View_Helper_HeadScript::$$_optionalAttributes
Default valuearray('charset', 'defer', 'language', 'src')Details
Type
array
Inherited_from
\Zend_View_Helper_HeadScript::$$_optionalAttributes  
>VPropertyprotectedstring $_regKey = 'Zend_View_Helper_InlineScript'
Registry key for placeholder
Default value'Zend_View_Helper_InlineScript'Details
Type
string
>VPropertyprotectedstring $_requiredAttributes = array('type')
inherited
Required attributes for script tag
Inherited from: \Zend_View_Helper_HeadScript::$$_requiredAttributes
Default valuearray('type')Details
Type
string
Inherited_from
\Zend_View_Helper_HeadScript::$$_requiredAttributes  
>VPropertypublicbool $useCdata = false
inherited
Whether or not to format scripts using CDATA; used only if doctype helper is not accessible
Inherited from: \Zend_View_Helper_HeadScript::$$useCdata
Default valuefalseDetails
Type
bool
Inherited_from
\Zend_View_Helper_HeadScript::$$useCdata  

Methods

methodpublic__call(string $method, array $args) : \Zend_View_Helper_HeadScript
inherited

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())

Parameters
NameTypeDescription
$methodstring
$argsarray
Returns
TypeDescription
\Zend_View_Helper_HeadScript
Throws
ExceptionDescription
\Zend_View_Exceptionif too few arguments or invalid method
methodpublic__construct() : void
inherited

Constructor

Inherited from: \Zend_View_Helper_HeadScript::__construct()

Set separator to PHP_EOL.

methodpublic__get(string $key) : mixed
Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
mixed
methodpublic__isset(string $key) : bool
Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
bool
methodpublic__set(string $key, mixed $value) : void
Parameters
NameTypeDescription
$keystring
$valuemixed
methodpublic__toString() : string
Returns
TypeDescription
string
methodpublic__unset(string $key) : void
Parameters
NameTypeDescription
$keystring
methodprotected_escape(string $string) : string
Parameters
NameTypeDescription
$stringstring
Returns
TypeDescription
string
methodprotected_isDuplicate(string $file) : bool
inherited

Is the file specified a duplicate?

Inherited from: \Zend_View_Helper_HeadScript::_isDuplicate()
Parameters
NameTypeDescription
$filestring
Returns
TypeDescription
bool
methodprotected_isValid(mixed $value) : bool
inherited

Is the script provided valid?

Inherited from: \Zend_View_Helper_HeadScript::_isValid()
Parameters
NameTypeDescription
$valuemixed
Returns
TypeDescription
bool
methodpublicappend(string $value) : void
inherited

Override append

Inherited from: \Zend_View_Helper_HeadScript::append()
Parameters
NameTypeDescription
$valuestring
methodpublicarbitraryAttributesAllowed() : bool
inherited

Are arbitrary attributes allowed?

Inherited from: \Zend_View_Helper_HeadScript::arbitraryAttributesAllowed()
Returns
TypeDescription
bool
methodpubliccaptureEnd() : void
inherited

End capture action and store

Inherited from: \Zend_View_Helper_HeadScript::captureEnd()
methodpubliccaptureStart(mixed $captureType = \Zend_View_Helper_Placeholder_Container_Abstract::APPEND,  $type = 'text/javascript',  $attrs = array()) : void
inherited

Start capture action

Inherited from: \Zend_View_Helper_HeadScript::captureStart()
Parameters
NameTypeDescription
$captureTypemixed
$type
$attrs
methodpubliccount() : int
Returns
TypeDescription
int
methodpubliccreateData(string $type, array $attributes, string $content = null) : \stdClass
inherited

Create data item containing all necessary components of script

Inherited from: \Zend_View_Helper_HeadScript::createData()
Parameters
NameTypeDescription
$typestring
$attributesarray
$contentstring
Returns
TypeDescription
\stdClass
methodpublicgetAutoEscape() : void
inherited

Return whether autoEscaping is enabled or disabled

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::getAutoEscape()\Zend_View_Helper_HeadScript::getAutoEscape()

return bool

methodpublicgetIterator() : \Iterator
Returns
TypeDescription
\Iterator
methodpublicheadScript(string $mode = \Zend_View_Helper_HeadScript::FILE, string $spec = null, string $placement = 'APPEND', array $attrs = array(), string $type = 'text/javascript') : \Zend_View_Helper_HeadScript
inherited

Return headScript object

Inherited from: \Zend_View_Helper_HeadScript::headScript()

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

Parameters
NameTypeDescription
$modestring

Script or file

$specstring

Script/url

$placementstring

Append, prepend, or set

$attrsarray

Array of script attributes

$typestring

Script type and/or array of script attributes

Returns
TypeDescription
\Zend_View_Helper_HeadScript
methodpublicinlineScript(string $mode = \Zend_View_Helper_HeadScript::FILE, 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.

Parameters
NameTypeDescription
$modestring

Script or file

$specstring

Script/url

$placementstring

Append, prepend, or set

$attrsarray

Array of script attributes

$typestring

Script type and/or array of script attributes

Returns
TypeDescription
\Zend_View_Helper_InlineScript
methodpublicitemToString( $item, string | int $indent,  $escapeStart,  $escapeEnd) : string
inherited

Create script HTML

Inherited from: \Zend_View_Helper_HeadScript::itemToString()
Parameters
NameTypeDescription
$item
$indentstring | int
$escapeStart
$escapeEnd
Returns
TypeDescription
string
methodpublicoffsetExists(string | int $offset) : bool
Parameters
NameTypeDescription
$offsetstring | int
Returns
TypeDescription
bool
methodpublicoffsetGet(string | int $offset) : mixed
Parameters
NameTypeDescription
$offsetstring | int
Returns
TypeDescription
mixed
methodpublicoffsetSet(string | int $index, mixed $value) : void
inherited

Override offsetSet

Inherited from: \Zend_View_Helper_HeadScript::offsetSet()
Parameters
NameTypeDescription
$indexstring | int
$valuemixed
methodpublicoffsetUnset(string | int $offset) : void
Parameters
NameTypeDescription
$offsetstring | int
methodpublicprepend(string $value) : void
inherited

Override prepend

Inherited from: \Zend_View_Helper_HeadScript::prepend()
Parameters
NameTypeDescription
$valuestring
methodpublicset(string $value) : void
inherited

Override set

Inherited from: \Zend_View_Helper_HeadScript::set()
Parameters
NameTypeDescription
$valuestring
methodpublicsetAllowArbitraryAttributes(bool $flag) : \Zend_View_Helper_HeadScript
inherited

Set flag indicating if arbitrary attributes are allowed

Inherited from: \Zend_View_Helper_HeadScript::setAllowArbitraryAttributes()
Parameters
NameTypeDescription
$flagbool
Returns
TypeDescription
\Zend_View_Helper_HeadScript
methodpublicsetAutoEscape(bool $autoEscape = true) : \Zend_View_Helper_Placeholder_Container_Standalone
Parameters
NameTypeDescription
$autoEscapebool

whether or not to auto escape output

Returns
TypeDescription
\Zend_View_Helper_Placeholder_Container_Standalone
methodpublictoString(string | int $indent = null) : string
inherited

Retrieve string representation

Inherited from: \Zend_View_Helper_HeadScript::toString()
Parameters
NameTypeDescription
$indentstring | int
Returns
TypeDescription
string
Documentation was generated by phpDocumentor 2.0.0a12.