Ответ

__construct(mixed $content = '', int $status = 200, array $headers = array())

Конструктор.

Параметры

mixed	$content	Содержание ответа, см. setContent()
int	$status	Код состояния ответа
array	$headers	Массив заголовков ответа

Исключения

InvalidArgumentException

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

static Response create(mixed $content = '', int $status = 200, array $headers = array())

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

Пример:

return Response::create($body, 200)
    ->setSharedMaxAge(300);

Параметры

mixed	$content	Содержание ответа, см. setContent()
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()

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

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

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

Response

Response setPublic()

Помечает ответ как «публичный».

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

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

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)

Устанавливает заголовок Expires HTTP с экземпляром 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

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

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 HTTP как экземпляр DateTime.

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

DateTime|null

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

Исключения

RuntimeException

При необработке HTTP заголовка

Response setLastModified(DateTime $date = null)

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

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

Параметры

DateTime

$date

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

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

Response

string|null getEtag()

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

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

string|null

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