class InputFilter implements Serializable (View source)

Class Filter

Constants

INTEGER

UINT

FLOAT

BOOLEAN

WORD

ALNUM

CMD

BASE64

STRING

HTML

ARRAY_TYPE

PATH

USERNAME

EMAIL

URL

RAW

Methods

__construct(HtmlCleaner $htmlCleaner = null)

Class init.

mixed
clean(string $source, string|callable|object $filter = 'string')

clean

callable
getHandler(string $name)

getHandlers

setHandler(string $name, CleanerInterface[]|callable[] $handler)

setHandlers

getHtmlCleaner()

gethtmlCleaner

setHtmlCleaner(HtmlCleaner $htmlCleaner)

sethtmlCleaner

callable
getDefaultHandler()

getDefaultHandler

setDefaultHandler(callable $defaultHandler)

setDefaultHandler

string
serialize()

Method to serialize the Filter.

unserialize(string $input)

Method to unserialize the Filter.

Details

at line line 63
__construct(HtmlCleaner $htmlCleaner = null)

Class init.

Parameters

HtmlCleaner $htmlCleaner

at line line 78
mixed clean(string $source, string|callable|object $filter = 'string')

clean

Parameters

string $source
string|callable|object $filter

Return Value

mixed

at line line 116
callable getHandler(string $name)

getHandlers

Parameters

string $name

Return Value

callable

at line line 130
InputFilter setHandler(string $name, CleanerInterface[]|callable[] $handler)

setHandlers

Parameters

string $name
CleanerInterface[]|callable[] $handler

Return Value

InputFilter Return self to support chaining.

Exceptions

InvalidArgumentException

at line line 147
HtmlCleaner getHtmlCleaner()

gethtmlCleaner

Return Value

HtmlCleaner

at line line 159
InputFilter setHtmlCleaner(HtmlCleaner $htmlCleaner)

sethtmlCleaner

Parameters

HtmlCleaner $htmlCleaner

Return Value

InputFilter Return self to support chaining.

at line line 171
callable getDefaultHandler()

getDefaultHandler

Return Value

callable

at line line 183
InputFilter setDefaultHandler(callable $defaultHandler)

setDefaultHandler

Parameters

callable $defaultHandler

Return Value

InputFilter Return self to support chaining.

at line line 350
string serialize()

Method to serialize the Filter.

Return Value

string The serialized Filter.

at line line 368
InputFilter unserialize(string $input)

Method to unserialize the Filter.

Parameters

string $input The serialized Filter.

Return Value

InputFilter The Filter object.