JsonResponse

class JsonResponse extends JsonResponse (View source)

Свойства

mixed	$original	Исходное содержимое ответа.	из ResponseTrait
Exception\|null	$exception	Исключение, которое вызвало ошибочный ответ (если применимо).	из ResponseTrait
static protected array	$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
string\|null	getCallback() Получить callback ответа.	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, bool $replace = true) Добавляет другой объект в класс.	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 callback.

смешанный	getData(bool $assoc = false, int $depth = 512) Получить данные из ответа, декодированные из JSON.
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

string|null getCallback()

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

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

string|null

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

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

Параметры

Исключение

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

$this

throwResponse()

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

Исключения

HttpResponseException

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

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

Parameters

string	$name
object\|callable	$macro

Return Value

void

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

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

Parameters

object	$mixin
bool	$replace

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.

Параметры

int

$jsonError

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

bool

setEncodingOptions($options)

{@inheritdoc}

Параметры

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