API Documentation

View/Helper/InlineScript.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_View  
subpackage
Helper  
version
$Id: InlineScript.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_View_Helper_InlineScript

Helper for setting and retrieving script elements for inclusion in HTML body section

Extends from
\Zend_View_Helper_HeadScript
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_View  
subpackage
Helper  
uses
\Zend_View_Helper_Head_Script  

Properties

Propertyprotectedstring  $_regKey= 'Zend_View_Helper_InlineScript'

Registry key for placeholder

Default valueZend_View_Helper_InlineScriptDetails
Type
string

Methods

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

Parameters
Name Type Description
$method string
$args array
Returns
Type Description
\Zend_View_Helper_HeadScript
Throws
Exception Description
\Zend_View_Exception if too few arguments or invalid method
methodpublic__construct( ) : void

Constructor

Inherited from: \Zend_View_Helper_HeadScript::__construct()

Set separator to PHP_EOL.

methodpublic__get( string $key ) : mixed

Overloading: retrieve property

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__get()
Parameters
Name Type Description
$key string
Returns
Type Description
mixed
methodpublic__isset( string $key ) : bool

Overloading: check if property is set

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__isset()
Parameters
Name Type Description
$key string
Returns
Type Description
bool
methodpublic__set( string $key, mixed $value ) : void

Overloading: set property value

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__set()
Parameters
Name Type Description
$key string
$value mixed
methodpublic__toString( ) : string

Cast to string representation

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__toString()
Returns
Type Description
string
methodpublic__unset( string $key ) : void

Overloading: unset property

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::__unset()
Parameters
Name Type Description
$key string
methodprotected_escape( string $string ) : string
Parameters
Name Type Description
$string string
Returns
Type Description
string
methodprotected_isDuplicate( string $file ) : bool

Is the file specified a duplicate?

Inherited from: \Zend_View_Helper_HeadScript::_isDuplicate()
Parameters
Name Type Description
$file string
Returns
Type Description
bool
methodprotected_isValid( mixed $value ) : bool

Is the script provided valid?

Inherited from: \Zend_View_Helper_HeadScript::_isValid()
Parameters
Name Type Description
$value mixed
Returns
Type Description
bool
methodpublicappend( string $value ) : void

Override append

Inherited from: \Zend_View_Helper_HeadScript::append()
Parameters
Name Type Description
$value string
methodpublicarbitraryAttributesAllowed( ) : bool

Are arbitrary attributes allowed?

Inherited from: \Zend_View_Helper_HeadScript::arbitraryAttributesAllowed()
Returns
Type Description
bool
methodpubliccaptureEnd( ) : void

End capture action and store

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

Start capture action

Inherited from: \Zend_View_Helper_HeadScript::captureStart()
Parameters
Name Type Description
$captureType mixed
$type
$attrs
methodpubliccount( ) : int
Returns
Type Description
int
methodpubliccreateData( string $type, array $attributes, string $content = null ) : \stdClass

Create data item containing all necessary components of script

Inherited from: \Zend_View_Helper_HeadScript::createData()
Parameters
Name Type Description
$type string
$attributes array
$content string
Returns
Type Description
\stdClass
methodpublicdirect( ) : void

Strategy pattern: currently unutilized

Inherited from: \Zend_View_Helper_Abstract::direct()
methodpublicgetAutoEscape( ) : void

Return whether autoEscaping is enabled or disabled

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::getAutoEscape()

return bool

methodpublicgetIterator( ) : \Iterator

IteratorAggregate: get Iterator

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::getIterator()
Returns
Type Description
\Iterator
methodpublicheadScript( 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.

Parameters
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

Returns
Type Description
\Zend_View_Helper_HeadScript
methodpublicinlineScript( 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.

Parameters
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

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

Create script HTML

Inherited from: \Zend_View_Helper_HeadScript::itemToString()
Parameters
Name Type Description
$item
$indent string|int
$escapeStart
$escapeEnd
Returns
Type Description
string
methodpublicoffsetExists( string|int $offset ) : bool

ArrayAccess: offsetExists

Inherited from: \Zend_View_Helper_Placeholder_Container_Standalone::offsetExists()
Parameters
Name Type Description
$offset string|int
Returns
Type Description
bool
methodpublicoffsetGet( string|int $offset ) : mixed
Parameters
Name Type Description
$offset string|int
Returns
Type Description
mixed
methodpublicoffsetSet( string|int $index, mixed $value ) : void

Override offsetSet

Inherited from: \Zend_View_Helper_HeadScript::offsetSet()
Parameters
Name Type Description
$index string|int
$value mixed
methodpublicoffsetUnset( string|int $offset ) : void
Parameters
Name Type Description
$offset string|int
methodpublicprepend( string $value ) : void

Override prepend

Inherited from: \Zend_View_Helper_HeadScript::prepend()
Parameters
Name Type Description
$value string
methodpublicset( string $value ) : void

Override set

Inherited from: \Zend_View_Helper_HeadScript::set()
Parameters
Name Type Description
$value string
methodpublicsetAllowArbitraryAttributes( bool $flag ) : \Zend_View_Helper_HeadScript

Set flag indicating if arbitrary attributes are allowed

Inherited from: \Zend_View_Helper_HeadScript::setAllowArbitraryAttributes()
Parameters
Name Type Description
$flag bool
Returns
Type Description
\Zend_View_Helper_HeadScript
methodpublicsetAutoEscape( 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()
Parameters
Name Type Description
$autoEscape bool whether or not to auto escape output
Returns
Type Description
\Zend_View_Helper_Placeholder_Container_Standalone
methodpublicsetView( \Zend_View_Interface $view ) : \Zend_View_Helper_Abstract

Set the View object

Inherited from: \Zend_View_Helper_Abstract::setView()
Parameters
Name Type Description
$view \Zend_View_Interface
Returns
Type Description
\Zend_View_Helper_Abstract
methodpublictoString( string|int $indent = null ) : string

Retrieve string representation

Inherited from: \Zend_View_Helper_HeadScript::toString()
Parameters
Name Type Description
$indent string|int
Returns
Type Description
string
Documentation was generated by DocBlox 0.13.3.