Path

ez components / documentation / api reference / 2008.2.2 / webdav

eZ Components 2008.2.2

Webdav: ezcWebdavBasicAuthenticator

[ Tutorial ] [ Clients ] [ Plugin architecture ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Interface: ezcWebdavBasicAuthenticator

Interface for Basic authentication mechanism. [source]
This interface must be implemented by objects that provide authentication through a username/password combination, as defined by the HTTP Basic authentication method.
An instance of a class implementing this interface may be used in the ezcWebdavServer $auth property. The WebDAV server will then use this instance to perform authentication. In addition, classes may implement ezcWebdavDigestAuthenticator and are highly recommended to do so.

Parents

ezcWebdavAnonymousAuthenticator
   |
   --ezcWebdavBasicAuthenticator

Descendents

Child Class Description
ezcWebdavDigestAuthenticator Interface for Digest authentication mechanism.

Method Summary

public bool authenticateBasic( $data )
Checks authentication for the given $user.

Inherited Methods

From ezcWebdavAnonymousAuthenticator :
public bool ezcWebdavAnonymousAuthenticator::authenticateAnonymous()
Checks authentication for the anonymous user.

Methods

authenticateBasic

bool authenticateBasic( ezcWebdavBasicAuth $data )
Checks authentication for the given $user.
This method checks the given user/password credentials encapsulated in $data. Returns true if the user was succesfully recognized and the password is valid for him, false otherwise. In case no username and/or password was provided in the request, empty strings are provided as the parameters of this method.

Parameters

Name Type Description
$data ezcWebdavBasicAuth  

Last updated: Mon, 30 Mar 2009