Класс 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()

Параметры

string $class

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

string $alias

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

array $settings

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

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

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

_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()

Параметры

string $class

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

string $plugin

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

Исключение

Cake\Console\Exception\MissingTaskException

__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

_checkDuplicate()source protected

_checkDuplicate( string $name , array $config )

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

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

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

Параметры

string $name

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

array $config

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

Исключение

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

get()source public

get( string $name )

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

Параметры

string $name

Имя объекта.

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

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

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

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

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

mixed

loaded()source public

loaded( )

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

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

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

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

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