How to clean the cache partially by tags?

dmitrii_fediuk · February 12, 2016, 8:58pm

APIs

magento/magento2/blob/6ce74b2/lib/internal/Magento/Framework/App/CacheInterface.php#L50-L56


/**
 * Clean cached data by specific tag
 *
 * @param array $tags
 * @return bool
 */
public function clean($tags = []);

github.com

magento/magento2/blob/6ce74b2/lib/internal/Magento/Framework/App/Cache.php#L87-L93


/**
 * Clean cached data by specific tag
 *
 * @param array $tags
 * @return bool
 */
public function clean($tags = [])

github.com

magento/magento2/blob/6ce74b2/lib/internal/Magento/Framework/Cache/FrontendInterface.php#L52-L60


/**
 * Clean cache records matching specified tags
 *
 * @param string $mode
 * @param array $tags
 * @return bool
 * @api
 */
public function clean($mode = \Zend_Cache::CLEANING_MODE_ALL, array $tags = []);

github.com

magento/magento2/blob/6ce74b2/lib/internal/Magento/Framework/Cache/Frontend/Adapter/Zend.php#L63-L80


public function clean($mode = \Zend_Cache::CLEANING_MODE_ALL, array $tags = [])
{
    // Cleaning modes 'old' and 'notMatchingTag' are prohibited as a trade off for decoration reliability
    if (!in_array(
        $mode,
        [
            \Zend_Cache::CLEANING_MODE_ALL,
            \Zend_Cache::CLEANING_MODE_MATCHING_TAG,
            \Zend_Cache::CLEANING_MODE_MATCHING_ANY_TAG
        ]
    )
    ) {
        throw new \InvalidArgumentException(
            "Magento cache frontend does not support the cleaning mode '{$mode}'."
        );
    }
    return $this->_frontend->clean($mode, $this->_unifyIds($tags));
}

github.com

magento/magento2/blob/6ce74b2/lib/internal/Magento/Framework/Cache/Core.php#L77-L95


/**
 * Clean cache entries
 *
 * Available modes are :
 * 'all' (default)  => remove all cache entries ($tags is not used)
 * 'old'            => remove too old cache entries ($tags is not used)
 * 'matchingTag'    => remove cache entries matching all given tags
 *                     ($tags can be an array of strings or a single string)
 * 'notMatchingTag' => remove cache entries not matching one of the given tags
 *                     ($tags can be an array of strings or a single string)
 * 'matchingAnyTag' => remove cache entries matching any given tags
 *                     ($tags can be an array of strings or a single string)
 *
 * @param string $mode
 * @param string[] $tags
 * @throws \Zend_Cache_Exception
 * @return bool True if ok
 */
public function clean($mode = 'all', $tags = [])

Usage examples

app/code/Magento/Authorization/Model/ResourceModel/Role.php#L96-L107

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Backend/Console/Command/AbstractCacheCommand.php#L20-L36


/**
 * CacheManager
 *
 * @var Manager
 */
protected $cacheManager;


/**
 * Constructor
 *
 * @param Manager $cacheManager
 */
