[Intl] Add methods to filter currencies more precisely #61431

Crovitche-1623 · 2025-08-15T09:07:07Z

Q	A
Branch?	7.4
Bug fix?	no
New feature?	yes
Deprecations?	no
Issues	Close #61365
License	MIT

Description

In the ICU dataset, there are values that are no longer relevant / no longer used today (e.g. the BEF currency). This PR add a method that check the metadata in the ICU metadata to check if the currency is active in at least 1 country.

Limitations

There are currencies that do not have legal tender and therefore no available date ranges. That can cause problem when we check if the currency is active (within the date range).
If we have a case in the future where a currency is no longer valid for a given date range but becomes valid again in the future, this will not work with the current date check (parameter $active).

carsonbot · 2025-08-15T09:07:10Z

Hey!

To help keep things organized, we don't allow "Draft" pull requests. Could you please click the "ready for review" button or close this PR and open a new one when you are done?

Note that a pull request does not have to be "perfect" or "ready for merge" when you first open it. We just want it to be ready for a first review.

Cheers!

Carsonbot

Crovitche-1623 · 2025-08-15T09:37:28Z

I think it's pretty much ready for a first review @javiereguiluz.

ro0NL

perhaps an alternative API could be getCurrencyCodesForCountry(string $country, ?bool $active = null) + existsForCountry(string $country, ?bool $active = null)
?

src/Symfony/Component/Intl/Currencies.php

Crovitche-1623 · 2025-08-15T12:39:02Z

perhaps an alternative API could be getCurrencyCodesForCountry(string $country, ?bool $active = null) + existsForCountry(string $country, ?bool $active = null)

?

I will add this ASAP 👍🏻

…ll use cases

Crovitche-1623 · 2025-08-15T16:36:25Z

I added the requested methods + tender filter but I need to add fews tests to ensure all uses cases are covered. I also need to update the CHANGELOG. I'll continue this ASAP.

src/Symfony/Component/Intl/Currencies.php

…cases to achieve 100% code coverage

Crovitche-1623 · 2025-08-18T13:40:02Z

I’ve applied the requested changes, this should be ready for a second review.

src/Symfony/Component/Intl/Data/Generator/CurrencyDataGenerator.php

src/Symfony/Component/Intl/CHANGELOG.md

src/Symfony/Component/Intl/Data/Generator/CurrencyDataGenerator.php

src/Symfony/Component/Intl/Currencies.php

…nment

…tries

…each

nicolas-grekas · 2025-08-19T15:19:58Z

src/Symfony/Component/Intl/Data/Generator/CurrencyDataGenerator.php

