Класс Response

send()source public

send( )

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

Возвращает

$this

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

Cake\Http\Response::send()

__construct()source public

__construct( array $options [] )

Конструктор

Параметры

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

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

__debugInfo()source public

__debugInfo( )

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

Возвращает

массив

__toString()source public

__toString( )

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

Возвращает

строка

_clearBuffer()source protected

_clearBuffer( )

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

Устарело

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

Возвращает

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

_clearHeader()source protected

_clearHeader( string $header )

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

Параметры

строка $header

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

_createStream()source protected

_createStream( )

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

_fileRange()source protected

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

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

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

Устарело

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

Параметры

Cake\Filesystem\File $file

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

строка $httpRange

Используемый диапазон.

_flushBuffer()source protected

_flushBuffer( )

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

Устарело

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

_getUTCDate()source protected

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

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

Параметры

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

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

Возвращает

DateTime

_handleCallableBody()source protected

_handleCallableBody( callable $content )

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

Параметры

вызываемая функция $content

Вызываемая функция содержимого.

Возвращает

строка

_isActive()source protected

_isActive( )

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

Устарело

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

Возвращает

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

_sendContent()source protected

_sendContent( string|callable $content )

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

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

Устарело

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

Параметры

строка|вызываемая функция $content

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

_sendFile()source protected

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

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

Устарело

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

Параметры

Cake\Filesystem\File $file

Объект файла

массив $range

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

Возвращает

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

_sendHeader()source protected

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

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

Устарело

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

Параметры

строка $name

имя заголовка

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

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

_setCacheControl()source protected

_setCacheControl( )

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

_setContent()source protected

_setContent( )

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

Устарело

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

_setContentType()source protected

_setContentType( )

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

_setCookies()source protected

_setCookies( )

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

Устарело

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

_setHeader()source protected

_setHeader( string $header , string $value )

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

Параметры

строка $header

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

строка $value

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

body()source public

body( string|callable|null $content null )

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

Устарело

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

Параметры

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

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

Возвращает

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

cache()source public

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

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

Устарело

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

Параметры

строка $since

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

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

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

charset()source public

charset( string|null $charset null )

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

Устарело

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

Параметры

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

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

Возвращает

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

checkNotModified()source public

checkNotModified( Cake\Http\ServerRequest $request )

Проверяет, не был ли ответ изменён в соответствии с заголовками запроса 'If-None-Match' (Etag) и 'If-Modified-Since' (дата последнего изменения). Если обнаруживается, что ответ не был изменён, он помечается как такой, чтобы об этом мог быть проинформирован клиент.

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

Параметры

Cake\Http\ServerRequest $request

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

Возвращает

boolean
Помечался ли ответ как не изменённый или нет.

compress()source public

compress( )

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

Возвращает

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

convertCookieToArray()source protected

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

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

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

Параметры

Cake\Http\Cookie\CookieInterface $cookie

Объект куки.

Возвращает

массив

cookie()source public

cookie( array|null $options null )

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

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

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

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

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

Примеры

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

$this->cookie()

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

$this->cookie('MyCookie')

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

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

Устарело

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

Параметры

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

Either null to get all cookies, string for a specific cookie or array to set cookie.

Возвращает

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

cors()source public

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

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

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

Полный URI

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

URI со звездочкой

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

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

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

Любой URI

cors($request, '*');

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

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

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

Параметры

Cake\Http\ServerRequest $request

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

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

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

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

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

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

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

Возвращает

Cake\Network\CorsBuilder

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

disableCache()source public

disableCache( )

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

Устарело

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

download()source public

download( string $filename )

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

Устарело

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

Параметры

строка $filename

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

etag()source public

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

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

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

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

Устарело

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

Параметры

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

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

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

Параметры

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

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

Возвращает

string|null

file()source public

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

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

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

Ключи опций

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

Устаревший

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

Параметры

string $path

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

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

Опции, см. выше.

Выбрасывает

Cake\Network\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( )

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

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

Возвращает

array

getFile()source public

getFile( )

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

Возвращает

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

getMimeType()source public

getMimeType( string $alias )

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

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

Параметры

string $alias

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

Возвращает

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

getReasonPhrase()source public

getReasonPhrase( )

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

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

Возвращает

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

Ссылка

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

getSimpleHeaders()source protected

getSimpleHeaders( )

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

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

Возвращает

array

getStatusCode()source public

getStatusCode( )

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

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

Возвращает

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

getType()source public

getType( )

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

Возвращает

string

header()source public

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. При чтении расположения возвращается строка с текущим значением заголовка Location (если таковой имеется).

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

sendHeaders()source public

sendHeaders( )

Отправка HTTP-заголовков и файлов cookie.

Устаревшее

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( string|null $contentType null )

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

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

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

Параметры

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

Примеры

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

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

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

Параметры

string|Cake\Http\Cookie\Cookie $name

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

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

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

Возвращает

Cake\Http\Response

withDisabledCache()source public

withDisabledCache( )

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

Возвращает

Cake\Http\Response

withDownload()source public

withDownload( string $filename )

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

Параметры

string $filename

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

Возвращает

Cake\Http\Response

withEtag()source public

withEtag( string $hash , boolean $weak false )

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

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

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

Параметры

string $hash

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

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

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

Возвращает

Cake\Http\Response

withExpiredCookie()source public

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

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

Параметры

string|Cake\Http\Cookie\CookieInterface $name

Имя cookie для истечения, или объект cookie

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

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

Возвращает

Cake\Http\Response

withExpires()source public

withExpires( string|DateTime $time )

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

Примеры:

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

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

Параметры

string|DateTime $time

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

Возвращает

Cake\Http\Response

withFile()source public

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

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

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

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

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

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

Параметры

string $path

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

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

Опции, см. выше.

Возвращает

Cake\Http\Response

Выбрасывает

Cake\Network\Exception\NotFoundException

withLength()source public

withLength( integer|string $bytes )

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

Параметры

integer|string $bytes

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

Возвращает

Cake\Http\Response

withLocation()source public

withLocation( string $url )

Возвращает экземпляр с обновленным заголовком location.

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

Параметры

string $url

Адрес переадресации.

Возвращает

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

withMaxAge()source public

withMaxAge( integer $seconds )

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

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

Параметры

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

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

Возвращает

Cake\Http\Response

withModified()source public

withModified( string|DateTime $time )

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

Примеры:

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

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

Параметры

строка|DateTime $time

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

Возвращает

Cake\Http\Response

withMustRevalidate()source public

withMustRevalidate( boolean $enable )

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

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

Параметры

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

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

Возвращает

Cake\Http\Response

withNotModified()source public

withNotModified( )

Создать новый экземпляр как «не изменённый»

Это удалит любые содержимое тела, установит код состояния «304» и удалит заголовки, описывающие тело ответа.

Возвращает

Cake\Http\Response

withSharable()source public

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

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

Параметры

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

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

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

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

Возвращает

Cake\Http\Response

withSharedMaxAge()source public

withSharedMaxAge( integer $seconds )

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

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

Параметры

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

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

Возвращает

Cake\Http\Response

withStatus()source public

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

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

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

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

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

Параметры

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

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

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