API Documentation
\

\Horde_Text_Filter_Emails

The Horde_Text_Filter_Emails:: class finds email addresses in a block of text and turns them into links.

Parameters:

class - (string) CSS class of the generated  tag.
        DEFAULT: ''
encode - (boolean) Whether to escape special HTML characters in the URLs
         and finally "encode" the complete tag so that it can be decoded
         later with the decode() method. This is useful if you want to run
         htmlspecialchars() or similar *after* using this filter.
         DEFAULT: false

Copyright 2003-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.

Summary

Methods
Properties
Constants
__construct()
preProcess()
getPatterns()
postProcess()
regexCallback()
decode()
No public properties found
No constants found
_regexCallback()
$_params
N/A
No private methods found
No private properties found
N/A

Properties

$_params

$_params : array

Filter parameters.

Type

array

Methods

__construct()

__construct(array  $params = array())

Constructor.

Parameters

array $params

Any parameters that the filter instance needs.

preProcess()

preProcess(string  $text) : string

Executes any code necessaray before applying the filter patterns.

Parameters

string $text

The text before the filtering.

Returns

string —

The modified text.

getPatterns()

getPatterns() : array

Returns a hash with replace patterns.

Returns

array —

Patterns hash.

postProcess()

postProcess(string  $text) : string

Executes any code necessaray after applying the filter patterns.

Parameters

string $text

The text after the filtering.

Returns

string —

The modified text.

regexCallback()

regexCallback(array  $matches) : string

Regular expression callback.

Parameters

array $matches

preg_replace_callback() matches. See regex above for description of matching data.

Returns

string —

Replacement string.

decode()

decode(string  $text) : string

"Decodes" the text formerly encoded by using the "encode" parameter.

Parameters

string $text

An encoded text.

Returns

string —

The decoded text.

_regexCallback()

_regexCallback(array  $matches) : string

Regular expression callback.

Parameters

array $matches

preg_replace_callback() matches. See regex above for description of matching data.

Returns

string —

Replacement string.