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

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