vendor/easycorp/easyadmin-bundle/src/Intl/IntlFormatter.php line 123

  1. <?php
  3. namespace EasyCorp\Bundle\EasyAdminBundle\Intl;
  5. use Twig\Error\RuntimeError;
  7. /**
  8.  * Copied from https://github.com/twigphp/intl-extra/blob/2.x/src/IntlExtension.php
  9.  * (c) Fabien Potencier - MIT License.
  10.  *
  11.  * @author Fabien Potencier <fabien@symfony.com>
  12.  */
  13. final class IntlFormatter
  14. {
  15.     private const DATE_FORMATS = [
  16.         'none' => \IntlDateFormatter::NONE,
  17.         'short' => \IntlDateFormatter::SHORT,
  18.         'medium' => \IntlDateFormatter::MEDIUM,
  19.         'long' => \IntlDateFormatter::LONG,
  20.         'full' => \IntlDateFormatter::FULL,
  21.     ];
  22.     private const NUMBER_TYPES = [
  23.         'default' => \NumberFormatter::TYPE_DEFAULT,
  24.         'int32' => \NumberFormatter::TYPE_INT32,
  25.         'int64' => \NumberFormatter::TYPE_INT64,
  26.         'double' => \NumberFormatter::TYPE_DOUBLE,
  27.         'currency' => \NumberFormatter::TYPE_CURRENCY,
  28.     ];
  29.     private const NUMBER_STYLES = [
  30.         'decimal' => \NumberFormatter::DECIMAL,
  31.         'currency' => \NumberFormatter::CURRENCY,
  32.         'percent' => \NumberFormatter::PERCENT,
  33.         'scientific' => \NumberFormatter::SCIENTIFIC,
  34.         'spellout' => \NumberFormatter::SPELLOUT,
  35.         'ordinal' => \NumberFormatter::ORDINAL,
  36.         'duration' => \NumberFormatter::DURATION,
  37.     ];
  38.     private const NUMBER_ATTRIBUTES = [
  39.         'grouping_used' => \NumberFormatter::GROUPING_USED,
  40.         'decimal_always_shown' => \NumberFormatter::DECIMAL_ALWAYS_SHOWN,
  41.         'max_integer_digit' => \NumberFormatter::MAX_INTEGER_DIGITS,
  42.         'min_integer_digit' => \NumberFormatter::MIN_INTEGER_DIGITS,
  43.         'integer_digit' => \NumberFormatter::INTEGER_DIGITS,
  44.         'max_fraction_digit' => \NumberFormatter::MAX_FRACTION_DIGITS,
  45.         'min_fraction_digit' => \NumberFormatter::MIN_FRACTION_DIGITS,
  46.         'fraction_digit' => \NumberFormatter::FRACTION_DIGITS,
  47.         'multiplier' => \NumberFormatter::MULTIPLIER,
  48.         'grouping_size' => \NumberFormatter::GROUPING_SIZE,
  49.         'rounding_mode' => \NumberFormatter::ROUNDING_MODE,
  50.         'rounding_increment' => \NumberFormatter::ROUNDING_INCREMENT,
  51.         'format_width' => \NumberFormatter::FORMAT_WIDTH,
  52.         'padding_position' => \NumberFormatter::PADDING_POSITION,
  53.         'secondary_grouping_size' => \NumberFormatter::SECONDARY_GROUPING_SIZE,
  54.         'significant_digits_used' => \NumberFormatter::SIGNIFICANT_DIGITS_USED,
  55.         'min_significant_digits_used' => \NumberFormatter::MIN_SIGNIFICANT_DIGITS,
  56.         'max_significant_digits_used' => \NumberFormatter::MAX_SIGNIFICANT_DIGITS,
  57.         'lenient_parse' => \NumberFormatter::LENIENT_PARSE,
  58.     ];
  59.     private const NUMBER_ROUNDING_ATTRIBUTES = [
  60.         'ceiling' => \NumberFormatter::ROUND_CEILING,
  61.         'floor' => \NumberFormatter::ROUND_FLOOR,
  62.         'down' => \NumberFormatter::ROUND_DOWN,
  63.         'up' => \NumberFormatter::ROUND_UP,
  64.         'halfeven' => \NumberFormatter::ROUND_HALFEVEN,
  65.         'halfdown' => \NumberFormatter::ROUND_HALFDOWN,
  66.         'halfup' => \NumberFormatter::ROUND_HALFUP,
  67.     ];
  68.     private const NUMBER_PADDING_ATTRIBUTES = [
  69.         'before_prefix' => \NumberFormatter::PAD_BEFORE_PREFIX,
  70.         'after_prefix' => \NumberFormatter::PAD_AFTER_PREFIX,
  71.         'before_suffix' => \NumberFormatter::PAD_BEFORE_SUFFIX,
  72.         'after_suffix' => \NumberFormatter::PAD_AFTER_SUFFIX,
  73.     ];
  75.     private array $dateFormatters = [];
  76.     private array $numberFormatters = [];
  78.     public function formatCurrency($amount, string $currency, array $attrs = [], string $locale = null): string
  79.     {
  80.         $formatter = $this->createNumberFormatter($locale, 'currency', $attrs);
  81.         /** @var string|false $formattedCurrency */
  82.         $formattedCurrency = $formatter->formatCurrency($amount, $currency);
  83.         if (false === $formattedCurrency) {
  84.             throw new RuntimeError('Unable to format the given number as a currency.');
  85.         }
  87.         return $formattedCurrency;
  88.     }
  90.     public function formatNumber($number, array $attrs = [], string $style = 'decimal', string $type = 'default', string $locale = null): string
  91.     {
  92.         if (!isset(self::NUMBER_TYPES[$type])) {
  93.             throw new RuntimeError(sprintf('The type "%s" does not exist, known types are: "%s".', $type, implode('", "', array_keys(self::NUMBER_TYPES))));
  94.         }
  96.         $formatter = $this->createNumberFormatter($locale, $style, $attrs);
  98.         if (false === $ret = $formatter->format($number, self::NUMBER_TYPES[$type])) {
  99.             throw new RuntimeError('Unable to format the given number.');
  100.         }
  102.         return $ret;
  103.     }
  105.     /**
  106.      * @param \DateTimeZone|string|false|null $timezone The target timezone, null to use the default, false to leave unchanged
  107.      */
  108.     public function formatDateTime(?\DateTimeInterface $date, ?string $dateFormat = 'medium', ?string $timeFormat = 'medium', string $pattern = '', $timezone = null, string $calendar = 'gregorian', string $locale = null): ?string
  109.     {
  110.         if (null === $date = $this->convertDate($date, $timezone)) {
  111.             return null;
  112.         }
  114.         $formatter = $this->createDateFormatter($locale, $dateFormat, $timeFormat, $pattern, $date->getTimezone(), $calendar);
  115.         $formattedDateTime = $formatter->format($date);
  117.         return false !== $formattedDateTime ? $formattedDateTime : null;
  118.     }
  120.     /**
  121.      * @param \DateTimeZone|string|false|null $timezone The target timezone, null to use the default, false to leave unchanged
  122.      */
  123.     public function formatDate(?\DateTimeInterface $date, ?string $dateFormat = 'medium', string $pattern = '', $timezone = null, string $calendar = 'gregorian', string $locale = null): ?string
  124.     {
  125.         return $this->formatDateTime($date, $dateFormat, 'none', $pattern, $timezone, $calendar, $locale);
  126.     }
  128.     /**
  129.      * @param \DateTimeZone|string|false|null $timezone The target timezone, null to use the default, false to leave unchanged
  130.      */
  131.     public function formatTime(?\DateTimeInterface $date, ?string $timeFormat = 'medium', string $pattern = '', $timezone = null, string $calendar = 'gregorian', string $locale = null): ?string
  132.     {
  133.         return $this->formatDateTime($date, 'none', $timeFormat, $pattern, $timezone, $calendar, $locale);
  134.     }
  136.     private function createDateFormatter(?string $locale, ?string $dateFormat, ?string $timeFormat, string $pattern = '', \DateTimeZone $timezone = null, string $calendarName = 'gregorian'): \IntlDateFormatter
  137.     {
  138.         if (null !== $dateFormat && !isset(self::DATE_FORMATS[$dateFormat])) {
  139.             throw new RuntimeError(sprintf('The date format "%s" does not exist, known formats are: "%s".', $dateFormat, implode('", "', array_keys(self::DATE_FORMATS))));
  140.         }
  142.         if (null !== $timeFormat && !isset(self::DATE_FORMATS[$timeFormat])) {
  143.             throw new RuntimeError(sprintf('The time format "%s" does not exist, known formats are: "%s".', $timeFormat, implode('", "', array_keys(self::DATE_FORMATS))));
  144.         }
  146.         if (null === $locale) {
  147.             $locale = \Locale::getDefault();
  148.         }
  150.         $calendar = 'gregorian' === $calendarName ? \IntlDateFormatter::GREGORIAN : \IntlDateFormatter::TRADITIONAL;
  152.         $dateFormatValue = self::DATE_FORMATS[$dateFormat] ?? self::DATE_FORMATS['full'];
  153.         $timeFormatValue = self::DATE_FORMATS[$timeFormat] ?? self::DATE_FORMATS['full'];
  155.         $hash = $locale.'|'.$dateFormatValue.'|'.$timeFormatValue.'|'.$timezone->getName().'|'.$calendar.'|'.$pattern;
  157.         if (!isset($this->dateFormatters[$hash])) {
  158.             $this->dateFormatters[$hash] = new \IntlDateFormatter($locale, $dateFormatValue, $timeFormatValue, $timezone, $calendar, $pattern);
  159.         }
  161.         return $this->dateFormatters[$hash];
  162.     }
  164.     private function createNumberFormatter(?string $locale, string $style, array $attrs = []): \NumberFormatter
  165.     {
  166.         if (!isset(self::NUMBER_STYLES[$style])) {
  167.             throw new RuntimeError(sprintf('The style "%s" does not exist, known styles are: "%s".', $style, implode('", "', array_keys(self::NUMBER_STYLES))));
  168.         }
  170.         if (null === $locale) {
  171.             $locale = \Locale::getDefault();
  172.         }
  174.         ksort($attrs);
  175.         $hash = sprintf('%s|%s|%s', $locale, $style, json_encode($attrs, \JSON_THROW_ON_ERROR));
  177.         if (!isset($this->numberFormatters[$hash])) {
  178.             $this->numberFormatters[$hash] = new \NumberFormatter($locale, self::NUMBER_STYLES[$style]);
  179.         }
  181.         foreach ($attrs as $name => $value) {
  182.             if (!isset(self::NUMBER_ATTRIBUTES[$name])) {
  183.                 throw new RuntimeError(sprintf('The number formatter attribute "%s" does not exist, known attributes are: "%s".', $name, implode('", "', array_keys(self::NUMBER_ATTRIBUTES))));
  184.             }
  186.             if ('rounding_mode' === $name) {
  187.                 if (!isset(self::NUMBER_ROUNDING_ATTRIBUTES[$value])) {
  188.                     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))));
  189.                 }
  191.                 $value = self::NUMBER_ROUNDING_ATTRIBUTES[$value];
  192.             } elseif ('padding_position' === $name) {
  193.                 if (!isset(self::NUMBER_PADDING_ATTRIBUTES[$value])) {
  194.                     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))));
  195.                 }
  197.                 $value = self::NUMBER_PADDING_ATTRIBUTES[$value];
  198.             }
  200.             $this->numberFormatters[$hash]->setAttribute(self::NUMBER_ATTRIBUTES[$name], $value);
  201.         }
  203.         return $this->numberFormatters[$hash];
  204.     }
  206.     private function convertDate(?\DateTimeInterface $date, $timezone = null): ?\DateTimeInterface
  207.     {
  208.         if (null === $date) {
  209.             return null;
  210.         }
  212.         if (null === $timezone) {
  213.             $timezone = new \DateTimeZone(date_default_timezone_get());
  214.         } elseif (!$timezone instanceof \DateTimeZone) {
  215.             $timezone = new \DateTimeZone($timezone);
  216.         }
  218.         if ($date instanceof \DateTimeImmutable) {
  219.             return $date->setTimezone($timezone);
  220.         }
  222.         $date = clone $date;
  223.         $date->setTimezone($timezone);
  225.         return $date;
  226.     }
  227. }