Documentation

IMP_Application extends Horde_Registry_Application
in package

IMP application API.

This file defines Horde's core API interface. Other core Horde libraries can interact with IMP through this API.

Tags
author

Michael Slusarz slusarz@horde.org

category

Horde

copyright

2010-2017 Horde LLC

license

http://www.horde.org/licenses/gpl GPL

Table of Contents

Properties

$auth  : mixed
$features  : mixed
$version  : mixed
$_oldserver  : string
Server key used in logged out session.

Methods

appInitFailure()  : mixed
authAddUser()  : mixed
authAuthenticate()  : mixed
authLoginParams()  : mixed
authRemoveUser()  : mixed
authTransparent()  : mixed
authUserList()  : mixed
changeLanguage()  : mixed
download()  : mixed
URL parameters: - actionID
exceptionHandler()  : mixed
getInitialPage()  : mixed
hasPermission()  : mixed
logout()  : mixed
nosqlDrivers()  : mixed
perms()  : mixed
setupNotification()  : mixed
Modifies the global notification handler.
topbarCreate()  : mixed
_authenticated()  : mixed
_bootstrap()  : mixed

Properties

$auth

public mixed $auth = array('add', 'authenticate', 'list', 'remove', 'transparent')

$features

public mixed $features = array('dynamicView' => \true, 'notificationHandler' => \true, 'smartmobileView' => \true)

$version

public mixed $version = 'H5 (7.0.0alpha13)'

$_oldserver

Server key used in logged out session.

protected string $_oldserver = \null

Methods

appInitFailure()

public appInitFailure(mixed $e) : mixed
Parameters
$e : mixed

authAddUser()

public authAddUser(mixed $userId, array<string|int, mixed> $credentials) : mixed
Parameters
$userId : mixed
$credentials : array<string|int, mixed>

An array of login credentials. For IMP, this must contain a password entry.

authAuthenticate()

public authAuthenticate(mixed $userId, array<string|int, mixed> $credentials) : mixed
Parameters
$userId : mixed
$credentials : array<string|int, mixed>

Credentials of the user. Allowed keys: 'imp_server_key', 'password'.

authRemoveUser()

public authRemoveUser(mixed $userId) : mixed
Parameters
$userId : mixed

authTransparent()

public authTransparent(mixed $auth_ob) : mixed
Parameters
$auth_ob : mixed

download()

URL parameters: - actionID

public download(Horde_Variables $vars) : mixed
Parameters
$vars : Horde_Variables
Tags
throws
IMP_Exception

exceptionHandler()

public exceptionHandler(mixed $e) : mixed
Parameters
$e : mixed
Tags
todo

Type hint with Throwable in H6.

hasPermission()

public hasPermission(mixed $permission, mixed $allowed[, mixed $opts = array() ]) : mixed
Parameters
$permission : mixed
$allowed : mixed
$opts : mixed = array()

setupNotification()

Modifies the global notification handler.

public setupNotification(Horde_Notification_Handler $handler) : mixed
Parameters
$handler : Horde_Notification_Handler

A notification handler.

topbarCreate()

public topbarCreate(Horde_Tree_Renderer_Base $tree[, mixed $parent = null ][, array<string|int, mixed> $params = array() ]) : mixed
Parameters
$tree : Horde_Tree_Renderer_Base
$parent : mixed = null
$params : array<string|int, mixed> = array()

_authenticated()

protected _authenticated() : mixed

        
On this page

Search results