[10.x] Add a File::bytesToHuman() helper
#48827
Conversation
driesvints
changed the title
File::bytesToHuman() helperFile::bytesToHuman() helper
| $bytes /= 1024; | ||
| } | ||
|
|
||
| return round($bytes, $precision).' '.['B', 'KB', 'MB', 'GB', 'TB'][$i]; |
There was a problem hiding this comment.
That will not work for Petabyte:
So please use a fallback if we have more then the highest unit.
There was a problem hiding this comment.
Also: Maybe use sprintf for text output. This should imo be more readable.
There was a problem hiding this comment.
Sure thing! I could increase the lookup array to Yottabytes? I can of course also add a fallback, or both. What do you think is best?
Will use sprintf as well.
There was a problem hiding this comment.
Personally, I would like to see it expanded to yottabytes when it is irrelevant whether it is needed or not, it is there and the function can then.
Additionally, you always need a fallback, as there can always be sizes you don't care about in the code (even if the integer is limited, you wan't always have a fallback).
So the easiest way for a fallback is a break within the loop, if we reach a certain point (or use a for loop with a break if $bytes < 1024).
There was a problem hiding this comment.
Thanks for the feedback!
7d04625 adds a cap so that the iterator stops dividing when reaching the end of the units array which now also supports extreme values. Also uses sprintf as requested. Also adds tests for large numbers.
Let me know if you want me to squash the commits!
Adds a cap so that the iterator stops dividing when reaching the end of the units array. Also uses `sprintf` as requested. Also adds tests for large numbers.
|
Hey @caendesilva - I started digging into what Rails does here. https://api.rubyonrails.org/classes/ActionView/Helpers/NumberHelper.html This may make sense as part of a new |
@taylorotwell That sounds even better to me! I'd love to help. I'm in the |
Ports laravel#48827 into the new `Number` utility class
* Create a new Number utility class * Add a `Number::bytesToHuman()` helper Ports #48827 into the new `Number` utility class * Add a `Number::toHuman()` helper This is unfortunately dependent on the `ext-intl`, as it wraps the NumberFormatter class. * Use lowercase `k` for kilobytes See #48845 (comment) * Update Support package to suggest `ext-intl` * Throw if extension is not installed when using NumberFormatter wrapper As discussed in #internals, this seems to be a good compromise when the extension is not used. Instead of testing against the exception in the tests, I just skipped the test if the extension is missing, as that is what we do in the InteractsWithRedis testing trait. * Add a `Number::toCurrency()` helper * Make Number helper locale parameters null and default to App locale This makes so that if no locale parameter is specified, the configured App locale is used. * Add a `Number::format()` helper Adds a locale-aware number formatting helper * Fix number tests Could not get Mockery to work, so this is my fix. * Add a `Number::toPercent()` helper I'm dividing the supplied value by 100 so that 50 = 50% as that's how Rails does it, and that's what Taylor linked to in his suggestion for this class. The default number formatter would consider 0.5 to be 50% and 50 to be 5000%. I'm not sure which option is best, so I went with the Rails format. https://api.rubyonrails.org/classes/ActionView/Helpers/NumberHelper.html#method-i-number_to_percentage * Rename Number toHuman helper to spellout We may want to remove it, as per #48845 (comment). But renaming it for now. * Create new `Number::toHuman()` helper Based on the Rails implementation, as requested by Taylor in #48845 (comment) See https://api.rubyonrails.org/classes/ActionView/Helpers/NumberHelper.html#method-i-number_to_human Uses the short scale system, see https://en.wikipedia.org/wiki/Long_and_short_scales * Change toHuman implementation to better match Rails version Based more on the logic of Rails, but with added support for massive numbers. * Update toHuman helper to better handle extreme numbers Inverts negative numbers, and removes unreachable cases, and handles very large numbers * Clean up toHuman helper * formatting * formatting * formatting * formatting * formatting --------- Co-authored-by: Taylor Otwell <taylor@laravel.com>
* Create a new Number utility class * Add a `Number::bytesToHuman()` helper Ports laravel/framework#48827 into the new `Number` utility class * Add a `Number::toHuman()` helper This is unfortunately dependent on the `ext-intl`, as it wraps the NumberFormatter class. * Use lowercase `k` for kilobytes See laravel/framework#48845 (comment) * Update Support package to suggest `ext-intl` * Throw if extension is not installed when using NumberFormatter wrapper As discussed in #internals, this seems to be a good compromise when the extension is not used. Instead of testing against the exception in the tests, I just skipped the test if the extension is missing, as that is what we do in the InteractsWithRedis testing trait. * Add a `Number::toCurrency()` helper * Make Number helper locale parameters null and default to App locale This makes so that if no locale parameter is specified, the configured App locale is used. * Add a `Number::format()` helper Adds a locale-aware number formatting helper * Fix number tests Could not get Mockery to work, so this is my fix. * Add a `Number::toPercent()` helper I'm dividing the supplied value by 100 so that 50 = 50% as that's how Rails does it, and that's what Taylor linked to in his suggestion for this class. The default number formatter would consider 0.5 to be 50% and 50 to be 5000%. I'm not sure which option is best, so I went with the Rails format. https://api.rubyonrails.org/classes/ActionView/Helpers/NumberHelper.html#method-i-number_to_percentage * Rename Number toHuman helper to spellout We may want to remove it, as per laravel/framework#48845 (comment). But renaming it for now. * Create new `Number::toHuman()` helper Based on the Rails implementation, as requested by Taylor in laravel/framework#48845 (comment) See https://api.rubyonrails.org/classes/ActionView/Helpers/NumberHelper.html#method-i-number_to_human Uses the short scale system, see https://en.wikipedia.org/wiki/Long_and_short_scales * Change toHuman implementation to better match Rails version Based more on the logic of Rails, but with added support for massive numbers. * Update toHuman helper to better handle extreme numbers Inverts negative numbers, and removes unreachable cases, and handles very large numbers * Clean up toHuman helper * formatting * formatting * formatting * formatting * formatting --------- Co-authored-by: Taylor Otwell <taylor@laravel.com>
|
how to install this update? |
A version of it will be released tomorrow! https://laravel-news.com/laravel-number-utility-class |
|
I assume that there could be a reverse |
Abstract
Adds a
File::bytesToHuman()helper to format the number of bytes to a human-readable string.Functionality
The helper works by iterating through the input byte count and dividing it by
1024. The iteration count is the used in a lookup array to get the appropriate byte suffix. It supports rounding to a specific precision. Results are also slightly rounded up.Development
I was originally thinking this could be a helper in the
Strclass, but after bringing it up in#internalswe thought it might be better in theFilefacade. I am of course more than happy to move it to theStrclass. Thanks to all the great people in the Discord!Added tests
I added a test with 8 assertions to get a broad range of conditions. I also ran some benchmarks on different implementations, and all of them have minuscule performance concerns (~0.00058ms avg/1 million iterations).
Backwards compatibility
This adds a new feature, so it will not break any existing features. It can thus also go in a minor release version.
How this improves Laravel
This is one of those things I often add to Laravel applications as a
Strmacro. And I thought it is so useful, so I wanted to share it with everyone!