artisan command with multiple arguments: bug or error

I tried to create a new command with multiple arguments as in the example on the Laravel page: https://laravel.com/docs/6.x/artisan#arguments

I ran into an issue when making the second argument optional.

When I make the second argument mandatory it is processed correctly.

Declaration:

protected $signature = 'email:send {user} {queue}';

Input:

php artisan email:send xyz asdf

Output:

Array
(
    [command] => email:send
    [user] => xyz
    [queue] => asdf
)

But, if I make the second argument optional it is not being processed.

Declaration:

protected $signature = 'email:send {user} {--queue=}';

Input:

php artisan email:send xyz --queue=asdf

Output:

Array
(
    [command] => email:send
    [user] => xyz
)

The argument for --queue is missing in the array. It has not been processed.

Am I making a mistake, or is this a bug?

Best Answer

Level 88

You need to parse it a different way, instead of using arguments, you need to use input

$arguments = $this->arguments();

// Retrieve a specific option...
$queue = $this->option('queue');

This should work ;)

Documentation: https://laravel.com/docs/6.x/artisan#retrieving-input

Level 4

Using input is wrong in that case (maybe you mistyped it?), but your example showed me to the solution.

Optional arguments are not saved in the arguments array but in the options array.

They can be accessed like this:

$this->info('queue: ' $this->option('queue'));

I was trying to access queue in the arguments array, which was wrong.

Level 88

Aah yeah typo! It should indeed be option! Glad you fixed it ;)

Please or to participate in this conversation.