Spec-Zone.ru › CakePHP 3.1

Класс CacheRegistry

Регистр объектов для кеширующих движков.

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

Cake\Core\ObjectRegistry
Extended by Cake\Cache\CacheRegistry
Пространство имён: Cake\Cache
Расположение Cache/CacheRegistry.php

Подробное описание метода

_createsource 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
когда объект не реализует соответствующий интерфейс.

_resolveClassNamesource protected

_resolveClassName( string $class )

Разрешить имя класса кеширующего движка.

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

Параметры

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

Возвращает

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

_throwMissingClassErrorsource protected

_throwMissingClassError( string $class , string $plugin )

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

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

Параметры

string $class
Отсутствующее имя класса.
string $plugin
Плагин, в котором отсутствует кеш.

Исключения

BadMethodCallException
\BadMethodCallException

unloadsource public

unload( string $name )

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

Параметры

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

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

Cake\Core\ObjectRegistry::unload()

Наследуемые методы от Cake\Core\ObjectRegistry

__debugInfosource public

__debugInfo( )

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

Возвращает

array
массив

__getsource public

__get( string $name )

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

Параметры

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

Возвращает

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

__issetsource public

__isset( string $name )

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

Параметры

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

Возвращает

boolean
bool

_checkDuplicatesource protected

_checkDuplicate( string $name , array $config )

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

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

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

Параметры

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

Исключения

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

getsource public

get( string $name )

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

Параметры

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

Возвращает

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

hassource public

has( string $name )

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

Параметры

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

Возвращает

boolean
True, если объект загружен, иначе false.

loadsource 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
смешанный тип

loadedsource public

loaded( )

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

Возвращает

array
Список имён объектов.

normalizeArraysource public

normalizeArray( array $objects )

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

Параметры

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

Возвращает

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

resetsource public

reset( )

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

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

setsource public

set( string $objectName , object $object )

Непосредственно установить объект в реестр по имени.

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

Параметры

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

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

$_loadedsource

protected array

Карта загруженных объектов.

[]

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

Spec-Zone.ru

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