Mindbox-HttpClients-StreamHttpClient.md

Mindbox\HttpClients\StreamHttpClient

Класс, реализующий абстрактные методы AbstractHttpClient для отправки HTTP запросов при помощи стандартных функций PHP.

Class StreamHttpClient

• Class name: StreamHttpClient
• Namespace: Mindbox\HttpClients
• Parent class: Mindbox\HttpClients\AbstractHttpClient

Constants

DEFAULT_CONNECTION_TIMEOUT

const DEFAULT_CONNECTION_TIMEOUT = 5

Properties

$stream

protected \Mindbox\HttpClients\MindboxStream $stream

• Visibility: protected

$allowedMethods

protected mixed $allowedMethods = array('POST', 'GET')

Допустимые HTTP методы для отправки запросов.

• Visibility: protected
• This property is static.

$timeout

protected integer $timeout

• Visibility: protected

Methods

__construct

mixed Mindbox\HttpClients\AbstractHttpClient::__construct(integer|null $timeout)

Конструктор AbstractHttpClient.

• Visibility: public
• This method is defined by Mindbox\HttpClients\AbstractHttpClient

Arguments

• $timeout integer|null - <p>Таймаут соединения.</p>

handleRequest

\Mindbox\HttpClients\HttpClientRawResponse Mindbox\HttpClients\AbstractHttpClient::handleRequest(\Mindbox\MindboxRequest $request)

Абстрактный метод для отправки запроса, должен быть реализован в дочерних классах.

• Visibility: protected
• This method is abstract.
• This method is defined by Mindbox\HttpClients\AbstractHttpClient

Arguments

• $request Mindbox\MindboxRequest - <p>Экземпляр запроса.</p>

getOptions

array Mindbox\HttpClients\StreamHttpClient::getOptions(string $method, string $body, array $headers)

Формирование массива параметров запроса.

• Visibility: private

Arguments

• $method string - <p>HTTP метод запроса.</p>
• $body string - <p>Тело запроса.</p>
• $headers array - <p>Заголовки запроса.</p>

compileHeader

string Mindbox\HttpClients\StreamHttpClient::compileHeader(array $headers)

Компиляция заголовков запроса в формат, понятный MindboxStream.

• Visibility: private

Arguments

• $headers array - <p>Исходный массив заголовков.</p>

send

\Mindbox\HttpClients\HttpClientRawResponse Mindbox\HttpClients\IHttpClient::send(\Mindbox\MindboxRequest $request)

Базовый метод отправки HTTP запроса, который должен быть реализован в каждом HTTP клиенте.

• Visibility: public
• This method is defined by Mindbox\HttpClients\IHttpClient

Arguments

• $request Mindbox\MindboxRequest - <p>Экземпляр запроса.</p>

validateRequestMethod

mixed Mindbox\HttpClients\AbstractHttpClient::validateRequestMethod(string $method)

Валидация HTTP метода отправки запроса.

При недопустимом методе будет выброшено исключение MindboxHttpClientException.

• Visibility: private
• This method is defined by Mindbox\HttpClients\AbstractHttpClient

Arguments

• $method string - <p>HTTP метод отправки запроса.</p>