fortis/iso-currency

A PHP library providing ISO 4217 currencies. Work with currencies by the standard to avoid confusions.

iso-currency

, _(*1)

Very simple and easy-to-use Currency class to work with ISO 4217 currencies as they provided by the official ISO Maintenance Agency, _(*2)

What is ISO 4217

ISO 4217 is a standard published by the International Organization for Standardization, which delineates currency designators, country codes (alpha and numeric), and references to minor units in three tables., _(*3)

-- Wikipedia, _(*4)

Install

Install directly from command line using Composer ``` bash composer require fortis/iso-currency, _(*5)

## Use

Don't type currency codes as strings, instead it's better to use constants from auto generated CurrencyCode class as it's always up-to-date with currency-iso.org and helps you avoid typos.
For example, use `CurrencyCode::USD` instead of `'USD'`. Autocomplete will make it easier.

Also you can create new currency object with Currency class and autocomplete: `new Currency::USD()`.

``` php
// Create Currency instance.
$currency = new Currency(CurrencyCode::EUR);     // constructor  
$currency = Currency::create(CurrencyCode::EUR); // static factory method
$currency = Currency::EUR();                     // short syntax with autocomplete on ::

// Currency code validation.
$currency = new Currency('EUE'); // throws InvalidCurrencyException

// Check whether the given Currency is USD/EUR/etc.
$currency = new Currency(CurrencyCode::EUR);
$currency->is(Currency::EUR()); // true
$currency->is(Currency::USD()); // false

License

iso-currency is licensed under the MIT license., _(*6)

, _(*7)

Source(s)

• "ISO 4217" by Wikipedia licensed under CC BY-SA 3.0 Unported License