JsonResponse
class JsonResponse extends Response
Ответ представляет HTTP-ответ в формате JSON.
Обратите внимание, что этот класс не принуждает возвращаемое содержимое JSON быть объектом. Тем не менее, рекомендуется возвращать объект, так как это защищает от XSSI и JSON-JavaScript Hijacking.
Постоянные значения
| HTTP_CONTINUE | |
| HTTP_SWITCHING_PROTOCOLS | |
| HTTP_PROCESSING | |
| HTTP_OK | |
| HTTP_CREATED | |
| HTTP_ACCEPTED | |
| HTTP_NON_AUTHORITATIVE_INFORMATION | |
| HTTP_NO_CONTENT | |
| HTTP_RESET_CONTENT | |
| HTTP_PARTIAL_CONTENT | |
| HTTP_MULTI_STATUS | |
| HTTP_ALREADY_REPORTED | |
| HTTP_IM_USED | |
| HTTP_MULTIPLE_CHOICES | |
| HTTP_MOVED_PERMANENTLY | |
| HTTP_FOUND | |
| HTTP_SEE_OTHER | |
| HTTP_NOT_MODIFIED | |
| HTTP_USE_PROXY | |
| HTTP_RESERVED | |
| HTTP_TEMPORARY_REDIRECT | |
| HTTP_PERMANENTLY_REDIRECT | |
| HTTP_BAD_REQUEST | |
| HTTP_UNAUTHORIZED | |
| HTTP_PAYMENT_REQUIRED | |
| HTTP_FORBIDDEN | |
| HTTP_NOT_FOUND | |
| HTTP_METHOD_NOT_ALLOWED | |
| HTTP_NOT_ACCEPTABLE | |
| HTTP_PROXY_AUTHENTICATION_REQUIRED | |
| HTTP_REQUEST_TIMEOUT | |
| HTTP_CONFLICT | |
| HTTP_GONE | |
| HTTP_LENGTH_REQUIRED | |
| HTTP_PRECONDITION_FAILED | |
| HTTP_REQUEST_ENTITY_TOO_LARGE | |
| HTTP_REQUEST_URI_TOO_LONG | |
| HTTP_UNSUPPORTED_MEDIA_TYPE | |
| HTTP_REQUESTED_RANGE_NOT_SATISFIABLE | |
| HTTP_EXPECTATION_FAILED | |
| HTTP_I_AM_A_TEAPOT | |
| HTTP_UNPROCESSABLE_ENTITY | |
| HTTP_LOCKED | |
| HTTP_FAILED_DEPENDENCY | |
| HTTP_RESERVED_FOR_WEBDAV_ADVANCED_COLLECTIONS_EXPIRED_PROPOSAL | |
| HTTP_UPGRADE_REQUIRED | |
| HTTP_PRECONDITION_REQUIRED | |
| HTTP_TOO_MANY_REQUESTS | |
| HTTP_REQUEST_HEADER_FIELDS_TOO_LARGE | |
| HTTP_INTERNAL_SERVER_ERROR | |
| HTTP_NOT_IMPLEMENTED | |
| HTTP_BAD_GATEWAY | |
| HTTP_SERVICE_UNAVAILABLE | |
| HTTP_GATEWAY_TIMEOUT | |
| HTTP_VERSION_NOT_SUPPORTED | |
| HTTP_VARIANT_ALSO_NEGOTIATES_EXPERIMENTAL | |
| HTTP_INSUFFICIENT_STORAGE | |
| HTTP_LOOP_DETECTED | |
| HTTP_NOT_EXTENDED | |
| HTTP_NETWORK_AUTHENTICATION_REQUIRED |
Свойства
| ResponseHeaderBag | $headers | из Response | |
| static array | $statusTexts | Таблица перевода кодов статусов. | из Response |
Методы
| __construct(mixed $data = null, int $status = 200, array $headers = array()) Конструктор. | ||
| static Response | create($data = null, int $status = 200, array $headers = array()) Метод фабрики для цепочечной обработки. | |
| string | __toString() Возвращает ответ как строку HTTP. | из Response |
| __clone() Клонирует текущий экземпляр Response. | из Response | |
| Response | prepare(Request $request) Подготавливает ответ перед отправкой клиенту. | из Response |
| Response | sendHeaders() Отправляет HTTP-заголовки. | из Response |
| Response | sendContent() Отправляет содержимое для текущего веб-ответа. | из Response |
| Response | send() Отправляет HTTP-заголовки и содержимое. | из Response |
| Response | setContent(mixed $content) Устанавливает содержимое ответа. | из Response |
| string | getContent() Получает текущее содержимое ответа. | из Response |
| Response | setProtocolVersion(string $version) Устанавливает версию протокола HTTP (1.0 или 1.1). | из Response |
| string | getProtocolVersion() Получает версию протокола HTTP. | из Response |
| Response | setStatusCode(int $code, mixed $text = null) Устанавливает код состояния ответа. | из Response |
| int | getStatusCode() Возвращает код состояния для текущего веб-ответа. | из Response |
| Response | setCharset(string $charset) Устанавливает кодировку ответа. | из Response |
| string | getCharset() Возвращает кодировку ответа. | из Response |
| bool | isCacheable() Возвращает true, если ответ стоит кешировать в любом случае. | из Response |
| bool | isFresh() Возвращает true, если ответ «свежий». | из Response |
| bool | isValidateable() Возвращает true, если ответ содержит заголовки, которые могут быть использованы для проверки ответа с исходным сервером с помощью запроса с условным GET. | из Response |
| Response | setPrivate() Помечает ответ как «личный». | из Response |
| Response | setPublic() Помечает ответ как «общедоступный». | из Response |
| bool | mustRevalidate() Возвращает true, если ответ должен быть перепроверен кэшами. | из Response |
| DateTime | getDate() Возвращает заголовок Date в виде экземпляра DateTime. | из Response |
| Response | setDate(DateTime $date) Устанавливает заголовок Date. | из Response |
| int | getAge() Возвращает возраст ответа. | из Response |
| Response | expire() Помечает ответ устаревшим, установив заголовок Age равным максимальному возрасту ответа. | из Response |
| DateTime|null | getExpires() Возвращает значение заголовка Expires в виде экземпляра DateTime. | из Response |
| Response | setExpires(DateTime $date = null) Устанавливает HTTP-заголовок Expires с помощью экземпляра DateTime. | из Response |
| int|null | getMaxAge() Возвращает количество секунд после времени, указанного в заголовке Date ответа, когда ответ больше не считается свежим. | из Response |
| Response | setMaxAge(int $value) Устанавливает количество секунд, после которых ответ больше не должен считаться свежим. | из Response |
| Response | setSharedMaxAge(int $value) Устанавливает количество секунд, после которых ответ больше не должен считаться свежим для кэшей общего использования. | из Response |
| int|null | getTtl() Возвращает время жизни ответа в секундах. | из Response |
| Response | setTtl(int $seconds) Устанавливает время жизни ответа для кэшей общего использования. | из Response |
| Response | setClientTtl(int $seconds) Устанавливает время жизни ответа для частных/клиентских кэшей. | из Response |
| DateTime|null | getLastModified() Возвращает заголовок Last-Modified в формате DateTime. | из Response |
| Response | setLastModified(DateTime $date = null) Устанавливает заголовок Last-Modified с помощью экземпляра DateTime. | из Response |
| строка|null | getEtag() Возвращает фактическое значение HTTP-заголовка ETag. | из Response |
| Response | setEtag(строка|null $etag = null, bool $weak = false) Устанавливает значение ETag. | из Response |
| Response | setCache(массив $options) Устанавливает заголовки кэширования ответа (валидация и/или срок действия). | из Response |
| Response | setNotModified() Изменяет ответ таким образом, чтобы он соответствовал правилам, определенным для кода состояния 304. | из Response |
| bool | hasVary() Возвращает true, если ответ включает заголовок Vary. | из Response |
| массив | getVary() Возвращает массив имен заголовков, указанных в заголовке Vary. | из Response |
| Response | setVary(строка|массив $headers, bool $replace = true) Устанавливает заголовок Vary. | из Response |
| bool | isNotModified(Request $request) Определяет, соответствуют ли валидаторы ответа (ETag, Last-Modified) условным значениям, указанным в запросе. | из Response |
| bool | isInvalid() Является ли ответ недействительным? | из Response |
| bool | isInformational() Является ли ответ информативным? | из Response |
| bool | isSuccessful() Успешен ли ответ? | из Response |
| bool | isRedirection() Является ли ответ перенаправлением? | из Response |
| bool | isClientError() Есть ли ошибка клиента? | из Response |
| bool | isServerError() Была ли ошибка на стороне сервера? | из Response |
| bool | isOk() Успешен ли ответ? | из Response |
| bool | isForbidden() Запрещен ли ответ? | из Response |
| bool | isNotFound() Является ли ответ ошибкой "не найдено"? | из Response |
| bool | isRedirect(строка $location = null) Является ли ответ перенаправлением? | из Response |
| bool | isEmpty() Пуст ли ответ? | из Response |
| static | closeOutputBuffers(целое $targetLevel, bool $flush) Очищает или сбрасывает буферы вывода до уровня target. | из Response |
| JsonResponse | setCallback(строка|null $callback = null) Устанавливает обратный вызов JSONP. | |
| JsonResponse | setData(смешанный $data = массив()) Устанавливает данные, которые будут отправлены как JSON. | |
| целое | getEncodingOptions() Возвращает опции, используемые при кодировании данных в JSON. | |
| JsonResponse | setEncodingOptions(целое $encodingOptions) Устанавливает опции, используемые при кодировании данных в JSON. |
Подробности
__construct(mixed $data = null, int $status = 200, array $headers = array())
Конструктор.
Параметры
| mixed | $data | Данные ответа |
| int | $status | Код состояния ответа |
| array | $headers | Массив заголовков ответа |
static Response create($data = null, int $status = 200, array $headers = array())
Метод-фабрика для цепочечной обработки.
Пример:
return Response::create($body, 200)
->setSharedMaxAge(300);
Параметры
| $data | ||
| int | $status | Код состояния ответа |
| array | $headers | Массив заголовков ответа |
Значение результата
| Response |
string __toString()
Возвращает ответ как строку HTTP.
Строковое представление ответа такое же, как будет отправлено клиенту, только если перед этим был вызван метод prepare().
Значение результата
| string | Ответ как строка HTTP |
См. также
| prepare() |
__clone()
Клонирует текущую экземпляр Response.
Response prepare(Request $request)
Подготавливает ответ перед отправкой клиенту.
Этот метод настраивает ответ, чтобы он соответствовал RFC 2616. Большинство изменений основано на запросе, «связанном» с этим ответом.
Параметры
| Request | $request | Экземпляр Request |
Значение результата
| Response | Текущий ответ. |
Response sendHeaders()
Отправляет HTTP-заголовки.
Значение результата
| Response |
Response sendContent()
Отправляет содержимое текущего веб-ответа.
Значение результата
| Response |
Response send()
Отправляет HTTP-заголовки и содержимое.
Значение результата
| Response |
Response setContent(mixed $content)
Устанавливает содержимое ответа.
Допустимые типы: строки, числа, null и объекты, реализующие метод __toString().
Параметры
| mixed | $content | Содержимое, которое можно преобразовать в строку |
Значение результата
| Response |
Исключения
| UnexpectedValueException |
string getContent()
Получает текущее содержимое ответа.
Значение результата
| string | Содержимое |
Response setProtocolVersion(string $version)
Устанавливает версию HTTP-протокола (1.0 или 1.1).
Параметры
| string | $version | Версия HTTP-протокола |
Значение результата
| Response |
string getProtocolVersion()
Получает версию HTTP-протокола.
Значение результата
| string | Версия HTTP-протокола |
Response setStatusCode(int $code, mixed $text = null)
Устанавливает код состояния ответа.
Параметры
| int | $code | Код состояния HTTP |
| mixed | $text | Текст состояния HTTP Если текст состояния null, он будет автоматически заполнен для известных кодов состояния, в противном случае останется пустым. |
Значение результата
| Response |
Исключения
| InvalidArgumentException | При некорректном коде состояния HTTP |
int getStatusCode()
Возвращает код состояния текущего веб-ответа.
Значение результата
| int | Код состояния |
Response setCharset(string $charset)
Устанавливает кодировку ответа.
Параметры
| string | $charset | Кодировка |
Значение результата
| Response |
string getCharset()
Возвращает кодировку ответа.
Значение результата
| string | Кодировка |
bool isCacheable()
Возвращает true, если ответ подходит для кэширования в любом случае.
Ответы, помеченные как «private» с явным директивой 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 |
Response setPrivate()
Помечает ответ как «private».
Это делает ответ недоступным для других клиентов.
Значение результата
| Response |
Response setPublic()
Помечает ответ как «public».
Это делает ответ доступным для других клиентов.
Значение результата
| Response |
bool mustRevalidate()
Возвращает true, если ответ должен быть перепроверен кэшами.
Этот метод указывает, что ответ не должен быть предоставлен устаревшим кэшем в любом случае без предварительной перепроверки с источником. Если указано, TTL ответа не должен быть больше значения, предоставленного источником.
Значение результата
| bool | true, если ответ должен быть перепроверен кэшем, иначе false |
DateTime getDate()
Возвращает заголовок Date как экземпляр DateTime.
Значение результата
| DateTime | Экземпляр \DateTime |
Исключения
| RuntimeException | При невозможности обработки заголовка |
Response setDate(DateTime $date)
Устанавливает заголовок Date.
Параметры
| DateTime | $date | Экземпляр \DateTime |
Значение результата
| Response |
int getAge()
Возвращает возраст ответа.
Значение результата
| int | Возвращает возраст ответа в секундах |
Response expire()
Помечает ответ как устаревший, установив заголовок Age равным максимальному возрасту ответа.
Значение возврата
| Response |
DateTime|null getExpires()
Возвращает значение заголовка Expires в виде объекта DateTime.
Значение возврата
| DateTime|null | Объект DateTime или null, если заголовок не существует |
Response setExpires(DateTime $date = null)
Устанавливает HTTP-заголовок Expires с помощью объекта DateTime.
Передача null в качестве значения удалит заголовок.
Параметры
| DateTime | $date | Объект \DateTime или null для удаления заголовка |
Значение возврата
| Response |
int|null getMaxAge()
Возвращает количество секунд после времени, указанного в заголовке Date ответа, когда ответ больше не должен считаться свежим.
Сначала проверяется директива s-maxage, затем max-age, а затем используется заголовок expires. Возвращает null, когда максимальный возраст установить нельзя.
Значение возврата
| int|null | Количество секунд |
Response setMaxAge(int $value)
Устанавливает количество секунд, после которого ответ больше не должен считаться свежим.
Этот метод устанавливает директиву Cache-Control max-age.
Параметры
| int | $value | Количество секунд |
Значение возврата
| Response |
Response setSharedMaxAge(int $value)
Устанавливает количество секунд, после которого ответ больше не должен считаться свежим для общих кэшей.
Этот метод устанавливает директиву Cache-Control s-maxage.
Параметры
| int | $value | Количество секунд |
Значение возврата
| Response |
int|null getTtl()
Возвращает время жизни ответа в секундах.
Возвращает null, когда информация о свежести отсутствует в ответе.
Если TTL ответа <= 0, ответ может не быть предоставлен из кэша без предварительной проверки с источником.
Значение возврата
| int|null | TTL в секундах |
Response setTtl(int $seconds)
Устанавливает время жизни ответа для общих кэшей.
Этот метод настраивает директиву Cache-Control/s-maxage.
Параметры
| int | $seconds | Количество секунд |
Значение возврата
| Response |
Response setClientTtl(int $seconds)
Устанавливает время жизни ответа для частных/клиентских кэшей.
Этот метод настраивает директиву Cache-Control/max-age.
Параметры
| int | $seconds | Количество секунд |
Значение возврата
| Response |
DateTime|null getLastModified()
Возвращает заголовок Last-Modified в виде объекта DateTime.
Значение возврата
| DateTime|null | Объект DateTime или null, если заголовок не существует |
Исключения
| RuntimeException | При некорректном анализе HTTP-заголовка |
Response setLastModified(DateTime $date = null)
Устанавливает заголовок Last-Modified с помощью объекта DateTime.
Передача null в качестве значения удалит заголовок.
Параметры
| DateTime | $date | Объект \DateTime или null для удаления заголовка |
Значение возврата
| Response |
string|null getEtag()
Возвращает буквальное значение HTTP-заголовка ETag.
Значение возврата
| string|null | HTTP-заголовок ETag или null, если он не существует |
Response setEtag(string|null $etag = null, bool $weak = false)
Устанавливает значение ETag.
Параметры
| string|null | $etag | Уникальный идентификатор ETag или null для удаления заголовка |
| bool | $weak | Использовать ли слабый ETag |
Значение возврата
| Response |
Response setCache(array $options)
Устанавливает заголовки кэширования ответа (валидация и/или срок хранения).
Доступные параметры: etag, last_modified, max_age, s_maxage, private и public.
Параметры
| array | $options | Массив параметров кэширования |
Значение возврата
| Response |
Исключения
| InvalidArgumentException |
Response setNotModified()
Изменяет ответ, чтобы он соответствовал правилам, определённым для кода состояния 304.
Устанавливает статус, удаляет тело и отбрасывает заголовки, которые НЕ ДОЛЖНЫ включаться в ответы 304.
Значение возврата
| Response |
См. также
| http://tools.ietf.org/html/rfc2616#section-10.3.5 |
bool hasVary()
Возвращает true, если ответ содержит заголовок Vary.
Значение возврата
| bool | true, если ответ содержит заголовок Vary, иначе false |
array getVary()
Возвращает массив имён заголовков, указанных в заголовке Vary.
Значение возврата
| array | Массив имён Vary |
Response setVary(string|array $headers, bool $replace = true)
Устанавливает заголовок Vary.
Параметры
| string|array | $headers | |
| bool | $replace | Заменять ли фактическое значение (по умолчанию true) |
Значение возврата
| Response |
bool isNotModified(Request $request)
Определяет, соответствуют ли валидаторы ответа (ETag, Last-Modified) условным значениям, указанным в запросе.
Если ответ не изменён, устанавливает код состояния 304 и удаляет фактическое содержимое, вызвав метод setNotModified().
Параметры
| Request | $request | Объект Request |
Значение возврата
| bool | true, если валидаторы ответа соответствуют запросу, иначе false |
bool isInvalid()
Недействителен ли ответ?
Значение возврата
| bool |
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 | Сбросить или очистить буферы |
JsonResponse setCallback(string|null $callback = null)
Устанавливает обратный вызов JSONP.
Параметры
| string|null | $callback | Обратный вызов JSONP или null для отключения |
Значение возврата
| JsonResponse |
Исключения
| InvalidArgumentException | Если имя обратного вызова недействительно |
JsonResponse setData(mixed $data = array())
Устанавливает данные, которые будут отправлены как JSON.
Параметры
| mixed | $data |
Значение возврата
| JsonResponse |
Исключения
| InvalidArgumentException |
int getEncodingOptions()
Возвращает опции, используемые при кодировании данных в JSON.
Значение возврата
| int |
JsonResponse setEncodingOptions(int $encodingOptions)
Устанавливает опции, используемые при кодировании данных в JSON.
Параметры
| int | $encodingOptions |
Значение возврата
| JsonResponse |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/HttpFoundation/JsonResponse.html
