Class CheckHttpCacheComponent

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

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

Чтобы использовать этот компонент, действия вашего контроллера должны установить заголовок Last-Modified или Etag. Без одного из этих заголовков этот компонент не будет иметь никакого эффекта.

Пространство имен: Cake\Controller\Component

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

$_componentMap protected

array<string, array>

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

array<string, mixed>

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

bool

Является ли свойство config уже настроенным со значениями по умолчанию
$_defaultConfig protected

array<string, mixed>

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

Cake\Controller\ComponentRegistry

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

array

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

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

__construct() public

Конструктор
__debugInfo() public

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

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

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

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

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

Обработчик перед рендерингом
configShallow() public

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

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

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

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

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

Метод обратного вызова конструктора.
log() public

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

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

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

__construct() public

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

Конструктор

Параметры

Cake\Controller\ComponentRegistry $registry: Регистр компонентов, который этот компонент может использовать для ленивой загрузки своих компонентов.
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: Истинно, чтобы выполнить рекурсивную склейку, 'shallow' для простой склейки, ложно, чтобы перезаписать, по умолчанию ложно.

Возвращает

void

Выбрасывает

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

beforeRender() public

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

Обработчик перед рендерингом

Параметры

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

Возвращает

void

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() для получения дополнительной информации о записи в журнал.

Параметры

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

Возвращает

bool

setConfig() public

setConfig(array<string, mixed>|string $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']);

Параметры

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

Возвращает

$this

Выбрасывает

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

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

`$_componentMap` защищенное

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

Тип

array<string, array>

`$_config` защищенное

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

Тип

array<string, mixed>

`$_configInitialized` защищенное

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

Тип

bool

`$_defaultConfig` защищенное

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

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

Тип

array<string, mixed>

`$_registry` защищенное

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

Тип

Cake\Controller\ComponentRegistry

`$components` защищенное

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

Тип

array

© 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.CheckHttpCacheComponent.html

Class CheckHttpCacheComponent

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

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

__construct() public

__debugInfo() public

__get() public

_configDelete() protected

_configRead() protected

_configWrite() protected

beforeRender() public

configShallow() public

getConfig() public

getConfigOrFail() public

getController() public

implementedEvents() public

initialize() public

log() public

setConfig() public

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

__construct() public

Параметры

__debugInfo() public

Возвращает

__get() public

Параметры

Возвращает

_configDelete() protected

Параметры

Возвращает

Выбрасывает

_configRead() protected

Параметры

Возвращает

_configWrite() protected

Параметры

Возвращает

Выбрасывает

beforeRender() public

Параметры

Возвращает

configShallow() public

Параметры

Возвращает

getConfig() public

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

Параметры

Возвращает

getConfigOrFail() public

Параметры

Возвращает

Выбрасывает

getController() public

Возвращает

implementedEvents() public

Возвращает

initialize() public

Параметры

Возвращает

log() public

Параметры

Возвращает

setConfig() public

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

Параметры

Возвращает

Выбрасывает

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

$_componentMap защищенное

Тип

$_config защищенное

Тип

$_configInitialized защищенное

Тип

$_defaultConfig защищенное

Тип

$_registry защищенное

Тип

$components защищенное

Тип

`$_componentMap` защищенное

`$_config` защищенное

`$_configInitialized` защищенное

`$_defaultConfig` защищенное

`$_registry` защищенное

`$components` защищенное