Spec-Zone.ru › CakePHP 3.8

Класс CacheRegistry

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

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

Cake\Core\ObjectRegistry реализует Countable, IteratorAggregate
Расширенный Cake\Cache\CacheRegistry
Пространство имён: Cake\Cache
Расположение: Cache/CacheRegistry.php

Унаследованные свойства

  • _loaded

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

  • _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()

Параметры

строка|Cake\Cache\CacheEngine $class
Имя класса или объект для создания.
строка $alias
Псевдоним объекта.
массив $config
Массив настроек для движка кэширования.

Возвращает

Cake\Cache\CacheEngine
Созданный класс CacheEngine.

Исключение

RuntimeException
при отсутствии реализации интерфейса.

_resolveClassName()source protected

_resolveClassName( string $class )

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

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

Параметры

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

Возвращает

строка|ложь
Правильное имя класса или ложь.

_throwMissingClassError()source protected

_throwMissingClassError( string $class , string $plugin )

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

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

Параметры

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

Исключение

BadMethodCallException

unload()source public

unload( string $name )

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

Параметры

строка $name
Имя адаптера.

Переопределяет

Cake\Core\ObjectRegistry::unload()

Наследованные методы из Cake\Core\ObjectRegistry

__debugInfo()source public

__debugInfo( )

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

Возвращает

массив

__get()source public

__get( string $name )

Предоставляет общедоступный чтение к загруженным объектам

Параметры

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

Возвращает

смешанный тип

__isset()source public

__isset( string $name )

Предоставляет доступ isset к _loaded

Параметры

строка $name
Имя объекта, который проверяется.

Возвращает

булево

__set()source public

__set( string $name , mixed $object )

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

Параметры

строка $name
Имя свойства для установки.
смешанный тип $object
Объект для установки.

__unset()source public

__unset( string $name )

Удаляет объект.

Параметры

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

_checkDuplicate()source protected

_checkDuplicate( string $name , array $config )

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

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

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

Параметры

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

Исключение

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

count()source public

count( )

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

Возвращает

целое число

Реализация

Countable::count()

get()source public

get( string $name )

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

Параметры

строка $name
Имя объекта.

Возвращает

объект|null
Экземпляр объекта, если загружен, иначе null.

getIterator()source public

getIterator( )

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

Возвращает

ArrayIterator

Реализация

IteratorAggregate::getIterator()

has()source public

has( string $name )

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

Параметры

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

Возвращает

булево
True, если объект загружен, иначе 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 вместо этого.

Параметры

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

Возвращает

смешанный тип

Исключение

Исключение
Если класс не найден.

loaded()source public

loaded( )

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

Возвращает

массив строк
Список имён объектов.
END_OF_DOCUMENT_MARKER

normalizeArray()source public

normalizeArray( array $objects )

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

Параметры

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

Возвращает

массив
Массив нормализованных объектов.

reset()source public

reset( )

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

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

Возвращает


$this

set()source public

set( string $objectName , object $object )

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

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

Параметры

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

Возвращает


$this

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API