https://github.com/brianium/nomnom
A simple library for converting byte sizes with PHP 5.3+
https://github.com/brianium/nomnom
Last synced: about 1 year ago
JSON representation
A simple library for converting byte sizes with PHP 5.3+
- Host: GitHub
- URL: https://github.com/brianium/nomnom
- Owner: brianium
- License: mit
- Created: 2013-08-20T03:31:50.000Z (almost 13 years ago)
- Default Branch: master
- Last Pushed: 2014-10-28T14:46:41.000Z (over 11 years ago)
- Last Synced: 2025-04-04T22:46:53.976Z (about 1 year ago)
- Language: PHP
- Size: 355 KB
- Stars: 11
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
#Nomnom [](https://travis-ci.org/brianium/nomnom)
> Get it? Bytes? Bites?
Nomnom handles file size conversion for PHP 5.3+. It handles both binary (base 2)
and metric (base 10) conversions. It provides a simple interface for converting between
sizes of any similar base!
Usage
-----
A Nomnom object is constructed with a "start" value that will be converted.
Two methods are defined on this object: `from` and `to`. Each of these methods takes
a metric or binary unit to convert from/to.
The `to` method takes an optional `precision` value to specify how many significant
digits to keep in the result.
```php
$nomnom = new Nomnom(1440000);
//metric conversion to 1.44
$mb = $nomnom->from('B')->to('MB', 2);
$nomnom = new Nomnom(1024);
//binary conversion to 1
$kb = $nomnom->from('KiB')->to('MiB');
//convert a file size
$filesize = new Filesize('/path/to/file.txt');
$mb = $filesize->to('MB');
```
As a convenience, Nomnom provides a factory method called `nom` and constants for the metric
and binary units.
```php
//returns 1.44
Nomnom::nom(1440000)->from(Nomnom::BYTES)->to(Nomnom::MB, 2);
//factory for Filesize
Nomnom::file('/path/to/file.txt')->to(Nomnom::MB);
```
Notes
-----
'B' refers to bytes in either base 10 or base 2.
Nomnom will throw a `ConversionException` if the `from` and `to` methods contain units
for different bases, i.e no `$nomnom->from('KiB')->to('MB');`
Nomnom requires the bcmath extension to handle greater precision.
Tests
-----
To run the tests, make sure dependencies have been installed with `composer install --dev` and run:
```bash
vendor/bin/phpunit test/
```