vendor/symfony/framework-bundle/Command/SecretsRemoveCommand.php line 38

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Bundle\FrameworkBundle\Command;
  14. use Symfony\Bundle\FrameworkBundle\Secrets\AbstractVault;
  15. use Symfony\Component\Console\Attribute\AsCommand;
  16. use Symfony\Component\Console\Command\Command;
  17. use Symfony\Component\Console\Completion\CompletionInput;
  18. use Symfony\Component\Console\Completion\CompletionSuggestions;
  19. use Symfony\Component\Console\Input\InputArgument;
  20. use Symfony\Component\Console\Input\InputInterface;
  21. use Symfony\Component\Console\Input\InputOption;
  22. use Symfony\Component\Console\Output\ConsoleOutputInterface;
  23. use Symfony\Component\Console\Output\OutputInterface;
  24. use Symfony\Component\Console\Style\SymfonyStyle;
  26. /**
  27.  * @author Jérémy Derussé <jeremy@derusse.com>
  28.  * @author Nicolas Grekas <p@tchwork.com>
  29.  *
  30.  * @internal
  31.  */
  32. #[AsCommand(name: 'secrets:remove', description: 'Remove a secret from the vault')]
  33. final class SecretsRemoveCommand extends Command
  34. {
  35.     private AbstractVault $vault;
  36.     private ?AbstractVault $localVault;
  38.     public function __construct(AbstractVault $vault, AbstractVault $localVault = null)
  39.     {
  40.         $this->vault = $vault;
  41.         $this->localVault = $localVault;
  43.         parent::__construct();
  44.     }
  46.     protected function configure()
  47.     {
  48.         $this
  49.             ->addArgument('name', InputArgument::REQUIRED, 'The name of the secret')
  50.             ->addOption('local', 'l', InputOption::VALUE_NONE, 'Update the local vault.')
  51.             ->setHelp(<<<'EOF'
  52. The <info>%command.name%</info> command removes a secret from the vault.
  54.     <info>%command.full_name% <name></info>
  55. EOF
  56.             )
  57.         ;
  58.     }
  60.     protected function execute(InputInterface $input, OutputInterface $output): int
  61.     {
  62.         $io = new SymfonyStyle($input, $output instanceof ConsoleOutputInterface ? $output->getErrorOutput() : $output);
  63.         $vault = $input->getOption('local') ? $this->localVault : $this->vault;
  65.         if (null === $vault) {
  66.             $io->success('The local vault is disabled.');
  68.             return 1;
  69.         }
  71.         if ($vault->remove($name = $input->getArgument('name'))) {
  72.             $io->success($vault->getLastMessage() ?? 'Secret was removed from the vault.');
  73.         } else {
  74.             $io->comment($vault->getLastMessage() ?? 'Secret was not found in the vault.');
  75.         }
  77.         if ($this->vault === $vault && null !== $this->localVault->reveal($name)) {
  78.             $io->comment('Note that this secret is overridden in the local vault.');
  79.         }
  81.         return 0;
  82.     }
  84.     public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void
  85.     {
  86.         if (!$input->mustSuggestArgumentValuesFor('name')) {
  87.             return;
  88.         }
  90.         $vaultKeys = array_keys($this->vault->list(false));
  91.         if ($input->getOption('local')) {
  92.             if (null === $this->localVault) {
  93.                 return;
  94.             }
  95.             $vaultKeys = array_intersect($vaultKeys, array_keys($this->localVault->list(false)));
  96.         }
  98.         $suggestions->suggestValues($vaultKeys);
  99.     }
  100. }