RedirectResponse

__construct(string $url, int $status = 302, array $headers = array())

Создаёт ответ перенаправления, соответствующий правилам статусных кодов перенаправления.

Параметры

string	$url	URL для перенаправления
int	$status	Код статуса ответа
array	$headers	Массив заголовков ответа

Исключения

InvalidArgumentException

См. также

http://tools.ietf.org/html/rfc2616#section-10.3

static Response create($url = '', int $status = 302, array $headers = array())

Метод-фабрика для цепочечного вызова.

Пример:

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

Параметры

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

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

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

Значение результата

Response

Response setPublic()

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

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

Значение результата

Response

bool mustRevalidate()

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

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

Значение результата

bool	true, если ответ необходимо перепроверить в кэше, иначе false

DateTime getDate()

Возвращает заголовок Date как экземпляр DateTime.

Значение результата

DateTime

Экземпляр \DateTime

Исключения

RuntimeException

Если заголовок не может быть проанализирован

Response setDate(DateTime $date)

Устанавливает заголовок Date.

Параметры

DateTime

$date

A \DateTime instance

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

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

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

string getTargetUrl()

Возвращает целевой URL.

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

string

целевой URL

RedirectResponse setTargetUrl(string $url)

Устанавливает целевой адрес перенаправления для этого ответа.

Параметры

string

$url

URL для перенаправления

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

RedirectResponse

Текущий ответ.

Исключения

InvalidArgumentException