Overview

Packages

  • Text
    • Filter

Classes

  • Horde_Text_Filter
  • Horde_Text_Filter_Base
  • Horde_Text_Filter_Bbcode
  • Horde_Text_Filter_Cleanascii
  • Horde_Text_Filter_Cleanhtml
  • Horde_Text_Filter_Dimsignature
  • Horde_Text_Filter_Emails
  • Horde_Text_Filter_Emoticons
  • Horde_Text_Filter_Environment
  • Horde_Text_Filter_Exception
  • Horde_Text_Filter_Highlightquotes
  • Horde_Text_Filter_Html2text
  • Horde_Text_Filter_JavascriptMinify
  • Horde_Text_Filter_JavascriptMinify_JsMin
  • Horde_Text_Filter_Linkurls
  • Horde_Text_Filter_Simplemarkup
  • Horde_Text_Filter_Space2html
  • Horde_Text_Filter_Tabs2spaces
  • Horde_Text_Filter_Text2html
  • Horde_Text_Filter_Translation
  • Horde_Text_Filter_Words
  • Horde_Text_Filter_Xss
  • Overview
  • Package
  • Class
  • Tree

Class Horde_Text_Filter

Horde_Text_Filter:: is a parent class for defining stackable text filters.

Copyright 1999-2012 Horde LLC (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Package: Text\Filter
Category: Horde
License: LGPL 2.1
Author: Chuck Hagenbuch chuck@horde.org
Author: Jan Schneider jan@horde.org
Located at Horde/Text/Filter.php
Methods summary
public static Horde_Text_Filter_Base
# factory( string $driver, array $params = array() )

Attempts to return a concrete instance based on $driver.

Attempts to return a concrete instance based on $driver.

Parameters

$driver
<p>Either a driver name, or the full class name to use (class must extend Horde_Text_Filter_Base).</p>
$params
<p>A hash containing any additional configuration parameters a subclass might need.</p>

Returns

Horde_Text_Filter_Base
The newly created concrete instance.

Throws

Horde_Text_Filter_Exception
public static string
# filter( string $text, mixed $filters = array(), mixed $params = array() )

Applies a set of patterns to a block of text.

Applies a set of patterns to a block of text.

Parameters

$text
The text to filter.
$filters
The list of filters (or a single filter).
$params
The list of params to use with each filter.

Returns

string
The transformed text.

Throws

Horde_Text_Filter_Exception
API documentation generated by ApiGen