Child classes:
- Sabre_HTTP_AWSAuth
- HTTP AWS Authentication handler
- Sabre_HTTP_BasicAuth
- HTTP Basic Authentication handler
- Sabre_HTTP_DigestAuth
- HTTP Digest Authentication handler
Inherited Variables
Inherited Constants
Inherited Methods
Class Details
HTTP Authentication baseclass
This class has the common functionality for BasicAuth and DigestAuth
Tags:
- author - Evert Pot (http://www.rooftopsolutions.nl/)
- copyright - Copyright (C) 2010 Rooftop Solutions. All rights reserved.
- abstract -
- license - Modified BSD License
[ Top ]
Class Variables
$httpRequest
[ Top ]
$httpResponse
[ Top ]
$realm = 'SabreDAV'
[line 23]
The realm will be displayed in the dialog boxes
This identifier can be changed through setRealm()
Tags:
- access - protected
Type: string
Overrides:
[ Top ]
Class Methods
__construct
Sabre_HTTP_AbstractAuth __construct(
)
[line 44]
__construct
Tags:
- access - public
Overridden in child classes as:
- Sabre_HTTP_DigestAuth::__construct()
- Initializes the object
Parameters:
[ Top ]
getRealm
string getRealm(
)
[line 96]
Returns the realm
Tags:
- access - public
Parameters:
[ Top ]
requireLogin
void requireLogin(
)
[line 109]
Returns an HTTP 401 header, forcing login
This should be called when username and password are incorrect, or not supplied at all
Tags:
- abstract -
- access - public
Overridden in child classes as:
- Sabre_HTTP_AWSAuth::requireLogin()
- Returns an HTTP 401 header, forcing login
- Sabre_HTTP_BasicAuth::requireLogin()
- Returns an HTTP 401 header, forcing login
- Sabre_HTTP_DigestAuth::requireLogin()
- Returns an HTTP 401 header, forcing login
Parameters:
[ Top ]
setHTTPRequest
void setHTTPRequest(
Sabre_HTTP_Request
$request)
[line 69]
Sets an alternative HTTP request object
Tags:
- access - public
Parameters:
- Sabre_HTTP_Request $request -
[ Top ]
setHTTPResponse
void setHTTPResponse(
Sabre_HTTP_Response
$response)
[line 57]
Sets an alternative HTTP response object
Tags:
- access - public
Parameters:
- Sabre_HTTP_Response $response -
[ Top ]
setRealm
void setRealm(
string
$realm)
[line 85]
Sets the realm
The realm is often displayed in authentication dialog boxes Commonly an application name displayed here
Tags:
- access - public
Parameters:
- string $realm -
[ Top ]