Request
in package
Неизменяемое описание исходящего запроса.
Содержит метод, адрес, заголовки, тело, учётные данные и настройки выполнения, а также директивы передачи: приёмник тела ответа (файл или обработчик потока), обратный вызов прогресса и смещение докачки. Все модификаторы возвращают новый экземпляр — запрос безопасно передавать через конвейер middleware.
Table of Contents
Methods
- __construct() : mixed
- auth() : Auth|null
- Учётные данные аутентификации.
- body() : Body
- Тело запроса.
- headers() : Headers
- Заголовки запроса.
- method() : non-empty-string
- Метод HTTP.
- options() : RequestOptions
- Настройки выполнения.
- progress() : callable(int, int, int, int): void|null
- Обратный вызов прогресса.
- resumeFrom() : int
- Смещение докачки.
- sink() : string|callable(string): void|null
- Приёмник тела ответа.
- uri() : Uri
- Адрес запроса.
- withBody() : self
- Копия с другим телом.
- withHeaders() : self
- Копия с другими заголовками.
- withMethod() : self
- Копия с другим методом.
- withOptions() : self
- Копия с другими настройками.
- withoutAuth() : self
- Копия без учётных данных аутентификации.
- withUri() : self
- Копия с другим адресом.
Methods
__construct()
public
__construct(non-empty-string $method, Uri $uri[, Headers $headers = new Headers() ][, Body|null $body = null ][, Auth|null $auth = null ][, RequestOptions $options = new RequestOptions() ][, string|callable(string): void|null $sink = null ][, callable(int, int, int, int): void|null $progress = null ][, int $resumeFrom = 0 ]) : mixed
Parameters
- $method : non-empty-string
-
метод HTTP (нормализованный)
- $uri : Uri
-
адрес запроса
- $headers : Headers = new Headers()
-
заголовки запроса
- $body : Body|null = null
-
тело запроса (
null— пустое тело) - $auth : Auth|null = null
-
учётные данные аутентификации или
null - $options : RequestOptions = new RequestOptions()
-
настройки выполнения
- $sink : string|callable(string): void|null = null
-
приёмник тела ответа (путь к файлу или обработчик чанков)
- $progress : callable(int, int, int, int): void|null = null
-
обратный вызов прогресса
- $resumeFrom : int = 0
-
смещение докачки в байтах (0 — с начала)
auth()
Учётные данные аутентификации.
public
auth() : Auth|null
Return values
Auth|null —учётные данные или null
body()
Тело запроса.
public
body() : Body
Return values
Body —тело
headers()
Заголовки запроса.
public
headers() : Headers
Return values
Headers —набор заголовков
method()
Метод HTTP.
public
method() : non-empty-string
Return values
non-empty-string —нормализованный метод
options()
Настройки выполнения.
public
options() : RequestOptions
Return values
RequestOptions —настройки
progress()
Обратный вызов прогресса.
public
progress() : callable(int, int, int, int): void|null
Return values
callable(int, int, int, int): void|null —обработчик прогресса или null
resumeFrom()
Смещение докачки.
public
resumeFrom() : int
Return values
int —число байт, которые нужно пропустить
sink()
Приёмник тела ответа.
public
sink() : string|callable(string): void|null
Return values
string|callable(string): void|null —путь к файлу, обработчик чанков или null
uri()
Адрес запроса.
public
uri() : Uri
Return values
Uri —разобранный URI
withBody()
Копия с другим телом.
public
withBody(Body $body) : self
Parameters
- $body : Body
-
новое тело
Return values
self —новый запрос
withHeaders()
Копия с другими заголовками.
public
withHeaders(Headers $headers) : self
Parameters
- $headers : Headers
-
новый набор заголовков
Return values
self —новый запрос
withMethod()
Копия с другим методом.
public
withMethod(non-empty-string $method) : self
Parameters
- $method : non-empty-string
-
новый метод
Return values
self —новый запрос
withOptions()
Копия с другими настройками.
public
withOptions(RequestOptions $options) : self
Parameters
- $options : RequestOptions
-
новые настройки
Return values
self —новый запрос
withoutAuth()
Копия без учётных данных аутентификации.
public
withoutAuth() : self
Return values
self —новый запрос без аутентификации
withUri()
Копия с другим адресом.
public
withUri(Uri $uri) : self
Parameters
- $uri : Uri
-
новый адрес
Return values
self —новый запрос