Класс CommandCollection

__construct()source public

__construct( array $commands = [] )

Конструктор

Параметры

массив $commands необязательный []

Список команд для добавления в коллекцию.

add()source public

add( string $name , string|Cake\Console\Shell|Cake\Console\Command $command )

Добавить команду в коллекцию

Параметры

строка $name

Имя команды, которую нужно сопоставить.

строка|Cake\Console\Shell|Cake\Console\Command $command

Команда для сопоставления.

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

$this

addMany()source public

addMany( array $commands )

Добавить сразу несколько команд.

Параметры

массив $commands

Список имён команд => классов/экземпляров команд.

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

$this

См. также

\Cake\Console\CommandCollection::add()

autoDiscover()source public

autoDiscover( )

Автоматически обнаружить команды оболочки в CakePHP, приложении и всех плагинах.

Команды будут обнаружены с использованием соглашений об именовании файлов. Команды обнаруживаются в следующем порядке:

• Команды, предоставленные CakePHP
• Команды приложения

Команды, определённые в приложении, переопределяют команды с одинаковым именем, предоставленные CakePHP.

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

массив строк
Массив имён команд и их классов.

count()source public

count( )

Реализация Countable.

Получить количество команд в коллекции.

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

целое число

Реализация

Countable::count()

discoverPlugin()source public

discoverPlugin( string $plugin )

Автообнаружение команд оболочки и команд из указанного плагина.

Обнаруженные команды будут иметь свои имена, дубликаты которых будут удалены с имеющимися командами в коллекции. Если команда уже определена в коллекции и обнаружена в плагине, будет возвращено только полное имя (plugin.command)

Параметры

строка $plugin

Плагин для сканирования.

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

массив строк
Обнаруженные команды плагина.

get()source public

get( string $name )

Получить целевой объект для команды.

Параметры

строка $name

Имя команды оболочки.

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

строка|Cake\Console\Shell
Класс оболочки или экземпляр.

Исключения

InvalidArgumentException
при получении неизвестных команд.

getIterator()source public

getIterator( )

Реализация IteratorAggregate.

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

ArrayIterator

Реализация

IteratorAggregate::getIterator()

has()source public

has( string $name )

Проверить, существует ли указанная команда оболочки в коллекции.

Параметры

строка $name

Имя команды оболочки.

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

логическое значение

remove()source public

remove( string $name )

Удалить команду из коллекции, если она существует.

Параметры

строка $name

Имя команды оболочки.

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

$this

resolveNames()source protected

resolveNames( array $input )

Разрешить имена на основе существующих команд

Параметры

массив $input

Результаты операции CommandScanner.

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

массив строк
Плоский массив имён команд => имён классов.

[]