feature #14561 [FrameworkBundle][DX] Add option to specify additional translation loading paths (Seldaek)

aitboudad · aitboudad · commit 88b7e7ce599c · 2015-05-06T20:51:24.000Z
This PR was squashed before being merged into the 2.8 branch (closes #14561). Discussion ---------- [FrameworkBundle][DX] Add option to specify additional translation loading paths | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #971 | License | MIT | Doc PR | TODO Thanks to this PR, next time I want to just do: ``` translator: fallback: "%locale%" paths: ['%kernel.root_dir%/../vendor/internal/package/translations'] ``` I will be able to, and won't have to dig in docs, start building a translation loader before I realize it's not what I want, dig in the framework ext, and then have to write a compiler pass to inject my file to the translator resource paths. Commits ------- bba0a25 [FrameworkBundle][DX] Add option to specify additional translation loading paths
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
@@ -575,13 +575,17 @@ private function addTranslatorSection(ArrayNodeDefinition $rootNode)
                     ->info('translator configuration')
                     ->canBeEnabled()
                     ->fixXmlConfig('fallback')
+                    ->fixXmlConfig('path')
                     ->children()
                         ->arrayNode('fallbacks')
                             ->beforeNormalization()->ifString()->then(function ($v) { return array($v); })->end()
                             ->prototype('scalar')->end()
                             ->defaultValue(array('en'))
                         ->end()
                         ->booleanNode('logging')->defaultValue($this->debug)->end()
+                        ->arrayNode('paths')
+                            ->prototype('scalar')->end()
+                        ->end()
                     ->end()
                 ->end()
             ->end()
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -692,6 +692,13 @@ private function registerTranslatorConfiguration(array $config, ContainerBuilder
                 $dirs[] = $dir;
             }
         }
+        foreach ($config['paths'] as $dir) {
+            if (is_dir($dir)) {
+                $dirs[] = $dir;
+            } else {
+                throw new \UnexpectedValueException(sprintf('%s defined in translator.paths does not exist or is not a directory', $dir));
+            }
+        }
         if (is_dir($dir = $container->getParameter('kernel.root_dir').'/Resources/translations')) {
             $dirs[] = $dir;
         }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd b/src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd
@@ -183,6 +183,7 @@
     <xsd:complexType name="translator">
         <xsd:sequence>
             <xsd:element name="fallback" type="xsd:string" minOccurs="0" maxOccurs="unbounded" />
+            <xsd:element name="path" type="xsd:string" minOccurs="0" maxOccurs="unbounded" />
         </xsd:sequence>
         <xsd:attribute name="enabled" type="xsd:boolean" />
         <xsd:attribute name="fallback" type="xsd:string" />
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php
@@ -146,6 +146,7 @@ protected static function getBundleDefaultConfig()
                 'enabled' => false,
                 'fallbacks' => array('en'),
                 'logging' => true,
+                'paths' => array(),
             ),
             'validation' => array(
                 'enabled' => false,
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/full.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/full.php
@@ -50,6 +50,7 @@
     'translator' => array(
         'enabled' => true,
         'fallback' => 'fr',
+        'paths' => array('%kernel.root_dir%/Fixtures/translations'),
     ),
     'validation' => array(
         'enabled' => true,
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/translations/test_paths.en.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/translations/test_paths.en.yml
@@ -0,0 +1,2 @@
+custom:
+    paths: test
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/full.xml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/full.xml
@@ -34,7 +34,9 @@
                  <framework:resource>theme2</framework:resource>
             </framework:form>
         </framework:templating>
-        <framework:translator enabled="true" fallback="fr" logging="true" />
+        <framework:translator enabled="true" fallback="fr" logging="true">
+            <framework:path>%kernel.root_dir%/Fixtures/translations</framework:path>
+        </framework:translator>
         <framework:validation enabled="true" cache="apc" />
         <framework:annotations cache="file" debug="true" file-cache-dir="%kernel.cache_dir%/annotations" />
         <framework:serializer enabled="true" />
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/full.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/full.yml
@@ -39,6 +39,7 @@ framework:
     translator:
         enabled:  true
         fallback: fr
+        paths: ['%kernel.root_dir%/Fixtures/translations']
     validation:
         enabled: true
         cache:   apc
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php
@@ -244,6 +244,11 @@ public function testTranslator()
             $files,
             '->registerTranslatorConfiguration() finds Security translation resources'
         );
+        $this->assertContains(
+            strtr(__DIR__.'/Fixtures/translations/test_paths.en.yml', '/', DIRECTORY_SEPARATOR),
+            $files,
+            '->registerTranslatorConfiguration() finds translation resources in custom paths'
+        );
 
         $calls = $container->getDefinition('translator.default')->getMethodCalls();
         $this->assertEquals(array('fr'), $calls[0][1][0]);

Original file line number	Diff line number	Diff line change
`@@ -692,6 +692,13 @@ private function registerTranslatorConfiguration(array $config, ContainerBuilder`
`692`	`692`	`$dirs[] = $dir;`
`693`	`693`	`}`
`694`	`694`	`}`
	`695`	`+ foreach ($config['paths'] as $dir) {`
	`696`	`+ if (is_dir($dir)) {`
	`697`	`+ $dirs[] = $dir;`
	`698`	`+ } else {`
	`699`	`+ throw new \UnexpectedValueException(sprintf('%s defined in translator.paths does not exist or is not a directory', $dir));`
	`700`	`+ }`
	`701`	`+ }`
`695`	`702`	`if (is_dir($dir = $container->getParameter('kernel.root_dir').'/Resources/translations')) {`
`696`	`703`	`$dirs[] = $dir;`
`697`	`704`	`}`