RedirectResponse

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

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

Параметры

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

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

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

bool	true, если ответ проверяем, иначе false

$this setPrivate()

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

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

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

$this

$this setPublic()

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

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

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

$this

$this setImmutable(bool $immutable = true)

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

Параметры

bool

$immutable

Включает или выключает директиву immutable

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

$this

bool isImmutable()

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

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

bool	возвращает true, если ответ помечен как «immutable», иначе 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)

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

Время жизни в секундах

$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

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

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

string getTargetUrl()

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

Результат

string

целевой URL

$this setTargetUrl(string $url)

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

Параметры

string

$url

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

Результат

$this

Исключения

InvalidArgumentException