File: README.md

Recommend this page to a friend!

README.md

File:	`README.md`
Role:	Documentation
Content typex:	`text/markdown`
Description:	Documentation
Class:	PHP Human Readable File Size Convert the size of a file to a readable format
Author:	By Rafal Janisz
Last change:
Date:	5 years ago
Size:	`1,426 bytes`

Download

readablesize

Converts number of bytes to human readable number by taking the number of that unit that the bytes will go into it.

Requirements

PHP >= 7.1
(optional) PHPUnit to run tests.

Install

Via Composer:

$ composer require ravjanisz/readablesize

Usage

// add settings instance
use Rav\Size\SizeSettings;
// add instance
use Rav\Size\Size;

//base for calculation can be added as SizeSettings constructor parameter
//SizeSettings::BINARY or SizeSettings::DECIMAL
$settings = new SizeSettings();
//set precision for size
$settings->setPrecision(2);

//new object instance
$this->size = new Size($settings);

//return '1.46KiB'
echo $this->size->human('1500');

//convert size
//return '0.01TiB'
echo $this->size->convert(Size::MB, Size::TB, '9500');