Class Text_Filter_highlightquotes

Description

Highlights quoted messages with different colors for the different quoting levels.

CSS class names called "quoted1" ... "quoted{$cssLevels}" must be present. CSS class name "togglequote" is used to style toggle text. The text to be passed in must have already been passed through htmlspecialchars().

Parameters:

 'citeblock'  -- Display cite blocks? (DEFAULT: true)
 'cssLevels'  -- Number of defined CSS class names. (DEFAULT: 5)
 'hideBlocks' -- Hide quoted text blocks by default? (DEFAULT: false)
 'outputJS'   -- Add necessary JS files? (DEFAULT: true)

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

Copyright 2004-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/highlightquotes.php (line 35)

Text_Filter
   |
   --Text_Filter_highlightquotes
Variable Summary
 array $_params
Method Summary
 array getPatterns ()
 string postProcess (string $text)
 string preProcess (string $text)
Variables
array $_params = array(
'citeblock' => true,
'cssLevels' => 5,
'hideBlocks' => false,
'outputJS' => true
)
(line 42)

Filter parameters.


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

Returns a hash with replace patterns.

  • return: Patterns hash.
array getPatterns ()

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

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 56)

Executes any code necessaray 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:17:59 +0000 by phpDocumentor 1.4.3