Ответ

класс Ответ реализует ArrayAccess (Просмотреть исходный код)

Трейты

Свойства

статический защищённый массив	$macros	Зарегистрированные строковые макросы.	из Macroable
защищённый ResponseInterface	$response	Основной ответ PSR.
защищённый массив	$decoded	Декодированный ответ JSON.
CookieJar	$cookies	Куки запроса.
TransferStats\|null	$transferStats	Статистика передачи для запроса.

Методы

bool	ok() Определить, был ли код ответа 200 "OK".	from DeterminesStatusCode
bool	created() Определить, был ли код ответа 201 "Создан".	from DeterminesStatusCode
bool	accepted() Определить, был ли код ответа 202 "Принят".	from DeterminesStatusCode
bool	noContent(int $status = 204) Определить, был ли код ответа указанным кодом состояния и тело не содержит контента.	from DeterminesStatusCode
bool	movedPermanently() Определить, был ли код ответа 301 "Перемещено постоянно".	from DeterminesStatusCode
bool	found() Определить, был ли код ответа 302 "Найден".	from DeterminesStatusCode
bool	notModified() Определить, был ли код ответа 304 "Не модифицирован".	from DeterminesStatusCode
bool	badRequest() Определить, был ли ответ 400 "Неверный запрос".	from DeterminesStatusCode
bool	unauthorized() Определить, был ли ответ 401 "Не авторизован".	from DeterminesStatusCode
bool	paymentRequired() Определить, был ли ответ 402 "Требуется оплата".	from DeterminesStatusCode
bool	forbidden() Определить, был ли ответ 403 "Запрещено".	from DeterminesStatusCode
bool	notFound() Определить, был ли ответ 404 "Не найдено".	from DeterminesStatusCode
bool	requestTimeout() Определить, был ли ответ 408 "Превышено время ожидания запроса".	from DeterminesStatusCode
bool	conflict() Определить, был ли ответ 409 "Конфликт".	from DeterminesStatusCode
bool	unprocessableEntity() Определить, был ли ответ 422 "Необрабатываемое сущность".	from DeterminesStatusCode
bool	tooManyRequests() Определить, был ли ответ 429 "Слишком много запросов".	from DeterminesStatusCode
static void	macro(string $name, object\|callable $macro) Зарегистрировать пользовательский макрос.	from Macroable
static void	mixin(object $mixin, bool $replace = true) Смешать другой объект в класс.	from Macroable
static bool	hasMacro(string $name) Проверить, зарегистрирован ли макрос.	from Macroable
static void	flushMacros() Очистить существующие макросы.	from Macroable
static mixed	__callStatic(string $method, array $parameters) Динамически обрабатывать вызовы класса.	from Macroable
mixed	__call(string $method, array $parameters) Динамически передавать другие методы базовому ответу.
void	__construct(MessageInterface $response) Создать новый экземпляр ответа.
string	body() Получить тело ответа.
mixed	json(string\|null $key = null, mixed $default = null) Получить JSON декодированное тело ответа в виде массива или скалярного значения.
object\|null	object() Получить JSON декодированное тело ответа в виде объекта.
Collection	collect(string\|null $key = null) Получить JSON декодированное тело ответа в виде коллекции.
string	header(string $header) Получить заголовок из ответа.
array	headers() Получить заголовки из ответа.
int	status() Получить код состояния ответа.
string	reason() Получить фразу причины ответа.
UriInterface\|null	effectiveUri() Получить эффективный URI ответа.
bool	successful() Определить, был ли запрос успешным.
bool	redirect() Определить, был ли ответ перенаправлением.
bool	failed() Определить, указывает ли ответ на ошибку клиента или сервера.
bool	clientError() Определить, указывает ли ответ на ошибку клиента.
bool	serverError() Определить, указывает ли ответ на ошибку сервера.

