Класс Response

__construct()source public

__construct( array $options [] )

Конструктор

Параметры

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

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

__debugInfo()source public

__debugInfo( )

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

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

массив

__toString()source public

__toString( )

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

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

строка

_clearBuffer()source protected

_clearBuffer( )

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

Устарело

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

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

булево

_clearHeader()source protected

_clearHeader( string $header )

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

Параметры

строка $header

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

_createStream()source protected

_createStream( )

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

_fileRange()source protected

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

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

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

Устарело

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

Параметры

Cake\Filesystem\File $file

Файл, к которому нужно установить диапазон.

строка $httpRange

Диапазон, который нужно использовать.

_flushBuffer()source protected

_flushBuffer( )

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

Устарело

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

_getUTCDate()source protected

_getUTCDate( string|integer|DateTime|null $time null )

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

Параметры

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

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

Возвращает

DateTime

_handleCallableBody()source protected

_handleCallableBody( callable $content )

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

Параметры

callable $content

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

Возвращает

string

_isActive()source protected

_isActive( )

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

Устарело

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

Возвращает

boolean

_sendContent()source protected

_sendContent( string|callable $content )

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

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

Устарело

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

Параметры

string|callable $content

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

_sendFile()source protected

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

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

Устарело

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

Параметры

Cake\Filesystem\File $file

Объект файла

array $range

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

Возвращает

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

_sendHeader()source protected

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

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

Устарело

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

Параметры

string $name

Имя заголовка.

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

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

_setCacheControl()source protected

_setCacheControl( )

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

_setContent()source protected

_setContent( )

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

Устарело

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

_setContentType()source protected

_setContentType( )

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

_setCookies()source protected

_setCookies( )

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

Устарело

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

_setHeader()source protected

_setHeader( string $header , string $value )

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

Параметры

string $header

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

string $value

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

body()source public

body( string|callable|null $content null )

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

Устарело

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

Параметры

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

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

Возвращает

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

cache()source public

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

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

Устарело

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

Параметры

string $since

действительный интервал времени, с момента последней модификации текста ответа

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

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

charset()source public

charset( string|null $charset null )

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

Устарело

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

Параметры

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

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

Возвращает

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

checkNotModified()source public

checkNotModified( Cake\Http\ServerRequest $request )

Проверяет, не был ли ответ изменён в соответствии с запросом заголовков 'If-None-Match' (Etag) и '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

cookie( array|null $options null )

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

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

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

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

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

Примеры

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

$this->cookie()

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

$this->cookie('MyCookie')

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

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

Устаревшее

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

Параметры

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

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

Возвращает

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

cors()source public

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

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

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

Полный URI

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

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

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

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

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

Любой URI

cors($request, '*');

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

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

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

Параметры

Cake\Http\ServerRequest $request

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

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

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

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

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

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

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

Возвращает

Cake\Network\CorsBuilder

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

disableCache()source public

disableCache( )

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

Устаревшее

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

download()source public

download( string $filename )

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

Устаревшее

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

Параметры

строка $filename

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

etag()source public

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

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

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

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

Устаревшее

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

Параметры

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

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

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

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

Возвращает

строка|null

expires()source public

expires( string|DateTime|null $time null )

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

Примеры:

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

Устаревшее

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

Параметры

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

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

Возвращает

строка|null

file()source public

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

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

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

Ключи опций

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

Устаревшее

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

Параметры

строка $path

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

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

Опции См. выше.

Исключения

Cake\Network\Exception\NotFoundException

getCharset()source public

getCharset( )

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

Возвращает

строка

getCookie()source public

getCookie( string $name )

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

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

Параметры

строка $name

Имя куки, которое нужно прочитать.

Возвращает

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

getCookieCollection()source public

getCookieCollection( )

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

Возвращает

Cake\Http\Cookie\CookieCollection

getCookies()source public

getCookies( )

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

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

Возвращает

массив

getFile()source public

getFile( )

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

Возвращает

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

getMimeType()source public

getMimeType( string $alias )

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

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

Параметры

