[Translation] Separate parameters formatting #41136

sylfabre · 2021-05-08T09:11:32Z

Q	A
Branch?	5.4
Bug fix?	no
New feature?	yes
Deprecations?	no
Tickets	Fix #32652
License	MIT
Doc PR	symfony/symfony-docs#...

ICU recommends to first format advanced parameters before translation (https://unicode-org.github.io/icu/userguide/format_parse/messages/#format-the-parameters-separately-recommended).

Thanks to #41858, TranslatableMessage now supports recursive TranslatableInterfaceas params.

This PR implements a few common use-cases for arguments that must be first formatted to improve DX:

DateTimeParameter to format date and time
MoneyParameter to format monetary values with the support of https://github.com/moneyphp/money
DecimalParameter to format decimal values as per locale specs

The following implementations could be considered in later PRs:

CountryParameter to format the ISO 3166-2 into a localized country name

# Translation file app+intl-icu.en_US.yml
payment: "{date, date, short} at {date, time, short} - {value, number, currency}"
payment2: "{date} at {time} - {value}"

# Translation file app+intl-icu.fr_FR.yml
payment: "{date, date, short} at {date, time, short} - {value, number, currency}"
payment2: "{date} at {time} - {value}"

Before this PR

// BASIC USAGE

// en_US: 1/25/19 at 7:30 PM - $100.00
// fr_FR: 25/01/2019 à 19:30 - 100,00 €
$this->translator->trans('payment', [
    'date' => new \DateTime('2019-01-25 11:30:00', 'America/Los_Angeles'),
    'value' => 100
]);
// en_US: 1/25/19 at 10:30 AM - $100.00
// fr_FR: 25/01/2019 à 10:30 - 100,00 €
$this->translator->trans('payment', [
    'date' => new \DateTime('2019-01-25 11:30:00', 'Europe/Paris'),
    'value' => 100
]);

// ADVANCED USAGE

// en_US: 1/25/19 at 11:30 AM - $100.00
// fr_FR: 25/01/2019 à 11:30 - 100,00 $
$userCurrency = 'USD';
$datetime = new \DateTime('2019-01-25 11:30:00', 'Europe/Paris');
$dateFormatter = new IntlDateFormatter($this->translator->getLocale(), IntlDateFormatter::SHORT, IntlDateFormatter::NONE, $datetime->getTimezone());
$timeFormatter = new IntlDateFormatter($this->translator->getLocale(), IntlDateFormatter::NONE, IntlDateFormatter::SHORT, $datetime->getTimezone());
$numberFormatter = new NumberFormatter($this->translator->getLocale(), NumberFormatter::CURRENCY);
$this->translator->trans('payment2', [
    'date' => $dateFormatter->format($datetime),
    'time' => $timeFormatter->format($datetime),
    'value' => $numberFormatter->formatCurrency(100, $userCurrency)
]);

After this PR

// BASIC USAGE
// No change

// ADVANCED USAGE

// en_US: 1/25/19 at 11:30 AM - $100.00
// fr_FR: 25/01/2019 à 11:30 - 100,00 $

$datetime = new \DateTime('2019-01-25 11:30:00', 'Europe/Paris');
$this->translator->trans('payment2', [
    'date' => DateTimeTranslatable::date($datetime),
    'time' => DateTimeTranslatable::time($datetime),
    'value' => new MoneyTranslatable(100, 'USD'),
    'value' => MoneyTranslatable::fromMoney(Money::USD(10000)), // Alternative with money-php
]);

// Or with TranslatableMessage for Twig
new TranslatableMessage('payment2', [
    'date' => DateTimeTranslatable::date($datetime),
    'time' => DateTimeTranslatable::time($datetime),
    'value' => new MoneyTranslatable(100, 'USD'),
    'value' => MoneyTranslatable::fromMoney(Money::USD(10000)), // Alternative with money-php
]);

TODO

Fix tests
Add DecimalParameter
Documentation PR

derrabus · 2021-05-08T11:16:30Z

Please give your PR a meaningful title.

src/Symfony/Component/Translation/Translatable/TranslatableCurrency.php

sylfabre · 2021-05-30T20:43:19Z

@ro0NL I've actually created another interface: ParameterInterface as my work resolves around parameters formatting instead of translation. Feel free to have a look :)

sylfabre · 2021-12-06T08:48:19Z

Thank you @stof for the review, I've fixed my PR

welcoMattic · 2021-12-13T14:01:12Z

src/Symfony/Component/Translation/Translatable/DateTimeTranslatable.php

+        $this->dateTime = $dateTime;
+        $this->dateType = $dateType;
+        $this->timeType = $timeType;
+    }


Should we use constructor promotion for all features targeting 6.1?

yes (especially now that we target 7.1)

