How is Magento\Framework\Cache\Frontend\Decorator\Logger::clean() implemented and used?

dmitry_fedyuk · June 29, 2017, 10:41pm

Usages

Implementation

1. Magento\Framework\Cache\Frontend\Decorator\Logger::clean()

magento/magento2/blob/2.2.0-RC1.1/lib/internal/Magento/Framework/Cache/Frontend/Decorator/Logger.php#L42-L50


/**
 * {@inheritdoc}
 */
public function clean($mode = \Zend_Cache::CLEANING_MODE_ALL, array $tags = [])
{
    $result = parent::clean($mode, $tags, $mode);
    $this->log(compact('tags', 'mode'));
    return $result;
}

2 Magento\Framework\Cache\Frontend\Decorator\Bare::clean()

github.com

magento/magento2/blob/2.2.0-RC1.1/lib/internal/Magento/Framework/Cache/Frontend/Decorator/Bare.php#L86-L92


/**
 * {@inheritdoc}
 */
public function clean($mode = \Zend_Cache::CLEANING_MODE_ALL, array $tags = [])
{
    return $this->_getFrontend()->clean($mode, $tags);
}

3. Magento\Framework\Cache\Frontend\Decorator\TagScope::clean()

github.com

magento/magento2/blob/2.2.0-RC1.1/lib/internal/Magento/Framework/Cache/Frontend/Decorator/TagScope.php#L54-L78


/**
 * Limit the cleaning scope within a tag
 *
 * {@inheritdoc}
 */
public function clean($mode = \Zend_Cache::CLEANING_MODE_ALL, array $tags = [])
{
    if ($mode == \Zend_Cache::CLEANING_MODE_MATCHING_ANY_TAG) {
        $result = false;
        foreach ($tags as $tag) {
            if (parent::clean(\Zend_Cache::CLEANING_MODE_MATCHING_TAG, [$tag, $this->getTag()])) {
                $result = true;
            }
        }
    } else {
        if ($mode == \Zend_Cache::CLEANING_MODE_ALL) {
            $mode = \Zend_Cache::CLEANING_MODE_MATCHING_TAG;
            $tags = [$this->getTag()];
        } else {
            $tags[] = $this->getTag();
        }
        $result = parent::clean($mode, $tags);
    }
    return $result;
}

4. Magento\Framework\Cache\Frontend\Decorator\Bare::clean()

github.com

magento/magento2/blob/2.2.0-RC1.1/lib/internal/Magento/Framework/Cache/Frontend/Decorator/Bare.php#L86-L92


/**
 * {@inheritdoc}
 */
public function clean($mode = \Zend_Cache::CLEANING_MODE_ALL, array $tags = [])
{
    return $this->_getFrontend()->clean($mode, $tags);
}

5. Magento\Framework\Cache\Frontend\Adapter\Zend::clean()

github.com

magento/magento2/blob/2.2.0-RC1.1/lib/internal/Magento/Framework/Cache/Frontend/Adapter/Zend.php#L58-L80


/**
 * {@inheritdoc}
 *
 * @throws \InvalidArgumentException Exception is thrown when non-supported cleaning mode is specified
 */
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));
}

6. Magento\Framework\Cache\Core::clean()

github.com

magento/magento2/blob/2.2.0-RC1.1/lib/internal/Magento/Framework/Cache/Core.php#L77-L99


/**
 * 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 = [])
{
    $tags = $this->_tags($tags);
    return parent::clean($mode, $tags);
}

7. Zend_Cache_Core::clean()

github.com

magento/zf1/blob/1.13.1/library/Zend/Cache/Core.php#L433-L466


/**
 * 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  array|string $tags
 * @throws Zend_Cache_Exception
 * @return boolean True if ok
 */
public function clean($mode = 'all', $tags = array())
{
    if (!$this->_options['caching']) {
        return true;
    }
    if (!in_array($mode, array(Zend_Cache::CLEANING_MODE_ALL,
                               Zend_Cache::CLEANING_MODE_OLD,
                               Zend_Cache::CLEANING_MODE_MATCHING_TAG,
                               Zend_Cache::CLEANING_MODE_NOT_MATCHING_TAG,
                               Zend_Cache::CLEANING_MODE_MATCHING_ANY_TAG))) {
        Zend_Cache::throwException('Invalid cleaning mode');
    }
    $this->_validateTagsArray($tags);


    return $this->_backend->clean($mode, $tags);
}

8. Cm_Cache_Backend_File::clean()

github.com

colinmollenhour/Cm_Cache_Backend_File/blob/1.4/File.php#L201-L229


/**
 * Clean some cache records
 *
 * 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 array $tags
 * @return boolean true if no problem
 */
public function clean($mode = Zend_Cache::CLEANING_MODE_ALL, $tags = array())
{
    // We use this protected method to hide the recursive stuff
    clearstatcache();
    switch($mode) {
        case Zend_Cache::CLEANING_MODE_ALL:
        case Zend_Cache::CLEANING_MODE_OLD:
            return $this->_clean($this->_options['cache_dir'], $mode);
        default:
            return $this->_cleanNew($mode, $tags);
    }
}

9. Cm_Cache_Backend_File::_cleanNew()

github.com

colinmollenhour/Cm_Cache_Backend_File/blob/1.4/File.php#L488-L532


/**
 * Clean some cache records (protected method used for recursive stuff)
 *
 * Available modes are :
 * Zend_Cache::CLEANING_MODE_ALL (default)    => remove all cache entries ($tags is not used)
 * Zend_Cache::CLEANING_MODE_OLD              => remove too old cache entries ($tags is not used)
 * Zend_Cache::CLEANING_MODE_MATCHING_TAG     => remove cache entries matching all given tags
 *                                               ($tags can be an array of strings or a single string)
 * Zend_Cache::CLEANING_MODE_NOT_MATCHING_TAG => remove cache entries not {matching one of the given tags}
 *                                               ($tags can be an array of strings or a single string)
 * Zend_Cache::CLEANING_MODE_MATCHING_ANY_TAG => remove cache entries matching any given tags
 *                                               ($tags can be an array of strings or a single string)
 *
 * @param  string $mode Clean mode
 * @param  array  $tags Array of tags
 * @throws Zend_Cache_Exception
 * @return boolean True if no problem
 */
protected function _cleanNew($mode = Zend_Cache::CLEANING_MODE_ALL, $tags = array())
{
    $result = true;
    $ids = $this->_getIdsByTags($mode, $tags);
    foreach ($ids as $id) {
        $idFile = $this->_file($id);
        if (is_file($idFile)) {
            $result = $this->_remove($idFile) && $result;
        }
    }
    switch($mode)
    {
        case Zend_Cache::CLEANING_MODE_MATCHING_ANY_TAG:
            foreach ($tags as $tag) {
                $tagFile = $this->_tagFile($tag);
                if (is_file($tagFile)) {
                    $result = $this->_remove($tagFile) && $result;
                }
            }
            break;
        case Zend_Cache::CLEANING_MODE_NOT_MATCHING_TAG:
        case Zend_Cache::CLEANING_MODE_MATCHING_TAG:
            $this->_updateIdsTags($ids, $tags, 'diff');
            break;
    }
    return $result;
}