API Documentation
\

\Horde_Mime_Related

This class parses a multipart/related MIME part (RFC 2387) to provide information on the part contents.

Summary

Methods
Properties
Constants
__construct()
startId()
cidSearch()
cidReplace()
getIterator()
No public properties found
No constants found
_cidReplace()
$_cids
$_start
N/A
No private methods found
No private properties found
N/A

Properties

$_cids

$_cids : array

Content IDs.

Type

array

$_start

$_start : string

Start ID.

Type

string

Methods

__construct()

__construct(\Horde_Mime_Part  $mime_part)

Constructor.

Parameters

\Horde_Mime_Part $mime_part

A MIME part object. Must be of type multipart/related.

startId()

startId() : string

Return the start ID.

Returns

string —

The start ID.

cidSearch()

cidSearch(string  $cid) : string

Search for a CID in the related part.

Parameters

string $cid

The CID to search for.

Returns

string —

The MIME ID or false if not found.

cidReplace()

cidReplace(mixed  $text, callback  $callback, string  $charset = 'UTF-8') : \Horde_Domhtml

Scan for CID strings in HTML data and replace with data returned from a callback method.

Parameters

mixed $text

The HTML text (can be Horde_Domhtml object).
callback $callback

Callback method. Receives three arguments: MIME ID, the attribute name containing the content ID, and the node object. Expects return value of URL to display the data.
string $charset

HTML data charset.

Returns

\Horde_Domhtml —

A Horde_Domhtml object.

getIterator()

getIterator()

_cidReplace()

_cidReplace(  $node,   $attribute,   $callback)

Parameters

$node
$attribute
$callback