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

  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 const DATE_FORMATS = [
  30.         'none' => \IntlDateFormatter::NONE,
  31.         'short' => \IntlDateFormatter::SHORT,
  32.         'medium' => \IntlDateFormatter::MEDIUM,
  33.         'long' => \IntlDateFormatter::LONG,
  34.         'full' => \IntlDateFormatter::FULL,
  35.     ];
  36.     private const NUMBER_TYPES = [
  37.         'default' => \NumberFormatter::TYPE_DEFAULT,
  38.         'int32' => \NumberFormatter::TYPE_INT32,
  39.         'int64' => \NumberFormatter::TYPE_INT64,
  40.         'double' => \NumberFormatter::TYPE_DOUBLE,
  41.         'currency' => \NumberFormatter::TYPE_CURRENCY,
  42.     ];
  43.     private const NUMBER_STYLES = [
  44.         'decimal' => \NumberFormatter::DECIMAL,
  45.         'currency' => \NumberFormatter::CURRENCY,
  46.         'percent' => \NumberFormatter::PERCENT,
  47.         'scientific' => \NumberFormatter::SCIENTIFIC,
  48.         'spellout' => \NumberFormatter::SPELLOUT,
  49.         'ordinal' => \NumberFormatter::ORDINAL,
  50.         'duration' => \NumberFormatter::DURATION,
  51.     ];
  52.     private const NUMBER_ATTRIBUTES = [
  53.         'grouping_used' => \NumberFormatter::GROUPING_USED,
  54.         'decimal_always_shown' => \NumberFormatter::DECIMAL_ALWAYS_SHOWN,
  55.         'max_integer_digit' => \NumberFormatter::MAX_INTEGER_DIGITS,
  56.         'min_integer_digit' => \NumberFormatter::MIN_INTEGER_DIGITS,
  57.         'integer_digit' => \NumberFormatter::INTEGER_DIGITS,
  58.         'max_fraction_digit' => \NumberFormatter::MAX_FRACTION_DIGITS,
  59.         'min_fraction_digit' => \NumberFormatter::MIN_FRACTION_DIGITS,
  60.         'fraction_digit' => \NumberFormatter::FRACTION_DIGITS,
  61.         'multiplier' => \NumberFormatter::MULTIPLIER,
  62.         'grouping_size' => \NumberFormatter::GROUPING_SIZE,
  63.         'rounding_mode' => \NumberFormatter::ROUNDING_MODE,
  64.         'rounding_increment' => \NumberFormatter::ROUNDING_INCREMENT,
  65.         'format_width' => \NumberFormatter::FORMAT_WIDTH,
  66.         'padding_position' => \NumberFormatter::PADDING_POSITION,
  67.         'secondary_grouping_size' => \NumberFormatter::SECONDARY_GROUPING_SIZE,
  68.         'significant_digits_used' => \NumberFormatter::SIGNIFICANT_DIGITS_USED,
  69.         'min_significant_digits_used' => \NumberFormatter::MIN_SIGNIFICANT_DIGITS,
  70.         'max_significant_digits_used' => \NumberFormatter::MAX_SIGNIFICANT_DIGITS,
  71.         'lenient_parse' => \NumberFormatter::LENIENT_PARSE,
  72.     ];
  73.     private const NUMBER_ROUNDING_ATTRIBUTES = [
  74.         'ceiling' => \NumberFormatter::ROUND_CEILING,
  75.         'floor' => \NumberFormatter::ROUND_FLOOR,
  76.         'down' => \NumberFormatter::ROUND_DOWN,
  77.         'up' => \NumberFormatter::ROUND_UP,
  78.         'halfeven' => \NumberFormatter::ROUND_HALFEVEN,
  79.         'halfdown' => \NumberFormatter::ROUND_HALFDOWN,
  80.         'halfup' => \NumberFormatter::ROUND_HALFUP,
  81.     ];
  82.     private const NUMBER_PADDING_ATTRIBUTES = [
  83.         'before_prefix' => \NumberFormatter::PAD_BEFORE_PREFIX,
  84.         'after_prefix' => \NumberFormatter::PAD_AFTER_PREFIX,
  85.         'before_suffix' => \NumberFormatter::PAD_BEFORE_SUFFIX,
  86.         'after_suffix' => \NumberFormatter::PAD_AFTER_SUFFIX,
  87.     ];
  88.     private const NUMBER_TEXT_ATTRIBUTES = [
  89.         'positive_prefix' => \NumberFormatter::POSITIVE_PREFIX,
  90.         'positive_suffix' => \NumberFormatter::POSITIVE_SUFFIX,
  91.         'negative_prefix' => \NumberFormatter::NEGATIVE_PREFIX,
  92.         'negative_suffix' => \NumberFormatter::NEGATIVE_SUFFIX,
  93.         'padding_character' => \NumberFormatter::PADDING_CHARACTER,
  94.         'currency_code' => \NumberFormatter::CURRENCY_CODE,
  95.         'default_ruleset' => \NumberFormatter::DEFAULT_RULESET,
  96.         'public_rulesets' => \NumberFormatter::PUBLIC_RULESETS,
  97.     ];
  98.     private const NUMBER_SYMBOLS = [
  99.         'decimal_separator' => \NumberFormatter::DECIMAL_SEPARATOR_SYMBOL,
  100.         'grouping_separator' => \NumberFormatter::GROUPING_SEPARATOR_SYMBOL,
  101.         'pattern_separator' => \NumberFormatter::PATTERN_SEPARATOR_SYMBOL,
  102.         'percent' => \NumberFormatter::PERCENT_SYMBOL,
  103.         'zero_digit' => \NumberFormatter::ZERO_DIGIT_SYMBOL,
  104.         'digit' => \NumberFormatter::DIGIT_SYMBOL,
  105.         'minus_sign' => \NumberFormatter::MINUS_SIGN_SYMBOL,
  106.         'plus_sign' => \NumberFormatter::PLUS_SIGN_SYMBOL,
  107.         'currency' => \NumberFormatter::CURRENCY_SYMBOL,
  108.         'intl_currency' => \NumberFormatter::INTL_CURRENCY_SYMBOL,
  109.         'monetary_separator' => \NumberFormatter::MONETARY_SEPARATOR_SYMBOL,
  110.         'exponential' => \NumberFormatter::EXPONENTIAL_SYMBOL,
  111.         'permill' => \NumberFormatter::PERMILL_SYMBOL,
  112.         'pad_escape' => \NumberFormatter::PAD_ESCAPE_SYMBOL,
  113.         'infinity' => \NumberFormatter::INFINITY_SYMBOL,
  114.         'nan' => \NumberFormatter::NAN_SYMBOL,
  115.         'significant_digit' => \NumberFormatter::SIGNIFICANT_DIGIT_SYMBOL,
  116.         'monetary_grouping_separator' => \NumberFormatter::MONETARY_GROUPING_SEPARATOR_SYMBOL,
  117.     ];
  119.     private $dateFormatters = [];
  120.     private $numberFormatters = [];
  121.     private $dateFormatterPrototype;
  122.     private $numberFormatterPrototype;
  124.     public function __construct(\IntlDateFormatter $dateFormatterPrototype = null, \NumberFormatter $numberFormatterPrototype = null)
  125.     {
  126.         $this->dateFormatterPrototype = $dateFormatterPrototype;
  127.         $this->numberFormatterPrototype = $numberFormatterPrototype;
  128.     }
  130.     public function getFilters()
  131.     {
  132.         return [
  133.             // internationalized names
  134.             new TwigFilter('country_name', [$this, 'getCountryName']),
  135.             new TwigFilter('currency_name', [$this, 'getCurrencyName']),
  136.             new TwigFilter('currency_symbol', [$this, 'getCurrencySymbol']),
  137.             new TwigFilter('language_name', [$this, 'getLanguageName']),
  138.             new TwigFilter('locale_name', [$this, 'getLocaleName']),
  139.             new TwigFilter('timezone_name', [$this, 'getTimezoneName']),
  141.             // localized formatters
  142.             new TwigFilter('format_currency', [$this, 'formatCurrency']),
  143.             new TwigFilter('format_number', [$this, 'formatNumber']),
  144.             new TwigFilter('format_*_number', [$this, 'formatNumberStyle']),
  145.             new TwigFilter('format_datetime', [$this, 'formatDateTime'], ['needs_environment' => true]),
  146.             new TwigFilter('format_date', [$this, 'formatDate'], ['needs_environment' => true]),
  147.             new TwigFilter('format_time', [$this, 'formatTime'], ['needs_environment' => true]),
  148.         ];
  149.     }
  151.     public function getFunctions()
  152.     {
  153.         return [
  154.             // internationalized names
  155.             new TwigFunction('country_timezones', [$this, 'getCountryTimezones']),
  156.             new TwigFunction('language_names', [$this, 'getLanguageNames']),
  157.             new TwigFunction('script_names', [$this, 'getScriptNames']),
  158.             new TwigFunction('country_names', [$this, 'getCountryNames']),
  159.             new TwigFunction('locale_names', [$this, 'getLocaleNames']),
  160.             new TwigFunction('currency_names', [$this, 'getCurrencyNames']),
  161.             new TwigFunction('timezone_names', [$this, 'getTimezoneNames']),
  162.         ];
  163.     }
  165.     public function getCountryName(?string $country, string $locale = null): string
  166.     {
  167.         if (null === $country) {
  168.             return '';
  169.         }
  171.         try {
  172.             return Countries::getName($country, $locale);
  173.         } catch (MissingResourceException $exception) {
  174.             return $country;
  175.         }
  176.     }
  178.     public function getCurrencyName(?string $currency, string $locale = null): string
  179.     {
  180.         if (null === $currency) {
  181.             return '';
  182.         }
  184.         try {
  185.             return Currencies::getName($currency, $locale);
  186.         } catch (MissingResourceException $exception) {
  187.             return $currency;
  188.         }
  189.     }
  191.     public function getCurrencySymbol(?string $currency, string $locale = null): string
  192.     {
  193.         if (null === $currency) {
  194.             return '';
  195.         }
  197.         try {
  198.             return Currencies::getSymbol($currency, $locale);
  199.         } catch (MissingResourceException $exception) {
  200.             return $currency;
  201.         }
  202.     }
  204.     public function getLanguageName(?string $language, string $locale = null): string
  205.     {
  206.         if (null === $language) {
  207.             return '';
  208.         }
  210.         try {
  211.             return Languages::getName($language, $locale);
  212.         } catch (MissingResourceException $exception) {
  213.             return $language;
  214.         }
  215.     }
  217.     public function getLocaleName(?string $data, string $locale = null): string
  218.     {
  219.         if (null === $data) {
  220.             return '';
  221.         }
  223.         try {
  224.             return Locales::getName($data, $locale);
  225.         } catch (MissingResourceException $exception) {
  226.             return $data;
  227.         }
  228.     }
  230.     public function getTimezoneName(?string $timezone, string $locale = null): string
  231.     {
  232.         if (null === $timezone) {
  233.             return '';
  234.         }
  236.         try {
  237.             return Timezones::getName($timezone, $locale);
  238.         } catch (MissingResourceException $exception) {
  239.             return $timezone;
  240.         }
  241.     }
  243.     public function getCountryTimezones(string $country): array
  244.     {
  245.         try {
  246.             return Timezones::forCountryCode($country);
  247.         } catch (MissingResourceException $exception) {
  248.             return [];
  249.         }
  250.     }
  252.     public function getLanguageNames(string $locale = null): array
  253.     {
  254.         try {
  255.             return Languages::getNames($locale);
  256.         } catch (MissingResourceException $exception) {
  257.             return [];
  258.         }
  259.     }
  261.     public function getScriptNames(string $locale = null): array
  262.     {
  263.         try {
  264.             return Scripts::getNames($locale);
  265.         } catch (MissingResourceException $exception) {
  266.             return [];
  267.         }
  268.     }
  270.     public function getCountryNames(string $locale = null): array
  271.     {
  272.         try {
  273.             return Countries::getNames($locale);
  274.         } catch (MissingResourceException $exception) {
  275.             return [];
  276.         }
  277.     }
  279.     public function getLocaleNames(string $locale = null): array
  280.     {
  281.         try {
  282.             return Locales::getNames($locale);
  283.         } catch (MissingResourceException $exception) {
  284.             return [];
  285.         }
  286.     }
  288.     public function getCurrencyNames(string $locale = null): array
  289.     {
  290.         try {
  291.             return Currencies::getNames($locale);
  292.         } catch (MissingResourceException $exception) {
  293.             return [];
  294.         }
  295.     }
  297.     public function getTimezoneNames(string $locale = null): array
  298.     {
  299.         try {
  300.             return Timezones::getNames($locale);
  301.         } catch (MissingResourceException $exception) {
  302.             return [];
  303.         }
  304.     }
  306.     public function formatCurrency($amount, string $currency, array $attrs = [], string $locale = null): string
  307.     {
  308.         $formatter = $this->createNumberFormatter($locale, 'currency', $attrs);
  310.         if (false === $ret = $formatter->formatCurrency($amount, $currency)) {
  311.             throw new RuntimeError('Unable to format the given number as a currency.');
  312.         }
  314.         return $ret;
  315.     }
  317.     public function formatNumber($number, array $attrs = [], string $style = 'decimal', string $type = 'default', string $locale = null): string
  318.     {
  319.         if (!isset(self::NUMBER_TYPES[$type])) {
  320.             throw new RuntimeError(sprintf('The type "%s" does not exist, known types are: "%s".', $type, implode('", "', array_keys(self::NUMBER_TYPES))));
  321.         }
  323.         $formatter = $this->createNumberFormatter($locale, $style, $attrs);
  325.         if (false === $ret = $formatter->format($number, self::NUMBER_TYPES[$type])) {
  326.             throw new RuntimeError('Unable to format the given number.');
  327.         }
  329.         return $ret;
  330.     }
  332.     public function formatNumberStyle(string $style, $number, array $attrs = [], string $type = 'default', string $locale = null): string
  333.     {
  334.         return $this->formatNumber($number, $attrs, $style, $type, $locale);
  335.     }
  337.     /**
  338.      * @param \DateTimeInterface|string|null  $date     A date or null to use the current time
  339.      * @param \DateTimeZone|string|false|null $timezone The target timezone, null to use the default, false to leave unchanged
  340.      */
  341.     public function formatDateTime(Environment $env, $date, ?string $dateFormat = 'medium', ?string $timeFormat = 'medium', string $pattern = '', $timezone = null, string $calendar = 'gregorian', string $locale = null): string
  342.     {
  343.         $date = twig_date_converter($env, $date, $timezone);
  344.         $formatter = $this->createDateFormatter($locale, $dateFormat, $timeFormat, $pattern, $date->getTimezone(), $calendar);
  346.         if (false === $ret = $formatter->format($date)) {
  347.             throw new RuntimeError('Unable to format the given date.');
  348.         }
  350.         return $ret;
  351.     }
  353.     /**
  354.      * @param \DateTimeInterface|string|null  $date     A date or null to use the current time
  355.      * @param \DateTimeZone|string|false|null $timezone The target timezone, null to use the default, false to leave unchanged
  356.      */
  357.     public function formatDate(Environment $env, $date, ?string $dateFormat = 'medium', string $pattern = '', $timezone = null, string $calendar = 'gregorian', string $locale = null): string
  358.     {
  359.         return $this->formatDateTime($env, $date, $dateFormat, 'none', $pattern, $timezone, $calendar, $locale);
  360.     }
  362.     /**
  363.      * @param \DateTimeInterface|string|null  $date     A date or null to use the current time
  364.      * @param \DateTimeZone|string|false|null $timezone The target timezone, null to use the default, false to leave unchanged
  365.      */
  366.     public function formatTime(Environment $env, $date, ?string $timeFormat = 'medium', string $pattern = '', $timezone = null, string $calendar = 'gregorian', string $locale = null): string
  367.     {
  368.         return $this->formatDateTime($env, $date, 'none', $timeFormat, $pattern, $timezone, $calendar, $locale);
  369.     }
  371.     private function createDateFormatter(?string $locale, ?string $dateFormat, ?string $timeFormat, string $pattern, \DateTimeZone $timezone, string $calendar): \IntlDateFormatter
  372.     {
  373.         if (null !== $dateFormat && !isset(self::DATE_FORMATS[$dateFormat])) {
  374.             throw new RuntimeError(sprintf('The date format "%s" does not exist, known formats are: "%s".', $dateFormat, implode('", "', array_keys(self::DATE_FORMATS))));
  375.         }
  377.         if (null !== $timeFormat && !isset(self::DATE_FORMATS[$timeFormat])) {
  378.             throw new RuntimeError(sprintf('The time format "%s" does not exist, known formats are: "%s".', $timeFormat, implode('", "', array_keys(self::DATE_FORMATS))));
  379.         }
  381.         if (null === $locale) {
  382.             $locale = \Locale::getDefault();
  383.         }
  385.         $calendar = 'gregorian' === $calendar ? \IntlDateFormatter::GREGORIAN : \IntlDateFormatter::TRADITIONAL;
  387.         $dateFormatValue = self::DATE_FORMATS[$dateFormat] ?? null;
  388.         $timeFormatValue = self::DATE_FORMATS[$timeFormat] ?? null;
  390.         if ($this->dateFormatterPrototype) {
  391.             $dateFormatValue = $dateFormatValue ?: $this->dateFormatterPrototype->getDateType();
  392.             $timeFormatValue = $timeFormatValue ?: $this->dateFormatterPrototype->getTimeType();
  393.             $timezone = $timezone ?: $this->dateFormatterPrototype->getTimeType();
  394.             $calendar = $calendar ?: $this->dateFormatterPrototype->getCalendar();
  395.             $pattern = $pattern ?: $this->dateFormatterPrototype->getPattern();
  396.         }
  398.         $hash = $locale.'|'.$dateFormatValue.'|'.$timeFormatValue.'|'.$timezone->getName().'|'.$calendar.'|'.$pattern;
  400.         if (!isset($this->dateFormatters[$hash])) {
  401.             $this->dateFormatters[$hash] = new \IntlDateFormatter($locale, $dateFormatValue, $timeFormatValue, $timezone, $calendar, $pattern);
  402.         }
  404.         return $this->dateFormatters[$hash];
  405.     }
  407.     private function createNumberFormatter(?string $locale, string $style, array $attrs = []): \NumberFormatter
  408.     {
  409.         if (!isset(self::NUMBER_STYLES[$style])) {
  410.             throw new RuntimeError(sprintf('The style "%s" does not exist, known styles are: "%s".', $style, implode('", "', array_keys(self::NUMBER_STYLES))));
  411.         }
  413.         if (null === $locale) {
  414.             $locale = \Locale::getDefault();
  415.         }
  417.         // textAttrs and symbols can only be set on the prototype as there is probably no
  418.         // use case for setting it on each call.
  419.         $textAttrs = [];
  420.         $symbols = [];
  421.         if ($this->numberFormatterPrototype) {
  422.             foreach (self::NUMBER_ATTRIBUTES as $name => $const) {
  423.                 if (!isset($attrs[$name])) {
  424.                     $value = $this->numberFormatterPrototype->getAttribute($const);
  425.                     if ('rounding_mode' === $name) {
  426.                         $value = array_flip(self::NUMBER_ROUNDING_ATTRIBUTES)[$value];
  427.                     } elseif ('padding_position' === $name) {
  428.                         $value = array_flip(self::NUMBER_PADDING_ATTRIBUTES)[$value];
  429.                     }
  430.                     $attrs[$name] = $value;
  431.                 }
  432.             }
  434.             foreach (self::NUMBER_TEXT_ATTRIBUTES as $name => $const) {
  435.                 $textAttrs[$name] = $this->numberFormatterPrototype->getTextAttribute($const);
  436.             }
  438.             foreach (self::NUMBER_SYMBOLS as $name => $const) {
  439.                 $symbols[$name] = $this->numberFormatterPrototype->getSymbol($const);
  440.             }
  441.         }
  443.         ksort($attrs);
  444.         $hash = $locale.'|'.$style.'|'.json_encode($attrs).'|'.json_encode($textAttrs).'|'.json_encode($symbols);
  446.         if (!isset($this->numberFormatters[$hash])) {
  447.             $this->numberFormatters[$hash] = new \NumberFormatter($locale, self::NUMBER_STYLES[$style]);
  448.         }
  450.         foreach ($attrs as $name => $value) {
  451.             if (!isset(self::NUMBER_ATTRIBUTES[$name])) {
  452.                 throw new RuntimeError(sprintf('The number formatter attribute "%s" does not exist, known attributes are: "%s".', $name, implode('", "', array_keys(self::NUMBER_ATTRIBUTES))));
  453.             }
  455.             if ('rounding_mode' === $name) {
  456.                 if (!isset(self::NUMBER_ROUNDING_ATTRIBUTES[$value])) {
  457.                     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))));
  458.                 }
  460.                 $value = self::NUMBER_ROUNDING_ATTRIBUTES[$value];
  461.             } elseif ('padding_position' === $name) {
  462.                 if (!isset(self::NUMBER_PADDING_ATTRIBUTES[$value])) {
  463.                     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))));
  464.                 }
  466.                 $value = self::NUMBER_PADDING_ATTRIBUTES[$value];
  467.             }
  469.             $this->numberFormatters[$hash]->setAttribute(self::NUMBER_ATTRIBUTES[$name], $value);
  470.         }
  472.         foreach ($textAttrs as $name => $value) {
  473.             $this->numberFormatters[$hash]->setTextAttribute(self::NUMBER_TEXT_ATTRIBUTES[$name], $value);
  474.         }
  476.         foreach ($symbols as $name => $value) {
  477.             $this->numberFormatters[$hash]->setSymbol(self::NUMBER_SYMBOLS[$name], $value);
  478.         }
  480.         return $this->numberFormatters[$hash];
  481.     }
  482. }