Класс ComponentRegistry

__construct()source public

__construct( Cake\Controller\Controller $controller null )

Конструктор.

Параметры

Cake\Controller\Controller $controller необязательно null

Экземпляр контроллера.

_create()source protected

_create( string $class , string $alias , array $config )

Создать экземпляр компонента.

Часть шаблонового метода для Cake\Core\ObjectRegistry::load() Включенные компоненты будут зарегистрированы в диспетчере событий.

Параметры

строка $class

Имя класса для создания.

строка $alias

Псевдоним компонента.

массив $config

Массив настроек для компонента.

Возвращает

Cake\Controller\Component
Созданный класс компонента.

_resolveClassName()source protected

_resolveClassName( string $class )

Разрешить имя класса компонента.

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

Параметры

строка $class

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

Возвращает

строка|false
Либо правильное имя класса, либо false.

_throwMissingClassError()source protected

_throwMissingClassError( string $class , string $plugin )

Выбрасывает исключение, если компонент отсутствует.

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

Параметры

строка $class

Отсутствующий класс.

строка $plugin

Плагин, в котором отсутствует компонент.

Исключения

Cake\Controller\Exception\MissingComponentException

getController()source public

getController( )

Получить контроллер, связанный с коллекцией.

Возвращает

Cake\Controller\Controller
Экземпляр контроллера

setController()source public

setController( Cake\Controller\Controller $controller )

Установить контроллер, связанный с коллекцией.

Параметры

Cake\Controller\Controller $controller

Экземпляр контроллера.

__debugInfo()source public

__debugInfo( )

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

Возвращает

массив

__get()source public

__get( string $name )

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

Параметры

строка $name

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

Возвращает

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

__isset()source public

__isset( string $name )

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

Параметры

строка $name

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

Возвращает

булево значение

_checkDuplicate()source protected

_checkDuplicate( string $name , array $config )

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

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

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

Параметры

строка $name

Имя псевдонима в реестре.

массив $config

Данные конфигурации для нового экземпляра.

Исключения

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

get()source public

get( string $name )

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

Параметры

строка $name

Имя объекта.

Возвращает

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

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 необязательно []

Дополнительные параметры для использования при загрузке объекта.

Возвращает

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

loaded()source public

loaded( )

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

Возвращает

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

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

экземпляр для хранения в реестре

unload()source public

unload( string $objectName )

Удалить объект из реестра.

Если у этого реестра есть менеджер событий, объект также будет отделён от всех событий.

Параметры

string $objectName

Имя объекта для удаления из реестра.

dispatchEvent()source public

dispatchEvent( string $name , array|null $data null , object|null $subject null )

Обёртка для создания и отправки событий.

Возвращает событие, которое было обработано.

Параметры

string $name

Имя события.

array|null $data необязательно null

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

object|null $subject необязательно null

Объект, к которому относится это событие ($this по умолчанию).

Возвращает

Cake\Event\Event

eventManager()source public

eventManager( Cake\Event\EventManager $eventManager null )

Возвращает экземпляр менеджера Cake\Event\EventManager для этого объекта.

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

Параметры

Cake\Event\EventManager $eventManager необязательно null

менеджер событий для установки

Возвращает

Cake\Event\EventManager

null