Класс CacheRegistry

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

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

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

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

$_loaded protected

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

Удалить отдельный адаптер из реестра.

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

__debugInfo() public

__debugInfo(): array

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

Возвращает

array

__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 $config): void

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

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

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

Параметры

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

Возвращает

void

Исключения

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

_create() protected

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

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

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

Параметры

string|object $class: Имя класса или объект для создания.
string $alias: Псевдоним объекта.
array $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 $config = []): mixed

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

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

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

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

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

Параметры

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

Возвращает

mixed

Исключения

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

loaded() public

loaded(): string[]

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

Возвращает

string[]

normalizeArray() public

normalizeArray(array $objects): array[]

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

Параметры

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

Возвращает

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

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

Тип

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