строка $alias

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

Возвращает

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

getReasonPhrase()source public

getReasonPhrase( )

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

Поскольку фраза причины не является обязательным элементом в строке состояния ответа, значение фразы причины МОЖЕТ быть 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( )

Возвращает код состояния ответа.

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

Возвращает

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

getType()source public

getType( )

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

Возвращает

string

header()source public

header( string|array|null $header null , string|array|null $value null )

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

Один заголовок

header('Location', 'http://example.com');

Несколько заголовков

header(['Location' => 'http://example.com', 'X-Extra' => 'My header']);

Заголовок-строка

header('WWW-Authenticate: Negotiate');

Массив строковых заголовков

header(['WWW-Authenticate: Negotiate', 'Content-type: application/pdf']);

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

header('WWW-Authenticate: Negotiate');
header('WWW-Authenticate: Not-Negotiate');

будет иметь тот же эффект, что и только

header('WWW-Authenticate: Not-Negotiate');

Устарело

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

Параметры

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

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

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

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

Возвращает

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

httpCodes()source public

httpCodes( integer|array|null $code null )

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

Устарело

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

Параметры

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

Если $code — целое число, то соответствующий код/сообщение возвращается, если оно существует, null, если не существует. Если $code — массив, то ключи используются в качестве кодов, а значения — как сообщения для добавления к стандартным HTTP-кодам. Коды должны быть целыми числами, большими 99 и меньшими 1000. Имейте в виду, что спецификация HTTP указывает, что коды статусов начинаются с цифры от 1 до 5, что определяет класс ответа, который клиент должен ожидать. Пример:

httpCodes(404); // returns [404 => 'Not Found']

   httpCodes([
       381 => 'Unicorn Moved',
       555 => 'Unexpected Minotaur'
   ]); // sets these new values, and returns true

   httpCodes([
       0 => 'Nothing Here',
       -1 => 'Reverse Infinity',
       12345 => 'Universal Password',
       'Hello' => 'World'
   ]); // throws an exception due to invalid codes

   For more on HTTP status codes see: http://www.w3.org/Protocols/rfc2616/rfc2616-sec6.html#sec6.1

Возвращает

mixed

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

Исключения

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

length()source public

length( integer|null $bytes null )

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

Устарело

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

Параметры

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

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

Возвращает

string|null

location()source public

location( null|string $url null )

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

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

Устарело

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

Параметры

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

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

Возвращает

string|null

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

mapType()source public

mapType( string|array $ctype )

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

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

Параметры

string|array $ctype

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

Возвращает

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

maxAge()source public

maxAge( integer|null $seconds null )

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

Параметры

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

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

Возвращает

integer|null

modified()source public

modified( string|DateTime|null $time null )

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

Примеры:

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

Устарело

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

Параметры

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

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

Возвращает

string|null

mustRevalidate()source public

mustRevalidate( boolean|null $enable null )

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

Устарело

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

Параметры

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

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

Возвращает

boolean

notModified()source public

notModified( )

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

outputCompressed()source public

outputCompressed( )

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

Возвращает

boolean

protocol()source public

protocol( string|null $protocol null )

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

Устаревшее

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

Параметры

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

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

Возвращает

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

resolveType()source protected

resolveType( string $contentType )

Преобразует и проверяет типы содержимого.

Параметры

string $contentType

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

Возвращает

string
Разрешенный тип содержимого

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

InvalidArgumentException
Если используется недопустимый тип содержимого или псевдоним.

send()source public

send( )

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

Устаревшее

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

sendHeaders()source public

sendHeaders( )

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

Устаревшее

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

sharable()source public

sharable( boolean|null $public null , integer|null $time null )

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

Параметры

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

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

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

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

Возвращает

boolean|null

sharedMaxAge()source public

sharedMaxAge( integer|null $seconds null )

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

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

Параметры

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

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

Возвращает

integer|null

statusCode()source public

statusCode( integer|null $code null )

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

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

Устаревшее

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

Параметры

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

код HTTP-состояния

Возвращает

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

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

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

