Sabre\HTTP\Auth\AbstractAuth Class Reference

HTTP Authentication base class. More...

Inheritance diagram for Sabre\HTTP\Auth\AbstractAuth:

Collaboration diagram for Sabre\HTTP\Auth\AbstractAuth:

Public Member Functions
	__construct ($realm='SabreTooth', RequestInterface $request, ResponseInterface $response)
	Creates the object. More...
	requireLogin ()
	This method sends the needed HTTP header and statuscode (401) to force the user to login. More...
	getRealm ()
	Returns the HTTP realm. More...

Protected Attributes
	$realm
	$request
	$response

Detailed Description

HTTP Authentication base class.

This class provides some common functionality for the various base classes.

Copyright

Copyright (C) fruux GmbH (https://fruux.com/)

Author

Evert Pot (http://evertpot.com/) @license http://sabre.io/license/ Modified BSD License

Definition at line 17 of file AbstractAuth.php.

Constructor & Destructor Documentation

__construct()

Sabre\HTTP\Auth\AbstractAuth::__construct	(		$realm = 'SabreTooth',
		RequestInterface	$request,
		ResponseInterface	$response
	)

Creates the object.

Parameters

string

$realm

Returns

void

Reimplemented in Sabre\HTTP\Auth\Digest.

Definition at line 46 of file AbstractAuth.php.

                                                                                                        {
 
        $this->realm = $realm;
        $this->request = $request;
        $this->response = $response;
 
    }

References Sabre\HTTP\Auth\AbstractAuth\$realm, Sabre\HTTP\Auth\AbstractAuth\$request, and Sabre\HTTP\Auth\AbstractAuth\$response.

Member Function Documentation

getRealm()

Sabre\HTTP\Auth\AbstractAuth::getRealm

(

)

Returns the HTTP realm.

Returns

string

Definition at line 67 of file AbstractAuth.php.

                        {
 
        return $this->realm;
 
    }

References Sabre\HTTP\Auth\AbstractAuth\$realm.

requireLogin()

Sabre\HTTP\Auth\AbstractAuth::requireLogin ( )

abstract

This method sends the needed HTTP header and statuscode (401) to force the user to login.

Returns

void

Reimplemented in Sabre\HTTP\Auth\AWS, Sabre\HTTP\Auth\Basic, Sabre\HTTP\Auth\Bearer, and Sabre\HTTP\Auth\Digest.

Field Documentation

$realm

Sabre\HTTP\Auth\AbstractAuth::$realm

protected

Definition at line 24 of file AbstractAuth.php.

Referenced by Sabre\HTTP\Auth\AbstractAuth\__construct(), Sabre\HTTP\Auth\Digest\__construct(), and Sabre\HTTP\Auth\AbstractAuth\getRealm().

$request

Sabre\HTTP\Auth\AbstractAuth::$request

protected

Definition at line 31 of file AbstractAuth.php.

Referenced by Sabre\HTTP\Auth\AbstractAuth\__construct(), and Sabre\HTTP\Auth\Digest\__construct().

$response

Sabre\HTTP\Auth\AbstractAuth::$response

protected

Definition at line 38 of file AbstractAuth.php.

Referenced by Sabre\HTTP\Auth\AbstractAuth\__construct(), and Sabre\HTTP\Auth\Digest\__construct().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/sabre/http/lib/Auth/AbstractAuth.php