Interface Symfony\Contracts\HttpClient\HttpClientInterface

Provides flexible methods for requesting HTTP resources synchronously or asynchronously.

Methods


					
	public

request(string $method, string $url, array $options = []): ResponseInterface

Requests an HTTP resource.

Responses MUST be lazy, but their status code MUST be checked even if none of their public methods are called.

Implementations are not required to support all options described above; they can also support more custom options; but in any case, they MUST throw a TransportExceptionInterface when an unsupported option is passed.

Throws

Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface

When an unsupported option is passed


					
	public

stream(
	ResponseInterface|iterable<array-key, ResponseInterface> $responses,
	float|null $timeout = null,
): ResponseStreamInterface

Yields responses chunk by chunk as they complete.

Parameters

`$responses`	One or more responses created by the current HTTP client
`$timeout`	The idle timeout before yielding timeout chunks


					
	public

withOptions(array $options): static

Returns a new instance of the client with new default options

Constants
`public`	OPTIONS_DEFAULTS = [ 'auth_basic' => null, 'auth_bearer' => null, 'query' => [], 'headers' => [], 'body' => '', 'json' => null, 'user_data' => null, 'max_redirects' => 20, 'http_version' => null, 'base_uri' => null, 'buffer' => true, 'on_progress' => null, 'resolve' => [], 'proxy' => null, 'no_proxy' => null, 'timeout' => null, 'max_duration' => 0, 'bindto' => '0', 'verify_peer' => true, 'verify_host' => true, 'cafile' => null, 'capath' => null, 'local_cert' => null, 'local_pk' => null, 'passphrase' => null, 'ciphers' => null, 'peer_fingerprint' => null, 'capture_peer_cert_chain' => false, 'extra' => [], ]	#

Namespaces

Interfaces

Interface Symfony\Contracts\HttpClient\HttpClientInterface

Throws

Parameters