xynnn/unicorn

A framework agnostic PHP library to convert several units

1.0.1 2017-01-25 17:11 UTC

Requires

• php: >=7.0
• ext-bcmath: *
• steffenbrand/curr-curr: ^2.2

Requires (Dev)

• phpunit/phpunit: 4.8

GNU LGPL v3.0

• Philipp Bräutigam
• Steffen Brand

• converter
• units
• formats

README

A PHP based framework agnostic library to convert several units

• Unicorn on Packagist
• Unicorn on GitHub

Documentation

http://unicorn.readthedocs.io

Conversion example

Here is a quick example that shows how to convert 110 centimeters to meters:

$converter = new LengthConverter();

try {
    $result = $converter->convert(
        new ConvertibleValue('110', $converter::$centimeter),
        $converter::$meter
    );
    
    $result->getValue(); // '1.10...' with 999 decimals
    $result->getFloatValue(); // 1.1
    $result->getUnit()->getAbbreviation(); // 'm'
    $result->getUnit()->getName(); // 'meter'
} catch (UnsupportedUnitException $e) {
    // Unit might not be present in the converters units array
} catch (InvalidArgumentException $e) {
    // Something is wrong with the provided ConvertibleValue or Unit
}

Requirements

• PHP 7.0 or higher
• BCMath extension installed and enabled

Installation

Open a command console, enter your project directory and execute the following command to download the latest stable version of unicorn:

composer require xynnn/unicorn

This command requires you to have Composer installed globally, as explained in the installation chapter of the Composer documentation.

Authors

Philipp Bräutigam

• github/xyNNN
• twitter/xyNNN

Steffen Brand

• github/steffenbrand

License

Copyright (c) 2016 Philipp Bräutigam, Steffen Brand and contributors.
This repository is released under the GNU LGPL v3.0 license.