Класс TaskRegistry

__construct()source public

__construct( Cake\Console\Shell $Shell )

Конструктор

Параметры

Cake\Console\Shell $Shell

Экземпляр оболочки

_create()source protected

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

Создание экземпляра задачи.

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

Параметры

строка $class

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

строка $alias

Псевдоним задачи.

массив $settings

Массив настроек для задачи.

Возвращает

Cake\Console\Shell
Созданный класс задачи.

_resolveClassName()source protected

_resolveClassName( string $class )

Разрешение имени класса задачи.

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

Параметры

строка $class

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

Возвращает

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

_throwMissingClassError()source protected

_throwMissingClassError( string $class , string $plugin )

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

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

Параметры

строка $class

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

строка $plugin

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

Выбрасывает

Cake\Console\Exception\MissingTaskException

__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

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

Выбрасывает

исключение Runtime
При обнаружении дубликата.

get()source public

get( string $name )

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

Параметры

строка $name

Имя объекта.

Возвращает

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

has()source public

has( string $name )

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

Параметры

строка $name

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

Возвращает

булево значение
Истина, если объект загружен, иначе ложь.

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 )

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

Параметры

массив $objects

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

Возвращает

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

reset()source public

reset( )

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

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

set()source public

set( string $objectName , object $object )

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

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

Параметры

строка $objectName

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

объект $object

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

unload()source public

unload( string $objectName )

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

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

Параметры

строка $objectName

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