Spec-Zone.ru › CakePHP 3.5

Класс CacheRegistry

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

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

Cake\Core\ObjectRegistry implements 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

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–2018 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.5/class-Cake.Cache.CacheRegistry.html

Spec-Zone.ru

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