[FrameworkBundle] Add cache:pool:clear command #19891
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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) { | ||
|
There was a problem hiding this comment. If there is no pools, what about clearing them all? There was a problem hiding this comment. too risky IMHO: there can be important operational data in the cache |
||
| $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)); | ||
|
There was a problem hiding this comment. I think the clearer/pool specific messages should be displayed only if the output is verbose and maybe a global comment should be added before e.g. "Clearing the cache for pools ...", wdyt? There was a problem hiding this comment. I don't know :) Doesn't look verbose to me. (Not as an exception trace e.g.). So I'll follow any advises. There was a problem hiding this comment. Sure, it's not very verbose until you have a lot of pools, I just refer to the clear cache command which hide details by default |
||
| $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.'); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just interesting - why not use
addArgumenthere?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All the other commands use
setDefinition, that's the reason :)