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

Open in your IDE?
  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\Component\Console\Attribute\AsCommand;
  15. use Symfony\Component\Console\Command\Command;
  16. use Symfony\Component\Console\Completion\CompletionInput;
  17. use Symfony\Component\Console\Completion\CompletionSuggestions;
  18. use Symfony\Component\Console\Input\InputArgument;
  19. use Symfony\Component\Console\Input\InputInterface;
  20. use Symfony\Component\Console\Output\OutputInterface;
  21. use Symfony\Component\Console\Style\SymfonyStyle;
  22. use Symfony\Component\HttpKernel\CacheClearer\Psr6CacheClearer;
  24. /**
  25.  * Delete an item from a cache pool.
  26.  *
  27.  * @author Pierre du Plessis <pdples@gmail.com>
  28.  */
  29. #[AsCommand(name: 'cache:pool:delete', description: 'Delete an item from a cache pool')]
  30. final class CachePoolDeleteCommand extends Command
  31. {
  32.     private Psr6CacheClearer $poolClearer;
  33.     private ?array $poolNames;
  35.     /**
  36.      * @param string[]|null $poolNames
  37.      */
  38.     public function __construct(Psr6CacheClearer $poolClearer, array $poolNames = null)
  39.     {
  40.         parent::__construct();
  42.         $this->poolClearer = $poolClearer;
  43.         $this->poolNames = $poolNames;
  44.     }
  46.     /**
  47.      * {@inheritdoc}
  48.      */
  49.     protected function configure()
  50.     {
  51.         $this
  52.             ->setDefinition([
  53.                 new InputArgument('pool', InputArgument::REQUIRED, 'The cache pool from which to delete an item'),
  54.                 new InputArgument('key', InputArgument::REQUIRED, 'The cache key to delete from the pool'),
  55.             ])
  56.             ->setHelp(<<<'EOF'
  57. The <info>%command.name%</info> deletes an item from a given cache pool.
  59.     %command.full_name% <pool> <key>
  60. EOF
  61.             )
  62.         ;
  63.     }
  65.     /**
  66.      * {@inheritdoc}
  67.      */
  68.     protected function execute(InputInterface $input, OutputInterface $output): int
  69.     {
  70.         $io = new SymfonyStyle($input, $output);
  71.         $pool = $input->getArgument('pool');
  72.         $key = $input->getArgument('key');
  73.         $cachePool = $this->poolClearer->getPool($pool);
  75.         if (!$cachePool->hasItem($key)) {
  76.             $io->note(sprintf('Cache item "%s" does not exist in cache pool "%s".', $key, $pool));
  78.             return 0;
  79.         }
  81.         if (!$cachePool->deleteItem($key)) {
  82.             throw new \Exception(sprintf('Cache item "%s" could not be deleted.', $key));
  83.         }
  85.         $io->success(sprintf('Cache item "%s" was successfully deleted.', $key));
  87.         return 0;
  88.     }
  90.     public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void
  91.     {
  92.         if (\is_array($this->poolNames) && $input->mustSuggestArgumentValuesFor('pool')) {
  93.             $suggestions->suggestValues($this->poolNames);
  94.         }
  95.     }
  96. }