Класс Response

send()source public

send( )

Заглушка для метода send(), чтобы заголовки и вывод не отправлялись.

Возвращает

$this

Переопределяет

Cake\Http\Response::send()

__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 deprecated

_clearBuffer( )

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

Устарело

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

Возвращает

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

_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|DateTime|null $time = null )

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

Параметры

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

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

Возвращает

DateTime

_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 устаревшее

_setCookies( )

Устанавливает куки, которые были добавлены с помощью Cake\Http\Response::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 устаревшее

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

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

Устаревшее

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

Параметры

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

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

Возвращает

строка|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' (Etag) и 'If-Modified-Since' (дата последней модификации). Если ответ не был изменён, он помечается как таковой, чтобы об этом уведомить клиента.

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

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

Параметры

Cake\Http\ServerRequest $request

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

Возвращает

boolean
Был ли ответ помечен как не изменённый или нет.

compress()source public

compress( )

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

Возвращает

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

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

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

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

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

### Опции (при установке конфигурации) - name: Имя куки - value: Значение куки - expire: Время истечения куки - path: Путь применения куки - domain: Домен куки - secure: Куки для HTTPS? - httpOnly: Куки доступен для клиента?

Примеры

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

$this->cookie()

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

$this->cookie('MyCookie')

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

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

Устаревшее

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

Параметры

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

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

Возвращает

смешанное

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\Http\CorsBuilder

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

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

disableCache( )

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

Устаревшее

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

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

download( string $filename )

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

Устаревшее

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

Параметры

строка $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 необязательно null

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

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

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

Возвращает

string|null

expires()source public deprecated

expires( string|DateTime|null $time = null )

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

Примеры:

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

Устарело

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

Параметры

string|DateTime|null $time необязательно 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 необязательно []

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

Исключение

Cake\Http\Exception\NotFoundException

getCharset()source public

getCharset( )

Возвращает текущий кодировочный стандарт.

Возвращает

string

getCookie()source public

getCookie( string $name )

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

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

Параметры

string $name

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

Возвращает

array|null
Данные куки или null

getCookieCollection()source public

getCookieCollection( )

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

Возвращает

Cake\Http\Cookie\CookieCollection

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'

Параметры

string $alias

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

Возвращает

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

getReasonPhrase()source public

getReasonPhrase( )

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

Поскольку фраза причины не является обязательным элементом в строке состояния ответа, значение фразы причины может быть равно null. Реализации могут выбрать возвращение рекомендуемой фразы причины по 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
Код состояния.

getType()source public

getType( )

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

Возвращает

string

header()source public deprecated

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 deprecated

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 deprecated

length( integer|null $bytes = null )

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

Устарело

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

Параметры

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

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

Возвращает

string|null

location()source public deprecated

location( null|string $url = null )

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

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

Устарело

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

Параметры

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

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

Возвращает

string|null

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

mapType()source public

mapType( string|array $ctype )

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

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

Параметры

string|array $ctype

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

Возвращает

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

maxAge()source public deprecated

maxAge( integer|null $seconds = null )

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

Устарело

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

Параметры

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

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

Возвращает

integer|null

modified()source public deprecated

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 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
Если используется недопустимый тип или псевдоним содержимого.

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 устаревший

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 устаревший

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

Устаревший

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

Параметры

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

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

Возвращает

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

validateFile()source protected

validateFile( string $path )

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

Параметры

string $path

Путь к файлу.

Возвращает

Cake\Filesystem\File

Выбрасывает

Cake\Http\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

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"

Параметры

string $url

Ссылка заголовка Link.

array $options необязательный []

Параметры заголовка Link.

Возвращает

Cake\Http\Response

С версии

3.6.0

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

Создаёт новый ответ с установленным 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));

Параметры

string|Cake\Http\Cookie\Cookie $name

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

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

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

Возвращает

Cake\Http\Response

withDisabledCache()source public

withDisabledCache( )

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

Возвращает

Cake\Http\Response

withDownload()source public

withDownload( string $filename )

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

Параметры

string $filename

Имя файла, как браузер будет загружать ответ

Возвращает

Cake\Http\Response

withEtag()source public

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

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

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

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

Параметры

string $hash

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

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

Параметры

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

Параметры

string|DateTime $time

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

Возвращает

Cake\Http\Response

withFile()source public

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

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

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

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

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

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

Параметры

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

Параметры

string|DateTime $time

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

Возвращает

Cake\Http\Response

withMustRevalidate()source public

withMustRevalidate( boolean $enable )

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

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

Параметры

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

Параметры

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

Количество секунд для shared max-age

Возвращает

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