PHP Class IMP_Ajax_Application, horde

Global tasks: - msgload: (string) BUID of a message to load in the background (mailbox is located in 'mailbox' parameter). - poll: (string) The list of mailboxes to process (JSON encoded array; mailboxes are base64url encoded). If an empty array, polls all mailboxes. Global parameters (in viewport parameter): - force: (integer) If set, always return viewport information if changed.

Author: Michael Slusarz ([email protected])

Inheritance: extends Horde_Core_Ajax_Application

Datei anzeigen Open project: horde/horde Class Usage Examples

Public Properties

Property	Type	Description
$indices	IMP_Indices_Mailbox	The IMP_Indices_Mailbox object based on form data.
$queue	IMP_Ajax_Queue	Queue object.

Public Methods

Method	Description
changed ( boolean $rw = null ) : boolean	Determine if the cache information has changed.
checkUidvalidity ( )	Check the UID validity of the mailbox.
composeSetup ( string $action ) : array	Setup environment for compose actions.
deleteMsgs ( IMP_Indices $indices, boolean $changed, boolean $force = false )	Processes delete message requests.
getAddrFields ( ) : array	Return address field data from the browser form.
getTasks ( ) : array	Get the list of tasks.
initCompose ( ) : object	Initialize the objects needed to compose.
previewUids ( ) : array	Return the list of preview UIDs for the current index.
send ( )
viewPortData ( boolean $change ) : IMP_Ajax_Application_Viewport	Generate the information necessary for a ViewPort request from/to the browser.

Protected Methods

Method	Description
_init ( )

Method Details

_init() protected method

protected _init ( )

changed() public method

Variables used: - cacheid: (string) The browser (ViewPort) cache identifier. - forceUpdate: (integer) If 1, forces an update.

public changed ( boolean $rw = null ) : boolean
$rw	boolean	Open mailbox as READ+WRITE?
return	boolean	True if the server state differs from the browser state.

checkUidvalidity() public method

See the list of variables needed for viewPortData().

public checkUidvalidity ( )

composeSetup() public method

Variables used: - bcc: (string) Bcc address to use. - bcc_ac: (string) Bcc address to use (autocompleter JSON data). - cc: (string) Cc address to use. - cc_ac: (string) Cc address to use (autocompleter JSON data). - composeCache: (string) The IMP_Compose cache identifier. - from: (string) From address to use. - from_ac: (string) From address to use (autocompleter JSON data). - identity: (integer) The identity to use - redirect_to: (string) To address to use (for redirect). - redirect_to_ac: (string) To address to use (for redirect) (autocompleter JSON data). - to: (string) To address to use. - to_ac: (string) To address to use (autocompleter JSON data).

public composeSetup ( string $action ) : array
$action	string	AJAX action.
return	array	An array with the following values: - (object) AJAX base return object (with action and success parameters defined). - (IMP_Compose) The IMP_Compose object for the message. - (array) The list of headers for the object. - (Horde_Prefs_Identity) The identity used for the composition.

deleteMsgs() public method

See the list of variables needed for viewPortData().

public deleteMsgs ( IMP_Indices $indices, boolean $changed, boolean $force = false )
$indices	IMP_Indices	An indices object.
$changed	boolean	If true, add full ViewPort information.
$force	boolean	If true, forces addition of disappear information.

getAddrFields() public method

Return address field data from the browser form.

public getAddrFields ( ) : array
return	array	Keys are header names, values are arrays with two keys: - addr: (array) List of addresses. - map: (boolean) If true, addr keys are autocomplete IDs.

getTasks() public method

Get the list of tasks.

public getTasks ( ) : array
return	array	Task list.

initCompose() public method

Initialize the objects needed to compose.

public initCompose ( ) : object
return	object	Object with the following properties: - ajax: IMP_Ajax_Application_Compose object - compose: IMP_Compose object - contents: IMP_Contents object

previewUids() public method

Return the list of preview UIDs for the current index.

public previewUids ( ) : array
return	array	List of objects. Each object has 2 properties: mbox and uid.

send() public method

public send ( )

viewPortData() public method

Variables used (contained in 'viewport' object): - applyfilter - cache - cacheid - delhide - initial - qsearch - qsearchfield - qsearchfilter - qsearchflag - qsearchflagnot - qsearchmbox - rangeslice - sortby - sortdir

public viewPortData ( boolean $change ) : IMP_Ajax_Application_Viewport
$change	boolean	True if cache information has changed.
return	IMP_Ajax_Application_Viewport	Viewport data object.

Property Details

$indices public_oe property

The IMP_Indices_Mailbox object based on form data.

public IMP_Indices_Mailbox $indices
return	IMP_Indices_Mailbox

$queue public_oe property

Queue object.

public IMP_Ajax_Queue $queue
return	IMP_Ajax_Queue