Класс
RequestHandlerComponent

Обработка объекта запроса для альтернативных HTTP-запросов.

Этот компонент проверяет запросы на различные типы контента, такие как JSON, XML, XMLHttpRequest(AJAX), и соответствующим образом настраивает объект ответа и строитель представления.

Он также может проверять заголовки HTTP-кэширования, такие как Last-Modified, If-Modified-Since и т.д., и возвращать ответ соответствующим образом.

Пространство имен: Cake\Controller\Component
Устарело: 4.4.0 См. руководство по миграции 4.4, чтобы узнать, как обновить. https://book.cakephp.org/4/en/appendices/4-4-migration-guide.html#requesthandlercomponent
Ссылка: https://book.cakephp.org/4/en/controllers/components/request-handling.html

Краткое описание полей

$_componentMap protected

array<string, array>

Таблица поиска компонентов, используемая для ленивой загрузки объектов компонентов.
$_config protected

array<string, mixed>

Настройки во время выполнения
$_configInitialized protected

bool

Было ли свойство конфигурации уже настроено с параметрами по умолчанию
$_defaultConfig protected

array<string, mixed>

Настройки по умолчанию
$_registry protected

Cake\Controller\ComponentRegistry

Класс реестра компонентов, используемый для ленивой загрузки компонентов.
$_renderType protected

string|null

Тип шаблона, который нужно использовать при отображении заданного типа контента.
$components protected

array

Другие компоненты, используемые этим компонентом.
$ext protected

string|null

Содержит расширение файла, извлеченное маршрутизатором

Краткое описание методов

__construct() public

Конструктор. Разбирает типы контента, принимаемые клиентом, используя HTTP_ACCEPT
__debugInfo() public

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

Магический метод для ленивой загрузки $components.
_configDelete() protected

Удаляет один ключ конфигурации.
_configRead() protected

Читает ключ конфигурации.
_configWrite() protected

Записывает ключ конфигурации.
_setExtension() protected

Устанавливает расширение на основе заголовка Accept или расширения URL.
accepts() public deprecated

Определяет, какие типы контента принимает клиент. Приемлемость основана на расширении файла, разобранном маршрутизатором (если есть), и на заголовке HTTP_ACCEPT. В отличие от {@link \Cake\Http\ServerRequest::accepts()} этот метод полностью обрабатывает сопоставленные типы контента.
beforeRender() public

Проверяет, можно ли считать ответ отличным в соответствии с заголовками запроса и заголовками кэшированного ответа. Если он не был изменен, то процесс отображения пропускается. И клиент получит пустой ответ с заголовком "304 Not Modified".
configShallow() public

Объединяет предоставленную конфигурацию с существующей конфигурацией. В отличие от config(), который выполняет рекурсивное слияние для вложенных ключей, этот метод выполняет простое слияние.
getConfig() public

Возвращает конфигурацию.
getConfigOrFail() public

Возвращает конфигурацию для этого конкретного ключа.
getController() public

Получить контроллер, к которому привязан этот компонент.
implementedEvents() public

События, поддерживаемые этим компонентом.
initialize() public

Метод-хук конструктора.
log() public

Удобный метод для записи сообщения в Log. См. Log::write() для получения дополнительной информации о записи в журналы.
mapAlias() public

Сопоставляет псевдоним типа контента с его типом(ами) mime.
prefers() public deprecated

Определяет, какие типы контента предпочитает клиент. Если параметры не указаны, возвращается один тип контента, который клиент, скорее всего, предпочитает. Если $type является массивом, возвращается первый элемент массива, который принимает клиент. Предпочтение определяется в первую очередь расширением файла, разобранным маршрутизатором, если оно предоставлено, и во вторую очередь списком типов контента, указанных в HTTP_ACCEPT.
renderAs() public

Устанавливает либо класс представления, если он существует, либо путь к макету и шаблону представления. Их имена выводятся из входного параметра $type.
requestedWith() public

Определяет тип контента данных, отправленных клиентом (т.е. в POST-запросе)
respondAs() public

Устанавливает заголовок ответа на основе имени индекса карты типов. Это оборачивает несколько методов, доступных в {@link \Cake\Http\Response}. Это также позволяет использовать псевдонимы Content-Type.
setConfig() public

Устанавливает конфигурацию.
startup() public

Метод запуска RequestHandler включает в себя несколько автоматических функций, связанных с обнаружением определенных свойств HTTP-запроса, включая:

Краткое описание методов

__construct() public

__construct(Cake\Controller\ComponentRegistry $registry, array<string, mixed> $config = [])

Конструктор. Разбирает принимаемые типы контента, принимаемые клиентом, используя HTTP_ACCEPT

Параметры

Cake\Controller\ComponentRegistry $registry: Объект ComponentRegistry.
array<string, mixed> $config optional: Массив конфигурации.

__debugInfo() public

__debugInfo(): array<string, mixed>

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

Возвращает

array<string, mixed>

__get() public

__get(string $name): Cake\Controller\Component|null

Магический метод для ленивой загрузки $components.

Параметры

string $name: Имя компонента для получения.

Возвращает

Cake\Controller\Component|null

_configDelete() protected

_configDelete(string $key): void

Удаляет один ключ конфигурации.

Параметры

string $key: Ключ для удаления.

Возвращает

void

Выбрасывает

Cake\Core\Exception\CakeException
если пытается перезаписать существующую конфигурацию

_configRead() protected

_configRead(string|null $key): mixed

Читает ключ конфигурации.

Параметры

string|null $key: Ключ для чтения.

Возвращает

mixed

_configWrite() protected

_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void

Записывает ключ конфигурации.

Параметры

array<string, mixed>|string $key: Ключ для записи.
mixed $value: Значение для записи.
string|bool $merge optional: True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Возвращает

void

Выбрасывает

Cake\Core\Exception\CakeException
если пытается перезаписать существующую конфигурацию

_setExtension() protected

_setExtension(Cake\Http\ServerRequest $request, Cake\Http\Response $response): void

Устанавливает расширение на основе заголовка Accept или расширения URL.

Сравнивает принятые типы и настроенные расширения. Если есть один общий тип, он назначается в качестве типа ext/content для ответа. Будет установлен тип с наивысшим весом. Если наивысший вес имеет более одного типа, соответствующего расширениям, порядок, в котором указаны расширения, определяет, какой тип будет установлен.

Если html является одним из предпочтительных типов, тип контента устанавливаться не будет, это предотвращает проблемы с браузерами, которые предпочитают HTML и несколько других типов контента.

Параметры

Cake\Http\ServerRequest $request: Экземпляр запроса.
Cake\Http\Response $response: Экземпляр ответа.

Возвращает

void

accepts() public

accepts(array<string>|string|null $type = null): array|bool|string|null

Определяет, какие типы контента принимает клиент. Прием основан на расширении файла, разобранном маршрутизатором (если оно присутствует), и на заголовке HTTP_ACCEPT. В отличие от {@link \Cake\Http\ServerRequest::accepts()} этот метод работает исключительно с сопоставленными типами контента.

Использование:

$this->RequestHandler->accepts(['xml', 'html', 'json']);

Возвращает true, если клиент принимает любой из указанных типов.

$this->RequestHandler->accepts('xml');

Возвращает true, если клиент принимает XML.

Параметры

array<string>|string|null $type optional: Может быть null (или без параметра), строковым именем типа или массивом типов

Возвращает

array|bool|string|null

beforeRender() public

beforeRender(Cake\Event\EventInterface $event): void

Проверяет, можно ли считать ответ отличным в соответствии с заголовками запроса и заголовками кэшированного ответа. Если он не был изменен, то процесс рендеринга пропускается. И клиент получит пустой ответ с заголовком "304 Not Modified".

Если включен Router::extensions(), тип макета и шаблона переключаются в зависимости от разобранного расширения или заголовка Accept. Например, если запрашивается controller/action.xml, путь к представлению становится templates/Controller/xml/action.php. Кроме того, если controller/action запрашивается с Accept: application/xml в заголовках, путь к представлению станет templates/Controller/xml/action.php. Типы макетов и шаблонов будут переключаться только на типы mime, распознаваемые \Cake\Http\Response. Если вам нужно объявить дополнительные типы mime, вы можете сделать это с помощью {@link \Cake\Http\Response::setTypeMap()} в методе beforeFilter() вашего контроллера.
Если существует вспомогательный элемент с тем же именем, что и расширение, он добавляется к контроллеру.
Если расширение имеет тип, который понимает RequestHandler, он установит этот тип Content-type в заголовке ответа.

Параметры

Cake\Event\EventInterface $event: Событие Controller.beforeRender.

Возвращает

void

Выбрасывает

Cake\Http\Exception\NotFoundException
Если вызывается не настроенное расширение.