$this	onError(callable $callback) Выполнить заданный обратный вызов, если произошла ошибка сервера или клиента.
CookieJar	cookies() Получить куки ответа.
array	handlerStats() Получить статистику обработчика ответа.
$this	close() Закрыть поток и все связанные ресурсы.
ResponseInterface	toPsrResponse() Получить базовый PSR ответ для ответа.
RequestException\|null	toException() Создать исключение, если произошла ошибка сервера или клиента.
$this	throw() Выбросить исключение, если произошла ошибка сервера или клиента.
$this	throwIf(Closure\|bool $condition) Выбросить исключение, если произошла ошибка сервера или клиента и заданное условие истинно.
$this	throwIfStatus(callable\|int $statusCode) Выбросить исключение, если код состояния ответа соответствует заданному коду.
$this	throwUnlessStatus(callable\|int $statusCode) Выбросить исключение, если код состояния ответа не соответствует заданному коду.
$this	throwIfClientError() Выбросить исключение, если код состояния ответа — код уровня 4xx.
$this	throwIfServerError() Выбросить исключение, если код состояния ответа — код уровня 5xx.
bool	offsetExists(string $offset) Определить, существует ли заданный смещение.
mixed	offsetGet(string $offset) Получить значение для заданного смещения.
void	offsetSet(string $offset, mixed $value) Установить значение по заданному смещению.
void	offsetUnset(string $offset) Удалить значение по заданному смещению.
string	__toString() Получить тело ответа.

Подробности

bool ok()

Определить, был ли код ответа 200 "OK".

Значение результата

bool

bool created()

Определить, был ли код ответа 201 "Создано".

Значение результата

bool

bool accepted()

Определить, был ли код ответа 202 "Принято".

Значение результата

bool

bool noContent(int $status = 204)

Определить, был ли код ответа заданным кодом состояния и тело ответа пустое.

Параметры

int

$status

Значение результата

bool

bool movedPermanently()

Определить, был ли код ответа 301 "Перемещено постоянно".

Значение результата

bool

bool found()

Определить, был ли код ответа 302 "Найдено".

Значение результата

bool

bool notModified()

Определить, был ли код ответа 304 "Не изменялось".

Значение результата

bool

bool badRequest()

Определить, был ли код ответа 400 "Плохой запрос".

Значение результата

bool

bool unauthorized()

Определить, был ли код ответа 401 "Не авторизован".

Значение результата

bool

bool paymentRequired()

Определить, был ли код ответа 402 "Требуется оплата".

Значение результата

bool

bool forbidden()

Определить, был ли код ответа 403 "Запрещено".

Значение результата

bool

bool notFound()

Определить, был ли код ответа 404 "Не найдено".

Значение результата

bool

bool requestTimeout()

Определить, был ли код ответа 408 "Тайм-аут запроса".

Значение результата

bool

bool conflict()

Определить, был ли код ответа 409 "Конфликт".

Значение результата

bool

bool unprocessableEntity()

Определить, был ли код ответа 422 "Необрабатываемое сущность".

Значение результата

bool

bool tooManyRequests()

Определить, был ли код ответа 429 "Слишком много запросов".

Значение результата

bool

static void macro(string $name, object|callable $macro)

Зарегистрировать пользовательское макро.

Параметры

string	$name
object\|callable	$macro

Значение результата

void

static void mixin(object $mixin, bool $replace = true)

Смешать другой объект в класс.

Параметры

object	$mixin
bool	$replace

Значение результата

void

Исключения

ReflectionException

END_OF_DOCUMENT_MARKER

static bool hasMacro(string $name)

Проверяет, зарегистрирован ли макрос.

Parameters

string

$name

Return Value

bool

static void flushMacros()

Очистить существующие макросы.

Return Value

void

static mixed __callStatic(string $method, array $parameters)

Динамически обрабатывает вызовы к классу.

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

Динамически делегирует другие методы на базовом ответе.

Parameters

string	$method
array	$parameters

Return Value

mixed

void __construct(MessageInterface $response)

