feature #19891 [FrameworkBundle] Add cache:pool:clear command (nicolas-grekas)

This PR was merged into the 3.2-dev branch.

Discussion
----------

[FrameworkBundle] Add cache:pool:clear command

| Q             | A
| ------------- | ---
| Branch?       | master
| New feature?  | yes
| Tests pass?   | yes
| License       | MIT

Useful when deploying apps to get better control of cache pool clearing.

Commits
-------

37c5b18 [FrameworkBundle] Add cache:pool:clear command

Author: fabpot

Command/CachePoolClearCommand.php

@@ -0,0 +1,83 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\FrameworkBundle\Command;
+
+use Psr\Cache\CacheItemPoolInterface;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+use Symfony\Component\HttpKernel\CacheClearer\Psr6CacheClearer;
+
+/**
+ * Clear cache pools.
+ *
+ * @author Nicolas Grekas <p@tchwork.com>
+ */
+final class CachePoolClearCommand extends ContainerAwareCommand
+{
+    /**
+     * {@inheritdoc}
+     */
+    protected function configure()
+    {
+        $this
+            ->setName('cache:pool:clear')
+            ->setDefinition(array(
+                new InputArgument('pools', InputArgument::IS_ARRAY, 'A list of cache pools or cache pool clearers'),
+            ))
+            ->setDescription('Clears cache pools')
+            ->setHelp(<<<'EOF'
+The <info>%command.name%</info> command clears the given cache pools or cache pool clearers.
+
+    %command.full_name% <cache pool or clearer 1> [...<cache pool or clearer N>]
+EOF
+            )
+        ;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $io = new SymfonyStyle($input, $output);
+        $pools = array();
+        $clearers = array();
+        $container = $this->getContainer();
+        $cacheDir = $container->getParameter('kernel.cache_dir');
+
+        foreach ($input->getArgument('pools') as $id) {
+            $pool = $container->get($id);
+
+            if ($pool instanceof CacheItemPoolInterface) {
+                $pools[$id] = $pool;
+            } elseif ($pool instanceof Psr6CacheClearer) {
+                $clearers[$id] = $pool;
+            } else {
+                throw new \InvalidArgumentException(sprintf('"%s" is not a cache pool nor a cache clearer.', $id));
+            }
+        }
+
+        foreach ($clearers as $id => $clearer) {
+            $io->comment(sprintf('Calling cache clearer: <info>%s</info>', $id));
+            $clearer->clear($cacheDir);
+        }
+
+        foreach ($pools as $id => $pool) {
+            $io->comment(sprintf('Clearing cache pool: <info>%s</info>', $id));
+            $pool->clear();
+        }
+
+        $io->success('Cache was successfully cleared.');
+    }
+}

Resources/config/cache.xml

@@ -7,7 +7,7 @@
     <services>
 
         <service id="cache.app" parent="cache.adapter.filesystem">
-            <tag name="cache.pool" />
+            <tag name="cache.pool" clearer="cache.app_clearer" />
         </service>
 
         <service id="cache.system" parent="cache.adapter.system">
@@ -92,5 +92,7 @@
             <tag name="kernel.cache_clearer" />
         </service>
 
+        <service id="cache.app_clearer" alias="cache.default_clearer" />
+
     </services>
 </container>