JsonResponse

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

Параметры

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

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

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

Пример:

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

Параметры

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

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

Response

string __toString()

Возвращает ответ как строку HTTP.

Представление ответа в виде строки совпадает со строкой, которая будет отправлена клиенту, только если перед этим был вызван метод prepare().

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

string

Ответ как строка HTTP

См. также

prepare()

__clone()

Клонирует текущий экземпляр Response.

$this prepare(Request $request)

Подготавливает ответ перед отправкой клиенту.

Этот метод корректирует ответ, чтобы убедиться, что он соответствует RFC 2616. Большинство изменений основаны на запросе, «ассоциированном» с этим ответом.

Параметры

Request

$request

Экземпляр Request

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

$this

$this sendHeaders()

Отправляет HTTP-заголовки.

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

$this

$this sendContent()

Отправляет содержимое для текущего ответа веб-сервера.

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

$this

$this send()

Отправляет HTTP-заголовки и содержимое.

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

$this

$this setContent(mixed $content)

Устанавливает содержимое ответа.

Допустимые типы: строки, числа, null и объекты, реализующие метод __toString().

Параметры

mixed

$content

Содержимое, которое может быть преобразовано в строку

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

$this

Исключения

UnexpectedValueException

string getContent()

Получает текущее содержимое ответа.

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

string

Содержимое

$this setProtocolVersion(string $version)

Устанавливает версию HTTP-протокола (1.0 или 1.1).

Параметры

string

$version

Версия HTTP-протокола

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

$this

string getProtocolVersion()

Получает версию HTTP-протокола.

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

string

Версия HTTP-протокола

$this setStatusCode(int $code, mixed $text = null)

Устанавливает код состояния ответа.

Если текст статуса равен null, он будет автоматически заполнен для известных кодов статусов, в противном случае останется пустым.

Параметры

int	$code	Код HTTP-статуса
mixed	$text	Текст HTTP-статуса

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

$this

Исключения

InvalidArgumentException

При неверном коде HTTP-статуса

int getStatusCode()

Получает код состояния текущего веб-ответа.

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

int	Код состояния

$this setCharset(string $charset)

Устанавливает кодировку символов ответа.

Параметры

string

$charset

Кодировка символов

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

$this

string getCharset()

Получает кодировку символов ответа.

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

string

Кодировка символов

bool isCacheable()

Возвращает true, если ответ подходит для кэширования в любых условиях.

Ответы, помеченные как «частные» с явным директивой Cache-Control, считаются некэшируемыми.

Ответы без срока действия кэширования (Expires, max-age) или валидатора кэша (Last-Modified, ETag) считаются некэшируемыми.

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

bool	true, если ответ подходит для кэширования, иначе false

bool isFresh()

Возвращает true, если ответ «свежий».

Свежие ответы могут быть возвращены из кэша без взаимодействия с источником. Ответ считается свежим, когда он содержит указатель Cache-Control/max-age или заголовок Expires, а рассчитанный срок действия меньше, чем срок действия кэширования.

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

bool	true, если ответ свежий, иначе false

bool isValidateable()

Возвращает true, если ответ содержит заголовки, которые можно использовать для проверки ответа с сервером-источником с помощью условного запроса GET.

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

bool	true, если ответ проверяем, иначе false

$this setPrivate()

Помечает ответ как «частный».

Это делает ответ недоступным для других клиентов.

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

$this

$this setPublic()

Помечает ответ как «общедоступный».

Это делает ответ доступным для других клиентов.

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

$this

bool mustRevalidate()

Возвращает true, если ответ должен быть повторно проверен кэшами.

Этот метод указывает, что ответ не должен передаваться устаревшим кэшем ни при каких обстоятельствах без предварительной повторной проверки с исходным сервером. При наличии значения TTL ответа не должно быть больше, чем указано исходным сервером.

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

bool	true, если ответ должен быть проверен кэшем, иначе false

DateTime getDate()

Возвращает заголовок Date как экземпляр DateTime.

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

DateTime

Экземпляр \DateTime

Исключения

RuntimeException

При невозможности разбора заголовка

$this setDate(DateTime $date)

Устанавливает заголовок Date.

Параметры

DateTime

$date

Экземпляр \DateTime

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

$this

int getAge()

Возвращает возраст ответа.

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

int	Возраст ответа в секундах

$this expire()

Помечает ответ устаревшим, установив заголовок Age равным максимальному возрасту ответа.

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

$this

DateTime|null getExpires()

Возвращает значение заголовка Expires в виде экземпляра DateTime.

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

DateTime|null

Экземпляр DateTime или null, если заголовок отсутствует

$this setExpires(DateTime $date = null)

Устанавливает заголовок Expires HTTP с экземпляром DateTime.

Передача null в качестве значения удалит заголовок.

Параметры

DateTime

$date

Экземпляр \DateTime или null для удаления заголовка

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

$this

int|null getMaxAge()

Возвращает количество секунд после времени, указанного в заголовке ответа Date, когда ответ больше не должен считаться свежим.

