Ответ

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

Ответы, помеченные как «частные» с явным директивой 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()

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

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

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

$this

$this setPublic()

Помечает ответ как «общедоступный».

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

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

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

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