Class CommandCollection
Collection for Commands.
Used by Applications to whitelist their console commands. CakePHP will use the mapped commands to construct and dispatch shell commands.
Property Summary
-
$commands protected
arrayCommand list
Method Summary
-
__construct() public
Constructor
-
add() public
Add a command to the collection
-
addMany() public
Add multiple commands at once.
-
autoDiscover() public
Automatically discover shell commands in CakePHP, the application and all plugins.
-
count() public
Implementation of Countable.
-
get() public
Get the target for a command.
-
getIterator() public
Implementation of IteratorAggregate.
-
has() public
Check whether the named shell exists in the collection.
-
remove() public
Remove a command from the collection if it exists.
Method Detail
__construct() ¶ public
__construct(array $commands = [])Constructor
Parameters
-
array$commands optional The map of commands to add to the collection.
add() ¶ public
add(string $name, string|Cake\Console\Shell $command): $thisAdd a command to the collection
Parameters
-
string$name The name of the command you want to map.
-
string|Cake\Console\Shell$command The command to map.
Returns
$thisaddMany() ¶ public
addMany(array $commands): $thisAdd multiple commands at once.
Parameters
-
array$commands A map of command names => command classes/instances.
Returns
$thisSee Also
autoDiscover() ¶ public
autoDiscover(): arrayAutomatically discover shell commands in CakePHP, the application and all plugins.
Commands will be located using filesystem conventions. Commands are discovered in the following order:
- CakePHP provided commands
- Application commands
- Plugin commands
Commands from plugins will be added based on the order plugins are loaded.
Plugin shells will attempt to use a short name. If however, a plugin
provides a shell that conflicts with CakePHP or the application shells,
the full plugin_name.shell name will be used. Plugin shells are added
in the order that plugins were loaded.
Returns
arraycount() ¶ public
count(): intImplementation of Countable.
Get the number of commands in the collection.
Returns
intget() ¶ public
get(string $name): string|Cake\Console\ShellGet the target for a command.
Parameters
-
string$name The named shell.
Returns
string|Cake\Console\ShellThrows
InvalidArgumentExceptionwhen unknown commands are fetched.
getIterator() ¶ public
getIterator(): ArrayIteratorImplementation of IteratorAggregate.
Returns
ArrayIteratorhas() ¶ public
has(string $name): boolCheck whether the named shell exists in the collection.
Parameters
-
string$name The named shell.
Returns
boolremove() ¶ public
remove(string $name): $thisRemove a command from the collection if it exists.
Parameters
-
string$name The named shell.
Returns
$this