Ответ

__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, «связанном» с этим ответом.

Параметры

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

Этот метод указывает, что ответ не должен быть предоставлен устаревшим кэшем ни при каких обстоятельствах без предварительной проверки с источником. При наличии 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)

Устанавливает заголовок 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()

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

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

string|null

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