Spec-Zone.ru › Symfony 4.0

JsonResponse

class JsonResponse extends Response

Response представляет HTTP-ответ в формате JSON.

Обратите внимание, что этот класс не принуждает возвращаемое содержимое JSON быть объектом. Однако рекомендуется возвращать объект, так как это защищает вас от XSSI и JSON-JavaScript Hijacking.

Постоянные значения

DEFAULT_ENCODING_OPTIONS

Методы

__construct(mixed $data = null, int $status = 200, array $headers = array(), bool $json = false)
static JsonResponse create(mixed $data = null, int $status = 200, array $headers = array())

Метод фабрики для цепочки вызовов.

static fromJsonString($data = null, $status = 200, $headers = array())

Упрощает создание JsonResponse из простого JSON.

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

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

$this setJson(string $json)

Устанавливает строку, содержащую JSON-документ, который будет отправлен.

$this setData(mixed $data = array())

Устанавливает данные, которые будут отправлены как JSON.

int getEncodingOptions()

Возвращает параметры, используемые при кодировании данных в JSON.

$this setEncodingOptions(int $encodingOptions)

Устанавливает параметры, используемые при кодировании данных в JSON.

Подробности

__construct(mixed $data = null, int $status = 200, array $headers = array(), bool $json = false)

Параметры

mixed $data Данные ответа
int $status Код состояния ответа
array $headers Массив заголовков ответа
bool $json Если данные уже являются строкой JSON

static JsonResponse create(mixed $data = null, int $status = 200, array $headers = array())

Метод фабрики для цепочки вызовов.

Пример:

return JsonResponse::create($data, 200)
    ->setSharedMaxAge(300);

Параметры

mixed $data Данные ответа JSON
int $status Код состояния ответа
array $headers Массив заголовков ответа

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

JsonResponse

static fromJsonString($data = null, $status = 200, $headers = array())

Упрощает создание JsonResponse из простого JSON.

Параметры

$data
$status
$headers

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

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

Параметры

string|null $callback Обратный вызов JSONP или null для отключения

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

$this

Исключения

InvalidArgumentException При некорректном имени обратного вызова

$this setJson(string $json)

Устанавливает строку, содержащую JSON-документ, который будет отправлен.

Параметры

string $json

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

$this

Исключения

InvalidArgumentException

$this setData(mixed $data = array())

Устанавливает данные, которые будут отправлены как JSON.

Параметры

mixed $data

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

$this

Исключения

InvalidArgumentException

int getEncodingOptions()

Возвращает параметры, используемые при кодировании данных в JSON.

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

int

$this setEncodingOptions(int $encodingOptions)

Устанавливает параметры, используемые при кодировании данных в JSON.

Параметры

int $encodingOptions

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

$this

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/HttpFoundation/JsonResponse.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API