Ответ

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

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

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

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

string

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

См. также

prepare()

__clone()

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

$this prepare(Request $request)

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

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

Параметры

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

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

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

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

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

$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

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

$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, когда информация о свежести отсутствует в ответе.

Если время жизни ответа <= 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, last_modified, max_age, 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

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

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