Class: Sabre_DAV_Auth_Backend_File

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

Class Overview [line 14]

This is an authentication backend that uses a file to manage passwords.

Author(s):

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

Version:

Copyright:

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

Variables

Constants

Methods

Inherited Variables

Class: Sabre_DAV_Auth_Backend_AbstractDigest

Sabre_DAV_Auth_Backend_AbstractDigest::$currentUser

Inherited Constants

Inherited Methods

Class: Sabre_DAV_Auth_Backend_AbstractDigest

Sabre_DAV_Auth_Backend_AbstractDigest::authenticate()
Authenticates the user based on the current request.
Sabre_DAV_Auth_Backend_AbstractDigest::getCurrentUser()
Returns information about the currently logged in user.
Sabre_DAV_Auth_Backend_AbstractDigest::getUserInfo()
Returns a users information based on its username

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

This is an authentication backend that uses a file to manage passwords.

The backend file must conform to Apache's htdigest format

Tags:

[ Top ]

Class Variables

$users = array()

[line 21]

List of users

Tags:

  • access - protected

Type: array

Overrides:

[ Top ]

Class Methods

__construct

void __construct( [string $filename = null])

[line 31]

Creates the backend object.

If the filename argument is passed in, it will parse out the specified file fist.

Tags:

  • access - public

Parameters:

  • string $filename -

[ Top ]

getUserInfo

string getUserInfo( string $realm, string $username)

[line 73]

Returns a users' information

Tags:

  • access - public

Overrides Sabre_DAV_Auth_Backend_AbstractDigest::getUserInfo() (Returns a users information based on its username)

Parameters:

  • string $realm -
  • string $username -

[ Top ]

getUsers

array getUsers( )

[line 87]

Returns the full list of users.

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

Tags:

  • access - public

Overrides Sabre_DAV_Auth_Backend_Abstract::getUsers() (Returns the full list of users.)

Parameters:

[ Top ]

loadFile

void loadFile( string $filename)

[line 45]

Loads an htdigest-formatted file. This method can be called multiple times if more than 1 file is used.

Tags:

  • access - public

Parameters:

  • string $filename -

[ Top ]

Class Constants

Documentation generated on Mon, 31 May 2010 12:53:19 -0400 by phpDocumentor 1.4.3