1. class
  2. Illuminate
  3. \
  4. Support
  5. \
  6. Number

Number

class Number (View source)

Traits

Macroable

Properties

static protected array $macros

The registered string macros.

 from  Macroable
static protected string $locale

The current default locale.
static protected string $currency

The current default currency.

Methods

static void
macro(string $name, object|callable $macro)

Register a custom macro.

from  Macroable
static void
mixin(object $mixin, bool $replace = true)

Mix another object into the class.

from  Macroable
static bool
hasMacro(string $name)

Checks if macro is registered.

from  Macroable
static void
flushMacros()

Flush the existing macros.

from  Macroable
static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
mixed
__call(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
static string|false
format(int|float $number, int|null $precision = null, int|null $maxPrecision = null, string|null $locale = null)

Format the given number according to the current locale.

static string
spell(int|float $number, string|null $locale = null, int|null $after = null, int|null $until = null)

Spell out the given number in the given locale.

static string
ordinal(int|float $number, string|null $locale = null)

Convert the given number to ordinal form.

static string
spellOrdinal(int|float $number, string|null $locale = null)

Spell out the given number in the given locale in ordinal form.

static string|false
percentage(int|float $number, int $precision = 0, int|null $maxPrecision = null, string|null $locale = null)

Convert the given number to its percentage equivalent.

static string|false
currency(int|float $number, string $in = '', string|null $locale = null, int|null $precision = null)

Convert the given number to its currency equivalent.

static string
fileSize(int|float $bytes, int $precision = 0, int|null $maxPrecision = null)

Convert the given number to its file size equivalent.

static bool|string
abbreviate(int|float $number, int $precision = 0, int|null $maxPrecision = null)

Convert the number to its human-readable equivalent.

static false|string
forHumans(int|float $number, int $precision = 0, int|null $maxPrecision = null, bool $abbreviate = false)

Convert the number to its human-readable equivalent.

static string|false
summarize(int|float $number, int $precision = 0, int|null $maxPrecision = null, array $units = [])

Convert the number to its human-readable equivalent.

static int|float
clamp(int|float $number, int|float $min, int|float $max)

Clamp the given number between the given minimum and maximum.

static array
pairs(int|float $to, int|float $by, int|float $start = 0, int|float $offset = 1)

Split the given number into pairs of min/max values.

static int|float
trim(int|float $number)

Remove any trailing zero digits after the decimal point of the given number.

static mixed
withLocale(string $locale, callable $callback)

Execute the given callback using the given locale.

static mixed
withCurrency(string $currency, callable $callback)

Execute the given callback using the given currency.

static void
useLocale(string $locale)

Set the default locale.

static void
useCurrency(string $currency)

Set the default currency.

static string
defaultLocale()

Get the default locale.

static string
defaultCurrency()

Get the default currency.

static void
ensureIntlExtensionIsInstalled()

Ensure the "intl" PHP extension is installed.

Details

in Macroable at line 29
static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

in Macroable at line 43
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

in Macroable at line 62
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 72
static void flushMacros()

Flush the existing macros.

Return Value

void

in Macroable at line 86
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line 112
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line 36
static string|false format(int|float $number, int|null $precision = null, int|null $maxPrecision = null, string|null $locale = null)

Format the given number according to the current locale.

Parameters

int|float $number
int|null $precision
int|null $maxPrecision
string|null $locale

Return Value

string|false

at line 60
static string spell(int|float $number, string|null $locale = null, int|null $after = null, int|null $until = null)

Spell out the given number in the given locale.

Parameters

int|float $number
string|null $locale
int|null $after
int|null $until

Return Value

string

at line 84
static string ordinal(int|float $number, string|null $locale = null)

Convert the given number to ordinal form.

Parameters

int|float $number
string|null $locale

Return Value

string

at line 100
static string spellOrdinal(int|float $number, string|null $locale = null)

Spell out the given number in the given locale in ordinal form.

Parameters

int|float $number
string|null $locale

Return Value

string

at line 120
static string|false percentage(int|float $number, int $precision = 0, int|null $maxPrecision = null, string|null $locale = null)

Convert the given number to its percentage equivalent.

Parameters

int|float $number
int $precision
int|null $maxPrecision
string|null $locale

Return Value

string|false

at line 144
static string|false currency(int|float $number, string $in = '', string|null $locale = null, int|null $precision = null)

Convert the given number to its currency equivalent.

Parameters

int|float $number
string $in
string|null $locale
int|null $precision

Return Value

string|false

at line 165
static string fileSize(int|float $bytes, int $precision = 0, int|null $maxPrecision = null)

Convert the given number to its file size equivalent.

Parameters

int|float $bytes
int $precision
int|null $maxPrecision

Return Value

string

at line 184
static bool|string abbreviate(int|float $number, int $precision = 0, int|null $maxPrecision = null)

Convert the number to its human-readable equivalent.

Parameters

int|float $number
int $precision
int|null $maxPrecision

Return Value

bool|string

at line 198
static false|string forHumans(int|float $number, int $precision = 0, int|null $maxPrecision = null, bool $abbreviate = false)

Convert the number to its human-readable equivalent.

Parameters

int|float $number
int $precision
int|null $maxPrecision
bool $abbreviate

Return Value

false|string

at line 224
static protected string|false summarize(int|float $number, int $precision = 0, int|null $maxPrecision = null, array $units = [])

Convert the number to its human-readable equivalent.

Parameters

int|float $number
int $precision
int|null $maxPrecision
array $units

Return Value

string|false

at line 260
static int|float clamp(int|float $number, int|float $min, int|float $max)

Clamp the given number between the given minimum and maximum.

Parameters

int|float $number
int|float $min
int|float $max

Return Value

int|float

at line 274
static array pairs(int|float $to, int|float $by, int|float $start = 0, int|float $offset = 1)

Split the given number into pairs of min/max values.

Parameters

int|float $to
int|float $by
int|float $start
int|float $offset

Return Value

array

at line 297
static int|float trim(int|float $number)

Remove any trailing zero digits after the decimal point of the given number.

Parameters

int|float $number

Return Value

int|float

at line 309
static mixed withLocale(string $locale, callable $callback)

Execute the given callback using the given locale.

Parameters

string $locale
callable $callback

Return Value

mixed

at line 325
static mixed withCurrency(string $currency, callable $callback)

Execute the given callback using the given currency.

Parameters

string $currency
callable $callback

Return Value

mixed

at line 340
static void useLocale(string $locale)

Set the default locale.

Parameters

string $locale

Return Value

void

at line 351
static void useCurrency(string $currency)

Set the default currency.

Parameters

string $currency

Return Value

void

at line 361
static string defaultLocale()

Get the default locale.

Return Value

string

at line 371
static string defaultCurrency()

Get the default currency.

Return Value

string

at line 381
static protected void ensureIntlExtensionIsInstalled()

Ensure the "intl" PHP extension is installed.

Return Value

void