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])
파일 보기 프로젝트 열기: horde/horde 1 사용 예제들

공개 메소드들

메소드 설명
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.