Class Horde_Core_Ajax_Application

Defines the AJAX interface for an application.

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Abstract
Package: Core
Category: Horde
License: LGPL 2.1
Author: Michael Slusarz slusarz@horde.org
Located at Horde/Core/Ajax/Application.php

Methods summary
`public`	# `__construct( string $app, Horde_Variables $vars, string $action = null )` Constructor. Constructor. Parameters `$app` The application name. `$vars` Form/request data. `$action` The AJAX action to perform.
`public mixed`	# `doAction( )` Performs the AJAX action. Performs the AJAX action. Returns `mixed` The result of the action call. Throws Horde_Exception
`public string`	# `responseType( )` Determines the HTTP response output type. Determines the HTTP response output type. Returns `string` The output type. See Horde::sendHTTPResponse().
`public`	# `logOut( )` Logs the user off the Horde session. Logs the user off the Horde session. This needs to be done here (server), rather than on the browser, because the logout tokens might otherwise expire.
`public Horde_Url`	# `getSessionLogoutUrl( )` AJAX actions performed through the endpoint are normally not a good URL to return to. Thus, by default after a session timeout, return to the base of the application instead. AJAX actions performed through the endpoint are normally not a good URL to return to. Thus, by default after a session timeout, return to the base of the application instead. Returns `Horde_Url` The logout Horde_Url object.
`public object`	# `listGroups( )` Returns a hash of group IDs and group names that the user has access to. Returns a hash of group IDs and group names that the user has access to. Returns `object` Object with the following properties: - groups: (array) Groups hash.
`public object`	# `parseEmailAddress( )` Parses a valid email address out of a complete address string. Parses a valid email address out of a complete address string. Variables used: - mbox: (string) The name of the new mailbox. - parent: (string) The parent mailbox. Returns `object` Object with the following properties: - email: (string) The parsed email address. Throws Horde_Exception Horde_Mail_Exception
`public object`	# `chunkContent( )` Loads a chunk of PHP code (usually an HTML template) from the application's templates directory. Loads a chunk of PHP code (usually an HTML template) from the application's templates directory. Returns `object` Object with the following properties: - chunk: (string) A chunk of PHP output.
`public boolean`	# `setPrefValue( )` Sets a preference value. Sets a preference value. Variables used: - pref: (string) The preference name. - value: (mixed) The preference value. Returns `boolean` True on success.

Properties summary
`public boolean`	`$notify` Determines if notification information is sent in response. Determines if notification information is sent in response.	# `false`

Packages

Classes

Exceptions

Class Horde_Core_Ajax_Application

Parameters

Returns

Throws

Returns

See

Returns

Returns

Returns

Throws

Returns

Returns