CardDAV Client Library

HttpClientAdapterGuzzle extends HttpClientAdapter

in package

• Internal
• Communication

Adapter for the Guzzle HTTP client library.

Tags

psalm-import-type

Credentials from HttpClientAdapter

psalm-import-type

RequestOptions from HttpClientAdapter

psalm-type

GuzzleAllowRedirectCfg = array{ max?: int, strict?: bool, referer?: bool, protocols?: list, on_redirect?: callable(Psr7Request, Psr7Response, Psr7Uri): void, track_redirects?: bool }

psalm-type

GuzzleRequestOptions = array{ headers?: array<string, string | list>, body?: string | resource | \Psr\Http\Message\StreamInterface, allow_redirects?: bool | GuzzleAllowRedirectCfg, auth?: null | array{string, string} | array{string, string, string}, curl?: array, base_uri?: string, http_errors?: bool, handler?: HandlerStack }

Table of Contents

NEEDED_AUTHNFO  = ['basic' => ['username', 'password'], 'digest' => ['username', 'password'], 'bearer' => ['bearertoken']]

Defines which credential attributes are required for auth mechanisms.

GUZZLE_KNOWN_AUTHSCHEMES  = ['basic', 'digest', 'ntlm']

A list of authentication schemes that can be handled by Guzzle itself, independent on whether it works only with the Guzzle Curl HTTP handler or not. Strings must be lowercase!

$baseUri  : string

The base URI for requests.

$credentials  : Credentials

The credentials to use for authentication

$authScheme  : string|null

The HTTP authentication scheme to use. Null if not determined yet.

$client  : Client

The Client object of the Guzzle HTTP library.

$failedAuthSchemes  : array<int, string>

HTTP authentication schemes tried without success, to avoid trying again.

$known_authschemes  : array<int, string>

A list of authentication schemes that can be handled by this HttpClientAdapter.

$schemeToCurlOpt  : mixed

Maps lowercase auth-schemes to their CURLAUTH_XXX constant. Only values not part of GUZZLE_KNOWN_AUTHSCHEMES are relevant here.

__construct()  : mixed

Constructs a HttpClientAdapterGuzzle object.

sendRequest()  : ResponseInterface

Sends a PSR-7 request and returns a PSR-7 response.

checkCredentialsAvailable()  : bool

Checks if the needed credentials for an authentication scheme are available.

checkSameDomainAsBase()  : bool

Checks whether the given URI has the same domain as the base URI of this HTTP client.

getDomainFromSubdomain()  : string

Extracts the domain name from a subdomain.

checkSabreCurlIncompatibility()  : bool

Checks if a request was rejected because of an incompatibility between curl and sabre/dav.

getSupportedAuthSchemes()  : array<int, string>

Extracts HTTP authentication schemes from a WWW-Authenticate header.

prepareGuzzleOptions()  : array<string|int, mixed>

Prepares options for the Guzzle request.