Создать новый экземпляр ответа.

Parameters

MessageInterface

$response

Return Value

void

string body()

Получить тело ответа.

Return Value

string

mixed json(string|null $key = null, mixed $default = null)

Получить декодированное JSON тело ответа в виде массива или скалярного значения.

Parameters

string\|null	$key
mixed	$default

Return Value

mixed

object|null object()

Получить декодированное JSON тело ответа в виде объекта.

Return Value

object|null

Collection collect(string|null $key = null)

Получить декодированное JSON тело ответа в виде коллекции.

Parameters

string|null

$key

Return Value

Collection

string header(string $header)

Получить заголовок из ответа.

Parameters

string

$header

Return Value

string

array headers()

Получить заголовки из ответа.

Return Value

array

int status()

Получить код состояния ответа.

Return Value

int

string reason()

Получить фразу причины ответа.

Return Value

string

UriInterface|null effectiveUri()

Получить эффективный URI ответа.

Return Value

UriInterface|null

bool successful()

Определить, был ли запрос успешным.

Return Value

bool

bool redirect()

Определить, был ли ответ перенаправлением.

Return Value

bool

bool failed()

Определить, указывает ли ответ на возникновение ошибки клиента или сервера.

Return Value

bool

bool clientError()

Определить, указывает ли ответ на возникновение ошибки клиента.

Return Value

bool

bool serverError()

Определить, указывает ли ответ на возникновение ошибки сервера.

Return Value

bool

$this onError(callable $callback)

Выполнить переданный обратный вызов, если произошла ошибка сервера или клиента.

Parameters

callable

$callback

Return Value

$this

CookieJar cookies()

Получить куки ответа.

Return Value

CookieJar

array handlerStats()

Получить статистику обработчика ответа.

Return Value

array

$this close()

Закрыть поток и все связанные ресурсы.

Return Value

$this

ResponseInterface toPsrResponse()

Получить базовый PSR ответ для ответа.

Return Value

ResponseInterface

RequestException|null toException()

Создать исключение, если произошла ошибка сервера или клиента.

Return Value

RequestException|null

$this throw()

Выбросить исключение, если произошла ошибка сервера или клиента.

Return Value

$this

Exceptions

RequestException

$this throwIf(Closure|bool $condition)

Выбросить исключение, если произошла ошибка сервера или клиента, и заданное условие истинно.

Параметры

Closure|bool

$condition

Возвращаемое значение

$this

Исключения

RequestException

$this throwIfStatus(callable|int $statusCode)

Выбросить исключение, если код состояния ответа соответствует заданному коду.

Параметры

callable|int

$statusCode

Возвращаемое значение

$this

Исключения

RequestException

$this throwUnlessStatus(callable|int $statusCode)

Выбросить исключение, если код состояния ответа не соответствует заданному коду.

Параметры

callable|int

$statusCode

Возвращаемое значение

$this

Исключения

RequestException

$this throwIfClientError()

Выбросить исключение, если код состояния ответа является кодом уровня 4xx.

Возвращаемое значение

$this

Исключения

RequestException

$this throwIfServerError()

Выбросить исключение, если код состояния ответа является кодом уровня 5xx.

Возвращаемое значение

$this

Исключения

RequestException

bool offsetExists(string $offset)

Определить, существует ли заданный смещение.

Параметры

string

$offset

Возвращаемое значение

bool

mixed offsetGet(string $offset)

Получить значение для заданного смещения.

Параметры

string

$offset

Возвращаемое значение

mixed

void offsetSet(string $offset, mixed $value)

Установить значение по заданному смещению.

Параметры

string	$offset
mixed	$value

Возвращаемое значение

void

Исключения

LogicException

void offsetUnset(string $offset)

Удалить значение по заданному смещению.

Параметры

string

$offset

Возвращаемое значение

void

Исключения

LogicException

string __toString()

Получить тело ответа.

Возвращаемое значение

string

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Http/Client/Response.html