scriptfusion / byte-formatter
Formats byte values as human-readable strings.
Installs: 219 169
Dependents: 7
Suggesters: 0
Security: 0
Stars: 40
Watchers: 4
Forks: 1
Open Issues: 3
Requires
- php: ^8
- scriptfusion/static-class: ^1
Requires (Dev)
- mockery/mockery: ^1.4
- phpunit/phpunit: ^9
README
ByteFormatter formats byte values as human-readable strings. An appropriate exponent is calculated automatically such
that the value never exceeds the base. For example, in base 1024, format(1023)
gives 1023 B but format(1024)
gives
1 KiB instead of 1024 B.
Usage
By default, bytes are divided using Base::BINARY
into multiples of 1024.
(new ByteFormatter)->format(0x80000);
512 KiB
Bytes can be divided into multiples of 1000 by specifying Base::DECIMAL
as the base.
(new ByteFormatter)->setBase(Base::DECIMAL)->format(500000);
500 KB
Precision
By default, all values are rounded to the nearest integer.
(new ByteFormatter)->format(0x80233);
513 KiB
Increasing the default precision with setPrecision()
allows the specified number of digits after the decimal point.
(new ByteFormatter)->setPrecision(2)->format(0x80233);
512.55 KiB
Increasing the precision will increase the maximum digits allowed but the formatter will only display as many as needed.
(new ByteFormatter)->setPrecision(2)->format(0x80200);
512.5 KiB
Automatic precision scaling can be disabled if this behaviour is undesired.
(new ByteFormatter)->setPrecision(2)->disableAutomaticPrecision()->format(0x80200);
512.50 KiB
The default precision can be overridden by passing the second argument to format()
.
(new ByteFormatter)->setPrecision(2)->format(0x80233, 4);
512.5498 KiB
Output format
The format can be changed by calling setFormat()
which takes a string format parameter. The default format is
'%v %u'
. Occurrences of %v
and %u
in the format string will be replaced with the calculated value and units
respectively.
(new ByteFormatter)->setFormat('%v%u')->format(0x80000);
512KiB
Fixed exponent
One of the main benefits of the formatter is an appropriate exponent is calculated automatically, however it is also
possible to fix the exponent to a specific value using setFixedExponent()
.
(new ByteFormatter)->setFixedExponent(1)->format(1024 * 1024);
1024 KiB
Normally we would expect the above example to output 1 MiB
but because the exponent is locked to 1
the output will
always be in KiB
. Consult the following table to see how exponents map to symbols.
Unit customization
Units are provided by decorators extending UnitDecorator
. Two implementations are provided: the default
SymbolDecorator
and an optional NameDecorator
.
Unit decorators receive the base of the formatter when asked to decorate a value so that different units can be
returned for different bases. For example, the default decorator outputs KiB
in base 1024 for
210 < bytes < 220 but outputs KB
in base 1000 for 1000 < bytes < 1000000. This behaviour
can be suppressed by callingSymbolDecorator::setSuffix()
with the desired SymbolDecorator
suffix constant to
prevent units changing when the base is changed. Decorators also receive the exponent and scaled byte value.
Symbol decorator
SymbolDecorator
is the default unit decorator and returns units like B, KB, MB, etc. The symbol's suffix can be
changed using one of the class constants from the following table.
The following example uses base 1024 but displays the metric suffix, like Windows Explorer.
(new ByteFormatter(new SymbolDecorator(SymbolDecorator::SUFFIX_METRIC))) ->format(0x80000)
512 KB
If you prefer terse notation the suffix may be removed with SUFFIX_NONE
.
(new ByteFormatter(new SymbolDecorator(SymbolDecorator::SUFFIX_NONE))) ->format(0x80000)
512 K
Note that no unit is displayed for bytes when the suffix is disabled. If this is undesired, byte units can be forced
with SymbolDecorator::alwaysShowUnit()
.
(new ByteFormatter(new SymbolDecorator(SymbolDecorator::SUFFIX_NONE))) ->format(512)
512
(new ByteFormatter( (new SymbolDecorator(SymbolDecorator::SUFFIX_NONE)) ->alwaysShowUnit() )) ->format(512)
512 B
Name decorator
NameDecorator
can be used to replace the default decorator and returns units like byte, kilobyte, megabyte,
etc.
(new ByteFormatter(new NameDecorator)) ->format(0x80000)
512 kibibytes
Using decimal base:
(new ByteFormatter(new NameDecorator)) ->setBase(Base::DECIMAL) ->format(500000)
500 kilobytes
Testing
This library is fully unit tested. Run the tests with composer test
from the command line. All examples
in this document can be found in DocumentationTest
.