category Zend
package Zend_Filter

 Methods

Sets filter options

__construct(array | \Traversable $options) 

Parameters

$options

array\Traversable

Invoke filter as a command

__invoke(mixed $value) : mixed
Inherited

Proxies to filter()

inherited_from \Zend\Filter\AbstractFilter::__invoke()

Parameters

$value

mixed

Exceptions

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

Returns

mixed

Defined by Zend\Filter\FilterInterface

filter(string $value) : string

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

Parameters

$value

string

Exceptions

\Zend\Filter\Exception\DomainException

Returns

string

Returns the charSet option

getCharSet() : string

Proxies to getEncoding()

Returns

string

Returns the doubleQuote option

getDoubleQuote() : bool

Returns

bool

Get encoding

getEncoding() : string

Returns

string

Retrieve options representing object state

getOptions() : array
Inherited

inherited_from \Zend\Filter\AbstractFilter::getOptions()

Returns

array

Returns the quoteStyle option

getQuoteStyle() : integer

Returns

integer

hasPcreUnicodeSupport()

hasPcreUnicodeSupport() : bool
Inherited

inherited_from \Zend\Filter\AbstractFilter::hasPcreUnicodeSupport()

Returns

bool

Sets the charSet option

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

Proxies to setEncoding()

Parameters

$charSet

string

Returns

\Zend\Filter\HtmlEntitiesProvides a fluent interface

Sets the doubleQuote option

setDoubleQuote(bool $doubleQuote) : \Zend\Filter\HtmlEntities

Parameters

$doubleQuote

bool

Returns

\Zend\Filter\HtmlEntitiesProvides a fluent interface

Set encoding

setEncoding(string $value) : \Zend\Filter\HtmlEntities

Parameters

$value

string

Returns

setOptions()

setOptions(array | \Traversable $options) : \Zend\Filter\AbstractFilter
Inherited

inherited_from \Zend\Filter\AbstractFilter::setOptions()

Parameters

$options

array\Traversable

Exceptions

\Zend\Filter\Exception\InvalidArgumentException

Returns

Sets the quoteStyle option

setQuoteStyle(integer $quoteStyle) : \Zend\Filter\HtmlEntities

Parameters

$quoteStyle

integer

Returns

\Zend\Filter\HtmlEntitiesProvides a fluent interface

isOptions()

isOptions(mixed $options) : bool
Inherited

inherited_from \Zend\Filter\AbstractFilter::isOptions()

Parameters

$options

mixed

Returns

bool

 Properties

 

Corresponds to the forth htmlentities() argument

$doubleQuote : bool

 

Corresponds to the third htmlentities() argument

$encoding : string

 

Is PCRE is compiled with UTF-8 and Unicode support

$hasPcreUnicodeSupport : bool
Inherited

inherited_from \Zend\Filter\AbstractFilter::$$hasPcreUnicodeSupport
 

Filter options

$options : array
Inherited

inherited_from \Zend\Filter\AbstractFilter::$$options
 

Corresponds to the second htmlentities() argument

$quoteStyle : integer