API Documentation
\

\Gollem_Application

Summary

Methods
Properties
Constants
perms()
authLoginParams()
authAuthenticate()
authTransparent()
authValidate()
menu()
sidebar()
topbarCreate()
download()
$auth
$version
No constants found
_bootstrap()
_init()
$_oldbackend
N/A
No private methods found
No private properties found
N/A

Properties

$auth

$auth :

Type

$version

$version :

Type

$_oldbackend

$_oldbackend : string

Server key used in logged out session.

Type

string

Methods

perms()

perms()

authLoginParams()

authLoginParams() : array

Return login parameters used on the login page.

Returns

array —

See Horde_Core_Auth_Application#authLoginParams().

authAuthenticate()

authAuthenticate(string  $userId, array  $credentials)

Tries to authenticate with the server and create a session.

Parameters

string $userId

The username of the user.
array $credentials

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

Throws

\Horde_Auth_Exception

authTransparent()

authTransparent(\Horde_Core_Auth_Application  $auth_ob) : boolean

Tries to transparently authenticate with the server and create a session.

Parameters

\Horde_Core_Auth_Application $auth_ob

The authentication object.

Throws

\Horde_Auth_Exception

Returns

boolean —

Whether transparent login is supported.

authValidate()

authValidate() : boolean

Validates an existing authentication.

Returns

boolean —

Whether the authentication is still valid.

menu()

menu(  $menu)

Parameters

$menu

sidebar()

sidebar(\Horde_View_Sidebar  $sidebar)

Add additional items to the sidebar.

Parameters

\Horde_View_Sidebar $sidebar

The sidebar object.

topbarCreate()

topbarCreate(\Horde_Tree_Renderer_Base  $tree,   $parent = null, array  $params = array())

Parameters

\Horde_Tree_Renderer_Base $tree
$parent
array $params

download()

download(\Horde_Variables  $vars)

URL parameters needed: - dir - driver

Parameters

\Horde_Variables $vars

Throws

\Horde_Vfs_Exception

_bootstrap()

_bootstrap()

_init()

_init()