Horde_Text_Filter_Base
in package
Horde_Text_Filter_Base:: is the parent class for defining a text filter.
Copyright 1999-2017 Horde LLC (http://www.horde.org/)
See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Tags
Table of Contents
- $_params : array<string|int, mixed>
- Filter parameters.
- __construct() : mixed
- Constructor.
- getPatterns() : array<string|int, mixed>
- Returns a hash with replace patterns.
- postProcess() : string
- Executes any code necessaray after applying the filter patterns.
- preProcess() : string
- Executes any code necessaray before applying the filter patterns.
Properties
$_params
Filter parameters.
protected
array<string|int, mixed>
$_params
= array()
Methods
__construct()
Constructor.
public
__construct([array<string|int, mixed> $params = array() ]) : mixed
Parameters
- $params : array<string|int, mixed> = array()
-
Any parameters that the filter instance needs.
Return values
mixed —getPatterns()
Returns a hash with replace patterns.
public
getPatterns() : array<string|int, mixed>
Return values
array<string|int, mixed> —Patterns hash.
postProcess()
Executes any code necessaray after applying the filter patterns.
public
postProcess(string $text) : string
Parameters
- $text : string
-
The text after the filtering.
Return values
string —The modified text.
preProcess()
Executes any code necessaray before applying the filter patterns.
public
preProcess(string $text) : string
Parameters
- $text : string
-
The text before the filtering.
Return values
string —The modified text.