Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit21431e3

Browse files
committed
deprecated the framework translator.
1 parente493100 commit21431e3

File tree

12 files changed

+226
-39
lines changed

12 files changed

+226
-39
lines changed

‎UPGRADE-2.8.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ Form
170170
}
171171
```
172172

173-
If your extension has to be compatible with Symfony 2.3-2.8, use the
173+
If your extension has to be compatible with Symfony 2.3-2.8, use the
174174
following statement:
175175

176176
```php
@@ -238,6 +238,18 @@ Form
238238
Translator
239239
----------
240240

241+
* Loading catalogues (file caching, resource loader, locale fallback) has been moved out of Translator and the class
242+
`Symfony\Bundle\FrameworkBundle\Translation\Translator` was deprecated and will be removed in Symfony 3.0.
243+
This introduced a**backwards-compatibility** break in the`translator.default` service.
244+
245+
A new configuration option,`use_legacy_translator` has been introduced to ease backwards-compatibility issues when upgrading.
246+
247+
```yaml
248+
framework:
249+
translator:
250+
use_legacy_translator: true
251+
```
252+
241253
* The`getMessages()` method of the`Symfony\Component\Translation\Translator` was deprecated and will be removed in
242254
Symfony 3.0. You should use the`getCatalogue()` method of the`Symfony\Component\Translation\TranslatorBagInterface`.
243255

@@ -448,7 +460,7 @@ Config
448460

449461
* The`\Symfony\Component\Config\Resource\ResourceInterface::isFresh()` method has been
450462
deprecated and will be removed in Symfony 3.0 because it assumes that resource
451-
implementations are able to check themselves for freshness.
463+
implementations are able to check themselves for freshness.
452464

