Spec-Zone.ru › CakePHP 4.3

Класс 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<string, mixed> $options): void

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

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

Параметры

Psr\Http\Message\RequestInterface$request

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

array<string, mixed>$options

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

Возвращает

void$requestBody

_buildContext() protected

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

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

Параметры

Psr\Http\Message\RequestInterface$request

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

array<string, mixed>$options

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

Возвращает

void$context

_buildHeaders() protected

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

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

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

Параметры

Psr\Http\Message\RequestInterface$request

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

array<string, mixed>$options

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

Возвращает

void$headers

_buildOptions() protected

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

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

Параметры

Psr\Http\Message\RequestInterface$request

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

array<string, mixed>$options

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

Возвращает

void$options

_buildResponse() protected

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

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

Параметры

array$headers

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

string$body

Тело ответа.

Возвращает

Cake\Http\Client\Response$response

_buildSslContext() protected

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

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

Параметры

Psr\Http\Message\RequestInterface$request

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

array<string, mixed>$options

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

Возвращает

void$sslContext

_open() protected

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

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

Параметры

string$url

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

Psr\Http\Message\RequestInterface$request

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

Возвращает

void$resource

Выбрасывает

Psr\Http\Client\RequestExceptionInterface$exception

_send() protected

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

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

Параметры

Psr\Http\Message\RequestInterface$request

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

Возвращает

array$response

Выбрасывает

Psr\Http\Client\NetworkExceptionInterface$exception

contextOptions() public

contextOptions(): array

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

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

Возвращает

array$contextOptions

createResponses() public

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

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

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

Параметры

array$headers

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

string$content

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

Возвращает

arrayCake\Http\Client\Response>$responses

send() public

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

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

Параметры

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

Возвращает

arrayCake\Http\Client\Response>$response

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

$_connectionErrors protected

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

Тип

array$array

$_context protected

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

Тип

resource|null$resource

$_contextOptions protected

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

Тип

array$array

$_sslContextOptions protected

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

Тип

array$array

$_stream protected

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

Тип

resource|null$resource

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

Spec-Zone.ru

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