Class Sabre_DAV_Auth_Backend_AbstractBasic

Description

HTTP Basic authentication backend class

This class can be used by authentication objects wishing to use HTTP Basic Most of the digest logic is handled, implementors just need to worry about the authenticateInternal and getUserInfo methods

  • author: Evert Pot (http://www.rooftopsolutions.nl/)
  • author: James David Low (http://jameslow.com/)
  • copyright: Copyright (C) 2007-2010 Rooftop Solutions. All rights reserved.
  • abstract:
  • license: Modified BSD License

Located in /sources_custom/Sabre/DAV/Auth/Backend/AbstractBasic.php (line 16)

Sabre_DAV_Auth_Backend_Abstract
   |
   --Sabre_DAV_Auth_Backend_AbstractBasic
Direct descendents
Class Description
Sabre_DAV_Auth_Backend_OCP This is an authentication backend that uses a file to manage passwords.
Variable Summary
array|null $currentUser
Method Summary
bool authenticate (Sabre_DAV_Server $server,  $realm)
array|null getCurrentUser ()
bool|array validateUserPass ( $username,  $password)
Variables
array|null $currentUser (line 24)

This variable holds information about the currently logged in user.

  • access: protected
Methods
authenticate (line 59)

Authenticates the user based on the current request.

If authentication is succesful, true must be returned. If authentication fails, an exception must be thrown.

  • throws: Sabre_DAV_Exception_NotAuthenticated
  • access: public
bool authenticate (Sabre_DAV_Server $server,  $realm)

Redefinition of:
Sabre_DAV_Auth_Backend_Abstract::authenticate()
Authenticates the user based on the current request.
getCurrentUser (line 45)

Returns information about the currently logged in user.

If nobody is currently logged in, this method should return null.

  • access: public
array|null getCurrentUser ()

Redefinition of:
Sabre_DAV_Auth_Backend_Abstract::getCurrentUser()
Returns information about the currently logged in user.
validateUserPass (line 36)

Validates a username and password

If the username and password were correct, this method must return an array with at least a 'uri' key.

If the credentials are incorrect, this method must return false.

  • abstract:
  • access: protected
bool|array validateUserPass ( $username,  $password)
  • $username
  • $password

Redefined in descendants as:

Inherited Methods

Inherited From Sabre_DAV_Auth_Backend_Abstract

Sabre_DAV_Auth_Backend_Abstract::authenticate()
Sabre_DAV_Auth_Backend_Abstract::getCurrentUser()
Sabre_DAV_Auth_Backend_Abstract::getUsers()

Documentation generated on Sun, 02 Jan 2011 23:06:51 +0000 by phpDocumentor 1.4.3