JsonResponse

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

Параметры

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

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, если ответ подходит для кэширования в любом случае.

Ответы, помеченные как «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

$this setPrivate()

Помечает ответ как «private».

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

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

$this

$this setPublic()

Помечает ответ как «public».

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

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

$this

bool mustRevalidate()

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

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

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

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

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

$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

Заголовок ETag HTTP или 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, last_modified, max_age, 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	Сбрасывать или очищать буферы

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

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

Параметры

string|null

$callback

Обратный вызов JSONP или null для отсутствия

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

$this

Исключения

InvalidArgumentException

Когда имя обратного вызова недействительно

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

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

Параметры

mixed

$data

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

$this

Исключения

InvalidArgumentException

int getEncodingOptions()

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

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

int

$this setEncodingOptions(int $encodingOptions)

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

Параметры

int

$encodingOptions

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

$this