[ Index ] |
|
Code source de Horde 3.1.3 |
[Code source] [Imprimer] [Statistiques]
The name of the URL parameter that holds the MIME_Contents cache identifier.
Poids: | 1139 lignes (35 kb) |
Inclus ou requis: | 0 fois |
Référencé: | 0 fois |
Nécessite: | 0 fichiers |
MIME_Contents:: (38 méthodes):
MIME_Contents()
getBody()
getBodyPart()
getMIMEMessage()
getMIMEPart()
rebuildMessage()
getRawMIMEPart()
getDecodedMIMEPart()
getAttachments()
getMessage()
_arrayToTableRow()
getIndex()
removeIndex()
canDisplayInline()
getMIMEViewer()
getMIMEViewerType()
_getMIMEKey()
getMIMEKeyOverride()
setMIMEKeyOverride()
showSummaryLinks()
renderMIMEPart()
renderMIMEAttachmentInfo()
_renderMIMEPart()
buildMessage()
buildMessagePart()
viewAsAttachment()
setSummary()
partSummary()
urlView()
linkView()
linkViewJS()
formatStatusMsg()
getBaseObjectPtr()
_addCache()
_createCacheID()
_addCacheShutdown()
getCache()
cacheIDURLParam()
Classe: MIME_Contents - X-Ref
The MIME_Contents:: class contains functions related to handling the outputMIME_Contents($messageOb, $viewID = array() X-Ref |
Constructor. param: MIME_Message $messageOb The object to work with. param: array $viewID The actionID values for viewing param: array &$contents Array containing a single value: |
getBody() X-Ref |
Returns the entire body of the message. You probably want to override this function in any subclass. return: string The text of the body of the message. |
getBodyPart($id) X-Ref |
Returns the raw text for one section of the message. You probably want to override this function in any subclass. param: string $id The ID of the MIME_Part. return: string The text of the part. |
getMIMEMessage() X-Ref |
Returns the MIME_Message object for the mail message. return: MIME_Message A MIME_Message object. |
getMIMEPart($id) X-Ref |
Fetch a part of a MIME message. param: integer $id The MIME index of the part requested. return: MIME_Part The raw MIME part asked for. |
rebuildMessage() X-Ref |
Rebuild the MIME_Part structure of a message. You probably want to override this function in any subclass. return: MIME_Message A MIME_Message object with all of the body text |
getRawMIMEPart($id, $all = false) X-Ref |
Fetch part of a MIME message. param: integer $id The MIME ID of the part requested. param: boolean $all If this is a header part, should we return all text return: MIME_Part The MIME_Part. |
getDecodedMIMEPart($id, $all = false) X-Ref |
Fetch part of a MIME message and decode it, if it is base_64 or qprint encoded. param: integer $id The MIME ID of the part requested. param: boolean $all If this is a header part, should we return all text return: MIME_Part The MIME_Part with its contents decoded. |
getAttachments() X-Ref |
Return the attachment list (HTML table format). return: string The list of attachments formatted into HTML. |
getMessage($oneframe = false) X-Ref |
Return the message list (HTML table format). param: boolean $oneframe Should the output be designed for display in a return: string The message formatted into HTML. |
_arrayToTableRow($array) X-Ref |
Expands an array into a table row. param: array $array The array to expand. return: string The array expanded to a HTML table row. |
getIndex($id, $field) X-Ref |
Returns the data for a specific MIME index. param: string $id The MIME index. param: string $field The field to return (message, atc, summary) return: string The text currently set for that index. |
removeIndex($id) X-Ref |
Removes the message text and summary for a specific MIME index. param: string $id The MIME index. |
canDisplayInline(&$mime_part) X-Ref |
Determine if we can (and know how to) inline a MIME Part. param: MIME_Part &$mime_part A MIME_Part object. return: boolean True if part can be inlined. |
getMIMEViewer(&$mime_part) X-Ref |
Get MIME_Viewer object. param: MIME_Part &$mime_part A MIME_Part object. return: MIME_Viewer The MIME_Viewer object, or false on error. |
getMIMEViewerType(&$mime_part) X-Ref |
Get the MIME Content-Type output by a MIME_Viewer for a particular MIME_Part. param: MIME_Part &$mime_part A MIME_Part object. return: string The MIME type output by the MIME_Viewer, or false on |
_getMIMEKey(&$mime_part, $override = true) X-Ref |
Returns the key to use for a particular MIME_Part. param: MIME_Part &$mime_part A MIME_Part object. param: boolean $override Respect the MIME key override value? return: string The unique identifier of the MIME_Part. |
getMIMEKeyOverride() X-Ref |
Gets the MIME key override. return: string The MIME key override - null if no override. |
setMIMEKeyOverride($mimekey = null) X-Ref |
Sets an override for the MIME key. param: string $mimekey |
showSummaryLinks($show = null) X-Ref |
Should we display links for the summaries? param: boolean $show Show the summary links? |
renderMIMEPart(&$mime_part) X-Ref |
Render a MIME Part. param: MIME_Part &$mime_part A MIME_Part object. return: string The rendered data. |
renderMIMEAttachmentInfo(&$mime_part) X-Ref |
Render MIME Part attachment info. param: MIME_Part &$mime_part A MIME_Part object. return: string The rendered data. |
_renderMIMEPart(&$mime_part, $attachment = false) X-Ref |
Render MIME Part data. param: MIME_Part &$mime_part A MIME_Part object. param: boolean $attachment Render MIME Part attachment info? return: string The rendered data. |
buildMessage() X-Ref |
Build the message deciding what MIME Parts to show. return: boolean False on error. |
buildMessagePart(&$mime_part) X-Ref |
Processes a MIME_Part and stores the display information in the internal class variables. param: MIME_Part &$mime_part The MIME_Part object to process. return: string The rendered text. |
viewAsAttachment($popup = false) X-Ref |
Are we viewing this page as an attachment through view.php? This method can also be called via MIME_Contents::viewAsAttachment(). param: boolean $popup If true, also check if we are viewing attachment return: boolean True if we are viewing this part as an attachment |
setSummary(&$mime_part, $type) X-Ref |
Sets a summary entry. param: MIME_Part &$mime_part The MIME_Part object. param: string $type The summary cache to use. |
partSummary(&$mime_part, $guess = false) X-Ref |
Returns an array summarizing a part of a MIME message. param: MIME_Part &$mime_part The MIME_Part to summarize. param: boolean $guess Is this a temporary guessed-type part? return: array The summary of the part. |
urlView(&$mime_part, $actionID, $params = array() X-Ref |
Return the URL to the view.php page. param: MIME_Part &$mime_part The MIME_Part object to view. param: integer $actionID The ActionID to perform. param: array $params A list of any additional parameters that param: boolean $dload Should we generate a download link? return: string The URL to view.php. |
linkView(&$mime_part, $actionID, $text, $params = array() X-Ref |
Generate a link to the view.php page. param: MIME_Part &$mime_part The MIME_Part object to view. param: integer $actionID The actionID value. param: string $text The link text. param: array $params A list of additional parameters. param: boolean $dload Should we generate a download link? return: string A HTML href link to view.php. |
linkViewJS(&$mime_part, $actionID, $text, $jstext = null,$css = null, $params = array() X-Ref |
Generate a javascript link to the view.php page. param: MIME_Part &$mime_part The MIME_Part object to view. param: integer $actionID The ActionID to perform. param: string $text The link text. param: string $jstext The Javascript link text. param: string $css The CSS class to use. param: array $params A list of any additional parameters that param: boolean $widget If true use Horde::widget() to generate, return: string A HTML href link to view.php. |
formatStatusMsg($msg, $img = null, $printable = true,$class = null) X-Ref |
Prints out the status message for a given MIME Part. param: string $msg The message to output. param: string $img An image link to add to the beginning of the param: boolean $print Output this message when in a print view? param: string $class An optional style for the status box. return: string The formatted status message string. |
getBaseObjectPtr() X-Ref |
Return a pointer to the base object. return: mixed Returns a pointer to the base object. |
_addCache() X-Ref |
Set the MIME_Contents:: object to be cached. param: string The cache OID. |
_createCacheID() X-Ref |
Creates a unique cache ID for this object. return: string A unique cache ID. |
_addCacheShutdown() X-Ref |
Saves a copy of the MIME_Contents object at the end of a request. |
getCache($cacheid = null) X-Ref |
Returns the cached MIME_Contents:: object. This function should be called statically e.g.: $ptr = &MIME_Contents::getCache(). param: string $cacheid The cache ID to use. If empty, will use the return: MIME_Contents The MIME_Contents object, or null if it does not |
cacheIDURLParam() X-Ref |
Add the current object to the cache, and return the cache identifier to be used in URLs. return: array The parameter key/value set to use in URLs. |
Généré le : Sun Feb 25 18:01:28 2007 | par Balluche grâce à PHPXref 0.7 |