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

Возвращает ответ Response в виде строки HTTP.

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

Значение, возвращаемое функцией

string

Ответ Response в виде строки HTTP

См. также

prepare()

__clone()

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

$this prepare(Request $request)

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

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

Параметры

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, если ответ подходит для кеширования в любых обстоятельствах.

Ответы, помеченные как «частные» с явным директивой 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()

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

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

Значение, возвращаемое функцией

$this

$this setPublic()

Помечает ответ как «публичный».

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

Значение, возвращаемое функцией

$this

bool mustRevalidate()

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

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

Значение, возвращаемое функцией

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)

Устанавливает HTTP-заголовок Expires с экземпляром 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

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

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

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

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

Параметры

DateTime

$date

Экземпляр \DateTime или null для удаления заголовка

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

$this

string|null getEtag()

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

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

string|null

HTTP-заголовок ETag или 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()

Ответ 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)

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

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

Параметры

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

string getTargetUrl()

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

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

string

Целевой URL

$this setTargetUrl(string $url)

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

Параметры

string

$url

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

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

$this

Исключения

InvalidArgumentException