JsonResponse

class JsonResponse extends JsonResponse (View source)

Трейты

Свойства

mixed	$original	Исходное содержимое ответа.	from ResponseTrait
Exception\|null	$exception	Исключение, вызвавшее ошибку ответа (при необходимости).	from ResponseTrait
static protected array	$macros	Зарегистрированные строковые макросы.	from 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) Конструктор.
$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 в ответ.

Параметры

Cookie|mixed

$cookie

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

$this

$this withCookie(Cookie|mixed $cookie)

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

Параметры

Cookie|mixed

$cookie

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

$this

$this withException(Exception $e)

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

Параметры

Exception

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

$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)

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

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)

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

Параметры

string	$method
array	$parameters

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

mixed

Исключения

BadMethodCallException

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

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

Параметры

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

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

void

$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

setData($data = [])

{@inheritdoc}

Параметры

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