+        $epochWithMicros = \sprintf('%d.%03d000', $seconds, $millisecondsRemainder);
+
+        $datetime = \DateTimeImmutable::createFromFormat(
+            'U.u',


let's simplify this and remove the part about $millisecondsRemainder
in the end we have only day precision

nicolas-grekas

LGTM thanks (but CS things).
I didn't comment on all places where my comments apply, you should be able to infer the rest ;)

nicolas-grekas · 2025-08-19T15:20:48Z

src/Symfony/Component/Intl/Tests/CurrenciesTest.php

+        $this->assertSame(
+            [],
+            Currencies::forCountry('AQ', null, true, new \DateTimeImmutable('2025-01-01', new \DateTimeZone('Etc/UTC'))),
+        );


Suggested change

$this->assertSame(

[],

Currencies::forCountry('AQ', null, true, new \DateTimeImmutable('2025-01-01', new \DateTimeZone('Etc/UTC'))),

);

$this->assertSame([], Currencies::forCountry('AQ', null, true, new \DateTimeImmutable('2025-01-01', new \DateTimeZone('Etc/UTC'))));

nicolas-grekas · 2025-08-19T15:21:30Z

src/Symfony/Component/Intl/Currencies.php

+    public static function forCountry(
+        string $country,
+        ?bool $legalTender = true,
+        ?bool $active = true,
+        \DateTimeInterface $date = new \DateTimeImmutable('today', new \DateTimeZone('Etc/UTC')),
+    ): array {


Suggested change

public static function forCountry(

string $country,

?bool $legalTender = true,

?bool $active = true,

\DateTimeInterface $date = new \DateTimeImmutable('today', new \DateTimeZone('Etc/UTC')),

): array {

public static function forCountry(string $country, ?bool $legalTender = true, ?bool $active = true, \DateTimeInterface $date = new \DateTimeImmutable('today', new \DateTimeZone('Etc/UTC'))): array

{

nicolas-grekas · 2025-08-19T15:21:39Z

src/Symfony/Component/Intl/Currencies.php

@@ -139,6 +139,154 @@ public static function forNumericCode(int $numericCode): array
        return self::readEntry(['NumericToAlpha3', (string) $numericCode], 'meta');
    }

+    /**
+     * @param non-empty-string   $country     e.g. 'FR'
+     * @param ?bool              $legalTender if the currency must be a legal tender. Using null do not filter anything


Suggested change

* @param ?bool $legalTender if the currency must be a legal tender. Using null do not filter anything

* @param ?bool $legalTender If the currency must be a legal tender; null to not filter anything

nicolas-grekas · 2025-08-19T15:22:12Z

src/Symfony/Component/Intl/Currencies.php

+    /**
+     * @param non-empty-string   $country     e.g. 'FR'
+     * @param ?bool              $legalTender if the currency must be a legal tender. Using null do not filter anything
+     * @param ?bool              $active      Indicates whether the currency should always be active for the given $date. Using null do not filter anything


Suggested change

* @param ?bool $active Indicates whether the currency should always be active for the given $date. Using null do not filter anything

* @param ?bool $active Indicates whether the currency should always be active for the given $date; null to not filter anything

nicolas-grekas · 2025-08-19T15:22:23Z

src/Symfony/Component/Intl/Currencies.php

+     * @param non-empty-string   $country     e.g. 'FR'
+     * @param ?bool              $legalTender if the currency must be a legal tender. Using null do not filter anything
+     * @param ?bool              $active      Indicates whether the currency should always be active for the given $date. Using null do not filter anything
+     * @param \DateTimeInterface $date        The date string on which the check will be performed


Suggested change

* @param \DateTimeInterface $date The date string on which the check will be performed

* @param \DateTimeInterface $date The date on which the check will be performed

nicolas-grekas · 2025-08-19T15:23:16Z

src/Symfony/Component/Intl/Currencies.php

+            /**
+             * @var \DateTimeImmutable $to The date format is always valid as it is generated using the CurrencyDataGenerator
+             */


we prefer not polluting the code with such SA concerns:

Suggested change

/**

* @var \DateTimeImmutable $to The date format is always valid as it is generated using the CurrencyDataGenerator

*/

nicolas-grekas · 2025-08-19T15:23:59Z

src/Symfony/Component/Intl/Currencies.php

+            return true;
+        }
+
+        return $active === self::isActive($country, $currency, $currencyMetadata, $date);


Suggested change

return $active === self::isActive($country, $currency, $currencyMetadata, $date);

return self::isActive($country, $currency, $currencyMetadata, $date) === $active;

nicolas-grekas · 2025-08-19T15:24:43Z

src/Symfony/Component/Intl/Data/Generator/CurrencyDataGenerator.php

+     *
+     * @return non-empty-string


I'd remove the non-empty-string declarations, they're not really useful IMHO

Suggested change

*

* @return non-empty-string

ro0NL · 2025-08-19T15:25:46Z

src/Symfony/Component/Intl/Currencies.php

+    ): bool {
+        if (!\array_key_exists('from', $currencyMetadata)) {
+            // Note: currencies that are not legal tender don't have often validity dates.
+            throw new \RuntimeException("Cannot check whether the currency $currency is active or not in $country because they are no validity dates available.");


return false?

Crovitche-1623 added 3 commits August 15, 2025 10:56

test: add test for isActive method

f038af2

feat: add required metadata in the generated data

1276849

feat: add isActive method

62312ed

Crovitche-1623 added 2 commits August 15, 2025 11:12

refactor: cs

449afd2

docs: updated CHANGELOG.md

c7719cc

Crovitche-1623 changed the title ~~[DRAFT] feat: Add Currencies::isActive() to ensure the currency is active in at least 1 country~~ [Intl] Add Currencies::isActive() to ensure the currency is active in at least 1 country Aug 15, 2025

Crovitche-1623 added 2 commits August 15, 2025 11:20

docs: fix grammar and consistency in currency notes

8d96d1c

fix: incorrect metadata for from and to properties

ab6e0f1

Crovitche-1623 marked this pull request as ready for review August 15, 2025 09:33

carsonbot added Status: Needs Review Feature Intl labels Aug 15, 2025

carsonbot added this to the 7.4 milestone Aug 15, 2025

ro0NL reviewed Aug 15, 2025

View reviewed changes

src/Symfony/Component/Intl/Currencies.php Outdated Show resolved Hide resolved

feat: refactor according to comments + multiple parameters to cover a…

6ee933d

…ll use cases

Crovitche-1623 changed the title ~~[Intl] Add Currencies::isActive() to ensure the currency is active in at least 1 country~~ [Intl] Add methods to filter currencies more precisely Aug 15, 2025

ro0NL reviewed Aug 15, 2025

View reviewed changes

Crovitche-1623 added 8 commits August 18, 2025 10:16

feat: changes related to the review + cs

0f4e203

test: fix testForCountry expected result

88a1d63

refactor: cs

ada1273

bug: fix condition in isValidInCountry

ed4d258

test: added few tests for CurrenciesTest.php

6ad12f4

test: added few tests for CurrenciesTest.php

5c86572

docs: updated CHANGELOG.md

95632e9

test: fix incorrect return type for forCountry and covered all use …

b2b7eeb

…cases to achieve 100% code coverage

ro0NL reviewed Aug 18, 2025

View reviewed changes

src/Symfony/Component/Intl/Data/Generator/CurrencyDataGenerator.php Outdated Show resolved Hide resolved

ro0NL approved these changes Aug 18, 2025

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Aug 18, 2025

fabpot requested changes Aug 19, 2025

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Reviewed labels Aug 19, 2025

Crovitche-1623 added 6 commits August 19, 2025 09:04

docs: change Decode to Decodes

492bad8

refactor: replace array_key_exists check with null coalescing assig…

6a62952

…nment

refactor: iterate CurrencyMap directly instead of using temporary arrays

44292b1

refactor: inline readEntry()` call in foreach loop

6d674db

docs(changelog): split currency metadata and methods into separate en…

d863b2a

…tries

refactor: remove temporary $countries variable in favor of direct for…

3a65b1f

…each

Crovitche-1623 requested a review from fabpot August 19, 2025 07:33

carsonbot added Status: Needs Review and removed Status: Needs Work labels Aug 19, 2025

nicolas-grekas reviewed Aug 19, 2025

View reviewed changes

ro0NL reviewed Aug 19, 2025

View reviewed changes

	* @param ?bool $legalTender if the currency must be a legal tender. Using null do not filter anything
	* @param ?bool $legalTender If the currency must be a legal tender; null to not filter anything

	* @param ?bool $active Indicates whether the currency should always be active for the given $date. Using null do not filter anything
	* @param ?bool $active Indicates whether the currency should always be active for the given $date; null to not filter anything

	* @param \DateTimeInterface $date The date string on which the check will be performed
	* @param \DateTimeInterface $date The date on which the check will be performed

	/**
	* @var \DateTimeImmutable $to The date format is always valid as it is generated using the CurrencyDataGenerator
	*/

	return $active === self::isActive($country, $currency, $currencyMetadata, $date);
	return self::isActive($country, $currency, $currencyMetadata, $date) === $active;

Uh oh!

[Intl] Add methods to filter currencies more precisely #61431

Are you sure you want to change the base?

[Intl] Add methods to filter currencies more precisely #61431

Conversation

Crovitche-1623 commented Aug 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Limitations

Uh oh!

carsonbot commented Aug 15, 2025

Uh oh!

Crovitche-1623 commented Aug 15, 2025

Uh oh!

ro0NL left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Crovitche-1623 commented Aug 15, 2025

Uh oh!

Crovitche-1623 commented Aug 15, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Crovitche-1623 commented Aug 18, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nicolas-grekas left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Crovitche-1623 commented Aug 15, 2025 •

edited

Loading

ro0NL left a comment •

edited

Loading