[12.x] Add option to get typed command input

[shaedrich]

and input validation

like, for example, with \Illuminate\Support\Facades\Config (#50140) and \Illuminate\Support\Arr (#55567)

Enhancements

• return value is typed
• optionally provide a default value, otherwise, an exception is thrown if not found
• when value has unexpected type, an exception is thrown

Example

<?php

namespace App\Console\Commands;

use App\Models\User;
use App\Support\DripEmailer;
use Illuminate\Console\Command;
 
class SendEmails extends Command
{
    protected $signature = 'mail:send {user} {--flag} {--subject=} {--cc=*}';
    protected $description = 'Send a marketing email to a user';
 
    /**
     * Execute the console command.
     */
    public function handle(DripEmailer $drip): void
    {
        $user = User::find($this->integer('user')); // argument typed as int, alternatively, you can use $this->int() or $this->number()
        $flag = $this->boolean('flag'); // flag typed as bool, there's also the alias $this->bool()
        $subject = $this->string('subject', 'Default subject'); // option typed as string with default value
        $cc = User::whereIn('id', $this->array('cc'))->get(); // option typed as array

        if ($flag) {
            // do something
        }

        $drip->send($user, $cc, $subject);
    }
}

[nguyentranchung]

This block is called multiple times.

[shaedrich]

Can you elaborate on that?

[nguyentranchung]

This block is called multiple times, and your code duplicates the logic for getting the value (checking argument, checking option, etc.) in several different parts of the codebase.

        $value = match (true) {
            $this->hasArgument($key) => $this->getArgument($key),
            $this->hasOption($key) => $this->getOption($key),
            default => $default ??  throw new InvalidArgumentException(sprintf('"%s" is neither an option nor an argument of this command', $key)),
        };

[shaedrich]

Ah, you mean, I could move that to its own method? Sure, I could, but I intend to first see if Taylor has an appetite for that

[shaedrich]

StyleCI can be fixed automatically upon merge as I understand it

[taylorotwell]

Thanks for your pull request to Laravel!

Unfortunately, I'm going to delay merging this code for now. To preserve our ability to adequately maintain the framework, we need to be very careful regarding the amount of code we include.

If applicable, please consider releasing your code as a package so that the community can still take advantage of your contributions!