JsonResponse

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

Трейты

Свойства

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

Методы

int

status()

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

из ResponseTrait

string

statusText()

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

из 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

$this

withoutCookie(Cookie|mixed $cookie, string|null $path = null, string|null $domain = null)

Истекает cookie при отправке ответа.

из ResponseTrait

string|null

getCallback()

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

из ResponseTrait

$this

withException(Throwable $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 void

flushMacros()

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

из 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, bool $json = false)

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

static JsonResponse

fromJsonString(string|null $data = null, int $status = 200, array $headers = [])

{@inheritdoc}

$this

withCallback(string|null $callback = null)

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

mixed

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

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

JsonResponse

setData($data = [])

{@inheritdoc}

bool

hasValidJson(int $jsonError)

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

JsonResponse

setEncodingOptions($options)

{@inheritdoc}

bool

hasEncodingOption(int $option)

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

Подробности

int status()

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

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

int

string statusText()

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

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

string

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

$this withoutCookie(Cookie|mixed $cookie, string|null $path = null, string|null $domain = null)

Истекает cookie при отправке ответа.

Параметры

Cookie\|mixed	$cookie
string\|null	$path
string\|null	$domain

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

$this

string|null getCallback()

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

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

string|null

$this withException(Throwable $e)

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

Параметры

Throwable

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

$this

void throwResponse()

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

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

void

Исключения

HttpResponseException

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

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

Исключения

BadMethodCallException

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

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

Параметры

mixed	$data
int	$status
array	$headers
int	$options
bool	$json

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

void

static JsonResponse fromJsonString(string|null $data = null, int $status = 200, array $headers = [])

{@inheritdoc}

Параметры

string\|null	$data
int	$status
array	$headers

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

JsonResponse

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

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

Параметры

string|null

$callback

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

$this

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

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

Параметры

bool	$assoc
int	$depth

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

mixed

JsonResponse setData($data = [])

{@inheritdoc}

Параметры

$data

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

JsonResponse

protected bool hasValidJson(int $jsonError)

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

Параметры

int

$jsonError

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

bool

JsonResponse setEncodingOptions($options)

{@inheritdoc}

Параметры

$options

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

JsonResponse

bool hasEncodingOption(int $option)

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

Параметры

int

$option

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

bool

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