final class HttpClientConfigDefinition extends AbstractConfigDefinition (View source)

Builds one composable layer of outbound HTTP client configuration.

Properties

protected mixed[] $data from  AbstractConfigDefinition

Methods

set(string $path, mixed $value)

Replaces one configuration value at a dot-separated path.

append(string $path, mixed $value)

Appends one configuration value at a dot-separated list path.

create()

Creates an empty definition that contributes only explicitly configured values.

static string

Returns the registry key under which HTTP client definitions are collected.

string
timeout(float|int $seconds)

Sets the total request timeout in seconds.

connectTimeout(float|int $seconds)

Sets the connection-establishment timeout in seconds.

verifySsl(bool $verifySsl = true)

Sets whether the selected client transport verifies peer TLS certificates.

Details

toArray

No description

Return Value

array

fromArrayData

final static AbstractConfigDefinition fromArrayData(array $data)

No description

Parameters

array $data

Return Value

AbstractConfigDefinition

set

protected AbstractConfigDefinition set(string $path, mixed $value)

Replaces one configuration value at a dot-separated path.

Parameters

string $path
mixed $value

Return Value

AbstractConfigDefinition

append

protected AbstractConfigDefinition append(string $path, mixed $value)

Appends one configuration value at a dot-separated list path.

Parameters

string $path
mixed $value

Return Value

AbstractConfigDefinition

create

Creates an empty definition that contributes only explicitly configured values.

moduleKey

static string moduleKey()

Returns the registry key under which HTTP client definitions are collected.

Return Value

string

timeout

HttpClientConfigDefinition timeout(float|int $seconds)

Sets the total request timeout in seconds.

Parameters

float|int $seconds

Return Value

HttpClientConfigDefinition

connectTimeout

HttpClientConfigDefinition connectTimeout(float|int $seconds)

Sets the connection-establishment timeout in seconds.

Parameters

float|int $seconds

Return Value

HttpClientConfigDefinition

verifySsl

HttpClientConfigDefinition verifySsl(bool $verifySsl = true)

Sets whether the selected client transport verifies peer TLS certificates.

Parameters

bool $verifySsl

Return Value

HttpClientConfigDefinition