Delegate creation of ConfigCache instances to a factory.

symfony · mpdude · Apr 21, 2013 · Apr 21, 2013 · Nov 24, 2013 · Nov 24, 2013
commit 6713e1001087baca92d3fdfc314b28369727f8e2
diff --git a/src/Symfony/Bundle/FrameworkBundle/Translation/Translator.php b/src/Symfony/Bundle/FrameworkBundle/Translation/Translator.php
@@ -14,7 +14,9 @@
 use Symfony\Component\Translation\Translator as BaseTranslator;
 use Symfony\Component\Translation\MessageSelector;
 use Symfony\Component\DependencyInjection\ContainerInterface;
-use Symfony\Component\Config\ConfigCache;
+use Symfony\Component\Config\ConfigCacheFactoryInterface;
+use Symfony\Component\Config\DefaultConfigCacheFactory;
+use Symfony\Component\Config\ConfigCacheInterface;
 
 /**
  * Translator.
@@ -29,6 +31,7 @@ class Translator extends BaseTranslator
         'debug'     => false,
     );
     protected $loaderIds;
+    protected $configCacheFactory;
 
     /**
      * Constructor.
@@ -60,6 +63,31 @@ public function __construct(ContainerInterface $container, MessageSelector $sele
         parent::__construct(null, $selector);
     }
 
+    /**
+     * Sets the ConfigCache factory to use.
+     *
+     * @param ConfigCacheFactoryInterface $configCacheFactory
+     */
+    public function setConfigCacheFactory(ConfigCacheFactoryInterface $configCacheFactory)
+    {
+        $this->configCacheFactory = $configCacheFactory;
+    }
+
+    /**
+     * Provides the ConfigCache factory implementation, falling back to a
+     * default implementation if necessary.
+     *
+     * @return ConfigCacheFactoryInterface $configCacheFactory
+     */
+    private function getConfigCacheFactory()
+    {
+        if (!$this->configCacheFactory) {
+            $this->configCacheFactory = new DefaultConfigCacheFactory($this->options['debug']);
+        }
+
+        return $this->configCacheFactory;
+    }
+
     /**
      * {@inheritdoc}
      */
@@ -87,18 +115,30 @@ protected function loadCatalogue($locale)
             return parent::loadCatalogue($locale);
         }
 
-        $cache = new ConfigCache($this->options['cache_dir'].'/catalogue.'.$locale.'.php', $this->options['debug']);
-        if (!$cache->isFresh()) {
-            $this->initialize();
+        $self = $this;
+        $cache = $this->getConfigCacheFactory()->cache($this->options['cache_dir'].'/catalogue.'.$locale.'.php', function ($cache) use ($self, $locale) {
+            $self->fillCache($cache, $locale);
+        });
+
+        if (!isset($this->catalogues[$locale])) {
+            $this->catalogues[$locale] = include $cache;
+        }
+
+    }
 
