interface FilterInterface (View source)

A FilterInterface is given an input string and returns a filtered string. Replacements will be provided and performed (typically in regex format), and transliteration may be used as a separate service to replace characters rather than remove them.

For example implementations, see URLSegmentFilter.

Methods

public
string
filter(string $input)

Performs a set of replacement rules against the input string, applying transliteration if a service is provided, and returns the filtered result.

Details

string filter(string $input)

Performs a set of replacement rules against the input string, applying transliteration if a service is provided, and returns the filtered result.

Parameters

string $input

Return Value

string