1. class
  2. Cable8mm
  3. \
  4. NFormat
  5. \
  6. NFormat

NFormat

class NFormat extends NumberFormatter (View source)

Number formatter for not following rules like Korean and Japanese.

Constants

private ORDINAL_DRIVER_PATH

Drivers path for the ordinals.
private CURRENCY_DRIVER_PATH

Properties

static $locale

Default locale name.
static $currency

Default ISO 4217 code aka currency code.

Methods

static string
spellOut(int $number)

Wrapper for NumberFormatter::format($locale, NumberFormatter::SPELLOUT).

static string
ordinalSpellOut(int $number)

Spell out ordinals for specific regions.

static string
currency(int|float|null $number, string $zero = '0')

Wrapper for NumberFormatter::format($locale, NumberFormatter::CURRENCY).

static string
currencySpellOut(int $number)

Spell out currency ordinals for specific regions.

static string
percent(int $number)

Wrapper for NumberFormatter::format($locale, NumberFormatter::PERCENT_SYMBOL).

static string
rawPercent(int $number)

Wrapper for NumberFormatter::format($locale, NumberFormatter::PERCENT_SYMBOL).

static string
decimal(int|float|null $number, string $zero = '0')

Wrapper for NumberFormatter::format($locale, NumberFormatter::DECIMAL).

static string|false
price(int|float $number, int|null $roundDigits = null)

Get the rounded price of a number

static string|false
smartPrice(int|float $number)

Get the smart price of a number for shopping cart

Details

at line 40
static string spellOut(int $number)

Wrapper for NumberFormatter::format($locale, NumberFormatter::SPELLOUT).

Parameters

int $number

Number not to be formatted.

Return Value

string

Formatted number

Examples

NFormat::spellOut(5) => 오

at line 56
static string ordinalSpellOut(int $number)

Spell out ordinals for specific regions.

Parameters

int $number

Number not to be formatted.

Return Value

string

Spell out ordinal.

Examples

NFormat::spellOut(10) => 열번째

at line 77
static string currency(int|float|null $number, string $zero = '0')

Wrapper for NumberFormatter::format($locale, NumberFormatter::CURRENCY).

Parameters

int|float|null $number

Number not to be formatted
string $zero

If $number is 0, $zero will be returned.

Return Value

string

Examples

NFormat::currency(358762) => ₩358,762

at line 97
static string currencySpellOut(int $number)

Spell out currency ordinals for specific regions.

Parameters

int $number

Number not to be formatted.

Return Value

string

Spell out currency ordinal.

Examples

NFormat::spellOut(12346) => 12,346원

at line 129
static string percent(int $number)

Wrapper for NumberFormatter::format($locale, NumberFormatter::PERCENT_SYMBOL).

Parameters

int $number

Number not to be formatted

Return Value

string

Examples

NFormat::percent(12346) => 1,234,600%

at line 144
static string rawPercent(int $number)

Wrapper for NumberFormatter::format($locale, NumberFormatter::PERCENT_SYMBOL).

Parameters

int $number

Number not to be formatted

Return Value

string

Examples

NFormat::percent(12346) => 12,346%

at line 160
static string decimal(int|float|null $number, string $zero = '0')

Wrapper for NumberFormatter::format($locale, NumberFormatter::DECIMAL).

Parameters

int|float|null $number

Number not to be formatted
string $zero

If $number is 0, $zero will be returned.

Return Value

string

Examples

NFormat::decimal(358762) => 358,762

at line 183
static string|false price(int|float $number, int|null $roundDigits = null)

Get the rounded price of a number

Parameters

int|float $number

The price
int|null $roundDigits

The digits of rounding number

Return Value

string|false

The method returns rounded number or false

Examples

NFormat::price(12346, -2) => 12300
 
NFormat::price(12346.0) => 12346.00
 
NFormat::price(12346.23123, -2) => 12300.00

at line 206
static string|false smartPrice(int|float $number)

Get the smart price of a number for shopping cart

Parameters

int|float $number

The price

Return Value

string|false

The method returns smart rounded number or false

Examples

NFormat::smartPrice(12346) => 12300
 
NFormat::smartPrice(1234678) => 1230000
 
NFormat::smartPrice(3212343232) => 3212340000