Docs For Class DIMP

DIMP

Description

$Horde: dimp/lib/DIMP.php,v 1.110.2.41 2010-09-27 18:14:30 slusarz Exp $

See the enclosed file COPYING for license information (GPL). If you did not receive this file, see http://www.fsf.org/copyleft/gpl.html.

Located in /lib/DIMP.php (line 10)

Method Summary

string actionButton ([array $params = array()])

string composeLink ([mixed $args = array()], [array $extra = array()])

array getAttachmentInfo ( $imp_compose)

array getFolderResponse (IMP_Tree $imptree, [array $changes = null])

void header (string $title, [array $scripts = array()])

array menuList ()

string notify ()

void outputJS ()

void prepareResponse ([string $data = null], [boolean $notify = true], [boolean $auto = true])

void _appendedFolderPref ( $folder)

string _includeDIMPJSVars ()

Methods

actionButton (line 27)

Output a dimp-style action (menubar) link.

return: An HTML link to $url.

string actionButton ([array $params = array()])

array $params: A list of parameters.

 'app' - The application to load the icon from.
 'class' - The CSS classname to use for the link.
 'icon' - The icon filename to display.
 'id' - The DOM ID of the link.
 'title' - The title string.
 'tooltip' - Tooltip text to use.

composeLink (line 532)

Returns the appropriate link to call the message composition screen.

return: The link to the message composition screen.

string composeLink ([mixed $args = array()], [array $extra = array()])

mixed $args: List of arguments to pass to compose.php. If this is passed in as a string, it will be parsed as a toaddress?subject=foo&cc=ccaddress (mailto-style) string.
array $extra: Hash of extra, non-standard arguments to pass to compose.php.

getAttachmentInfo (line 486)

Return information about the current attachments for a message

var: An IMP_Compose object.

return: An array of arrays with the following keys:

 'number' - The current attachment number
 'name' - The HTML encoded attachment name
 'type' - The MIME type of the attachment
 'size' - The size of the attachment in KB (string)

array getAttachmentInfo ( $imp_compose)

$imp_compose

getFolderResponse (line 322)

Formats the response to send to javascript code when dealing with folder operations.

return: The object used by the JS code to update the folder tree.

array getFolderResponse (IMP_Tree $imptree, [array $changes = null])

IMP_Tree $imptree: An IMP_Tree object.
array $changes: An array with three sub arrays - to be used instead of the return from $imptree->eltDiff(): 'a' - a list of folders to add 'c' - a list of changed folders 'd' - a list of folders to delete

header (line 60)

Output everything up to but not including the <body> tag.

void header (string $title, [array $scripts = array()])

string $title: The title of the page.
array $scripts: Any additional scripts that need to be loaded. Each entry contains the three elements necessary for a Horde::addScriptFile() call.

menuList (line 509)

Return a list of DIMP specific menu items.

return: The array of menu items.

array menuList ()

notify (line 287)

Return the javascript code necessary to display notification popups.

return: The notification JS code.

string notify ()

outputJS (line 302)

Output the javascript for the page.

void outputJS ()

prepareResponse (line 456)

Returns a stdClass response object with added notification information.

void prepareResponse ([string $data = null], [boolean $notify = true], [boolean $auto = true])

string $data: The 'response' data.
boolean $notify: If true, adds notification information to object.
boolean $auto: If true, DimpCore will automatically display the notification. If false, the callback handler is responsible for displaying the notification.

_appendedFolderPref (line 277)

Return an appended IMP folder string

void _appendedFolderPref ( $folder)

$folder

_includeDIMPJSVars (line 132)

Outputs the javascript code which defines all javascript variables that are dependent on the local user's account.

private:

string _includeDIMPJSVars ()

Documentation generated on Sun, 30 Jan 2011 05:10:54 +0000 by phpDocumentor 1.4.3