Класс 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: кодировка символов для тела ответа

Выбрасывает

InvalidArgumentException

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

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

Параметры

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

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

Возвращает

DateTimeInterface

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

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

_setStatus()source protected

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

Модификатор для статуса ответа

Параметры

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

Код для установки.

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

Фраза причины ответа.

Исключения

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

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

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

Устаревший

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

Параметры

строка|целое число|DateTimeInterface|null $since

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

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

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

Исключения

InvalidArgumentException

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' (Etags) и 'If-Modified-Since' (дата последнего изменения). Если ответ обнаруживается не изменённым, он отмечается соответствующим образом, чтобы клиент об этом знал.

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

Предупреждение Этот метод изменяет ответ на месте и следует избегать его использования.

Параметры

Cake\Http\ServerRequest $request

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

Возвращает

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

compress()source public

compress( )

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

Возвращает

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

convertCookieToArray()source protected

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

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

Этот метод совместим с историческим поведением 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

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

Возвращает

mixed

cors()source public

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

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

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

Полный URI

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

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

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

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

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

Любой URI

cors($request, '*');

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

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

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

Параметры

Cake\Http\ServerRequest $request

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

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

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

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

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

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

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

Возвращает

Cake\Http\CorsBuilder

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

disableCache()source public устаревший

disableCache( )

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

Устаревший

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

download()source public устаревший

download( string $filename )

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

Устаревший

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

Параметры

строка $filename

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

etag()source public deprecated

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

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

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

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

Устаревшее

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

Параметры

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

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

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

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

Возвращает

string|null

expires()source public deprecated

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

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

Примеры:

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

Устаревшее

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

Параметры

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

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

Возвращает

string|null

file()source public deprecated

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

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

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

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

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

Устаревшее

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

Параметры

string $path

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

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

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

Исключения

Cake\Http\Exception\NotFoundException

getCharset()source public

getCharset( )

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

Возвращает

string

getCookie()source public

getCookie( string $name )

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

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

Параметры

string $name

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

Возвращает

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

getCookieCollection()source public

getCookieCollection( )

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

Возвращает

Cake\Http\Cookie\CookieCollection

getCookies()source public

getCookies( )

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

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

Возвращает

array

getFile()source public

getFile( )

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

Возвращает

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

getMimeType()source public

getMimeType( string $alias )

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

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

Параметры

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

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

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

Возвращает

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

getType()source public

getType( )

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

Возвращает

string

header()source public deprecated

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

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

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

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

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

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

Строковый заголовок

header('WWW-Authenticate: Negotiate');

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

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

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

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

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

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

Устаревшее

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

Параметры

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

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

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

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

Возвращает

array
Список заголовков, которые будут отправлены

httpCodes()source public deprecated

httpCodes( integer|array|null $code = null )

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

Устарело

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

Параметры

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

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

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

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

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

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

Возвращает

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

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

Исключения

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

length()source public deprecated

length( integer|null $bytes = null )

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

Устарело

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

Параметры

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

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

Возвращает

строка|null

location()source public deprecated

location( null|string $url = null )

Доступ к заголовку location.

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

Устарело

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

Параметры

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

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

Возвращает

строка|null

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

mapType()source public

mapType( string|array $ctype )

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

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

Параметры

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

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

Возвращает

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

maxAge()source public deprecated

maxAge( integer|null $seconds = null )

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

Устарело

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

Параметры

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

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

Возвращает

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

modified()source public deprecated

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

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

Примеры:

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

Устарело

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

Параметры

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

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

Возвращает

строка|null

mustRevalidate()source public deprecated

mustRevalidate( boolean|null $enable = null )

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

Устарело

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

Параметры

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

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

Возвращает

boolean

notModified()source public

notModified( )

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

Предупреждение Этот метод изменяет ответ на месте и следует избегать.

outputCompressed()source public

outputCompressed( )

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

Возвращает

boolean

