Ответ

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

Трейты

Свойства

статический защищенный массив	$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	unprocessableContent() Определить, был ли ответ 422 "Необработанное содержимое".	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 unprocessableContent()

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

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

bool

bool unprocessableEntity()

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

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

bool

bool tooManyRequests()

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

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

bool

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

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

Parameters

string	$name
object\|callable	$macro

Return Value

void

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

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

Parameters

object	$mixin
bool	$replace

Return Value

void

Exceptions

ReflectionException

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()

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

Значение возврата

RequestException|null

$this throw()

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

Значение возврата

$this

Исключения

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/11.x/Illuminate/Http/Client/Response.html