Summary

Fully Qualified Name:	Laminas\Filter\HtmlEntities
Extends:	AbstractFilter

Description

Methods

Name	Description	Defined By
__construct()	Sets filter options	HtmlEntities
__invoke()	Invoke filter as a command	AbstractFilter
filter()	Defined by Laminas\Filter\FilterInterface	HtmlEntities
getCharSet()	Returns the charSet option	HtmlEntities
getDoubleQuote()	Returns the doubleQuote option	HtmlEntities
getEncoding()	Get encoding	HtmlEntities
getOptions()	Retrieve options representing object state	AbstractFilter
getQuoteStyle()	Returns the quoteStyle option	HtmlEntities
hasPcreUnicodeSupport()		AbstractFilter
setCharSet()	Sets the charSet option	HtmlEntities
setDoubleQuote()	Sets the doubleQuote option	HtmlEntities
setEncoding()	Set encoding	HtmlEntities
setOptions()		AbstractFilter
setQuoteStyle()	Sets the quoteStyle option	HtmlEntities

Method Details

__construct()

Sets filter options

Parameter Name	Type	Description
$options	array|\Traversable

Returns:

__invoke()

Invoke filter as a command

Proxies to {@link filter()}

Parameter Name	Type	Description
$value	mixed

Returns: mixed

filter()

Defined by Laminas\Filter\FilterInterface

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

Parameter Name	Type	Description
$value	string

Returns: string|mixed

getCharSet()

Returns the charSet option

Proxies to {@link getEncoding()}

Returns: string

getDoubleQuote()

Returns the doubleQuote option

Returns: bool

getEncoding()

Get encoding

Returns: string

getOptions()

Retrieve options representing object state

Returns: array

getQuoteStyle()

Returns the quoteStyle option

Returns: int

hasPcreUnicodeSupport()

Returns: bool

setCharSet()

Sets the charSet option

Proxies to {@link setEncoding()}

Parameter Name	Type	Description
$charSet	string

Returns: self Provides a fluent interface

setDoubleQuote()

Sets the doubleQuote option

Parameter Name	Type	Description
$doubleQuote	bool

Returns: self Provides a fluent interface

setEncoding()

Set encoding

Parameter Name	Type	Description
$value	string

Returns: self

setOptions()

Parameter Name	Type	Description
$options	array|\Traversable

Returns: self

setQuoteStyle()

Sets the quoteStyle option

Parameter Name	Type	Description
$quoteStyle	int

Returns: self Provides a fluent interface