stop()source public

stop( integer|string $status 0 )

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

Устаревшее

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

Параметры

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

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

type()source public

type( string|null $contentType null )

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

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

type('jpg');

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

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

type();

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

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

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

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

Устаревшее

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

Параметры

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

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

Возвращает

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

validateFile()source protected

validateFile( string $path )

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

Параметры

string $path

Путь к файлу.

Возвращает

Cake\Filesystem\File

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

Cake\Network\Exception\NotFoundException

vary()source public

vary( string|array|null $cacheVariances null )

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

Устаревшее

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

Параметры

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

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

Возвращает

array|null

withCache()source public

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

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

Параметры

string $since

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

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

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

Возвращает

Cake\Http\Response

withCharset()source public

withCharset( string $charset )

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

Параметры

string $charset

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

Возвращает

Cake\Http\Response

withCookie()source public

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

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

Параметры

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

Примеры

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

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

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

Параметры

string|Cake\Http\Cookie\Cookie $name

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

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

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

Возвращает

Cake\Http\Response

withDisabledCache()source public

withDisabledCache( )

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

Возвращает

Cake\Http\Response

withDownload()source public

withDownload( string $filename )

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

Параметры

строка $filename

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

Возвращает

Cake\Http\Response

withEtag()source public

withEtag( string $hash , boolean $weak false )

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

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

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

Параметры

строка $hash

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

логическое значение $weak необязательно false

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

Возвращает

Cake\Http\Response

withExpiredCookie()source public

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

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

Параметры

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

Примеры

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

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

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

Параметры

строка|Cake\Http\Cookie\CookieInterface $name

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

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

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

Возвращает

Cake\Http\Response

withExpires()source public

withExpires( string|DateTime $time )

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

Примеры:

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

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

Параметры

строка|DateTime $time

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

Возвращает

Cake\Http\Response

withFile()source public

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

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

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

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

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

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

Параметры

строка $path

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

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

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

Возвращает

Cake\Http\Response

Выбрасывает

Cake\Network\Exception\NotFoundException

withLength()source public

withLength( integer|string $bytes )

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

Параметры

целое число|строка $bytes

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

Возвращает

Cake\Http\Response

withLocation()source public

withLocation( string $url )

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

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

Параметры

строка $url

Расположение для перенаправления.

Возвращает

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

withMaxAge()source public

withMaxAge( integer $seconds )

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

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

Параметры

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

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

Возвращает

Cake\Http\Response

withModified()source public

withModified( string|DateTime $time )

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

Примеры:

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

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

Параметры

строка|DateTime $time

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

Возвращает

Cake\Http\Response

withMustRevalidate()source public

withMustRevalidate( boolean $enable )

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

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

Параметры

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

Если значение 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.

Параметры

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

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

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

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

Возвращает

Cake\Http\Response

withSharedMaxAge()source public

withSharedMaxAge( integer $seconds )

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

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

Параметры

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

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

Возвращает

Cake\Http\Response

withStatus()source public

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

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

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

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

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

Параметры

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

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

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

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

Возвращает

Cake\Http\Response

Исключения

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

Ссылка

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

withStringBody()source public

withStringBody( string $string )

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

Параметры

строка $string

Строка, которая должна быть отправлена

Возвращает

Cake\Http\Response

withType()source public

withType( string $contentType )

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

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

Параметры

строка $contentType

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

Возвращает

Cake\Http\Response

withVary()source public

withVary( string|array $cacheVariances )

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

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

Параметры

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

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

Возвращает

Cake\Http\Response

[]

'UTF-8'

'text/html'

null

[]

