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

$this prepare(Request $request)

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

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

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

Параметры

int	$code	Код статуса HTTP
mixed	$text	Текст статуса HTTP Если текст статуса равен null, он будет автоматически заполнен для известных кодов статусов и оставлен пустым в противном случае.

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

$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

Объект \DateTime

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

$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

Экземпляр 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)

Очищает или сбрасывает буферы вывода до уровня target.

Результат может быть больше, чем целевой уровень, если был встречен не удаляемый буфер.

Параметры

int	$targetLevel	Уровень буферизации выходных данных
bool	$flush	Выполнить сброс или очистить буферы

string getTargetUrl()

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

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

string

Целевой URL

$this setTargetUrl(string $url)

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

Параметры

string

$url

URL, на который необходимо перенаправить

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

$this

Исключения

InvalidArgumentException