Класс ComponentRegistry

__construct()source public

__construct( Cake\Controller\Controller $controller null )

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

Параметры

Cake\Controller\Controller $controller optional null

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

_create()source protected

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

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

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

Параметры

string $class

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

string $alias

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

array $config

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

Возвращает

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

_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() и Cake\Core\ObjectRegistry::unload()

Параметры

string $class

Отсутствующее имя класса.

string $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( )

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

Возвращает

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

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

Возвращает

mixed

loaded()source public

loaded( )

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

Возвращает

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

normalizeArray()source public

normalizeArray( array $objects )

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

Параметры

array $objects

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

Возвращает

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

reset()source public

reset( )

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

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

Возвращает

$this

set()source public

set( string $objectName , object $object )

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

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

Параметры

string $objectName

Имя объекта, который нужно установить в реестре.

object $object

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

Возвращает

$this

unload()source public

unload( string $objectName )

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

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

Параметры

string $objectName

Имя объекта, который нужно удалить из реестра.

Возвращает

$this

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 для данного объекта.

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

Устаревшее

3.5.0 Используйте getEventManager()/setEventManager() вместо этого.

Параметры

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

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

Возвращает

Cake\Event\EventManager

getEventManager()source public

getEventManager( )

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

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

Возвращает

Cake\Event\EventManager

setEventManager()source public

setEventManager( Cake\Event\EventManager $eventManager )

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

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

Параметры

Cake\Event\EventManager $eventManager

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

Возвращает

$this