New in Symfony 5.3: Negatable Command Options

Contributed by Greg Anderson and Jérémy Derussé in #39642.

In some console commands it’s common to define two related options with opposite behaviors. For example, the default options applied to all Symfony commands include the --ansi and --no-ansi options: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17// ... use Symfony\Component\Console\Command\Command; use Symfony\Component\Console\Input\InputOption;

class SomeCommand extends Command { // ...

protected function configure(): void
{
    $this
        // ...
        ->addOption('ansi', null, InputOption::VALUE_NONE, 'Force ANSI output')
        ->addOption('no-ansi', null, InputOption::VALUE_NONE, 'Disable ANSI output')
    ;
}

}

In Symfony 5.3 we’ve introduced negatable command options to simplify these commands. A single negatable option creates two options in the command, following the pattern --xxx and --no-xxx. In practice, the following is equivalent to the previous example: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27// ... use Symfony\Component\Console\Command\Command; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\OutputInterface;

class SomeCommand extends Command { // ...

protected function configure(): void
{
    $this
        // ...
        ->addOption('ansi', null, InputOption::VALUE_NEGATABLE, 'Force/disable ANSI output')
    ;
}

protected function execute(InputInterface $input, OutputInterface $output): int
{
    // if command is run as `command --ansi`, $useAnsi = true
    // if command is run as `command --no-ansi`, $useAnsi = false
    $useAnsi = $input->getOption('ansi');

    // ...
}

}

Negatable options are only available for options that don’t allow passing any value to them (their previous type should be InputOption::VALUE_NONE).

                Sponsor the Symfony project.

http://feedproxy.google.com/~r/symfony/blog/~3/cgXbi8YPbsY/new-in-symfony-5-3-negatable-command-options

Établi 4y | 27 avr. 2021 à 07:20:09


Connectez-vous pour ajouter un commentaire

Autres messages de ce groupe

Symfony 2024 Year in Review

This blog post highlights the key accomplishments of the Symfony project in 2024. We are grateful for your continuous support, which enabled the Symfony project to achieve a remarkable year.

Releases

7 janv. 2025 à 13:40:05 | Symfony
A Week of Symfony #940 (30 December 2024 - 5 January 2025)

This week, Symfony 6.4.17, 7.1.10 and 7.2.2 maintenance versions were released. In addition, we published more information about the upcoming SymfonyOnline January 2025 conference.

Symfony developmen

5 janv. 2025 à 10:30:12 | Symfony
SymfonyOnline January 2025: Join us in 2 weeks!

Get ready for the exciting SymfonyOnline January 2025, kicking off shortly on January 16-17! There’s still time to register and join the international online Symfony conference—along with pre-

2 janv. 2025 à 12:50:08 | Symfony
Symfony 6.4.17 released

Symfony 6.4.17 has just been released. Here is the list of the most important changes since 6.4.16:

bug #59304 [PropertyInfo] Remove @internal from PropertyReadInfo and PropertyWriteInfo (Dario G
31 déc. 2024 à 16:50:11 | Symfony
Symfony 7.1.10 released

Symfony 7.1.10 has just been released. Here is the list of the most important changes since 7.1.9:

bug #59304 [PropertyInfo] Remove @internal from PropertyReadInfo and PropertyWriteInfo (Dario Gu
31 déc. 2024 à 16:50:10 | Symfony
Symfony 7.2.2 released

Symfony 7.2.2 has just been released. Here is the list of the most important changes since 7.2.1:

bug #59304 [PropertyInfo] Remove @internal from PropertyReadInfo and PropertyWriteInfo (Dario Gua
31 déc. 2024 à 16:50:10 | Symfony
A Week of Symfony #939 (23-29 December 2024)

This week, we launched the new Twig playground, a tool that lets you test and experiment with Twig features in a safe, sandboxed environment. While Symfony development activity was lighter than usual

29 déc. 2024 à 11:30:09 | Symfony