Ответ

__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.

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

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

Параметры

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

Возвращаемое значение

bool	true, если ответ подходит для проверки, иначе false

$this setPrivate()

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

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

Возвращаемое значение

$this

$this setPublic()

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

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

Возвращаемое значение

$this

bool mustRevalidate()

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

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

Возвращаемое значение

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)

Устанавливает заголовок HTTP Expires с экземпляром 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	Сбрасывать или очищать буферы