Response
in package
Неизменяемый ответ на запрос.
Содержит код состояния, заголовки, тело, тайминги и итоговый адрес (с учётом перенаправлений). Предоставляет удобные проверки класса статуса и разбор тела как JSON. При потоковой загрузке в файл тело в памяти не хранится — доступен путь назначения через Response::sinkPath().
Table of Contents
Methods
- __construct() : mixed
- body() : string
- Тело ответа.
- effectiveUrl() : string
- Итоговый адрес после перенаправлений.
- header() : string
- Значения заголовка, объединённые запятой.
- headers() : Headers
- Заголовки ответа.
- isClientError() : bool
- Является ли ответ ошибкой клиента (класс 4xx).
- isRedirect() : bool
- Является ли ответ перенаправлением (класс 3xx).
- isServerError() : bool
- Является ли ответ ошибкой сервера (класс 5xx).
- isSuccessful() : bool
- Успешен ли ответ (класс 2xx).
- json() : mixed
- Разобрать тело ответа как JSON.
- reason() : string
- Пояснительная фраза статуса.
- saveTo() : int
- Сохранить тело ответа в файл.
- sinkPath() : string|null
- Путь файла-приёмника при потоковой загрузке.
- status() : int
- Код состояния HTTP.
- timing() : Timing
- Тайминги выполнения.
Methods
__construct()
public
__construct(int $status, string $reason, Headers $headers, string $body[, Timing $timing = new Timing() ][, string $effectiveUrl = '' ][, string|null $sinkPath = null ]) : mixed
Parameters
- $status : int
-
код состояния HTTP
- $reason : string
-
пояснительная фраза статуса
- $headers : Headers
-
заголовки ответа
- $body : string
-
тело ответа (пустое при потоковой загрузке в файл)
- $timing : Timing = new Timing()
-
тайминги выполнения
- $effectiveUrl : string = ''
-
итоговый адрес после перенаправлений
- $sinkPath : string|null = null
-
путь файла-приёмника при потоковой загрузке
body()
Тело ответа.
public
body() : string
Return values
string —тело (пустое при потоковой загрузке в файл)
effectiveUrl()
Итоговый адрес после перенаправлений.
public
effectiveUrl() : string
Return values
string —адрес (может быть пустым)
header()
Значения заголовка, объединённые запятой.
public
header(string $name) : string
Parameters
- $name : string
-
имя заголовка (регистр не важен)
Return values
string —объединённые значения (пустая строка, если заголовка нет)
headers()
Заголовки ответа.
public
headers() : Headers
Return values
Headers —набор заголовков
isClientError()
Является ли ответ ошибкой клиента (класс 4xx).
public
isClientError() : bool
Return values
bool —true, если код в диапазоне 400–499
isRedirect()
Является ли ответ перенаправлением (класс 3xx).
public
isRedirect() : bool
Return values
bool —true, если код в диапазоне 300–399
isServerError()
Является ли ответ ошибкой сервера (класс 5xx).
public
isServerError() : bool
Return values
bool —true, если код >= 500
isSuccessful()
Успешен ли ответ (класс 2xx).
public
isSuccessful() : bool
Return values
bool —true, если код в диапазоне 200–299
json()
Разобрать тело ответа как JSON.
public
json([bool $associative = true ]) : mixed
Parameters
- $associative : bool = true
-
возвращать ли объекты как ассоциативные массивы
Tags
Return values
mixed —декодированное значение
reason()
Пояснительная фраза статуса.
public
reason() : string
Return values
string —фраза (может быть пустой)
saveTo()
Сохранить тело ответа в файл.
public
saveTo(string $path) : int
Parameters
- $path : string
-
путь назначения
Tags
Return values
int —число записанных байт
sinkPath()
Путь файла-приёмника при потоковой загрузке.
public
sinkPath() : string|null
Return values
string|null —путь или null, если тело в памяти
status()
Код состояния HTTP.
public
status() : int
Return values
int —код состояния
timing()
Тайминги выполнения.
public
timing() : Timing
Return values
Timing —тайминги