Skip to content

Commit 5d3d1a0

Browse files
fabpotfabpot
committed
feature #28846 [Intl] Simplify API (ro0NL)
This PR was squashed before being merged into the 4.3-dev branch (closes #28846). Discussion ---------- [Intl] Simplify API | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no <!-- see https://symfony.com/bc --> | Deprecations? | no | Tests pass? | yes <!-- please add some, will be required by reviewers --> | Fixed tickets | #18368 | License | MIT | Doc PR | symfony/symfony-docs#11221 Simplifies the Intl API. It greatly reduces the no. of boilerplate classes in this component. Very over complicated, much wow :) Solving (IMHO): ```php class LanguageBundle extends LanguageDataProvider implements LanguageBundleInterface ``` Which seems very over complicated just to provide static data. ```php // before Intl::getLanguageBundle()->getLanguageName() // string | null // after Languages::getName() // string Languages::exists() // bool ``` I left out Canonicalization on puropose, that's a new topic to me. - [x] Languages - [x] Locales - [x] Currencies - [x] Regions - [x] Scripts - [ ] Timezones (#28831) - [x] Update constraints - [x] Update form types Thoughts? Commits ------- d6b67d4 [Intl] Simplify API
2 parents 95932df + d6b67d4 commit 5d3d1a0

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+3767
-60
lines changed

‎UPGRADE-4.3.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,15 @@ HttpKernel
101101
* Renamed `PostResponseEvent` to `TerminateEvent`
102102
* Deprecated `TranslatorListener` in favor of `LocaleAwareListener`
103103

104+
Intl
105+
----
106+
107+
* Deprecated `ResourceBundle` namespace
108+
* Deprecated `Intl::getCurrencyBundle()`, use `Currencies` instead
109+
* Deprecated `Intl::getLanguageBundle()`, use `Languages` or `Scripts` instead
110+
* Deprecated `Intl::getLocaleBundle()`, use `Locales` instead
111+
* Deprecated `Intl::getRegionBundle()`, use `Regions` instead
112+
104113
Messenger
105114
---------
106115

‎UPGRADE-5.0.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -243,6 +243,15 @@ HttpKernel
243243
* Removed `PostResponseEvent`, use `TerminateEvent` instead
244244
* Removed `TranslatorListener` in favor of `LocaleAwareListener`
245245

246+
Intl
247+
----
248+
249+
* Removed `ResourceBundle` namespace
250+
* Removed `Intl::getLanguageBundle()`, use `Languages` or `Scripts` instead
251+
* Removed `Intl::getCurrencyBundle()`, use `Currencies` instead
252+
* Removed `Intl::getLocaleBundle()`, use `Locales` instead
253+
* Removed `Intl::getRegionBundle()`, use `Regions` instead
254+
246255
Messenger
247256
---------
248257

‎src/Symfony/Component/Form/Extension/Core/Type/CountryType.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
use Symfony\Component\Form\ChoiceList\ArrayChoiceList;
1616
use Symfony\Component\Form\ChoiceList\Loader\ChoiceLoaderInterface;
1717
use Symfony\Component\Form\ChoiceList\Loader\IntlCallbackChoiceLoader;
18-
use Symfony\Component\Intl\Intl;
18+
use Symfony\Component\Intl\Regions;
1919
use Symfony\Component\OptionsResolver\Options;
2020
use Symfony\Component\OptionsResolver\OptionsResolver;
2121

@@ -44,7 +44,7 @@ public function configureOptions(OptionsResolver $resolver)
4444
$choiceTranslationLocale = $options['choice_translation_locale'];
4545

4646
return new IntlCallbackChoiceLoader(function () use ($choiceTranslationLocale) {
47-
return array_flip(Intl::getRegionBundle()->getCountryNames($choiceTranslationLocale));
47+
return array_flip(Regions::getNames($choiceTranslationLocale));
4848
});
4949
},
5050
'choice_translation_domain' => false,
@@ -83,7 +83,7 @@ public function loadChoiceList($value = null)
8383
return $this->choiceList;
8484
}
8585

86-
return $this->choiceList = new ArrayChoiceList(array_flip(Intl::getRegionBundle()->getCountryNames()), $value);
86+
return $this->choiceList = new ArrayChoiceList(array_flip(Regions::getNames()), $value);
8787
}
8888

8989
/**

‎src/Symfony/Component/Form/Extension/Core/Type/CurrencyType.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
use Symfony\Component\Form\ChoiceList\ArrayChoiceList;
1616
use Symfony\Component\Form\ChoiceList\Loader\ChoiceLoaderInterface;
1717
use Symfony\Component\Form\ChoiceList\Loader\IntlCallbackChoiceLoader;
18-
use Symfony\Component\Intl\Intl;
18+
use Symfony\Component\Intl\Currencies;
1919
use Symfony\Component\OptionsResolver\Options;
2020
use Symfony\Component\OptionsResolver\OptionsResolver;
2121

@@ -44,7 +44,7 @@ public function configureOptions(OptionsResolver $resolver)
4444
$choiceTranslationLocale = $options['choice_translation_locale'];
4545

4646
return new IntlCallbackChoiceLoader(function () use ($choiceTranslationLocale) {
47-
return array_flip(Intl::getCurrencyBundle()->getCurrencyNames($choiceTranslationLocale));
47+
return array_flip(Currencies::getNames($choiceTranslationLocale));
4848
});
4949
},
5050
'choice_translation_domain' => false,
@@ -83,7 +83,7 @@ public function loadChoiceList($value = null)
8383
return $this->choiceList;
8484
}
8585

86-
return $this->choiceList = new ArrayChoiceList(array_flip(Intl::getCurrencyBundle()->getCurrencyNames()), $value);
86+
return $this->choiceList = new ArrayChoiceList(array_flip(Currencies::getNames()), $value);
8787
}
8888

8989
/**

‎src/Symfony/Component/Form/Extension/Core/Type/LanguageType.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
use Symfony\Component\Form\ChoiceList\ArrayChoiceList;
1616
use Symfony\Component\Form\ChoiceList\Loader\ChoiceLoaderInterface;
1717
use Symfony\Component\Form\ChoiceList\Loader\IntlCallbackChoiceLoader;
18-
use Symfony\Component\Intl\Intl;
18+
use Symfony\Component\Intl\Languages;
1919
use Symfony\Component\OptionsResolver\Options;
2020
use Symfony\Component\OptionsResolver\OptionsResolver;
2121

@@ -44,7 +44,7 @@ public function configureOptions(OptionsResolver $resolver)
4444
$choiceTranslationLocale = $options['choice_translation_locale'];
4545

4646
return new IntlCallbackChoiceLoader(function () use ($choiceTranslationLocale) {
47-
return array_flip(Intl::getLanguageBundle()->getLanguageNames($choiceTranslationLocale));
47+
return array_flip(Languages::getNames($choiceTranslationLocale));
4848
});
4949
},
5050
'choice_translation_domain' => false,
@@ -83,7 +83,7 @@ public function loadChoiceList($value = null)
8383
return $this->choiceList;
8484
}
8585

86-
return $this->choiceList = new ArrayChoiceList(array_flip(Intl::getLanguageBundle()->getLanguageNames()), $value);
86+
return $this->choiceList = new ArrayChoiceList(array_flip(Languages::getNames()), $value);
8787
}
8888

8989
/**

‎src/Symfony/Component/Form/Extension/Core/Type/LocaleType.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
use Symfony\Component\Form\ChoiceList\ArrayChoiceList;
1616
use Symfony\Component\Form\ChoiceList\Loader\ChoiceLoaderInterface;
1717
use Symfony\Component\Form\ChoiceList\Loader\IntlCallbackChoiceLoader;
18-
use Symfony\Component\Intl\Intl;
18+
use Symfony\Component\Intl\Locales;
1919
use Symfony\Component\OptionsResolver\Options;
2020
use Symfony\Component\OptionsResolver\OptionsResolver;
2121

@@ -44,7 +44,7 @@ public function configureOptions(OptionsResolver $resolver)
4444
$choiceTranslationLocale = $options['choice_translation_locale'];
4545

4646
return new IntlCallbackChoiceLoader(function () use ($choiceTranslationLocale) {
47-
return array_flip(Intl::getLocaleBundle()->getLocaleNames($choiceTranslationLocale));
47+
return array_flip(Locales::getNames($choiceTranslationLocale));
4848
});
4949
},
5050
'choice_translation_domain' => false,
@@ -83,7 +83,7 @@ public function loadChoiceList($value = null)
8383
return $this->choiceList;
8484
}
8585

86-
return $this->choiceList = new ArrayChoiceList(array_flip(Intl::getLocaleBundle()->getLocaleNames()), $value);
86+
return $this->choiceList = new ArrayChoiceList(array_flip(Locales::getNames()), $value);
8787
}
8888

8989
/**

‎src/Symfony/Component/Form/composer.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
"require": {
1919
"php": "^7.1.3",
2020
"symfony/event-dispatcher": "^4.3",
21-
"symfony/intl": "~3.4|~4.0",
21+
"symfony/intl": "^4.3",
2222
"symfony/options-resolver": "~4.2",
2323
"symfony/polyfill-ctype": "~1.8",
2424
"symfony/polyfill-mbstring": "~1.0",
@@ -43,6 +43,7 @@
4343
"symfony/doctrine-bridge": "<3.4",
4444
"symfony/framework-bundle": "<3.4",
4545
"symfony/http-kernel": "<4.3",
46+
"symfony/intl": "<4.3",
4647
"symfony/translation": "<4.2",
4748
"symfony/twig-bridge": "<3.4.5|<4.0.5,>=4.0"
4849
},

‎src/Symfony/Component/Intl/CHANGELOG.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,15 @@
11
CHANGELOG
22
=========
33

4+
4.3.0
5+
-----
6+
7+
* deprecated `ResourceBundle` namespace
8+
* added `Currencies` in favor of `Intl::getCurrencyBundle()`
9+
* added `Languages` and `Scripts` in favor of `Intl::getLanguageBundle()`
10+
* added `Locales` in favor of `Intl::getLocaleBundle()`
11+
* added `Regions` in favor of `Intl::getRegionBundle()`
12+
413
4.2.0
514
-----
615

‎src/Symfony/Component/Intl/Currencies.php‎

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.com>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Component\Intl;
13+
14+
use Symfony\Component\Intl\Exception\MissingResourceException;
15+
16+
/**
17+
* Gives access to currency-related ICU data.
18+
*
19+
* @author Bernhard Schussek <bschussek@gmail.com>
20+
* @author Roland Franssen <franssen.roland@gmail.com>
21+
*/
22+
final class Currencies extends ResourceBundle
23+
{
24+
private const INDEX_SYMBOL = 0;
25+
private const INDEX_NAME = 1;
26+
private const INDEX_FRACTION_DIGITS = 0;
27+
private const INDEX_ROUNDING_INCREMENT = 1;
28+
29+
/**
30+
* @return string[]
31+
*/
32+
public static function getCurrencyCodes(): array
33+
{
34+
return self::readEntry(['Currencies'], 'meta');
35+
}
36+
37+
public static function exists(string $currency): bool
38+
{
39+
try {
40+
self::readEntry(['Names', $currency, self::INDEX_NAME]);
41+
42+
return true;
43+
} catch (MissingResourceException $e) {
44+
return false;
45+
}
46+
}
47+
48+
public static function getName(string $currency, string $displayLocale = null): string
49+
{
50+
return self::readEntry(['Names', $currency, self::INDEX_NAME], $displayLocale);
51+
}
52+
53+
/**
54+
* @return string[]
55+
*/
56+
public static function getNames(string $displayLocale = null): array
57+
{
58+
// ====================================================================
59+
// For reference: It is NOT possible to return names indexed by
60+
// numeric code here, because some numeric codes map to multiple
61+
// 3-letter codes (e.g. 32 => "ARA", "ARP", "ARS")
62+
// ====================================================================
63+
64+
$names = self::readEntry(['Names'], $displayLocale);
65+
66+
if ($names instanceof \Traversable) {
67+
$names = iterator_to_array($names);
68+
}
69+
70+
array_walk($names, function (&$value) {
71+
$value = $value[self::INDEX_NAME];
72+
});
73+
74+
return self::asort($names, $displayLocale);
75+
}
76+
77+
public static function getSymbol(string $currency, string $displayLocale = null): string
78+
{
79+
return self::readEntry(['Names', $currency, self::INDEX_SYMBOL], $displayLocale);
80+
}
81+
82+
public static function getFractionDigits(string $currency): int
83+
{
84+
try {
85+
return self::readEntry(['Meta', $currency, self::INDEX_FRACTION_DIGITS], 'meta');
86+
} catch (MissingResourceException $e) {
87+
return self::readEntry(['Meta', 'DEFAULT', self::INDEX_FRACTION_DIGITS], 'meta');
88+
}
89+
}
90+
91+
/**
92+
* @return float|int
93+
*/
94+
public static function getRoundingIncrement(string $currency)
95+
{
96+
try {
97+
return self::readEntry(['Meta', $currency, self::INDEX_ROUNDING_INCREMENT], 'meta');
98+
} catch (MissingResourceException $e) {
99+
return self::readEntry(['Meta', 'DEFAULT', self::INDEX_ROUNDING_INCREMENT], 'meta');
100+
}
101+
}
102+
103+
public static function getNumericCode(string $currency): int
104+
{
105+
return self::readEntry(['Alpha3ToNumeric', $currency], 'meta');
106+
}
107+
108+
public static function forNumericCode(int $numericCode): array
109+
{
110+
return self::readEntry(['NumericToAlpha3', (string) $numericCode], 'meta');
111+
}
112+
113+
protected static function getPath(): string
114+
{
115+
return Intl::getDataDirectory().'/'.Intl::CURRENCY_DIR;
116+
}
117+
}

‎src/Symfony/Component/Intl/Data/Provider/CurrencyDataProvider.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
*
2121
* @author Bernhard Schussek <bschussek@gmail.com>
2222
*
23-
* @internal
23+
* @internal to be removed in 5.0.
2424
*/
2525
class CurrencyDataProvider
2626
{

0 commit comments

Comments
 (0)