Class InlineScript

Summary

Fully Qualified Name: Zend\View\Helper\InlineScript
Extends: HeadScript

Description

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

Methods

Name Description Defined By
__call() Overload method access HeadScript
__construct() Constructor HeadScript
__get() Overloading: retrieve property AbstractStandalone
__invoke() Return InlineScript object InlineScript
__isset() Overloading: check if property is set AbstractStandalone
__set() Overloading: set property value AbstractStandalone
__toString() Cast to string representation AbstractStandalone
__unset() Overloading: unset property AbstractStandalone
append() Override append HeadScript
arbitraryAttributesAllowed() Are arbitrary attributes allowed? HeadScript
captureEnd() End capture action and store HeadScript
captureStart() Start capture action HeadScript
count() Countable AbstractStandalone
createData() Create data item containing all necessary components of script HeadScript
deleteContainer() Delete a container AbstractStandalone
getAutoEscape() Return whether autoEscaping is enabled or disabled AbstractStandalone
getContainer() Retrieve placeholder container AbstractStandalone
getContainerClass() Retrieve the container class AbstractStandalone
getEscaper() Get Escaper instance AbstractStandalone
getIterator() IteratorAggregate: get Iterator AbstractStandalone
getView() Get the view object AbstractHelper
itemToString() Create script HTML HeadScript
offsetExists() ArrayAccess: offsetExists AbstractStandalone
offsetGet() ArrayAccess: offsetGet AbstractStandalone
offsetSet() Override offsetSet HeadScript
offsetUnset() ArrayAccess: offsetUnset AbstractStandalone
prepend() Override prepend HeadScript
set() Override set HeadScript
setAllowArbitraryAttributes() Set flag indicating if arbitrary attributes are allowed HeadScript
setAutoEscape() Set whether or not auto escaping should be used AbstractStandalone
setContainer() Set container on which to operate AbstractStandalone
setContainerClass() Set the container class to use AbstractStandalone
setEscaper() Set Escaper instance AbstractStandalone
setView() Set the View object AbstractHelper
toString() Retrieve string representation HeadScript

Method Details

__call()

Overload method access

Parameter Name Type Description
$method string Method
$args array Arguments

Returns: \HeadScript

__construct()

Constructor

Set separator to PHP_EOL.

Returns:

__get()

Overloading: retrieve property

Parameter Name Type Description
$key string

Returns: mixed

__invoke()

Return InlineScript object

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

Parameter Name Type Description
$mode string Script
$spec string Script/url
$placement string Append,
$attrs array Array
$type string Script

Returns: \InlineScript

__isset()

Overloading: check if property is set

Parameter Name Type Description
$key string

Returns: bool

__set()

Overloading: set property value

Parameter Name Type Description
$key string
$value mixed

Returns: void

__toString()

Cast to string representation

Returns: string

__unset()

Overloading: unset property

Parameter Name Type Description
$key string

Returns: void

append()

Override append

Parameter Name Type Description
$value string Append

Returns: void

arbitraryAttributesAllowed()

Are arbitrary attributes allowed?

Returns: bool

captureEnd()

End capture action and store

Returns: void

captureStart()

Start capture action

Parameter Name Type Description
$captureType mixed Type
$type string Type
$attrs array Attributes

Returns: void

count()

Countable

Returns: int

createData()

Create data item containing all necessary components of script

Parameter Name Type Description
$type string Type
$attributes array Attributes
$content string Content

Returns: \stdClass

deleteContainer()

Delete a container

Returns: bool

getAutoEscape()

Return whether autoEscaping is enabled or disabled

return bool

Returns:

getContainer()

Retrieve placeholder container

Returns: \AbstractContainer

getContainerClass()

Retrieve the container class

Returns: string

getEscaper()

Get Escaper instance

Lazy-loads one if none available

Parameter Name Type Description
$enc string|null Encoding

Returns: mixed

getIterator()

IteratorAggregate: get Iterator

Returns: \Iterator

getView()

Get the view object

Returns: null|\Renderer

itemToString()

Create script HTML

Parameter Name Type Description
$item mixed Item
$indent string String
$escapeStart string Starting
$escapeEnd string Ending

Returns: string

offsetExists()

ArrayAccess: offsetExists

Parameter Name Type Description
$offset string|int

Returns: bool

offsetGet()

ArrayAccess: offsetGet

Parameter Name Type Description
$offset string|int

Returns: mixed

offsetSet()

Override offsetSet

Parameter Name Type Description
$index string|int Set
$value mixed

Returns: void

offsetUnset()

ArrayAccess: offsetUnset

Parameter Name Type Description
$offset string|int

Returns: void

prepend()

Override prepend

Parameter Name Type Description
$value string Prepend

Returns: void

set()

Override set

Parameter Name Type Description
$value string Set

Returns: void

setAllowArbitraryAttributes()

Set flag indicating if arbitrary attributes are allowed

Parameter Name Type Description
$flag bool Set

Returns: \HeadScript

setAutoEscape()

Set whether or not auto escaping should be used

Parameter Name Type Description
$autoEscape bool whether

Returns: \AbstractStandalone

setContainer()

Set container on which to operate

Parameter Name Type Description
$container \AbstractContainer

Returns: \AbstractStandalone

setContainerClass()

Set the container class to use

Parameter Name Type Description
$name string

Returns: \Zend\View\Helper\Placeholder\Container\AbstractStandalone

setEscaper()

Set Escaper instance

Parameter Name Type Description
$escaper \Escaper

Returns: \AbstractStandalone

setView()

Set the View object

Parameter Name Type Description
$view \Renderer

Returns: \AbstractHelper

toString()

Retrieve string representation

Parameter Name Type Description
$indent string|int Amount

Returns: string

Top