configShallow() public

configShallow(array<string, mixed>|string $key, mixed|null $value = null): $this

Слияние предоставленной конфигурации с существующей конфигурацией. В отличие от config(), который выполняет рекурсивное слияние для вложенных ключей, этот метод выполняет простое слияние.

Установка определенного значения:

$this->configShallow('key', $value);

Установка вложенного значения:

$this->configShallow('some.nested.key', $value);

Обновление нескольких параметров конфигурации одновременно:

$this->configShallow(['one' => 'value', 'another' => 'value']);

Параметры

array<string, mixed>|string $key: Ключ для установки или полный массив конфигураций.
mixed|null $value optional: Значение для установки.

Возвращает

$this

getConfig() public

getConfig(string|null $key = null, mixed $default = null): mixed

Возвращает конфигурацию.

Использование

Чтение всей конфигурации:

$this->getConfig();

Чтение конкретного значения:

$this->getConfig('key');

Чтение вложенного значения:

$this->getConfig('some.nested.key');

Чтение со значением по умолчанию:

$this->getConfig('some-key', 'default-value');

Параметры

string|null $key optional: Ключ для получения или null для всей конфигурации.
mixed $default optional: Возвращаемое значение, когда ключ не существует.

Возвращает

mixed

getConfigOrFail() public

getConfigOrFail(string $key): mixed

Возвращает конфигурацию для этого конкретного ключа.

Значение конфигурации для этого ключа должно существовать, оно никогда не может быть null.

Параметры

string $key: Ключ для получения.

Возвращает

mixed

Выбрасывает

InvalidArgumentException

getController() public

getController(): Cake\Controller\Controller

Получить контроллер, к которому привязан этот компонент.

Возвращает

Cake\Controller\Controller

implementedEvents() public

implementedEvents(): array<string, mixed>

События, поддерживаемые этим компонентом.

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

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

Возвращает

array<string, mixed>

initialize() public

initialize(array<string, mixed> $config): void

Метод хука конструктора.

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

Параметры

array<string, mixed> $config: Параметры конфигурации, предоставленные этому компоненту.

Возвращает

void

log() public

log(string $message, string|int $level = LogLevel::ERROR, array|string $context = []): bool

Вспомогательный метод для записи сообщения в лог. См. Log::write() для получения дополнительной информации о записи в журналы.

Parameters

string $message: Сообщение для лога.
string|int $level optional: Уровень ошибки.
array|string $context optional: Дополнительные данные лога, относящиеся к этому сообщению.

Returns

bool

mapAlias() public

mapAlias(array|string $alias): array|string|null

Сопоставляет псевдоним типа контента с его типом(ами) mime.

Parameters

array|string $alias: Строковый псевдоним для преобразования обратно в тип контента. Или массив псевдонимов для сопоставления.

Returns

array|string|null

prefers() public

prefers(array<string>|string|null $type = null): string|bool|null

Определяет, какие типы контента предпочитает клиент. Если параметры не указаны, возвращается единственный тип контента, который клиент, скорее всего, предпочитает. Если $type — это массив, возвращается первый элемент массива, который принимает клиент. Предпочтение определяется в первую очередь расширением файла, анализируемым маршрутизатором, если оно предоставлено, и во вторую очередь — списком типов контента, указанных в HTTP_ACCEPT.

Parameters

array<string>|string|null $type optional: Необязательный массив «дружественных» имен типов контента, например, «html», «xml», «js» и т. д.

Returns

string|bool|null

renderAs() public

renderAs(Cake\Controller\Controller $controller, string $type, array<string, mixed> $options = []): void

Устанавливает либо класс представления, если он существует, либо путь к макету и шаблону представления. Их имена выводятся из входного параметра $type.

Usage:

Отображение ответа как ответа «ajax».

$this->RequestHandler->renderAs($this, 'ajax');

Отображение ответа как XML-файла и принудительное сохранение результата как файла для загрузки.

