Digest (class)
Class Digest
Digest authentication adapter for Cake\Http\Client
Generally not directly constructed, but instead used by Cake\Http\Client when $options['auth']['type'] is 'digest'
Properties summary
-
$_client
protected
Method Summary
- __construct() publicConstructor
- _generateHeader() protectedGenerate the header Authorization
- _getServerInfo() protectedRetrieve information about the authentication
- authentication() publicAdd Authorization header to the request.
Method Detail
__construct()source public
__construct( Cake\Http\Client $client , array|null $options null )
Constructor
Parameters
-
Cake\Http\Client
$client
- Http client object.
- array|null
$options
optional null - Options list.
_generateHeader()source protected
_generateHeader( Cake\Http\Client\Request $request , array $credentials )
Generate the header Authorization
Parameters
-
Cake\Http\Client\Request
$request
- The request object.
- array
$credentials
- Authentication credentials.
Returns
string_getServerInfo()source protected
_getServerInfo( Cake\Http\Client\Request $request , array $credentials )
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
arraymodified credentials.
authentication()source public
authentication( Cake\Http\Client\Request $request , array $credentials )
Add Authorization header to the request.
Parameters
-
Cake\Http\Client\Request
$request
- The request object.
- array
$credentials
- Authentication credentials.
Returns
Cake\Http\Client\Request
The updated request.
See
http://www.ietf.org/rfc/rfc2617.txtProperties detail
© 2005–2017 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/3.3/class-Cake.Http.Client.Auth.Digest.html