package Default
inherited_from \Zend\Filter\AbstractFilter

 Methods

Sets filter options

__construct(array|\Traversable $options = array()

Parameters

$options

array\Traversable

Invoke filter as a command

__invoke(mixed $value) : mixed
Inherited

Proxies to \filter()

Parameters

$value

mixed

Exceptions

\Zend\Filter\Exception\ExceptionInterface If filtering $value is impossible

Returns

mixed

Defined by Zend\Filter\FilterInterface

filter(string $value) : string | mixed

Returns the string $value, converting characters to their corresponding HTML entity equivalents where they exist

If the value provided is non-scalar, the value will remain unfiltered

Parameters

$value

string

Exceptions

\Zend\Filter\Exception\DomainException on encoding mismatches

Returns

stringmixed

Returns the charSet option

getCharSet() : string

Proxies to \getEncoding()

Returns

string

Returns the doubleQuote option

getDoubleQuote() : boolean

Returns

boolean

Get encoding

getEncoding() : string

Returns

string

Retrieve options representing object state

getOptions() : array
Inherited

Returns

array

Returns the quoteStyle option

getQuoteStyle() : integer

Returns

integer

hasPcreUnicodeSupport()

hasPcreUnicodeSupport() : boolean
InheritedStatic
deprecated Since 2.1.0

Returns

boolean

Sets the charSet option

setCharSet(string $charSet) : \Zend\Filter\HtmlEntities

Proxies to \setEncoding()

fluent This method is part of a fluent interface and will return the same instance

Parameters

$charSet

string

Returns

\Zend\Filter\HtmlEntitiesProvides a fluent interface

Sets the doubleQuote option

setDoubleQuote(boolean $doubleQuote) : \Zend\Filter\HtmlEntities
fluent This method is part of a fluent interface and will return the same instance

Parameters

$doubleQuote

boolean

Returns

\Zend\Filter\HtmlEntitiesProvides a fluent interface

Set encoding

setEncoding(string $value) : \Zend\Filter\HtmlEntities
fluent This method is part of a fluent interface and will return the same instance

Parameters

$value

string

Returns

\Zend\Filter\HtmlEntities

setOptions()

setOptions(array|\Traversable $options) : \Zend\Filter\HtmlEntities
Inherited
fluent This method is part of a fluent interface and will return the same instance

Parameters

$options

array\Traversable

Exceptions

\Zend\Filter\Exception\InvalidArgumentException

Returns

\Zend\Filter\HtmlEntities

Sets the quoteStyle option

setQuoteStyle(integer $quoteStyle) : \Zend\Filter\HtmlEntities
fluent This method is part of a fluent interface and will return the same instance

Parameters

$quoteStyle

integer

Returns

\Zend\Filter\HtmlEntitiesProvides a fluent interface

isOptions()

isOptions(mixed $options) : boolean
InheritedStatic

Parameters

$options

mixed

Returns

boolean

 Properties

 

Corresponds to the forth htmlentities() argument

$doubleQuote : boolean

Default

 

Corresponds to the third htmlentities() argument

$encoding : string

Default

 

Filter options

$options : array

Default

array()
 

Corresponds to the second htmlentities() argument

$quoteStyle : integer

Default