Spec-Zone.ru › CakePHP 4.2

Класс Stream

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

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

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

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

  • $_connectionErrors protected
    array

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

  • $_context protected
    resource|null

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

  • $_contextOptions protected
    array

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

  • $_sslContextOptions protected
    array

    Массив параметров/содержимого для контекста потока 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 $options): void

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

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

Параметры

Psr\Http\Message\RequestInterface $request

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

array $options

Массив параметров.

Возвращает

void

_buildContext() protected 

_buildContext(Psr\Http\Message\RequestInterface $request, array $options): void

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

Параметры

Psr\Http\Message\RequestInterface $request

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

array $options

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

Возвращает

void

_buildHeaders() protected 

_buildHeaders(Psr\Http\Message\RequestInterface $request, array $options): void

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

Создаёт куки и заголовки.

Параметры

Psr\Http\Message\RequestInterface $request

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

array $options

Массив параметров.

Возвращает

void

_buildOptions() protected 

_buildOptions(Psr\Http\Message\RequestInterface $request, array $options): void

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

Параметры

Psr\Http\Message\RequestInterface $request

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

array $options

Массив параметров.

Возвращает

void

_buildResponse() protected 

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

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

Параметры

array $headers

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

string $body

Тело ответа.

Возвращает

Cake\Http\Client\Response

_buildSslContext() protected 

_buildSslContext(Psr\Http\Message\RequestInterface $request, array $options): void

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

Параметры

Psr\Http\Message\RequestInterface $request

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

array $options

Массив параметров.

Возвращает

void

_open() protected 

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

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

Параметры

string $url

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

Psr\Http\Message\RequestInterface $request

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

Возвращает

void

Исключения

Psr\Http\Client\RequestExceptionInterface

_send() protected 

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

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

Параметры

Psr\Http\Message\RequestInterface $request

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

Возвращает

array

Исключения

Psr\Http\Client\NetworkExceptionInterface

contextOptions() public 

contextOptions(): array

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

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

Возвращает

array

createResponses() public 

createResponses(array $headers, string $content): Cake\Http\Client\Response[]

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

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

Параметры

array $headers

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

string $content

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

Возвращает

Cake\Http\Client\Response[]

send() public 

send(Psr\Http\Message\RequestInterface $request, array $options): Cake\Http\Client\Response[]

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

Параметры

Psr\Http\Message\RequestInterface $request
array $options

Возвращает

Cake\Http\Client\Response[]

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

$_connectionErrors protected

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

Тип

array

$_context protected

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

Тип

resource|null

$_contextOptions protected

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

Тип

array

$_sslContextOptions protected

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

Тип

array

$_stream protected

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

Тип

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.2/class-Cake.Http.Client.Adapter.Stream.html

Spec-Zone.ru

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