Child classes:
- Sabre_DAV_Auth_Backend_File
- This is an authentication backend that uses a file to manage passwords.
- Sabre_DAV_Auth_Backend_PDO
- This is an authentication backend that uses a file to manage passwords.
- Sabre_DAV_Auth_Backend_AbstractDigestMock
- HTTP Digest authentication backend class
- Webcal_Sabre_DAV_Auth_Backend_PDO
- This is an authentication backend that uses a file to manage passwords.
Inherited Variables
Inherited Constants
Inherited Methods
Class: Sabre_DAV_Auth_Backend_Abstract
- Sabre_DAV_Auth_Backend_Abstract::authenticate()
- Authenticates the user based on the current request.
- Sabre_DAV_Auth_Backend_Abstract::getCurrentUser()
- Returns information about the currently logged in user.
- Sabre_DAV_Auth_Backend_Abstract::getUsers()
- Returns the full list of users.
Class Details
HTTP Digest authentication backend class
This class can be used by authentication objects wishing to use HTTP Digest Most of the digest logic is handled, implementors just need to worry about the getUserInfo method
Tags:
- author - Evert Pot (http://www.rooftopsolutions.nl/)
- copyright - Copyright (C) 2007-2010 Rooftop Solutions. All rights reserved.
- abstract -
- license - Modified BSD License
[ Top ]
Class Variables
$currentUser
[line 24]
This variable holds information about the currently logged in user.
Tags:
- access - protected
Type: array|null
Overrides:
[ Top ]
Class Methods
authenticate
bool authenticate(
Sabre_DAV_Server
$server,
$realm)
[line 50]
Authenticates the user based on the current request.
If authentication is succesful, true must be returned. If authentication fails, an exception must be thrown.
Tags:
- throws - Sabre_DAV_Exception_NotAuthenticated
- access - public
Overrides Sabre_DAV_Auth_Backend_Abstract::authenticate() (Authenticates the user based on the current request.)
Parameters:
- Sabre_DAV_Server $server -
- $realm -
[ Top ]
getCurrentUser
array|null getCurrentUser(
)
[line 99]
Returns information about the currently logged in user.
Tags:
- access - public
Overrides Sabre_DAV_Auth_Backend_Abstract::getCurrentUser() (Returns information about the currently logged in user.)
Parameters:
[ Top ]
getUserInfo
array getUserInfo(
string
$realm, string
$username)
[line 39]
Returns a users information based on its username
The returned struct must contain at least a uri element (which can be identical to username) as well as a digestHash element.
If the user was not known, false must be returned.
Tags:
- abstract -
- access - public
Overridden in child classes as:
- Sabre_DAV_Auth_Backend_File::getUserInfo()
- Returns a users' information
- Sabre_DAV_Auth_Backend_PDO::getUserInfo()
- Returns a users' information
- Webcal_Sabre_DAV_Auth_Backend_PDO::getUserInfo()
- Returns a users' information
Parameters:
- string $realm -
- string $username -
[ Top ]