-            parent::loadCatalogue($locale);
+    /* This method is only public to allow it to be called from a callback (prior PHP 5.4?) */
+    public function fillCache(ConfigCacheInterface $cache, $locale)
+    {
+        $this->initialize();
+
+        parent::loadCatalogue($locale);
 
-            $fallbackContent = '';
-            $current = '';
-            foreach ($this->computeFallbackLocales($locale) as $fallback) {
-                $fallbackSuffix = ucfirst(str_replace('-', '_', $fallback));
+        $fallbackContent = '';
+        $current = '';
+        foreach ($this->computeFallbackLocales($locale) as $fallback) {
+            $fallbackSuffix = ucfirst(str_replace('-', '_', $fallback));
 
-                $fallbackContent .= sprintf(<<<EOF
+            $fallbackContent .= sprintf(<<<EOF
 \$catalogue%s = new MessageCatalogue('%s', %s);
 \$catalogue%s->addFallbackCatalogue(\$catalogue%s);
 
@@ -114,7 +154,7 @@ protected function loadCatalogue($locale)
                 $current = $fallback;
             }
 
-            $content = sprintf(<<<EOF
+        $content = sprintf(<<<EOF
 <?php
 
 use Symfony\Component\Translation\MessageCatalogue;
@@ -125,18 +165,13 @@ protected function loadCatalogue($locale)
 return \$catalogue;
 
 EOF
-                ,
-                $locale,
-                var_export($this->catalogues[$locale]->all(), true),
-                $fallbackContent
-            );
-
-            $cache->write($content, $this->catalogues[$locale]->getResources());
-
-            return;
-        }
+            ,
+            $locale,
+            var_export($this->catalogues[$locale]->all(), true),
+            $fallbackContent
+        );
 
-        $this->catalogues[$locale] = include $cache;
+        $cache->write($content, $this->catalogues[$locale]->getResources());
     }
 
     protected function initialize()

diff --git a/src/Symfony/Component/Config/ConfigCache.php b/src/Symfony/Component/Config/ConfigCache.php
@@ -22,7 +22,7 @@
  *
  * @author Fabien Potencier <[email protected]>
  */
-class ConfigCache
+class ConfigCache implements ConfigCacheInterface
 {
     private $debug;
     private $file;

diff --git a/src/Symfony/Component/Config/ConfigCacheFactoryInterface.php b/src/Symfony/Component/Config/ConfigCacheFactoryInterface.php
@@ -0,0 +1,31 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Config;
+
+/**
+ * Interface for a ConfigCache factory. This factory creates
+ * an instance of ConfigCacheInterface and initializes the
+ * cache if necessary.
+ *
+ * @author Matthias Pigulla <[email protected]>
+ */
+interface ConfigCacheFactoryInterface
+{
+    /**
+     * Creates a cache instance and (re-)initializes it if necessary.
+     *
+     * @param  string               $file        The absolute cache file path
+     * @param  callable             $callable    The callable to be executed when the cache needs to be filled (i. e. is not fresh). The cache will be passed as the only parameter to this callback.
+     * @return ConfigCacheInterface $configCache The cache instance.
+     */
+    public function cache($file, $callable);
+}
diff --git a/src/Symfony/Component/Config/ConfigCacheInterface.php b/src/Symfony/Component/Config/ConfigCacheInterface.php
@@ -0,0 +1,44 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Config;
+
+/**
+ * Interface for ConfigCache
+ *
+ * @author Matthias Pigulla <[email protected]>
+ */
+interface ConfigCacheInterface
+{
+    /**
+     * Gets the cache file path.
+     *
+     * @return string The cache file path
+     */
+    public function __toString();
+
+    /**
+     * Checks if the cache is still fresh.
+     *
+     * @return Boolean true if the cache is fresh, false otherwise
+     */
+    public function isFresh();
+
+    /**
+     * Writes cache.
+     *
+     * @param string              $content  The content to write into the cache
+     * @param ResourceInterface[] $metadata An array of ResourceInterface instances
+     *
+     * @throws \RuntimeException When the cache file cannot be written
+     */
+    public function write($content, array $metadata = null);
+}
diff --git a/src/Symfony/Component/Config/DefaultConfigCacheFactory.php b/src/Symfony/Component/Config/DefaultConfigCacheFactory.php
@@ -0,0 +1,44 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Config;
+
+/**
+ * Default implementation for ConfigCacheFactoryInterface
+ * that will create an instance of ConfigCache.
+ *
+ * @author Matthias Pigulla <[email protected]>
+ */
+class DefaultConfigCacheFactory implements ConfigCacheFactoryInterface
+{
+    /** @var bool Debug flag passed to the ConfigCache */
+    private $debug;
+
+    /**
+     * Constructor.
+     *
+     * @param bool $debug The debug flag to pass to ConfigCache.
+     */
+    public function __construct($debug)
+    {
+        $this->debug = $debug;
+    }
+
+    /**
+    * {@inheritdoc}
+    */
+    public function cache($file, $callback)
+    {
+        $cache = new ConfigCache($file, $this->debug);
+        if (!$cache->isFresh()) call_user_func($callback, $cache);
+        return $cache;
+    }
+}
diff --git a/src/Symfony/Component/Routing/Router.php b/src/Symfony/Component/Routing/Router.php
@@ -12,7 +12,8 @@
 namespace Symfony\Component\Routing;
 
 use Symfony\Component\Config\Loader\LoaderInterface;
-use Symfony\Component\Config\ConfigCache;
+use Symfony\Component\Config\ConfigCacheFactoryInterface;
+use Symfony\Component\Config\DefaultConfigCacheFactory;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\Routing\Generator\ConfigurableRequirementsInterface;
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
@@ -70,6 +71,11 @@ class Router implements RouterInterface, RequestMatcherInterface
      */
     protected $logger;
 
+    /**
+     * @var ConfigCacheFactoryInterface|null
+     */
+    protected $configCacheFactory;
+
     /**
      * Constructor.
      *
@@ -203,6 +209,16 @@ public function getContext()
         return $this->context;
     }
 
+    /**
+     * Sets the ConfigCache factory to use.
+     *
+     * @param ConfigCacheFactoryInterface $configCacheFactory The factory to use.
+     */
+    public function setConfigCacheFactory(ConfigCacheFactoryInterface $configCacheFactory)
+    {
+        $this->configCacheFactory = $configCacheFactory;
+    }
+
     /**
      * {@inheritdoc}
      */
@@ -249,17 +265,21 @@ public function getMatcher()
         }
 
         $class = $this->options['matcher_cache_class'];
-        $cache = new ConfigCache($this->options['cache_dir'].'/'.$class.'.php', $this->options['debug']);
-        if (!$cache->isFresh()) {
-            $dumper = $this->getMatcherDumperInstance();
+        $routerOptions = $this->options;
+        $self = $this;
 
-            $options = array(
-                'class'      => $class,
-                'base_class' => $this->options['matcher_base_class'],
-            );
+        $cache = $this->getConfigCacheFactory()->cache($this->options['cache_dir'].'/'.$class.'.php',
+            function($cache) use ($routerOptions, $self, $class) {
+                $dumper = $this->getMatcherDumperInstance();
 
-            $cache->write($dumper->dump($options), $this->getRouteCollection()->getResources());
-        }
+                $options = array(
+                    'class'      => $class,
+                    'base_class' => $routerOptions['matcher_base_class'],
+                );
+
+                $cache->write($dumper->dump($options), $self->getRouteCollection()->getResources());
+            }
+        );
 
         require_once $cache;
 
@@ -281,17 +301,21 @@ public function getGenerator()
             $this->generator = new $this->options['generator_class']($this->getRouteCollection(), $this->context, $this->logger);
         } else {
             $class = $this->options['generator_cache_class'];
-            $cache = new ConfigCache($this->options['cache_dir'].'/'.$class.'.php', $this->options['debug']);
-            if (!$cache->isFresh()) {
-                $dumper = $this->getGeneratorDumperInstance();
+            $baseClass = $this->options['generator_base_class'];
+            $self = $this;
 
-                $options = array(
-                    'class'      => $class,
-                    'base_class' => $this->options['generator_base_class'],
-                );
+            $cache = $this->getConfigCacheFactory()->cache($this->options['cache_dir'].'/'.$class.'.php',
+                function($cache) use ($self, $class, $baseClass) {
+                    $dumper = $self->getGeneratorDumperInstance();
 
-                $cache->write($dumper->dump($options), $this->getRouteCollection()->getResources());
-            }
+                    $options = array(
+                        'class'      => $class,
+                        'base_class' => $baseClass,
+                    );
+
+                    $cache->write($dumper->dump($options), $self->getRouteCollection()->getResources());
+                }
+            );
 
             require_once $cache;
 
@@ -308,16 +332,31 @@ public function getGenerator()
     /**
      * @return GeneratorDumperInterface
      */
-    protected function getGeneratorDumperInstance()
+    public function getGeneratorDumperInstance()
     {
         return new $this->options['generator_dumper_class']($this->getRouteCollection());
     }
 
     /**
      * @return MatcherDumperInterface
      */
-    protected function getMatcherDumperInstance()
+    public function getMatcherDumperInstance()
     {
         return new $this->options['matcher_dumper_class']($this->getRouteCollection());
     }
+
+    /**
+     * Provides the ConfigCache factory implementation, falling back to a
+     * default implementation if necessary.
+     *
+     * @return ConfigCacheFactoryInterface $configCacheFactory
+     */
+    protected function getConfigCacheFactory()
+    {
+        if (null === $this->configCacheFactory) {
+            $this->configCacheFactory = new DefaultConfigCacheFactory($this->options['debug']);
+        }
+
+        return $this->configCacheFactory;
+    }
 }