[FrameworkBundle] added logging capabilities to translator

symfony · meandmymonkey · Apr 11, 2012 · Apr 11, 2012 · Apr 11, 2012 · Apr 11, 2012
commit cbd5f990afdccf6698f1277467fc3990bf3dd10c
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
@@ -337,6 +337,7 @@ private function addTranslatorSection(ArrayNodeDefinition $rootNode)
                     ->treatTrueLike(array('enabled' => true))
                     ->children()
                         ->booleanNode('enabled')->defaultTrue()->end()
+                        ->booleanNode('enable_logging')->defaultFalse()->end()
                         ->scalarNode('fallback')->defaultValue('en')->end()
                     ->end()
                 ->end()

diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -549,6 +549,10 @@ private function registerTranslatorConfiguration(array $config, ContainerBuilder
                     $translator->addMethodCall('addResource', array($format, (string) $file, $locale, $domain));
                 }
             }
+
+            if ($config['enable_logging']) {
+                $translator->addMethodCall('setLogger', array(new Reference('logger')));
+            }
         }
     }
 

diff --git a/src/Symfony/Bundle/FrameworkBundle/Translation/Translator.php b/src/Symfony/Bundle/FrameworkBundle/Translation/Translator.php
@@ -13,8 +13,10 @@
 
 use Symfony\Component\Translation\Translator as BaseTranslator;
 use Symfony\Component\Translation\MessageSelector;
+use Symfony\Component\Translation\MessageCatalogueInterface;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\Config\ConfigCache;
+use Symfony\Component\HttpKernel\Log\LoggerInterface;
 
 /**
  * Translator.
@@ -26,6 +28,7 @@ class Translator extends BaseTranslator
     protected $container;
     protected $options;
     protected $loaderIds;
+    protected $logger;
 
     /**
      * Constructor.
@@ -44,6 +47,7 @@ public function __construct(ContainerInterface $container, MessageSelector $sele
     {
         $this->container = $container;
         $this->loaderIds = $loaderIds;
+        $this->logger = null;
 
         $this->options = array(
             'cache_dir' => null,
@@ -72,6 +76,27 @@ public function getLocale()
         return $this->locale;
     }
 
+    public function setLogger(LoggerInterface $logger)
+    {
+        $this->logger = $logger;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function validateCatalogueForId(MessageCatalogueInterface $catalogue, $id, $domain)
+    {
+        if (null !== $this->logger && !$catalogue->defines($id, $domain)) {
+            if ($catalogue->has($id, $domain)) {
+                $this->logger->notice('Translator: using fallback catalogue.', array('id' => $id, 'domain' => $domain));
+            } else {
+                $this->logger->warn('Translator: translation not found.', array('id' => $id, 'domain' => $domain));
+            }
+        }
+
+        return parent::validateCatalogueForId($catalogue, $id, $domain);
+    }
+
     /**
      * {@inheritdoc}
      */
-Original file line number
+Diff line change
@@ Expand Up @@
                         $translator->addMethodCall('addResource', array($format, (string) $file, $locale, $domain));
                     }
                 }
+                if ($config['enable_logging']) {
+                    $translator->addMethodCall('setLogger', array(new Reference('logger')));
+                }
             }
         }
@@ Expand Down @@