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(string $url = '', int $status = 302, array $headers = array())

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

Параметры

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

Значение, возвращаемое методом

Response

string __toString()

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

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

Значение, возвращаемое методом

string

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

См. также

prepare()

__clone()

Клонирует текущую инстанцию Response.

$this prepare(Request $request)

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

Этот метод корректирует Response, чтобы гарантировать соответствие 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

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

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

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

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