Skip to content

Latest commit

 

History

History
240 lines (156 loc) · 5.15 KB

Numbers.md

File metadata and controls

240 lines (156 loc) · 5.15 KB
Raw

Numbers

This part covers number elements, number formatting, and currencies.

Unicode Reference

The documentation is divided into the following parts, mimicking Unicode's documentation:

  • Part 1: Core (languages, locales, basic structure)
  • Part 2: General (display names & transforms, etc.)
  • Part 3: Numbers (number & currency formatting)
  • Part 4: Dates (date, time, time zone formatting)
  • Part 5: Collation (sorting, searching, grouping)
  • Part 6: Supplemental (supplemental data)

Number Elements

Default Numbering System

This element indicates which numbering system should be used for presentation of numeric quantities in the given locale.

<?php

/**
 * @var \ICanBoogie\CLDR\Core\Locale $de
 */

echo $de->numbers->default_numbering_system;
// latn

Reference

Number Symbols

Number symbols define the localized symbols that are commonly used when formatting numbers in a given locale. They are represented by a Symbols entity. It's unlikely you'll have to use symbols as long as you're using localized formatters.

<?php

namespace ICanBoogie\CLDR;

/**
 * @var ICanBoogie\CLDR\Locale $en
 */

$en->numbers->symbols;

Reference

Number formatting

You can format a number with a given pattern using the format_number() function of the repository:

<?php

/**
 * @var ICanBoogie\CLDR\Repository $repository
 */

echo $repository->format_number(4123.37, "#,#00.#0");
// 4,123.37
echo $repository->format_number(.3789, "#0.#0 %");
// 37.89 %

Alternatively, you format a number using a NumberFormatter instance:

<?php

use ICanBoogie\CLDR\Numbers\NumberFormatter;

/**
 * @var ICanBoogie\CLDR\Repository $repository
 */

$number_formatter = $repository->number_formatter
# or
$number_formatter = new NumberFormatter();

echo $number_formatter->format(4123.37, "#,#00.#0");
// 4,123.37
echo $number_formatter->format(.3789, "#0.#0 %");
// 37.89 %

Localized number formatting

Use the format_number() method of a Locale to format a number using its conventions.

<?php

/**
 * @var ICanBoogie\CLDR\Repository $repository
 * @var \ICanBoogie\CLDR\Core\Locale $en
 * @var \ICanBoogie\CLDR\Core\Locale $fr
 */

echo $en->format_number(123456.78)
// 123,456.78

echo $fr->format_number(123456.78)
// 123 456,78

Alternatively, you can use a LocalizedNumberFormatter instance:

<?php

/**
 * @var \ICanBoogie\CLDR\Core\Locale $en
 * @var \ICanBoogie\CLDR\Core\Locale $fr
 */

$localized_formatter = $en->number_formatter;
echo $localized_formatter->format(123456.78);
// 123,456.78

$localized_formatter = $fr->number_formatter;
echo $localized_formatter->format(123456.78);
// 123 456,78

Currencies

<?php

use ICanBoogie\CLDR\Numbers\Currency;

/**
 * @var ICanBoogie\CLDR\Repository $cldr
 * @var \ICanBoogie\CLDR\Supplemental\Territory\Territory $territory
 * @var \ICanBoogie\CLDR\Core\Locale $locale
 */

$currency_code = 'EUR';

# You can get a currency with its code
$currency = Currency::of($currency_code);

# You can get the main currency from a territory
$currency = $territory->currency;

# You can localize a currency to get its local name, symbol, or format a number
$localized_currency = $currency->localized($locale);

echo $localized_currency->name;
// euro
echo $localized_currency->name_for(10);
// euros
echo $localized_currency->symbol;
// €
echo $localized_currency->format(12345.67);
// 12 345,67 €

# You can also format a currency directly from a locale
echo $locale->format_currency(12345.67, $currency_code);
// 12 345,67 €

Reference

Language Plural Rules

Languages have different pluralization rules for numbers that represent zero, one, tow, few, many or other. ICanBoogie's CLDR makes it easy to find the plural rules for any numeric value:

<?php

/**
 * @var ICanBoogie\CLDR\Repository $cldr
 */

$cldr->plurals->rules_for('fr'); // [ 'one', 'other' ]
$cldr->plurals->rules_for('ar'); // [ 'zero', 'one', 'two', 'few', 'many', 'other' ]

$cldr->plurals->rule_for(1.5, 'fr'); // one
$cldr->plurals->rule_for(2, 'fr');   // other
$cldr->plurals->rule_for(2, 'ar');   // two

Reference