jordanbrauer/unit-converter

Convert standard units from one to another with this easy to use, lightweight package

Sunday, June 10, 2018
by jordanbrauer
Repository
2 Watchers
9 Stars
26 Installations

PHP
0 Dependents
0 Suggesters
10 Forks
14 Open issues
29 Versions
136 % Grown

The README.md

Unit Converter

, _(*1)

, _(*2)

, _(*3)

Convert all kinds of standard units of measurement from one to another with this highly customizable, easy to use, lightweight PHP component., _(*4)

Table of Contents:, _(*5)

About the Component
Installing the Component
Basic Usage
Documentation

1. About the Component

This unit converter component aims to be modern and follow best practices. It also aims to be fully SI compliant (eventually...)., _(*6)

It supports the following types of measurement by default (support for more measurement types are on the roadmap)., _(*7)

Area
Data Transfer Rates Coming Soon!
Digital Storage New!
Energy (Power)
Frequency
Fuel Economy
Length
Mass (Weight)
Plane Angle (Rotation)
Pressure
Speed
Temperature
Time
Volume

You also have the ability to override & customize the default units, as well as add your own!, _(*8)

2. Installing the Component

The best way to install the component is with Composer. For other supported methods, see the wiki artile on installation., _(*9)

$ composer require jordanbrauer/unit-converter

3. Basic Usage

Using the component is very easy, especially if you have used the Symfony or Laravel frameworks before., _(*10)

Quick-Start

If you'd like to skip the minutiae of this component's setup and get right down to business, you can get started by constructing a pre-configured converter via static constructors or the builder object, like so,, _(*11)

Static Constructors

use UnitConverter\UnitConverter;

$converter = UnitConverter::default(); # simple calculator
$converter = UnitConverter::binary(); # binary calculator (BC math)

Builder

use UnitConverter\UnitConverter;

$converter = UnitConverter::createBuilder()
    ->addSimpleCalculator()
    ->addDefaultRegistry()
    ->build();

and use it like this,, _(*12)

$converter->convert(1)->from("in")->to("cm"); # (float) 2.54

and you're done! For a more in-depth setup guide, check the wiki., _(*13)

Usage Examples

Here are where some usage examples of something that may fit more along the lines of "real-life", are found. Keep in mind that the code examples in each use-case, while working & valid, do contain some pseudo-code in them for demonstration purposes., _(*14)

The Traffic Camera

In this example, pretend we have a traffic camera that only captures speeds in Imperial measurement of miles per hour. The traffic camera records each passing car's speed to determine if they were speeding & if so, snap a photo of their license plate as proof to serve a ticket. In this case, the camera caught a speed of 59 miles per hour., _(*15)

Here we construct a new unit & give it a value representing how many of the unit exists,, _(*16)

$capturedSpeed = new MilePerHour(59);

Next, a conversion of units needs to take place, because this traffic camera model is being used in a country that uses the metric system., _(*17)

As you can see in this example, we are leveraging the power of typehints to ensure we only receive units of the desired measurement. Inside of the closure, we are using one of the unit's most convenient & powerful methods: as(). It allows us to convert units without the direct use of the UnitConverter & UnitRegistry objects – giving the benefit of even cleaner code & type safety., _(*18)

$isOverSpeedLimit = function (SpeedUnit $speed) {
    return $speed->as(new KilometrePerHour) > 50;
};

if ($isOverSpeedLimit($capturedSpeed)) { # (bool) true
    TrafficCamera::snapPhoto();
}

Conversion Results as Words

Sometimes you might need localization support for values. This component makes that a breeze by making using the intl extension. Simply opt for using the spellout method in lieu of to. You may also provide an optional locale as the second parameter to translate., _(*19)

$converter->convert(1)->from('in')->spellout('cm');       # (string) two point five four
$converter->convert(1)->from('in')->spellout('cm', 'fr'); # (string) deux virgule cinq quatre

4. Documentation

There are two kinds of in-depth documentation for this project: user & API documentation. Use whichever one you need to help answer your questions!, _(*20)

User Documentation

Setup guides, in-depth examples, tutorials, and explanations on the component for users who are looking to integrate it into their project, as-is., _(*21)

User Documentation, _(*22)

API Documentation

If you are looking to extend and hack on this component for your own project, these pages will give you insight into all about how the component works, through the awesome power of dockblocks!, _(*23)

API Documentation, _(*24)

The Versions

10/06 2018

dev-master

9999999-dev

Convert standard units from one to another with this easy to use, lightweight package

component unit-converter

Convert standard units from one to another with this easy to use, lightweight package

jordanbrauer/unit-converter

The README.md

Unit Converter

1. About the Component

2. Installing the Component

3. Basic Usage

Quick-Start

Static Constructors

Builder

Usage Examples

The Traffic Camera

Conversion Results as Words

4. Documentation

User Documentation

API Documentation

The Versions

dev-master

The Development Requires

by jordanbrauer

dev-array-dot-notation

The Development Requires

by jordanbrauer

v0.7.0

The Development Requires

by jordanbrauer

dev-fully-loaded-converter

The Development Requires

by jordanbrauer

dev-codesmell-removals

The Development Requires

by jordanbrauer

dev-debugging-tools

The Development Requires

by jordanbrauer

dev-codeclimate-badges

The Development Requires

by jordanbrauer

dev-repo-files

The Development Requires

by jordanbrauer

dev-debug-tools

The Development Requires

by jordanbrauer

dev-time-helpers

The Development Requires

by jordanbrauer

dev-si-units

The Development Requires

by jordanbrauer

v0.6.7

The Development Requires

by jordanbrauer

v0.6.6

The Development Requires

by jordanbrauer

v0.6.5

The Development Requires

by jordanbrauer

v0.6.3

The Development Requires

by jordanbrauer

v0.6.4

The Development Requires

by jordanbrauer

v0.6.2

The Development Requires

by jordanbrauer

v0.6.2-rc

The Development Requires

by jordanbrauer

v0.6.1

The Development Requires

by jordanbrauer

dev-robofile-taskrunner

The Development Requires

by jordanbrauer

dev-develop

The Development Requires