JsonResponse

класс JsonResponse расширяет JsonResponse (View source)

Трейты

Свойства

смешанное	$original	Исходное содержимое ответа.	из ResponseTrait
Throwable\|null	$exception	Исключение, вызвавшее ошибочный ответ (применимо).	из ResponseTrait
статический защищенный массив	$macros	Зарегистрированные строковые макросы.	из Macroable

Методы

int

status()

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

из ResponseTrait

строка

content()

Получить содержимое ответа.

из ResponseTrait

смешанное

getOriginalContent()

Получить исходное содержимое ответа.

из ResponseTrait

$this

header(строка $key, массив|строка $values, bool $replace = true)

Установить заголовок ответа.

из ResponseTrait

$this

withHeaders(HeaderBag|массив $headers)

Добавить массив заголовков к ответу.

из ResponseTrait

$this

cookie(Cookie|смешанное $cookie)

Добавить cookie к ответу.

из ResponseTrait

$this

withCookie(Cookie|смешанное $cookie)

Добавить cookie к ответу.

из ResponseTrait

строка|null

getCallback()

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

из ResponseTrait

$this

withException(Throwable $e)

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

из ResponseTrait

void

throwResponse()

Выбрасывает ответ в экземпляре HttpResponseException.

из ResponseTrait

статический void

macro(строка $name, объект|вызов $macro)

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

из Macroable

статический void

mixin(объект $mixin, bool $replace = true)

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

из Macroable

статический bool

hasMacro(строка $name)

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

из Macroable

статический смешанное

__callStatic(строка $method, массив $parameters)

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

из Macroable

смешанное

__call(строка $method, массив $parameters)

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

из Macroable

void

__construct(смешанное $data = null, int $status = 200, массив $headers = [], int $options = 0)

Конструктор.

$this

withCallback(строка|null $callback = null)

Устанавливает обратный вызов JSONP.

смешанное

getData(bool $assoc = false, int $depth = 512)

Получить данные json_decoded из ответа.

setData($data = [])

{@inheritdoc}

bool

hasValidJson(int $jsonError)

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

setEncodingOptions($options)

{@inheritdoc}

bool

hasEncodingOption(int $option)

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

Детали

int status()

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

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

int

строка content()

Получить содержимое ответа.

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

строка

смешанное getOriginalContent()

Получить исходное содержимое ответа.

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

смешанное

$this header(строка $key, массив|строка $values, bool $replace = true)

Установить заголовок ответа.

Параметры

строка	$key
массив\|строка	$values
bool	$replace

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

$this

$this withHeaders(HeaderBag|массив $headers)

Добавить массив заголовков к ответу.

Параметры

HeaderBag|массив

$headers

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

$this

$this cookie(Cookie|смешанное $cookie)

Добавить cookie к ответу.

Параметры

Cookie|смешанное

$cookie

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

$this

$this withCookie(Cookie|смешанное $cookie)

Добавить cookie к ответу.

Параметры

Cookie|смешанное

$cookie

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

$this

строка|null getCallback()

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

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

строка|null

$this withException(Throwable $e)

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

Параметры

Throwable

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

$this

void throwResponse()

Выбрасывает ответ в экземпляр HttpResponseException.

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

void

Исключения

HttpResponseException

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

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

Параметры

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

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

void

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

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

Параметры

объект	$mixin
логическое	$replace

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

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

Параметры

строка

$name

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

логическое

static смешанное __callStatic(string $method, array $parameters)

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

Параметры

строка	$method
массив	$parameters

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

смешанное

Исключения

BadMethodCallException

смешанное __call(string $method, array $parameters)

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

Параметры

строка	$method
массив	$parameters

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

смешанное

Исключения

BadMethodCallException

void __construct(mixed $data = null, int $status = 200, array $headers = [], int $options = 0)

Конструктор.

Параметры

смешанное	$data
целое	$status
массив	$headers
целое	$options

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

void

$this withCallback(string|null $callback = null)

Устанавливает обратный вызов JSONP.

Параметры

строка|null

$callback

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

$this

смешанное getData(bool $assoc = false, int $depth = 512)

Получить данные json_decoded из ответа.

Параметры

логическое	$assoc
целое	$depth

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

смешанное

setData($data = [])

{@inheritdoc}

Параметры

$data

protected логическое hasValidJson(int $jsonError)

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

Параметры

целое

$jsonError

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

логическое

setEncodingOptions($options)

{@inheritdoc}

Параметры

$options

логическое hasEncodingOption(int $option)

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

Параметры

целое

$option

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

логическое

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