skeeks/cms-module-money

Module for working with money and currency

Module for working with money and currency

Installation

The preferred way to install this extension is through composer., _(*1)

Either run, _(*2)

php composer.phar require --prefer-dist skeeks/cms-module-money "*"

or add, _(*3)

"skeeks/cms-module-money": "*"

Configuration app

'components' =>
[
 'money' => [
     'class'         => 'skeeks\modules\cms\money\components\money\Money',
 ],
 'i18n' => [
     'translations' =>
     [
         'skeeks/money' => [
             'class'             => 'yii\i18n\PhpMessageSource',
             'basePath'          => '@skeeks/modules/cms/money/messages',
             'fileMap' => [
                 'skeeks/money' => 'main.php',
             ],
         ]
     ]
 ],
],
'modules' =>
[
    'money' => [
        'class'         => 'skeeks\modules\cms\money\Module',
    ]
]

Links

• Web site
• Web site (rus)
• Author
• ChangeLog

Игформация о модуле

Модуль для работы с деньгами и валютой. За основу данного модуля, была взята библиотека https://github.com/sebastianbergmann/money, но ее пришлось изрядно допилить. Поэтому в чистом виде она не была подключена., _(*4)

Основная работа была в том, чтобы появилась некоторая прозрачная работа с деньгами. Типичны пример, который мы прозрачно решаем в этой библиотеке. (10$ + 154руб + 12$) = рузальтат нужно показать в GBP, для de_DE локали, _(*5)

Сразу пример:, _(*6)

use \skeeks\modules\cms\money\Money;
use \skeeks\modules\cms\money\IntlFormatter;

$money  = Money::fromString('10', "USD");
$money2 = Money::fromString('154', "EUR");
$money3 = Money::fromString('12', "EUR");

$money = $money->add($money2);
$money = $money->add($money3);

$money = $money->convertToCurrency('GBP');

$formatter = new IntlFormatter('de_DE');
$formatter->format($money); //результат 132,25 £

Установка

1) Стандартная установка через composer, _(*7)

php composer.phar require --prefer-dist skeeks/cms-module-money "*"

or add, _(*8)

"skeeks/cms-module-money": "*"

to the require section of your composer.json file., _(*9)

2) Установка миграций, _(*10)

 php yii migrate --migrationPath=vendor/skeeks/cms-module-money/migrations

Примеры и использование

Оригинальные примеры

Creating a Money object and accessing its monetary value

use skeeks\cms\modules\money\Currency;
use skeeks\cms\modules\money\Money;

// Create Money object that represents 1 EUR
$m = new Money(100, new Currency('EUR'));

// Access the Money object's monetary value
print $m->getAmount();

The code above produces the output shown below:, _(*11)

100

Creating a Money object from a string value

use skeeks\cms\modules\money\Currency;
use skeeks\cms\modules\money\Money;

// Create Money object that represents 12.34 EUR
$m = Money::fromString('12.34', new Currency('EUR'))

// Access the Money object's monetary value
print $m->getAmount();

The code above produces the output shown below:, _(*12)

1234

Using a Currency-specific subclass of Money

use skeeks\cms\modules\money\EUR;

// Create Money object that represents 1 EUR
$m = new EUR(100);

// Access the Money object's monetary value
print $m->getAmount();

The code above produces the output shown below:, _(*13)

100

Please note that there is no subclass of Money that is specific to Turkish Lira as TRY is not a valid class name in PHP., _(*14)

Formatting a Money object using PHP's built-in NumberFormatter

use skeeks\cms\modules\money\Currency;
use skeeks\cms\modules\money\Money;
use skeeks\cms\modules\money\IntlFormatter;

// Create Money object that represents 1 EUR
$m = new Money(100, new Currency('EUR'));

// Format a Money object using PHP's built-in NumberFormatter (German locale)
$f = new IntlFormatter('de_DE');

print $f->format($m);

The code above produces the output shown below:, _(*15)

1,00 €

Basic arithmetic using Money objects

