Class Text_Filter_text2html

Description

Turn text into HTML with varying levels of parsing. For no html whatsoever, use htmlspecialchars() instead.

Parameters:

 parselevel -- The parselevel of the output. See the list of constants below.
 charset    -- The charset to use for htmlspecialchars() calls.
 class      -- The CSS class name for the links.
 nofollow   -- Whether to set the 'rel="nofollow"' attribute on links.
 callback   -- An optional callback function that the URL is passed through
               before being set as the href attribute.  Must be a string with
               the function name, the function must take the original as the
               first and only parameter.

 List of valid constants for the parse level:
 --------------------------------------------
 TEXT_HTML_PASSTHRU        =  No action. Pass-through. Included for
                              completeness.
 TEXT_HTML_SYNTAX          =  Allow full html, also do line-breaks,
                              in-lining, syntax-parsing.
 TEXT_HTML_MICRO           =  Micro html (only line-breaks, in-line linking).
 TEXT_HTML_MICRO_LINKURL   =  Micro html (only line-breaks, in-line linking
                              of URLSs; no email addresses are linked).
 TEXT_HTML_NOHTML          =  No html (all stripped, only line-breaks)
 TEXT_HTML_NOHTML_NOBREAK  =  No html whatsoever, no line breaks added.
                              Included for completeness.

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

Copyright 2002-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/text2html.php (line 48)

Text_Filter
   |
   --Text_Filter_text2html
Variable Summary
 array $_params
Method Summary
 Text_Filter_text2html Text_Filter_text2html ([array $params = array()])
 string preProcess (string $text)
Variables
array $_params = array('charset' => null,
'class' => 'fixed',
'nofollow' => false,
'callback' => 'Horde::externalUrl')
(line 55)

Filter parameters.


Redefinition of:
Text_Filter::$_params
Filter parameters.
Methods
Constructor Text_Filter_text2html (line 65)

Constructor.

Text_Filter_text2html Text_Filter_text2html ([array $params = array()])
  • array $params: Any parameters that the filter instance needs.
preProcess (line 82)

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:22:52 +0000 by phpDocumentor 1.4.3