harp-orm/money

Helper Traits for Sebastian Bergmann's Money

0.2.2 2014-08-28 11:58 UTC

Requires

• php: >=5.4.0
• clippings/currency-convert: ~0.1
• harp-orm/harp: ~0.3.2

BSD-3-Clause

• Ivan Kerin

README

Helper Traits for Sebastian Bergmann's Money

Usage

This adds "value" properties to your models, using traits. This is accomplished with ValueTrait and CurrencyTrait. The first adds the methods responsible for working with the Money objects, while CurencyTrait handles keeping tabs on which currency to use.

// Model Class
use Harp\Harp\AbstractModel;
use Harp\Money\ValueTrait;
use Harp\Money\CurrencyTrait;

class User extends AbstractModel
{
    use ValueTrait;
    use CurrencyTrait;

    public static function initialize($config)
    {
        // ...
        ValueTrait::initialize($config)
        CurrencyTrait::initialize($config)
    }
    // ...
}

Database Table:

┌─────────────────────────┐
│ Table: User             │
├─────────────┬───────────┤
│ id          │ ingeter   │
│ name        │ string    │
│ currency*   │ string    │
│ value*      │ integer   │
└─────────────┴───────────┘
* Required fields

Methods

ValueTrait Methods

CurrencyTrait Methods

Freezable

Using the FreezableTrait will allow you to easily freeze values in the database. You will need to implement performFreeze and performUnfreeze methods. Database Table:

┌─────────────────────────┐
│ Table: User             │
├─────────────┬───────────┤
│ id          │ ingeter   │
│ name        │ string    │
│ isFrozen*   │ integer   │
└─────────────┴───────────┘
* Required fields

FreezableTrait Methods

Freezable Value

This combines ValueTrait and FreezableTrait to allow you to "freeze" values in the model. It requires a getSourceValue which returns the dynamic value as a Money object. After "freeze" is called the result of getSourceValue is stored in the database, and subsequent calls to "getValue" will return the frozen value.

Additionally if the price from getSourceValue is with a different currency, use Converter class to convert the to the target currency.

FreezableTrait Methods

License

Copyright (c) 2014, Clippings Ltd. Developed by Ivan Kerin

Under BSD-3-Clause license, read LICENSE file.