You can add new console commands to your application or register plugin commands using bootloaders. By default, the
Console component configured to automatically find commands in the app/src directory.
To add a new symfony/console based Command, simply drop it into your application.
To create a new command, you can either extend Symfony\Component\Console\Command\Command or Spiral\Console\Command
which provides some syntax sugar.
use Spiral\Console\Command;
class MyCommand extends Command
{
const NAME = 'my:command';
const DESCRIPTION = 'This is my command';
const ATTRIBUTES = [];
const OPTIONS = [];
/**
* Perform command
*/
protected function perform(): int
{
// do something special...
return self::SUCCESS;
}
}
Use constants NAME and DESCRIPTION to give a name to your Command. You can invoke it now using:
php app.php my:command
Spiral's Command class makes it easy to define needed arguments and options:
const ARGUMENTS = [
['argument', InputArgument::REQUIRED, 'Argument name.']
];
const OPTIONS = [
['option', 'c', InputOption::VALUE_NONE, 'Some option.']
];
To get user's data via arguments and/or options, you can make use of $this->argument("argName") or
$this->option("optName").
You can put your user code into the perform method. The perform support method injection and provide $this->input
and $this->output properties to work with user input.
protected function perform(MyService $service): int
{
$this->output->writeln($service->doSomething());
return self::SUCCESS;
}
You can use a set of helper methods available inside the Spiral\Console\Command. Given examples are intended to be
called in the perform method.
To write into output:
$this->writeln("hello world");
To write into output without advancing to the new line:
$this->write("hello world");
To write formatted output without advancing to the new line:
$this->sprintf("Hello, <comment>%s</comment>", $name);
Note
This method is compatible with thesprintfdefinition.
To check if current verbosity mode is higher than OutputInterface::VERBOSITY_VERBOSE:
dump($this->isVerbose());
Note
You can freely use thedumpmethod in console commands.
To render table:
$table = $this->table([
'Column #1:',
'Column #2:',
]);
foreach ($data as $row)
{
$table->addRow([
$row[1],
$row[2]
]);
}
$table->render();
To add table separator:
$table->addRow(new Symfony\Component\Console\Helper\TableSeparator());