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

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

$this setImmutable(bool $immutable = true)

Помечает ответ как «неизменяемый».

Параметры

bool

$immutable

включает или отключает директиву immutable

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

$this

bool isImmutable()

Возвращает true, если ответ помечен как «неизменяемый».

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

bool	возвращает true, если ответ помечен как «неизменяемый», иначе false

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

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

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

Ответ OK?

Значение, возвращаемое функцией

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