Class: Sabre_DAV_Auth_Backend_Abstract

Source Location: /includes/classes/SabreDAV/lib/Sabre/DAV/Auth/Backend/Abstract.php

Class Overview [line 12]


This is the base class for any authentication object.

Author(s):

  • Evert Pot (http://www.rooftopsolutions.nl/)

Version:

Copyright:

  • Copyright (C) 2007-2010 Rooftop Solutions. All rights reserved.

Variables

Constants

Methods


Child classes:

Sabre_DAV_Auth_Backend_AbstractDigest
HTTP Digest authentication backend class
Sabre_DAV_Auth_MockBackend
This is the base class for any authentication object.

Inherited Variables

Inherited Constants

Inherited Methods



Class Details

This is the base class for any authentication object.

Tags:

[ Top ]


Class Variables


Class Methods

authenticate

bool authenticate( Sabre_DAV_Server $server, $realm)

[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.

Tags:

  • abstract -
  • access - public

Overridden in child classes as:

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

Parameters:

[ Top ]

getCurrentUser

array|null getCurrentUser( )

[line 31]

Returns information about the currently logged in user.

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

Tags:

  • abstract -
  • access - public

Overridden in child classes as:

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

Parameters:

[ Top ]

getUsers

array 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.

Tags:

  • access - public

Overridden in child classes as:

Sabre_DAV_Auth_Backend_File::getUsers()
Returns the full list of users.
Sabre_DAV_Auth_Backend_PDO::getUsers()
Returns a list of all users
Webcal_Sabre_DAV_Auth_Backend_PDO::getUsers()
Returns a list of all users
Sabre_DAV_Auth_MockBackend::getUsers()

Parameters:

[ Top ]


Class Constants


Documentation generated on Mon, 31 May 2010 12:52:51 -0400 by phpDocumentor 1.4.3