. */ namespace Doctrine\ORM\Tools\Console\Command\ClearCache; use Symfony\Component\Console\Command\Command; use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Input\InputArgument; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; use Doctrine\ORM\Cache\Region\DefaultRegion; use Doctrine\ORM\Cache; /** * Command to clear a query cache region. * * @since 2.5 * @author Fabio B. Silva */ class QueryRegionCommand extends Command { /** * {@inheritdoc} */ protected function configure() { $this ->setName('orm:clear-cache:region:query') ->setDescription('Clear a second-level cache query region.') ->addArgument('region-name', InputArgument::OPTIONAL, 'The query region to clear.') ->addOption('all', null, InputOption::VALUE_NONE, 'If defined, all query regions will be deleted/invalidated.') ->addOption('flush', null, InputOption::VALUE_NONE,'If defined, all cache entries will be flushed.'); $this->setHelp(<<%command.name% command is meant to clear a second-level cache query region for an associated Entity Manager. It is possible to delete/invalidate all query region, a specific query region or flushes the cache provider. The execution type differ on how you execute the command. If you want to invalidate all entries for the default query region this command would do the work: %command.name% To invalidate entries for a specific query region you should use : %command.name% my_region_name If you want to invalidate all entries for the all query region: %command.name% --all Alternatively, if you want to flush the configured cache provider use this command: %command.name% my_region_name --flush Finally, be aware that if --flush option is passed, not all cache providers are able to flush entries, because of a limitation of its execution nature. EOT ); } /** * {@inheritdoc} */ protected function execute(InputInterface $input, OutputInterface $output) { $em = $this->getHelper('em')->getEntityManager(); $name = $input->getArgument('region-name'); $cache = $em->getCache(); if ($name === null) { $name = Cache::DEFAULT_QUERY_REGION_NAME; } if ( ! $cache instanceof Cache) { throw new \InvalidArgumentException('No second-level cache is configured on the given EntityManager.'); } if ($input->getOption('flush')) { $queryCache = $cache->getQueryCache($name); $queryRegion = $queryCache->getRegion(); if ( ! $queryRegion instanceof DefaultRegion) { throw new \InvalidArgumentException(sprintf( 'The option "--flush" expects a "Doctrine\ORM\Cache\Region\DefaultRegion", but got "%s".', is_object($queryRegion) ? get_class($queryRegion) : gettype($queryRegion) )); } $queryRegion->getCache()->flushAll(); $output->writeln(sprintf('Flushing cache provider configured for second-level cache query region named "%s"', $name)); return; } if ($input->getOption('all')) { $output->writeln('Clearing all second-level cache query regions'); $cache->evictQueryRegions(); return; } $output->writeln(sprintf('Clearing second-level cache query region named "%s"', $name)); $cache->evictQueryRegion($name); } }