Class: Sabre_HTTP_BasicAuth

Source Location: /includes/classes/SabreDAV/lib/Sabre/HTTP/BasicAuth.php

Class Overview [line 14]

Sabre_HTTP_AbstractAuth
   |
   --Sabre_HTTP_BasicAuth

HTTP Basic Authentication handler

Author(s):

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

Version:

Copyright:

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

Variables

Constants

Methods


Inherited Methods

Class: Sabre_HTTP_AbstractAuth

Sabre_HTTP_AbstractAuth::__construct()
__construct
Sabre_HTTP_AbstractAuth::getRealm()
Returns the realm
Sabre_HTTP_AbstractAuth::requireLogin()
Returns an HTTP 401 header, forcing login
Sabre_HTTP_AbstractAuth::setHTTPRequest()
Sets an alternative HTTP request object
Sabre_HTTP_AbstractAuth::setHTTPResponse()
Sets an alternative HTTP response object
Sabre_HTTP_AbstractAuth::setRealm()
Sets the realm


Class Details

HTTP Basic Authentication handler

Use this class for easy http authentication setup

Tags:

[ Top ]


Class Variables


Class Methods

getUserPass

mixed getUserPass( )

[line 27]

Returns the supplied username and password.

The returned array has two values: * 0 - username * 1 - password

If nothing was supplied, 'false' will be returned

Tags:

  • access - public

Parameters:

[ Top ]

requireLogin

void requireLogin( )

[line 54]

Returns an HTTP 401 header, forcing login

This should be called when username and password are incorrect, or not supplied at all

Tags:

  • access - public

Overrides Sabre_HTTP_AbstractAuth::requireLogin() (Returns an HTTP 401 header, forcing login)

Parameters:

[ Top ]


Class Constants


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