. */ 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 entity cache region. * * @since 2.5 * @author Fabio B. Silva */ class EntityRegionCommand extends Command { /** * {@inheritdoc} */ protected function configure() { $this ->setName('orm:clear-cache:region:entity') ->setDescription('Clear a second-level cache entity region.') ->addArgument('entity-class', InputArgument::OPTIONAL, 'The entity name.') ->addArgument('entity-id', InputArgument::OPTIONAL, 'The entity 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 entity region for an associated Entity Manager. It is possible to delete/invalidate all entity region, a specific entity 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 entity region this command would do the work: %command.name% 'Entities\MyEntity' To invalidate a specific entry you should use : %command.name% 'Entities\MyEntity' 1 If you want to invalidate all entries for the all entity regions: %command.name% --all Alternatively, if you want to flush the configured cache provider for an entity region use this command: %command.name% 'Entities\MyEntity' --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(); $entityClass = $input->getArgument('entity-class'); $entityId = $input->getArgument('entity-id'); $cache = $em->getCache(); if ( ! $cache instanceof Cache) { throw new \InvalidArgumentException('No second-level cache is configured on the given EntityManager.'); } if ( ! $entityClass && ! $input->getOption('all')) { throw new \InvalidArgumentException('Invalid argument "--entity-class"'); } if ($input->getOption('flush')) { $entityRegion = $cache->getEntityCacheRegion($entityClass); if ( ! $entityRegion instanceof DefaultRegion) { throw new \InvalidArgumentException(sprintf( 'The option "--flush" expects a "Doctrine\ORM\Cache\Region\DefaultRegion", but got "%s".', is_object($entityRegion) ? get_class($entityRegion) : gettype($entityRegion) )); } $entityRegion->getCache()->flushAll(); $output->writeln(sprintf('Flushing cache provider configured for entity named "%s"', $entityClass)); return; } if ($input->getOption('all')) { $output->writeln('Clearing all second-level cache entity regions'); $cache->evictEntityRegions(); return; } if ($entityId) { $output->writeln(sprintf('Clearing second-level cache entry for entity "%s" identified by "%s"', $entityClass, $entityId)); $cache->evictEntity($entityClass, $entityId); return; } $output->writeln(sprintf('Clearing second-level cache for entity "%s"', $entityClass)); $cache->evictEntityRegion($entityClass); } }