$this->RequestHandler->renderAs($this, 'xml', ['attachment' => 'myfile.xml'];

Parameters

Cake\Controller\Controller $controller: Ссылка на объект контроллера
string $type: Тип ответа для отправки (например: «ajax»)
array<string, mixed> $options optional: Массив параметров для использования

Returns

void

requestedWith() public

requestedWith(array<string>|string|null $type = null): mixed

Определяет тип контента данных, отправленных клиентом (например, в запросе POST).

Parameters

array<string>|string|null $type optional: Может быть null (или без параметра), строковым именем типа или массивом типов

Returns

mixed

respondAs() public

respondAs(string $type, array<string, mixed> $options = []): bool

Устанавливает заголовок ответа на основе имени индекса карты типов. Это оборачивает несколько методов, доступных в {@link \Cake\Http\Response}. Это также позволяет использовать псевдонимы Content-Type.

Parameters

string $type: Дружественное имя типа, например, «html» или «xml», или полный тип контента, например, «application/x-shockwave».
array<string, mixed> $options optional: Если $type — это дружественное имя типа, которое связано с более чем одним типом контента, $index используется для выбора типа контента, который нужно использовать.

Returns

bool

setConfig() public

setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this

Устанавливает конфигурацию.

Usage

Установка конкретного значения:

$this->setConfig('key', $value);

Установка вложенного значения:

$this->setConfig('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->setConfig(['one' => 'value', 'another' => 'value']);

Parameters

array<string, mixed>|string $key: Ключ для установки или полный массив конфигураций.
mixed|null $value optional: Значение для установки.
bool $merge optional: Следует ли рекурсивно объединять или перезаписывать существующую конфигурацию, по умолчанию true.

Returns

$this

Throws

Cake\Core\Exception\CakeException
При попытке установить недопустимый ключ.

startup() public

startup(Cake\Event\EventInterface $event): void

Метод запуска RequestHandler включает несколько автоматических поведений, связанных с обнаружением определенных свойств HTTP-запроса, включая:

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

Parameters

Cake\Event\EventInterface $event: Событие запуска, которое было вызвано.

Returns

void

Краткое описание полей

`$_componentMap` protected

Таблица поиска компонентов, используемая для ленивой загрузки объектов компонентов.

Type

array<string, array>

`$_config` protected

Конфигурация во время выполнения

Type

array<string, mixed>

`$_configInitialized` protected

Было ли свойство конфигурации уже настроено с параметрами по умолчанию

Type

bool

`$_defaultConfig` protected

Конфигурация по умолчанию

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

checkHttpCache - Проверять ли HTTP-кэш. Значение по умолчанию true.
viewClassMap - Сопоставление между типом и классами представлений. Если не определено, будут сопоставлены JSON, XML и AJAX. Определение любых типов приведет к исключению значений по умолчанию.

Type

array<string, mixed>

`$_registry` protected

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

Type

Cake\Controller\ComponentRegistry

`$_renderType` protected

Тип шаблона, который нужно использовать при отрисовке заданного типа контента.

Type

string|null

`$components` protected

Другие компоненты, используемые этим компонентом.

Type

array

`$ext` protected

Содержит расширение файла, извлеченное маршрутизатором

Type

string|null

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.4/class-Cake.Controller.Component.RequestHandlerComponent.html

Класс RequestHandlerComponent

Краткое описание полей

Краткое описание методов

__construct() public

__debugInfo() public

__get() public

_configDelete() protected

_configRead() protected

_configWrite() protected

_setExtension() protected

accepts() public deprecated

beforeRender() public

configShallow() public

getConfig() public

getConfigOrFail() public

getController() public

implementedEvents() public

initialize() public

log() public

mapAlias() public

prefers() public deprecated

renderAs() public

requestedWith() public

respondAs() public

setConfig() public

startup() public

Краткое описание методов

__construct() public

Параметры

__debugInfo() public

Возвращает

__get() public

Параметры

Возвращает

_configDelete() protected

Параметры

Возвращает

Выбрасывает

_configRead() protected

Параметры

Возвращает

_configWrite() protected

Параметры

Возвращает

Выбрасывает

_setExtension() protected

Параметры

Возвращает

accepts() public

Параметры

Возвращает

beforeRender() public

Параметры

Возвращает

Выбрасывает

configShallow() public

Параметры

Возвращает

getConfig() public

Использование

Параметры

Возвращает

getConfigOrFail() public

Параметры

Возвращает

Выбрасывает

getController() public

Возвращает

implementedEvents() public

Возвращает

initialize() public

Параметры

Возвращает

log() public

Parameters

Returns

mapAlias() public

Parameters

Returns

prefers() public

Класс
RequestHandlerComponent

`$_componentMap` protected

`$_config` protected

`$_configInitialized` protected

`$_defaultConfig` protected

`$_registry` protected

`$_renderType` protected

`$components` protected

`$ext` protected