Spec-Zone.ru › Laravel 8

Ответ

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

Трейты

Macroable

Свойства

статический защищённый массив $macros

Зарегистрированные строковые макросы.

из Macroable
защищённый ResponseInterface $response

Базовый PSR ответ.

защищённый массив $decoded

Декодированный JSON ответ.

Методы

статический void macro(строка $name, объект|вызываемый $macro)

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

из Macroable
статический void mixin(объект $mixin, bool $replace = true)

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

из Macroable
статический bool hasMacro(строка $name)

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

из Macroable
статический void flushMacros()

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

из Macroable
статический смешанный __callStatic(строка $method, массив $parameters)

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

из Macroable
смешанный __call(строка $method, массив $parameters)

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

void __construct(MessageInterface $response)

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

строка body()

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

смешанный json(строка|null $key = null, смешанный $default = null)

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

объект object()

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

Collection collect(строка|null $key = null)

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

строка header(строка $header)

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

массив headers()

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

целое число status()

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

строка reason()

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

UriInterface|null effectiveUri()

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

bool successful()

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

bool ok()

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

bool redirect()

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

bool unauthorized()

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

bool forbidden()

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

bool failed()

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

bool clientError()

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

bool serverError()

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

$this onError(вызываемый $callback)

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

CookieJar cookies()

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

массив handlerStats()

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

$this close()

Закрыть поток и любые базовые ресурсы.

ResponseInterface toPsrResponse()

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

RequestException|null toException()

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

$this throw()

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

$this throwIf(bool $condition)

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

bool offsetExists(строка $offset)

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

смешанный offsetGet(строка $offset)

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

void offsetSet(строка $offset, смешанный $value)

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

void offsetUnset(строка $offset)

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

строка __toString()

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

Подробности

статический void macro(строка $name, объект|вызываемый $macro)

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

Параметры

строка $name
объект|вызываемый $macro

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

void

статический void mixin(объект $mixin, bool $replace = true)

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

Параметры

объект $mixin
bool $replace

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

void

Исключения

ReflectionException
END_OF_DOCUMENT_MARKER

static bool hasMacro(string $name)

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

Параметры

string $name

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

bool

static void flushMacros()

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

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

void

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

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

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Параметры

string $method
array $parameters

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

mixed

void __construct(MessageInterface $response)

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

Параметры

MessageInterface $response

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

void

string body()

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

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

string

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

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

Параметры

string|null $key
mixed $default

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

mixed

object object()

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

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

object

Collection collect(string|null $key = null)

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

Параметры

string|null $key

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

Collection

string header(string $header)

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

Параметры

string $header

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

string

array headers()

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

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

array

int status()

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

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

int

string reason()

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

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

string

UriInterface|null effectiveUri()

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

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

UriInterface|null

bool successful()

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

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

bool

bool ok()

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

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

bool

bool redirect()

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

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

bool

bool unauthorized()

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

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

bool

bool forbidden()

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

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

bool

bool failed()

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

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

bool

bool clientError()

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

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

bool

bool serverError()

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

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

bool

$this onError(callable $callback)

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

Параметры

callable $callback

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

$this

CookieJar cookies()

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

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

CookieJar

array handlerStats()

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

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

array

$this close()

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

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

$this

ResponseInterface toPsrResponse()

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

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

ResponseInterface

RequestException|null toException()

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

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

RequestException|null

$this throw()

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

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

$this

Исключения

RequestException

$this throwIf(bool $condition)

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

Параметры

bool $condition

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

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

Spec-Zone.ru

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