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

_setCookies()source protected

_setCookies( )

Устанавливает файлы cookie, которые были добавлены с помощью Cake\Http\Response::cookie() перед отправкой любого другого вывода клиенту. Файлы 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() и getBody() вместо этого.

Параметры

строка|вызываемый объект|null $content необязательно 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

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

Возвращает

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

compress()source public

compress( )

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

Возвращает

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

Возвращает

массив

cookie()source public

cookie( array|null $options null )

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

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

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

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

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

Примеры

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

$this->cookie()

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

$this->cookie('MyCookie')

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

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

Устарело

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

Параметры

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

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

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

логическое значение $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( )

Получить все 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'

Параметры

string $alias

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

Возвращает

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

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
Код состояния.

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

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

Возвращает

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

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

Параметры

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

Параметры

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

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

Возвращает

массив|null

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.

Параметры

• name: Название 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

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

Возвращает

Cake\Http\Response

withExpiredCookie()source public

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

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

Параметры

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

Примеры

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

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

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

Параметры

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

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

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

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

Возвращает

Cake\Http\Response

withExpires()source public

withExpires( string|DateTime $time )

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

Примеры:

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

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

Параметры

строка|DateTime $time

Действительная строка времени или объект DateTime.

Возвращает

Cake\Http\Response

withFile()source public

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

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

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

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

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

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

Параметры

строка $path

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

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

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

Возвращает

Cake\Http\Response

Выбрасывает

Cake\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 указывает, что ответ не должен быть предоставлен кешем в устаревшем состоянии при каких-либо обстоятельствах без предварительной проверки с источником.

Параметры

boolean $enable

Если boolean, устанавливает или отключает направление.

Возвращает

Cake\Http\Response

withNotModified()source public

withNotModified( )

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

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

Возвращает

Cake\Http\Response

withSharable()source public

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

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

Параметры

boolean $public

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

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

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

Возвращает

Cake\Http\Response

withSharedMaxAge()source public

withSharedMaxAge( integer $seconds )

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

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

Параметры

integer $seconds

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

Возвращает

Cake\Http\Response

withStatus()source public

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

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

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

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

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

Параметры

integer $code

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

string $reasonPhrase необязательно ''

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

Возвращает

Cake\Http\Response

Исключения

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

Ссылка

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

withStringBody()source public

withStringBody( string $string )

Метод-обёртка для установки строки в тело ответа

Параметры

string $string

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

Возвращает

Cake\Http\Response

withType()source public

withType( string $contentType )

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

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

Параметры

string $contentType

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

Возвращает

Cake\Http\Response

withVary()source public

withVary( string|array $cacheVariances )

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

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

Параметры

string|array $cacheVariances

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

Возвращает

Cake\Http\Response