W3cubDocs

/CakePHP 4.4

Class Digest

Digest authentication adapter for Cake\Http\Client

Generally not directly constructed, but instead used by {@link \Cake\Http\Client} when $options['auth']['type'] is 'digest'

Property Summary

  • $_client protected
    Cake\Http\Client

    Instance of Cake\Http\Client

Method Summary

Method Detail

__construct() public

__construct(Cake\Http\Client $client, array|null $options = null)

Constructor

Parameters

Cake\Http\Client $client

Http client object.

array|null $options optional

Options list.

_generateHeader() protected

_generateHeader(Cake\Http\Client\Request $request, array<string, mixed> $credentials): string

Generate the header Authorization

Parameters

Cake\Http\Client\Request $request

The request object.

array<string, mixed> $credentials

Authentication credentials.

Returns

string

_getServerInfo() protected

_getServerInfo(Cake\Http\Client\Request $request, array $credentials): array

Retrieve information about the authentication

Will get the realm and other tokens by performing another request without authentication to get authentication challenge.

Parameters

Cake\Http\Client\Request $request

The request object.

array $credentials

Authentication credentials.

Returns

array

authentication() public

authentication(Cake\Http\Client\Request $request, array<string, mixed> $credentials): Cake\Http\Client\Request

Add Authorization header to the request.

Parameters

Cake\Http\Client\Request $request

The request object.

array<string, mixed> $credentials

Authentication credentials.

Returns

Cake\Http\Client\Request

See Also

https://www.ietf.org/rfc/rfc2617.txt

Property Detail

$_client protected

Instance of Cake\Http\Client

Type

Cake\Http\Client

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.4/class-Cake.Http.Client.Auth.Digest.html