[Translation] Added intl message formatter. #27399
Use FallbackFormatter instead of support for multiple formatters
- Loading branch information
commit 597a15d7f7df10ce574dd3ba83a05c3720fc9a67
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| declare(strict_types=1); | ||
|
There was a problem hiding this comment. AFAIK, we are not using this anywhere else, this should be removed. |
||
|
|
||
| namespace Symfony\Component\Translation\Formatter; | ||
|
|
||
| use Symfony\Component\Translation\Exception\LogicException; | ||
|
|
||
| class FallbackFormatter implements MessageFormatterInterface, ChoiceMessageFormatterInterface | ||
| { | ||
| /** | ||
| * @var MessageFormatterInterface|ChoiceMessageFormatterInterface | ||
| */ | ||
| private $firstFormatter; | ||
|
|
||
| /** | ||
| * @var MessageFormatterInterface|ChoiceMessageFormatterInterface | ||
| */ | ||
| private $secondFormatter; | ||
|
|
||
| public function __construct(MessageFormatterInterface $firstFormatter, MessageFormatterInterface $secondFormatter) | ||
| { | ||
| $this->firstFormatter = $firstFormatter; | ||
| $this->secondFormatter = $secondFormatter; | ||
| } | ||
|
|
||
| public function format($message, $locale, array $parameters = array()) | ||
| { | ||
| try { | ||
| $result = $this->firstFormatter->format($message, $locale, $parameters); | ||
| } catch (\Throwable $e) { | ||
|
There was a problem hiding this comment. Can we be more specific here? We should be as much as possible IMHO (same below.) There was a problem hiding this comment. Do we want to be more specific? |
||
| return $this->secondFormatter->format($message, $locale, $parameters); | ||
| } | ||
|
|
||
| if ($result === $message) { | ||
| $result = $this->secondFormatter->format($message, $locale, $parameters); | ||
| } | ||
|
|
||
| return $result; | ||
| } | ||
|
|
||
| public function choiceFormat($message, $number, $locale, array $parameters = array()) | ||
| { | ||
| // If both support ChoiceMessageFormatterInterface | ||
| if ($this->firstFormatter instanceof ChoiceMessageFormatterInterface && $this->secondFormatter instanceof ChoiceMessageFormatterInterface) { | ||
| try { | ||
| $result = $this->firstFormatter->choiceFormat($message, $number, $locale, $parameters); | ||
| } catch (\Throwable $e) { | ||
| return $this->secondFormatter->choiceFormat($message, $number, $locale, $parameters); | ||
| } | ||
|
|
||
| if ($result === $message) { | ||
| $result = $this->secondFormatter->choiceFormat($message, $number, $locale, $parameters); | ||
| } | ||
|
|
||
| return $result; | ||
| } | ||
|
|
||
| if ($this->firstFormatter instanceof ChoiceMessageFormatterInterface) { | ||
| return $this->firstFormatter->choiceFormat($message, $number, $locale, $parameters); | ||
| } | ||
|
|
||
| if ($this->secondFormatter instanceof ChoiceMessageFormatterInterface) { | ||
| return $this->secondFormatter->choiceFormat($message, $number, $locale, $parameters); | ||
| } | ||
|
|
||
| throw new LogicException(sprintf('The no formatter support plural translations.')); | ||
|
There was a problem hiding this comment. The message is not so clear to me :) I suppose you meant |
||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,196 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\Translation\Tests\Formatter; | ||
|
|
||
| use Symfony\Component\Translation\Exception\InvalidArgumentException; | ||
| use Symfony\Component\Translation\Exception\LogicException; | ||
| use Symfony\Component\Translation\Formatter\ChoiceMessageFormatterInterface; | ||
| use Symfony\Component\Translation\Formatter\FallbackFormatter; | ||
| use Symfony\Component\Translation\Formatter\MessageFormatterInterface; | ||
|
|
||
| class FallbackFormatterTest extends \PHPUnit\Framework\TestCase | ||
| { | ||
| public function testFormatSame() | ||
| { | ||
| $first = $this->getMockBuilder(MessageFormatterInterface::class)->setMethods(array('format'))->getMock(); | ||
| $first | ||
| ->expects($this->once()) | ||
| ->method('format') | ||
| ->with('foo', 'en', array(2)) | ||
| ->willReturn('foo'); | ||
|
|
||
| $second = $this->getMockBuilder(MessageFormatterInterface::class)->setMethods(array('format'))->getMock(); | ||
| $second | ||
| ->expects($this->once()) | ||
| ->method('format') | ||
| ->with('foo', 'en', array(2)) | ||
| ->willReturn('bar'); | ||
|
|
||
| $this->assertEquals('bar', (new FallbackFormatter($first, $second))->format('foo', 'en', array(2))); | ||
| } | ||
|
|
||
| public function testFormatDifferent() | ||
| { | ||
| $first = $this->getMockBuilder(MessageFormatterInterface::class)->setMethods(array('format'))->getMock(); | ||
| $first | ||
| ->expects($this->once()) | ||
| ->method('format') | ||
| ->with('foo', 'en', array(2)) | ||
| ->willReturn('new value'); | ||
|
|
||
| $second = $this->getMockBuilder(MessageFormatterInterface::class)->setMethods(array('format'))->getMock(); | ||
| $second | ||
| ->expects($this->exactly(0)) | ||
| ->method('format') | ||
| ->withAnyParameters(); | ||
|
|
||
| $this->assertEquals('new value', (new FallbackFormatter($first, $second))->format('foo', 'en', array(2))); | ||
| } | ||
|
|
||
| public function testFormatException() | ||
| { | ||
| $first = $this->getMockBuilder(MessageFormatterInterface::class)->setMethods(array('format'))->getMock(); | ||
| $first | ||
| ->expects($this->once()) | ||
| ->method('format') | ||
| ->willThrowException(new InvalidArgumentException()); | ||
|
|
||
| $second = $this->getMockBuilder(MessageFormatterInterface::class)->setMethods(array('format'))->getMock(); | ||
| $second | ||
| ->expects($this->once()) | ||
| ->method('format') | ||
| ->with('foo', 'en', array(2)) | ||
| ->willReturn('bar'); | ||
|
|
||
| $this->assertEquals('bar', (new FallbackFormatter($first, $second))->format('foo', 'en', array(2))); | ||
| } | ||
|
|
||
| public function testChoiceFormatSame() | ||
| { | ||
| $first = $this->getMockBuilder(SuperFormatterInterface::class)->setMethods(array('format', 'choiceFormat'))->getMock(); | ||
| $first | ||
| ->expects($this->once()) | ||
| ->method('choiceFormat') | ||
| ->with('foo', 1, 'en', array(2)) | ||
| ->willReturn('foo'); | ||
|
|
||
| $second = $this->getMockBuilder(SuperFormatterInterface::class)->setMethods(array('format', 'choiceFormat'))->getMock(); | ||
| $second | ||
| ->expects($this->once()) | ||
| ->method('choiceFormat') | ||
| ->with('foo', 1, 'en', array(2)) | ||
| ->willReturn('bar'); | ||
|
|
||
| $this->assertEquals('bar', (new FallbackFormatter($first, $second))->choiceFormat('foo', 1, 'en', array(2))); | ||
| } | ||
|
|
||
| public function testChoiceFormatDifferent() | ||
| { | ||
| $first = $this->getMockBuilder(SuperFormatterInterface::class)->setMethods(array('format', 'choiceFormat'))->getMock(); | ||
| $first | ||
| ->expects($this->once()) | ||
| ->method('choiceFormat') | ||
| ->with('foo', 1, 'en', array(2)) | ||
| ->willReturn('new value'); | ||
|
|
||
| $second = $this->getMockBuilder(SuperFormatterInterface::class)->setMethods(array('format', 'choiceFormat'))->getMock(); | ||
| $second | ||
| ->expects($this->exactly(0)) | ||
| ->method('choiceFormat') | ||
| ->withAnyParameters() | ||
| ->willReturn('bar'); | ||
|
|
||
| $this->assertEquals('new value', (new FallbackFormatter($first, $second))->choiceFormat('foo', 1, 'en', array(2))); | ||
| } | ||
|
|
||
| public function testChoiceFormatException() | ||
| { | ||
| $first = $this->getMockBuilder(SuperFormatterInterface::class)->setMethods(array('format', 'choiceFormat'))->getMock(); | ||
| $first | ||
| ->expects($this->once()) | ||
| ->method('choiceFormat') | ||
| ->willThrowException(new InvalidArgumentException()); | ||
|
|
||
| $second = $this->getMockBuilder(SuperFormatterInterface::class)->setMethods(array('format', 'choiceFormat'))->getMock(); | ||
| $second | ||
| ->expects($this->once()) | ||
| ->method('choiceFormat') | ||
| ->with('foo', 1, 'en', array(2)) | ||
| ->willReturn('bar'); | ||
|
|
||
| $this->assertEquals('bar', (new FallbackFormatter($first, $second))->choiceFormat('foo', 1, 'en', array(2))); | ||
| } | ||
|
|
||
| public function testChoiceFormatOnlyFirst() | ||
| { | ||
| // Implements both interfaces | ||
| $first = $this->getMockBuilder(SuperFormatterInterface::class)->setMethods(array('format', 'choiceFormat'))->getMock(); | ||
| $first | ||
| ->expects($this->once()) | ||
| ->method('choiceFormat') | ||
| ->with('foo', 1, 'en', array(2)) | ||
| ->willReturn('bar'); | ||
|
|
||
| // Implements only one interface | ||
| $second = $this->getMockBuilder(MessageFormatterInterface::class)->setMethods(array('format'))->getMock(); | ||
| $second | ||
| ->expects($this->exactly(0)) | ||
| ->method('format') | ||
| ->withAnyParameters() | ||
| ->willReturn('error'); | ||
|
|
||
| $this->assertEquals('bar', (new FallbackFormatter($first, $second))->choiceFormat('foo', 1, 'en', array(2))); | ||
| } | ||
|
|
||
| public function testChoiceFormatOnlySecond() | ||
| { | ||
| // Implements only one interface | ||
| $first = $this->getMockBuilder(MessageFormatterInterface::class)->setMethods(array('format'))->getMock(); | ||
| $first | ||
| ->expects($this->exactly(0)) | ||
| ->method('format') | ||
| ->withAnyParameters() | ||
| ->willReturn('error'); | ||
|
|
||
| // Implements both interfaces | ||
| $second = $this->getMockBuilder(SuperFormatterInterface::class)->setMethods(array('format', 'choiceFormat'))->getMock(); | ||
| $second | ||
| ->expects($this->once()) | ||
| ->method('choiceFormat') | ||
| ->with('foo', 1, 'en', array(2)) | ||
| ->willReturn('bar'); | ||
|
|
||
| $this->assertEquals('bar', (new FallbackFormatter($first, $second))->choiceFormat('foo', 1, 'en', array(2))); | ||
| } | ||
|
|
||
| public function testChoiceFormatNoChoiceFormat() | ||
| { | ||
| // Implements only one interface | ||
| $first = $this->getMockBuilder(MessageFormatterInterface::class)->setMethods(array('format'))->getMock(); | ||
| $first | ||
| ->expects($this->exactly(0)) | ||
| ->method('format'); | ||
|
|
||
| // Implements both interfaces | ||
| $second = $this->getMockBuilder(MessageFormatterInterface::class)->setMethods(array('format'))->getMock(); | ||
| $second | ||
| ->expects($this->exactly(0)) | ||
| ->method('format'); | ||
|
|
||
| $this->expectException(LogicException::class); | ||
| $this->assertEquals('bar', (new FallbackFormatter($first, $second))->choiceFormat('foo', 1, 'en', array(2))); | ||
| } | ||
| } | ||
|
|
||
| interface SuperFormatterInterface extends MessageFormatterInterface, ChoiceMessageFormatterInterface | ||
| { | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
missing space after
and.