Класс 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() и Cake\Core\ObjectRegistry::unload()

Параметры

строка $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

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

Возвращает

логическое

__set()source public

__set( string $name , mixed $object )

Устанавливает объект.

Параметры

строка $name

Имя свойства для установки.

смешанное $object

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

__unset()source public

__unset( string $name )

Удаляет объект.

Параметры

строка $name

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

_checkDuplicate()source protected

_checkDuplicate( string $name , array $config )

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

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

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

Параметры

строка $name

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

массив $config

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

Выбрасывает

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

count()source public

count( )

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

Возвращает

целое число

Реализация

Countable::count()

get()source public

get( string $name )

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

Параметры

строка $name

Имя объекта.

Возвращает

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

getIterator()source public

getIterator( )

Возвращает итератор массива.

Возвращает

ArrayIterator

Реализация

IteratorAggregate::getIterator()

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 optional []

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

Возвращает

смешанное

Выбрасывает

Исключение
Если класс не найден.

loaded()source public

loaded( )

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

Возвращает

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

normalizeArray()source public

normalizeArray( array $objects )

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

Параметры

массив $objects

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

Возвращаемое значение

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

reset()source public

reset( )

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

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

Возвращаемое значение

$this

set()source public

set( string $objectName , object $object )

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

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

Параметры

строка $objectName

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

объект $object

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

Возвращаемое значение

$this

unload()source public

unload( string $objectName )

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

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

Параметры

строка $objectName

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

Возвращаемое значение

$this