Класс CacheRegistry
Регистр объектов для движков кэша.
Используется Cake\Cache\Cache для загрузки и управления движками кэша.
- Cake\Core\ObjectRegistry
-
Cake\Cache\CacheRegistry
Наследованные свойства
Краткое описание методов
- _create() protectedСоздать экземпляр движка кэша.
- _resolveClassName() protectedРазрешить имя класса движка кэша.
- _throwMissingClassError() protectedВыбрасывает исключение, когда движок кэша отсутствует.
- unload() publicУдалить единственный адаптер из реестра.
Подробное описание методов
_create()source protected
_create( string|Cake\Cache\CacheEngine $class , string $alias , array $config )
Создать экземпляр движка кэша.
Часть шаблонового метода Cake\Core\ObjectRegistry::load()
Параметры
- string|
Cake\Cache\CacheEngine$class - Имя класса или объект для создания.
- string
$alias - Алиас объекта.
- array
$config - Массив настроек для движка кэша.
Возвращает
Cake\Cache\CacheEngineКонструируемый класс CacheEngine.
Выбрасывает
RuntimeExceptionкогда объект не реализует правильный интерфейс.
_resolveClassName()source protected
_resolveClassName( string $class )
Разрешить имя класса движка кэша.
Часть шаблонового метода для Cake\Core\ObjectRegistry::load()
Параметры
- string
$class - Частичное имя класса для разрешения.
Возвращает
string|falseЛибо правильное имя класса, либо false.
_throwMissingClassError()source protected
_throwMissingClassError( string $class , string $plugin )
Выбрасывает исключение, когда движок кэша отсутствует.
Часть шаблонового метода для Cake\Core\ObjectRegistry::load()
Параметры
- string
$class - Имя класса, которого нет.
- string
$plugin - Плагин, в котором отсутствует кэш.
Выбрасывает
BadMethodCallExceptionunload()source public
unload( string $name )
Удалить единственный адаптер из реестра.
Параметры
- string
$name - Имя адаптера.
Переопределяет
Cake\Core\ObjectRegistry::unload() Методы, унаследованные от Cake\Core\ObjectRegistry
__get()source public
__get( string $name )
Предоставляет публичный доступ для чтения к загруженным объектам
Параметры
- string
$name - Имя свойства для чтения
Возвращает
mixed__isset()source public
__isset( string $name )
Предоставляет доступ isset к _loaded
Параметры
- string
$name - Имя проверяемого объекта.
Возвращает
boolean_checkDuplicate()source protected
_checkDuplicate( string $name , array $config )
Проверка на дублирование загрузки объектов.
Если загружается дубликат с другой конфигурацией, это плохо, и будет выброшено исключение.
Исключение выбрасывается, так как замена объекта не обновит ссылки, которые могут быть у других объектов. Кроме того, простое обновление конфигурации во время выполнения — не лучший вариант, так как могут быть пропущены важные логические элементы конструктора, зависящие от конфигурации.
Параметры
- string
$name - Имя алиаса в реестре.
- array
$config - Данные конфигурации для нового экземпляра.
Выбрасывает
RuntimeExceptionПри обнаружении дубликата.
get()source public
get( string $name )
Получить загруженный экземпляр объекта.
Параметры
- string
$name - Имя объекта.
Возвращает
object|nullЭкземпляр объекта, если загружен, иначе null.
has()source public
has( string $name )
Проверка наличия загруженного объекта.
Параметры
- string
$name - Имя объекта для проверки.
Возвращает
booleanTrue, если объект загружен, иначе false.
load()source public
load( string $objectName , array $config [] )
Загружает/создаёт экземпляр объекта.
Вернёт экземпляр из реестра, если он уже существует. Если подкласс поддерживает события, вы можете использовать $config['enabled'] = false для исключения созданных объектов из регистрации событий.
Например, Cake\Controller\Controller::$components. Вы можете задать алиас объекта, установив ключ 'className', например:
public $components = [
'Email' => [
'className' => '\App\Controller\Component\AliasedEmailComponent'
];
]; Все вызовы компонента Email будут использовать AliasedEmail вместо него.
Параметры
- string
$objectName - Имя/класс объекта для загрузки.
- array
$configoptional [] - Дополнительные настройки для загрузки объекта.
Возвращает
mixedloaded()source public
loaded( )
Получить список загруженных объектов.
Возвращает
arrayСписок имён объектов.
normalizeArray()source public
normalizeArray( array $objects )
Нормализует массив объектов, создаёт массив, упрощающий ленивую загрузку
Параметры
- array
$objects - Массив дочерних объектов для нормализации.
Возвращает
arrayМассив нормализованных объектов.
reset()source public
reset( )
Очистить загруженные экземпляры в реестре.
Если подкласс реестра имеет менеджер событий, объекты также будут откреплены от событий.
set()source public
set( string $objectName , object $object )
Непосредственно установить объект в реестр по имени.
Если этот набор реализует события, переданный объект будет прикреплён к менеджеру событий
Параметры
- string
$objectName - Имя объекта для установки в реестре.
- object
$object - Экземпляр для хранения в реестре
© 2005–2017 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/3.3/class-Cake.Cache.CacheRegistry.html