apiotrowski / unit-converter
Unit converter it is service which converts values based on raw string query.
Requires
- php: ~7.1
- ext-bcmath: *
Requires (Dev)
- phpunit/phpunit: ~7.4
README
Unit converter it is php service which converts values based on raw string query.
QueryExample: 10cm to ?in
Converter will automatically resolve supported converter and make calculation. In the output it return new Value.
Value is an Object what have two property: Value (string), Unit (object).
Manual conversion
If you want to convert values not using Convert Manager you can do it directly by calling following snippet:
(new LengthConverter())->convertTo(new Value(10, UnitFactory::build(LengthUnit::CENTIMETRE)), UnitFactory::build(LengthUnit::INCH));
Current converters list implemented inside:
- Length Converter (unit: ml, km, m, cm, in, ft)
- Weight Converter (unit: t, kg, g, dag, lbs, oz)
How to use it
Unit Converter is really simple to use and easy to extend. In a bellow example I show how to use this tool.
$convertManager = new ConvertManager(new ArrayCollection([ new LengthConverter(), new WeightConverter() ]), new QueryResolver()); $convertedValue = $convertManager->convert('10cm to ?in');
After you call convert() function all magic happened inside. At the beginning it resolve the query to php form, choose what converter should be used, and in the end converts value to destination unit.
In the output ($convertedValue) you get Value object with the result.
To calculation values tool is use BC Math library.
Tool are tested in PHPUnit, so everything should work Without any mistake.
How to extend Unit Converter
To Extend Converter User should:
-
Create new Converter class and Unit class,
-
Add new created Unit class to list of the supported units in the UnitFactory class,
-
During initialization of ConvertManager, add your converter class to list of supported converters.
Supported PHP Versions
- PHP 7.0 with installed BC Math Extension