Класс RequestHandlerComponent

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

Этот компонент проверяет запросы разных типов содержимого, таких как JSON, XML, XMLHttpRequest (AJAX), и настраивает объект ответа и билдер представлений соответственно.

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

Пространство имен: Cake\Controller\Component
Ссылка: https://book.cakephp.org/4/ru/controllers/components/request-handling.html

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

$_componentMap protected

array

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

array

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

bool

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

array

Конфигурация по умолчанию
$_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

Определяет типы содержимого, принимаемые клиентом. Принятие основано на расширении файла, проанализированном маршрутизатором (если оно есть), и на заголовке HTTP_ACCEPT. В отличие от 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::write().
mapAlias() public

Сопоставляет псевдоним типа содержимого с его MIME-типом(ами).
prefers() public

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

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

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

Устанавливает заголовок ответа на основе имени индекса карты типов. Это обертывает несколько методов, доступных в Cake\Http\Response. Оно также позволяет использовать псевдонимы типов содержимого.
setConfig() public

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

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

END_OF_DOCUMENT_MARKER

Подробное описание методов

__construct() public

__construct(Cake\Controller\ComponentRegistry $registry, array $config = [])

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

Параметры

Cake\Controller\ComponentRegistry $registry: Объект ComponentRegistry.
array $config необязательно: Массив конфигурации.

__debugInfo() public

__debugInfo(): array

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

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

array

__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(string|array $key, mixed $value, bool|string $merge = false): void

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

Параметры

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

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

void

Исключения

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

_setExtension() protected

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

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

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

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

Параметры

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

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

void

accepts() public

accepts(string|array|null $type = null): mixed

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

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

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

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

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

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

Параметры

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

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

mixed

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, вы можете сделать это, используя Cake\Http\Response::setTypeMap() в методе beforeFilter() вашего контроллера.
Если существует помощник с таким же именем, что и расширение, он добавляется к контроллеру.
Если расширение относится к типу, который понимает RequestHandler, он установит этот тип Content-type в заголовке ответа.

Параметры

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

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

void

Исключения

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

configShallow() public

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

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

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

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

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

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

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

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

Параметры

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

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

$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 необязательно: Ключ для получения или null для всей конфигурации.
mixed $default необязательно: Возвращаемое значение, если ключ не существует.

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

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

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

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

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

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

array

initialize() public

initialize(array $config): void

Метод обработки крючка конструктора.

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

Параметры

array $config: Настройки конфигурации, предоставленные этому компоненту.

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

void

log() public

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

Метод для записи сообщения в журнал. Подробнее о записи в журналы см. Log::write().

Параметры

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

Возвращает

bool

mapAlias() public

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

Преобразует псевдоним типа контента в соответствующий MIME-тип(ы).

Параметры

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

Возвращает

string|array|null

prefers() public

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

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

Параметры

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

Возвращает

string|bool|null

renderAs() public

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

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

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

Отобразить ответ как ответ «ajax».

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

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

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

Параметры

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

Возвращает

void

См. также

\Cake\Controller\Component\RequestHandlerComponent::respondAs()

requestedWith() public

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

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

Параметры

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

Возвращает

mixed

respondAs() public

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

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

Параметры

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

Возвращает

bool

setConfig() public

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

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

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

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

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

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

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

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

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

Параметры

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

Возвращает

$this

Исключения

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

startup() public

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

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

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

Параметры

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

Возвращает

void

Подробное описание свойств

`$_componentMap` protected

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

Тип

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.2/class-Cake.Controller.Component.RequestHandlerComponent.html