[
    'html' => ['text/html', '*/*'],
    'json' => 'application/json',
    'xml' => ['application/xml', 'text/xml'],
    'xhtml' => ['application/xhtml+xml', 'application/xhtml', 'text/xhtml'],
    'webp' => 'image/webp',
    'rss' => 'application/rss+xml',
    'ai' => 'application/postscript',
    'bcpio' => 'application/x-bcpio',
    'bin' => 'application/octet-stream',
    'ccad' => 'application/clariscad',
    'cdf' => 'application/x-netcdf',
    'class' => 'application/octet-stream',
    'cpio' => 'application/x-cpio',
    'cpt' => 'application/mac-compactpro',
    'csh' => 'application/x-csh',
    'csv' => ['text/csv', 'application/vnd.ms-excel'],
    'dcr' => 'application/x-director',
    'dir' => 'application/x-director',
    'dms' => 'application/octet-stream',
    'doc' => 'application/msword',
    'docx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
    'drw' => 'application/drafting',
    'dvi' => 'application/x-dvi',
    'dwg' => 'application/acad',
    'dxf' => 'application/dxf',
    'dxr' => 'application/x-director',
    'eot' => 'application/vnd.ms-fontobject',
    'eps' => 'application/postscript',
    'exe' => 'application/octet-stream',
    'ez' => 'application/andrew-inset',
    'flv' => 'video/x-flv',
    'gtar' => 'application/x-gtar',
    'gz' => 'application/x-gzip',
    'bz2' => 'application/x-bzip',
    '7z' => 'application/x-7z-compressed',
    'hdf' => 'application/x-hdf',
    'hqx' => 'application/mac-binhex40',
    'ico' => 'image/x-icon',
    'ips' => 'application/x-ipscript',
    'ipx' => 'application/x-ipix',
    'js' => 'application/javascript',
    'jsonapi' => 'application/vnd.api+json',
    'latex' => 'application/x-latex',
    'lha' => 'application/octet-stream',
    'lsp' => 'application/x-lisp',
    'lzh' => 'application/octet-stream',
    'man' => 'application/x-troff-man',
    'me' => 'application/x-troff-me',
    'mif' => 'application/vnd.mif',
    'ms' => 'application/x-troff-ms',
    'nc' => 'application/x-netcdf',
    'oda' => 'application/oda',
    'otf' => 'font/otf',
    'pdf' => 'application/pdf',
    'pgn' => 'application/x-chess-pgn',
    'pot' => 'application/vnd.ms-powerpoint',
    'pps' => 'application/vnd.ms-powerpoint',
    'ppt' => 'application/vnd.ms-powerpoint',
    'pptx' => 'application/vnd.openxmlformats-officedocument.presentationml.presentation',
    'ppz' => 'application/vnd.ms-powerpoint',
    'pre' => 'application/x-freelance',
    'prt' => 'application/pro_eng',
    'ps' => 'application/postscript',
    'roff' => 'application/x-troff',
    'scm' => 'application/x-lotusscreencam',
    'set' => 'application/set',
    'sh' => 'application/x-sh',
    'shar' => 'application/x-shar',
    'sit' => 'application/x-stuffit',
    'skd' => 'application/x-koan',
    'skm' => 'application/x-koan',
    'skp' => 'application/x-koan',
    'skt' => 'application/x-koan',
    'smi' => 'application/smil',
    'smil' => 'application/smil',
    'sol' => 'application/solids',
    'spl' => 'application/x-futuresplash',
    'src' => 'application/x-wais-source',
    'step' => 'application/STEP',
    'stl' => 'application/SLA',
    'stp' => 'application/STEP',
    'sv4cpio' => 'application/x-sv4cpio',
    'sv4crc' => 'application/x-sv4crc',
    'svg' => 'image/svg+xml',
    'svgz' => 'image/svg+xml',
    'swf' => 'application/x-shockwave-flash',
    't' => 'application/x-troff',
    'tar' => 'application/x-tar',
    'tcl' => 'application/x-tcl',
    'tex' => 'application/x-tex',
    'texi' => 'application/x-texinfo',
    'texinfo' => 'application/x-texinfo',
    'tr' => 'application/x-troff',
    'tsp' => 'application/dsptype',
    'ttc' => 'font/ttf',
    'ttf' => 'font/ttf',
    'unv' => 'application/i-deas',
    'ustar' => 'application/x-ustar',
    'vcd' => 'application/x-cdlink',
    'vda' => 'application/vda',
    'xlc' => 'application/vnd.ms-excel',
    'xll' => 'application/vnd.ms-excel',
    'xlm' => 'application/vnd.ms-excel',
    'xls' => 'application/vnd.ms-excel',
    'xlsx' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
    'xlw' => 'application/vnd.ms-excel',
    'zip' => 'application/zip',
    'aif' => 'audio/x-aiff',
    'aifc' => 'audio/x-aiff',
    'aiff' => 'audio/x-aiff',
    'au' => 'audio/basic',
    'kar' => 'audio/midi',
    'mid' => 'audio/midi',
    'midi' => 'audio/midi',
    'mp2' => 'audio/mpeg',
    'mp3' => 'audio/mpeg',
    'mpga' => 'audio/mpeg',
    'ogg' => 'audio/ogg',
    'oga' => 'audio/ogg',
    'spx' => 'audio/ogg',
    'ra' => 'audio/x-realaudio',
    'ram' => 'audio/x-pn-realaudio',
    'rm' => 'audio/x-pn-realaudio',
    'rpm' => 'audio/x-pn-realaudio-plugin',
    'snd' => 'audio/basic',
    'tsi' => 'audio/TSP-audio',
    'wav' => 'audio/x-wav',
    'aac' => 'audio/aac',
    'asc' => 'text/plain',
    'c' => 'text/plain',
    'cc' => 'text/plain',
    'css' => 'text/css',
    'etx' => 'text/x-setext',
    'f' => 'text/plain',
    'f90' => 'text/plain',
    'h' => 'text/plain',
    'hh' => 'text/plain',
    'htm' => ['text/html', '*/*'],
    'ics' => 'text/calendar',
    'm' => 'text/plain',
    'rtf' => 'text/rtf',
    'rtx' => 'text/richtext',
    'sgm' => 'text/sgml',
    'sgml' => 'text/sgml',
    'tsv' => 'text/tab-separated-values',
    'tpl' => 'text/template',
    'txt' => 'text/plain',
    'text' => 'text/plain',
    'avi' => 'video/x-msvideo',
    'fli' => 'video/x-fli',
    'mov' => 'video/quicktime',
    'movie' => 'video/x-sgi-movie',
    'mpe' => 'video/mpeg',
    'mpeg' => 'video/mpeg',
    'mpg' => 'video/mpeg',
    'qt' => 'video/quicktime',
    'viv' => 'video/vnd.vivo',
    'vivo' => 'video/vnd.vivo',
    'ogv' => 'video/ogg',
    'webm' => 'video/webm',
    'mp4' => 'video/mp4',
    'm4v' => 'video/mp4',
    'f4v' => 'video/mp4',
    'f4p' => 'video/mp4',
    'm4a' => 'audio/mp4',
    'f4a' => 'audio/mp4',
    'f4b' => 'audio/mp4',
    'gif' => 'image/gif',
    'ief' => 'image/ief',
    'jpg' => 'image/jpeg',
    'jpeg' => 'image/jpeg',
    'jpe' => 'image/jpeg',
    'pbm' => 'image/x-portable-bitmap',
    'pgm' => 'image/x-portable-graymap',
    'png' => 'image/png',
    'pnm' => 'image/x-portable-anymap',
    'ppm' => 'image/x-portable-pixmap',
    'ras' => 'image/cmu-raster',
    'rgb' => 'image/x-rgb',
    'tif' => 'image/tiff',
    'tiff' => 'image/tiff',
    'xbm' => 'image/x-xbitmap',
    'xpm' => 'image/x-xpixmap',
    'xwd' => 'image/x-xwindowdump',
    'psd' => ['application/photoshop', 'application/psd', 'image/psd', 'image/x-photoshop', 'image/photoshop', 'zz-application/zz-winassoc-psd'],
    'ice' => 'x-conference/x-cooltalk',
    'iges' => 'model/iges',
    'igs' => 'model/iges',
    'mesh' => 'model/mesh',
    'msh' => 'model/mesh',
    'silo' => 'model/mesh',
    'vrml' => 'model/vrml',
    'wrl' => 'model/vrml',
    'mime' => 'www/mime',
    'pdb' => 'chemical/x-pdb',
    'xyz' => 'chemical/x-pdb',
    'javascript' => 'application/javascript',
    'form' => 'application/x-www-form-urlencoded',
    'file' => 'multipart/form-data',
    'xhtml-mobile' => 'application/vnd.wap.xhtml+xml',
    'atom' => 'application/atom+xml',
    'amf' => 'application/x-amf',
    'wap' => ['text/vnd.wap.wml', 'text/vnd.wap.wmlscript', 'image/vnd.wap.wbmp'],
    'wml' => 'text/vnd.wap.wml',
    'wmlscript' => 'text/vnd.wap.wmlscript',
    'wbmp' => 'image/vnd.wap.wbmp',
    'woff' => 'application/x-font-woff',
    'appcache' => 'text/cache-manifest',
    'manifest' => 'text/cache-manifest',
    'htc' => 'text/x-component',
    'rdf' => 'application/xml',
    'crx' => 'application/x-chrome-extension',
    'oex' => 'application/x-opera-extension',
    'xpi' => 'application/x-xpinstall',
    'safariextz' => 'application/octet-stream',
    'webapp' => 'application/x-web-app-manifest+json',
    'vcf' => 'text/x-vcard',
    'vtt' => 'text/vtt',
    'mkv' => 'video/x-matroska',
    'pkpass' => 'application/vnd.apple.pkpass',
    'ajax' => 'text/html'
]

