Create a new ValidatorConfigCache class and pass metadata validators …

…in the constructor. That way, we can keep the isFresh() method and get away without deprecations.
symfony · bnw · Sep 3, 2015 · Sep 4, 2015 · Sep 4, 2015 · Sep 4, 2015
commit 23a4464fd059b56c48c7495a1e2c6f98e1de5ac6
diff --git a/src/Symfony/Bundle/FrameworkBundle/FrameworkBundle.php b/src/Symfony/Bundle/FrameworkBundle/FrameworkBundle.php
@@ -72,7 +72,6 @@ public function build(ContainerBuilder $container)
 
         $container->addCompilerPass(new RoutingResolverPass());
         $container->addCompilerPass(new ProfilerPass());
-        $container->addCompilerPass(new ConfigCachePass());
         // must be registered before removing private services as some might be listeners/subscribers
         // but as late as possible to get resolved parameters
         $container->addCompilerPass(new RegisterListenersPass(), PassConfig::TYPE_BEFORE_REMOVING);
@@ -94,6 +93,7 @@ public function build(ContainerBuilder $container)
         if ($container->getParameter('kernel.debug')) {
             $container->addCompilerPass(new ContainerBuilderDebugDumpPass(), PassConfig::TYPE_AFTER_REMOVING);
             $container->addCompilerPass(new CompilerDebugDumpPass(), PassConfig::TYPE_AFTER_REMOVING);
+            $container->addCompilerPass(new ConfigCachePass());
         }
     }
 }
diff --git a/src/Symfony/Component/Config/CHANGELOG.md b/src/Symfony/Component/Config/CHANGELOG.md
@@ -1,17 +1,6 @@
 CHANGELOG
 =========
 
-2.8.0
------
-
- * deprecated the `ConfigCache::isFresh()` method. Use the new `isValid()` method instead and
-   pass the `MetadataValidator` instances that shall be used to validate the cache. A single
-   `ResourceValidator` will do and perform the same validations (using `ResourceInterface`)
-   as `isFresh()` previously did.
-
-   Note that an even better approach would be to use the `ConfigCacheFactory`; it will
-   perform the freshness check for you and runs a callback if the cache needs to be updated.
-
 2.7.0
 -----
 

diff --git a/src/Symfony/Component/Config/ConfigCache.php b/src/Symfony/Component/Config/ConfigCache.php
@@ -12,30 +12,28 @@
 namespace Symfony\Component\Config;
 
 use Symfony\Component\Config\Resource\ResourceValidator;
-use Symfony\Component\Filesystem\Exception\IOException;
-use Symfony\Component\Filesystem\Filesystem;
 
 /**
  * ConfigCache caches arbitrary content in files on disk.
  *
- * Metadata can be stored alongside the cache and can later be
- * used by MetadataValidators to check if the cache is still fresh.
+ * When in debug mode, those metadata resources that implement
+ * \Symfony\Component\Config\Resource\ResourceInterface will
+ * be used to check cache freshness.
  *
  * @author Fabien Potencier <fabien@symfony.com>
  * @author Matthias Pigulla <mp@webfactory.de>
  */
