Spec-Zone.ru › CakePHP 4.4

Класс Stream

Реализует отправку Cake\Http\Client\Request через API потоков PHP.

Этот подход и реализация частично вдохновлены Aura.Http

Пространство имен: Cake\Http\Client\Adapter

Краткое описание свойств

  • $_connectionErrors protected
    array

    Список ошибок соединения.

  • $_context protected
    resource|null

    Ресурс контекста, используемый API потоков.

  • $_contextOptions protected
    array<string, mixed>

    Массив параметров/содержимого для контекста потока HTTP.

  • $_sslContextOptions protected
    array<string, mixed>

    Массив параметров/содержимого для контекста потока SSL.

  • $_stream protected
    resource|null

    Ресурс потока.

Краткое описание методов

  • _buildContent() protected

    Создает содержимое запроса на основе объекта запроса.

  • _buildContext() protected

    Создает контекст потока из объекта запроса.

  • _buildHeaders() protected

    Создает контекст заголовков для запроса.

  • _buildOptions() protected

    Создает дополнительные параметры для запроса.

  • _buildResponse() protected

    Создает объект ответа

  • _buildSslContext() protected

    Создает параметры SSL для запроса.

  • _open() protected

    Открывает сокет и обрабатывает любые ошибки соединения.

  • _send() protected

    Открывает поток и отправляет запрос.

  • contextOptions() public

    Получает параметры контекста

  • createResponses() public

    Создает список ответов на основе заголовков и содержимого

  • send() public

    Отправляет запрос и получает ответ.

Подробное описание методов

_buildContent() protected 

_buildContent(Psr\Http\Message\RequestInterface $request, array<string, mixed> $options): void

Создает содержимое запроса на основе объекта запроса.

Если $request->body() является строкой, она будет использоваться как есть. Массивы данных будут обработаны с помощью {@link \Cake\Http\Client\FormData}

Parameters

Psr\Http\Message\RequestInterface $request

Отправляемый запрос.

array<string, mixed> $options

Массив параметров для использования.

Returns

void

_buildContext() protected 

_buildContext(Psr\Http\Message\RequestInterface $request, array<string, mixed> $options): void

Создает контекст потока из объекта запроса.

Parameters

Psr\Http\Message\RequestInterface $request

Запрос, из которого создается контекст.

array<string, mixed> $options

Дополнительные параметры запроса.

Returns

void

_buildHeaders() protected 

_buildHeaders(Psr\Http\Message\RequestInterface $request, array<string, mixed> $options): void

Создает контекст заголовков для запроса.

Создает cookies и заголовки.

Parameters

Psr\Http\Message\RequestInterface $request

Отправляемый запрос.

array<string, mixed> $options

Массив параметров для использования.

Returns

void

_buildOptions() protected 

_buildOptions(Psr\Http\Message\RequestInterface $request, array<string, mixed> $options): void

Создает дополнительные параметры для запроса.

Parameters

Psr\Http\Message\RequestInterface $request

Отправляемый запрос.

array<string, mixed> $options

Массив параметров для использования.

Returns

void

_buildResponse() protected 

_buildResponse(array $headers, string $body): Cake\Http\Client\Response

Создает объект ответа

Parameters

array $headers

Необработанные заголовки.

string $body

Тело ответа.

Returns

Cake\Http\Client\Response

_buildSslContext() protected 

_buildSslContext(Psr\Http\Message\RequestInterface $request, array<string, mixed> $options): void

Создает параметры SSL для запроса.

Parameters

Psr\Http\Message\RequestInterface $request

Отправляемый запрос.

array<string, mixed> $options

Массив параметров для использования.

Returns

void

_open() protected 

_open(string $url, Psr\Http\Message\RequestInterface $request): void

Открывает сокет и обрабатывает любые ошибки соединения.

Parameters

string $url

URL для подключения.

Psr\Http\Message\RequestInterface $request

Объект запроса.

Returns

void

Throws

Psr\Http\Client\RequestExceptionInterface

_send() protected 

_send(Psr\Http\Message\RequestInterface $request): array

Открывает поток и отправляет запрос.

Parameters

Psr\Http\Message\RequestInterface $request

Объект запроса.

Returns

array

Throws

Psr\Http\Client\NetworkExceptionInterface

contextOptions() public 

contextOptions(): array<string, mixed>

Получает параметры контекста

Полезно для отладки и тестирования создания контекста.

Returns

array<string, mixed>

createResponses() public 

createResponses(array $headers, string $content): arrayCake\Http\Client\Response>

Создает список ответов на основе заголовков и содержимого

Создает один или несколько объектов ответа в зависимости от количества произошедших перенаправлений.

Parameters

array $headers

Список заголовков из запроса(ов)

string $content

Содержимое ответа.

Returns

arrayCake\Http\Client\Response>

send() public 

send(Psr\Http\Message\RequestInterface $request, array<string, mixed> $options): arrayCake\Http\Client\Response>

Отправляет запрос и получает ответ.

Parameters

Psr\Http\Message\RequestInterface $request
array<string, mixed> $options

Returns

arrayCake\Http\Client\Response>

Подробное описание свойств

$_connectionErrors protected

Список ошибок соединения.

Type

array

$_context protected

Ресурс контекста, используемый API потока.

Type

resource|null

$_contextOptions protected

Массив параметров/содержимого для контекста HTTP-потока.

Type

array<string, mixed>

$_sslContextOptions protected

Массив параметров/содержимого для контекста SSL-потока.

Type

array<string, mixed>

$_stream protected

Ресурс потока.

Type

resource|null

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.4/class-Cake.Http.Client.Adapter.Stream.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API