\Horde_Mime_Viewer_Richtext

__construct()

__construct(\Horde_Mime_Part  $part, array  $conf = array()) 

Constructor.

Parameters

temp_file - (callback) A callback function that returns a temporary
            filename.  Is passed one parameter: a prefix string.
            DEFAULT: Uses Horde_Util::getTempFile().
text_filter - (callback) A callback function used to filter text. Is
              called the same as Horde_Text_Filter::filter().
              DEFAULT: Uses Horde_Text_Filter::filter().

Throws

\InvalidArgumentException

setMimePart()

setMimePart(\Horde_Mime_Part  $mime_part) 

Sets the Horde_Mime_Part object for the class.

Parameters

render()

render(string  $mode) : array

Return the rendered version of the Horde_Mime_Part object.

Parameters

'full' - A full representation of the MIME part, for use in a view
         where the output to the browser can be set to the value
         returned in 'type'. This mode should only return a single
         MIME ID entry for viewing and should not return any status
         information.
'inline' - A representation of the MIME part that can be viewed inline
           on a text/html page that may contain other HTML elements.
'info' - A representation of the MIME part that can be viewed inline
         on an text/html page that may contain other HTML elements.
         This view is not a full view, but rather a condensed view of
         the contents of the MIME part. This view is intended to be
         displayed to the user with the intention that this MIME part's
         subparts may also independently be viewed inline.
'raw' - The raw data of the MIME part, generally useful for downloading
        a part. This view exists in case this raw data needs to be
        altered in any way.

Returns

An array. The keys are the MIME parts that were handled by the driver. The values are either null (which indicates the driver is recommending that this particular MIME ID should not be displayed) or an array with the following keys:

'data' - (string) The rendered data.
'status' - (array) An array of status information to be displayed to
           the user.  Consists of arrays with the following keys:
           'class' - (string) The class to use for display.
           'img' - (string) An image to display.
           'text' - (array) The text to display.
'type' - (string) The MIME type of the rendered data.

canRender()

canRender(string  $mode) : boolean

Can this driver render the the data?

Parameters

Returns

True if the driver can render the data for the given view.

embeddedMimeParts()

embeddedMimeParts() : boolean

Does this MIME part possibly contain embedded MIME parts?

Returns

True if this driver supports parsing embedded MIME parts.

getEmbeddedMimeParts()

getEmbeddedMimeParts() : mixed

If this MIME part can contain embedded MIME part(s), and those part(s) exist, return a representation of that data.

Returns

A Horde_Mime_Part object representing the embedded data. Returns null if no embedded MIME part(s) exist.

getConfigParam()

getConfigParam(string  $param) : mixed

Return a configuration parameter for the current viewer.

Parameters

Returns

The value of the parameter; returns null if the parameter doesn't exist.

setConfigParam()

setConfigParam(string  $param, mixed  $value) 

Sets a configuration parameter for the current viewer.

Parameters

getDriver()

getDriver() : string

Returns the driver name for the current object.

Returns

The driver name.

getMetadata()

getMetadata(string  $data) : mixed

Returns metadata information on the viewer/data.

Parameters

Returns

The requested information, or null if the key doesn't exist.

_render()

_render() : array

Return the full rendered version of the Horde_Mime_Part object.

This MUST be text/html data.

Returns

See parent::render().

_renderInline()

_renderInline() : array

Return the rendered inline version of the Horde_Mime_Part object.

This MUST be text/html data. This is not a full HTML document - only the HTML necessary to output the part.

Returns

See parent::render().

_renderInfo()

_renderInfo() : array

Return the rendered information about the Horde_Mime_Part object.

Throws

\Horde_Exception

Returns

See render().

_renderRaw()

_renderRaw() : array

Return the raw representation of the Horde_Mime_Part object.

Throws

\Horde_Exception

Returns

See render().

_getEmbeddedMimeParts()

_getEmbeddedMimeParts() : mixed

If this MIME part can contain embedded MIME part(s), and those part(s) exist, return a representation of that data.

Returns

A Horde_Mime_Part object representing the embedded data. Returns null if no embedded MIME part(s) exist.

_getViewer()

_getViewer() : mixed

Return the underlying MIME Viewer for this part.

Returns

A Horde_Mime_Viewer object, or false if not found.

_renderReturn()

_renderReturn(string  $data = null, string  $type = null) : array

Internal helper function to create render data array for a MIME Part object that only has a single part.

Parameters

Returns

See render().

_renderFullReturn()

_renderFullReturn(array  $data) : array

Internal helper function to add base HTML tags to a render() return array that contains a single MIME part.

Parameters

Returns

See render().

_getTempFile()

_getTempFile() : string

Returns a temporary file name.

Returns

A temp filename.

_textFilter()

_textFilter(string  $text, mixed  $driver, array  $params = array()) : string

Filter text.

Parameters

Returns

The filtered text.

_toHTML()

_toHTML() : string

Convert richtext to HTML.

Returns

The converted HTML string.