Spec-Zone.ru › CakePHP 3.8

Класс Response

Ответ содержит текст ответа, код состояния и заголовки HTTP-ответа.

Cake\Http\Response реализует Psr\Http\Message\ResponseInterface использует Zend\Diactoros\MessageTrait

Прямые подклассы

  • Cake\TestSuite\Stub\Response
Пространство имён: Cake\Http
Расположение: Http/Response.php

Краткое описание свойств

  • $_cacheDirectives protected
    array

    Содержит все директивы кеширования, которые будут преобразованы в заголовки при отправке запроса

  • $_charset protected
    string
    Кодировка символов тела ответа
  • $_contentType protected
    string

    Тип контента для отправки. Может быть расширением, которое будет преобразовано с использованием массива $_mimetypes, или полным типом MIME

  • $_cookies protected
    Cake\Http\Cookie\CookieCollection
    Коллекция куки для отправки клиенту
  • $_file protected
    Cake\Filesystem\File|null
    Объект файла для чтения файла в качестве ответа
  • $_fileRange protected
    array
    Диапазон файла. Используется для запроса диапазонов файлов.
  • $_mimeTypes protected
    array
    Содержит соответствия типов ключей типа MIME для известных типов MIME.
  • $_protocol protected
    string
    Заголовок протокола для отправки клиенту
  • $_reasonPhrase protected
    string
    Фраза причины
  • $_status protected
    integer
    Код состояния для отправки клиенту
  • $_statusCodes protected
    array
    Содержит HTTP-коды состояний
  • $_streamMode protected
    string
    Параметры режима потока.
  • $_streamTarget protected
    string|resource
    Целевая точка или объект ресурса потока.

