PHP Класс Gollem_Auth, horde

Copyright 2004-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Автор: Michael Slusarz ([email protected])
Автор: Jan Schneider ([email protected])
Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
authenticate ( array $credentials = [] ) : mixed Authenticate to the backend.
canAutoLogin ( string $key = null ) : array Can we log in without a login screen for the requested backend key?
changeBackend ( string $key ) Change the currently active backend.
getAutologinID ( string $backend ) : string Get the authentication ID to use for autologins based on the value of the 'hordeauth' parameter.
getBackend ( string $backend = null ) : mixed Loads the Gollem backend configuration from backends.php.
getPreferredBackend ( ) : string Get the current preferred backend key.
transparent ( Horde_Auth_Application $auth_ob ) : mixed Perform transparent authentication.

Защищенные методы

Метод Описание
_getBackends ( ) : array Return stored backend list.
_setBackends ( array $backends ) Store backend list.

Описание методов

_getBackends() защищенный статический Метод

Return stored backend list.
protected static _getBackends ( ) : array
Результат array Backend configuration list.

_setBackends() защищенный статический Метод

Store backend list.
protected static _setBackends ( array $backends )
$backends array Backend configuration list.

authenticate() публичный статический Метод

Authenticate to the backend.
public static authenticate ( array $credentials = [] ) : mixed
$credentials array 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.
Результат mixed If authentication was successful, and no session exists, an array of data to add to the session. Otherwise returns false.

canAutoLogin() публичный статический Метод

Can we log in without a login screen for the requested backend key?
public static canAutoLogin ( string $key = null ) : array
$key string The backend to login to.
Результат array The credentials needed to login ('userId', 'password', 'backend') or false if autologin not available.

changeBackend() публичный статический Метод

Change the currently active backend.
public static changeBackend ( string $key )
$key string The ID of the backend to set as active.

getAutologinID() публичный статический Метод

Get the authentication ID to use for autologins based on the value of the 'hordeauth' parameter.
public static getAutologinID ( string $backend ) : string
$backend string The backend to login to.
Результат string The ID string to use for logins.

getBackend() публичный статический Метод

Loads the Gollem backend configuration from backends.php.
public static getBackend ( string $backend = null ) : mixed
$backend string Returns this labeled entry only.
Результат mixed If $backend is set return this entry; else, return the entire backends array. Returns false on error.

getPreferredBackend() публичный статический Метод

Get the current preferred backend key.
public static getPreferredBackend ( ) : string
Результат string The preferred backend key.

transparent() публичный статический Метод

Perform transparent authentication.
public static transparent ( Horde_Auth_Application $auth_ob ) : mixed
$auth_ob Horde_Auth_Application The authentication object.
Результат mixed If authentication was successful, and no session exists, an array of data to add to the session. Otherwise returns false.