-- tweak the translation loader, writer and extractor

symfony · michelsalib · Jun 11, 2011 · Jun 11, 2011 · Jun 11, 2011 · Jun 13, 2011
commit 7c0329478bb273654bd28cc5763ac8c58ff0fc65
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/TranslationUpdateCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/TranslationUpdateCommand.php
@@ -83,14 +83,14 @@ protected function execute(InputInterface $input, OutputInterface $output)
 
         // load any messages from templates
         $output->writeln('Parsing templates');
-        $templateExtractor = $this->container->get('translation.extractor.template');
-        $templateExtractor->setPrefix($input->getOption('prefix'));
-        $templateExtractor->extractMessages($foundBundle->getPath() . '/Resources/views/', $catalogue);
+        $extractor = $this->container->get('translation.extractor');
+        $extractor->setPrefix($input->getOption('prefix'));
+        $extractor->extractMessages($foundBundle->getPath() . '/Resources/views/', $catalogue);
 
         // load any existing messages from the translation files
-        $output->writeln('Parsing translation files');
-        $fileExtractor = $this->container->get('translation.extractor.file');
-        $fileExtractor->extractMessages($bundleTransPath, $catalogue);
+        $output->writeln('Loading translation files');
+        $loader = $this->container->get('translation.loader');
+        $loader->loadMessages($bundleTransPath, $catalogue);
 
         // show compiled list of messages
         if($input->getOption('dump-messages') === true){

diff --git a/...iler/TranslationTemplateExtractorPass.php → ...ion/Compiler/TranslationExtractorPass.php b/...iler/TranslationTemplateExtractorPass.php → ...ion/Compiler/TranslationExtractorPass.php
@@ -7,17 +7,17 @@
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 
 /**
- * Adds tagged translation.extractor services to template translation extractor
+ * Adds tagged translation.extractor services to translation extractor
  */
-class TranslationTemplateExtractorPass implements CompilerPassInterface
+class TranslationExtractorPass implements CompilerPassInterface
 {
     public function process(ContainerBuilder $container)
     {
-        if (!$container->hasDefinition('translation.extractor.template')) {
+        if (!$container->hasDefinition('translation.extractor')) {
             return;
         }
 
-        $definition = $container->getDefinition('translation.extractor.template');
+        $definition = $container->getDefinition('translation.extractor');
 
         foreach ($container->findTaggedServiceIds('translation.extractor') as $id => $attributes) {
             $definition->addMethodCall('addExtractor', array($attributes[0]['alias'], new Reference($id)));

diff --git a/...fony/Bundle/FrameworkBundle/DependencyInjection/Compiler/TranslationFileExtractorPass.php b/...fony/Bundle/FrameworkBundle/DependencyInjection/Compiler/TranslationFileExtractorPass.php
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/TranslatorPass.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/TranslatorPass.php
@@ -11,21 +11,27 @@
 
 namespace Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler;
 
+use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 
 class TranslatorPass implements CompilerPassInterface
 {
     public function process(ContainerBuilder $container)
     {
-        if (!$container->hasDefinition('translator.real')) {
-            return;
+        if ($container->hasDefinition('translator.real')) {
+            $loaders = array();
+            foreach ($container->findTaggedServiceIds('translation.loader') as $id => $attributes) {
+                $loaders[$id] = $attributes[0]['alias'];
+            }
+            $container->findDefinition('translator.real')->replaceArgument(2, $loaders);
         }
 
-        $loaders = array();
-        foreach ($container->findTaggedServiceIds('translation.loader') as $id => $attributes) {
-            $loaders[$id] = $attributes[0]['alias'];
+        if ($container->hasDefinition('translation.loader')) {
+            $definition = $container->getDefinition('translation.loader');
+            foreach ($container->findTaggedServiceIds('translation.loader') as $id => $attributes) {
+                $definition->addMethodCall('addLoader', array($attributes[0]['alias'], new Reference($id)));
+            }
         }
-        $container->findDefinition('translator.real')->replaceArgument(2, $loaders);
     }
 }
diff --git a/src/Symfony/Bundle/FrameworkBundle/FrameworkBundle.php b/src/Symfony/Bundle/FrameworkBundle/FrameworkBundle.php
@@ -21,8 +21,7 @@
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\AddCacheWarmerPass;
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\ContainerBuilderDebugDumpPass;
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\CompilerDebugDumpPass;
-use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\TranslationTemplateExtractorPass;
-use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\TranslationFileExtractorPass;
+use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\TranslationExtractorPass;
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\TranslationWriterPass;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Compiler\PassConfig;
@@ -51,8 +50,7 @@ public function build(ContainerBuilder $container)
         $container->addCompilerPass(new FormPass());
         $container->addCompilerPass(new TranslatorPass());
         $container->addCompilerPass(new AddCacheWarmerPass());
-        $container->addCompilerPass(new TranslationTemplateExtractorPass());
-        $container->addCompilerPass(new TranslationFileExtractorPass());
+        $container->addCompilerPass(new TranslationExtractorPass());
         $container->addCompilerPass(new TranslationWriterPass());
 
         if ($container->getParameter('kernel.debug')) {

diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/translation.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/translation.xml
@@ -16,9 +16,9 @@
         <parameter key="translation.formatter.xliff.class">Symfony\Component\Translation\Formatter\XliffFormatter</parameter>
         <parameter key="translation.formatter.yml.class">Symfony\Component\Translation\Formatter\YamlFormatter</parameter>
         <parameter key="translation.extractor.php.class">Symfony\Bundle\FrameworkBundle\Translation\PhpExtractor</parameter>
-        <parameter key="translation.extractor.template.class">Symfony\Bundle\FrameworkBundle\Translation\TemplateTranslationExtractor</parameter>
-        <parameter key="translation.extractor.file.class">Symfony\Bundle\FrameworkBundle\Translation\FileTranslationExtractor</parameter>
-        <parameter key="translation.writer.class">Symfony\Bundle\FrameworkBundle\Translation\FileTranslationWriter</parameter>
+        <parameter key="translation.loader.class">Symfony\Bundle\FrameworkBundle\Translation\TranslationLoader</parameter>
+        <parameter key="translation.extractor.class">Symfony\Component\Translation\Extractor\TranslationExtractor</parameter>
+        <parameter key="translation.writer.class">Symfony\Component\Translation\Writer\TranslationWriter</parameter>
     </parameters>
 
     <services>
@@ -71,9 +71,9 @@
             <tag name="translation.extractor" alias="php" />
         </service>
 
-        <service id="translation.extractor.template" class="%translation.extractor.template.class%"/>
+        <service id="translation.loader" class="%translation.loader.class%"/>
 
-        <service id="translation.extractor.file" class="%translation.extractor.file.class%"/>
+        <service id="translation.extractor" class="%translation.extractor.class%"/>
 
         <service id="translation.writer" class="%translation.writer.class%"/>
     </services>

diff --git a/src/Symfony/Bundle/FrameworkBundle/Translation/PhpExtractor.php b/src/Symfony/Bundle/FrameworkBundle/Translation/PhpExtractor.php
@@ -2,7 +2,9 @@
 
 namespace Symfony\Bundle\FrameworkBundle\Translation;
 
+use Symfony\Component\Finder\Finder;
 use Symfony\Component\Translation\MessageCatalogue;
+use Symfony\Component\Translation\Extractor\ExtractorInterface;
 
 /**
  * Extract translation messages from a php template
@@ -41,9 +43,14 @@ class PhpExtractor implements ExtractorInterface
     /**
      * {@inheritDoc}
      */
-    public function load($file, MessageCatalogue $catalog)
+    public function load($directory, MessageCatalogue $catalog)
     {
-        $this->parseTokens(token_get_all(file_get_contents($file)), $catalog);
+        // load any existing translation files
+        $finder = new Finder();
+        $files = $finder->files()->name('*.php')->in($directory);
+        foreach ($files as $file) {
+            $this->parseTokens(token_get_all(file_get_contents($file)), $catalog);
+        }
     }
 
     /**
@@ -62,8 +69,9 @@ public function setPrefix($prefix)
      */
     protected function normalizeToken($token)
     {
-        if(is_array($token))
+        if (is_array($token)) {
             return $token[1];
+        }
 
         return $token;
     }
@@ -83,14 +91,11 @@ protected function parseTokens($tokens, MessageCatalogue $catalog)
                 foreach ($sequence as $id => $item) {
                     if($this->normalizeToken($tokens[$key + $id]) == $item) {
                         continue;
-                    }
-                    elseif (self::MESSAGE_TOKEN == $item) {
+                    } elseif (self::MESSAGE_TOKEN == $item) {
                         $message = $this->normalizeToken($tokens[$key + $id]);
-                    }
-                    elseif (self::IGNORE_TOKEN == $item) {
+                    } elseif (self::IGNORE_TOKEN == $item) {
                         continue;
-                    }
-                    else {
+                    } else {
                         break;
                     }
                 }

diff --git a/.../Translation/FileTranslationExtractor.php → ...kBundle/Translation/TranslationLoader.php b/.../Translation/FileTranslationExtractor.php → ...kBundle/Translation/TranslationLoader.php
@@ -7,9 +7,9 @@
 use Symfony\Component\Translation\Loader\LoaderInterface;
 
 /**
- * Extract translation messages from translation files
+ * Load translation messages from translation files
  */
-class FileTranslationExtractor
+class TranslationLoader
 {
     /**
      * Loaders used for import
@@ -29,12 +29,12 @@ public function addLoader($format, LoaderInterface $loader)
     }
 
     /**
-     * Extract translation messages from a directory to the catalogue
+     * Load translation messages from a directory to the catalogue
      * 
      * @param string $directory the directory to look into
      * @param MessageCatalogue $catalogue the catalogue
      */
-    public function extractMessages($directory, MessageCatalogue $catalogue)
+    public function loadMessages($directory, MessageCatalogue $catalogue)
     {
         foreach($this->loaders as $format => $loader) {
             // load any existing translation files

diff --git a/src/Symfony/Bundle/TwigBundle/Translation/TwigExtractor.php b/src/Symfony/Bundle/TwigBundle/Translation/TwigExtractor.php
@@ -2,7 +2,8 @@
 
 namespace Symfony\Bundle\TwigBundle\Translation;
 
-use Symfony\Bundle\FrameworkBundle\Translation\ExtractorInterface;
+use Symfony\Component\Finder\Finder;
+use Symfony\Component\Translation\Extractor\ExtractorInterface;
 use Symfony\Component\Translation\MessageCatalogue;
 use Symfony\Bridge\Twig\Node\TransNode;
 use Twig_Environment;
@@ -40,10 +41,15 @@ public function __construct(Twig_Environment $twig)
     /**
      * {@inheritDoc}
      */
-    public function load($file, MessageCatalogue $catalogue)
+    public function load($directory, MessageCatalogue $catalogue)
     {
-        $tree = $this->twig->parse($this->twig->tokenize(file_get_contents($file->getPathname())));
-        $this->crawlNode($tree, $catalogue);
+        // load any existing translation files
+        $finder = new Finder();
+        $files = $finder->files()->name('*.twig')->in($directory);
+        foreach ($files as $file) {
+            $tree = $this->twig->parse($this->twig->tokenize(file_get_contents($file->getPathname())));
+            $this->crawlNode($tree, $catalogue);
+        }
     }
 
     /**

diff --git a/...Bundle/Translation/ExtractorInterface.php → ...nslation/Extractor/ExtractorInterface.php b/...Bundle/Translation/ExtractorInterface.php → ...nslation/Extractor/ExtractorInterface.php
@@ -1,20 +1,21 @@
 <?php
 
-namespace Symfony\Bundle\FrameworkBundle\Translation;
+namespace Symfony\Component\Translation\Extractor;
 
 use Symfony\Component\Translation\MessageCatalogue;
 
 /**
  * Interface implemented by all extractors
  */
-interface ExtractorInterface {
+interface ExtractorInterface
+{
     /**
-     * Extract translation messages from a template file to the catalogue
+     * Extract translation messages from a template directory to the catalogue
      * 
-     * @param string $file the path to the template file to look into
+     * @param string $directory the path to look into
      * @param MessageCatalogue $catalogue the catalogue
      */
-    function load($file, MessageCatalogue $catalogue);
+    function load($directory, MessageCatalogue $catalogue);
 
     /**
      * Set the prefix that should be used for new found messages

diff --git a/...nslation/TemplateTranslationExtractor.php → ...lation/Extractor/TranslationExtractor.php b/...nslation/TemplateTranslationExtractor.php → ...lation/Extractor/TranslationExtractor.php
@@ -1,14 +1,13 @@
 <?php
 
-namespace Symfony\Bundle\FrameworkBundle\Translation;
+namespace Symfony\Component\Translation\Extractor;
 
-use Symfony\Component\Finder\Finder;
 use Symfony\Component\Translation\MessageCatalogue;
 
 /**
- * Extract translation messages from translation files
+ * Extract translation messages from template files
  */
-class TemplateTranslationExtractor
+class TranslationExtractor
 {
     /**
      * Extractors
@@ -20,11 +19,11 @@ class TemplateTranslationExtractor
     /**
      * Add a loader to the translation extractor
      * @param string $format The format of the loader
-     * @param ExtractorInterface $extactor 
+     * @param ExtractorInterface $extractor 
      */
-    public function addExtractor($format, ExtractorInterface $extactor)
+    public function addExtractor($format, ExtractorInterface $extractor)
     {
-        $this->extractors[$format] = $extactor;
+        $this->extractors[$format] = $extractor;
     }
 
     /**
@@ -45,13 +44,8 @@ public function setPrefix($prefix)
      */
     public function extractMessages($directory, MessageCatalogue $catalogue)
     {
-        foreach($this->extractors as $format => $extactor) {
-            // load any existing translation files
-            $finder = new Finder();
-            $files = $finder->files()->name('*.'.$format)->in($directory);
-            foreach ($files as $file) {
-                $extactor->load($file, $catalogue);
-            }
+        foreach ($this->extractors as $extractor) {
+            $extractor->load($directory, $catalogue);
         }
     }
 }
diff --git a/...dle/Translation/FileTranslationWriter.php → .../Translation/Writer/TranslationWriter.php b/...dle/Translation/FileTranslationWriter.php → .../Translation/Writer/TranslationWriter.php
@@ -1,15 +1,15 @@
 <?php
 
-namespace Symfony\Bundle\FrameworkBundle\Translation;
+namespace Symfony\Component\Translation\Writer;
 
 use Symfony\Component\Translation\MessageCatalogue;
 use Symfony\Component\Translation\Formatter\FormatterInterface;
 
 /**
  * Write translation messages to translation files
  */
-class FileTranslationWriter
-{    
+class TranslationWriter
+{
     /**
      * Formatters used for export
      *