Класс CommandCollection

Коллекция команд.

Используется приложениями для указания своих команд консоли. CakePHP будет использовать сопоставленные команды для построения и отправки команд оболочки.

Пространство имён: Cake\Console

Краткое описание свойств

$commands protected

array<string,Cake\Console\ShellCake\Console\CommandInterface|string>

Список команд

Краткое описание методов

__construct() public

Конструктор
add() public

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

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

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

Реализация Countable.
discoverPlugin() public

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

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

Реализация IteratorAggregate.
has() public

Проверить, существует ли указанная команда в коллекции.
keys() public

Получить список доступных имён команд.
remove() public

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

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

Подробное описание методов

__construct() public

__construct(array<string,Cake\Console\ShellCake\Console\CommandInterface|string> $commands = [])

Конструктор

Параметры

array<string,Cake\Console\ShellCake\Console\CommandInterface|string> $commands optional: Карта команд для добавления в коллекцию.

add() public

add(string $name, Cake\Console\CommandInterfaceCake\Console\Shell|string $command): $this

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

Параметры

string $name: Имя команды, которую вы хотите сопоставить.
Cake\Console\CommandInterfaceCake\Console\Shell|string $command: Команда для сопоставления. Может быть FQCN, экземпляром Shell или экземпляром CommandInterface.

Возвращает

$this

Исключения

InvalidArgumentException

addMany() public

addMany(array<string,Cake\Console\ShellCake\Console\CommandInterface|string> $commands): $this

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

Параметры

array<string,Cake\Console\ShellCake\Console\CommandInterface|string> $commands: Карта имён команд => классы/экземпляры команд.

Возвращает

$this

См. также

\Cake\Console\CommandCollection::add()

autoDiscover() public

autoDiscover(): array<string, string>

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

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

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

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

Возвращает

array<string, string>

count() public

count(): int

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

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

Возвращает

int

discoverPlugin() public

discoverPlugin(string $plugin): array<string, string>

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

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

Параметры

string $plugin: Плагин для сканирования.

Возвращает

array<string, string>

get() public

get(string $name): Cake\Console\CommandInterfaceCake\Console\Shell|string

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

Параметры

string $name: Именованная оболочка.

Возвращает

Cake\Console\CommandInterfaceCake\Console\Shell|string

Исключения

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

getIterator() public

getIterator(): Traversable

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

Возвращает

Traversable

has() public

has(string $name): bool

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

Параметры

string $name: Именованная оболочка.

Возвращает

bool

keys() public

keys(): array<string>

Получить список доступных имён команд.

Возвращает

array<string>

remove() public

remove(string $name): $this

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

Параметры

string $name: Именованная оболочка.

Возвращает

$this

resolveNames() protected

resolveNames(array $input): array<string, string>

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

Параметры

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

Возвращает

array<string, string>

Подробное описание свойств

`$commands` protected

Список команд

Тип

array<string,Cake\Console\ShellCake\Console\CommandInterface|string>

© 2005–present 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/4.3/class-Cake.Console.CommandCollection.html

Класс CommandCollection

Краткое описание свойств

Краткое описание методов

__construct() public

add() public

addMany() public

autoDiscover() public

count() public

discoverPlugin() public

get() public

getIterator() public

has() public

keys() public

remove() public

resolveNames() protected

Подробное описание методов

__construct() public

Параметры

add() public

Параметры

Возвращает

Исключения

addMany() public

Параметры

Возвращает

См. также

autoDiscover() public

Возвращает

count() public

Возвращает

discoverPlugin() public

Параметры

Возвращает

get() public

Параметры

Возвращает

Исключения

getIterator() public

Возвращает

has() public

Параметры

Возвращает

keys() public

Возвращает

remove() public

Параметры

Возвращает

resolveNames() protected

Параметры

Возвращает

Подробное описание свойств

$commands protected

Тип

`$commands` protected