JsonResponse

class JsonResponse extends JsonResponse (View source)

Свойства

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

Свойства

mixed	$original	The original content of the response.	from ResponseTrait
Throwable\|null	$exception	The exception that triggered the error response (if applicable).	from ResponseTrait
static protected array	$macros	The registered string macros.	from 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()

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

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

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

static JsonResponse

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

{@inheritdoc}

$this

withCallback(string|null $callback = null)

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

mixed

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

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

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)

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

Параметры

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, из ответа.

Параметры

bool	$assoc
int	$depth

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

mixed

JsonResponse setData($data = [])

{@inheritdoc}

Параметры

$data

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

JsonResponse

protected bool hasValidJson(int $jsonError)

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

Параметры

int

$jsonError

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

bool

END_OF_DOCUMENT_MARKER

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/10.x/Illuminate/Http/JsonResponse.html