Helper for escaping values

 Methods

Invoke this helper: escape a value

__invoke(mixed $value, int $recurse) : mixed
Inherited

inherited_from \Zend\View\Helper\Escaper\AbstractHelper::__invoke()

Parameters

$value

mixed

$recurse

int

Expects one of the recursion constants; used to decide whether or not to recurse the given value when escaping

Exceptions

\Zend\View\Exception\InvalidArgumentException

Returns

mixedGiven a scalar, a scalar value is returned. Given an object, with the $recurse flag not allowing object recursion, returns a string. Otherwise, returns an array.

Get the encoding to use for escape operations

getEncoding() : string
Inherited

inherited_from \Zend\View\Helper\Escaper\AbstractHelper::getEncoding()

Returns

string

getEscaper()

getEscaper() 
Inherited

inherited_from \Zend\View\Helper\Escaper\AbstractHelper::getEscaper()

Get the view object

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

inherited_from \Zend\View\Helper\AbstractHelper::getView()
inherited_from \Zend\View\Helper\Escaper\AbstractHelper::getView()

Returns

Set the encoding to use for escape operations

setEncoding(string $encoding) : \Zend\View\Helper\Escaper\AbstractHelper
Inherited

inherited_from \Zend\View\Helper\Escaper\AbstractHelper::setEncoding()

Parameters

$encoding

string

Exceptions

\Zend\View\Exception\InvalidArgumentException

Returns

setEscaper()

setEscaper(\Zend\Escaper\Escaper $escaper) 
Inherited

inherited_from \Zend\View\Helper\Escaper\AbstractHelper::setEscaper()

Parameters

$escaper

Set the View object

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

inherited_from \Zend\View\Helper\AbstractHelper::setView()
inherited_from \Zend\View\Helper\Escaper\AbstractHelper::setView()

Parameters

Returns

Escape a value for current escaping strategy

escape(string $value) : string

Parameters

$value

string

Returns

string

 Properties

 

<p>Encoding</p>

$encoding : string
Inherited

inherited_from \Zend\View\Helper\Escaper\AbstractHelper::$$encoding
 

$escaper

$escaper : \Zend\Escaper\Escaper
Inherited

inherited_from \Zend\View\Helper\Escaper\AbstractHelper::$$escaper
 

View object

$view : \Zend\View\Renderer\RendererInterface
Inherited

inherited_from \Zend\View\Helper\AbstractHelper::$$view
inherited_from \Zend\View\Helper\Escaper\AbstractHelper::$$view

 Constants

 

RECURSE_ARRAY

RECURSE_ARRAY 
Inherited

inherited_from \Zend\View\Helper\Escaper\AbstractHelper::RECURSE_ARRAY
 

RECURSE_NONE

RECURSE_NONE 
Inherited

inherited_from \Zend\View\Helper\Escaper\AbstractHelper::RECURSE_NONE
 

RECURSE_OBJECT

RECURSE_OBJECT 
Inherited

inherited_from \Zend\View\Helper\Escaper\AbstractHelper::RECURSE_OBJECT