-class ConfigCache implements ConfigCacheInterface
+class ConfigCache extends ValidatorConfigCache
 {
     private $debug;
-    private $file;
 
     /**
      * @param string $file  The absolute cache path
      * @param bool   $debug Whether debugging is enabled or not
      */
     public function __construct($file, $debug)
     {
-        $this->file = $file;
+        parent::__construct($file, array(new ResourceValidator()));
         $this->debug = (bool) $debug;
     }
 
@@ -50,127 +48,23 @@ public function __toString()
     {
         @trigger_error('ConfigCache::__toString() is deprecated since version 2.7 and will be removed in 3.0. Use the getPath() method instead.', E_USER_DEPRECATED);
 
-        return $this->file;
-    }
-
-    /**
-     * Gets the cache file path.
-     *
-     * @return string The cache file path
-     */
-    public function getPath()
-    {
-        return $this->file;
+        return $this->getPath();
     }
 
     /**
      * Checks if the cache is still fresh.
      *
-     * This method always returns true when debug is off and the
+     * This implementation always returns true when debug is off and the
      * cache file exists.
      *
      * @return bool true if the cache is fresh, false otherwise
-     *
-     * @deprecated since version 2.8, to be removed in 3.0.
      */
     public function isFresh()
     {
-        @trigger_error(__NAMESPACE__.'\ConfigCache::isFresh() is deprecated since version 2.8 and will be removed in 3.0. Use the isValid() method instead and pass the appropriate MetadataValidators, or even better use a \Symfony\Component\Config\ConfigCacheFactoryInterface implementation to create and validate the cache.', E_USER_DEPRECATED);
-
-        if (!$this->debug && is_file($this->file)) {
+        if (!$this->debug && is_file($this->getPath())) {
             return true;
         }
 
-        return $this->isValid(array(new ResourceValidator()));
-    }
-
-    /**
-     * Use MetadataValidators to check if the cache is still valid.
-     *
-     * The first MetadataValidator that supports a given resource is considered authoritative.
-     * Resources with no matching MetadataValidators will silently be ignored and considered fresh.
-     *
-     * This method <em>does not</em> take the debug flag into consideration: Whether or not a cache
-     * should be checked in production mode and/or which validators need to be applied is a decision
-     * left to the client of this method.
-     *
-     * @param MetadataValidatorInterface[] $validators List of validators the metadata is checked against.
-     *                                                 The first validator that supports a resource is considered authoritative.
-     *
-     * @return bool True if all supported resources and valid, false otherwise
-     */
-    public function isValid(array $validators = null)
-    {
-        if (!is_file($this->file)) {
-            return false;
-        }
-
-        if (!$validators) {
-            return true; // shortcut - if we don't have any validators we don't need to bother with the meta file at all
-        }
-
-        $metadata = $this->getMetaFile();
-        if (!is_file($metadata)) {
-            return true;
-        }
-
-        $time = filemtime($this->file);
-        $meta = unserialize(file_get_contents($metadata));
-
-        foreach ($meta as $resource) {
-            foreach ($validators as $validator) {
-                if (!$validator->supports($resource)) {
-                    continue; // next validator
-                }
-                if ($validator->isFresh($resource, $time)) {
-                    break; // no need to further check this resource
-                } else {
-                    return false; // cache is stale
-                }
-            }
-            // no suitable validator found, ignore this resource
-        }
-
-        return true;
-    }
-
-    /**
-     * Writes cache.
-     *
-     * @param string $content  The content to write in the cache
-     * @param array  $metadata An array of metadata
-     *
-     * @throws \RuntimeException When cache file can't be written
-     */
-    public function write($content, array $metadata = null)
-    {
-        $mode = 0666;
-        $umask = umask();
-        $filesystem = new Filesystem();
-        $filesystem->dumpFile($this->file, $content, null);
-        try {
-            $filesystem->chmod($this->file, $mode, $umask);
-        } catch (IOException $e) {
-            // discard chmod failure (some filesystem may not support it)
-        }
-
-        if (null !== $metadata) {
-            $filesystem->dumpFile($this->getMetaFile(), serialize($metadata), null);
-            try {
-                $filesystem->chmod($this->getMetaFile(), $mode, $umask);
-            } catch (IOException $e) {
-                // discard chmod failure (some filesystem may not support it)
-            }
-        }
-    }
-
-    /**
-     * Gets the meta file path.
-     *
-     * @return string The meta file path
-     */
-    private function getMetaFile()
-    {
-        return $this->file.'.meta';
+        return parent::isFresh();
     }
 }
diff --git a/src/Symfony/Component/Config/ConfigCacheFactory.php b/src/Symfony/Component/Config/ConfigCacheFactory.php
@@ -45,7 +45,7 @@ public function cache($file, $callback)
         }
 
         $cache = new ConfigCache($file, $this->debug);
-        if (!$cache->isValid(array(new ResourceValidator()))) {
+        if (!$cache->isFresh()) {
             call_user_func($callback, $cache);
         }
 

diff --git a/src/Symfony/Component/Config/ConfigCacheInterface.php b/src/Symfony/Component/Config/ConfigCacheInterface.php
@@ -33,10 +33,6 @@ public function getPath();
      * This check should take the metadata passed to the write() method into consideration.
      *
      * @return bool Whether the cache is still fresh.
-     *
-     * @deprecated since 2.8, to be removed in 3.0.
-     *      Use Symfony\Component\Config\ConfigCacheFactory instead, it will take care of
-     *      validating the cache.
      */
     public function isFresh();