| Свойство | Тип | Описание | |
|---|---|---|---|
| $auth | array | The full capability list can be found in Horde_Core_Auth_Application. | |
| $features | array | List of features supported by this application. | |
| $initParams | array | The init params used. | |
| $version | string | The application's version. |
| Свойство | Тип | Описание | |
|---|---|---|---|
| $_app | string | Application identifier. | |
| $_sessVars | array | Cached values to add to the session after authentication. |
| Метод | Описание | |
|---|---|---|
| __construct ( string $app ) | Constructor. | |
| appInitFailure ( Horde_Exception_PushApp $e ) | Application-specific code to run if application auth fails. | |
| authAddUser ( string $userId, array $credentials ) | Adds a user defined by authentication credentials. | |
| authAuthenticate ( string $userId, array $credentials ) | Tries to authenticate with the server and create a session. | |
| authLoginParams ( ) : array | Return login parameters used on the login page. | |
| authRemoveUser ( string $userId ) | Deletes a user defined by authentication credentials. | |
| authResetPassword ( string $userId ) : string | Reset a user's password. | |
| authTransparent ( Horde_Core_Auth_Application $auth_ob ) : boolean | Tries to transparently authenticate with the server and create a session. | |
| authUpdateUser ( string $oldId, string $newId, array $credentials ) | Update an existing user's credentials. | |
| authUserExists ( string $userId ) : boolean | Does a user exist? | |
| authUserList ( ) : array | Lists all users in the system. | |
| authValidate ( ) : boolean | Validates an existing authentication. | |
| authenticated ( ) | Code run on successful authentication. | |
| changeLanguage ( ) | Code to run if the language preference changes. | |
| configSpecialValues ( string $what ) : array |
Returns values for |
|
| download ( Horde_Variables $vars ) : array | Prepare data to deliver to browser for download. | |
| getInitialPage ( ) : mixed | Return the initial page to access. | |
| hasPermission ( string $permission, mixed $allowed, array $opts = [] ) : mixed | Returns the specified permission for the given app permission. | |
| init ( ) | Code run when the application is pushed on the stack for the first time in a page access. | |
| listAlarms ( integer $time, string $user = null ) : array | Lists alarms for a given moment. | |
| logout ( ) | Tasks to perform at logout. | |
| menu ( Horde_Menu $menu ) | Add additional items to the menu. | |
| nosqlDrivers ( ) : array | Return a list of NoSQL drivers used in the application. | |
| perms ( ) : array | Returns a list of available permissions. | |
| removeUserData ( string $user ) | Removes user data. | |
| setupNotification ( Horde_Notification_Handler $handler ) | Modifies the global notification handler. | |
| shutdown ( ) | Shutdown tasks. | |
| sidebar ( Horde_View_Sidebar $sidebar ) | Add additional items to the sidebar. | |
| topbarCreate ( Horde_Tree_Renderer_Base $tree, string $parent = null, array $params = [] ) | Add node(s) to the sidebar tree. | |
| updateSessVars ( ) | Updates cached session variable information into the active session. |
| Метод | Описание | |
|---|---|---|
| _addSessVars ( array $vars ) | Add session variables to the session. | |
| _authenticated ( ) | Code to run on successful authentication. This will be called once per session, and the entire Horde framework will be available. | |
| _bootstrap ( ) | Bootstrap code for an application. This is run when the application object is being created. The full Horde environment is not available in this method, and the user may not yet be authenticated. Only tasks necessary to setup the base application environment should be done here. | |
| _init ( ) | Code run when the application is pushed on the stack for the first time in a page access. The entire Horde framework will be available, but the user may not be authenticated. |
| final public __construct ( string $app ) | ||
| $app | string | Application identifier. |
| final protected _addSessVars ( array $vars ) | ||
| $vars | array | Array of session variables to add to the session, once it becomes available. |
| protected _authenticated ( ) |
| protected _bootstrap ( ) |
| protected _init ( ) |
| public appInitFailure ( Horde_Exception_PushApp $e ) | ||
| $e | Horde_Exception_PushApp | The exception object. |
| public authAddUser ( string $userId, array $credentials ) | ||
| $userId | string | The user ID to add. |
| $credentials | array | An array of login credentials. |
| public authAuthenticate ( string $userId, array $credentials ) | ||
| $userId | string | The username of the user. |
| $credentials | array | Credentials of the user. |
| public authLoginParams ( ) : array | ||
| Результат | array | See Horde_Core_Auth_Application#authLoginParams(). |
| public authRemoveUser ( string $userId ) | ||
| $userId | string | The user ID to delete. |
| public authResetPassword ( string $userId ) : string | ||
| $userId | string | The user id for which to reset the password. |
| Результат | string | The new password. |
| public authTransparent ( Horde_Core_Auth_Application $auth_ob ) : boolean | ||
| $auth_ob | Horde_Core_Auth_Application | The authentication object. |
| Результат | boolean | Whether transparent login is supported. |
| public authUserExists ( string $userId ) : boolean | ||
| $userId | string | The user ID to check. |
| Результат | boolean | True if the user exists. |
| public authUserList ( ) : array | ||
| Результат | array | The array of user IDs. |
| public authValidate ( ) : boolean | ||
| Результат | boolean | Whether the authentication is still valid. |
| final public authenticated ( ) |
| public changeLanguage ( ) |
| public configSpecialValues ( string $what ) : array | ||
| $what | string | The configuration setting to return. |
| Результат | array | The values for the requested configuration setting. |
| public download ( Horde_Variables $vars ) : array | ||
| $vars | Horde_Variables | Form variables provided to download script. The filename is available in the 'filename' parameter. |
| Результат | array | Download data: - data: [REQUIRED] (mixed) Data. Either a stream or a string. - name: (string) Filename that overrides 'filename' URL parameter. - size: (integer) If set, used as size. If null, no size will be sent to browser. If not set, size will be automatically determined from data. - type: (string) MIME type to send (default: application/octet-stream). |
| public getInitialPage ( ) : mixed | ||
| Результат | mixed | URL of the initial page, or null to use Horde defaults. |
| final public init ( ) |
| public nosqlDrivers ( ) : array | ||
| Результат | array | Array of NoSQL drivers. |
| public removeUserData ( string $user ) | ||
| $user | string | Name of user to remove data for. |
| public setupNotification ( Horde_Notification_Handler $handler ) | ||
| $handler | Horde_Notification_Handler | A notification handler. |
| public sidebar ( Horde_View_Sidebar $sidebar ) | ||
| $sidebar | Horde_View_Sidebar | The sidebar object. |
| public topbarCreate ( Horde_Tree_Renderer_Base $tree, string $parent = null, array $params = [] ) | ||
| $tree | Horde_Tree_Renderer_Base | Tree object. |
| $parent | string | The current parent element. |
| $params | array | Additional parameters. |
| final public updateSessVars ( ) |
| protected array $_sessVars | ||
| Результат | array | |
| public array $auth | ||
| Результат | array | |
| public array $features | ||
| Результат | array | |