ICanBoogie/CLDR v1.5.0
  • Namespace
  • Class

Namespaces

  • ICanBoogie
    • CLDR

Classes

  • Calendar
  • CalendarCollection
  • Currency
  • CurrencyCollection
  • CurrencyFormatter
  • DateFormatter
  • DateTimeFormatter
  • FileProvider
  • ListFormatter
  • Locale
  • LocaleCollection
  • LocalizedCurrency
  • LocalizedDateTime
  • LocalizedListFormatter
  • LocalizedLocale
  • LocalizedNumberFormatter
  • LocalizedObject
  • LocalizedObjectWithFormatter
  • LocalizedTerritory
  • NumberFormatter
  • NumberPattern
  • NumberPatternParser
  • Numbers
  • ProviderCollection
  • RedisProvider
  • Repository
  • RunTimeProvider
  • Supplemental
  • Territory
  • TerritoryCollection
  • TimeFormatter
  • WebProvider

Interfaces

  • Exception
  • Formatter
  • LocalizeAwareInterface
  • Provider

Traits

  • CodePropertyTrait
  • CollectionTrait
  • LocalePropertyTrait
  • ProviderStorageBinding
  • RepositoryPropertyTrait

Exceptions

  • ResourceNotFound
  • TerritoryNotDefined
  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 
<?php

/*
 * This file is part of the ICanBoogie package.
 *
 * (c) Olivier Laviale <olivier.laviale@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ICanBoogie\CLDR;

use ICanBoogie\Accessor\AccessorTrait;

/**
 * Formats numbers.
 */
class NumberFormatter implements Formatter
{
    use AccessorTrait;
    use RepositoryPropertyTrait;

    static private $default_symbols = [

        'decimal' => ".",
        'group' => ",",
        'percentSign' => "%",
        'plusSign' => "+",
        'minusSign' => "-",
        'perMille' => "‰"

    ];

    /**
     * Returns the precision of a number.
     *
     * @param number $number
     *
     * @return int
     */
    static public function precision_from($number)
    {
        $number = (string) $number;
        $pos = strrpos($number, '.');

        if (!$pos)
        {
            return 0;
        }

        return strlen($number) - $pos - 1;
    }

    /**
     * Returns a number rounded to the specified precision.
     *
     * @param number $number
     * @param int $precision
     *
     * @return float
     */
    static public function round_to($number, $precision)
    {
        return round($number, $precision);
    }

    /**
     * Parses a number.
     *
     * @param number $number
     * @param null|int $precision
     *
     * @return array
     */
    static public function parse_number($number, $precision=null)
    {
        if ($precision === null)
        {
            $precision = self::precision_from($number);
        }

        $number = self::round_to($number, $precision);
        $number = abs($number);
        $number = number_format($number, $precision, '.', '');

        return explode('.', (string) $number);
    }

    /**
     * @param Repository $repository
     */
    public function __construct(Repository $repository=null)
    {
        $this->repository = $repository;
    }

    /**
     * Format a number with the specified pattern.
     *
     * Note, if the pattern contains '%', the number will be multiplied by 100 first. If the
     * pattern contains '‰', the number will be multiplied by 1000.
     *
     * @param mixed $number The number to be formatted.
     * @param string $pattern The pattern used to format the number.
     * @param array $symbols Symbols.
     *
     * @return string The formatted number.
     */
    public function __invoke($number, $pattern, array $symbols = [])
    {
        return $this->format($number, $pattern, $symbols);
    }

    /**
     * Format a number with the specified pattern.
     *
     * Note, if the pattern contains '%', the number will be multiplied by 100 first. If the
     * pattern contains '‰', the number will be multiplied by 1000.
     *
     * @param mixed $number The number to be formatted.
     * @param string $pattern The pattern used to format the number.
     * @param array $symbols Symbols.
     *
     * @return string The formatted number.
     */
    public function format($number, $pattern, array $symbols = [])
    {
        if (!($pattern instanceof NumberPattern))
        {
            $pattern = NumberPattern::from($pattern);
        }

        $symbols += self::$default_symbols;

        list($integer, $decimal) = $pattern->parse_number($number);

        $formatted_integer = $pattern->format_integer_with_group($integer, $symbols['group']);
        $formatted_number = $pattern->format_integer_with_decimal($formatted_integer, $decimal, $symbols['decimal']);

        if ($number < 0)
        {
            $number = $pattern->negative_prefix . $formatted_number . $pattern->negative_suffix;
        }
        else
        {
            $number = $pattern->positive_prefix . $formatted_number . $pattern->positive_suffix;
        }

        return strtr($number, [

            '%' => $symbols['percentSign'],
            '‰' => $symbols['perMille']

        ]);
    }

    /**
     * Localize the instance.
     *
     * @param string $locale_code
     *
     * @return LocalizedNumberFormatter
     *
     * @throw \LogicException when the instance was created without a repository.
     */
    public function localize($locale_code)
    {
        if (!$this->repository)
        {
            throw new \LogicException("The instance was created without a repository.");
        }

        return $this->repository->locales[$locale_code]->localize($this);
    }
}
ICanBoogie/CLDR v1.5.0 API documentation generated by ApiGen