Класс TaskRegistry

__constructsource public

__construct( Cake\Console\Shell $Shell )

Конструктор

Параметры

Cake\Console\Shell $Shell

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

_createsource protected

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

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

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

Параметры

string $class

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

string $alias

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

array $settings

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

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

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

_resolveClassNamesource protected

_resolveClassName( string $class )

Разрешить имя класса задачи.

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

Параметры

string $class

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

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

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

_throwMissingClassErrorsource protected

_throwMissingClassError( string $class , string $plugin )

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

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

Параметры

string $class

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

string $plugin

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

Исключения

Cake\Console\Exception\MissingTaskException
\Cake\Console\Exception\MissingTaskException

__debugInfosource public

__debugInfo( )

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

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

array
массив

__getsource public

__get( string $name )

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

Параметры

string $name

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

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

mixed
смешанное

__issetsource public

__isset( string $name )

Предоставление доступа isset к _loaded

Параметры

string $name

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

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

boolean
булево

_checkDuplicatesource protected

_checkDuplicate( string $name , array $config )

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

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

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

Параметры

string $name

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

array $config

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

Исключения

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

getsource public

get( string $name )

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

Параметры

string $name

Имя объекта.

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

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

hassource public

has( string $name )

Проверить, загружен ли данный объект.

Параметры

string $name

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

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

boolean
True, если объект загружен, иначе false.

loadsource 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
смешанное

loadedsource public

loaded( )

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

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

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

normalizeArraysource public

normalizeArray( array $objects )

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

Параметры

array $objects

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

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

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

resetsource public

reset( )

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

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

setsource public

set( string $objectName , object $object )

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

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

Параметры

string $objectName

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

object $object

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

unloadsource public

unload( string $objectName )

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

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

Параметры

string $objectName

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

[]