JsonResponse

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

Трейты

Свойства

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

Методы

int	status() Получить код состояния ответа.	from ResponseTrait
string	content() Получить содержимое ответа.	from ResponseTrait
mixed	getOriginalContent() Получить исходное содержимое ответа.	from ResponseTrait
$this	header(string $key, array\|string $values, bool $replace = true) Установить заголовок ответа.	from ResponseTrait
$this	withHeaders(HeaderBag\|array $headers) Добавить массив заголовков в ответ.	from ResponseTrait
$this	cookie(Cookie\|mixed $cookie) Добавить cookie в ответ.	from ResponseTrait
$this	withCookie(Cookie\|mixed $cookie) Добавить cookie в ответ.	from ResponseTrait
$this	withException(Exception $e) Установить исключение для добавления в ответ.	from ResponseTrait
throwResponse() Выбрасывает ответ в экземпляре HttpResponseException.	from ResponseTrait
static void	macro(string $name, object\|callable $macro) Регистрация пользовательского макроса.	from Macroable
static void	mixin(object $mixin) Смешивание другого объекта в класс.	from Macroable
static bool	hasMacro(string $name) Проверка регистрации макроса.	from Macroable
static mixed	__callStatic(string $method, array $parameters) Динамическая обработка вызовов класса.	from Macroable
mixed	__call(string $method, array $parameters) Динамическая обработка вызовов класса.	from Macroable
void	__construct(mixed $data = null, int $status = 200, array $headers = [], int $options = 0) Конструктор.
$this	withCallback(string\|null $callback = null) Устанавливает обратный вызов JSONP.
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|mixed

$cookie

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

$this

$this withCookie(Cookie|mixed $cookie)

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

Параметры

Cookie|mixed

$cookie

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

$this

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

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

Параметры

Исключение

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

$this

throwResponse()

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

Исключения

HttpResponseException

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

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

Параметры

string	$name
object\|callable	$macro

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

void

static void mixin(object $mixin)

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

Parameters

object

$mixin

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

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

Parameters

string

$name

Return Value

bool

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

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

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

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

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

Parameters

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

Return Value

void

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

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

Parameters

string|null

$callback

Return Value

$this

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

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

Parameters

bool	$assoc
int	$depth

Return Value

mixed

setData($data = [])

{@inheritdoc}

Parameters

$data

protected bool hasValidJson(int $jsonError)

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

Parameters

int

$jsonError

Return Value

bool

setEncodingOptions($options)

{@inheritdoc}

Parameters

$options

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