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

Возвращает ответ Response в виде строки HTTP.

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

Значение результата

string

Ответ Response в виде строки HTTP

См. также

prepare()

__clone()

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

$this prepare(Request $request)

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

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

Параметры

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)

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

Параметры

int	$code	Код состояния HTTP
mixed	$text	Текст состояния HTTP Если текст состояния равен null, он будет автоматически заполнен для известных кодов состояния, в противном случае останется пустым.

Значение результата

$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, если ответ включает заголовки, которые могут быть использованы для проверки ответа с сервером-источником с помощью запроса conditional 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, 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	Сбрасывать или очищать буферы

$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