[Form] Add new active_at, not_active_at and legal_tender options to CurrencyType

Author: Crovitche-1623

CHANGELOG.md

@@ -6,6 +6,7 @@ CHANGELOG
 
  * Add `input=date_point` to `DateTimeType`, `DateType` and `TimeType`
  * Add support for guessing form type of enum properties
+ * Add `active_at`, `not_active_at` and `legal_tender` options to `CurrencyType`
 
 7.3
 ---

Extension/Core/Type/CurrencyType.php

@@ -17,6 +17,7 @@
 use Symfony\Component\Form\Exception\LogicException;
 use Symfony\Component\Intl\Currencies;
 use Symfony\Component\Intl\Intl;
+use Symfony\Component\OptionsResolver\Exception\InvalidOptionsException;
 use Symfony\Component\OptionsResolver\Options;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
@@ -31,15 +32,62 @@ public function configureOptions(OptionsResolver $resolver): void
                 }
 
                 $choiceTranslationLocale = $options['choice_translation_locale'];
+                $activeAt = $options['active_at'];
+                $notActiveAt = $options['not_active_at'];
+                $legalTender = $options['legal_tender'];
 
-                return ChoiceList::loader($this, new IntlCallbackChoiceLoader(static fn () => array_flip(Currencies::getNames($choiceTranslationLocale))), $choiceTranslationLocale);
+                if (null !== $activeAt && null !== $notActiveAt) {
+                    throw new InvalidOptionsException('The "active_at" and "not_active_at" options cannot be used together.');
+                }
+
+                $legalTenderCacheKey = match ($legalTender) {
+                    null => '',
+                    true => '1',
+                    false => '0',
+                };
+
+                return ChoiceList::loader(
+                    $this,
+                    new IntlCallbackChoiceLoader(
+                        static function () use ($choiceTranslationLocale, $activeAt, $notActiveAt, $legalTender) {
+                            if (null === $activeAt && null === $notActiveAt && null === $legalTender) {
+                                return array_flip(Currencies::getNames($choiceTranslationLocale));
+                            }
+
+                            $filteredCurrencyNames = [];
+
+                            $active = match (true) {
+                                null !== $activeAt => true,
+                                null !== $notActiveAt => false,
+                                default => null,
+                            };
+
+                            foreach (Currencies::getCurrencyCodes() as $code) {
+                                if (!Currencies::isValidInAnyCountry($code, $legalTender, $active, $activeAt ?? $notActiveAt)) {
+                                    continue;
+                                }
+
+                                $filteredCurrencyNames[$code] = Currencies::getName($code, $choiceTranslationLocale);
+                            }
+
+                            return array_flip($filteredCurrencyNames);
+                        },
+                    ),
+                    $choiceTranslationLocale.($activeAt ?? $notActiveAt)?->format('Y-m-d\TH:i:s').$legalTenderCacheKey,
+                );
             },
             'choice_translation_domain' => false,
             'choice_translation_locale' => null,
+            'active_at' => new \DateTimeImmutable('today', new \DateTimeZone('Etc/UTC')),
+            'not_active_at' => null,
+            'legal_tender' => true,
             'invalid_message' => 'Please select a valid currency.',
         ]);
 
         $resolver->setAllowedTypes('choice_translation_locale', ['null', 'string']);
+        $resolver->setAllowedTypes('active_at', [\DateTimeInterface::class, 'null']);
+        $resolver->setAllowedTypes('not_active_at', [\DateTimeInterface::class, 'null']);
+        $resolver->setAllowedTypes('legal_tender', ['bool', 'null']);
     }
 
     public function getParent(): ?string

Tests/Extension/Core/Type/CurrencyTypeTest.php

@@ -15,6 +15,7 @@
 use Symfony\Component\Form\ChoiceList\View\ChoiceView;
 use Symfony\Component\Form\Extension\Core\Type\CurrencyType;
 use Symfony\Component\Intl\Util\IntlTestHelper;
+use Symfony\Component\OptionsResolver\Exception\InvalidOptionsException;
 
 class CurrencyTypeTest extends BaseTypeTestCase
 {
@@ -34,7 +35,6 @@ public function testCurrenciesAreSelectable()
 
         $this->assertContainsEquals(new ChoiceView('EUR', 'EUR', 'Euro'), $choices);
         $this->assertContainsEquals(new ChoiceView('USD', 'USD', 'US Dollar'), $choices);
-        $this->assertContainsEquals(new ChoiceView('SIT', 'SIT', 'Slovenian Tolar'), $choices);
     }
 
     #[RequiresPhpExtension('intl')]
@@ -49,7 +49,6 @@ public function testChoiceTranslationLocaleOption()
         // Don't check objects for identity
         $this->assertContainsEquals(new ChoiceView('EUR', 'EUR', 'євро'), $choices);
         $this->assertContainsEquals(new ChoiceView('USD', 'USD', 'долар США'), $choices);
-        $this->assertContainsEquals(new ChoiceView('SIT', 'SIT', 'словенський толар'), $choices);
     }
 
     public function testSubmitNull($expected = null, $norm = null, $view = null)
@@ -61,4 +60,63 @@ public function testSubmitNullUsesDefaultEmptyData($emptyData = 'EUR', $expected
     {
         parent::testSubmitNullUsesDefaultEmptyData($emptyData, $expectedData);
     }
+
+    #[RequiresPhpExtension('intl')]
+    public function testAnActiveAndLegalTenderCurrencyIn2006()
+    {
+        $choices = $this->factory
+            ->create(static::TESTED_TYPE, null, [
+                'choice_translation_locale' => 'fr',
+                'active_at' => new \DateTimeImmutable('2006-01-01', new \DateTimeZone('Etc/UTC')),
+                'legal_tender' => true,
+            ])
+            ->createView()->vars['choices'];
+
+        $this->assertContainsEquals(new ChoiceView('SIT', 'SIT', 'tolar slovène'), $choices);
+    }
+
+    #[RequiresPhpExtension('intl')]
+    public function testAnExpiredCurrencyIn2007()
+    {
+        $choices = $this->factory
+            ->create(static::TESTED_TYPE, null, [
+                'choice_translation_locale' => 'fr',
+                'legal_tender' => true,
+                // The SIT currency expired on 2007-01-14.
+                'active_at' => new \DateTimeImmutable('2007-01-15', new \DateTimeZone('Etc/UTC')),
+            ])
+            ->createView()->vars['choices'];
+
+        $this->assertNotContainsEquals(new ChoiceView('SIT', 'SIT', 'tolar slovène'), $choices);
+    }
+
+    #[RequiresPhpExtension('intl')]
+    public function testRetrieveExpiredCurrenciesIn2007()
+    {
+        $choices = $this->factory
+            ->create(static::TESTED_TYPE, null, [
+                'choice_translation_locale' => 'fr',
+                'legal_tender' => true,
+                'active_at' => null,
+                // The SIT currency expired on 2007-01-14.
+                'not_active_at' => new \DateTimeImmutable('2007-01-15', new \DateTimeZone('Etc/UTC')),
+            ])
+            ->createView()->vars['choices'];
+
+        $this->assertContainsEquals(new ChoiceView('SIT', 'SIT', 'tolar slovène'), $choices);
+    }
+
+    public function testAnExceptionShouldBeThrownWhenTheActiveAtAndNotActiveAtOptionsAreBothSet()
+    {
+        $this->expectException(InvalidOptionsException::class);
+
+        $this->expectExceptionMessage('The "active_at" and "not_active_at" options cannot be used together.');
+
+        $this->factory
+            ->create(static::TESTED_TYPE, null, [
+                'active_at' => new \DateTimeImmutable(),
+                'not_active_at' => new \DateTimeImmutable(),
+            ])
+            ->createView();
+    }
 }