Сначала проверяется директива s-maxage, затем директива max-age, а затем используется заголовок expires. Возвращает null, когда максимальный срок хранения не может быть установлен.

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

int|null

Количество секунд

$this setMaxAge(int $value)

Устанавливает количество секунд, по истечении которых ответ больше не должен считаться свежим.

Этот метод устанавливает директиву Cache-Control max-age.

Параметры

int

$value

Количество секунд

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

$this

$this setSharedMaxAge(int $value)

Устанавливает количество секунд, по истечении которых ответ больше не должен считаться свежим для кэшей, используемых совместно.

Этот метод устанавливает директиву Cache-Control s-maxage.

Параметры

int

$value

Количество секунд

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

$this

int|null getTtl()

Возвращает время жизни ответа в секундах.

Возвращает null, когда информация о свежести отсутствует в ответе.

Если время жизни ответа TTL <= 0, ответ может не быть получен из кэша без предварительной проверки с источником.

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

int|null

Время жизни в секундах

$this setTtl(int $seconds)

Устанавливает время жизни ответа для кэшей, используемых совместно.

Этот метод изменяет директиву Cache-Control/s-maxage.

Параметры

int

$seconds

Количество секунд

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

$this

$this setClientTtl(int $seconds)

Устанавливает время жизни ответа для частных/клиентских кэшей.

Этот метод изменяет директиву Cache-Control/max-age.

Параметры

int

$seconds

Количество секунд

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

$this

DateTime|null getLastModified()

Возвращает заголовок Last-Modified HTTP в виде экземпляра DateTime.

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

DateTime|null

Экземпляр DateTime или null, если заголовок не существует

Исключения

RuntimeException

При невозможности парсить заголовок HTTP

$this setLastModified(DateTime $date = null)

Устанавливает заголовок Last-Modified HTTP с помощью экземпляра DateTime.

Передача null в качестве значения удалит заголовок.

Параметры

DateTime

$date

Экземпляр \DateTime или null для удаления заголовка

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

$this

string|null getEtag()

Возвращает литеральное значение заголовка ETag HTTP.

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

string|null

Заголовок HTTP ETag или null, если он не существует

$this setEtag(string|null $etag = null, bool $weak = false)

Устанавливает значение ETag.

Параметры

string|null	$etag	Уникальный идентификатор ETag или null для удаления заголовка
bool	$weak	Нужно ли использовать слабый ETag

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

$this

$this setCache(array $options)

Устанавливает заголовки кэша ответа (валидация и/или срок хранения).

Доступные параметры: etag, lastmodified, maxage, s_maxage, private и public.

Параметры

array

$options

Массив параметров кэша

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

$this

Исключения

InvalidArgumentException

$this setNotModified()

Изменяет ответ так, чтобы он соответствовал правилам, определённым для кода состояния 304.

Устанавливает статус, удаляет тело и отбрасывает заголовки, которые НЕ ДОЛЖНЫ включаться в ответы 304.

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

$this

См. также

http://tools.ietf.org/html/rfc2616#section-10.3.5

bool hasVary()

Возвращает true, если ответ содержит заголовок Vary.

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

bool	true, если ответ содержит заголовок Vary, иначе false

array getVary()

Возвращает массив имён заголовков, указанных в заголовке Vary.

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

array

Массив имён Vary

$this setVary(string|array $headers, bool $replace = true)

Устанавливает заголовок Vary.

Параметры

string|array	$headers
bool	$replace	Заменить ли фактическое значение (по умолчанию true)

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

$this

bool isNotModified(Request $request)

Определяет, соответствуют ли валидаторы ответа (ETag, Last-Modified) условным значениям, указанным в запросе.

Если ответ не был изменён, устанавливает код состояния 304 и удаляет фактическое содержимое, вызвав метод setNotModified().

Параметры

Request

$request

Экземпляр Request

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

bool	true, если валидаторы ответа соответствуют запросу, иначе false

bool isInvalid()

Является ли ответ недействительным?

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

bool

См. также

http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html

bool isInformational()

Является ли ответ информативным?

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

bool

bool isSuccessful()

Успешен ли ответ?

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

bool

bool isRedirection()

Является ли ответ перенаправлением?

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

bool

bool isClientError()

Возникла ли ошибка клиента?

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

bool

bool isServerError()

Возникла ли ошибка на стороне сервера?

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

bool

bool isOk()

Успешен ли ответ?

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

bool

bool isForbidden()

Запрещён ли ответ?

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

bool

bool isNotFound()

Является ли ответ ошибкой "не найдено"?

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

bool

bool isRedirect(string $location = null)

Является ли ответ перенаправлением?

Параметры

string

$location

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

bool

bool isEmpty()

Пуст ли ответ?

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

bool

static closeOutputBuffers(int $targetLevel, bool $flush)

Очищает или сбрасывает буферы вывода до целевого уровня.

Результирующий уровень может быть больше целевого уровня, если был обнаружен не удаляемый буфер.

Параметры

int	$targetLevel	Целевой уровень буферизации вывода
bool	$flush	Сбрасывать или очищать буферы

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