use skeeks\cms\modules\money\Currency;
use skeeks\cms\modules\money\Money;

// Create two Money objects that represent 1 EUR and 2 EUR, respectively
$a = new Money(100, new Currency('EUR'));
$b = new Money(200, new Currency('EUR'));

// Negate a Money object
$c = $a->negate();
print $c->getAmount();

// Calculate the sum of two Money objects
$c = $a->add($b);
print $c->getAmount();

// Calculate the difference of two Money objects
$c = $b->subtract($a);
print $c->getAmount();

// Multiply a Money object with a factor
$c = $a->multiply(2);
print $c->getAmount();

The code above produces the output shown below:, _(*16)

-100
300
100
200

Comparing Money objects

use skeeks\cms\modules\money\Currency;
use skeeks\cms\modules\money\Money;

// Create two Money objects that represent 1 EUR and 2 EUR, respectively
$a = new Money(100, new Currency('EUR'));
$b = new Money(200, new Currency('EUR'));

var_dump($a->lessThan($b));
var_dump($a->greaterThan($b));

var_dump($b->lessThan($a));
var_dump($b->greaterThan($a));

var_dump($a->compareTo($b));
var_dump($a->compareTo($a));
var_dump($b->compareTo($a));

The code above produces the output shown below:, _(*17)

bool(true)
bool(false)
bool(false)
bool(true)
int(-1)
int(0)
int(1)

The compareTo() method returns an integer less than, equal to, or greater than zero if the value of one Money object is considered to be respectively less than, equal to, or greater than that of another Money object., _(*18)

You can use the compareTo() method to sort an array of Money objects using PHP's built-in sorting functions:, _(*19)

use skeeks\cms\modules\money\Currency;
use skeeks\cms\modules\money\Money;

$m = array(
    new Money(300, new Currency('EUR')),
    new Money(100, new Currency('EUR')),
    new Money(200, new Currency('EUR'))
);

usort(
    $m,
    function ($a, $b) { return $a->compareTo($b); }
);

foreach ($m as $_m) {
    print $_m->getAmount() . "\n";
}

The code above produces the output shown below:, _(*20)

100
200
300

Allocate the monetary value represented by a Money object among N targets

use skeeks\cms\modules\money\Currency;
use skeeks\cms\modules\money\Money;

// Create a Money object that represents 0,99 EUR
$a = new Money(99, new Currency('EUR'));

foreach ($a->allocateToTargets(10) as $t) {
    print $t->getAmount() . "\n";
}

The code above produces the output shown below:, _(*21)

10
10
10
10
10
10
10
10
10
9

Allocate the monetary value represented by a Money object using a list of ratios

use skeeks\cms\modules\money\Currency;
use skeeks\cms\modules\money\Money;

// Create a Money object that represents 0,05 EUR
$a = new Money(5, new Currency('EUR'));

foreach ($a->allocateByRatios(array(3, 7)) as $t) {
    print $t->getAmount() . "\n";
}

The code above produces the output shown below:, _(*22)

2
3

Extract a percentage (and a subtotal) from the monetary value represented by a Money object

use skeeks\cms\modules\money\Currency;
use skeeks\cms\modules\money\Money;

// Create a Money object that represents 100,00 EUR
$original = new Money(10000, new Currency('EUR'));

// Extract 21% (and the corresponding subtotal)
$extract = $original->extractPercentage(21);

printf(
    "%d = %d + %d\n",
    $original->getAmount(),
    $extract['subtotal']->getAmount(),
    $extract['percentage']->getAmount()
);

The code above produces the output shown below:, _(*23)

10000 = 8265 + 1735

Please note that this extracts the percentage out of a monetary value where the percentage is already included. If you want to get the percentage of the monetary value you should use multiplication (multiply(0.21), for instance, to calculate 21% of a monetary value represented by a Money object) instead., _(*24)

Страница на SkeekS CMS Marketplace, _(*25)

SkeekS CMS (Yii2) — быстро, просто, эффективно!
skeeks.com | cms.skeeks.com | marketplace.cms.skeeks.com, _(*26)