. */ 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 collection cache region. * * @since 2.5 * @author Fabio B. Silva */ class CollectionRegionCommand extends Command { /** * {@inheritdoc} */ protected function configure() { $this ->setName('orm:clear-cache:region:collection') ->setDescription('Clear a second-level cache collection region.') ->addArgument('owner-class', InputArgument::OPTIONAL, 'The owner entity name.') ->addArgument('association', InputArgument::OPTIONAL, 'The association collection name.') ->addArgument('owner-id', InputArgument::OPTIONAL, 'The owner identifier.') ->addOption('all', null, InputOption::VALUE_NONE, 'If defined, all entity 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 collection regions for an associated Entity Manager. It is possible to delete/invalidate all collection region, a specific collection region or flushes the cache provider. The execution type differ on how you execute the command. If you want to invalidate all entries for an collection region this command would do the work: %command.name% 'Entities\MyEntity' 'collectionName' To invalidate a specific entry you should use : %command.name% 'Entities\MyEntity' 'collectionName' 1 If you want to invalidate all entries for the all collection regions: %command.name% --all Alternatively, if you want to flush the configured cache provider for an collection region use this command: %command.name% 'Entities\MyEntity' 'collectionName' --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(); $ownerClass = $input->getArgument('owner-class'); $assoc = $input->getArgument('association'); $ownerId = $input->getArgument('owner-id'); $cache = $em->getCache(); if ( ! $cache instanceof Cache) { throw new \InvalidArgumentException('No second-level cache is configured on the given EntityManager.'); } if ( (! $ownerClass || ! $assoc) && ! $input->getOption('all')) { throw new \InvalidArgumentException('Missing arguments "--owner-class" "--association"'); } if ($input->getOption('flush')) { $collectionRegion = $cache->getCollectionCacheRegion($ownerClass, $assoc); if ( ! $collectionRegion instanceof DefaultRegion) { throw new \InvalidArgumentException(sprintf( 'The option "--flush" expects a "Doctrine\ORM\Cache\Region\DefaultRegion", but got "%s".', is_object($collectionRegion) ? get_class($collectionRegion) : gettype($collectionRegion) )); } $collectionRegion->getCache()->flushAll(); $output->writeln(sprintf('Flushing cache provider configured for "%s#%s"', $ownerClass, $assoc)); return; } if ($input->getOption('all')) { $output->writeln('Clearing all second-level cache collection regions'); $cache->evictEntityRegions(); return; } if ($ownerId) { $output->writeln(sprintf('Clearing second-level cache entry for collection "%s#%s" owner entity identified by "%s"', $ownerClass, $assoc, $ownerId)); $cache->evictCollection($ownerClass, $assoc, $ownerId); return; } $output->writeln(sprintf('Clearing second-level cache for collection "%s#%s"', $ownerClass, $assoc)); $cache->evictCollectionRegion($ownerClass, $assoc); } }