Class Http

Summary

Fully Qualified Name: Zend\Authentication\Adapter\Http
Implements: AdapterInterface

Description

HTTP Authentication Adapter

Implements a pretty good chunk of RFC 2617.

Methods

Name Description Defined By
__construct() Constructor Http
authenticate() Authenticate Http
challengeClient() Challenge Client Http
getBasicResolver() Getter for the basicResolver property Http
getDigestResolver() Getter for the digestResolver property Http
getRequest() Getter for the Request object Http
getResponse() Getter for the Response object Http
setBasicResolver() Setter for the basicResolver property Http
setDigestResolver() Setter for the digestResolver property Http
setRequest() Setter for the Request object Http
setResponse() Setter for the Response object Http

Method Details

__construct()

Constructor

Parameter Name Type Description
$config array Configuration

Returns:

authenticate()

Authenticate

Returns: \Authentication\Result

challengeClient()

Challenge Client

Sets a 401 or 407 Unauthorized response code, and creates the appropriate Authenticate header(s) to prompt for credentials.

Returns: \Authentication\Result Always returns a non-identity Auth result

getBasicResolver()

Getter for the basicResolver property

Returns: \Http\ResolverInterface

getDigestResolver()

Getter for the digestResolver property

Returns: \Http\ResolverInterface

getRequest()

Getter for the Request object

Returns: \HTTPRequest

getResponse()

Getter for the Response object

Returns: \HTTPResponse

setBasicResolver()

Setter for the basicResolver property

Parameter Name Type Description
$resolver \Http\ResolverInterface

Returns: self Provides a fluent interface

setDigestResolver()

Setter for the digestResolver property

Parameter Name Type Description
$resolver \Http\ResolverInterface

Returns: self Provides a fluent interface

setRequest()

Setter for the Request object

Parameter Name Type Description
$request \HTTPRequest

Returns: self Provides a fluent interface

setResponse()

Setter for the Response object

Parameter Name Type Description
$response \HTTPResponse

Returns: self Provides a fluent interface

Top