Класс 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–2016 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.
http://api.cakephp.org/3.2/class-Cake.Cache.CacheRegistry.html