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

Method	Description
getValue()	Return a new Money object that represents the value property in the model, using the currency object returned from a "getCurrency" method.
setValue(Money $money)	Set the parent model

CurrencyTrait Methods

Method	Description
getCurrency()	Return a new Currency object, based on the currency property in the model

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

Method	Description
freeze()	call the `performFreeze` method if the model is not "frozen", e.g. isFrozen property is false. And set isFrozen to true after `performFreeze` is called
unfreeze()	call the `performUnfreeze` method if the model is "frozen", e.g. isFrozen property is true. And set isFrozen to false after `performUnfreeze` is called

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

Method	Description
freeze()	From FreezableTrait
unfreeze()	From FreezableTrait
setValue()	From ValueTrait
getValue(Money $money)	From ValueTrait
getConvertedSourceValue()	return a Money object from getSourceValue converted to a proper currency with
performFreeze()	implements a FreezableTrait requirement, saves the value
performUnfreeze()	implements a FreezableTrait requirement, clears the value frozen in the database

License

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

harp-orm / money

Maintainers

Details