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

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 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.     /**
  49.      * {@inheritdoc}
  50.      */
  51.     protected function configure()
  52.     {
  53.         $this
  54.             ->setDefinition([
  55.                 new InputArgument('pools', InputArgument::IS_ARRAY | InputArgument::REQUIRED, 'A list of cache pools or cache pool clearers'),
  56.             ])
  57.             ->setHelp(<<<'EOF'
  58. The <info>%command.name%</info> command clears the given cache pools or cache pool clearers.
  60.     %command.full_name% <cache pool or clearer 1> [...<cache pool or clearer N>]
  61. EOF
  62.             )
  63.         ;
  64.     }
  66.     /**
  67.      * {@inheritdoc}
  68.      */
  69.     protected function execute(InputInterface $input, OutputInterface $output): int
  70.     {
  71.         $io = new SymfonyStyle($input, $output);
  72.         $kernel = $this->getApplication()->getKernel();
  73.         $pools = [];
  74.         $clearers = [];
  76.         foreach ($input->getArgument('pools') as $id) {
  77.             if ($this->poolClearer->hasPool($id)) {
  78.                 $pools[$id] = $id;
  79.             } else {
  80.                 $pool = $kernel->getContainer()->get($id);
  82.                 if ($pool instanceof CacheItemPoolInterface) {
  83.                     $pools[$id] = $pool;
  84.                 } elseif ($pool instanceof Psr6CacheClearer) {
  85.                     $clearers[$id] = $pool;
  86.                 } else {
  87.                     throw new InvalidArgumentException(sprintf('"%s" is not a cache pool nor a cache clearer.', $id));
  88.                 }
  89.             }
  90.         }
  92.         foreach ($clearers as $id => $clearer) {
  93.             $io->comment(sprintf('Calling cache clearer: <info>%s</info>', $id));
  94.             $clearer->clear($kernel->getContainer()->getParameter('kernel.cache_dir'));
  95.         }
  97.         $failure = false;
  98.         foreach ($pools as $id => $pool) {
  99.             $io->comment(sprintf('Clearing cache pool: <info>%s</info>', $id));
  101.             if ($pool instanceof CacheItemPoolInterface) {
  102.                 if (!$pool->clear()) {
  103.                     $io->warning(sprintf('Cache pool "%s" could not be cleared.', $pool));
  104.                     $failure = true;
  105.                 }
  106.             } else {
  107.                 if (false === $this->poolClearer->clearPool($id)) {
  108.                     $io->warning(sprintf('Cache pool "%s" could not be cleared.', $pool));
  109.                     $failure = true;
  110.                 }
  111.             }
  112.         }
  114.         if ($failure) {
  115.             return 1;
  116.         }
  118.         $io->success('Cache was successfully cleared.');
  120.         return 0;
  121.     }
  123.     public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void
  124.     {
  125.         if (\is_array($this->poolNames) && $input->mustSuggestArgumentValuesFor('pools')) {
  126.             $suggestions->suggestValues($this->poolNames);
  127.         }
  128.     }
  129. }