Spec-Zone.ru › CakePHP 3.6

Класс CacheRegistry

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

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

Cake\Core\ObjectRegistry реализует Countable, IteratorAggregate
Extended by 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()

Параметры

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
Плагин, в котором отсутствует кэш.

Выбрасывает

BadMethodCallException

unload()source public

unload( string $name )

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

Параметры

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

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

Cake\Core\ObjectRegistry::unload()

Методы, унаследованные от Cake\Core\ObjectRegistry

__debugInfo()source public

__debugInfo( )

Дебаг-дружественные свойства объекта.

Возвращает

array

__get()source public

__get( string $name )

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

Параметры

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

Возвращает

mixed

__isset()source public

__isset( string $name )

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

Параметры

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

Возвращает

boolean

__set()source public

__set( string $name , mixed $object )

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

Параметры

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

__unset()source public

__unset( string $name )

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

Параметры

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

_checkDuplicate()source protected

_checkDuplicate( string $name , array $config )

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

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

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

Параметры

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

Выбрасывает

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

count()source public

count( )

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

Возвращает

integer

Реализация

Countable::count()

get()source public

get( string $name )

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

Параметры

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

Возвращает

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

getIterator()source public

getIterator( )

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

Возвращает

ArrayIterator

Реализация

IteratorAggregate::getIterator()

has()source public

has( string $name )

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

Параметры

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

Возвращает

boolean
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 вместо этого.

Параметры

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

Возвращает

mixed

Выбрасывает

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

loaded()source public

loaded( )

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

Возвращает

array
Список имён объектов.
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.6/class-Cake.Cache.CacheRegistry.html

Spec-Zone.ru

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