'HTTP/1.1'

'OK'

200

[
    100 => 'Continue',
    101 => 'Switching Protocols',
    102 => 'Processing',
    200 => 'OK',
    201 => 'Created',
    202 => 'Accepted',
    203 => 'Non-Authoritative Information',
    204 => 'No Content',
    205 => 'Reset Content',
    206 => 'Partial Content',
    207 => 'Multi-status',
    208 => 'Already Reported',
    226 => 'IM used',
    300 => 'Multiple Choices',
    301 => 'Moved Permanently',
    302 => 'Found',
    303 => 'See Other',
    304 => 'Not Modified',
    305 => 'Use Proxy',
    306 => '(Unused)',
    307 => 'Temporary Redirect',
    308 => 'Permanent Redirect',
    400 => 'Bad Request',
    401 => 'Unauthorized',
    402 => 'Payment Required',
    403 => 'Forbidden',
    404 => 'Not Found',
    405 => 'Method Not Allowed',
    406 => 'Not Acceptable',
    407 => 'Proxy Authentication Required',
    408 => 'Request Timeout',
    409 => 'Conflict',
    410 => 'Gone',
    411 => 'Length Required',
    412 => 'Precondition Failed',
    413 => 'Request Entity Too Large',
    414 => 'Request-URI Too Large',
    415 => 'Unsupported Media Type',
    416 => 'Requested range not satisfiable',
    417 => 'Expectation Failed',
    418 => 'I\'m a teapot',
    421 => 'Misdirected Request',
    422 => 'Unprocessable Entity',
    423 => 'Locked',
    424 => 'Failed Dependency',
    425 => 'Unordered Collection',
    426 => 'Upgrade Required',
    428 => 'Precondition Required',
    429 => 'Too Many Requests',
    431 => 'Request Header Fields Too Large',
    444 => 'Connection Closed Without Response',
    451 => 'Unavailable For Legal Reasons',
    499 => 'Client Closed Request',
    500 => 'Internal Server Error',
    501 => 'Not Implemented',
    502 => 'Bad Gateway',
    503 => 'Service Unavailable',
    504 => 'Gateway Timeout',
    505 => 'Unsupported Version',
    506 => 'Variant Also Negotiates',
    507 => 'Insufficient Storage',
    508 => 'Loop Detected',
    510 => 'Not Extended',
    511 => 'Network Authentication Required',
    599 => 'Network Connect Timeout Error',
]

'wb+'

'php://memory'