Класс Response
Класс Cake Response отвечает за управление текстом ответа, кодом состояния и заголовками HTTP-ответа.
По умолчанию контроллеры будут использовать этот класс для отображения своего ответа. Если вы собираетесь использовать пользовательский класс ответа, он должен быть подклассом этого объекта для обеспечения совместимости.
Прямые подклассы
Краткое описание свойств
-
$_bodyprotectedСтрока или вызываемый объект буфера для сообщения ответаstring|callable -
$_cacheDirectivesprotectedarrayСодержит все директивы кэширования, которые будут преобразованы в заголовки при отправке запроса
-
$_charsetprotectedКодировка символов тела ответаstring -
$_contentTypeprotectedstringТип содержимого для отправки. Может быть 'расширением', которое будет преобразовано с помощью массива $_mimetypes, или полным MIME-типом
-
$_cookiesprotectedСодержит куки, которые нужно отправить клиентуarray - Объект файла для чтения файла в качестве ответа
$_fileprotected -
$_fileRangeprotectedДиапазон файла. Используется для запроса диапазонов файлов.array -
$_headersprotectedСписок заголовков буфераarray -
$_mimeTypesprotectedarrayХранит сопоставления ключей типов к MIME-типам для известных MIME-типов.
-
$_protocolprotectedЗаголовок протокола для отправки клиентуstring -
$_statusprotectedКод состояния для отправки клиентуinteger -
$_statusCodesprotectedСодержит HTTP-коды состоянияarray
Краткое описание методов
- __construct() publicКонструктор
- __toString() public
Преобразование в строку. Извлекает тело ответа в виде строки. Не отправляет заголовки. Если тело — вызываемый объект, возвращается пустая строка.
- _clearBuffer() protectedОчищает содержимое верхнего буфера вывода и отбрасывает его
- _fileRange() protectedПрименяет диапазон файла и устанавливает конечный смещение.
- _flushBuffer() protectedОчищает содержимое буфера вывода
- _getUTCDate() protected
Возвращает объект DateTime, инициализированный параметром $time и использующий часовой пояс UTC.
- _isActive() protectedВозвращает true, если соединение всё ещё активно
- _sendContent() protectedОтправляет строку содержимого клиенту.
- _sendFile() protectedЧитает файл и выводит содержимое клиенту.
- _sendHeader() protectedОтправляет заголовок клиенту.
- _setCacheControl() protected
Вспомогательный метод для генерации корректного заголовка Cache-Control из опций, установленных в других методах.
- _setContent() protectedУстанавливает тело ответа в пустой текст, если код состояния равен 204 или 304.
- _setContentType() protected
Форматирует заголовок Content-Type на основе конфигурированного contentType и charset. charset будет установлен в заголовке только в том случае, если тип ответа имеет вид text/*
- _setCookies() protected
Устанавливает куки, добавленные с помощью Cake\Network\Response::cookie(), перед отправкой любого другого вывода клиенту. Куки будут установлены в порядке их добавления.
- body() public
Буферизует сообщение ответа для отправки. Если $content равен null, возвращает текущий буфер.
- cache() publicУстанавливает правильные заголовки для указания клиенту кэшировать ответ.
- charset() public
Устанавливает кодировку ответа. Если $charset равен null, возвращает текущую кодировку.
- checkNotModified() public
Проверяет, не был ли ответ изменён в соответствии с заголовками запроса 'If-None-Match' (Etag) и 'If-Modified-Since' (дата последней модификации). Если ответ не был изменён, он помечается соответствующим образом, чтобы клиент мог об этом узнать.
- compress() public
Устанавливает правильную обработку буферизации вывода для отправки сжатого ответа. Ответы будут сжаты с помощью zlib, если расширение доступно.
- cookie() publicПолучение/установка конфигурации куки
- cors() publicНастройка доступа для источника и методов при кросс-доменных запросах
- disableCache() publicУстанавливает правильные заголовки для указания клиенту не кэшировать ответ
- download() publicУстанавливает правильные заголовки для указания браузеру скачать ответ как файл.
- etag() public
Устанавливает Etag ответа. Etag — сильный индикатор того, что ответ может быть кэширован HTTP-клиентом. Плохой способ генерации Etag — создание хэша из вывода ответа, вместо этого создайте уникальный хэш из уникальных компонентов, которые идентифицируют запрос, таких как время изменения, идентификатор ресурса и всё, что вы считаете уникальным.
- expires() public
Устанавливает заголовок Expires для ответа, приняв время истечения. Если вызван без параметров, вернёт текущее значение Expires.
- file() publicНастройка для отображения или загрузки указанного файла.
- getFile() publicПолучить текущий файл, если он существует.
- getMimeType() publicВозвращает определение типа MIME для псевдонима
- header() public
Буферизует строку заголовка для отправки. Возвращает полный список буферизованных заголовков.
- httpCodes() publicЗапрос и установка допустимых кодов и сообщений HTTP ответа.
- length() public
Устанавливает заголовок Content-Length для ответа. Если вызван без аргументов, возвращает последний установленный Content-Length.
- location() publicДоступ к заголовку расположения.
- mapType() publicПреобразует тип содержимого обратно в псевдоним
- maxAge() public
Устанавливает директиву Cache-Control max-age. max-age — это количество секунд, по истечении которого ответ больше не должен рассматриваться как хороший кандидат для извлечения из кэша клиента. Если вызван без параметров, функция возвращает текущее значение max-age, если оно есть.
- modified() public
Устанавливает заголовок Last-Modified для ответа, приняв время изменения. Если вызван без параметров, вернёт текущее значение Last-Modified.
- mustRevalidate() public
Устанавливает директиву Cache-Control must-revalidate. must-revalidate указывает, что ответ не должен быть предоставлен устаревшим кэшем в любом случае без предварительной перепроверки с источником. Если вызван без параметров, функция возвращает, присутствует ли must-revalidate.
- notModified() public
Устанавливает ответ как «Не изменён», удаляя любое содержимое тела, устанавливая код состояния на «304 Не изменён» и удаляя все конфликтующие заголовки.
- outputCompressed() publicВозвращает, будет ли результирующий вывод сжат PHP
- protocol() public
Устанавливает протокол, который будет использоваться при отправке ответа. По умолчанию HTTP/1.1. Если вызван без аргументов, возвращает текущий настроенный протокол.
- send() public
Отправляет полный ответ клиенту, включая заголовки и тело сообщения. Выведет содержимое в теле ответа.
- sendHeaders() publicОтправляет HTTP-заголовки и куки.
- sharable() public
Устанавливает, может ли ответ кэшироваться промежуточными прокси. Этот метод контролирует директиву
publicилиprivateв заголовке Cache-Control. - sharedMaxAge() public
Устанавливает директиву Cache-Control s-maxage. max-age — это количество секунд, по истечении которого ответ больше не должен рассматриваться как хороший кандидат для извлечения из общего кэша (например, в сервере прокси). Если вызван без параметров, функция возвращает текущее значение max-age, если оно есть.
- statusCode() public
Устанавливает код состояния HTTP для отправки. Если $code равен null, возвращает текущий код.
- stop() public
Останавливает выполнение текущего скрипта. Оборачивает exit(), что упрощает тестирование.
- type() public
Устанавливает тип содержимого ответа. Это может быть расширение файла, которое будет отображаться в типе MIME, или строка, представляющая тип MIME. Если $contentType равен null, возвращается текущий тип содержимого. Если $contentType является ассоциативным массивом, определения типов содержимого будут сохранены/заменены.
- vary() public
Устанавливает заголовок Vary для ответа; если передаётся массив, значения будут объединены в строку, разделённую запятыми. Если параметры не переданы, возвращается массив с текущим значением заголовка Vary.
Подробное описание методов
__construct()source public
__construct( array $options [] )
Конструктор
Параметры
- массив
$optionsнеобязательно [] список параметров для настройки ответа. Возможные значения: - body: текст ответа, который должен быть отправлен клиенту - statusCodes: дополнительные допустимые коды ответов - status: код HTTP-статуса для ответа - type: полное значение MIME-типа или расширение, сопоставленное в этом классе - charset: кодировка символов для тела ответа
__toString()source public
__toString( )
Преобразование в строку. Возвращает тело ответа в виде строки. Заголовки не отправляются. Если тело — вызываемый объект, возвращается пустая строка.
Возвращает
строка_clearBuffer()source protected
_clearBuffer( )
Очищает содержимое буфера вывода и отбрасывает его.
Устарело
3.2.4 Эта функция больше не нужнаВозвращает
логическое значение_fileRange()source protected
_fileRange( Cake\Filesystem\File $file , string $httpRange )
Применение диапазона файла к файлу и установка конечной позиции.
Если запрос диапазона некорректен, в ответе будет использоваться код статуса 416.
Параметры
-
Cake\Filesystem\File$file - Файл, для которого устанавливается диапазон.
- строка
$httpRange - Используемый диапазон.
_flushBuffer()source protected
_flushBuffer( )
Очищает содержимое буфера вывода.
Устарело
3.2.4 Эта функция больше не нужна_getUTCDate()source protected
_getUTCDate( string|integer|DateTime|null $time null )
Возвращает объект DateTime, инициализированный параметром $time и использующий часовой пояс UTC.
Параметры
- строка|целое число|DateTime|null
$timeнеобязательно null - Действительная строка времени или экземпляр \DateTime.
Возвращает
DateTime_isActive()source protected
_isActive( )
Возвращает true, если соединение всё ещё активно.
Возвращает
логическое значение_sendContent()source protected
_sendContent( string|callable $content )
Отправляет строку содержимого клиенту.
Если содержимое — вызываемый объект, он вызывается. Вызываемый объект должен либо возвращать строку, либо напрямую выводить содержимое, не имея значения возврата.
Параметры
- строка|вызываемый объект
$content Строка для отправки в качестве тела ответа или вызываемый объект, возвращающий/выводящий содержимое.
_sendFile()source protected
_sendFile( Cake\Filesystem\File $file , array $range )
Читает файл и выводит содержимое в поток клиенту.
Параметры
-
Cake\Filesystem\File$file - Объект файла
- массив
$range - Диапазон для чтения из файла.
Возвращает
логическое значениеTrue, если весь файл был успешно выведен, или false, если соединение с клиентом было потеряно
_sendHeader()source protected
_sendHeader( string $name , string|null $value null )
Отправляет заголовок клиенту.
Параметры
- строка
$name - название заголовка
- строка|null
$valueнеобязательно null - значение заголовка
_setCacheControl()source protected
_setCacheControl( )
Вспомогательный метод для создания валидного заголовка Cache-Control на основе параметров, заданных в других методах.
_setContent()source protected
_setContent( )
Устанавливает тело ответа в пустую строку, если код статуса равен 204 или 304.
_setContentType()source protected
_setContentType( )
Форматирует заголовок Content-Type на основе настроенного contentType и charset. charset будет установлен в заголовке только в том случае, если тип ответа — text/*.
_setCookies()source protected
_setCookies( )
Устанавливает куки, добавленные с помощью Cake\Network\Response::cookie(), прежде чем любой другой вывод будет отправлен клиенту. Куки будут установлены в порядке их добавления.
body()source public
body( string|callable|null $content null )
Буферизует сообщение ответа для отправки. Если $content равно null, возвращается текущий буфер.
Параметры
- строка|вызываемый объект|null
$contentнеобязательно null - строка или вызываемый объект, сообщение для отправки
Возвращает
строкаТекущий буфер сообщений, если параметр $content передан как null
cache()source public
cache( string $since , string $time '+1 day' )
Устанавливает правильные заголовки для инструктирования клиента о кэшировании ответа.
Параметры
- строка
$since - действительное время с момента последней модификации текста ответа
- строка
$timeнеобязательно '+1 day' - действительное время истечения срока действия кэша
charset()source public
charset( string|null $charset null )
Устанавливает кодировку символов ответа; если $charset равно null, возвращается текущая кодировка.
Параметры
- строка|null
$charsetнеобязательно null - строка кодировки символов.
Возвращает
строкаТекущая кодировка
checkNotModified()source public
checkNotModified( Cake\Network\Request $request )
Проверяет, не был ли ответ изменён в соответствии с заголовками запроса 'If-None-Match' (Etag) и 'If-Modified-Since' (дата последней модификации). Если обнаруживается, что ответ не изменён, он помечается соответствующим образом, чтобы клиент мог быть проинформирован об этом.
Чтобы отметить ответ как не изменённый, необходимо установить по крайней мере заголовок ответа Last-Modified etag перед вызовом этого метода. Иначе сравнение не будет возможно.
Параметры
-
Cake\Network\Request$request - объект запроса
Возвращает
логическое значениеПомечен ли ответ как не изменённый или нет.
compress()source public
compress( )
Устанавливает обработчик буферизации вывода для отправки сжатого ответа. Ответы будут сжаты с помощью zlib, если расширение доступно.
Возвращает
логическое значениеfalse, если клиент не принимает сжатые ответы или обработчик недоступен, true в противном случае
cookie()source public
cookie( array|null $options null )
Получение/установка настроек cookie
Этот метод работает как setter/getter, в зависимости от типа аргумента. Если метод вызывается без аргументов, он возвращает все конфигурации.
Если метод вызывается со строковым аргументом, он возвращает заданную конфигурацию, если она установлена, или null, если она не установлена.
Если метод вызывается с массивом в качестве аргумента, он установит конфигурацию cookie в контейнер cookie.
### Параметры (при установке конфигурации) - имя: Имя cookie - значение: Значение cookie - срок действия: Время истечения срока действия cookie - путь: Путь, к которому относится cookie - домен: Домен, к которому относится cookie. - безопасный: Является ли cookie https? - httpOnly: Доступен ли cookie в клиенте?
Примеры
Получение всех cookie
$this->cookie()
Получение определенной конфигурации cookie
$this->cookie('MyCookie')
Установка конфигурации cookie
$this->cookie((array) $options)
Параметры
- массив|null
$optionsнеобязательно null Либо null для получения всех cookie, строка для определенного cookie или массив для установки cookie.
Возвращает
смешанныйcors()source public
cors( Cake\Network\Request $request , string|array $allowedDomains [] , string|array $allowedMethods [] , string|array $allowedHeaders [] )
Настройка доступа по origin и методам при кросс-доменных запросах
Этот метод позволяет несколькими способами настроить домены, см. примеры
Полный URI
cors($request, 'http://www.cakephp.org');
URI с подстановкой
cors($request, 'http://*.cakephp.org');
Игнорирование запрошенного протокола
cors($request, 'www.cakephp.org');
Любой URI
cors($request, '*');
Белый список URI
cors($request, ['http://www.cakephp.org', '*.google.com', 'https://myproject.github.io']);
Примечание Параметры $allowedDomains, $allowedMethods, $allowedHeaders устарели. Вместо этого следует использовать объект-билдер.
Параметры
-
Cake\Network\Request$request - Объект запроса
- строка|массив
$allowedDomainsнеобязательно [] - Список разрешенных доменов, см. описание метода для получения более подробной информации
- строка|массив
$allowedMethodsнеобязательно [] - Список разрешенных HTTP-методов
- строка|массив
$allowedHeadersнеобязательно [] - Список разрешенных HTTP-заголовков
Возвращает
Cake\Network\CorsBuilderОбъект-билдер, предоставляющий удобный интерфейс для определения дополнительных заголовков CORS.
disableCache()source public
disableCache( )
Устанавливает необходимые заголовки, чтобы настроить клиент на отказ от кеширования ответа
download()source public
download( string $filename )
Устанавливает необходимые заголовки, чтобы настроить браузер на скачивание ответа в виде файла.
Параметры
- строка
$filename - Имя файла, как браузер будет скачивать ответ
etag()source public
etag( string|null $hash null , boolean $weak false )
Устанавливает заголовок Etag для ответа. Etag - это сильный индикатор, что ответ может быть кэширован HTTP-клиентом. Плохой способ генерации Etag - создание хеша всего выходного ответа, вместо этого создайте уникальный хеш уникальных компонентов, которые идентифицируют запрос, например, время изменения, идентификатор ресурса и всё, что вы считаете уникальным.
Второй параметр используется для указания клиентам, что содержимое изменилось, но семантически может использоваться также. Представьте себе страницу с счётчиком посещений, два разных просмотра страницы эквивалентны, но различаются несколькими байтами. Это оставляет клиенту решение о том, использовать или нет кэшированную страницу.
Если не переданы параметры, возвращается текущий заголовок Etag.
Параметры
- строка|null
$hashнеобязательно null - Уникальный хеш, который идентифицирует этот ответ
- булево
$weakнеобязательно false Является ли ответ семантически таким же, как и другие с таким же хешем или нет
Возвращает
строка|nullexpires()source public
expires( string|DateTime|null $time null )
Устанавливает заголовок Expires для ответа, принимая время истечения срока действия. Если вызывается без параметров, возвращает текущее значение Expires.
Примеры:
$response->expires('now') Приведёт к немедленному истечению кэша ответа $response->expires(new DateTime('+1 day')) Установит срок действия через 24 часа $response->expires() Вернёт текущее значение заголовка истечения срока действия
Параметры
- строка|DateTime|null
$timeнеобязательно null - Действительная строка времени или экземпляр \DateTime.
Возвращает
строка|nullfile()source public
file( string $path , array $options [] )
Настройка отображения или загрузки указанного файла.
Если $_SERVER['HTTP_RANGE'] установлено, будет возвращена часть файла вместо всего файла.
Ключи опций
- имя: альтернативное имя файла для загрузки
- загрузка: Если
trueустанавливает заголовок загрузки и принуждает загрузку файла вместо отображения в браузере
Параметры
- строка
$path Путь к файлу. Если путь не абсолютный и не разрешается в файл,
APPбудет добавлен в начало пути.- массив
$optionsнеобязательно [] - Опции, см. выше.
Исключения
Cake\Network\Exception\NotFoundExceptiongetFile()source public
getFile( )
Получение текущего файла, если он существует.
Возвращает
Cake\Filesystem\File|nullИспользуемый файл в ответе или null
getMimeType()source public
getMimeType( string $alias )
Возвращает определение MIME-типа для псевдонима
Например getMimeType('pdf'); // returns 'application/pdf'
Параметры
- строка
$alias - псевдоним типа содержимого для сопоставления
Возвращает
смешанныйСтрока сопоставленного MIME-типа или false, если $alias не сопоставлен
header()source public
header( string|array|null $header null , string|array|null $value null )
Буферизует строку заголовка для отправки. Возвращает полный список буферизованных заголовков
Один заголовок
header('Location', 'http://example.com'); Несколько заголовков
header(['Location' => 'http://example.com', 'X-Extra' => 'My header']);
Строковый заголовок
header('WWW-Authenticate: Negotiate'); Массив строковых заголовков
header(['WWW-Authenticate: Negotiate', 'Content-type: application/pdf']);
Несколько вызовов для установки одного и того же имени заголовка будут иметь тот же эффект, что и установка заголовка один раз с последним отправленным значением.
header('WWW-Authenticate: Negotiate');
header('WWW-Authenticate: Not-Negotiate'); будет иметь тот же эффект, что и только
header('WWW-Authenticate: Not-Negotiate'); Параметры
- строка|массив|null
$headerнеобязательно null Массив строк заголовка или одна строка заголовка - ассоциативный массив "имя заголовка" => "значение заголовка" также принимается - массив строк заголовков также принимается
- строка|массив|null
$valueнеобязательно null - Значение заголовка(ов)
Возвращает
массивСписок заголовков для отправки
httpCodes()source public
httpCodes( integer|array|null $code null )
Запрашивает и устанавливает допустимые HTTP-коды ответа и сообщения.
Параметры
- целое число|массив|null
$codeнеобязательно null -
Если $code - целое число, то соответствующий код/сообщение возвращается, если существует, null, если не существует. Если $code - массив, то ключи используются в качестве кодов, а значения - в качестве сообщений для добавления к стандартным HTTP-кодам. Коды должны быть целыми числами больше 99 и меньше 1000. Имейте в виду, что спецификация HTTP определяет, что коды состояния начинаются с цифры от 1 до 5, что определяет класс ответа, который клиент должен ожидать. Пример:
httpCodes(404); // returns [404 => 'Not Found'] httpCodes([ 381 => 'Unicorn Moved', 555 => 'Unexpected Minotaur' ]); // sets these new values, and returns true httpCodes([ 0 => 'Nothing Here', -1 => 'Reverse Infinity', 12345 => 'Universal Password', 'Hello' => 'World' ]); // throws an exception due to invalid codes For more on HTTP status codes see: http://www.w3.org/Protocols/rfc2616/rfc2616-sec6.html#sec6.1
Возвращает
смешанныйАссоциативный массив HTTP-кодов в качестве ключей и строк сообщений в качестве значений или null, если заданный $code не существует.
Исключения
InvalidArgumentExceptionЕсли есть попытка добавить недопустимый код состояния
length()source public
length( integer|null $bytes null )
Устанавливает заголовок Content-Length для ответа. Если вызывается без аргументов, возвращает последний установленный Content-Length.
Параметры
- integer|null
$bytesнеобязательно null - Количество байтов
Возвращает
integer|nulllocation()source public
location( null|string $url null )
Доступ к заголовку location.
Получение/Установка значения заголовка Location.
Параметры
- null|string
$urlнеобязательно null - Либо null для получения текущего значения, либо строка для установки нового.
Возвращает
string|nullПри установке значения возвращается null. При чтении значения возвращается строка текущего значения заголовка Location (если оно есть).
mapType()source public
mapType( string|array $ctype )
Сопоставляет тип содержимого с псевдонимом
Например: mapType('application/pdf'); // returns 'pdf'
Параметры
- string|array
$ctype - Строковый тип содержимого для сопоставления или массив типов.
Возвращает
string|array|nullПсевдонимы для предоставленных типов.
maxAge()source public
maxAge( integer|null $seconds null )
Устанавливает директиву Cache-Control max-age. max-age — количество секунд, после которого ответ больше не должен рассматриваться как хороший кандидат для получения из кэша клиента. Если вызывается без параметров, функция возвращает текущее значение max-age, если оно есть.
Параметры
- integer|null
$secondsнеобязательно null - если null, метод вернёт текущее значение max-age
Возвращает
integer|nullmodified()source public
modified( string|DateTime|null $time null )
Устанавливает заголовок Last-Modified для ответа, используя время изменения. Если вызывается без параметров, возвращает текущее значение Last-Modified.
Примеры:
$response->modified('now') Установит Last-Modified на текущее время $response->modified(new DateTime('+1 day')) Установит дату изменения в прошлом за 24 часа $response->modified() Вернёт текущее значение заголовка Last-Modified
Параметры
- string|DateTime|null
$timeнеобязательно null - Действительная строка времени или экземпляр DateTime.
Возвращает
string|nullmustRevalidate()source public
mustRevalidate( boolean|null $enable null )
Устанавливает директиву Cache-Control must-revalidate. must-revalidate указывает, что ответ не должен быть предоставлен устаревшим кэшем в каких-либо обстоятельствах без предварительной перевалидации с источником. Если вызывается без параметров, функция вернёт, присутствует ли must-revalidate.
Параметры
- boolean|null
$enableнеобязательно null если null, метод вернёт текущее значение must-revalidate. Если булево, установит или сбросит директиву.
Возвращает
booleannotModified()source public
notModified( )
Устанавливает ответ как "Не изменён", удаляя содержимое тела, устанавливая код состояния на "304 Не изменён" и удаляя все конфликтующие заголовки.
outputCompressed()source public
outputCompressed( )
Возвращает, будет ли сжато результирующее выходное значение PHP.
Возвращает
booleanprotocol()source public
protocol( string|null $protocol null )
Устанавливает протокол, который будет использоваться при отправке ответа. По умолчанию HTTP/1.1. Если вызывается без аргументов, возвращает текущий настроенный протокол.
Параметры
- string|null
$protocolнеобязательно null - Протокол, который будет использоваться для отправки ответа.
Возвращает
stringТекущий установленный протокол
send()source public
send( )
Отправляет полный ответ клиенту, включая заголовки и тело сообщения. Выводит содержимое в теле ответа.
sharable()source public
sharable( boolean|null $public null , integer|null $time null )
Устанавливает, может ли ответ быть кэширован промежуточными прокси-серверами. Этот метод управляет директивой public или private в заголовке Cache-Control.
Параметры
- boolean|null
$publicнеобязательно null Если установлено в true, заголовок Cache-Control будет установлен как public. Если установлено в false, ответ будет установлен как private. Если значение не указано, вернёт, является ли ответ разделяемым.
- integer|null
$timeнеобязательно null - время в секундах, после которого ответ больше не должен считаться свежим
Возвращает
boolean|nullsharedMaxAge()source public
sharedMaxAge( integer|null $seconds null )
Устанавливает директиву Cache-Control s-maxage. max-age — количество секунд, после которого ответ больше не должен рассматриваться как хороший кандидат для получения из общего кэша (например, в прокси-сервере). Если вызывается без параметров, функция возвращает текущее значение max-age, если оно есть.
Параметры
- integer|null
$secondsнеобязательно null - если null, метод вернёт текущее значение s-maxage
Возвращает
integer|nullstatusCode()source public
statusCode( integer|null $code null )
Устанавливает HTTP-код состояния. Если $code равен null, возвращает текущий код.
Параметры
- integer|null
$codeнеобязательно null - HTTP-код состояния
Возвращает
integerТекущий код состояния
Исключение
InvalidArgumentExceptionПри достижении неизвестного кода состояния.
stop()source public
stop( integer|string $status 0 )
Останавливает выполнение текущего скрипта. Оборачивает exit(), что упрощает тестирование.
Параметры
- integer|string
$statusнеобязательно 0 - См. http://php.net/exit для значений
type()source public
type( string|null $contentType null )
Устанавливает тип содержимого ответа. Может быть расширением файла, которое будет сопоставлено внутри с типом MIME, или строкой, представляющей тип MIME. Если $contentType равен null, возвращается текущий тип содержимого. Если $contentType — ассоциативный массив, определения типов содержимого будут сохранены/заменены.
Установка типа содержимого
type('jpg'); Возвращение текущего типа содержимого
type();
Сохранение определений типов содержимого
type(['keynote' => 'application/keynote', 'bat' => 'application/bat']);
Замена определения типа содержимого
type(['jpg' => 'text/plain']);
Параметры
- string|null
$contentTypeнеобязательно null - Ключ типа содержимого.
Возвращает
mixedТекущий тип содержимого или false, если предоставлен недопустимый тип содержимого
vary()source public
vary( string|array|null $cacheVariances null )
Устанавливает заголовок Vary для ответа. Если передано массив, значения будут объединены в строку, разделенную запятыми. Если параметров нет, возвращается массив с текущим значением заголовка Vary.
Параметры
- string|array|null
$cacheVariancesoptional null Строка Vary или массив, содержащий список вариаций.
Возвращает
array|nullПодробное описание свойств
$_bodysource
protected string|callable
Буферная строка или вызываемый объект для сообщения ответа
null
$_cacheDirectivessource
protected array
Содержит все директивы кеширования, которые будут преобразованы в заголовки при отправке запроса
[]
$_contentTypesource
protected string
Тип содержимого для отправки. Может быть «расширением», которое будет преобразовано с использованием массива $_mimetypes, или полным типом MIME.
'text/html'
$_mimeTypessource
protected array
Содержит сопоставления ключей типа к типам MIME для известных типов MIME.
[
'html' => ['text/html', '*/*'],
'json' => 'application/json',
'xml' => ['application/xml', 'text/xml'],
'xhtml' => ['application/xhtml+xml', 'application/xhtml', 'text/xhtml'],
'webp' => 'image/webp',
'rss' => 'application/rss+xml',
'ai' => 'application/postscript',
'bcpio' => 'application/x-bcpio',
'bin' => 'application/octet-stream',
'ccad' => 'application/clariscad',
'cdf' => 'application/x-netcdf',
'class' => 'application/octet-stream',
'cpio' => 'application/x-cpio',
'cpt' => 'application/mac-compactpro',
'csh' => 'application/x-csh',
'csv' => ['text/csv', 'application/vnd.ms-excel'],
'dcr' => 'application/x-director',
'dir' => 'application/x-director',
'dms' => 'application/octet-stream',
'doc' => 'application/msword',
'docx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
'drw' => 'application/drafting',
'dvi' => 'application/x-dvi',
'dwg' => 'application/acad',
'dxf' => 'application/dxf',
'dxr' => 'application/x-director',
'eot' => 'application/vnd.ms-fontobject',
'eps' => 'application/postscript',
'exe' => 'application/octet-stream',
'ez' => 'application/andrew-inset',
'flv' => 'video/x-flv',
'gtar' => 'application/x-gtar',
'gz' => 'application/x-gzip',
'bz2' => 'application/x-bzip',
'7z' => 'application/x-7z-compressed',
'hdf' => 'application/x-hdf',
'hqx' => 'application/mac-binhex40',
'ico' => 'image/x-icon',
'ips' => 'application/x-ipscript',
'ipx' => 'application/x-ipix',
'js' => 'application/javascript',
'jsonapi' => 'application/vnd.api+json',
'latex' => 'application/x-latex',
'lha' => 'application/octet-stream',
'lsp' => 'application/x-lisp',
'lzh' => 'application/octet-stream',
'man' => 'application/x-troff-man',
'me' => 'application/x-troff-me',
'mif' => 'application/vnd.mif',
'ms' => 'application/x-troff-ms',
'nc' => 'application/x-netcdf',
'oda' => 'application/oda',
'otf' => 'font/otf',
'pdf' => 'application/pdf',
'pgn' => 'application/x-chess-pgn',
'pot' => 'application/vnd.ms-powerpoint',
'pps' => 'application/vnd.ms-powerpoint',
'ppt' => 'application/vnd.ms-powerpoint',
'pptx' => 'application/vnd.openxmlformats-officedocument.presentationml.presentation',
'ppz' => 'application/vnd.ms-powerpoint',
'pre' => 'application/x-freelance',
'prt' => 'application/pro_eng',
'ps' => 'application/postscript',
'roff' => 'application/x-troff',
'scm' => 'application/x-lotusscreencam',
'set' => 'application/set',
'sh' => 'application/x-sh',
'shar' => 'application/x-shar',
'sit' => 'application/x-stuffit',
'skd' => 'application/x-koan',
'skm' => 'application/x-koan',
'skp' => 'application/x-koan',
'skt' => 'application/x-koan',
'smi' => 'application/smil',
'smil' => 'application/smil',
'sol' => 'application/solids',
'spl' => 'application/x-futuresplash',
'src' => 'application/x-wais-source',
'step' => 'application/STEP',
'stl' => 'application/SLA',
'stp' => 'application/STEP',
'sv4cpio' => 'application/x-sv4cpio',
'sv4crc' => 'application/x-sv4crc',
'svg' => 'image/svg+xml',
'svgz' => 'image/svg+xml',
'swf' => 'application/x-shockwave-flash',
't' => 'application/x-troff',
'tar' => 'application/x-tar',
'tcl' => 'application/x-tcl',
'tex' => 'application/x-tex',
'texi' => 'application/x-texinfo',
'texinfo' => 'application/x-texinfo',
'tr' => 'application/x-troff',
'tsp' => 'application/dsptype',
'ttc' => 'font/ttf',
'ttf' => 'font/ttf',
'unv' => 'application/i-deas',
'ustar' => 'application/x-ustar',
'vcd' => 'application/x-cdlink',
'vda' => 'application/vda',
'xlc' => 'application/vnd.ms-excel',
'xll' => 'application/vnd.ms-excel',
'xlm' => 'application/vnd.ms-excel',
'xls' => 'application/vnd.ms-excel',
'xlsx' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
'xlw' => 'application/vnd.ms-excel',
'zip' => 'application/zip',
'aif' => 'audio/x-aiff',
'aifc' => 'audio/x-aiff',
'aiff' => 'audio/x-aiff',
'au' => 'audio/basic',
'kar' => 'audio/midi',
'mid' => 'audio/midi',
'midi' => 'audio/midi',
'mp2' => 'audio/mpeg',
'mp3' => 'audio/mpeg',
'mpga' => 'audio/mpeg',
'ogg' => 'audio/ogg',
'oga' => 'audio/ogg',
'spx' => 'audio/ogg',
'ra' => 'audio/x-realaudio',
'ram' => 'audio/x-pn-realaudio',
'rm' => 'audio/x-pn-realaudio',
'rpm' => 'audio/x-pn-realaudio-plugin',
'snd' => 'audio/basic',
'tsi' => 'audio/TSP-audio',
'wav' => 'audio/x-wav',
'aac' => 'audio/aac',
'asc' => 'text/plain',
'c' => 'text/plain',
'cc' => 'text/plain',
'css' => 'text/css',
'etx' => 'text/x-setext',
'f' => 'text/plain',
'f90' => 'text/plain',
'h' => 'text/plain',
'hh' => 'text/plain',
'htm' => ['text/html', '*/*'],
'ics' => 'text/calendar',
'm' => 'text/plain',
'rtf' => 'text/rtf',
'rtx' => 'text/richtext',
'sgm' => 'text/sgml',
'sgml' => 'text/sgml',
'tsv' => 'text/tab-separated-values',
'tpl' => 'text/template',
'txt' => 'text/plain',
'text' => 'text/plain',
'avi' => 'video/x-msvideo',
'fli' => 'video/x-fli',
'mov' => 'video/quicktime',
'movie' => 'video/x-sgi-movie',
'mpe' => 'video/mpeg',
'mpeg' => 'video/mpeg',
'mpg' => 'video/mpeg',
'qt' => 'video/quicktime',
'viv' => 'video/vnd.vivo',
'vivo' => 'video/vnd.vivo',
'ogv' => 'video/ogg',
'webm' => 'video/webm',
'mp4' => 'video/mp4',
'm4v' => 'video/mp4',
'f4v' => 'video/mp4',
'f4p' => 'video/mp4',
'm4a' => 'audio/mp4',
'f4a' => 'audio/mp4',
'f4b' => 'audio/mp4',
'gif' => 'image/gif',
'ief' => 'image/ief',
'jpg' => 'image/jpeg',
'jpeg' => 'image/jpeg',
'jpe' => 'image/jpeg',
'pbm' => 'image/x-portable-bitmap',
'pgm' => 'image/x-portable-graymap',
'png' => 'image/png',
'pnm' => 'image/x-portable-anymap',
'ppm' => 'image/x-portable-pixmap',
'ras' => 'image/cmu-raster',
'rgb' => 'image/x-rgb',
'tif' => 'image/tiff',
'tiff' => 'image/tiff',
'xbm' => 'image/x-xbitmap',
'xpm' => 'image/x-xpixmap',
'xwd' => 'image/x-xwindowdump',
'ice' => 'x-conference/x-cooltalk',
'iges' => 'model/iges',
'igs' => 'model/iges',
'mesh' => 'model/mesh',
'msh' => 'model/mesh',
'silo' => 'model/mesh',
'vrml' => 'model/vrml',
'wrl' => 'model/vrml',
'mime' => 'www/mime',
'pdb' => 'chemical/x-pdb',
'xyz' => 'chemical/x-pdb',
'javascript' => 'application/javascript',
'form' => 'application/x-www-form-urlencoded',
'file' => 'multipart/form-data',
'xhtml-mobile' => 'application/vnd.wap.xhtml+xml',
'atom' => 'application/atom+xml',
'amf' => 'application/x-amf',
'wap' => ['text/vnd.wap.wml', 'text/vnd.wap.wmlscript', 'image/vnd.wap.wbmp'],
'wml' => 'text/vnd.wap.wml',
'wmlscript' => 'text/vnd.wap.wmlscript',
'wbmp' => 'image/vnd.wap.wbmp',
'woff' => 'application/x-font-woff',
'appcache' => 'text/cache-manifest',
'manifest' => 'text/cache-manifest',
'htc' => 'text/x-component',
'rdf' => 'application/xml',
'crx' => 'application/x-chrome-extension',
'oex' => 'application/x-opera-extension',
'xpi' => 'application/x-xpinstall',
'safariextz' => 'application/octet-stream',
'webapp' => 'application/x-web-app-manifest+json',
'vcf' => 'text/x-vcard',
'vtt' => 'text/vtt',
'mkv' => 'video/x-matroska',
'pkpass' => 'application/vnd.apple.pkpass',
'ajax' => 'text/html'
] $_statusCodessource
protected array
Содержит HTTP коды состояния
[
100 => 'Continue',
101 => 'Switching Protocols',
200 => 'OK',
201 => 'Created',
202 => 'Accepted',
203 => 'Non-Authoritative Information',
204 => 'No Content',
205 => 'Reset Content',
206 => 'Partial Content',
300 => 'Multiple Choices',
301 => 'Moved Permanently',
302 => 'Found',
303 => 'See Other',
304 => 'Not Modified',
305 => 'Use Proxy',
307 => 'Temporary Redirect',
400 => 'Bad Request',
401 => 'Unauthorized',
402 => 'Payment Required',
403 => 'Forbidden',
404 => 'Not Found',
405 => 'Method Not Allowed',
406 => 'Not Acceptable',
407 => 'Proxy Authentication Required',
408 => 'Request Time-out',
409 => 'Conflict',
410 => 'Gone',
411 => 'Length Required',
412 => 'Precondition Failed',
413 => 'Request Entity Too Large',
414 => 'Request-URI Too Large',
415 => 'Unsupported Media Type',
416 => 'Requested range not satisfiable',
417 => 'Expectation Failed',
422 => 'Unprocessable Entity',
429 => 'Too Many Requests',
451 => 'Unavailable For Legal Reasons',
500 => 'Internal Server Error',
501 => 'Not Implemented',
502 => 'Bad Gateway',
503 => 'Service Unavailable',
504 => 'Gateway Time-out',
505 => 'Unsupported Version'
]
© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/3.2/class-Cake.Network.Response.html