vendor/symfony/framework-bundle/Command/CachePoolClearCommand.php line 40

  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 Psr\Cache\CacheItemPoolInterface;
  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\Exception\InvalidArgumentException;
  20. use Symfony\Component\Console\Input\InputArgument;
  21. use Symfony\Component\Console\Input\InputInterface;
  22. use Symfony\Component\Console\Output\OutputInterface;
  23. use Symfony\Component\Console\Style\SymfonyStyle;
  24. use Symfony\Component\HttpKernel\CacheClearer\Psr6CacheClearer;
  26. /**
  27.  * Clear cache pools.
  28.  *
  29.  * @author Nicolas Grekas <p@tchwork.com>
  30.  */
  31. #[AsCommand(name: 'cache:pool:clear', description: 'Clear cache pools')]
  32. final class CachePoolClearCommand extends Command
  33. {
  34.     private Psr6CacheClearer $poolClearer;
  35.     private ?array $poolNames;
  37.     /**
  38.      * @param string[]|null $poolNames
  39.      */
  40.     public function __construct(Psr6CacheClearer $poolClearer, array $poolNames = null)
  41.     {
  42.         parent::__construct();
  44.         $this->poolClearer = $poolClearer;
  45.         $this->poolNames = $poolNames;
  46.     }
  48.     protected function configure()
  49.     {
  50.         $this
  51.             ->setDefinition([
  52.                 new InputArgument('pools', InputArgument::IS_ARRAY | InputArgument::REQUIRED, 'A list of cache pools or cache pool clearers'),
  53.             ])
  54.             ->setHelp(<<<'EOF'
  55. The <info>%command.name%</info> command clears the given cache pools or cache pool clearers.
  57.     %command.full_name% <cache pool or clearer 1> [...<cache pool or clearer N>]
  58. EOF
  59.             )
  60.         ;
  61.     }
  63.     protected function execute(InputInterface $input, OutputInterface $output): int
  64.     {
  65.         $io = new SymfonyStyle($input, $output);
  66.         $kernel = $this->getApplication()->getKernel();
  67.         $pools = [];
  68.         $clearers = [];
  70.         foreach ($input->getArgument('pools') as $id) {
  71.             if ($this->poolClearer->hasPool($id)) {
  72.                 $pools[$id] = $id;
  73.             } else {
  74.                 $pool = $kernel->getContainer()->get($id);
  76.                 if ($pool instanceof CacheItemPoolInterface) {
  77.                     $pools[$id] = $pool;
  78.                 } elseif ($pool instanceof Psr6CacheClearer) {
  79.                     $clearers[$id] = $pool;
  80.                 } else {
  81.                     throw new InvalidArgumentException(sprintf('"%s" is not a cache pool nor a cache clearer.', $id));
  82.                 }
  83.             }
  84.         }
  86.         foreach ($clearers as $id => $clearer) {
  87.             $io->comment(sprintf('Calling cache clearer: <info>%s</info>', $id));
  88.             $clearer->clear($kernel->getContainer()->getParameter('kernel.cache_dir'));
  89.         }
  91.         $failure = false;
  92.         foreach ($pools as $id => $pool) {
  93.             $io->comment(sprintf('Clearing cache pool: <info>%s</info>', $id));
  95.             if ($pool instanceof CacheItemPoolInterface) {
  96.                 if (!$pool->clear()) {
  97.                     $io->warning(sprintf('Cache pool "%s" could not be cleared.', $pool));
  98.                     $failure = true;
  99.                 }
  100.             } else {
  101.                 if (false === $this->poolClearer->clearPool($id)) {
  102.                     $io->warning(sprintf('Cache pool "%s" could not be cleared.', $pool));
  103.                     $failure = true;
  104.                 }
  105.             }
  106.         }
  108.         if ($failure) {
  109.             return 1;
  110.         }
  112.         $io->success('Cache was successfully cleared.');
  114.         return 0;
  115.     }
  117.     public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void
  118.     {
  119.         if (\is_array($this->poolNames) && $input->mustSuggestArgumentValuesFor('pools')) {
  120.             $suggestions->suggestValues($this->poolNames);
  121.         }
  122.     }
  123. }