Class Text_Filter_space2html

Description

The space2html filter converts horizontal whitespace to HTML code.

Parameters:

 encode     -- HTML encode the text?  Defaults to false.
 charset    -- Charset of the text.  Defaults to ISO-8859-1.
 encode_all -- Replace all spaces with  ?  Defaults to false.

$Horde: framework/Text_Filter/Filter/space2html.php,v 1.1.10.9 2009/01/06 15:23:42 jan Exp $

Copyright 2001-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

Located in /Text_Filter/Filter/space2html.php (line 23)

Text_Filter
   |
   --Text_Filter_space2html
Variable Summary
 array $_params
Method Summary
 array getPatterns ()
 string postProcess (string $text)
 string preProcess (string $text)
Variables
array $_params = array('encode' => false,
'charset' => 'ISO-8859-1',
'encode_all' => false)
(line 30)

Filter parameters.


Redefinition of:
Text_Filter::$_params
Filter parameters.
Methods
getPatterns (line 54)

Returns a hash with replace patterns.

  • return: Patterns hash.
array getPatterns ()

Redefinition of:
Text_Filter::getPatterns()
Returns a hash with replace patterns.
postProcess (line 68)

Executes any code necessaray after applying the filter patterns.

  • return: The modified text.
string postProcess (string $text)
  • string $text: The text after the filtering.

Redefinition of:
Text_Filter::postProcess()
Executes any code necessaray after applying the filter patterns.
preProcess (line 41)

Executes any code necessary before applying the filter patterns.

  • return: The modified text.
string preProcess (string $text)
  • string $text: The text before the filtering.

Redefinition of:
Text_Filter::preProcess()
Executes any code necessaray before applying the filter patterns.

Inherited Methods

Inherited From Text_Filter

 Text_Filter::Text_Filter()
 Text_Filter::factory()
 Text_Filter::filter()
 Text_Filter::getPatterns()
 Text_Filter::postProcess()
 Text_Filter::preProcess()

Documentation generated on Sun, 30 Jan 2011 05:21:40 +0000 by phpDocumentor 1.4.3