Class Horde_Registry_Application

Default class for the Horde Application API.

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

Package: Core
Category: Horde
Author: Michael Slusarz slusarz@horde.org
Located at Horde/Registry/Application.php

Methods summary
`public`	# `appInitFailure( Horde_Exception $e )` Application-specific code to run if application auth fails. Called from Horde_Registry::appInit(). Application-specific code to run if application auth fails. Called from Horde_Registry::appInit(). Parameters `$e` The exception object.
`final public`	# `init( )` Initialization. Does any necessary init needed to setup the full environment for the application. Initialization. Does any necessary init needed to setup the full environment for the application. Global constants defined: [APPNAME]_TEMPLATES - (string) Location of template files.
`public`	# `menu( Horde_Menu $menu )` Add additional items to the menu. Add additional items to the menu. Parameters `$menu` The menu object.
`public`	# `logout( )` Tasks to perform at logout. Tasks to perform at logout.
`public`	# `removeUserData( string $user )` Removes user data. Removes user data. Parameters `$user` Name of user to remove data for. Throws Horde_Exception
`public array`	# `perms( )` Returns a list of available permissions. Returns a list of available permissions. Returns `array` An array describing all available permissions.
`public mixed`	# `hasPermission( string $permission, mixed $allowed, array $opts = array() )` Returns the specified permission for the given app permission. Returns the specified permission for the given app permission. Parameters `$permission` The permission to check. `$allowed` The allowed permissions. `$opts` Additional options ('value'). Returns `mixed` The value of the specified permission.
`public`	# `setupNotification( Horde_Notification_Handler $handler )` Modifies the global notification handler. Modifies the global notification handler. Parameters `$handler` A notification handler.
`public array`	# `listAlarms( integer $time, string $user = null )` Lists alarms for a given moment. Lists alarms for a given moment. Parameters `$time` The time to retrieve alarms for. `$user` <p>The user to retreive alarms for. All users if null.</p> Returns `array` An array of UIDs
`public array`	# `authLoginParams( )` Return login parameters used on the login page. Return login parameters used on the login page. Returns `array` See Horde_Core_Auth_Application#authLoginParams().
`public`	# `authAuthenticate( string $userId, array $credentials )` Tries to authenticate with the server and create a session. Tries to authenticate with the server and create a session. Parameters `$userId` The username of the user. `$credentials` Credentials of the user. Throws Horde_Auth_Exception
`public boolean`	# `authTransparent( Horde_Core_Auth_Application $auth_ob )` Tries to transparently authenticate with the server and create a session. Tries to transparently authenticate with the server and create a session. Parameters `$auth_ob` The authentication object. Returns `boolean` Whether transparent login is supported. Throws Horde_Auth_Exception
`public`	# `authAuthenticateCallback( )` Does necessary authentication tasks reliant on a full app environment. Does necessary authentication tasks reliant on a full app environment. Throws Horde_Auth_Exception
`public boolean`	# `authValidate( )` Validates an existing authentication. Validates an existing authentication. Returns `boolean` Whether the authentication is still valid. Since Horde_Core 1.4.0
`public`	# `authAddUser( string $userId, array $credentials )` Adds a user defined by authentication credentials. Adds a user defined by authentication credentials. Parameters `$userId` The user ID to add. `$credentials` An array of login credentials. Throws Horde_Auth_Exception
`public`	# `authUpdateUser( string $oldId, string $newId, array $credentials )` Update an existing user's credentials. Update an existing user's credentials. Parameters `$oldId` The old user ID. `$newId` The new user ID. `$credentials` The new login credentials. Throws Horde_Auth_Exception
`public`	# `authRemoveUser( string $userId )` Deletes a user defined by authentication credentials. Deletes a user defined by authentication credentials. Parameters `$userId` The user ID to delete. Throws Horde_Auth_Exception
`public boolean`	# `authUserExists( string $userId )` Does a user exist? Does a user exist? Parameters `$userId` The user ID to check. Returns `boolean` True if the user exists.
`public array`	# `authUserList( )` Lists all users in the system. Lists all users in the system. Returns `array` The array of user IDs. Throws Horde_Auth_Exception
`public string`	# `authResetPassword( string $userId )` Reset a user's password. Reset a user's password. Parameters `$userId` The user id for which to reset the password. Returns `string` The new password. Throws Horde_Auth_Exception
`public`	# `prefsInit( Horde_Core_Prefs_Ui $ui )` Run on init when viewing prefs for an application. Run on init when viewing prefs for an application. Parameters `$ui` The UI object.
`public`	# `prefsGroup( Horde_Core_Prefs_Ui $ui )` Determine active prefs when displaying a group. This is where all suppress/overrides should be defined. Determine active prefs when displaying a group. This is where all suppress/overrides should be defined. This function may be run multiple times in a single page - once on init and once after prefs are updated. Parameters `$ui` The UI object.
`public`	# `prefsCallback( Horde_Core_Prefs_Ui $ui )` Called when preferences are changed. Called when preferences are changed. Parameters `$ui` The UI object.
`public string`	# `prefsSpecial( Horde_Core_Prefs_Ui $ui, string $item )` Generate code used to display a special preference. Generate code used to display a special preference. Parameters `$ui` The UI object. `$item` The preference name. Returns `string` The HTML code to display on the preferences page.
`public boolean`	# `prefsSpecialUpdate( Horde_Core_Prefs_Ui $ui, string $item )` Special preferences handling on update. Special preferences handling on update. Parameters `$ui` The UI object. `$item` The preference name. Returns `boolean` True if preference was updated.
`public array`	# `configSpecialValues( string $what )` Returns values for configuration settings. Returns values for configuration settings. Parameters `$what` The configuration setting to return. Returns `array` The values for the requested configuration setting.
`public`	# `sidebarCreate( Horde_Tree_Base $tree, string $parent = null, array $params = array() )` Add node(s) to the sidebar tree. Add node(s) to the sidebar tree. Parameters `$tree` Tree object. `$parent` The current parent element. `$params` Additional parameters. Throws Horde_Exception
`public`	# `changeLanguage( )` Code to run if the language preference changes. Code to run if the language preference changes. Called only in applications the user is currently authenticated to in the current session.

Properties summary
`public boolean`	`$ajaxView` Does this application support an ajax view? Does this application support an ajax view?	# `false`
`public array`	`$auth` The list of available authentication capabilities handled by this application. The full capability list can be found in Horde_Core_Auth_Application. The list of available authentication capabilities handled by this application. The full capability list can be found in Horde_Core_Auth_Application.	# `array()`
`public array`	`$initParams` The init params used. The init params used.	# `array()`
`public boolean`	`$mobileView` Does this application support a mobile view? Does this application support a mobile view?	# `false`
`public string`	`$version` The application's version. The application's version.	# `'unknown'`

Packages

Classes

Exceptions

Class Horde_Registry_Application

Parameters

Parameters

Parameters

Throws

Returns

Parameters

Returns

Parameters

Parameters

Returns

Returns

Parameters

Throws

Parameters

Returns

Throws

Throws

Returns

Since

Parameters

Throws

Parameters

Throws

Parameters

Throws

Parameters

Returns

Returns

Throws

Parameters

Returns

Throws

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Throws