Class MIME_Viewer_richtext

Description

The MIME_Viewer_richtext class renders out HTML text from text/richtext content tags, (RFC 1896 [7.1.3]).

A minimal richtext implementation is one that simply converts "<lt>" to "<", converts CRLFs to SPACE, converts <nl> to a newline according to local newline convention, removes everything between a <comment> command and the next balancing </comment> command, and removes all other formatting commands (all text enclosed in angle brackets).

We implement the following tags: <bold>, <italic>, <fixed>, <smaller>, <bigger>, <underline>, <center>, <flushleft>, <flushright>, <indent>, <subscript>, <excerpt>, <paragraph>, <signature>, <comment>, <no-op>, <lt>, <nl>

The following tags are implemented differently than described in the RFC (due to limitations in HTML output): <heading> - Output as centered, bold text. <footing> - Output as centered, bold text. <np> - Output as paragraph break.

The following tags are NOT implemented: <indentright>, <outdent>, <outdentright>, <samepage>, <iso-8859-X>, <us-ascii>,

$Horde: framework/MIME/MIME/Viewer/richtext.php,v 1.4.10.14 2009/01/06 15:23:21 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 /MIME/MIME/Viewer/richtext.php (line 37)

MIME_Viewer
   |
   --MIME_Viewer_richtext
Method Summary
 string getType ()
 string render ([array $params = array()])
Variables
Methods
getType (line 150)

Return the MIME content type of the rendered content.

  • return: The content type of the output.
string getType ()

Redefinition of:
MIME_Viewer::getType()
Return the MIME type of the rendered content. This can be
render (line 46)

Render out the currently set contents in HTML format.

  • return: The rendered contents.
string render ([array $params = array()])
  • array $params: Any parameters the Viewer may need.

Redefinition of:
MIME_Viewer::render()
Return the rendered version of the object.

Inherited Methods

Inherited From MIME_Viewer

 MIME_Viewer::MIME_Viewer()
 MIME_Viewer::canDisplayInline()
 MIME_Viewer::factory()
 MIME_Viewer::forceInlineView()
 MIME_Viewer::getCharset()
 MIME_Viewer::getConfigParam()
 MIME_Viewer::getDriver()
 MIME_Viewer::getIcon()
 MIME_Viewer::getType()
 MIME_Viewer::includeDriver()
 MIME_Viewer::render()
 MIME_Viewer::renderAttachmentInfo()
 MIME_Viewer::resolveDriver()
 MIME_Viewer::setMIMEPart()

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