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

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