skoyah / unit-converter
A simple tool for converting units of measurement.
Requires
- php: ^7.1
Requires (Dev)
- phpunit/phpunit: ^7.4
README
Unit Converter is a PHP library that makes unit converting a fairly simple an intuitive process.
Table of Contents
Installation
$ composer require skoyah/unit-converter
Basic Usage
Namespacing
The Unit Converter library is under Skoyah\Converter namespace.
Once you have installed the Unit Converter library, converting from one unit of measurement to another is really simple.
First, create a new instance of the desired type and import the related class. The instance needs to accept two parameters - 1) a boolean for the quantity, and 2) a string for the unit of measurement.
Next, all you need is to call a to() method and pass in the parameter for the convertion.
Example conversion:
use Skoyah\Converter\Mass; $mass = new Mass(1, 'kg'); echo $mass->to('pounds'); // '2.20462262'
Alternatively, you can convert using the unit abbreviation as a parameter:
echo $mass->to('lbs'); // '2.20462262'
The to() method has also an optional parameter tor defining how many decimal units should be displayed for the given convertion.
echo $mass->to('lbs', 2); // '2.20'
Support
Currently, the Unit Converter supports the following types:
Configuration
During instantiation or convertion, you have two options for defining the unit to be used.
There is a longform and a short-hand word available for each unit of measure.
For consistency, it is recommended to use lowercase letters, but if you prefer you can use uppercase letters since during instantiation and/or convertion, the unit of measure will be parsed and formatted to lowercase characters.
Mass units
Temperature units
Length units
Pressure units
Area units
Volume units
Code of Conduct
In order to ensure that the community is welcoming to all, please review and abide by the Code of Conduct.
License
Unit Converter is released under the MIT Licence. Read the license file for more details.