PHP Class Horde_Core_ActiveSync_Auth, horde

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, http://www.horde.org/licenses/lgpl21
Author: Michael J Rubinsky ([email protected])
Inheritance: extends Horde_Auth_Base
Exibir arquivo Open project: horde/horde Class Usage Examples

Public Methods

Method Description
__construct ( array $params = [] ) Constructor.
_authenticate ( $userId, $credentials )
authenticate ( string $userId, array $credentials, boolean $login = true ) : boolean Find out if a set of login credentials are valid, and if requested, mark the user as logged in in the current session.
hasCapability ( string $capability ) : boolean Query the current Auth object to find out if it supports the given capability.
transparent ( ) : boolean Automatic authentication.

Method Details

__construct() public method

Constructor.
public __construct ( array $params = [] )
$params array Required parameters: - base_driver: (Horde_Auth_Base) The globally configured horde auth driver. REQUIRED - transparent_driver: (Horde_Auth_Base) The driver to perform transparent auth, such as X509. OPTIONAL.

_authenticate() public method

public _authenticate ( $userId, $credentials )

authenticate() public method

Find out if a set of login credentials are valid, and if requested, mark the user as logged in in the current session.
public authenticate ( string $userId, array $credentials, boolean $login = true ) : boolean
$userId string The userId to check.
$credentials array The credentials to check.
$login boolean Whether to log the user in. If false, we'll only test the credentials and won't modify the current session. Defaults to true.
return boolean Whether or not the credentials are valid.

hasCapability() public method

Query the current Auth object to find out if it supports the given capability.
public hasCapability ( string $capability ) : boolean
$capability string The capability to test for.
return boolean Whether or not the capability is supported.

transparent() public method

Automatic authentication.
public transparent ( ) : boolean
return boolean Whether or not the client is allowed.