CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (Github)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 3.3 Red Velvet API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 3.3
      • 5.2
      • 5.1
      • 5.0
      • 4.6
      • 4.5
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Namespaces

  • Global
  • Cake
    • Auth
    • Cache
    • Collection
    • Console
    • Controller
    • Core
    • Database
    • Datasource
    • Error
    • Event
    • Filesystem
    • Form
    • Http
      • Client
        • Adapter
        • Auth
    • I18n
    • Log
    • Mailer
    • Network
    • ORM
    • Routing
    • Shell
    • TestSuite
    • Utility
    • Validation
    • View

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'

Namespace: Cake\Http\Client\Auth

Property Summary

  • $_client protected
    Cake\Http\Client

    Instance of Cake\Http\Client

Method Summary

  • __construct() public

    Constructor

  • _generateHeader() protected

    Generate the header Authorization

  • _getServerInfo() protected

    Retrieve information about the authentication

  • authentication() public

    Add Authorization header to the request.

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 $credentials): string

Generate the header Authorization

Parameters
Cake\Http\Client\Request $request

The request object.

array $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 $credentials): Cake\Http\Client\Request

Add Authorization header to the request.

Parameters
Cake\Http\Client\Request $request

The request object.

array $credentials

Authentication credentials.

Returns
Cake\Http\Client\Request
See Also
http://www.ietf.org/rfc/rfc2617.txt

Property Detail

$_client ¶ protected

Instance of Cake\Http\Client

Type
Cake\Http\Client
OpenHub
Pingping
Linode
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (Github)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs