Add a Number::toHuman() helper

This is unfortunately dependent on the `ext-intl`, as it wraps the NumberFormatter class.
laravel · Oct 29, 2023 · 66655b4 · 66655b4
1 parent fb0e6ce
commit 66655b4
Show file tree

Hide file tree

Showing 2 changed files with 49 additions and 0 deletions.
diff --git a/src/Illuminate/Support/Number.php b/src/Illuminate/Support/Number.php
@@ -3,11 +3,26 @@
 namespace Illuminate\Support;
 
 use Illuminate\Support\Traits\Macroable;
+use NumberFormatter;
 
 class Number
 {
     use Macroable;
 
+    /**
+     * Format the number to a fluent human-readable string.
+     *
+     * @param  float|int  $number
+     * @param  string  $locale
+     * @return false|string
+     */
+    public static function toHuman($number, $locale = 'en')
+    {
+        $formatter = new NumberFormatter($locale, NumberFormatter::SPELLOUT);
+
+        return $formatter->format($number);
+    }
+
     /**
      * Format the number of bytes to a human-readable string.
      *

diff --git a/tests/Support/SupportNumberTest.php b/tests/Support/SupportNumberTest.php
@@ -7,6 +7,40 @@
 
 class SupportNumberTest extends TestCase
 {
+    public function testToHuman()
+    {
+        $this->assertSame('zero', Number::toHuman(0));
+        $this->assertSame('one', Number::toHuman(1));
+        $this->assertSame('ten', Number::toHuman(10));
+        $this->assertSame('twenty-five', Number::toHuman(25));
+        $this->assertSame('one hundred', Number::toHuman(100));
+        $this->assertSame('one hundred thousand', Number::toHuman(100000));
+        $this->assertSame('one hundred twenty-three million four hundred fifty-six thousand seven hundred eighty-nine', Number::toHuman(123456789));
+
+        $this->assertSame('one billion', Number::toHuman(1000000000));
+        $this->assertSame('one trillion', Number::toHuman(1000000000000));
+        $this->assertSame('one quadrillion', Number::toHuman(1000000000000000));
+        $this->assertSame('1,000,000,000,000,000,000', Number::toHuman(1000000000000000000));
+
+        $this->assertSame('minus one', Number::toHuman(-1));
+        $this->assertSame('minus ten', Number::toHuman(-10));
+        $this->assertSame('minus twenty-five', Number::toHuman(-25));
+
+        $this->assertSame('zero point two', Number::toHuman(0.2));
+        $this->assertSame('one point two three', Number::toHuman(1.23));
+        $this->assertSame('minus one point two three', Number::toHuman(-1.23));
+        $this->assertSame('one hundred twenty-three point four five six', Number::toHuman(123.456));
+    }
+
+    public function testToHumanWithDifferentLocale()
+    {
+        $this->assertSame('cent vingt-trois', Number::toHuman(123, 'fr'));
+
+        $this->assertSame('einhundertdreiundzwanzig', Number::toHuman(123, 'de'));
+
+        $this->assertSame('etthundratjugotre', Number::toHuman(123, 'sv'));
+    }
+
     public function testBytesToHuman()
     {
         $this->assertSame('0 B', Number::bytesToHuman(0));