{"id":4746,"date":"2023-12-02T04:02:07","date_gmt":"2023-12-02T04:02:07","guid":{"rendered":"https:\/\/rengga.dev\/blog\/?p=4746"},"modified":"2024-01-14T05:32:24","modified_gmt":"2024-01-14T05:32:24","slug":"laravel-number-utility-class","status":"publish","type":"post","link":"https:\/\/rengga.dev\/blog\/laravel-number-utility-class\/","title":{"rendered":"Laravel Number Utility Class"},"content":{"rendered":"

Hello everyone, Caen here! I’m excited to share with you a recent addition I made to the Laravel framework (PR #48845<\/a>) that I believe will simplify your number formatting needs. I’ve introduced a new\u00a0Number<\/code>\u00a0utility class that provides several new helpers to format numbers, and it should be available in the next Laravel release this week.<\/p>\n

As another bonus<\/strong>: the helpers are locale-aware, so you can format numbers according to the current locale, either globally, or on a per-method basis!<\/p>\n

Background<\/h2>\n

In many applications, there’s often a need to format numbers according to different requirements, such as displaying them as currency, percentages, or human-readable file sizes. Laravel didn’t have a dedicated utility for this, so with the help of the community, I decided to create one. I’ve been working on this utility class for a a little while now, and am really excited that it was merged into the framework. Let’s take a look at what it offers.<\/p>\n

The Laravel\u00a0Number<\/code>\u00a0Class<\/strong><\/p>\n

Introduction<\/h3>\n

All methods are part of the\u00a0Illuminate\\Support\\Number<\/code>\u00a0class:<\/p>\n

use Illuminate\\Support\\Number;<\/pre>\n
General number formatting<\/h3>\n
Using the\u00a0format<\/code>\u00a0method, we can format a number according to the current locale.<\/p>\n
Number::format(25) \/\/ 25\r\nNumber::format(100000) \/\/ 100,000\r\nNumber::format(123456789) \/\/ 123,456,789<\/pre>\n
We can also specify a custom locale to format the number according to that locale’s rules.<\/p>\n
Number::format(123456789, locale: 'en') \/\/ 123,456,789\r\nNumber::format(123456789, locale: 'de') \/\/ 123.456.789\r\nNumber::format(123456789, locale: 'sv') \/\/ 123 456 789<\/pre>\n
Percentage formatting<\/h3>\n
The\u00a0formatPercentage<\/code>\u00a0method formats a number as a percentage according to the current locale.<\/p>\n
Number::percentage(25) \/\/ 25%\r\nNumber::percentage((1\/3) * 100, precision: 2) \/\/ 33.33%<\/pre>\n
Currency formatting<\/h3>\n
Here’s another fun method used to format various currencies with locale support. Perfect for your webshops!<\/p>\n
Number::toCurrency(10) \/\/ $10.00\r\nNumber::toCurrency(25, currency: 'EUR') \/\/ \u20ac25.00\r\nNumber::toCurrency(5.49, currency: 'EUR', locale: 'de') \/\/ 5.49 \u20ac<\/pre>\n
File size formatting<\/h3>\n
Here is the\u00a0toFileSize<\/code>\u00a0method which actually is the whole reason behind this utility class. I first submitted a PR to add a\u00a0File::bytesToHuman()<\/code>\u00a0helper (PR #48827<\/a>), which\u00a0Taylor then suggested<\/a>\u00a0we add as part of a new\u00a0Number<\/code>\u00a0class.<\/p>\n
Number::toFileSize(1024); \/\/ 1 KB\r\nNumber::toFileSize(1600, precision: 2); \/\/ 1.56 KB\r\nNumber::toFileSize(1024 * 1024 * 1024 * 5); \/\/ 5 GB<\/pre>\n
Human readable formatting<\/h3>\n
Next up is also a quite fun one for when you want something that’s more readable than precise. It converts numbers to a human-readable string.<\/p>\n
Number::forHumans(1000) \/\/ 1 thousand\r\nNumber::forHumans(12345) \/\/ 12 thousand\r\nNumber::forHumans(12345, precision: 3) \/\/ 12.345 thousand<\/pre>\n
Setting the locale<\/h3>\n
We can set the locale globally using the\u00a0setLocale<\/code>\u00a0method, for example in a service provider:<\/p>\n
Number::setLocale('sv');<\/pre>\n
You can also use the\u00a0withLocale<\/code>\u00a0method which executes the given callback using the specified locale and then restores the original locale:<\/p>\n
Number::withLocale('sv', function () {\r\n    return Number::format(123456789);\r\n});<\/pre>\n
Conclusion<\/h2>\n
I hope this new addition makes your life a bit easier when dealing with number formatting in Laravel. Please free to check out the next Laravel release and incorporate this utility class into your projects. Happy coding!<\/p>\n","protected":false},"excerpt":{"rendered":"
Hello everyone, Caen here! I’m excited to share with you a recent <\/a><\/p>\n","protected":false},"author":1,"featured_media":4747,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[12],"tags":[708,722,676],"newstopic":[597,574],"class_list":{"0":"post-4746","1":"post","2":"type-post","3":"status-publish","4":"format-standard","5":"has-post-thumbnail","7":"category-web-development","8":"tag-laravel","9":"tag-laravel-number-utility-class","10":"tag-rengga-dev","11":"newstopic-laravel","12":"newstopic-php"},"_links":{"self":[{"href":"https:\/\/rengga.dev\/blog\/wp-json\/wp\/v2\/posts\/4746","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/rengga.dev\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/rengga.dev\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/rengga.dev\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/rengga.dev\/blog\/wp-json\/wp\/v2\/comments?post=4746"}],"version-history":[{"count":4,"href":"https:\/\/rengga.dev\/blog\/wp-json\/wp\/v2\/posts\/4746\/revisions"}],"predecessor-version":[{"id":4751,"href":"https:\/\/rengga.dev\/blog\/wp-json\/wp\/v2\/posts\/4746\/revisions\/4751"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/rengga.dev\/blog\/wp-json\/wp\/v2\/media\/4747"}],"wp:attachment":[{"href":"https:\/\/rengga.dev\/blog\/wp-json\/wp\/v2\/media?parent=4746"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/rengga.dev\/blog\/wp-json\/wp\/v2\/categories?post=4746"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/rengga.dev\/blog\/wp-json\/wp\/v2\/tags?post=4746"},{"taxonomy":"newstopic","embeddable":true,"href":"https:\/\/rengga.dev\/blog\/wp-json\/wp\/v2\/newstopic?post=4746"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}