Класс Response

__construct()source public

__construct( array $options = [] )

Конструктор

Параметры

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

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

__debugInfo()source public

__debugInfo( )

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

Возвращает

массив

__toString()source public

__toString( )

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

Возвращает

строка

_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. charset будет установлен в заголовке только в том случае, если тип ответа text/*

_setCookies()source protected deprecated

_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 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 $since , string $time = '+1 day' )

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

Устаревшее

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

Параметры

строка $since

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

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

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

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 в клиенте?

Примеры

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

$this->cookie()

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

$this->cookie('MyCookie')

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

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

Устарело

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

Параметры

array|null $options optional null

Либо null для получения всех cookies, строка для определённого 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

Объект билдера, предоставляющий интерфейс fluent для определения дополнительных заголовков 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 для ответа. Etags являются сильным указанием на то, что ответ может быть кэширован HTTP-клиентом. Плохой способ генерации Etags — создание хэша выходных данных ответа, вместо этого создайте уникальный хэш уникальных компонентов, которые идентифицируют запрос, например, время изменения, идентификатор ресурса и всё остальное, что вы считаете уникальным.

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

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

Устарело

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

Параметры

string|null $hash optional null

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

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

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) для кода состояния ответа.

Возвращает

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

Параметры

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

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

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

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

Возвращает

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

httpCodes()source public deprecated

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

Возвращает

mixed

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

Исключения

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

length()source public deprecated

length( integer|null $bytes = null )

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

Устаревшее

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

Параметры

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

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

Возвращает

string|null

location()source public deprecated

location( null|string $url = null )

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

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

Устаревшее

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

Параметры

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

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

Возвращает

string|null

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

mapType()source public

mapType( string|array $ctype )

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

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

Параметры

строка|массив $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() вместо этого.

Параметры

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

Параметры

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

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

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"

Параметры

строка $url

URL заголовка LinkHeader.

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

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

Возвращает

Cake\Http\Response

С версии

3.6.0

withCache()source public

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

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

Параметры

строка $since

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

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

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

Возвращает

Cake\Http\Response

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

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 = [] )

Создать новый ответ с установленным истекшим 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|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\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'))

Параметры

строка|DateTime $time

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

Возвращает

Cake\Http\Response

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 необязательный null

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

Возвращает

Cake\Http\Response

withSharedMaxAge()source public

withSharedMaxAge( integer $seconds )

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

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

Параметры

integer $seconds

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

Возвращает

Cake\Http\Response

withStatus()source public

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

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

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

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

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

Параметры

integer $code

Трехзначный целочисленный код результата, который нужно установить.

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

[]

'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',
    'bmp' => 'image/bmp'
]

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