Download the PHP package byrokrat/amount without Composer
On this page you can find all versions of the php package byrokrat/amount. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download byrokrat/amount
More information about byrokrat/amount
Files in byrokrat/amount
Package amount
Short Description Value objects for monetary amounts
License Unlicense
Homepage https://github.com/byrokrat/amount
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package amount
ABANDONED! This package is discontinued and will not be updated. See moneyphp/money instead.
Amount
Value objects for monetary amounts.
Features
- Immutable value object.
- Using the bcmath extension for arbitrary floating point arithmetic precision.
- Currency support to prevent mixing currencies.
- Out of the box support for ISO 4217 currencies.
- Simple interface for defining new currencies.
- Support for multiple rounding strategies.
- Support for allocating amounts based on ratios.
- Support for the signal string format as used in the swedish direct debit system.
Installation
Usage
API
Amount defines the following api:
| Method signature | returns | description |
|---|---|---|
| __construct(string $amount) | Amount | Create new instance |
| getAmount() | string | Get raw amount |
| roundTo([int $precision, [Rounder $rounder]]) | Amount | Get new Amount rounded to $precision |
| getString([int $precision, [Rounder $rounder]]) | string | Get amount as string |
| __tostring() | string | Get amount as string |
| getInt([Rounder $rounder]) | integer | Get amount as integer (WARNING) |
| getFloat([int $precision, [Rounder $rounder]]) | float | Get amount as float (WARNING) |
| getSignalString([Rounder $rounder]) | string | Get amount as a signal string |
| add(Amount $amount) | Amount | Get new Amount with $amount added |
| subtract(Amount $amount) | Amount | Get new Amount with $amount subtracted |
| multiplyWith(mixed $amount) | Amount | Get new Amount multiplied with $amount |
| divideBy(mixed $amount) | Amount | Get new Amount divided by $amount |
| compareTo(Amount $amount) | integer | 0 if equals, 1 if greater, -1 otherwise |
| equals(Amount $amount) | boolean | Check if equals amount |
| isLessThan(Amount $amount) | boolean | Check if less than amount |
| isLessThanOrEquals(Amount $amount) | boolean | Check if less than or equals amount |
| isGreaterThan(Amount $amount) | boolean | Check if greater than amount |
| isGreaterThanOrEquals(Amount $amount) | boolean | Check if greater than or equals amount |
| isZero() | boolean | Check if amount is zero |
| isPositive() | boolean | Check if amount is greater than zero |
| isNegative() | boolean | Check if amount is less than zero |
| getInverted() | Amount | Get new amount with sign inverted |
| getAbsolute() | Amount | Get new amount with negative sign removed |
| allocate(array $ratios, [int $precision]) | Amount[] | Allocate amount based on list of ratios |
Creating Amounts from other formats
Floating point numbers
Amount contains two convenience methods for working with floating point numbers.
createFromNumber can create an Amount object from a floating point number,
getFloat can convert an Amount object to a float. These methods should be used
with care.
It is important to note that computers internally use the binary floating
point format and cannot accurately represent a number like 0.1, 0.2 or
0.3 at all. Using floating point numbers leads to a loss of precision.
For example floor((0.1+0.7)*10) will usually return 7 instead of the
expected 8, since the internal representation will be something like
7.9999999999999991118....
For this reason floats should never ne used to store monetary data. These methods exists for rare situations when converting to or from native formats is inevitable. Unless you know what you are doing they should NOT be used.
For more information see the php manual or What Every Programmer Should Know About Floating-Point Arithmetic.
Formatted numbers
You can create Amounts from strings formatted with non-standard or locale dependent decimal point and grouping characters using the static method createFromFormat.
Signal strings
The signal string format contans no decimal point and negative amounts are signaled using a letter instead of the final digit. Create Amounts from signal strings using the static method createFromSignalString.
Working with currencies
The currency subsystem helps prevent bugs where values in different currencies are
mixed (for example added together). Currency objects subclass Amount and works in
the same way, with the added feature that they know their defined currency.
ISO 4217
A comprehensive set of ISO 4217 currencies are bundled in the
byrokrat\amount\Currency namespace.
Please note that the Turkish Lira with the ISO code TRY is represented as
_TRY as try is a reserved keyword.
Creating new currencies
Creating new currencies however is straight forward. Simply subclass the
Currency class and define getCurrencyCode().
Additionaly you may override getDisplayPrecision(), getInternalPrecision() and
getDefaultRounder() to further define your currency's behaviour.
Exchanging
Exchanging currencies is supported using createFromExchange. Note that you must
supply the correct exchange rate.
Formatting currencies
Currency objects can easily be formatted using php's built in NumberFormatter.
Rounding
A number of rounding strategies are supported. To implement your own see the Rounder interface.
For more info on rounding strategies see wikipedia.
Allocating
Allocating is the process of dividing an amount based on ratios in such a way that the smallest unit is not divided (every currency has a smallest unit that is non-dividable) but instead handed to the receiver next in line.
The ratios can be seen as (but does not have to be) percentages. A hundred units can thous be divided to two receivers as
The strength of allocating becomes clear when we distribute a value that we are not able to divide evenly. In this case the order of the receivers is significant.
In these examples the undividable unit used is 0.01. This is the default behaviour.
Change it either by specifying the $precision parameter or by overriding
getDisplayPrecision() in your currency class.
All versions of amount with dependencies
ext-bcmath Version *