453465
If you have custom resources that implement this method, change them to implement the
454466
`\Symfony\Component\Config\Resource\SelfCheckingResourceInterface` sub-interface instead
@@ -470,6 +482,6 @@ Config
470482
class MyCustomResource implements SelfCheckingResourceInterface { ... }
471483
```
472484

473-
Additionally, if you have implemented cache validation strategies*using*`isFresh()`
474-
yourself, you should have a look at the new cache validation system based on
485+
Additionally, if you have implemented cache validation strategies*using*`isFresh()`
486+
yourself, you should have a look at the new cache validation system based on
475487
`ResourceChecker`s.

‎src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/TranslatorPass.php

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,11 @@ public function process(ContainerBuilder $container)
4040
}
4141
}
4242

43-
$container->findDefinition('translator.default')->replaceArgument(2,$loaders);
43+
$translator =$container->findDefinition('translator.default');
44+
if ('Symfony\Bundle\FrameworkBundle\Translation\Translator' ===$translator->getClass()) {
45+
$translator->replaceArgument(2,$loaders);
46+
}else {
47+
$container->findDefinition('translation.catalogue_bag.resource')->replaceArgument(1,$loaders);
48+
}
4449
}
4550
}

‎src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -584,6 +584,7 @@ private function addTranslatorSection(ArrayNodeDefinition $rootNode)
584584
->defaultValue(array('en'))
585585
->end()
586586
->booleanNode('logging')->defaultValue($this->debug)->end()
587+
->booleanNode('use_legacy_translator')->defaultFalse()->end()
587588
->arrayNode('paths')
588589
->prototype('scalar')->end()
589590
->end()

‎src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php

Lines changed: 32 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -661,11 +661,28 @@ private function registerTranslatorConfiguration(array $config, ContainerBuilder
661661
}
662662
$this->translationConfigEnabled =true;
663663

664-
// Use the "real" translator instead of the identity default
665-
$container->setAlias('translator','translator.default');
666664
$translator =$container->findDefinition('translator.default');
667-
$translator->addMethodCall('setFallbackLocales',array($config['fallbacks']));
665+
if ($config['use_legacy_translator']) {
666+
$translator->addMethodCall('setFallbackLocales',array($config['fallbacks']));
667+
}else {
668+
$translator->setClass('Symfony\Component\Translation\Translator');
669+
$translator->setArguments(array(
670+
$container->getParameter('kernel.default_locale'),
671+
$container->findDefinition('translation.catalogue_bag.cache'),
672+
$container->findDefinition('translator.selector')
673+
));
674+
675+
if ($config['fallbacks']) {
676+
$fallbackCatalogue =$container->findDefinition('translation.catalogue_bag.fallback');
677+
$fallbackCatalogue->replaceArgument(1,$config['fallbacks']);
678+
679+
$cacheCatalogue =$container->findDefinition('translation.catalogue_bag.cache');
680+
$cacheCatalogue->replaceArgument(0,$fallbackCatalogue);
681+
}
682+
}
668683

684+
// Use the "real" translator instead of the identity default
685+
$container->setAlias('translator','translator.default');
669686
$container->setParameter('translator.logging',$config['logging']);
670687

671688
// Discover translation directories
@@ -713,6 +730,7 @@ private function registerTranslatorConfiguration(array $config, ContainerBuilder
713730
}
714731

715732
$files =array();
733+
$resources =array();
716734
$finder = Finder::create()
717735
->files()
718736
->filter(function (\SplFileInfo$file) {
@@ -728,15 +746,20 @@ private function registerTranslatorConfiguration(array $config, ContainerBuilder
728746
$files[$locale] =array();
729747
}
730748

749+
$resources[] =array($format, (string)$file,$locale,$domain);
731750
$files[$locale][] = (string)$file;
732751
}
733752

734-
$options =array_merge(
735-
$translator->getArgument(3),
736-
array('resource_files' =>$files)
737-
);
738-
739-
$translator->replaceArgument(3,$options);
753+
if ($config['use_legacy_translator']) {
754+
$options =array_merge(
755+
$translator->getArgument(3),
756+
array('resource_files' =>$files)
757+
);
758+
$translator->replaceArgument(3,$options);
759+
}else {
760+
$resourceCatalogue =$container->findDefinition('translation.catalogue_bag.resource');
761+
$resourceCatalogue->replaceArgument(2,$resources);
762+
}
740763
}
741764
}
742765

‎src/Symfony/Bundle/FrameworkBundle/Resources/config/translation.xml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,5 +160,23 @@
160160
<argumenttype="service"id="translator" />
161161
<tagname="kernel.cache_warmer" />
162162
</service>
163+
164+
<serviceid="translation.catalogue_bag.resource"class="Symfony\Component\Translation\CatalogueBag\ContainerAwareResourceCatalogueBag"public="false">
165+
<argumenttype="service"id="service_container" />
166+
<argumenttype="collection" /><!-- translation loaders-->
167+
<argumenttype="collection" /><!-- translation resources-->
168+
</service>
169+
170+
<serviceid="translation.catalogue_bag.fallback"class="Symfony\Component\Translation\CatalogueBag\FallbackCatalogueBag"public="false">
171+
<argumenttype="service"id="translation.catalogue_bag.resource" />
172+
<argumenttype="collection" /><!-- fallback locales-->
173+
</service>
174+
175+
<serviceid="translation.catalogue_bag.cache"class="Symfony\Component\Translation\CatalogueBag\CacheCatalogueBag"public="false">
176+
<argumenttype="service"id="translation.catalogue_bag.resource" />
177+
<argument>%kernel.cache_dir%/translations</argument><!-- cache directory-->
178+
<argument>%kernel.debug%</argument>
179+
<argumenttype="service"id="config_cache_factory" />
180+
</service>
163181
</services>
164182
</container>

‎src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Compiler/LoggingTranslatorPassTest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ public function testProcess()
4848

4949
$parameterBag->expects($this->once())
5050
->method('resolveValue')
51-
->will($this->returnValue("Symfony\Bundle\FrameworkBundle\Translation\Translator"));
51+
->will($this->returnValue("Symfony\Component\Translation\Translator"));
5252

5353
$container->expects($this->once())
5454
->method('getParameterBag')

‎src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Compiler/TranslatorPassTest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public function testValidCollector()
3939
$container->expects($this->once())
4040
->method('findTaggedServiceIds')
4141
->will($this->returnValue(array('xliff' =>array(array('alias' =>'xliff','legacy-alias' =>'xlf')))));
42-
$container->expects($this->once())
42+
$container->expects($this->any())
4343
->method('findDefinition')
4444
->will($this->returnValue($this->getMock('Symfony\Component\DependencyInjection\Definition')));
4545
$pass =newTranslatorPass();

‎src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,7 @@ protected static function getBundleDefaultConfig()
158158
'fallbacks' =>array('en'),
159159
'logging' =>true,
160160
'paths' =>array(),
161+
'use_legacy_translator' =>false
161162
),
162163
'validation' =>array(
163164
'enabled' =>false,

‎src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php

Lines changed: 67 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -220,6 +220,54 @@ public function testAssets()
220220
publicfunctiontestTranslator()
221221
{
222222
$container =$this->createContainerFromFile('full');
223+
$this->assertTrue($container->hasDefinition('translator.default'),'->registerTranslatorConfiguration() loads translation.xml');
224+
$this->assertEquals('translator.default', (string)$container->getAlias('translator'),'->registerTranslatorConfiguration() redefines translator service from identity to real translator');
225+
$resources =$container->getDefinition('translation.catalogue_bag.resource')->getArgument(2);
226+
227+
$files =array_map(function ($resource) {returnrealpath($resource[1]); },$resources);
228+
$ref =new \ReflectionClass('Symfony\Component\Validator\Validation');
229+
$this->assertContains(
230+
strtr(dirname($ref->getFileName()).'/Resources/translations/validators.en.xlf','/',DIRECTORY_SEPARATOR),
231+
$files,
232+
'->registerTranslatorConfiguration() finds Validator translation resources'
233+
);
234+
$ref =new \ReflectionClass('Symfony\Component\Form\Form');
235+
$this->assertContains(
236+
strtr(dirname($ref->getFileName()).'/Resources/translations/validators.en.xlf','/',DIRECTORY_SEPARATOR),
237+
$files,
238+
'->registerTranslatorConfiguration() finds Form translation resources'
239+
);
240+
$ref =new \ReflectionClass('Symfony\Component\Security\Core\Security');
241+
$this->assertContains(
242+
strtr(dirname($ref->getFileName()).'/Resources/translations/security.en.xlf','/',DIRECTORY_SEPARATOR),
243+
$files,
244+
'->registerTranslatorConfiguration() finds Security translation resources'
245+
);
246+
$this->assertContains(
247+
strtr(__DIR__.'/Fixtures/translations/test_paths.en.yml','/',DIRECTORY_SEPARATOR),
248+
$files,
249+
'->registerTranslatorConfiguration() finds translation resources in custom paths'
250+
);
251+
252+
$this->assertEquals(array('fr'),$container->getDefinition('translation.catalogue_bag.fallback')->getArgument(1));
253+
}
254+
255+
/**
256+
* @group legacy
257+
*/
258+
publicfunctiontestLegacyTranslator()
259+
{
260+
$container =$this->createContainerFromClosure(function ($container) {
261+
$container->loadFromExtension('framework',array(
262+
'translator' =>array(
263+
'use_legacy_translator' =>true,
264+
'fallback' =>'fr',
265+
'paths' =>array('%kernel.root_dir%/Fixtures/translations'),
266+
'paths' =>array('%kernel.root_dir%/Fixtures/translations'),
267+
),
268+
));
269+
});
270+
223271
$this->assertTrue($container->hasDefinition('translator.default'),'->registerTranslatorConfiguration() loads translation.xml');
224272
$this->assertEquals('translator.default', (string)$container->getAlias('translator'),'->registerTranslatorConfiguration() redefines translator service from identity to real translator');
225273
$options =$container->getDefinition('translator.default')->getArgument(3);
@@ -253,14 +301,31 @@ public function testTranslator()
253301
$this->assertEquals(array('fr'),$calls[1][1][0]);
254302
}
255303

256-
publicfunctiontestTranslatorMultipleFallbacks()
304+
/**
305+
* @group legacy
306+
*/
307+
publicfunctiontestLegacyTranslatorMultipleFallbacks()
257308
{
258-
$container =$this->createContainerFromFile('translator_fallbacks');
309+
$container =$this->createContainerFromClosure(function ($container) {
310+
$container->loadFromExtension('framework',array(
311+
'translator' =>array(
312+
'fallbacks' =>array('en','fr'),
313+
'use_legacy_translator' =>true,
314+
),
315+
));
316+
});
259317

260318
$calls =$container->getDefinition('translator.default')->getMethodCalls();
261319
$this->assertEquals(array('en','fr'),$calls[1][1][0]);
262320
}
263321

322+
publicfunctiontestTranslatorMultipleFallbacks()
323+
{
324+
$container =$this->createContainerFromFile('translator_fallbacks');
325+
326+
$this->assertEquals(array('en','fr'),$container->getDefinition('translation.catalogue_bag.fallback')->getArgument(1));
327+
}
328+
264329
/**
265330
* @expectedException \Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
266331
*/

‎src/Symfony/Bundle/FrameworkBundle/Tests/Translation/TranslatorTest.php

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -97,16 +97,6 @@ public function testTransWithCaching()
9797
$this->assertEquals('foobarbax (sr@latin)',$translator->trans('foobarbax'));
9898
}
9999

100-
publicfunctiontestTransWithCachingWithInvalidLocale()
101-
{
102-
$loader =$this->getMock('Symfony\Component\Translation\Loader\LoaderInterface');
103-
$translator =$this->getTranslator($loader,array('cache_dir' =>$this->tmpDir),'loader','\Symfony\Bundle\FrameworkBundle\Tests\Translation\TranslatorWithInvalidLocale');
104-
$translator->setLocale('invalid locale');
105-
106-
$this->setExpectedException('\InvalidArgumentException');
107-
$translator->trans('foo');
108-
}
109-
110100
publicfunctiontestLoadResourcesWithoutCaching()
111101
{
112102
$loader =new \Symfony\Component\Translation\Loader\YamlFileLoader();
@@ -272,14 +262,3 @@ private function createTranslator($loader, $options, $translatorClass = '\Symfon
272262
);
273263
}
274264
}
275-
276-
class TranslatorWithInvalidLocaleextends Translator
277-
{
278-
/**
279-
* {@inheritdoc}
280-
*/
281-
publicfunctionsetLocale($locale)
282-
{
283-
$this->locale =$locale;
284-
}
285-
}

‎src/Symfony/Bundle/FrameworkBundle/Translation/Translator.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111

1212
namespaceSymfony\Bundle\FrameworkBundle\Translation;
1313

14+
@trigger_error('The'.__NAMESPACE__.'\Translator class is deprecated since version 2.8 and will be removed in 3.0. Use directly the Symfony\Component\Translation\Translator class instead.',E_USER_DEPRECATED);
15+
1416
useSymfony\Component\HttpKernel\CacheWarmer\WarmableInterface;
1517
useSymfony\Component\Translation\TranslatorasBaseTranslator;
1618
useSymfony\Component\Translation\MessageSelector;
@@ -20,6 +22,8 @@
2022
* Translator.
2123
*
2224
* @author Fabien Potencier <fabien@symfony.com>
25+
*
26+
* @deprecated since 2.8, to be removed in 3.0. Use the Symfony\Component\Translation\Translator instead.
2327
*/
2428
class Translatorextends BaseTranslatorimplements WarmableInterface
2529
{

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp