Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[10.x] Add support for Number::summarize #49197

Merged
merged 11 commits into from
Nov 30, 2023
Merged

[10.x] Add support for Number::summarize #49197

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
0988f28
Add Number::summarize
jcsoriano Nov 30, 2023
3a57da8
Update comment
jcsoriano Nov 30, 2023
e5f2f22
Make units configurable
jcsoriano Nov 30, 2023
63296cb
Make end unit dynamic
jcsoriano Nov 30, 2023
edfe1e7
Remove named arguments to be consistent with other method calls
jcsoriano Nov 30, 2023
abbb9e8
CS fix
jcsoriano Nov 30, 2023
b310ffe
Fix tests
jcsoriano Nov 30, 2023
77d5d94
Fix tests
jcsoriano Nov 30, 2023
03f870d
Fix tests
jcsoriano Nov 30, 2023
9494d9a
formatting
taylorotwell Nov 30, 2023
918bc90
format
taylorotwell Nov 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 52 additions & 11 deletions src/Illuminate/Support/Number.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,30 +141,71 @@ public static function fileSize(int|float $bytes, int $precision = 0, ?int $maxP
* @param int|null $maxPrecision
* @return string
*/
public static function forHumans(int|float $number, int $precision = 0, ?int $maxPrecision = null)
public static function abbreviate(int|float $number, int $precision = 0, ?int $maxPrecision = null)
{
$units = [
3 => 'thousand',
6 => 'million',
9 => 'billion',
12 => 'trillion',
15 => 'quadrillion',
];
return static::forHumans($number, $precision, $maxPrecision, abbreviate: true);
}

/**
* Convert the number to its human readable equivalent.
*
* @param int $number
* @param int $precision
* @param int|null $maxPrecision
* @return string
*/
public static function forHumans(int|float $number, int $precision = 0, ?int $maxPrecision = null, bool $abbreviate = false)
{
return static::summarize($number, $precision, $maxPrecision, $abbreviate ? [
3 => 'K',
6 => 'M',
9 => 'B',
12 => 'T',
15 => 'Q',
] : [
3 => ' thousand',
6 => ' million',
9 => ' billion',
12 => ' trillion',
15 => ' quadrillion',
]);
}

/**
* Convert the number to its human readable equivalent.
*
* @param int $number
* @param int $precision
* @param int|null $maxPrecision
* @param array $units
* @return string
*/
protected static function summarize(int|float $number, int $precision = 0, ?int $maxPrecision = null, array $units = [])
{
if (empty($units)) {
$units = [
3 => 'K',
6 => 'M',
9 => 'B',
12 => 'T',
15 => 'Q',
];
}

switch (true) {
case $number === 0:
return '0';
case $number < 0:
return sprintf('-%s', static::forHumans(abs($number), $precision, $maxPrecision));
return sprintf('-%s', static::summarize(abs($number), $precision, $maxPrecision, $units));
case $number >= 1e15:
return sprintf('%s quadrillion', static::forHumans($number / 1e15, $precision, $maxPrecision));
return sprintf('%s'.end($units), static::summarize($number / 1e15, $precision, $maxPrecision, $units));
}

$numberExponent = floor(log10($number));
$displayExponent = $numberExponent - ($numberExponent % 3);
$number /= pow(10, $displayExponent);

return trim(sprintf('%s %s', static::format($number, $precision, $maxPrecision), $units[$displayExponent] ?? ''));
return trim(sprintf('%s%s', static::format($number, $precision, $maxPrecision), $units[$displayExponent] ?? ''));
}

/**
Expand Down
53 changes: 53 additions & 0 deletions tests/Support/SupportNumberTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,59 @@ public function testToHuman()
$this->assertSame('-1 thousand quadrillion', Number::forHumans(-1000000000000000000));
}

public function testSummarize()
{
$this->assertSame('1', Number::abbreviate(1));
$this->assertSame('1.00', Number::abbreviate(1, precision: 2));
$this->assertSame('10', Number::abbreviate(10));
$this->assertSame('100', Number::abbreviate(100));
$this->assertSame('1K', Number::abbreviate(1000));
$this->assertSame('1.00K', Number::abbreviate(1000, precision: 2));
$this->assertSame('1K', Number::abbreviate(1000, maxPrecision: 2));
$this->assertSame('1K', Number::abbreviate(1230));
$this->assertSame('1.2K', Number::abbreviate(1230, maxPrecision: 1));
$this->assertSame('1M', Number::abbreviate(1000000));
$this->assertSame('1B', Number::abbreviate(1000000000));
$this->assertSame('1T', Number::abbreviate(1000000000000));
$this->assertSame('1Q', Number::abbreviate(1000000000000000));
$this->assertSame('1KQ', Number::abbreviate(1000000000000000000));

$this->assertSame('123', Number::abbreviate(123));
$this->assertSame('1K', Number::abbreviate(1234));
$this->assertSame('1.23K', Number::abbreviate(1234, precision: 2));
$this->assertSame('12K', Number::abbreviate(12345));
$this->assertSame('1M', Number::abbreviate(1234567));
$this->assertSame('1B', Number::abbreviate(1234567890));
$this->assertSame('1T', Number::abbreviate(1234567890123));
$this->assertSame('1.23T', Number::abbreviate(1234567890123, precision: 2));
$this->assertSame('1Q', Number::abbreviate(1234567890123456));
$this->assertSame('1.23KQ', Number::abbreviate(1234567890123456789, precision: 2));
$this->assertSame('490K', Number::abbreviate(489939));
$this->assertSame('489.9390K', Number::abbreviate(489939, precision: 4));
$this->assertSame('500.00000M', Number::abbreviate(500000000, precision: 5));

$this->assertSame('1MQ', Number::abbreviate(1000000000000000000000));
$this->assertSame('1BQ', Number::abbreviate(1000000000000000000000000));
$this->assertSame('1TQ', Number::abbreviate(1000000000000000000000000000));
$this->assertSame('1QQ', Number::abbreviate(1000000000000000000000000000000));
$this->assertSame('1KQQ', Number::abbreviate(1000000000000000000000000000000000));

$this->assertSame('0', Number::abbreviate(0));
$this->assertSame('-1', Number::abbreviate(-1));
$this->assertSame('-1.00', Number::abbreviate(-1, precision: 2));
$this->assertSame('-10', Number::abbreviate(-10));
$this->assertSame('-100', Number::abbreviate(-100));
$this->assertSame('-1K', Number::abbreviate(-1000));
$this->assertSame('-1.23K', Number::abbreviate(-1234, precision: 2));
$this->assertSame('-1.2K', Number::abbreviate(-1234, maxPrecision: 1));
$this->assertSame('-1M', Number::abbreviate(-1000000));
$this->assertSame('-1B', Number::abbreviate(-1000000000));
$this->assertSame('-1T', Number::abbreviate(-1000000000000));
$this->assertSame('-1.1T', Number::abbreviate(-1100000000000, maxPrecision: 1));
$this->assertSame('-1Q', Number::abbreviate(-1000000000000000));
$this->assertSame('-1KQ', Number::abbreviate(-1000000000000000000));
}

protected function needsIntlExtension()
{
if (! extension_loaded('intl')) {
Expand Down