API Documentation
\

\Gollem_Auth

The Gollem_Auth class provides authentication for Gollem.

Copyright 2004-2017 Horde LLC (http://www.horde.org/)

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

Summary

Methods
Properties
Constants
authenticate()
transparent()
getBackend()
getPreferredBackend()
getAutologinID()
canAutoLogin()
changeBackend()
No public properties found
No constants found
_getBackends()
_setBackends()
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

authenticate()

authenticate(array  $credentials = array()) : mixed

Authenticate to the backend.

Parameters

array $credentials

An array of login credentials. If empty, attempts to login to the cached session.

'password' - (string) The user password.
'backend' - (string) The backend key to use (from backends.php).
'userId' - (string) The username.

Throws

\Horde_Auth_Exception

Returns

mixed —

If authentication was successful, and no session exists, an array of data to add to the session. Otherwise returns false.

transparent()

transparent(\Horde_Auth_Application  $auth_ob) : mixed

Perform transparent authentication.

Parameters

\Horde_Auth_Application $auth_ob

The authentication object.

Returns

mixed —

If authentication was successful, and no session exists, an array of data to add to the session. Otherwise returns false.

getBackend()

getBackend(string  $backend = null) : mixed

Loads the Gollem backend configuration from backends.php.

Parameters

string $backend

Returns this labeled entry only.

Returns

mixed —

If $backend is set return this entry; else, return the entire backends array. Returns false on error.

getPreferredBackend()

getPreferredBackend() : string

Get the current preferred backend key.

Returns

string —

The preferred backend key.

getAutologinID()

getAutologinID(string  $backend) : string

Get the authentication ID to use for autologins based on the value of the 'hordeauth' parameter.

Parameters

string $backend

The backend to login to.

Returns

string —

The ID string to use for logins.

canAutoLogin()

canAutoLogin(string  $key = null) : array

Can we log in without a login screen for the requested backend key?

Parameters

string $key

The backend to login to.

Returns

array —

The credentials needed to login ('userId', 'password', 'backend') or false if autologin not available.

changeBackend()

changeBackend(string  $key)

Change the currently active backend.

Parameters

string $key

The ID of the backend to set as active.

_getBackends()

_getBackends() : array

Return stored backend list.

Returns

array —

Backend configuration list.

_setBackends()

_setBackends(array  $backends)

Store backend list.

Parameters

array $backends

Backend configuration list.