Класс CommandCollection
Коллекция для команд.
Используется приложениями для добавления в белый список своих команд консоли. CakePHP будет использовать сопоставленные команды для построения и отправки команд оболочки.
- Cake\Console\CommandCollection реализует IteratorAggregate, Countable
Краткое описание свойств
-
$commandsprotectedСписок командarray
Краткое описание методов
- __construct() publicКонструктор
- add() publicДобавление команды в коллекцию
- addMany() publicДобавление нескольких команд сразу.
- autoDiscover() publicАвтоматическое обнаружение команд оболочки в CakePHP, приложении и всех плагинах.
- count() publicРеализация Countable.
- get() publicПолучение целевой команды.
- getIterator() publicРеализация IteratorAggregate.
- has() publicПроверка наличия команды в коллекции по её имени.
- remove() publicУдаление команды из коллекции, если она существует.
Подробное описание методов
__construct()source public
__construct( array $commands [] )
Конструктор
Параметры
- массив
$commandsнеобязательно [] - Список команд для добавления в коллекцию.
add()source public
add( string $name , string|Cake\Console\Shell $command )
Добавление команды в коллекцию
Параметры
- строка
$name - Имя команды, которую нужно сопоставить.
- строка|
Cake\Console\Shell$command - Команда для сопоставления.
Возвращает
$this
addMany()source public
addMany( array $commands )
Добавление нескольких команд сразу.
Параметры
- массив
$commands - Список имен команд => классов/экземпляров команд.
Возвращает
$this
См. также
\Cake\Console\CommandCollection::add()autoDiscover()source public
autoDiscover( )
Автоматическое обнаружение команд оболочки в CakePHP, приложении и всех плагинах.
Команды будут обнаружены с использованием соглашений о файловой системе. Команды обнаруживаются в следующем порядке:
- Команды CakePHP
- Команды приложения
- Команды плагинов
Команды из плагинов будут добавлены в соответствии с порядком загрузки плагинов. Команды оболочки из плагинов будут пытаться использовать короткое имя. Однако, если плагин предоставляет команду оболочки, которая конфликтует с CakePHP или командами приложения, будет использоваться полное plugin_name.shell имя. Команды оболочки плагинов добавляются в порядке загрузки плагинов.
Возвращает
массивМассив имён команд и их классов.
count()source public
count( )
Реализация Countable.
Получение количества команд в коллекции.
Возвращает
целое числоРеализация
Countable::count() 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
Подробное описание свойств
© 2005–2017 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.4/class-Cake.Console.CommandCollection.html