Класс CacheRegistry

Регистр объектов для движков кэша.

Используется {@link \Cake\Cache\Cache} для загрузки и управления движками кэша.

Пространство имён: Cake\Cache

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

$_loaded protected

array<object>

Карта загруженных объектов.

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

__debugInfo() public

Свойства объекта для отладки.
__get() public

Предоставление публичного чтения загруженных объектов.
__isset() public

Предоставление доступа isset к _loaded.
__set() public

Устанавливает объект.
__unset() public

Удаляет объект.
_checkDuplicate() protected

Проверка на дублирование загрузки объектов.
_create() protected

Создание экземпляра движка кэша.
_resolveClassName() protected

Разрешение имени класса движка кэша.
_throwMissingClassError() protected

Выбрасывает исключение, если движок кэша отсутствует.
count() public

Возвращает количество загруженных объектов.
get() public

Получение экземпляра загруженного объекта.
getIterator() public

Возвращает итератор массива.
has() public

Проверка наличия заданного объекта.
load() public

Загрузка/создание экземпляра объекта.
loaded() public

Получение списка загруженных объектов.
normalizeArray() public

Нормализует массив объектов, создает массив, который упрощает ленивую загрузку
reset() public

Очистка загруженных экземпляров в регистре.
set() public

Непосредственно устанавливает объект в регистр по имени.
unload() public

Удаление одного адаптера из регистра.

END_OF_DOCUMENT_MARKER

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

__debugInfo() public

__debugInfo(): array<string, mixed>

Свойства объекта для отладки.

Возвращает

array<string, mixed>

__get() public

__get(string $name): object|null

Обеспечивает общедоступный чтение загруженных объектов

Параметры

string $name: Имя свойства для чтения

Возвращает

object|null

__isset() public

__isset(string $name): bool

Обеспечивает доступ isset к _loaded

Параметры

string $name: Имя проверяемого объекта.

Возвращает

bool

__set() public

__set(string $name, object $object): void

Устанавливает объект.

Параметры

string $name: Имя свойства для установки.
object $object: Объект для установки.

Возвращает

void

__unset() public

__unset(string $name): void

Убирает объект.

Параметры

string $name: Имя свойства для удаления.

Возвращает

void

_checkDuplicate() protected

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

Проверка на дублирование загрузки объекта.

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

Исключение вызывается, так как замена объекта не обновит ссылки, которые другие объекты могут иметь. Кроме того, простое обновление конфигурации в реальном времени не является хорошим вариантом, так как мы можем пропустить важную логику конструктора, зависящую от конфигурации.

Параметры

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

Возвращает

void

Выбрасывает

RuntimeException
При обнаружении дубликата.

_create() protected

_create(object|string $class, string $alias, array<string, mixed> $config): Cake\Cache\CacheEngine

Создает экземпляр движка кэша.

Часть шаблона метода для Cake\Core\ObjectRegistry::load()

Параметры

object|string $class: Имя класса или объект для создания.
string $alias: Псевдоним объекта.
array<string, mixed> $config: Массив настроек для использования движка кэша.

Возвращает

Cake\Cache\CacheEngine

Выбрасывает

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

_resolveClassName() protected

_resolveClassName(string $class): string|null

Разрешение имени класса движка кэша.

Часть шаблона метода для Cake\Core\ObjectRegistry::load()

Параметры

string $class: Частичное имя класса для разрешения.

Возвращает

string|null

_throwMissingClassError() protected

_throwMissingClassError(string $class, string|null $plugin): void

Выбрасывает исключение, когда движок кэша отсутствует.

Часть шаблона метода для Cake\Core\ObjectRegistry::load()

Параметры

string $class: Имя класса, которого нет.
string|null $plugin: Плагин, в котором отсутствует кэш.

Возвращает

void

Выбрасывает

BadMethodCallException

count() public

count(): int

Возвращает количество загруженных объектов.

Возвращает

int

get() public

get(string $name): object

Получить экземпляр загруженного объекта.

Параметры

string $name: Имя объекта.

Возвращает

object

Выбрасывает

RuntimeException
Если не загружен или не найден.

getIterator() public

getIterator(): Traversable

Возвращает итератор массива.

Возвращает

Traversable

has() public

has(string $name): bool

Проверить, загружен ли заданный объект.

Параметры

string $name: Имя объекта для проверки.

Возвращает

bool

load() public

load(string $name, array<string, mixed> $config = []): mixed

Загрузка/создание экземпляра объекта.

Вернет экземпляр в реестре, если он уже существует. Если подкласс предоставляет поддержку событий, вы можете использовать $config['enabled'] = false для исключения созданных объектов из регистрации для событий.

Используя {@link \Cake\Controller\Component::$components} в качестве примера. Вы можете задать псевдоним объекта, установив ключ 'className', например,

protected $components = [
  'Email' => [
    'className' => 'App\Controller\Component\AliasedEmailComponent'
  ];
];

Все вызовы компонента Email будут использовать AliasedEmail вместо.

Параметры

string $name: Имя/класс объекта для загрузки.
array<string, mixed> $config optional: Дополнительные настройки для использования при загрузке объекта.

Возвращает

mixed

Выбрасывает

Exception
Если класс не найден.

loaded() public

loaded(): array<string>

Получить список загруженных объектов.

Возвращает

array<string>

normalizeArray() public

normalizeArray(array $objects): array<string, array>

Нормализует массив объектов, создает массив, который упрощает ленивую загрузку

Параметры

array $objects: Массив дочерних объектов для нормализации.

Возвращает

array<string, array>

reset() public

reset(): $this

Очистить загруженные экземпляры в реестре.

Если подкласс реестра имеет менеджер событий, объекты также будут откреплены от событий.

Возвращает

$this

set() public

set(string $name, object $object): $this

Установка объекта напрямую в реестр по имени.

Если эта коллекция реализует события, переданный объект будет подключен к менеджеру событий

Параметры

string $name: Имя объекта для установки в реестре.
object $object: экземпляр для хранения в реестре

Возвращает

$this

unload() public

unload(string $name): $this

Удаление одного адаптера из реестра.

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

Параметры

string $name: Имя адаптера.

Возвращает

$this

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

`$_loaded` protected

Карта загруженных объектов.

Тип

array<object>

© 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.3/class-Cake.Cache.CacheRegistry.html