docs

Documentation

• Documentation
  • Creating a command
  • Defining command Inputs
    • Arguments
    • Options
    • Input arrays
    • Input descriptions
  • Command Input Output
    • Retrieve input values
    • Determine if an input is present
  • Writing output

Creating a command

To create a command, instead of extending the Command class from Symfony, you should extend the Symblaze console command class. Then use the Symfony AsCommand attribute to register the command.

use Symblaze\Console\Command;
use Symfony\Component\Console\Attribute\AsCommand;

#[ASCommand(name: 'send:email', description: 'Send a marketing email to a user')]
class SendEmailCommand extends Command
{   
    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        //...
    }
}

You can also replace the execute() method with a handle() method:

use Symblaze\Console\Command;
use Symfony\Component\Console\Attribute\AsCommand;

 #[ASCommand(name: 'send:email', description: 'Send a marketing email to a user')]
class SendEmailCommand extends Command
{
    public function handle(): int
    {
        //...
    }
}

Defining command Inputs

No need to override the configure method to define the command arguments. All you need to do is to add the argument names wrapped in curly braces to the command name attribute.

Arguments

use Symblaze\Console\Command;
use Symfony\Component\Console\Attribute\AsCommand;

#[ASCommand(name: 'send:email {user}', description: 'Send a marketing email to a user')]
class SendEmailCommand extends Command
{   
    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        //...
    }
}

The command above will create a required argument named user. You may also make arguments optional or define default values for arguments:

// Optional argument
'mail:send {user?}'

// Argument with default value
'mail:send {user=imdhemy}'

Options

Options are defined in the same way as arguments, but they are prefixed with two dashes --:

AsCommand(name: 'mail:send {user} {--queue}')

In the example above, the command will have a required argument named user and an option named queue.

If the user must provide a value for the option, you can define it as follows:

AsCommand(name: 'mail:send {user} {--queue=}')

Or you can define a default value for the option:

AsCommand(name: 'mail:send {user} {--queue=10}')

You can also define a shortcut for the option:

AsCommand(name: 'mail:send {user} {--Q|queue}')

Input arrays

If you want to define arguments or options that accept multiple values, you can do so by adding * after the argument or option name:

AsCommand(name: 'mail:send {user*}')

You can combine the ? and * characters to define an optional array:

AsCommand(name: 'mail:send {user?*}')

The same applies to options:

AsCommand(name: 'mail:send {user} {--queue*}')

Input descriptions

You can define a description for each argument or option by adding a : after the argument or option name:

AsCommand(name: 'mail:send {user : The user ID} {--queue : The queue ID}')

Command Input Output

Retrieve input values

You can retrieve the value of an argument or option using the argument and option methods:

$user = $this->argument('user');

$queue = $this->option('queue');

In case you want to retrieve all the arguments or options, you can use the arguments and options methods:

$arguments = $this->arguments();

$options = $this->options();

Determine if an input is present

You can determine if an argument or option is present using the hasArgument and hasOption methods. Both methods return true exists and is not null:

if ($this->hasArgument('user')) {
    //...
}

if ($this->hasOption('queue')) {
    //...
}

Writing output

The package provides a handy Console style that you can use to write output to the console:

$this->output->comment('This is a comment');
$this->output->success('This is a success message');
$this->output->error('This is an error message');
$this->output->warning('This is an info message');
$this->output->note('This is an info message');
$this->output->info('This is an info message');
$this->output->caution('This is a line message');
$this->output->question('This is a question message');