Base class for targeted placeholder helpers

package Default
inherited_from \Zend\View\Helper\AbstractHelper

 Methods

Overload

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

Proxy to container methods

Parameters

$method

string

$args

array

Exceptions

\Zend\View\Exception\BadMethodCallException

Returns

mixed

Constructor

__construct() 

Overloading: retrieve property

__get(string $key) : mixed

Parameters

$key

string

Returns

mixed

Overloading: check if property is set

__isset(string $key) : boolean

Parameters

$key

string

Returns

boolean

Overloading: set property value

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

Parameters

$key

string

$value

mixed

Cast to string representation

__toString() : string

Returns

string

Overloading: unset property

__unset(string $key) : void

Parameters

$key

string

Countable

count() : integer

Returns

integer

Delete a container

deleteContainer() : boolean

Returns

boolean

Return whether autoEscaping is enabled or disabled

getAutoEscape() 

return bool

Retrieve placeholder container

getContainer() : \Zend\View\Helper\Placeholder\Container\AbstractContainer

Returns

\Zend\View\Helper\Placeholder\Container\AbstractContainer

Retrieve the container class

getContainerClass() : string

Returns

string

Get Escaper instance

getEscaper(string|null $enc = 'UTF-8') : mixed

Lazy-loads one if none available

Parameters

$enc

stringnull

Encoding to use

Returns

mixed

IteratorAggregate: get Iterator

getIterator() : \Iterator

Returns

\Iterator

Get the view object

getView() : null | \Zend\View\Renderer\RendererInterface
Inherited
inherited_from \Zend\View\Helper\HelperInterface::getView()

Returns

null\Zend\View\Renderer\RendererInterface

ArrayAccess: offsetExists

offsetExists(string|integer $offset) : boolean

Parameters

$offset

stringinteger

Returns

boolean

ArrayAccess: offsetGet

offsetGet(string|integer $offset) : mixed

Parameters

$offset

stringinteger

Returns

mixed

ArrayAccess: offsetSet

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

Parameters

$offset

stringinteger

$value

mixed

ArrayAccess: offsetUnset

offsetUnset(string|integer $offset) : void

Parameters

$offset

stringinteger

Set whether or not auto escaping should be used

setAutoEscape(boolean $autoEscape = true) : \Zend\View\Helper\Placeholder\Container\AbstractStandalone

Parameters

$autoEscape

boolean

whether or not to auto escape output

Returns

\Zend\View\Helper\Placeholder\Container\AbstractStandalone

Set container on which to operate

setContainer(\Zend\View\Helper\Placeholder\Container\AbstractContainer $container) : \Zend\View\Helper\Placeholder\Container\AbstractStandalone

Parameters

$container

\Zend\View\Helper\Placeholder\Container\AbstractContainer

Returns

\Zend\View\Helper\Placeholder\Container\AbstractStandalone

Set the container class to use

setContainerClass(string $name) : \Zend\View\Helper\Placeholder\Container\AbstractStandalone

Parameters

$name

string

Exceptions

\Zend\View\Exception\InvalidArgumentException
\Zend\View\Exception\DomainException

Returns

\Zend\View\Helper\Placeholder\Container\AbstractStandalone

Set Escaper instance

setEscaper(\Zend\Escaper\Escaper $escaper) : \Zend\View\Helper\Placeholder\Container\AbstractStandalone

Parameters

$escaper

\Zend\Escaper\Escaper

Returns

\Zend\View\Helper\Placeholder\Container\AbstractStandalone

Set the View object

setView(\Zend\View\Renderer\RendererInterface $view) : \Zend\View\Helper\AbstractHelper
Inherited
inherited_from \Zend\View\Helper\HelperInterface::setView()

Parameters

$view

\Zend\View\Renderer\RendererInterface

Returns

\Zend\View\Helper\AbstractHelper

String representation

toString() : string

Returns

string

Escape a string

escape(string $string) : string

Parameters

$string

string

Returns

string

 Properties

 

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

$autoEscape : boolean

Default

true
 

$container

$container : \Zend\View\Helper\Placeholder\Container\AbstractContainer

Default

 

Default container class

$containerClass : string

Default

'Zend\View\Helper\Placeholder\Container'
 

$escapers

$escapers : array<mixed,\Zend\Escaper\Escaper>

Default

array()
 

View object instance

$view : \Zend\View\Renderer\RendererInterface

Default

null