This PR was merged into the 6.1 branch. Discussion ---------- [Translation] Translatable parameters | Q | A | ------------- | --- | Branch? | 6.1 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | N/A | License | MIT | Doc PR | TBD ✅ The TwigExtension now supports messages implementing `TranslatableInterface` (https://symfony.com/blog/new-in-symfony-5-2-translatable-objects). ✅ Thanks to #41858, `TranslatableMessage` now supports recursive `TranslatableInterface` as params. ❌ But using `TranslatableInterface` as params with regular messages is not supported yet. 💡 This PR addresses this issue and makes it possible to create dedicated `TranslatableInterface` implementations like the one from #41136 _Note: I would like also to add `TranslatableInterface` to the `trans(?string $id)` signature method like with the one from the [TwigExtension](https://github.com/symfony/symfony/blob/6.1/src/Symfony/Bridge/Twig/Extension/TranslationExtension.php#L111) but I don't know how to do it without breaking BC. Any advice is welcome!_ Commits ------- 5beaee8 [Translation] Translatable parameters

This PR was merged into the 6.1 branch. Discussion ---------- [Translation] Translatable parameters | Q | A | ------------- | --- | Branch? | 6.1 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | N/A | License | MIT | Doc PR | TBD ✅ The TwigExtension now supports messages implementing `TranslatableInterface` (https://symfony.com/blog/new-in-symfony-5-2-translatable-objects). ✅ Thanks to #41858, `TranslatableMessage` now supports recursive `TranslatableInterface` as params. ❌ But using `TranslatableInterface` as params with regular messages is not supported yet. 💡 This PR addresses this issue and makes it possible to create dedicated `TranslatableInterface` implementations like the one from symfony/symfony#41136 _Note: I would like also to add `TranslatableInterface` to the `trans(?string $id)` signature method like with the one from the [TwigExtension](https://github.com/symfony/symfony/blob/6.1/src/Symfony/Bridge/Twig/Extension/TranslationExtension.php#L111) but I don't know how to do it without breaking BC. Any advice is welcome!_ Commits ------- 5beaee85f9 [Translation] Translatable parameters

welcoMattic · 2023-09-20T08:02:45Z

src/Symfony/Component/Translation/CHANGELOG.md

+ * Add new implementations of `TranslatableInterface` to format parameters
+  separately as recommended per the ICU for DateTime, money, and decimal values.


After rebase, this should be moved to 6.4 section

welcoMattic · 2023-09-20T08:05:48Z

@sylfabre what is the status of this PR? There are some not addressed comments and the branch needs to be rebased, but I think we are close to be able to merge it.

OskarStark · 2023-10-24T13:06:42Z

friendly ping @sylfabre 👋

sylfabre · 2023-10-24T14:17:47Z

@welcoMattic @OskarStark Sorry for the late answer: the back-to-school period was challenging on my side 🙈
I need to find some time to get back to work on this one. 😊

Before that: @stof @nicolas-grekas does this suggestion/PR make sense to you? Is working on it worth it?

nicolas-grekas · 2023-10-24T14:26:16Z

No objections on my side, let's resume the PR for 7.1.
I guess this can be useful in twig templates also, isn't it?

stof · 2023-10-24T14:40:21Z

src/Symfony/Component/Translation/Translatable/DateTimeTranslatable.php

+        $key = implode('.', [$locale, $this->dateType, $this->timeType, $timezone->getName()]);
+        if (!isset(self::$formatters[$key])) {
+            self::$formatters[$key] = new \IntlDateFormatter(
+                $locale ?? $translator->getLocale(),


the coalesce is dead code as the default is already applied in the variable a few lines above

stof · 2023-10-24T14:44:53Z

src/Symfony/Component/Translation/Translatable/DateTimeTranslatable.php

+
+    private static array $formatters = [];
+
+    public function __construct(


I suggest adding @param \IntlDateFormatter::* $dateType (and same for the other parameters in this constructor and static factory methods) so that static analysis tool can report invalid values

stof · 2023-10-24T14:45:14Z

src/Symfony/Component/Translation/Translatable/DateTimeTranslatable.php

+        $this->dateTime = $dateTime;
+        $this->dateType = $dateType;
+        $this->timeType = $timeType;
+    }


yes (especially now that we target 7.1)

stof · 2023-10-24T14:47:01Z

src/Symfony/Component/Translation/composer.json

@@ -47,7 +47,8 @@
    "suggest": {
        "symfony/config": "",
        "symfony/yaml": "",
-        "psr/log-implementation": "To use logging capability in translator"
+        "psr/log-implementation": "To use logging capability in translator",
+        "moneyphp/money":  "To use money capability in translator"


We stopped using suggest in the composer packages.

Thus, this suggestion is useless. If you don't already use this money library, there is no reason to suggest you to use it to use the MoneyTranslatable object (you would use its constructor directly). And if you already use the library, composer won't display the suggestion as it is already part of the project.

thus, your PR does not even contain the fromMoney static method described in the PR description.

fabpot · 2024-02-04T10:12:29Z

Closing as there is no more activity. Feel to reopen when you have time.

carsonbot added Status: Needs Work Deprecation Feature labels May 8, 2021

sylfabre mentioned this pull request May 8, 2021

[Translator] Why does the currency depend on the locale? #32652

Closed

derrabus added Translation and removed Deprecation labels May 8, 2021

carsonbot changed the title ~~[wip]~~ [Translation] [wip] May 8, 2021

derrabus added this to the 5.x milestone May 8, 2021

sylfabre changed the title ~~[Translation] [wip]~~ [Translation] [wip] Advanced localization with custom currency and timezone May 8, 2021

sylfabre force-pushed the translate_date_time_currency branch from 08f1df0 to 4cde975 Compare May 19, 2021 16:09

This comment was marked as resolved.

Sign in to view

ro0NL reviewed May 28, 2021

View reviewed changes

src/Symfony/Component/Translation/Translatable/TranslatableCurrency.php Outdated Show resolved Hide resolved

sylfabre force-pushed the translate_date_time_currency branch 2 times, most recently from 60985be to cdc168f Compare May 30, 2021 19:17

sylfabre changed the title ~~[Translation] [wip] Advanced localization with custom currency and timezone~~ [Translation] [wip] Separate parameters formatting May 30, 2021

sylfabre force-pushed the translate_date_time_currency branch 8 times, most recently from 539ce31 to f274351 Compare May 30, 2021 20:41

sylfabre changed the title ~~[Translation] [wip] Separate parameters formatting~~ [Translation] Separate parameters formatting May 30, 2021

sylfabre force-pushed the translate_date_time_currency branch 4 times, most recently from 9b1506d to ed8eae3 Compare June 1, 2021 08:04

sylfabre force-pushed the translate_date_time_currency branch 3 times, most recently from 0ce48cf to cc02f6a Compare December 6, 2021 08:45

sylfabre force-pushed the translate_date_time_currency branch 2 times, most recently from 0f0101c to b642d18 Compare December 6, 2021 09:20

[Translation] TranslatableInterface implementations

dab3f2a

sylfabre force-pushed the translate_date_time_currency branch from b642d18 to dab3f2a Compare December 6, 2021 09:35

welcoMattic reviewed Dec 13, 2021

View reviewed changes

ro0NL mentioned this pull request Dec 14, 2021

LessThanOrEqual is not formatting compared value in error #44619

Closed

sylfabre mentioned this pull request Dec 16, 2021

[Translation] Translatable parameters #44672

Merged

fabpot modified the milestones: 6.1, 6.2 May 20, 2022

nicolas-grekas modified the milestones: 6.2, 6.3 Nov 5, 2022

nicolas-grekas modified the milestones: 6.3, 6.4 May 23, 2023

welcoMattic reviewed Sep 20, 2023

View reviewed changes

stof reviewed Oct 24, 2023

View reviewed changes

nicolas-grekas modified the milestones: 6.4, 7.1 Nov 15, 2023

fabpot closed this Feb 4, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Translation] Separate parameters formatting #41136

[Translation] Separate parameters formatting #41136

sylfabre commented May 8, 2021 •

edited

Loading

derrabus commented May 8, 2021

This comment was marked as resolved.

sylfabre commented May 30, 2021

sylfabre commented Dec 6, 2021

welcoMattic Dec 13, 2021

stof Oct 24, 2023

welcoMattic Sep 20, 2023

welcoMattic commented Sep 20, 2023

OskarStark commented Oct 24, 2023

sylfabre commented Oct 24, 2023

nicolas-grekas commented Oct 24, 2023

stof Oct 24, 2023

stof Oct 24, 2023

stof Oct 24, 2023

stof Oct 24, 2023

stof Oct 24, 2023

fabpot commented Feb 4, 2024

		* Add new implementations of `TranslatableInterface` to format parameters
		separately as recommended per the ICU for DateTime, money, and decimal values.


		private static array $formatters = [];

		public function __construct(

[Translation] Separate parameters formatting #41136

[Translation] Separate parameters formatting #41136

Conversation

sylfabre commented May 8, 2021 • edited Loading

derrabus commented May 8, 2021

This comment was marked as resolved.

sylfabre commented May 30, 2021

sylfabre commented Dec 6, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

welcoMattic commented Sep 20, 2023

OskarStark commented Oct 24, 2023

sylfabre commented Oct 24, 2023

nicolas-grekas commented Oct 24, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fabpot commented Feb 4, 2024

sylfabre commented May 8, 2021 •

edited

Loading