h4kuna/number-format

Object wrapper above number_format

v2.0.1 2017-08-12 03:28 UTC

README

Build Status Latest stable Downloads this Month Coverage Status

Wrapper above number_format, api is very easy.

Changelog

v2.0

New behavior is representing by one class is one type of format. Onetime create class and you can'nt change by life of object. Added new classes for number, unit and currency. Working with percent and taxes are better too.

Here is manual for older version 1.3.0.

Install via composer

composer require h4kuna/number-format

NumberFormatState

Class has many parameters and all paremetes has default value. You can add parameters normaly by position or name of keys in array like first parameter.

use h4kuna\Number;

// set decimals as 3
$numberFormat = new Number\NumberFormatState(3);
// or
$numberFormat = new Number\NumberFormatState(['decimals' => 3]);


echo $numberFormat->format(1000); // 1 000,000

Parameters

  • decimals: [2]
  • decimalPoint: string [',']
  • thousandsSeparator: string [NULL] mean  
  • zeroIsEmpty: bool [FALSE] - transform 0 to empty value
  • emptyValue: string [NULL] has two options dependecy on zeroIsEmpty if is FALSE than empty value transform to zero or TRUE mean zero tranform to emtpy string if is not defined other string
  • zeroClear: [FALSE] mean 1.20 trim zero from right -> 1.2
  • intOnly: [NULL] if we have numbers like integers. This mean set 3 and transform number 1050 -> 1,05

Here is test for more use cases.

UnitFormatState

Use this class for number with unit like Kb, Mb, Gb. Unit symbol is second parameter in method format. Visit tests.

Parameters

  • mask: ['1 U'] mean 1 pattern for number and U is pattern for unit
  • showUnit: [TRUE] mean show unit if number is empty
  • nbsp: [TRUE] mean replace white space in mask by &nbsp

UnitPersistentFormatState

This class is same like previous, but unit is persistent like currencies or temperature.

Parameters

  • unit: has'nt default value

NumberFormatFactory

For all previous classes is prepared factory class. This class help you create new instance and support named parameters in constructor. Visit test

Tax

$tax = new Tax(20);
echo $tax->add(100); // 120
echo $tax->deduct(120); // 100.0
echo $tax->diff(120); // 20.0

Percent

$percent = new Percent(20);
echo $percent->add(100); // 120.0
echo $percent->deduct(120); // 96.0
echo $percent->diff(120); // 24.0

Integration to Nette framework

In your neon file

services:
	number: h4kuna\Number\NumberFormatState([decimalPoint: '.', intOnly: 1, decimals: 1])

	latte.latteFactory:
		setup:
			- addFilter('number', [@number, 'format'])

We added new filter number, in template use like:

{=10000|number} // this render "1 000.0" with &nbps; like white space

Units

Help us convert units in general decimal system.

Units\Unit

use h4kuna\Number\Units;

$unit = new Units\Unit(/* [string $from], [array $allowedUnits] */);
  • $from select default prefix for your units default is BASE = 0
  • $allowedUnits if we need other units if is defined

This example say: I have 50kilo (103) and convert to base 100

$unitValue = $unit->convertFrom(50, $unit::KILO, $unit::BASE);
echo $unitValue->unit; // empty string mean BASE
echo $unitValue->value; // 50000

If second parameter is NULL then use from unit whose is defined in constructor.

$unitValue = $unit->convertFrom(5000, NULL, $unit::KILO);
// alias for this use case is 
$unitValue = $unit->convert(5000, $unit::KILO);

echo $unitValue->unit; // k mean KILO
echo $unitValue->value; // 5

If third parameter is NULL, class try find best unit.

$unitValue = $unit->convertFrom(5000000, $unit::MILI, NULL);
echo $unitValue->unit; // k mean KILO
echo $unitValue->value; // 5

Last method, take string and convert how we need. This is good for Byte.

$unitValue = $unit->fromString('100k', $unit::BASE);
echo $unitValue->unit; // BASE
echo $unitValue->value; // 100000

Units\Byte

$unitValue = $byte = new Units\Byte();
$byte->fromString('128M');
echo $unitValue->unit; // BASE
echo $unitValue->value; // 134217728

Units\UnitFormat

If we need format our units.

$nff = new Number\NumberFormatFactory();
$unitfFormat = new Units\UnitFormat('B', new Byte, $nff->createUnit());

$unitfFormat->convert(968884224); // '924,00 MB'
$unitfFormat->convert(1024); // '1,00 kB'