Docs For Class Sabre_DAV_Auth_Backend

Description

This is the base class for any authentication object.

Direct descendents

Class	Description
Sabre_DAV_Auth_Backend_AbstractBasic	HTTP Basic authentication backend class
Sabre_DAV_Auth_Backend_AbstractDigest	HTTP Digest authentication backend class
Sabre_DAV_Auth_Backend_Apache	Apache authenticator

Method Summary

bool authenticate (Sabre_DAV_Server $server, $realm)

array|null getCurrentUser ()

array getUsers ()

Methods

authenticate (line 22)

Authenticates the user based on the current request.

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

bool authenticate (Sabre_DAV_Server $server, $realm)

Redefined in descendants as:

Sabre_DAV_Auth_Backend_AbstractBasic::authenticate() : Authenticates the user based on the current request.
Sabre_DAV_Auth_Backend_AbstractDigest::authenticate() : Authenticates the user based on the current request.
Sabre_DAV_Auth_Backend_Apache::authenticate() : Authenticates the user based on the current request.

getCurrentUser (line 31)

Returns information about the currently logged in user.

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

array|null getCurrentUser ()

Redefined in descendants as:

Sabre_DAV_Auth_Backend_AbstractBasic::getCurrentUser() : Returns information about the currently logged in user.
Sabre_DAV_Auth_Backend_AbstractDigest::getCurrentUser() : Returns information about the currently logged in user.
Sabre_DAV_Auth_Backend_Apache::getCurrentUser() : Returns information about the currently logged in user.

getUsers (line 42)

Returns the full list of users.

This method must at least return a uri for each user.

It is optional to implement this.

array getUsers ()

Redefined in descendants as:

Class Sabre_DAV_Auth_Backend_Abstract