protocol()source public deprecated

protocol( string|null $protocol = null )

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

Устарело

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

Параметры

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

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

Возвращает

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

resolveType()source protected

resolveType( string $contentType )

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

Параметры

строка $contentType

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

Возвращает

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

Исключения

InvalidArgumentException
При использовании недопустимого типа содержимого или псевдонима.

sendHeaders()source public deprecated

sendHeaders( )

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

Устарело

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

setTypeMap()source public

setTypeMap( string $type , string|array $mimeType )

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

Например: setTypeMap('xhtml', ['application/xhtml+xml', 'application/xhtml'])

Это необходимо для RequestHandlerComponent и распознавания типов.

Параметры

строка $type

Тип содержимого.

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

Определение MIME-типа.

sharable()source public

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

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

Параметры

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

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

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

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

Возвращает

boolean|null

sharedMaxAge()source public deprecated

sharedMaxAge( integer|null $seconds = null )

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

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

Устарело

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

Параметры

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

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

Возвращает

integer|null

statusCode()source public deprecated

statusCode( integer|null $code = null )

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

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

Устарело

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

Параметры

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

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

Возвращает

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

Выбрасывает

InvalidArgumentException
При достижении неизвестного кода состояния.

stop()source public deprecated

stop( integer|string $status = 0 )

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

Устарело

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

Параметры

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

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

type()source public deprecated

type( string|array|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|array|null $contentType необязательно null

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

Возвращает

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

validateFile()source protected

validateFile( string $path )

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

Параметры

string $path

Путь к файлу.

Возвращает

Cake\Filesystem\File

Выбрасывает

Cake\Http\Exception\NotFoundException

vary()source public deprecated

vary( string|array|null $cacheVariances = null )

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

Устарело

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

Параметры

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

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

Возвращает

array|null

withAddedLink()source public

withAddedLink( string $url , array $options = [] )

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

Примеры

$response = $response->withAddedLink('http://example.com?page=1', ['rel' => 'prev'])
    ->withAddedLink('http://example.com?page=3', ['rel' => 'next']);

Сгенерирует:

Link: <http://example.com?page=1>; rel="prev"
Link: <http://example.com?page=3>; rel="next"

Параметры

string $url

Ссылка LinkHeader.

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

Параметры LinkHeader.

Возвращает

Cake\Http\Response

С версии

3.6.0

withCache()source public

withCache( string|integer|DateTimeInterface|null $since , string|integer $time = '+1 day' )

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

Параметры

string|integer|DateTimeInterface|null $since

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

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

Время истечения кэша

Возвращает

Cake\Http\Response

Выбрасывает

InvalidArgumentException

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

withCookieCollection()source public

withCookieCollection( Cake\Http\Cookie\CookieCollection $cookieCollection )

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

Параметры

Cake\Http\Cookie\CookieCollection $cookieCollection

Коллекция 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 = [] )

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

Параметры

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

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

Примеры:

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

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

Параметры

строка|целое число|DateTimeInterface|null $time

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

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

Cake\Http\Response

withFile()source public

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

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

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

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

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

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

Параметры

строка $path

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

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

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

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

Cake\Http\Response

Исключения

Cake\Http\Exception\NotFoundException

withLength()source public

withLength( integer|string $bytes )

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

Параметры

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

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

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

Cake\Http\Response

withLocation()source public

withLocation( string $url )

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

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

Параметры

строка $url

Место перенаправления.

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

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

withMaxAge()source public

withMaxAge( integer $seconds )

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

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

Параметры

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

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

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

Cake\Http\Response

withModified()source public

withModified( string|integer|DateTimeInterface|null $time )

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

Примеры:

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

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

Параметры

строка|целое число|DateTimeInterface|null $time

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

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

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.

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

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

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

Cake\Http\Response

withSharedMaxAge()source public

withSharedMaxAge( integer $seconds )

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

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

Параметры

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

Число секунд для shared 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