Класс Response

__construct()source public

__construct( array $options [] )

Конструктор

Параметры

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

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

__debugInfo()source public

__debugInfo( )

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

Возвращает

массив

__toString()source public

__toString( )

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

Возвращает

строка

_clearBuffer()source protected

_clearBuffer( )

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

Устарело

3.2.4 Этот метод больше не нужен

Возвращает

булево

_clearHeader()source protected

_clearHeader( string $header )

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

Параметры

строка $header

Ключ заголовка.

_createStream()source protected

_createStream( )

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

_fileRange()source protected

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

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

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

Устарело

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

Параметры

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

_handleCallableBody()source protected

_handleCallableBody( callable $content )

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

Параметры

вызываемый $content

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

Возвращает

строка

_isActive()source protected

_isActive( )

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

Устарело

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

Возвращает

булево значение

_sendContent()source protected

_sendContent( string|callable $content )

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

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

Устарело

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

Параметры

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

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

_sendFile()source protected

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

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

Устарело

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

Параметры

Cake\Filesystem\File $file

Объект файла

массив $range

Диапазон для чтения из файла.

Возвращает

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

_sendHeader()source protected

_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

_setContent( )

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

Устарело

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

_setContentType()source protected

_setContentType( )

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

_setCookies()source protected

_setCookies( )

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

Устарело

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

_setHeader()source protected

_setHeader( string $header , string $value )

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

Параметры

строка $header

Ключ заголовка.

строка $value

Значение заголовка.

body()source public

body( string|callable|null $content null )

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

Устарело

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

Параметры

строка|вызываемый|null $content необязательно null

строка или вызываемый объект сообщения, подлежащие отправке

Возвращает

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

cache()source public

cache( string $since , string $time '+1 day' )

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

Устарело

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

Параметры

строка $since

действительный временной интервал, после которого текст ответа не изменялся

строка $time необязательно '+1 day'

действительный интервал времени для истечения срока действия кэша

charset()source public

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

Объект запроса

Возвращает

булево значение
Отмечен ли ответ как неизменённый или нет.

compress()source public

compress( )

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

Возвращает

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

convertCookieToArray()source protected

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

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

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

Параметры

Cake\Http\Cookie\CookieInterface $cookie

Объект куки.

Возвращает

массив

cookie()source public

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() вместо этого.

Параметры

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

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

Возвращает

смешанный тип

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

Объект запроса

строка|массив $allowedDomains необязательно []

Список разрешенных доменов, см. описание метода для более подробной информации

строка|массив $allowedMethods необязательно []

Список разрешенных HTTP-методов

строка|массив $allowedHeaders необязательно []

Список разрешенных HTTP-заголовков

Возвращает

Cake\Network\CorsBuilder

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

disableCache()source public

disableCache( )

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

Устарело

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

download()source public

download( string $filename )

Устанавливает необходимые заголовки, чтобы браузер загружал ответ как файл.

Устарело

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

Параметры

строка $filename

Название файла, как браузер загрузит ответ

etag()source public

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

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

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

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

Устарело

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

Параметры

строка|null $hash необязательно null

Уникальный хэш, идентифицирующий этот ответ

булево $weak необязательно false

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

Возвращает

строка|null

expires()source public

expires( string|DateTime|null $time null )

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

Примеры:

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

Устарело

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

Параметры

строка|DateTime|null $time необязательно null

Действительная строка времени или экземпляр DateTime.

Возвращает

строка|null

file()source public

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

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

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

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

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

Устарело

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

Параметры

строка $path

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

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

Параметры См. выше.

Исключения

Cake\Network\Exception\NotFoundException

getCharset()source public

getCharset( )

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

Возвращает

строка

getCookie()source public

getCookie( string $name )

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

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

Параметры

строка $name

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

Возвращает

массив|null
Данные cookie или null

getCookieCollection()source public

getCookieCollection( )

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

Возвращает

Cake\Http\Cookie\CookieCollection

getCookies()source public

getCookies( )

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

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

Возвращает

массив

getFile()source public

getFile( )

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

Возвращает

Cake\Filesystem\File|null
Используемый файл в ответе или null

getMimeType()source public

getMimeType( string $alias )

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

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

Параметры

строка $alias

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

Возвращает

смешанный тип
Строка сопоставленного MIME-типа или false, если $alias не сопоставлен

getReasonPhrase()source public

getReasonPhrase( )

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

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

Возвращает

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

Ссылка

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, внутреннее хранилище имеет каждый заголовок в виде массива.

Возвращает

array

getStatusCode()source public

getStatusCode( )

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

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

Возвращает

integer
Код состояния.

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() вместо этого.

Параметры

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

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

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

Значение(я) заголовка

Возвращает

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

