JsonResponse

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

Черты

Свойства

mixed	$original	Оригинальное содержимое ответа.	из ResponseTrait
Exception\|null	$exception	Исключение, вызвавшее ошибочный ответ (если применимо).	из ResponseTrait
static protected array	$macros	Зарегистрированные строковые макросы.	из Macroable

Методы

int

status()

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

из ResponseTrait

string

content()

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

из ResponseTrait

mixed

getOriginalContent()

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

из ResponseTrait

$this

header(string $key, array|string $values, bool $replace = true)

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

из ResponseTrait

$this

withHeaders(HeaderBag|array $headers)

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

из ResponseTrait

$this

cookie(Cookie|mixed $cookie)

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

из ResponseTrait

$this

withCookie(Cookie|mixed $cookie)

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

из ResponseTrait

string|null

getCallback()

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

из ResponseTrait

$this

withException(Exception $e)

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

из ResponseTrait

void

throwResponse()

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

из ResponseTrait

static void

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

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

из Macroable

static void

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

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

из Macroable

static bool

hasMacro(string $name)

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

из Macroable

static mixed

__callStatic(string $method, array $parameters)

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

из Macroable

mixed

__call(string $method, array $parameters)

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

из Macroable

void

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

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

$this

withCallback(string|null $callback = null)

Устанавливает JSONP callback.

mixed

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

string content()

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

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

string

mixed getOriginalContent()

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

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

mixed

$this header(string $key, array|string $values, bool $replace = true)

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

Параметры

string	$key
array\|string	$values
bool	$replace

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

$this

$this withHeaders(HeaderBag|array $headers)

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

Параметры

HeaderBag|array

$headers

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

$this

$this cookie(Cookie|mixed $cookie)

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

Параметры

Cookie|mixed

$cookie

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

$this

$this withCookie(Cookie|mixed $cookie)

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

Параметры

Cookie|mixed

$cookie

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

$this

END_OF_DOCUMENT_MARKER

строка|null getCallback()

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

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

строка|null

$this withException(Исключение $e)

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

Параметры

Исключение

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

$this

пустое значение throwResponse()

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

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

пустое значение

Исключения

HttpResponseException

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

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

Параметры

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

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

пустое значение

статический пустое значение mixin(объект $mixin, логическое значение $replace = true)

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

Параметры

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

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

пустое значение

Исключения

ReflectionException

статический логическое значение hasMacro(строка $name)

Проверка регистрации макроса.

Параметры

строка

$name

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

логическое значение

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

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

Параметры

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

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

смешанное значение

Исключения

BadMethodCallException

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

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

Параметры

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

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

смешанное значение

Исключения

BadMethodCallException

пустое значение __construct(смешанное значение $data = null, целое число $status = 200, массив $headers = [], целое число $options = 0)

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

Параметры

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

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

пустое значение

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

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

Параметры

строка|null

$callback

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

$this

смешанное значение getData(логическое значение $assoc = false, целое число $depth = 512)

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

Параметры

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

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

смешанное значение

setData($data = [])

{@inheritdoc}

Параметры

$data

защищенный логическое значение hasValidJson(целое число $jsonError)

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

Параметры

целое число

$jsonError

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

логическое значение

setEncodingOptions($options)

{@inheritdoc}

Параметры

$options

логическое значение hasEncodingOption(целое число $option)

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

Параметры

целое число

$option

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

логическое значение

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