Download the PHP package scriptfusion/byte-formatter without Composer

On this page you can find all versions of the php package scriptfusion/byte-formatter. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of scriptfusion/byte-formatter

Informations about the package byte-formatter

ByteFormatter

Latest version Total downloads Build status Test coverage Code style

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.

512 KiB

Bytes can be divided into multiples of 1000 by specifying Base::DECIMAL as the base.

500 KB

Precision

By default, all values are rounded to the nearest integer.

513 KiB

Increasing the default precision with setPrecision() allows the specified number of digits after the decimal point.

512.55 KiB

Increasing the precision will increase the maximum digits allowed but the formatter will only display as many as needed.

512.5 KiB

Automatic precision scaling can be disabled if this behaviour is undesired.

512.50 KiB

The default precision can be overridden by passing the second argument to format().

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.

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().

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.

Exponent Symbol
0 B
1 K
2 M
3 G
4 T
5 P
6 E
7 Z
8 Y

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.

Constant B K M G T P E Z Y
SUFFIX_NONE K M G T P E Z Y
SUFFIX_METRIC B KB MB GB TB PB EB ZB YB
SUFFIX_IEC B KiB MiB GiB TiB PiB EiB ZiB YiB

The following example uses base 1024 but displays the metric suffix, like Windows Explorer.

512 KB

If you prefer terse notation the suffix may be removed with SUFFIX_NONE.

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().

512

512 B

Name decorator

NameDecorator can be used to replace the default decorator and returns units like byte, kilobyte, megabyte, etc.

512 kibibytes

Using decimal base:

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.

All versions of byte-formatter with dependencies

PHP Build Version
Package Version
Requires php Version ^8
scriptfusion/static-class Version ^1
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package scriptfusion/byte-formatter contains the following files

Loading the files please wait ....