httpCodes()source public

httpCodes( integer|array|null $code null )

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

Устарело

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

Параметры

integer|array|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

Возвращает

mixed

Ассоциативный массив кодов HTTP в качестве ключей и строк сообщений в качестве значений или null, если заданный $code не существует.

Выбрасывает

InvalidArgumentException
Если выполняется попытка добавить недопустимый код состояния

length()source public

length( integer|null $bytes null )

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

Устарело

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

Параметры

integer|null $bytes необязательно null

Количество байтов

Возвращает

integer|null

location()source public

location( null|string $url null )

Доступ к заголовку location.

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

Устарело

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

Параметры

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

Либо null, чтобы получить текущее расположение, либо строка, чтобы установить его.

Возвращает

string|null

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

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

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

Устарело

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

Параметры

string|DateTime|null $time необязательно null

Действительная строка времени или экземпляр \DateTime.

Возвращает

string|null

mustRevalidate()source public

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

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

send( )

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

Устарело

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

sendHeaders()source public

sendHeaders( )

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

Устарело

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

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

sharedMaxAge( integer|null $seconds null )

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

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

Параметры

integer|null $seconds необязательно null

если null, метод вернёт текущее значение s-maxage.

Возвращает

integer|null

statusCode()source public

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

stop( integer|string $status 0 )

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

Устарело

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

Параметры

integer|string $status необязательно 0

См. https://secure.php.net/exit для значений

type()source public

type( string|null $contentType null )

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

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

type('jpg');

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

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

type();

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

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

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

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

Параметры

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

Ключ типа содержимого.

Возвращает

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

validateFile()source protected

validateFile( string $path )

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

Параметры

string $path

Путь к файлу.

Возвращает

Cake\Filesystem\File

Исключения

Cake\Network\Exception\NotFoundException

vary()source public

vary( string|array|null $cacheVariances null )

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

Устарело

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

Параметры

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

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

Возвращает

array|null

withCache()source public

withCache( string $since , string $time '+1 day' )

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

Параметры

string $since

допустимое время, с момента последнего изменения содержимого ответа.

string $time необязательно '+1 day'

допустимое время для истечения кэша.

Возвращает

Cake\Http\Response

withCharset()source public

withCharset( string $charset )

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

Параметры

string $charset

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

Возвращает

Cake\Http\Response

withCookie()source public

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

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

Параметры

• name: Имя куки
• value: Значение куки
• expire: Время истечения куки
• path: Путь, к которому применяется куки
• domain: Домен куки
• secure: Является ли куки HTTPS
• httpOnly: Доступен ли куки в клиенте

Примеры

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

Параметры

string|Cake\Http\Cookie\Cookie $name

Имя куки для установки или объект куки

array|string $data необязательно ''

Строковое значение или массив параметров куки.

Возвращает

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

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

Возвращает

Cake\Http\Response

withExpiredCookie()source public

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

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

Параметры

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

Примеры

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

Имя куки для истечения срока действия или объект куки

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

Массив параметров куки.

Возвращает

Cake\Http\Response

withExpires()source public

withExpires( string|DateTime $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'))

Параметры

строка|DateTime $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\Network\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|DateTime $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'))

Параметры

строка|DateTime $time

Действительная строка времени или экземпляр DateTime.

Возвращает

Cake\Http\Response

withMustRevalidate()source public

withMustRevalidate( boolean $enable )

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

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

Параметры

булево $enable

Если булево значение, устанавливает или отменяет директиву.

Возвращает

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.

Параметры

булево $public

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

целое число|null $time необязательно null

Время в секундах, по истечении которого ответ больше не должен считаться свежим.

Возвращает

Cake\Http\Response

withSharedMaxAge()source public

withSharedMaxAge( integer $seconds )

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

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

Параметры

целое число $seconds

Количество секунд для s-maxage

Возвращает

Cake\Http\Response

withStatus()source public

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

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

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

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

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

Параметры

целое число $code

Целое число результата (3 цифры) для установки.

строка $reasonPhrase необязательно ''

Фраза причины, которая будет использована с указанным кодом состояния; если она не указана, реализации МОГУТ использовать значения по умолчанию, как предложено в спецификации 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

Строка, которая будет отправлена

Возвращает

Cake\Http\Response

withType()source public

withType( string $contentType )

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

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

Параметры

строка $contentType

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

Возвращает

Cake\Http\Response

withVary()source public

withVary( string|array $cacheVariances )

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

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

Параметры

строка|массив $cacheVariances

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

Возвращает

Cake\Http\Response

[]

'UTF-8'

'text/html'

null

[]

[
    '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'
]

'HTTP/1.1'

'OK'

200

[
    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',
]

'wb+'

'php://memory'