RedirectResponse

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

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

Параметры

string|null	$url	URL для перенаправления. URL должен быть полным URL, включая схему и т.д., но на практике большинство браузеров перенаправляются и по только путям
int	$status
array	$headers

Исключения

InvalidArgumentException

См. также

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

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

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

Параметры

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

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

Response

string __toString()

Возвращает ответ как строку HTTP.

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

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

string

Ответ как строка HTTP

См. также

prepare()

__clone()

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

$this prepare(Request $request)

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

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

Параметры

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

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

$this

string getProtocolVersion()

Получает версию HTTP-протокола.

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

string

$this setStatusCode(int $code, $text = null)

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

Если текст статуса равен null, он будет автоматически заполнен для известных кодов статуса, в противном случае останется пустым.

Параметры

int	$code
	$text

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

$this

Исключения

InvalidArgumentException

При недопустимом коде HTTP-статуса

int getStatusCode()

Получает код статуса текущего веб-ответа.

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

int

$this setCharset(string $charset)

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

Параметры

string

$charset

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

$this

string|null getCharset()

Получает кодировку ответа.

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

string|null

bool isCacheable()

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

Ответы, помеченные как «частные» с явным директивой Cache-Control, считаются некэшируемыми.

Ответы без срока действия кэширования (Expires, max-age) или валидатора кэша (Last-Modified, ETag) считаются некэшируемыми, так как нет способа определить, когда или как их удалить из кэша.

Обратите внимание, что RFC 7231 и RFC 7234, возможно, допускают более либеральную реализацию, например, «коды статуса, которые по умолчанию определены как кэшируемые [...] могут быть повторно использованы кэшем с эвристическим сроком действия, если не указано иное» (https://tools.ietf.org/html/rfc7231#section-6.1)

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

bool

bool isFresh()

Возвращает true, если ответ «свежий».

Свежие ответы могут быть возвращены из кэша без взаимодействия с источником. Ответ считается свежим, если он содержит индикатор Cache-Control/max-age или заголовок Expires, и вычисленный возраст меньше срока действия свежести.

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

bool

bool isValidateable()

Возвращает true, если ответ содержит заголовки, которые могут быть использованы для проверки ответа с сервером-источником с помощью условного запроса GET.

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

bool

$this setPrivate()

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

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

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

$this

$this setPublic()

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

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

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

$this

$this setImmutable(bool $immutable = true)

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

Параметры

bool

$immutable

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

$this

bool isImmutable()

Возвращает true, если ответ помечен как «неизменяемый».

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

bool

bool mustRevalidate()

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

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

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

bool

DateTimeInterface|null getDate()

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

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

DateTimeInterface|null

Исключения

RuntimeException

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

$this setDate(DateTimeInterface $date)

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

Параметры

DateTimeInterface

$date

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

$this

int getAge()

Возвращает возраст ответа в секундах.

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

int

$this expire()

Помечает ответ как устаревший, установив заголовок Age равным максимальному возрасту ответа.

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

$this

DateTimeInterface|null getExpires()

Возвращает значение заголовка Expires в виде экземпляра DateTime.

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

DateTimeInterface|null

$this setExpires(DateTimeInterface $date = null)

Устанавливает заголовок HTTP Expires с экземпляром DateTime.

Передача null в качестве значения удалит заголовок.

Параметры

DateTimeInterface

$date

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

$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

$this setTtl(int $seconds)

Устанавливает время жизни ответа для общих кэшей в секундах.

Этот метод корректирует директиву Cache-Control/s-maxage.

Параметры

int

$seconds

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

$this

$this setClientTtl(int $seconds)

Устанавливает время жизни ответа для частных/клиентских кэшей в секундах.

Этот метод корректирует директиву Cache-Control/max-age.

Параметры

int

$seconds

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

$this

DateTimeInterface|null getLastModified()

Возвращает заголовок Last-Modified HTTP в виде экземпляра DateTime.

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

DateTimeInterface|null

Исключения

RuntimeException

Когда заголовок HTTP не может быть распарсен

$this setLastModified(DateTimeInterface $date = null)

Устанавливает заголовок HTTP Last-Modified с экземпляром DateTime.

Передача null в качестве значения удалит заголовок.

Параметры

DateTimeInterface

$date

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

$this

string|null getEtag()

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

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

string|null

$this setEtag(string $etag = null, bool $weak = false)

Устанавливает значение ETag.

Параметры

string	$etag	Уникальный идентификатор ETag или null для удаления заголовка
bool	$weak	Использовать слабый ETag или нет

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

$this

$this setCache(array $options)

Устанавливает заголовки кэша ответа (проверка и/или срок действия).

Доступные параметры: etag, last_modified, max_age, s_maxage, private, public и immutable.

Параметры

array

$options

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

$this

Исключения

InvalidArgumentException

$this setNotModified()

Изменяет ответ так, чтобы он соответствовал правилам, определенным для кода состояния 304.

Это устанавливает состояние, удаляет тело и отбрасывает заголовки, которые НЕ ДОЛЖНЫ включаться в ответы 304.

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

$this

См. также

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

bool hasVary()

Возвращает true, если ответ включает заголовок Vary.

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

bool

array getVary()

Возвращает массив имён заголовков, заданных в заголовке Vary.

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

array

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

Успешен ли ответ?

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

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

protected ensureIEOverSSLCompatibility(Request $request)

Проверяет, нужно ли удалить Cache-Control для SSL-шифрованных загрузок при использовании IE < 9.

Параметры

Request

$request

См. также

http://support.microsoft.com/kb/323308

string getTargetUrl()

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

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

string

целевой URL

$this setTargetUrl(string $url)

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

Параметры

string

$url

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

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

$this

Исключения

InvalidArgumentException