Skip to content

Commit 986513d

Browse files
xabbuhxabbuh
committed
feature #18314 [Translation] added support for adding custom message formatter (aitboudad)
This PR was merged into the 3.4 branch. Discussion ---------- [Translation] added support for adding custom message formatter | Q | A | | --- | --- | | Branch? | master | | Bug fix? | no | | New feature? | yes | | BC breaks? | no | | Deprecations? | yes | | Tests pass? | yes | | Fixed tickets | #6009, #10152, one item in #11742, #11948 | | License | MIT | | Doc PR | ~ | Commits ------- 42183b0 [Translation] Support adding custom message formatter
2 parents c2fa02d + e070bc5 commit 986513d

File tree

7 files changed

+24
-16
lines changed

7 files changed

+24
-16
lines changed

‎DependencyInjection/Configuration.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -669,6 +669,7 @@ private function addTranslatorSection(ArrayNodeDefinition $rootNode)
669669
->defaultValue(array('en'))
670670
->end()
671671
->booleanNode('logging')->defaultValue($this->debug)->end()
672+
->scalarNode('formatter')->defaultValue('translator.formatter.default')->end()
672673
->arrayNode('paths')
673674
->prototype('scalar')->end()
674675
->end()

‎DependencyInjection/FrameworkExtension.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1075,6 +1075,7 @@ private function registerTranslatorConfiguration(array $config, ContainerBuilder
10751075

10761076
// Use the "real" translator instead of the identity default
10771077
$container->setAlias('translator', 'translator.default');
1078+
$container->setAlias('translator.formatter', new Alias($config['formatter'], false));
10781079
$translator = $container->findDefinition('translator.default');
10791080
$translator->addMethodCall('setFallbackLocales', array($config['fallbacks']));
10801081

‎Resources/config/schema/symfony-1.0.xsd

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,7 @@
184184
<xsd:attribute name="enabled" type="xsd:boolean" />
185185
<xsd:attribute name="fallback" type="xsd:string" />
186186
<xsd:attribute name="logging" type="xsd:boolean" />
187+
<xsd:attribute name="formatter" type="xsd:string" />
187188
</xsd:complexType>
188189

189190
<xsd:complexType name="validation">

‎Resources/config/translation.xml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
<service id="translator.default" class="Symfony\Bundle\FrameworkBundle\Translation\Translator" public="true">
1111
<argument /> <!-- translation loaders locator -->
12-
<argument type="service" id="translator.selector" />
12+
<argument type="service" id="translator.formatter" />
1313
<argument>%kernel.default_locale%</argument>
1414
<argument type="collection" /> <!-- translation loaders ids -->
1515
<argument type="collection">
@@ -28,6 +28,10 @@
2828
<tag name="monolog.logger" channel="translation" />
2929
</service>
3030

31+
<service id="translator.formatter.default" class="Symfony\Component\Translation\Formatter\MessageFormatter">
32+
<argument type="service" id="translator.selector" />
33+
</service>
34+
3135
<service id="translation.loader.php" class="Symfony\Component\Translation\Loader\PhpFileLoader" public="true">
3236
<tag name="translation.loader" alias="php" />
3337
</service>

‎Tests/DependencyInjection/ConfigurationTest.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -255,6 +255,7 @@ protected static function getBundleDefaultConfig()
255255
'enabled' => !class_exists(FullStack::class),
256256
'fallbacks' => array('en'),
257257
'logging' => true,
258+
'formatter' => 'translator.formatter.default',
258259
'paths' => array(),
259260
),
260261
'validation' => array(

‎Tests/Translation/TranslatorTest.php

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@
1414
use PHPUnit\Framework\TestCase;
1515
use Psr\Container\ContainerInterface;
1616
use Symfony\Bundle\FrameworkBundle\Translation\Translator;
17+
use Symfony\Component\Translation\Formatter\MessageFormatter;
1718
use Symfony\Component\Translation\MessageCatalogue;
1819
use Symfony\Component\Filesystem\Filesystem;
19-
use Symfony\Component\Translation\MessageSelector;
2020

2121
class TranslatorTest extends TestCase
2222
{
@@ -149,7 +149,7 @@ public function testGetDefaultLocaleOmittingLocale()
149149
->with('kernel.default_locale')
150150
->will($this->returnValue('en'))
151151
;
152-
$translator = new Translator($container, new MessageSelector());
152+
$translator = new Translator($container, new MessageFormatter());
153153

154154
$this->assertSame('en', $translator->getLocale());
155155
}
@@ -162,7 +162,7 @@ public function testGetDefaultLocaleOmittingLocale()
162162
public function testGetDefaultLocaleOmittingLocaleWithPsrContainer()
163163
{
164164
$container = $this->getMockBuilder(ContainerInterface::class)->getMock();
165-
$translator = new Translator($container, new MessageSelector());
165+
$translator = new Translator($container, new MessageFormatter());
166166
}
167167

168168
/**
@@ -277,7 +277,7 @@ public function testLoadResourcesWithoutCaching()
277277
public function testGetDefaultLocale()
278278
{
279279
$container = $this->getMockBuilder(ContainerInterface::class)->getMock();
280-
$translator = new Translator($container, new MessageSelector(), 'en');
280+
$translator = new Translator($container, new MessageFormatter(), 'en');
281281

282282
$this->assertSame('en', $translator->getLocale());
283283
}
@@ -290,7 +290,7 @@ public function testInvalidOptions()
290290
{
291291
$container = $this->getMockBuilder('Symfony\Component\DependencyInjection\ContainerInterface')->getMock();
292292

293-
(new Translator($container, new MessageSelector(), 'en', array(), array('foo' => 'bar')));
293+
(new Translator($container, new MessageFormatter(), 'en', array(), array('foo' => 'bar')));
294294
}
295295

296296
/** @dataProvider getDebugModeAndCacheDirCombinations */
@@ -468,15 +468,15 @@ private function createTranslator($loader, $options, $translatorClass = '\Symfon
468468
if (null === $defaultLocale) {
469469
return new $translatorClass(
470470
$this->getContainer($loader),
471-
new MessageSelector(),
471+
new MessageFormatter(),
472472
array($loaderFomat => array($loaderFomat)),
473473
$options
474474
);
475475
}
476476

477477
return new $translatorClass(
478478
$this->getContainer($loader),
479-
new MessageSelector(),
479+
new MessageFormatter(),
480480
$defaultLocale,
481481
array($loaderFomat => array($loaderFomat)),
482482
$options

‎Translation/Translator.php

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515
use Symfony\Component\DependencyInjection\ContainerInterface as SymfonyContainerInterface;
1616
use Symfony\Component\HttpKernel\CacheWarmer\WarmableInterface;
1717
use Symfony\Component\Translation\Translator as BaseTranslator;
18-
use Symfony\Component\Translation\MessageSelector;
1918
use Symfony\Component\Translation\Exception\InvalidArgumentException;
19+
use Symfony\Component\Translation\Formatter\MessageFormatterInterface;
2020

2121
/**
2222
* Translator.
@@ -56,15 +56,15 @@ class Translator extends BaseTranslator implements WarmableInterface
5656
* * debug: Whether to enable debugging or not (false by default)
5757
* * resource_files: List of translation resources available grouped by locale.
5858
*
59-
* @param ContainerInterface $container A ContainerInterface instance
60-
* @param MessageSelector $selector The message selector for pluralization
61-
* @param string $defaultLocale
62-
* @param array $loaderIds An array of loader Ids
63-
* @param array $options An array of options
59+
* @param ContainerInterface $container A ContainerInterface instance
60+
* @param MessageFormatterInterface $formatter The message formatter
61+
* @param string $defaultLocale
62+
* @param array $loaderIds An array of loader Ids
63+
* @param array $options An array of options
6464
*
6565
* @throws InvalidArgumentException
6666
*/
67-
public function __construct(ContainerInterface $container, MessageSelector $selector, $defaultLocale = null, array $loaderIds = array(), array $options = array())
67+
public function __construct(ContainerInterface $container, $formatter, $defaultLocale = null, array $loaderIds = array(), array $options = array())
6868
{
6969
// BC 3.x, to be removed in 4.0 along with the $defaultLocale default value
7070
if (is_array($defaultLocale) || 3 > func_num_args()) {
@@ -90,7 +90,7 @@ public function __construct(ContainerInterface $container, MessageSelector $sele
9090
$this->resourceLocales = array_keys($this->options['resource_files']);
9191
$this->addResourceFiles($this->options['resource_files']);
9292

93-
parent::__construct($defaultLocale, $selector, $this->options['cache_dir'], $this->options['debug']);
93+
parent::__construct($defaultLocale, $formatter, $this->options['cache_dir'], $this->options['debug']);
9494
}
9595

9696
/**

0 commit comments

Comments
 (0)