vendor/twig/intl-extra/IntlExtension.php line 372

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of Twig.
  5.  *
  6.  * (c) Fabien Potencier
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Twig\Extra\Intl;
  14. use Symfony\Component\Intl\Countries;
  15. use Symfony\Component\Intl\Currencies;
  16. use Symfony\Component\Intl\Exception\MissingResourceException;
  17. use Symfony\Component\Intl\Languages;
  18. use Symfony\Component\Intl\Locales;
  19. use Symfony\Component\Intl\Scripts;
  20. use Symfony\Component\Intl\Timezones;
  21. use Twig\Environment;
  22. use Twig\Error\RuntimeError;
  23. use Twig\Extension\AbstractExtension;
  24. use Twig\TwigFilter;
  25. use Twig\TwigFunction;
  27. final class IntlExtension extends AbstractExtension
  28. {
  29.     private static function availableDateFormats(): array
  30.     {
  31.         static $formats = null;
  33.         if (null !== $formats) {
  34.             return $formats;
  35.         }
  37.         $formats = [
  38.             'none' => \IntlDateFormatter::NONE,
  39.             'short' => \IntlDateFormatter::SHORT,
  40.             'medium' => \IntlDateFormatter::MEDIUM,
  41.             'long' => \IntlDateFormatter::LONG,
  42.             'full' => \IntlDateFormatter::FULL,
  43.         ];
  45.         // Assuming that each `RELATIVE_*` constant are defined when one of them is.
  46.         if (\defined('IntlDateFormatter::RELATIVE_FULL')) {
  47.             $formats = array_merge($formats, [
  48.                 'relative_short' => \IntlDateFormatter::RELATIVE_SHORT,
  49.                 'relative_medium' => \IntlDateFormatter::RELATIVE_MEDIUM,
  50.                 'relative_long' => \IntlDateFormatter::RELATIVE_LONG,
  51.                 'relative_full' => \IntlDateFormatter::RELATIVE_FULL,
  52.             ]);
  53.         }
  55.         return $formats;
  56.     }
  58.     private const TIME_FORMATS = [
  59.         'none' => \IntlDateFormatter::NONE,
  60.         'short' => \IntlDateFormatter::SHORT,
  61.         'medium' => \IntlDateFormatter::MEDIUM,
  62.         'long' => \IntlDateFormatter::LONG,
  63.         'full' => \IntlDateFormatter::FULL,
  64.     ];
  65.     private const NUMBER_TYPES = [
  66.         'default' => \NumberFormatter::TYPE_DEFAULT,
  67.         'int32' => \NumberFormatter::TYPE_INT32,
  68.         'int64' => \NumberFormatter::TYPE_INT64,
  69.         'double' => \NumberFormatter::TYPE_DOUBLE,
  70.         'currency' => \NumberFormatter::TYPE_CURRENCY,
  71.     ];
  72.     private const NUMBER_STYLES = [
  73.         'decimal' => \NumberFormatter::DECIMAL,
  74.         'currency' => \NumberFormatter::CURRENCY,
  75.         'percent' => \NumberFormatter::PERCENT,
  76.         'scientific' => \NumberFormatter::SCIENTIFIC,
  77.         'spellout' => \NumberFormatter::SPELLOUT,
  78.         'ordinal' => \NumberFormatter::ORDINAL,
  79.         'duration' => \NumberFormatter::DURATION,
  80.     ];
  81.     private const NUMBER_ATTRIBUTES = [
  82.         'grouping_used' => \NumberFormatter::GROUPING_USED,
  83.         'decimal_always_shown' => \NumberFormatter::DECIMAL_ALWAYS_SHOWN,
  84.         'max_integer_digit' => \NumberFormatter::MAX_INTEGER_DIGITS,
  85.         'min_integer_digit' => \NumberFormatter::MIN_INTEGER_DIGITS,
  86.         'integer_digit' => \NumberFormatter::INTEGER_DIGITS,
  87.         'max_fraction_digit' => \NumberFormatter::MAX_FRACTION_DIGITS,
  88.         'min_fraction_digit' => \NumberFormatter::MIN_FRACTION_DIGITS,
  89.         'fraction_digit' => \NumberFormatter::FRACTION_DIGITS,
  90.         'multiplier' => \NumberFormatter::MULTIPLIER,
  91.         'grouping_size' => \NumberFormatter::GROUPING_SIZE,
  92.         'rounding_mode' => \NumberFormatter::ROUNDING_MODE,
  93.         'rounding_increment' => \NumberFormatter::ROUNDING_INCREMENT,
  94.         'format_width' => \NumberFormatter::FORMAT_WIDTH,
  95.         'padding_position' => \NumberFormatter::PADDING_POSITION,
  96.         'secondary_grouping_size' => \NumberFormatter::SECONDARY_GROUPING_SIZE,
  97.         'significant_digits_used' => \NumberFormatter::SIGNIFICANT_DIGITS_USED,
  98.         'min_significant_digits_used' => \NumberFormatter::MIN_SIGNIFICANT_DIGITS,
  99.         'max_significant_digits_used' => \NumberFormatter::MAX_SIGNIFICANT_DIGITS,
  100.         'lenient_parse' => \NumberFormatter::LENIENT_PARSE,
  101.     ];
  102.     private const NUMBER_ROUNDING_ATTRIBUTES = [
  103.         'ceiling' => \NumberFormatter::ROUND_CEILING,
  104.         'floor' => \NumberFormatter::ROUND_FLOOR,
  105.         'down' => \NumberFormatter::ROUND_DOWN,
  106.         'up' => \NumberFormatter::ROUND_UP,
  107.         'halfeven' => \NumberFormatter::ROUND_HALFEVEN,
  108.         'halfdown' => \NumberFormatter::ROUND_HALFDOWN,
  109.         'halfup' => \NumberFormatter::ROUND_HALFUP,
  110.     ];
  111.     private const NUMBER_PADDING_ATTRIBUTES = [
  112.         'before_prefix' => \NumberFormatter::PAD_BEFORE_PREFIX,
  113.         'after_prefix' => \NumberFormatter::PAD_AFTER_PREFIX,
  114.         'before_suffix' => \NumberFormatter::PAD_BEFORE_SUFFIX,
  115.         'after_suffix' => \NumberFormatter::PAD_AFTER_SUFFIX,
  116.     ];
  117.     private const NUMBER_TEXT_ATTRIBUTES = [
  118.         'positive_prefix' => \NumberFormatter::POSITIVE_PREFIX,
  119.         'positive_suffix' => \NumberFormatter::POSITIVE_SUFFIX,
  120.         'negative_prefix' => \NumberFormatter::NEGATIVE_PREFIX,
  121.         'negative_suffix' => \NumberFormatter::NEGATIVE_SUFFIX,
  122.         'padding_character' => \NumberFormatter::PADDING_CHARACTER,
  123.         'currency_code' => \NumberFormatter::CURRENCY_CODE,
  124.         'default_ruleset' => \NumberFormatter::DEFAULT_RULESET,
  125.         'public_rulesets' => \NumberFormatter::PUBLIC_RULESETS,
  126.     ];
  127.     private const NUMBER_SYMBOLS = [
  128.         'decimal_separator' => \NumberFormatter::DECIMAL_SEPARATOR_SYMBOL,
  129.         'grouping_separator' => \NumberFormatter::GROUPING_SEPARATOR_SYMBOL,
  130.         'pattern_separator' => \NumberFormatter::PATTERN_SEPARATOR_SYMBOL,
  131.         'percent' => \NumberFormatter::PERCENT_SYMBOL,
  132.         'zero_digit' => \NumberFormatter::ZERO_DIGIT_SYMBOL,
  133.         'digit' => \NumberFormatter::DIGIT_SYMBOL,
  134.         'minus_sign' => \NumberFormatter::MINUS_SIGN_SYMBOL,
  135.         'plus_sign' => \NumberFormatter::PLUS_SIGN_SYMBOL,
  136.         'currency' => \NumberFormatter::CURRENCY_SYMBOL,
  137.         'intl_currency' => \NumberFormatter::INTL_CURRENCY_SYMBOL,
  138.         'monetary_separator' => \NumberFormatter::MONETARY_SEPARATOR_SYMBOL,
  139.         'exponential' => \NumberFormatter::EXPONENTIAL_SYMBOL,
  140.         'permill' => \NumberFormatter::PERMILL_SYMBOL,
  141.         'pad_escape' => \NumberFormatter::PAD_ESCAPE_SYMBOL,
  142.         'infinity' => \NumberFormatter::INFINITY_SYMBOL,
  143.         'nan' => \NumberFormatter::NAN_SYMBOL,
  144.         'significant_digit' => \NumberFormatter::SIGNIFICANT_DIGIT_SYMBOL,
  145.         'monetary_grouping_separator' => \NumberFormatter::MONETARY_GROUPING_SEPARATOR_SYMBOL,
  146.     ];
  148.     private $dateFormatters = [];
  149.     private $numberFormatters = [];
  150.     private $dateFormatterPrototype;
  151.     private $numberFormatterPrototype;
  153.     public function __construct(\IntlDateFormatter $dateFormatterPrototype = null, \NumberFormatter $numberFormatterPrototype = null)
  154.     {
  155.         $this->dateFormatterPrototype = $dateFormatterPrototype;
  156.         $this->numberFormatterPrototype = $numberFormatterPrototype;
  157.     }
  159.     public function getFilters()
  160.     {
  161.         return [
  162.             // internationalized names
  163.             new TwigFilter('country_name', [$this, 'getCountryName']),
  164.             new TwigFilter('currency_name', [$this, 'getCurrencyName']),
  165.             new TwigFilter('currency_symbol', [$this, 'getCurrencySymbol']),
  166.             new TwigFilter('language_name', [$this, 'getLanguageName']),
  167.             new TwigFilter('locale_name', [$this, 'getLocaleName']),
  168.             new TwigFilter('timezone_name', [$this, 'getTimezoneName']),
  170.             // localized formatters
  171.             new TwigFilter('format_currency', [$this, 'formatCurrency']),
  172.             new TwigFilter('format_number', [$this, 'formatNumber']),
  173.             new TwigFilter('format_*_number', [$this, 'formatNumberStyle']),
  174.             new TwigFilter('format_datetime', [$this, 'formatDateTime'], ['needs_environment' => true]),
  175.             new TwigFilter('format_date', [$this, 'formatDate'], ['needs_environment' => true]),
  176.             new TwigFilter('format_time', [$this, 'formatTime'], ['needs_environment' => true]),
  177.         ];
  178.     }
  180.     public function getFunctions()
  181.     {
  182.         return [
  183.             // internationalized names
  184.             new TwigFunction('country_timezones', [$this, 'getCountryTimezones']),
  185.             new TwigFunction('language_names', [$this, 'getLanguageNames']),
  186.             new TwigFunction('script_names', [$this, 'getScriptNames']),
  187.             new TwigFunction('country_names', [$this, 'getCountryNames']),
  188.             new TwigFunction('locale_names', [$this, 'getLocaleNames']),
  189.             new TwigFunction('currency_names', [$this, 'getCurrencyNames']),
  190.             new TwigFunction('timezone_names', [$this, 'getTimezoneNames']),
  191.         ];
  192.     }
  194.     public function getCountryName(?string $country, string $locale = null): string
  195.     {
  196.         if (null === $country) {
  197.             return '';
  198.         }
  200.         try {
  201.             return Countries::getName($country, $locale);
  202.         } catch (MissingResourceException $exception) {
  203.             return $country;
  204.         }
  205.     }
  207.     public function getCurrencyName(?string $currency, string $locale = null): string
  208.     {
  209.         if (null === $currency) {
  210.             return '';
  211.         }
  213.         try {
  214.             return Currencies::getName($currency, $locale);
  215.         } catch (MissingResourceException $exception) {
  216.             return $currency;
  217.         }
  218.     }
  220.     public function getCurrencySymbol(?string $currency, string $locale = null): string
  221.     {
  222.         if (null === $currency) {
  223.             return '';
  224.         }
  226.         try {
  227.             return Currencies::getSymbol($currency, $locale);
  228.         } catch (MissingResourceException $exception) {
  229.             return $currency;
  230.         }
  231.     }
  233.     public function getLanguageName(?string $language, string $locale = null): string
  234.     {
  235.         if (null === $language) {
  236.             return '';
  237.         }
  239.         try {
  240.             return Languages::getName($language, $locale);
  241.         } catch (MissingResourceException $exception) {
  242.             return $language;
  243.         }
  244.     }
  246.     public function getLocaleName(?string $data, string $locale = null): string
  247.     {
  248.         if (null === $data) {
  249.             return '';
  250.         }
  252.         try {
  253.             return Locales::getName($data, $locale);
  254.         } catch (MissingResourceException $exception) {
  255.             return $data;
  256.         }
  257.     }
  259.     public function getTimezoneName(?string $timezone, string $locale = null): string
  260.     {
  261.         if (null === $timezone) {
  262.             return '';
  263.         }
  265.         try {
  266.             return Timezones::getName($timezone, $locale);
  267.         } catch (MissingResourceException $exception) {
  268.             return $timezone;
  269.         }
  270.     }
  272.     public function getCountryTimezones(string $country): array
  273.     {
  274.         try {
  275.             return Timezones::forCountryCode($country);
  276.         } catch (MissingResourceException $exception) {
  277.             return [];
  278.         }
  279.     }
  281.     public function getLanguageNames(string $locale = null): array
  282.     {
  283.         try {
  284.             return Languages::getNames($locale);
  285.         } catch (MissingResourceException $exception) {
  286.             return [];
  287.         }
  288.     }
  290.     public function getScriptNames(string $locale = null): array
  291.     {
  292.         try {
  293.             return Scripts::getNames($locale);
  294.         } catch (MissingResourceException $exception) {
  295.             return [];
  296.         }
  297.     }
  299.     public function getCountryNames(string $locale = null): array
  300.     {
  301.         try {
  302.             return Countries::getNames($locale);
  303.         } catch (MissingResourceException $exception) {
  304.             return [];
  305.         }
  306.     }
  308.     public function getLocaleNames(string $locale = null): array
  309.     {
  310.         try {
  311.             return Locales::getNames($locale);
  312.         } catch (MissingResourceException $exception) {
  313.             return [];
  314.         }
  315.     }
  317.     public function getCurrencyNames(string $locale = null): array
  318.     {
  319.         try {
  320.             return Currencies::getNames($locale);
  321.         } catch (MissingResourceException $exception) {
  322.             return [];
  323.         }
  324.     }
  326.     public function getTimezoneNames(string $locale = null): array
  327.     {
  328.         try {
  329.             return Timezones::getNames($locale);
  330.         } catch (MissingResourceException $exception) {
  331.             return [];
  332.         }
  333.     }
  335.     public function formatCurrency($amount, string $currency, array $attrs = [], string $locale = null): string
  336.     {
  337.         $formatter = $this->createNumberFormatter($locale, 'currency', $attrs);
  339.         if (false === $ret = $formatter->formatCurrency($amount, $currency)) {
  340.             throw new RuntimeError('Unable to format the given number as a currency.');
  341.         }
  343.         return $ret;
  344.     }
  346.     public function formatNumber($number, array $attrs = [], string $style = 'decimal', string $type = 'default', string $locale = null): string
  347.     {
  348.         if (!isset(self::NUMBER_TYPES[$type])) {
  349.             throw new RuntimeError(sprintf('The type "%s" does not exist, known types are: "%s".', $type, implode('", "', array_keys(self::NUMBER_TYPES))));
  350.         }
  352.         $formatter = $this->createNumberFormatter($locale, $style, $attrs);
  354.         if (false === $ret = $formatter->format($number, self::NUMBER_TYPES[$type])) {
  355.             throw new RuntimeError('Unable to format the given number.');
  356.         }
  358.         return $ret;
  359.     }
  361.     public function formatNumberStyle(string $style, $number, array $attrs = [], string $type = 'default', string $locale = null): string
  362.     {
  363.         return $this->formatNumber($number, $attrs, $style, $type, $locale);
  364.     }
  366.     /**
  367.      * @param \DateTimeInterface|string|null  $date     A date or null to use the current time
  368.      * @param \DateTimeZone|string|false|null $timezone The target timezone, null to use the default, false to leave unchanged
  369.      */
  370.     public function formatDateTime(Environment $env, $date, ?string $dateFormat = 'medium', ?string $timeFormat = 'medium', string $pattern = '', $timezone = null, string $calendar = 'gregorian', string $locale = null): string
  371.     {
  372.         $date = twig_date_converter($env, $date, $timezone);
  373.         $formatter = $this->createDateFormatter($locale, $dateFormat, $timeFormat, $pattern, $date->getTimezone(), $calendar);
  375.         if (false === $ret = $formatter->format($date)) {
  376.             throw new RuntimeError('Unable to format the given date.');
  377.         }
  379.         return $ret;
  380.     }
  382.     /**
  383.      * @param \DateTimeInterface|string|null  $date     A date or null to use the current time
  384.      * @param \DateTimeZone|string|false|null $timezone The target timezone, null to use the default, false to leave unchanged
  385.      */
  386.     public function formatDate(Environment $env, $date, ?string $dateFormat = 'medium', string $pattern = '', $timezone = null, string $calendar = 'gregorian', string $locale = null): string
  387.     {
  388.         return $this->formatDateTime($env, $date, $dateFormat, 'none', $pattern, $timezone, $calendar, $locale);
  389.     }
  391.     /**
  392.      * @param \DateTimeInterface|string|null  $date     A date or null to use the current time
  393.      * @param \DateTimeZone|string|false|null $timezone The target timezone, null to use the default, false to leave unchanged
  394.      */
  395.     public function formatTime(Environment $env, $date, ?string $timeFormat = 'medium', string $pattern = '', $timezone = null, string $calendar = 'gregorian', string $locale = null): string
  396.     {
  397.         return $this->formatDateTime($env, $date, 'none', $timeFormat, $pattern, $timezone, $calendar, $locale);
  398.     }
  400.     private function createDateFormatter(?string $locale, ?string $dateFormat, ?string $timeFormat, string $pattern, \DateTimeZone $timezone, string $calendar): \IntlDateFormatter
  401.     {
  402.         $dateFormats = self::availableDateFormats();
  404.         if (null !== $dateFormat && !isset($dateFormats[$dateFormat])) {
  405.             throw new RuntimeError(sprintf('The date format "%s" does not exist, known formats are: "%s".', $dateFormat, implode('", "', array_keys($dateFormats))));
  406.         }
  408.         if (null !== $timeFormat && !isset(self::TIME_FORMATS[$timeFormat])) {
  409.             throw new RuntimeError(sprintf('The time format "%s" does not exist, known formats are: "%s".', $timeFormat, implode('", "', array_keys(self::TIME_FORMATS))));
  410.         }
  412.         if (null === $locale) {
  413.             $locale = \Locale::getDefault();
  414.         }
  416.         $calendar = 'gregorian' === $calendar ? \IntlDateFormatter::GREGORIAN : \IntlDateFormatter::TRADITIONAL;
  418.         $dateFormatValue = $dateFormats[$dateFormat] ?? null;
  419.         $timeFormatValue = self::TIME_FORMATS[$timeFormat] ?? null;
  421.         if ($this->dateFormatterPrototype) {
  422.             $dateFormatValue = $dateFormatValue ?: $this->dateFormatterPrototype->getDateType();
  423.             $timeFormatValue = $timeFormatValue ?: $this->dateFormatterPrototype->getTimeType();
  424.             $timezone = $timezone ?: $this->dateFormatterPrototype->getTimeType();
  425.             $calendar = $calendar ?: $this->dateFormatterPrototype->getCalendar();
  426.             $pattern = $pattern ?: $this->dateFormatterPrototype->getPattern();
  427.         }
  429.         $hash = $locale.'|'.$dateFormatValue.'|'.$timeFormatValue.'|'.$timezone->getName().'|'.$calendar.'|'.$pattern;
  431.         if (!isset($this->dateFormatters[$hash])) {
  432.             $this->dateFormatters[$hash] = new \IntlDateFormatter($locale, $dateFormatValue, $timeFormatValue, $timezone, $calendar, $pattern);
  433.         }
  435.         return $this->dateFormatters[$hash];
  436.     }
  438.     private function createNumberFormatter(?string $locale, string $style, array $attrs = []): \NumberFormatter
  439.     {
  440.         if (!isset(self::NUMBER_STYLES[$style])) {
  441.             throw new RuntimeError(sprintf('The style "%s" does not exist, known styles are: "%s".', $style, implode('", "', array_keys(self::NUMBER_STYLES))));
  442.         }
  444.         if (null === $locale) {
  445.             $locale = \Locale::getDefault();
  446.         }
  448.         // textAttrs and symbols can only be set on the prototype as there is probably no
  449.         // use case for setting it on each call.
  450.         $textAttrs = [];
  451.         $symbols = [];
  452.         if ($this->numberFormatterPrototype) {
  453.             foreach (self::NUMBER_ATTRIBUTES as $name => $const) {
  454.                 if (!isset($attrs[$name])) {
  455.                     $value = $this->numberFormatterPrototype->getAttribute($const);
  456.                     if ('rounding_mode' === $name) {
  457.                         $value = array_flip(self::NUMBER_ROUNDING_ATTRIBUTES)[$value];
  458.                     } elseif ('padding_position' === $name) {
  459.                         $value = array_flip(self::NUMBER_PADDING_ATTRIBUTES)[$value];
  460.                     }
  461.                     $attrs[$name] = $value;
  462.                 }
  463.             }
  465.             foreach (self::NUMBER_TEXT_ATTRIBUTES as $name => $const) {
  466.                 $textAttrs[$name] = $this->numberFormatterPrototype->getTextAttribute($const);
  467.             }
  469.             foreach (self::NUMBER_SYMBOLS as $name => $const) {
  470.                 $symbols[$name] = $this->numberFormatterPrototype->getSymbol($const);
  471.             }
  472.         }
  474.         ksort($attrs);
  475.         $hash = $locale.'|'.$style.'|'.json_encode($attrs).'|'.json_encode($textAttrs).'|'.json_encode($symbols);
  477.         if (!isset($this->numberFormatters[$hash])) {
  478.             $this->numberFormatters[$hash] = new \NumberFormatter($locale, self::NUMBER_STYLES[$style]);
  479.         }
  481.         foreach ($attrs as $name => $value) {
  482.             if (!isset(self::NUMBER_ATTRIBUTES[$name])) {
  483.                 throw new RuntimeError(sprintf('The number formatter attribute "%s" does not exist, known attributes are: "%s".', $name, implode('", "', array_keys(self::NUMBER_ATTRIBUTES))));
  484.             }
  486.             if ('rounding_mode' === $name) {
  487.                 if (!isset(self::NUMBER_ROUNDING_ATTRIBUTES[$value])) {
  488.                     throw new RuntimeError(sprintf('The number formatter rounding mode "%s" does not exist, known modes are: "%s".', $value, implode('", "', array_keys(self::NUMBER_ROUNDING_ATTRIBUTES))));
  489.                 }
  491.                 $value = self::NUMBER_ROUNDING_ATTRIBUTES[$value];
  492.             } elseif ('padding_position' === $name) {
  493.                 if (!isset(self::NUMBER_PADDING_ATTRIBUTES[$value])) {
  494.                     throw new RuntimeError(sprintf('The number formatter padding position "%s" does not exist, known positions are: "%s".', $value, implode('", "', array_keys(self::NUMBER_PADDING_ATTRIBUTES))));
  495.                 }
  497.                 $value = self::NUMBER_PADDING_ATTRIBUTES[$value];
  498.             }
  500.             $this->numberFormatters[$hash]->setAttribute(self::NUMBER_ATTRIBUTES[$name], $value);
  501.         }
  503.         foreach ($textAttrs as $name => $value) {
  504.             $this->numberFormatters[$hash]->setTextAttribute(self::NUMBER_TEXT_ATTRIBUTES[$name], $value);
  505.         }
  507.         foreach ($symbols as $name => $value) {
  508.             $this->numberFormatters[$hash]->setSymbol(self::NUMBER_SYMBOLS[$name], $value);
  509.         }
  511.         return $this->numberFormatters[$hash];
  512.     }
  513. }