Краткое описание методов

  • __construct() public
    Конструктор
  • __debugInfo() public

    Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.

  • __toString() public

    Преобразование в строку. Получает тело ответа в виде строки. Не отправляет заголовки. Если тело является вызываемым объектом, возвращается пустая строка.

  • _clearBuffer() protected deprecated
    Очищает содержимое верхнего буфера вывода и отбрасывает его
  • _clearHeader() protected
    Очистить заголовок
  • _createStream() protected
    Создаёт объект потока.
  • _fileRange() protected deprecated
    Применяет диапазон файла к файлу и устанавливает конечный смещение.
  • _flushBuffer() protected deprecated
    Очищает содержимое буфера вывода
  • _getUTCDate() protected

    Возвращает объект DateTime, инициализированный в параметре $time и использующий UTC в качестве часового пояса

  • _handleCallableBody() protected
    Обрабатывает вызываемое тело по соображениям обратной совместимости.
  • _isActive() protected deprecated
    Возвращает true, если соединение всё ещё активно
  • _sendContent() protected deprecated
    Отправляет строку содержимого клиенту.
  • _sendFile() protected deprecated
    Читает файл и выводит содержимое в клиент.
  • _sendHeader() protected deprecated
    Отправляет заголовок клиенту.
  • _setCacheControl() protected

    Вспомогательный метод для создания корректного заголовка Cache-Control из опций, установленных в других методах

  • _setContent() protected deprecated
    Устанавливает тело ответа в пустой текст, если код состояния 204 или 304
  • _setContentType() protected

    Форматирует заголовок Content-Type на основе настроенного contentType и charset. charset будет установлен в заголовке только если тип ответа text/*

  • _setCookies() protected deprecated

    Устанавливает куки, которые были добавлены через Cake\Http\Response::cookie(), прежде чем любой другой вывод будет отправлен клиенту. Будет устанавливать куки в порядке их установки.

  • _setHeader() protected
    Устанавливает заголовок.
  • _setStatus() protected
    Модификатор для кода состояния ответа
  • body() public deprecated

    Буферизует сообщение ответа для отправки. Если $content равен null, возвращается текущий буфер.

  • cache() public deprecated
    Устанавливает правильные заголовки, чтобы направить клиенту кэш ответа.
  • charset() public deprecated

    Устанавливает кодировку ответа. Если $charset равен null, возвращается текущая кодировка.

  • checkNotModified() public

    Проверяет, не был ли ответ изменён в соответствии с запросами заголовков 'If-None-Match' (Etags) и 'If-Modified-Since' (дата последнего изменения). Если ответ не был изменён, он помечается как таковой, чтобы клиент мог об этом узнать.

  • compress() public

    Устанавливает правильный обработчик буферизации вывода для отправки сжатого ответа. Ответы будут сжаты с помощью zlib, если расширение доступно.

  • convertCookieToArray() protected
    Преобразует куки в массив его свойств.
  • cookie() public deprecated
    Получение/установка параметров куки
  • cors() public
    Настройка доступа для источника и методов при кросс-доменных запросах
  • disableCache() public deprecated
    Устанавливает правильные заголовки, чтобы направить клиенту отказ от кэширования ответа.
  • download() public deprecated
    Устанавливает правильные заголовки, чтобы браузер загрузил ответ как файл.
  • etag() public deprecated

    Устанавливает Etag ответа. Etags являются сильным указанием на то, что клиент HTTP может кэшировать ответ. Плохим способом генерации Etags является создание хеша из выходных данных ответа, вместо этого создайте уникальный хеш уникальных компонентов, которые идентифицируют запрос, такие как время изменения, идентификатор ресурса и всё остальное, что вы считаете уникальным.

  • expires() public deprecated

    Устанавливает заголовок Expires для ответа, используя время истечения срока действия. Если вызывается без параметров, возвращает текущее значение Expires.

  • file() public deprecated
    Настройка отображения или загрузки указанного файла.
  • getCharset() public
    Возвращает текущую кодировку.
  • getCookie() public
    Считывает одну куки из ответа.
  • getCookieCollection() public
    Получает CookieCollection из ответа
  • getCookies() public
    Получает все куки из ответа.
  • getFile() public
    Получает текущий файл, если он существует.
  • getMimeType() public
    Возвращает определение типа MIME для псевдонима.
  • getReasonPhrase() public
    Получает фразу причины ответа, связанную с кодом состояния.
  • getSimpleHeaders() protected
    Вспомогательный метод обратной совместимости для получения уплощенных заголовков.
  • getStatusCode() public
    Получает код состояния ответа.
  • getType() public
    Возвращает текущий тип содержимого.
  • header() public deprecated

    Буферизует строку заголовка для отправки. Возвращает полный список буферизованных заголовков.

  • httpCodes() public deprecated
    Запрос и установка допустимых кодов и сообщений HTTP ответа.
  • length() public deprecated

    Устанавливает заголовок Content-Length для ответа. Если вызывается без аргументов, возвращает последний установленный Content-Length.

  • location() public deprecated
    Доступ к заголовку местоположения.
  • mapType() public
    Сопоставляет тип содержимого с псевдонимом
  • maxAge() public deprecated

    Устанавливает директиву Cache-Control max-age. max-age — это количество секунд, после которого ответ больше не должен рассматриваться как хороший кандидат для извлечения из кэша на стороне клиента. Если вызывается без параметров, эта функция вернёт текущее значение max-age, если оно есть.

  • modified() public deprecated

    Устанавливает заголовок Last-Modified для ответа, принимая время модификации. Если вызывается без параметров, возвращает текущее значение Last-Modified.

  • mustRevalidate() public deprecated

    Устанавливает директиву Cache-Control must-revalidate. must-revalidate указывает, что ответ не должен быть предоставлен кэшем устаревшим ни при каких обстоятельствах без предварительной перепроверки с источником. Если вызывается без параметров, функция возвращает, присутствует ли must-revalidate.

  • notModified() public

    Устанавливает ответ как «Не модифицирован», удаляя содержимое тела, устанавливая код состояния на «304 Not Modified» и удаляя все конфликтующие заголовки.

  • outputCompressed() public
    Возвращает, будет ли сжатие результата вывода PHP.
  • protocol() public deprecated

    Устанавливает используемый протокол при отправке ответа. По умолчанию HTTP/1.1. Если вызывается без аргументов, возвращает текущий настроенный протокол.

  • resolveType() protected
    Перевод и проверка типов содержимого.
  • send() public deprecated

    Отправляет полный ответ клиенту, включая заголовки и тело сообщения. Выводит содержимое в теле ответа.

  • sendHeaders() public deprecated
    Отправляет HTTP-заголовки и куки.
  • setTypeMap() public
    Устанавливает определение типа содержимого в карту.
  • sharable() public

    Устанавливает, может ли ответ кэшироваться промежуточными прокси. Этот метод управляет директивой public или private в заголовке Cache-Control.

  • sharedMaxAge() public deprecated
    Устанавливает директиву Cache-Control s-maxage.
  • statusCode() public deprecated

    Устанавливает HTTP-код состояния для отправки. Если $code равен null, возвращается текущий код.

  • stop() public deprecated

    Останавливает выполнение текущего сценария. Оборачивает exit(), что упрощает тестирование.

  • type() public deprecated

    Устанавливает тип содержимого ответа. Может быть расширением файла, которое будет сопоставлено внутри с типом MIME, или строкой, представляющей тип MIME. Если $contentType равен null, возвращается текущий тип содержимого. Если $contentType является ассоциативным массивом, определения типов содержимого будут сохранены/заменены.

  • validateFile() protected
    Проверка, является ли путь к файлу допустимым телом ответа.
  • vary() public deprecated

    Устанавливает заголовок Vary для ответа. Если передан массив, значения будут объединены в строку, разделенную запятыми. Если параметры не переданы, возвращается массив с текущим значением заголовка Vary.

  • withAddedLink() public
    Создаёт новый ответ с установленным заголовком Link.
  • withCache() public
    Создаёт новый экземпляр с заголовками для включения кэширования клиентом.
  • withCharset() public
    Получить новый экземпляр с обновлённым кодированием символов.
  • withCookie() public
    Создаёт новый ответ с установленным куки.
  • withCookieCollection() public
    Получить новый экземпляр с предоставленной коллекцией куки.
  • withDisabledCache() public
    Создаёт новый экземпляр с заголовками, которые указывают клиенту не кэшировать ответ.
  • withDownload() public
    Создаёт новый экземпляр с установленным заголовком Content-Disposition.
  • withEtag() public
    Создаёт новый экземпляр с установленным заголовком Etag.
  • withExpiredCookie() public
    Создаёт новый ответ с установленным просроченным куки.
  • withExpires() public
    Создаёт новый экземпляр с установленным заголовком Expires.
  • withFile() public
    Создаёт новый экземпляр, основанный на файле.
  • withLength() public
    Создаёт новый ответ с установленным заголовком Content-Length.
  • withLocation() public
    Возвращает экземпляр с обновлённым заголовком расположения.
  • withMaxAge() public
    Создаёт экземпляр с установленной директивой Cache-Control max-age.
  • withModified() public
    Создаёт новый экземпляр с установленным заголовком Last-Modified.
  • withMustRevalidate() public
    Создаёт экземпляр с установленной директивой Cache-Control must-revalidate.
  • withNotModified() public
    Создаёт новый экземпляр как «не модифицированный».
  • withSharable() public
    Создаёт новый экземпляр с установленной директивой Cache-Control public/private.
  • withSharedMaxAge() public
    Создаёт новый экземпляр с установленной директивой Cache-Control s-maxage.
  • withStatus() public
    Возвращает экземпляр с указанным кодом состояния и, необязательно, фразой причины.
  • withStringBody() public
    Удобный метод для установки строки в тело ответа.
  • withType() public
    Получение обновлённого ответа с установленным типом содержимого.
  • withVary() public
    Создаёт новый экземпляр с установленным заголовком Vary.

Подробное описание методов

__construct()source public

__construct( array $options = [] )

Конструктор

Параметры

массив $options необязательный []

список параметров для настройки ответа. Возможные значения: - body: текст ответа, который должен быть отправлен клиенту - statusCodes: дополнительные допустимые коды ответа - status: HTTP-код состояния для ответа - type: полная строка типа MIME или расширение, сопоставленное в этом классе - charset: кодировка символов для тела ответа

Исключения

InvalidArgumentException

__debugInfo()source public

__debugInfo( )

Возвращает массив, который может быть использован для описания внутреннего состояния этого объекта.

Возвращает

массив

__toString()source public

__toString( )

Преобразование в строку. Извлекает тело ответа как строку. Не отправляет заголовки. Если body является вызываемым объектом, возвращается пустая строка.

Возвращает

строка

_clearBuffer()source protected deprecated

_clearBuffer( )

Очищает содержимое верхнего выходного буфера и отбрасывает его.

Устарело

3.2.4 Эта функция больше не нужна

Возвращает

логическое значение
END_OF_DOCUMENT_MARKER

_clearHeader()source protected

_clearHeader( string $header )

Очистка заголовка

Параметры

строка $header
Ключ заголовка.

_createStream()source protected

_createStream( )

Создаёт объект потока.

_fileRange()source protected deprecated

_fileRange( Cake\Filesystem\File $file , string $httpRange )

Применение диапазона файла и установка конечного смещения.

Если запрос содержит недопустимый диапазон, в ответе будет использоваться код состояния 416.

Устарело

3.4.0 В долгосрочной перспективе это нужно переработать, чтобы следовать парадигме неизменяемости. Однако пока проще оставить это без изменений.


Параметры

Cake\Filesystem\File $file
Файл, для которого устанавливается диапазон.
строка $httpRange
Диапазон для использования.

_flushBuffer()source protected deprecated

_flushBuffer( )

Очищает содержимое буфера вывода

Устарело

3.2.4 Эта функция больше не требуется

_getUTCDate()source protected

_getUTCDate( string|integer|DateTimeInterface|null $time = null )

Возвращает объект DateTime, инициализированный в параметре $time и использующий часовой пояс UTC

Параметры

строка|целое число|DateTimeInterface|null $time необязательно null
Действительная строка времени или экземпляр DateTimeInterface.

Возвращает

DateTimeInterface

_handleCallableBody()source protected

_handleCallableBody( callable $content )

Обрабатывает вызываемый тело для обратной совместимости.

Параметры

вызываемый $content
Вызываемый контент.

Возвращает

строка

_isActive()source protected deprecated

_isActive( )

Возвращает true, если соединение всё ещё активно

Устарело

3.4.0 Будет удалено в 4.0.0

Возвращает

логическое значение

_sendContent()source protected deprecated

_sendContent( string|callable $content )

Отправляет строку контента клиенту.

Если контент является вызываемым, он вызывается. Вызываемый должен либо вернуть строку, либо вывести контент непосредственно и не иметь значения возврата.

Устарело

3.4.0 Будет удалено в 4.0.0

Параметры

строка|вызываемый $content

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

_sendFile()source protected deprecated

_sendFile( Cake\Filesystem\File $file , array $range )

Читает файл и выводит содержимое клиенту.

Устарело

3.4.0 Будет удалено в 4.0.0

Параметры

Cake\Filesystem\File $file
Объект файла
массив $range
Диапазон для чтения из файла.

Возвращает

логическое значение
True, если весь файл успешно отправлен, или false, если соединение с клиентом было потеряно в процессе

_sendHeader()source protected deprecated

_sendHeader( string $name , string|null $value = null )

Отправляет заголовок клиенту.

Устарело

3.4.0 Будет удалено в 4.0.0

Параметры

строка $name
название заголовка
строка|null $value необязательно null
значение заголовка

_setCacheControl()source protected

_setCacheControl( )

Вспомогательный метод для генерации валидного заголовка Cache-Control из опций, установленных в других методах

_setContent()source protected deprecated

_setContent( )

Устанавливает тело ответа на пустую строку, если код состояния равен 204 или 304

Устарело

3.4.0 Будет удалено в 4.0.0

_setContentType()source protected

_setContentType( )

Форматирует заголовок Content-Type на основе настроенного contentType и charset. Кодировка будет установлена только в заголовке, если тип ответа равен text/*

_setCookies()source protected deprecated

_setCookies( )

Устанавливает cookie, добавленные через Cake\Http\Response::cookie() перед отправкой любого другого вывода клиенту. Будет устанавливать cookie в порядке их добавления.

Устарело

3.4.0 Будет удалено в 4.0.0

_setHeader()source protected

_setHeader( string $header , string $value )

Устанавливает заголовок.

Параметры

строка $header
Ключ заголовка.
строка $value
Значение заголовка.

_setStatus()source protected

_setStatus( integer $code , string $reasonPhrase = '' )

Изменение состояния ответа

Параметры

целое число $code
Код для установки.
строка $reasonPhrase необязательно ''
Фраза причины ответа.

Исключения

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

body()source public deprecated

body( string|callable|null $content = null )

Буферирует сообщение ответа для отправки. Если $content равен null, возвращается текущий буфер.

Устарело

3.4.0 Изменяемые методы ответа устарели. Используйте withBody()/withStringBody() и getBody() вместо этого.

Параметры

строка|вызываемый|null $content необязательно null
Строка или вызываемый объект сообщения для отправки

Возвращает

строка|null
Текущий буфер сообщения, если параметр $content передан как null

cache()source public deprecated

cache( string|integer|DateTimeInterface|null $since , string|integer $time = '+1 day' )

Устанавливает правильные заголовки для указания клиенту кешировать ответ.

Устарело

3.4.0 Используйте withCache() вместо этого.

Параметры

строка|целое число|DateTimeInterface|null $since
Действительный интервал времени с момента последнего изменения текста ответа
строка|целое число $time необязательно '+1 day'
Действительный интервал времени для истечения кеша

Исключения

InvalidArgumentException

charset()source public deprecated

charset( string|null $charset = null )

Устанавливает кодировку ответа, если $charset равен null, возвращается текущая кодировка.

Устарело

3.5.0 Используйте getCharset()/withCharset() вместо этого.

Параметры

строка|null $charset необязательно null
Строка кодировки символов.

Возвращает

строка
Текущая кодировка

checkNotModified()source public

checkNotModified( Cake\Http\ServerRequest $request )

Проверяет, не был ли ответ изменён в соответствии с заголовками запроса 'If-None-Match' (Etags) и 'If-Modified-Since' (дата последней модификации). Если ответ определяется как не изменённый, он помечается соответствующим образом, чтобы клиент мог быть об этом проинформирован.

Для того, чтобы отметить ответ как неизменённый, необходимо установить хотя бы заголовок ответа Last-Modified etag перед вызовом этого метода. В противном случае сравнение не будет возможным.

Предупреждение Этот метод изменяет ответ на месте и следует избегать его использования.

Параметры

Cake\Http\ServerRequest $request
Объект запроса

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

boolean
Отмечался ли ответ как не изменённый или нет.

compress()source public

compress( )

Устанавливает правильный обработчик буферизации вывода для отправки сжатого ответа. Ответы будут сжаты с помощью zlib, если расширение доступно.

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

boolean
false, если клиент не принимает сжатые ответы или нет доступного обработчика, true в противном случае

convertCookieToArray()source protected

convertCookieToArray( Cake\Http\Cookie\CookieInterface $cookie )

Преобразует cookie в массив его свойств.

Этот метод совместим с историческим поведением Cake\Http\Response, где httponly является httpOnly и expires является expire

Параметры

Cake\Http\Cookie\CookieInterface $cookie
Объект cookie.

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

array

cookie()source public deprecated

cookie( array|null $options = null )

Получатель/установщик конфигураций cookie

Этот метод действует как устанавливающий/получающий в зависимости от типа аргумента. Если метод вызывается без аргументов, он возвращает все конфигурации.

Если метод вызывается со строковым аргументом, он возвращает заданную конфигурацию, если она установлена, или null, если она не установлена.

Если метод вызывается с массивом в качестве аргумента, он установит конфигурацию cookie в контейнер cookie.

### Параметры (при установке конфигурации) - name: Имя cookie - value: Значение cookie - expire: Время истечения срока действия cookie - path: Путь, к которому применяется cookie - domain: Домен, для которого предназначен cookie - secure: Является ли cookie https? - httpOnly: Доступен ли cookie в клиенте?

Примеры

Получение всех cookie

$this->cookie()

Получение определенной конфигурации cookie

$this->cookie('MyCookie')

Установка конфигурации cookie

$this->cookie((array) $options)

Устаревший

3.4.0 Используйте getCookie(), getCookies() и withCookie() вместо этого.

Параметры

array|null $options optional null

Либо null для получения всех cookie, строка для определенного cookie или массив для установки cookie.

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

mixed

cors()source public

cors( Cake\Http\ServerRequest $request , string|array $allowedDomains = [] , string|array $allowedMethods = [] , string|array $allowedHeaders = [] )

Настройка доступа для источника и методов при запросах с разных источников

Этот метод позволяет установить домены несколькими способами, см. примеры

Полный URI

cors($request, 'https://www.cakephp.org');

URI с подстановкой

cors($request, 'https://*.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\Http\ServerRequest $request
Объект запроса
string|array $allowedDomains optional []
Список разрешенных доменов, см. описание метода для получения дополнительной информации
string|array $allowedMethods optional []
Список разрешенных HTTP-глаголов
string|array $allowedHeaders optional []
Список разрешенных HTTP-заголовков

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

Cake\Http\CorsBuilder

Объект билдера, предоставляющий удобный интерфейс для определения дополнительных заголовков CORS.


disableCache()source public deprecated

disableCache( )

Устанавливает правильные заголовки, чтобы указать клиенту не кэшировать ответ

Устаревший

3.4.0 Используйте withDisabledCache() вместо этого.

download()source public deprecated

download( string $filename )

Устанавливает правильные заголовки, чтобы указать браузеру загрузить ответ как файл.

Устаревший

3.4.0 Используйте withDownload() вместо этого.

Параметры

string $filename
Название файла, как браузер будет загружать ответ

etag()source public deprecated

etag( string|null $hash = null , boolean $weak = false )

Устанавливает заголовок Etag ответа. Etag - это сильное указание на то, что клиентом HTTP ответ может быть кэширован. Плохой способ генерирования Etag - создание хэша выходных данных ответа, вместо этого генерируйте уникальный хэш уникальных компонентов, которые идентифицируют запрос, такие как время модификации, идентификатор ресурса и всё, что вы считаете уникальным.

Второй параметр используется для указания клиентам, что содержимое изменилось, но семантически он может использоваться как то же самое. Например, представьте страницу с счётчиком посещений, два разных просмотра страницы эквивалентны, но отличаются на несколько байт. Это оставляет решение клиенту использовать или не использовать кэшированную страницу.

Если не переданы параметры, возвращается текущий заголовок Etag.

Устаревший

3.4.0 Используйте withEtag() вместо этого.

Параметры

string|null $hash optional null
Уникальный хэш, который идентифицирует этот ответ
boolean $weak optional false

Является ли ответ семантически таким же, как и другие с тем же хэшем или нет

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

string|null

expires()source public deprecated

expires( string|integer|DateTimeInterface|null $time = null )

Устанавливает заголовок Expires для ответа, взяв время истечения срока действия Если вызывается без параметров, он вернёт текущее значение Expires.

Примеры:

$response->expires('now') Срок действия кэша ответа истечёт сейчас $response->expires(new DateTime('+1 day')) Срок действия истечения будет установлен через 24 часа $response->expires() Вернёт текущее значение заголовка истечения срока действия

Устаревший

3.4.0 Используйте withExpires() вместо этого.

Параметры

string|integer|DateTimeInterface|null $time optional null
Действительная строка времени или экземпляр \DateTime.

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

string|null

file()source public deprecated

file( string $path , array $options = [] )

Настройка для отображения или загрузки указанного файла.

Если $_SERVER['HTTP_RANGE'] задано, вместо всего файла будет возвращён фрагмент файла.

Ключи параметров

  • name: Альтернативное имя файла для загрузки
  • download: Если true устанавливает заголовок для загрузки и принуждает файл к загрузке вместо отображения в браузере

Устаревший

3.4.0 Используйте withFile() вместо этого.

Параметры

string $path

Путь к файлу. Если путь не является абсолютным путём, разрешающим файл, APP будет добавлен в начало пути (это поведение устарело).

array $options optional []
Параметры, см. выше.

Исключения

Cake\Http\Exception\NotFoundException

getCharset()source public

getCharset( )

Возвращает текущий кодировщик.

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

string

getCookie()source public

getCookie( string $name )

Чтение одного cookie из ответа.

Этот метод предоставляет чтение ожидаемых cookie. Он не будет читать заголовок Set-Cookie в случае его установки.

Параметры

string $name
Имя cookie, которое вы хотите прочитать.

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

array|null
Данные cookie или null

getCookieCollection()source public

getCookieCollection( )

Получить CookieCollection из ответа

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

Cake\Http\Cookie\CookieCollection
END_OF_DOCUMENT_MARKER

getCookies()source public

getCookies( )

Получить все куки в ответе.

Возвращает ассоциативный массив имени куки => данные куки.

Возвращает

array

getFile()source public

getFile( )

Получить текущий файл, если он существует.

Возвращает

Cake\Filesystem\File|null
Файл для использования в ответе или null

getMimeType()source public

getMimeType( string $alias )

Возвращает определение типа MIME для псевдонима

Например getMimeType('pdf'); // returns 'application/pdf'

Параметры

строка $alias
псевдоним типа контента для сопоставления

Возвращает

mixed
Строка сопоставленного типа MIME или false, если $alias не сопоставлен

getReasonPhrase()source public

getReasonPhrase( )

Получает фразу причины ответа, связанную со статусом.

Поскольку фраза причины не является обязательным элементом в строке статуса ответа, значение фразы причины МОЖЕТ быть равно null. Реализации МОГУТ выбрать возвращение рекомендуемой по RFC 7231 фразы причины (или тех, которые перечислены в Реестре кодов состояния HTTP IANA) для кода состояния ответа.

Возвращает

строка
Фраза причины; должна возвращать пустую строку, если она отсутствует.

Ссылка

https://tools.ietf.org/html/rfc7231#section-6
http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml

getSimpleHeaders()source protected

getSimpleHeaders( )

Вспомогательная функция обратной совместимости для получения сглаженных заголовков.

Ранее CakePHP хранил заголовки как простой словарь, теперь, когда мы поддерживаем PSR7, внутреннее хранилище имеет каждый заголовок в виде массива.

Возвращает

массив

getStatusCode()source public

getStatusCode( )

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

Код состояния — это трехзначное целое числовое значение кода результата попытки сервера понять и выполнить запрос.

Возвращает

целое число
Код состояния.

getType()source public

getType( )

Возвращает текущий тип контента.

Возвращает

строка

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');

Устарело

3.4.0 Используйте withHeader(), getHeaderLine() и getHeaders() вместо этого.

Параметры

строка|массив|null $header необязательно null

Массив строк заголовка или одна строка заголовка - также принимается ассоциативный массив "имя заголовка" => "значение заголовка" - также принимается массив строковых заголовков

строка|массив|null $value необязательно null
Значение(я) заголовка

Возвращает

массив
Список заголовков для отправки

httpCodes()source public устаревшее

httpCodes( integer|array|null $code = null )

Запрашивает и устанавливает допустимые коды и сообщения ответов HTTP.

Устарело

3.4.0 Будет удалено в 4.0.0

Параметры

целое число|массив|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

Устарело

3.4.0 Используйте withLength() для установки длины вместо этого.

Параметры

целое число|null $bytes необязательно null
Число байтов

Возвращает

строка|null

location()source public устаревшее

location( null|string $url = null )

Доступ к заголовку расположения.

Получение/установка значения заголовка Location.

Устарело

3.4.0 Изменяемые ответы устарели. Используйте withLocation() и getHeaderLine() вместо этого.


Параметры

null|строка $url необязательно null
Либо null для получения текущего расположения, либо строка для установки расположения.

Возвращает

строка|null

При установке расположения возвращается null. При чтении расположения возвращается строка текущего значения заголовка расположения (если таковой имеется).


mapType()source public

mapType( string|array $ctype )

Сопоставляет тип контента обратно с псевдонимом

Например mapType('application/pdf'); // returns 'pdf'

Параметры

строка|массив $ctype
Либо строка типа контента для сопоставления, либо массив типов.

Возвращает

строка|массив|null
Псевдонимы для предоставленных типов.

maxAge()source public устаревшее

maxAge( integer|null $seconds = null )

Устанавливает директиву Cache-Control max-age. max-age — это количество секунд, по истечении которого ответ больше не должен рассматриваться как хороший кандидат для извлечения из кэша (клиента). Если вызывается без параметров, эта функция вернет текущее значение max-age, если оно есть.

Устарело

3.6.5 Используйте withMaxAge() вместо этого.

Параметры

целое число|null $seconds необязательно null
если null, метод вернет текущее значение max-age

Возвращает

целое число|null

modified()source public устаревшее

modified( string|integer|DateTimeInterface|null $time = null )

Устанавливает заголовок Last-Modified для ответа, используя время модификации Если вызывается без параметров, он вернет текущее значение Last-Modified

Примеры:

$response->modified('now') Установит Last-Modified на текущее время $response->modified(new DateTime('+1 day')) Установит дату модификации в прошлом за 24 часа $response->modified() Вернет текущее значение заголовка Last-Modified

Устарело

3.4.0 Используйте withModified() вместо этого.

Параметры

строка|целое число|DateTimeInterface|null $time необязательно null
Действительная строка времени или экземпляр \DateTime.

Возвращает

строка|null
END_OF_DOCUMENT_MARKER ```

mustRevalidate()source public deprecated

mustRevalidate( boolean|null $enable = null )

Устанавливает директиву Cache-Control must-revalidate. must-revalidate указывает, что ответ не должен быть предоставлен кэшем в старом виде ни при каких обстоятельствах без предварительной перевалидации с исходником. Если функция вызвана без параметров, она вернёт, присутствует ли must-revalidate.

Устарело

3.4.0 Используйте с withMustRevalidate() вместо этого.

Параметры

boolean|null $enable необязательно null

если null, метод вернёт текущее значение must-revalidate. Если boolean, устанавливает или сбрасывает директиву.

Возвращает

boolean

notModified()source public

notModified( )

Устанавливает ответ как «Не изменён», удаляя содержимое тела, устанавливая код состояния на «304 Не изменён» и удаляя все конфликтующие заголовки.

Предупреждение Этот метод изменяет ответ на месте и следует избегать его использования.

outputCompressed()source public

outputCompressed( )

Возвращает, будет ли результирующий вывод сжат PHP.

Возвращает

boolean

protocol()source public deprecated

protocol( string|null $protocol = null )

Устанавливает протокол, используемый при отправке ответа. По умолчанию HTTP/1.1. Если вызов производится без аргументов, возвращается текущий настроенный протокол.

Устарело

3.4.0 Используйте getProtocolVersion() вместо этого.

Параметры

string|null $protocol необязательно null
Протокол, используемый для отправки ответа.

Возвращает

string
Текущий установленный протокол

resolveType()source protected

resolveType( string $contentType )

Перевод и валидация типов содержимого.

Параметры

string $contentType
Тип содержимого или псевдоним типа.

Возвращает

string
Результирующий тип содержимого

Выбрасывает

InvalidArgumentException
При использовании недопустимого типа содержимого или псевдонима.

send()source public deprecated

send( )

Отправляет полный ответ клиенту, включая заголовки и тело сообщения. Выведет содержимое тела ответа.

Устарело

3.4.0 Будет удалено в версии 4.0.0

sendHeaders()source public deprecated

sendHeaders( )

Отправляет HTTP-заголовки и куки.

Устарело

3.4.0 Будет удалено в версии 4.0.0

setTypeMap()source public

setTypeMap( string $type , string|array $mimeType )

Добавляет определение типа содержимого в карту.

Например: setTypeMap('xhtml', ['application/xhtml+xml', 'application/xhtml'])

Это необходимо для RequestHandlerComponent и распознавания типов.

Параметры

string $type
Тип содержимого.
string|array $mimeType
Определение MIME-типа.

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|null

sharedMaxAge()source public deprecated

sharedMaxAge( integer|null $seconds = null )

Устанавливает директиву Cache-Control s-maxage.

max-age — количество секунд, после которого ответ больше не должен рассматриваться как подходящий для извлечения из общего кэша (например, на прокси-сервере). Если функция вызвана без параметров, она вернёт текущее значение max-age, если оно есть.

Устарело

3.6.5 Используйте с withSharedMaxAge() вместо этого.

Параметры

integer|null $seconds необязательно null
если null, метод вернёт текущее значение s-maxage

Возвращает

integer|null

statusCode()source public deprecated

statusCode( integer|null $code = null )

Устанавливает HTTP-код состояния, который должен быть отправлен. Если $code равен null, возвращается текущий код.

Если код состояния равен 304 или 204, существующий заголовок Content-Type будет очищен, так как эти коды ответа не имеют тела.

Устарело

3.4.0 Используйте getStatusCode() и withStatus() вместо этого.

Параметры

integer|null $code необязательно null
HTTP-код состояния

Возвращает

integer
Текущий код состояния

Выбрасывает

InvalidArgumentException
При достижении неизвестного кода состояния.

stop()source public deprecated

stop( integer|string $status = 0 )

Останавливает выполнение текущего скрипта. Оборачивает exit(), что облегчает тестирование.

Устарело

3.4.0 Будет удалено в версии 4.0.0

Параметры

integer|string $status необязательно 0
См. https://secure.php.net/exit для значений

type()source public deprecated

type( string|array|null $contentType = null )

Устанавливает тип содержимого ответа. Может быть расширением файла, которое будет сопоставлено с MIME-типом внутри, или строкой, представляющей MIME-тип. Если $contentType равно null, возвращается текущий тип содержимого. Если $contentType — ассоциативный массив, определения типов содержимого будут сохранены/заменены.

Установка типа содержимого

type('jpg');

Если вы попытаетесь установить тип на ответе со статусом 304 или 204, тип содержимого не будет действовать, так как эти коды статуса не содержат типов содержимого.

Возвращение текущего типа содержимого

type();

Хранение определений типов содержимого

type(['keynote' => 'application/keynote', 'bat' => 'application/bat']);

Замена определения типа содержимого

type(['jpg' => 'text/plain']);

Устарело

3.5.5 Используйте getType() или withType() вместо этого.

Параметры

string|array|null $contentType необязательно null
Ключ типа содержимого.

Возвращает

mixed
Текущий тип содержимого или false, если предоставлен недопустимый тип содержимого.

validateFile()source protected

validateFile( string $path )

Проверяет, является ли путь к файлу допустимым телом ответа.

Параметры

string $path
Путь к файлу.

Возвращает

Cake\Filesystem\File

Выбрасывает

Cake\Http\Exception\NotFoundException

vary()source public deprecated

vary( string|array|null $cacheVariances = null )

Устанавливает заголовок Vary для ответа. Если передан массив, значения будут объединены в строку, разделённую запятыми. Если параметры не переданы, возвращается массив с текущим значением заголовка Vary.

Устарело

3.4.0 Используйте withVary() вместо этого.

Параметры

string|array|null $cacheVariances необязательно null

Одна строка Vary или массив, содержащий список вариантов.

Возвращает

array|null
END_OF_DOCUMENT_MARKER

withAddedLink()source public

withAddedLink( string $url , array $options = [] )

Создать новый ответ с установленным заголовком Link.

Примеры

$response = $response->withAddedLink('http://example.com?page=1', ['rel' => 'prev'])
    ->withAddedLink('http://example.com?page=3', ['rel' => 'next']);

Сгенерирует:

Link: <http://example.com?page=1>; rel="prev"
Link: <http://example.com?page=3>; rel="next"

Параметры

строка $url
URL заголовка LinkHeader.
массив $options необязательно []
Параметры заголовка LinkHeader.

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

Cake\Http\Response

С версии

3.6.0

withCache()source public

withCache( string|integer|DateTimeInterface|null $since , string|integer $time = '+1 day' )

Создать новый экземпляр с заголовками для включения кэширования клиентом.

Параметры

строка|целое число|DateTimeInterface|null $since
Действительная дата, с момента которой текст ответа не изменялся
строка|целое число $time необязательно '+1 day'
Действительная дата истечения срока действия кэша

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

Cake\Http\Response

Исключения

InvalidArgumentException

withCharset()source public

withCharset( string $charset )

Получить новый экземпляр с обновлённым набором символов.

Параметры

строка $charset
Строка набора символов.

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

Cake\Http\Response

withCookie()source public

withCookie( string|Cake\Http\Cookie\Cookie $name , array|string $data = '' )

Создать новый ответ с установленным cookie.

Данные

  • value: Значение cookie
  • expire: Время истечения срока действия cookie
  • path: Путь действия cookie
  • domain: Домен, для которого предназначено cookie
  • secure: Является ли cookie https?
  • httpOnly: Доступно ли cookie в клиенте?

Примеры

// set scalar value with defaults
$response = $response->withCookie('remember_me', 1);

// customize cookie attributes
$response = $response->withCookie('remember_me', ['path' => '/login']);

// add a cookie object
$response = $response->withCookie(new Cookie('remember_me', 1));

Параметры

строка|Cake\Http\Cookie\Cookie $name
Имя cookie для установки или объект cookie
массив|строка $data необязательно ''
Строковое значение или массив опций cookie.

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

Cake\Http\Response

withCookieCollection()source public

withCookieCollection( Cake\Http\Cookie\CookieCollection $cookieCollection )

Получить новый экземпляр с предоставленным набором cookie.

Параметры

Cake\Http\Cookie\CookieCollection $cookieCollection
Набор cookie для установки.

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

Cake\Http\Response

withDisabledCache()source public

withDisabledCache( )

Создать новый экземпляр с заголовками, чтобы указать клиенту не кэшировать ответ

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

Cake\Http\Response

withDownload()source public

withDownload( string $filename )

Создать новый экземпляр с установленным заголовком Content-Disposition.

Параметры

строка $filename
Имя файла, как браузер загрузит ответ

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

Cake\Http\Response

withEtag()source public

withEtag( string $hash , boolean $weak = false )

Создать новый экземпляр с установленным заголовком Etag.

Etag - это сильное указание на то, что ответ может быть кэширован HTTP-клиентом. Плохой способ генерации Etag - это создание хэша выходных данных ответа, вместо этого создайте уникальный хэш уникальных компонентов, которые идентифицируют запрос, таких как время изменения, идентификатор ресурса и всё остальное, что вы считаете уникальным для ответа.

Второй параметр используется для информирования клиентов о том, что содержимое изменилось, но семантически оно эквивалентно существующим кэшированным значениям. Рассмотрим страницу со счётчиком посещений, две разные просмотры страниц эквивалентны, но отличаются на несколько байт. Это позволяет клиенту решить, использовать ли данные из кэша.

Параметры

строка $hash
Уникальный хэш, который идентифицирует этот ответ
логическое значение $weak необязательно false

Является ли ответ семантически таким же, как и другие с тем же хэшем или нет. По умолчанию ложь

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

Cake\Http\Response

withExpiredCookie()source public

withExpiredCookie( string|Cake\Http\Cookie\CookieInterface $name , array $options = [] )

Создать новый ответ с установленным истекшим cookie.

Опции

  • path: Путь действия cookie
  • domain: Домен, для которого предназначено cookie
  • secure: Является ли cookie https?
  • httpOnly: Доступно ли cookie в клиенте?

Примеры

// set scalar value with defaults
$response = $response->withExpiredCookie('remember_me');

// customize cookie attributes
$response = $response->withExpiredCookie('remember_me', ['path' => '/login']);

// add a cookie object
$response = $response->withExpiredCookie(new Cookie('remember_me'));

Параметры

строка|Cake\Http\Cookie\CookieInterface $name
Имя истекающего cookie или объект cookie
массив $options необязательно []
Массив опций cookie.

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

Cake\Http\Response

withExpires()source public

withExpires( string|integer|DateTimeInterface|null $time )

Создать новый экземпляр с установленным заголовком Expires.

Примеры:

// Will Expire the response cache now
$response->withExpires('now')

// Will set the expiration in next 24 hours
$response->withExpires(new DateTime('+1 day'))

Параметры

строка|целое число|DateTimeInterface|null $time
Действительная строка времени или экземпляр DateTime.

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

Cake\Http\Response

withFile()source public

withFile( string $path , array $options = [] )

Создать новый экземпляр, основанный на файле.

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

Если $_SERVER['HTTP_RANGE'] задано, вместо всего файла будет возвращён фрагмент файла.

Ключи опций

  • name: Альтернативное имя для загрузки
  • download: Если true устанавливает заголовок загрузки и принудительно загружает файл, а не отображает его внутри.

Параметры

строка $path

Путь к файлу. Если путь не является абсолютным путём, который разрешается в файл, APP будет добавлен к пути (это поведение устарело).

массив $options необязательно []
Опции См. выше.

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

Cake\Http\Response

Исключения

Cake\Http\Exception\NotFoundException

withLength()source public

withLength( integer|string $bytes )

Создать новый ответ с установленным заголовком Content-Length.

Параметры

целое число|строка $bytes
Количество байт

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

Cake\Http\Response

withLocation()source public

withLocation( string $url )

Возвращает экземпляр с обновлённым заголовком расположения.

Если текущий код состояния равен 200, он будет заменён на 302.

Параметры

строка $url
Адрес перенаправления.

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

Cake\Http\Response
Новый ответ с установленным заголовком Location.

withMaxAge()source public

withMaxAge( integer $seconds )

Создать экземпляр с установленным директивой Cache-Control max-age.

max-age - это количество секунд, по истечении которых ответ больше не должен рассматриваться как хороший кандидат для извлечения из локального (клиентского) кэша.

Параметры

целое число $seconds
Количество секунд, в течение которых кэшированный ответ может считаться действительным

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

Cake\Http\Response

withModified()source public

withModified( string|integer|DateTimeInterface|null $time )

Создать новый экземпляр с установленным заголовком Last-Modified.

Примеры:

// Will Expire the response cache now
$response->withModified('now')

// Will set the expiration in next 24 hours
$response->withModified(new DateTime('+1 day'))

Параметры

строка|целое число|DateTimeInterface|null $time
Действительная строка времени или экземпляр DateTimeInterface.

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

Cake\Http\Response
END_OF_DOCUMENT_MARKER

withMustRevalidate()source public

withMustRevalidate( boolean $enable )

Создать экземпляр с директивой Cache-Control must-revalidate.

Устанавливает директиву Cache-Control must-revalidate. must-revalidate указывает, что ответ не должен быть предоставлен кешем устаревшим в любом случае без предварительной перевалидации с источником.

Параметры

boolean $enable
Если boolean устанавливает или отменяет директиву.

Возвращает

Cake\Http\Response

withNotModified()source public

withNotModified( )

Создать новый экземпляр как 'не изменённый'.

Это удалит все содержимое тела, установит код состояния на "304" и удалит заголовки, описывающие тело ответа.

Возвращает

Cake\Http\Response

withSharable()source public

withSharable( boolean $public , integer|null $time = null )

Создать новый экземпляр с установленными директивами Cache-Control public/private.

Параметры

boolean $public

Если установлено в true, заголовок Cache-Control будет установлен как public, если установлено в false, ответ будет установлен как private.

integer|null $time optional null
Время в секундах после которого ответ больше не должен считаться свежим.

Возвращает

Cake\Http\Response

withSharedMaxAge()source public

withSharedMaxAge( integer $seconds )

Создать новый экземпляр с установленной директивой Cache-Control s-maxage.

max-age — это количество секунд после которого ответ больше не должен считаться подходящим для извлечения из общего кэша (например, в прокси-сервере).

Параметры

integer $seconds
Количество секунд для общего max-age

Возвращает

Cake\Http\Response

withStatus()source public

withStatus( integer $code , string $reasonPhrase = '' )

Возвращает экземпляр со специфицированным кодом состояния и, необязательно, фразой причины.

Если фраза причины не указана, реализации МОГУТ использовать значения по умолчанию, рекомендованные RFC 7231 или IANA для кода состояния ответа.

Этот метод ДОЛЖЕН быть реализован таким образом, чтобы сохранить неизменяемость сообщения, и ДОЛЖЕН вернуть экземпляр с обновлённым состоянием и фразой причины.

Если код состояния равен 304 или 204, существующий заголовок Content-Type будет очищен, так как эти коды ответа не имеют тела.

Параметры

integer $code
3-значный целочисленный код результата для установки.
string $reasonPhrase optional ''

Фраза причины для использования с предоставленным кодом состояния; если она не указана, реализации МОГУТ использовать значения по умолчанию, как предложено в спецификации HTTP.

Возвращает

Cake\Http\Response

Исключения

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

Ссылка

https://tools.ietf.org/html/rfc7231#section-6
https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml

withStringBody()source public

withStringBody( string $string )

Метод-утилита для установки строки в тело ответа

Параметры

string $string
Строка для отправки

Возвращает

Cake\Http\Response

withType()source public

withType( string $contentType )

Получить обновлённый ответ с установленным типом содержимого.

Если вы попытаетесь установить тип для ответа со статусом 304 или 204, тип содержимого не будет действовать, так как эти коды состояния не имеют типов содержимого.

Параметры

string $contentType
Расширение файла, которое будет сопоставлено с типом MIME, или конкретный тип MIME.

Возвращает

Cake\Http\Response

withVary()source public

withVary( string|array $cacheVariances )

Создать новый экземпляр с установленным заголовком Vary.

Если передаётся массив, значения будут объединены в строку, разделённую запятыми. Если параметры не передаются, возвращается массив с текущим значением заголовка Vary.

Параметры

string|array $cacheVariances

Одна строка Vary или массив, содержащий список вариаций.

Возвращает

Cake\Http\Response

Подробное описание свойств

$_cacheDirectivessource

protected массив

Хранит все директивы кэширования, которые будут преобразованы в заголовки при отправке запроса

[]

$_charsetsource

protected строка

Кодировка символов тела ответа

'UTF-8'

$_contentTypesource

protected строка

Тип содержимого для отправки. Может быть 'расширением', которое будет преобразовано с помощью массива $_mimetypes, или полным типом MIME.

'text/html'

$_cookiessource

protected Cake\Http\Cookie\CookieCollection

Коллекция куки для отправки клиенту

null

$_filesource

protected Cake\Filesystem\File|null

Объект файла для чтения файла как ответа

$_fileRangesource

protected массив

Диапазон файла. Используется для запроса диапазонов файлов.

[]

$_mimeTypessource

protected массив

Содержит сопоставления типов ключей с типами 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',
    'psd' => ['application/photoshop', 'application/psd', 'image/psd', 'image/x-photoshop', 'image/photoshop', 'zz-application/zz-winassoc-psd'],
    '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',
    'bmp' => 'image/bmp'
]

$_protocolsource

protected строка

Заголовок протокола для отправки клиенту

'HTTP/1.1'

$_reasonPhrasesource

protected строка

Фраза причины

'OK'

$_statussource

protected целое число

Код состояния для отправки клиенту

200

$_statusCodessource

protected массив

Хранит HTTP коды ответов

[
    100 => 'Continue',
    101 => 'Switching Protocols',
    102 => 'Processing',
    200 => 'OK',
    201 => 'Created',
    202 => 'Accepted',
    203 => 'Non-Authoritative Information',
    204 => 'No Content',
    205 => 'Reset Content',
    206 => 'Partial Content',
    207 => 'Multi-status',
    208 => 'Already Reported',
    226 => 'IM used',
    300 => 'Multiple Choices',
    301 => 'Moved Permanently',
    302 => 'Found',
    303 => 'See Other',
    304 => 'Not Modified',
    305 => 'Use Proxy',
    306 => '(Unused)',
    307 => 'Temporary Redirect',
    308 => 'Permanent 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 Timeout',
    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',
    418 => 'I\'m a teapot',
    421 => 'Misdirected Request',
    422 => 'Unprocessable Entity',
    423 => 'Locked',
    424 => 'Failed Dependency',
    425 => 'Unordered Collection',
    426 => 'Upgrade Required',
    428 => 'Precondition Required',
    429 => 'Too Many Requests',
    431 => 'Request Header Fields Too Large',
    444 => 'Connection Closed Without Response',
    451 => 'Unavailable For Legal Reasons',
    499 => 'Client Closed Request',
    500 => 'Internal Server Error',
    501 => 'Not Implemented',
    502 => 'Bad Gateway',
    503 => 'Service Unavailable',
    504 => 'Gateway Timeout',
    505 => 'Unsupported Version',
    506 => 'Variant Also Negotiates',
    507 => 'Insufficient Storage',
    508 => 'Loop Detected',
    510 => 'Not Extended',
    511 => 'Network Authentication Required',
    599 => 'Network Connect Timeout Error',
]

$_streamModesource

protected строка

Параметры режима потока.

'wb+'
END_OF_DOCUMENT_MARKER

$_streamTargetsource

protected string|resource

Целевой поток или объект ресурса.

'php://memory'

© 2005–present 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.
https://api.cakephp.org/3.8/class-Cake.Http.Response.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API