Класс 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 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|DateTimeInterface|null $time = null )

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

Параметры

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

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

Возвращает

DateTimeInterface

_handleCallableBody()source protected

_handleCallableBody( callable $content )

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

Параметры

вызываемый объект $content

Вызываемое содержимое.

Возвращает

строка

_isActive()source protected deprecated

_isActive( )

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

Устаревший

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

Возвращает

boolean

_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

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

Возвращает

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

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

Примеры

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

$this->cookie()

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

$this->cookie('MyCookie')

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

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

Устарело

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

Параметры

array|null $options optional null

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

Возвращает

mixed

cors()source public

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

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

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

Полный URI

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

URI с подстановочным знаком

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

Игнорирование запрошенного протокола

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

Любой URI

cors($request, '*');

Белый список URI

cors($request, ['http://www.cakephp.org', '*.google.com', 'https://myproject.github.io']);

Примечание Параметры $allowedDomains, $allowedMethods, $allowedHeaders устарели. Вместо этого следует использовать объект билдера.

Параметры

Cake\Http\ServerRequest $request

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

string|array $allowedDomains optional []

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

string|array $allowedMethods optional []

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

string|array $allowedHeaders optional []

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

Возвращает

Cake\Http\CorsBuilder

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

disableCache()source public deprecated

disableCache( )

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

Устарело

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

download()source public deprecated

download( string $filename )

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

Устарело

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

Параметры

string $filename

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

etag()source public deprecated

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

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

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

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

Устарело

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

Параметры

string|null $hash optional null

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

boolean $weak optional false

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

Возвращает

string|null

expires()source public deprecated

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

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

Примеры:

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

Устарело

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

Параметры

string|DateTimeInterface|null $time optional null

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

Возвращает

string|null

file()source public deprecated

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

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

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

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

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

Устарело

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

Параметры

string $path

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

array $options optional []

Параметры, см. выше.

Исключения

Cake\Http\Exception\NotFoundException

getCharset()source public

getCharset( )

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

Возвращает

string

getCookie()source public

getCookie( string $name )

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

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

Параметры

string $name

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

Возвращает

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

getCookieCollection()source public

getCookieCollection( )

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

Возвращает

Cake\Http\Cookie\CookieCollection

getCookies()source public

getCookies( )

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

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

Возвращает

array

getFile()source public

getFile( )

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

Возвращает

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

getMimeType()source public

getMimeType( string $alias )

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

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

Параметры

строка $alias

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

Возвращает

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

getReasonPhrase()source public

getReasonPhrase( )

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

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

Возвращает

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

Ссылка

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

getSimpleHeaders()source protected

getSimpleHeaders( )

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

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

Возвращает

array

getStatusCode()source public

getStatusCode( )

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

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

Возвращает

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

getType()source public

getType( )

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

Возвращает

строка

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

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

Возвращает

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

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

Возвращает

смешанный

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

Вызывает исключение

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

length()source public deprecated

length( integer|null $bytes = null )

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

Устарело

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

Параметры

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

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

Возвращает

строка|null

location()source public deprecated

location( null|string $url = null )

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

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

Устарело

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

Параметры

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

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

Возвращает

строка|null

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

mapType()source public

mapType( string|array $ctype )

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

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

Параметры

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

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

Возвращает

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

maxAge()source public deprecated

maxAge( integer|null $seconds = null )

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

Устарело

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

Параметры

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

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

Возвращает

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

modified()source public deprecated

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

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

Примеры:

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

Устарело

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

Параметры

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

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

Возвращает

строка|null

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|DateTimeInterface $time )

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

Примеры:

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

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

Параметры

строка|DateTimeInterface $time

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

Возвращает

Cake\Http\Response

withFile()source public

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

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

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

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

Ключи опций

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

Параметры

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

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

Если текущий код состояния равен 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|DateTimeInterface $time )

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

Примеры:

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

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

Параметры

строка|DateTimeInterface $time

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

Возвращает

Cake\Http\Response

withMustRevalidate()source public

withMustRevalidate( boolean $enable )

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

Устанавливает директиву кэширования 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 )

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

Параметры

boolean $public

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

integer|null $time optional null

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

Возвращает

Cake\Http\Response

withSharedMaxAge()source public

withSharedMaxAge( integer $seconds )

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

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

Параметры

integer $seconds

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

Возвращает

Cake\Http\Response

withStatus()source public

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

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

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

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

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

Параметры

integer $code

Устанавливаемый код результата из 3 цифр.

string $reasonPhrase optional ''

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

Возвращает

Cake\Http\Response

Исключения

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

Ссылка

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

withStringBody()source public

withStringBody( string $string )

Удобный метод для установки строки в теле ответа

Параметры

string $string

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

Возвращает

Cake\Http\Response

withType()source public

withType( string $contentType )

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

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

Параметры

string $contentType

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

Возвращает

Cake\Http\Response

withVary()source public

withVary( string|array $cacheVariances )

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

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

Параметры

string|array $cacheVariances

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

Возвращает

Cake\Http\Response

[]

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