public function __construct(Manager $cacheManager)
{
    $this->cacheManager = $cacheManager;
    parent::__construct();
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Backend/Console/Command/AbstractCacheSetCommand.php#L24-L42


protected function execute(InputInterface $input, OutputInterface $output)
{
    $isEnable = $this->isEnable();
    $types = $this->getRequestedTypes($input);
    $changedTypes = $this->cacheManager->setEnabled($types, $isEnable);
    if ($changedTypes) {
        $output->writeln('Changed cache status:');
        foreach ($changedTypes as $type) {
            $output->writeln(sprintf('%30s: %d -> %d', $type, !$isEnable, $isEnable));
        }
    } else {
        $output->writeln('There is nothing to change in cache status');
    }
    if (!empty($changedTypes) && $isEnable) {
        $this->cacheManager->clean($changedTypes);
        $output->writeln('Cleaned cache types:');
        $output->writeln(join(PHP_EOL, $changedTypes));
    }
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Backend/Cron/CleanCache.php#L27-L39


/**
 * Cron job method to clean old cache resources
 *
 * @return void
 */
public function execute()
{
    /** @var $cacheFrontend \Magento\Framework\Cache\FrontendInterface */
    foreach ($this->cacheFrontendPool as $cacheFrontend) {
        // Magento cache frontend does not support the 'old' cleaning mode, that's why backend is used directly
        $cacheFrontend->getBackend()->clean(\Zend_Cache::CLEANING_MODE_OLD);
    }
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Backend/Model/Url.php#L288-L296


/**
 * Refresh admin menu cache etc.
 *
 * @return void
 */
public function renewSecretUrls()
{
    $this->_cache->clean([\Magento\Backend\Block\Menu::CACHE_TAGS]);
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Catalog/Model/Product.php#L1045-L1054


/**
 * Clear cache related with product id
 *
 * @return $this
 */
public function cleanCache()
{
    $this->_cacheManager->clean('catalog_product_' . $this->getId());
    return $this;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Catalog/Model/ResourceModel/Category/Tree.php#L449-L449


$this->_cache->clean([\Magento\Catalog\Model\Category::CACHE_TAG]);

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Config/Model/Config/Backend/Cache.php#L13-L33


class Cache extends \Magento\Framework\App\Config\Value
{
/**
 * Cache tags to clean
 *
 * @var array
 */
protected $_cacheTags = [];


/**
 * Clean cache, value was changed
 *
 * @return void
 */
public function afterSave()
{
    if ($this->isValueChanged()) {
        $this->_cacheManager->clean($this->_cacheTags);
    }
}
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Eav/Model/Config.php#L140-L145


$this->_cache->clean(
    [
        \Magento\Eav\Model\Cache\Type::CACHE_TAG,
        \Magento\Eav\Model\Entity\Attribute::CACHE_TAG,
    ]
);

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Eav/Setup/EavSetup.php#L118-L127


/**
 * Clean cache
 *
 * @return $this
 */
public function cleanCache()
{
    $this->cache->clean([\Magento\Eav\Model\Cache\Type::CACHE_TAG]);
    return $this;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/PageCache/Observer/FlushCacheByTags.php#L35-L55


/**
 * If Built-In caching is enabled it collects array of tags
 * of incoming object and asks to clean cache.
 *
 * @param \Magento\Framework\Event\Observer $observer
 * @return void
 */
public function execute(\Magento\Framework\Event\Observer $observer)
{
    if ($this->_config->getType() == \Magento\PageCache\Model\Config::BUILT_IN && $this->_config->isEnabled()) {
        $object = $observer->getEvent()->getObject();
        if ($object instanceof \Magento\Framework\DataObject\IdentityInterface) {
            $tags = $object->getIdentities();
            foreach ($tags as $tag) {
                $tags[] = preg_replace("~_\\d+$~", '', $tag);
            }
            if (!empty($tags)) {
                $this->_cache->clean(array_unique($tags));
            }
        }
    }

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Store/Model/StoreManager.php#L231-L231


$this->cache->clean(\Zend_Cache::CLEANING_MODE_MATCHING_TAG, [StoreResolver::CACHE_TAG]);

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Tax/Model/Config/Price/IncludePrice.php#L16-L16


$this->_cacheManager->clean(['checkout_quote']);

github.com

magento/magento2/blob/6ce74b2/lib/internal/Magento/Framework/DB/Adapter/Pdo/Mysql.php#L1460-L1460


$this->_cacheAdapter->clean(\Zend_Cache::CLEANING_MODE_MATCHING_TAG, [self::DDL_CACHE_TAG]);

github.com

magento/magento2/blob/6ce74b2/lib/internal/Magento/Framework/Interception/Config/Config.php#L115-L115


$this->_cache->clean(\Zend_Cache::CLEANING_MODE_MATCHING_TAG, [$this->_cacheId]);

github.com

magento/magento2/blob/6ce74b2/lib/internal/Magento/Framework/Model/AbstractModel.php#L762-L774


/**
 * Remove model object related cache
 *
 * @return $this
 */
public function cleanModelCache()
{
    $tags = $this->getCacheTags();
    if ($tags !== false) {
        $this->_cacheManager->clean($tags);
    }
    return $this;
}

github.com

magento/magento2/blob/6ce74b2/setup/src/Magento/Setup/Model/Installer.php#L975-L992


/**
 * Enables caches after installing application
 *
 * @return void
 *
 * @SuppressWarnings(PHPMD.UnusedPrivateMethod) Called by install() via callback.
 */
private function enableCaches()
{
    /** @var \Magento\Framework\App\Cache\Manager $cacheManager */
    $cacheManager = $this->objectManagerProvider->get()->create('Magento\Framework\App\Cache\Manager');
    $types = $cacheManager->getAvailableTypes();
    $enabledTypes = $cacheManager->setEnabled($types, true);
    $cacheManager->clean($enabledTypes);


    $this->log->log('Current status:');
    $this->log->log(print_r($cacheManager->getStatus(), true));
}

github.com

magento/magento2/blob/6ce74b2/setup/src/Magento/Setup/Model/Installer.php#L994-L1008


/**
 * Clean caches after installing application
 *
 * @return void
 *
 * @SuppressWarnings(PHPMD.UnusedPrivateMethod) Called by install() via callback.
 */
private function cleanCaches()
{
    /** @var \Magento\Framework\App\Cache\Manager $cacheManager */
    $cacheManager = $this->objectManagerProvider->get()->get('Magento\Framework\App\Cache\Manager');
    $types = $cacheManager->getAvailableTypes();
    $cacheManager->clean($types);
    $this->log->log('Cache cleared successfully');
}

dmitrii_fediuk · June 30, 2017, 1:17am