search

moneyphp / money

PHP implementation of Fowler's Money pattern.
http://moneyphp.org
MIT License
4.6k stars 440 forks source link

Converter, convertAndReturnWithCurrencyPair and convertAgainstCurrencyPair methods #644

Closed frederikbosch closed 3 years ago

frederikbosch commented 3 years ago

Fixes #498, supersedes #502.

This PR provides:

  1. Converter#conversion to get a combination of Money and the CurrencyPair that was used for conversion.
  2. Converter#convertAgainst, to convert against a known CurrencyPair, and does make any call to an exchange

Why? When an amount is the result of a conversion, this amount usually saved together with the conversion rate. The method Converter#conversion helps to fulfill this need directly. While Converter#convertAgainst helps to convert an amount based on a saved CurrencyPair.

frederikbosch commented 3 years ago

@sagikazarmark @Ocramius This PR and probably a PR related to calculators will be the last PRs before tagging version 4.0 beta 1. Since @Ocramius contributed so much already, and therefore has specific knowledge of the upcoming release, I would kindly like to ask him if he is prepared to review this PR.

Ocramius commented 3 years ago

I read through it, but naming/API does not really makes much sense to me 🤔

frederikbosch commented 3 years ago

I agree. The names of the methods in the Converter class are too close. convert must stay for BC reasons, and I think that name fits the purpose. Maybe I should be more explicit for convertAgainst and change it into convertAgainstCurrencyPair.

But then what to do with conversion? I tried to lookup if there is a name inside the exchange domain that fits this purpose but I was not able to find it. It's like you stand at the counter of the exchange office and you have just received money in the new currency with a receipt that shows you the currency pair. What do you say of convertWithReceipt and return [Money, CurrencyPair]?

frederikbosch commented 3 years ago

The PR was updated with improved method names.