Viewing file:  Teller.php (12.94 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
declare(strict_types=1);
namespace Money;
use Money\Currencies\ISOCurrencies;
use Money\Formatter\DecimalMoneyFormatter;
use Money\Parser\DecimalMoneyParser;
use function array_shift;
use function is_float;
final class Teller
{
/**
* Convenience factory method for a Teller object.
*
* <code>
* $teller = Teller::USD();
* </code>
*
* @param non-empty-string $method
* @param array{0?: int} $arguments
*
* @return Teller
*/
public static function __callStatic(string $method, array $arguments): self
{
$currency = new Currency($method);
$currencies = new ISOCurrencies();
$parser = new DecimalMoneyParser($currencies);
$formatter = new DecimalMoneyFormatter($currencies);
$roundingMode = empty($arguments)
? Money::ROUND_HALF_UP
: (int) array_shift($arguments);
return new self(
$currency,
$parser,
$formatter,
$roundingMode
);
}
private Currency $currency;
private MoneyFormatter $formatter;
private MoneyParser $parser;
private int $roundingMode = Money::ROUND_HALF_UP;
public function __construct(
Currency $currency,
MoneyParser $parser,
MoneyFormatter $formatter,
int $roundingMode = Money::ROUND_HALF_UP
) {
$this->currency = $currency;
$this->parser = $parser;
$this->formatter = $formatter;
$this->roundingMode = $roundingMode;
}
/**
* Are two monetary amounts equal to each other?
*
* @param mixed $amount a monetary amount
* @param mixed $other another monetary amount
*/
public function equals(mixed $amount, mixed $other): bool
{
return $this->convertToMoney($amount)->equals(
$this->convertToMoney($other)
);
}
/**
* Returns an integer less than, equal to, or greater than zero if a
* monetary amount is respectively less than, equal to, or greater than
* another.
*
* @param mixed $amount a monetary amount
* @param mixed $other another monetary amount
*/
public function compare(mixed $amount, mixed $other): int
{
return $this->convertToMoney($amount)->compare(
$this->convertToMoney($other)
);
}
/**
* Is one monetary amount greater than another?
*
* @param mixed $amount a monetary amount
* @param mixed $other another monetary amount
*/
public function greaterThan(mixed $amount, mixed $other): bool
{
return $this->convertToMoney($amount)->greaterThan(
$this->convertToMoney($other)
);
}
/**
* Is one monetary amount greater than or equal to another?
*
* @param mixed $amount a monetary amount
* @param mixed $other another monetary amount
*/
public function greaterThanOrEqual(mixed $amount, mixed $other): bool
{
return $this->convertToMoney($amount)->greaterThanOrEqual(
$this->convertToMoney($other)
);
}
/**
* Is one monetary amount less than another?
*
* @param mixed $amount a monetary amount
* @param mixed $other another monetary amount
*/
public function lessThan(mixed $amount, mixed $other): bool
{
return $this->convertToMoney($amount)->lessThan(
$this->convertToMoney($other)
);
}
/**
* Is one monetary amount less than or equal to another?
*
* @param mixed $amount a monetary amount
* @param mixed $other another monetary amount
*/
public function lessThanOrEqual(mixed $amount, mixed $other): bool
{
return $this->convertToMoney($amount)->lessThanOrEqual(
$this->convertToMoney($other)
);
}
/**
* Adds a series of monetary amounts to each other in sequence.
*
* @param mixed $amount a monetary amount
* @param mixed $other another monetary amount
* @param mixed[] $others subsequent other monetary amounts
*
* @return string the calculated monetary amount
*/
public function add(mixed $amount, mixed $other, mixed ...$others): string
{
return $this->convertToString(
$this->convertToMoney($amount)->add(
$this->convertToMoney($other),
...$this->convertToMoneyArray($others)
)
);
}
/**
* Subtracts a series of monetary amounts from each other in sequence.
*
* @param mixed $amount a monetary amount
* @param mixed $other another monetary amount
* @param mixed[] $others subsequent monetary amounts
*/
public function subtract(mixed $amount, mixed $other, mixed ...$others): string
{
return $this->convertToString(
$this->convertToMoney($amount)->subtract(
$this->convertToMoney($other),
...$this->convertToMoneyArray($others)
)
);
}
/**
* Multiplies a monetary amount by a factor.
*
* @param mixed $amount a monetary amount
* @param int|float|numeric-string $multiplier the multiplier
*/
public function multiply(mixed $amount, int|float|string $multiplier): string
{
$multiplier = is_float($multiplier) ? Number::fromFloat($multiplier) : Number::fromNumber($multiplier);
return $this->convertToString(
$this->convertToMoney($amount)->multiply(
(string) $multiplier,
$this->roundingMode
)
);
}
/**
* Divides a monetary amount by a divisor.
*
* @param mixed $amount a monetary amount
* @param int|float|numeric-string $divisor the divisor
*/
public function divide(mixed $amount, int|float|string $divisor): string
{
$divisor = is_float($divisor) ? Number::fromFloat($divisor) : Number::fromNumber($divisor);
return $this->convertToString(
$this->convertToMoney($amount)->divide(
(string) $divisor,
$this->roundingMode
)
);
}
/**
* Mods a monetary amount by a divisor.
*
* @param mixed $amount a monetary amount
* @param int|float|numeric-string $divisor the divisor
*/
public function mod(mixed $amount, int|float|string $divisor): string
{
$divisor = is_float($divisor) ? Number::fromFloat($divisor) : Number::fromNumber($divisor);
return $this->convertToString(
$this->convertToMoney($amount)->mod(
$this->convertToMoney((string) $divisor)
)
);
}
/**
* Allocates a monetary amount according to an array of ratios.
*
* @param mixed $amount a monetary amount
* @param non-empty-array<array-key, float|int> $ratios an array of ratios
*
* @return string[] the calculated monetary amounts
*/
public function allocate(mixed $amount, array $ratios): array
{
return $this->convertToStringArray(
$this->convertToMoney($amount)->allocate($ratios)
);
}
/**
* Allocates a monetary amount among N targets.
*
* @param mixed $amount a monetary amount
* @psalm-param positive-int $n the number of targets
*
* @return string[] the calculated monetary amounts
*/
public function allocateTo(mixed $amount, int $n): array
{
return $this->convertToStringArray(
$this->convertToMoney($amount)->allocateTo($n)
);
}
/**
* Determines the ratio of one monetary amount to another.
*
* @param mixed $amount a monetary amount
* @param mixed $other another monetary amount
*/
public function ratioOf(mixed $amount, mixed $other): string
{
return $this->convertToString(
$this->convertToMoney($amount)->ratioOf(
$this->convertToMoney($other)
)
);
}
/**
* Returns an absolute monetary amount.
*
* @param mixed $amount a monetary amount
*/
public function absolute(mixed $amount): string
{
return $this->convertToString(
$this->convertToMoney($amount)->absolute()
);
}
/**
* Returns the negative of an amount; note that this will convert negative
* amounts to positive ones.
*
* @param mixed $amount a monetary amount
*/
public function negative(mixed $amount): string
{
return $this->convertToString(
$this->convertToMoney($amount)->negative()
);
}
/**
* Is a monetary amount equal to zero?
*
* @param mixed $amount a monetary amount
*/
public function isZero(mixed $amount): bool
{
return $this->convertToMoney($amount)->isZero();
}
/**
* Is a monetary amount greater than zero?
*
* @param mixed $amount a monetary amount
*/
public function isPositive(mixed $amount): bool
{
return $this->convertToMoney($amount)->isPositive();
}
/**
* Is a monetary amount less than zero?
*
* @param mixed $amount a monetary amount
*/
public function isNegative(mixed $amount): bool
{
return $this->convertToMoney($amount)->isNegative();
}
/**
* Returns the lowest of a series of monetary amounts.
*
* @param mixed $amount a monetary amount
* @param mixed ...$amounts additional monetary amounts
*/
public function min(mixed $amount, mixed ...$amounts): string
{
return $this->convertToString(
Money::min(
$this->convertToMoney($amount),
...$this->convertToMoneyArray($amounts)
)
);
}
/**
* Returns the highest of a series of monetary amounts.
*
* @param mixed $amount a monetary amount
* @param mixed ...$amounts additional monetary amounts
*/
public function max(mixed $amount, mixed ...$amounts): string
{
return $this->convertToString(
Money::max(
$this->convertToMoney($amount),
...$this->convertToMoneyArray($amounts)
)
);
}
/**
* Returns the sum of a series of monetary amounts.
*
* @param mixed $amount a monetary amount
* @param mixed ...$amounts additional monetary amounts
*/
public function sum(mixed $amount, mixed ...$amounts): string
{
return $this->convertToString(
Money::sum(
$this->convertToMoney($amount),
...$this->convertToMoneyArray($amounts)
)
);
}
/**
* Returns the average of a series of monetary amounts.
*
* @param mixed $amount a monetary amount
* @param mixed ...$amounts additional monetary amounts
*/
public function avg(mixed $amount, mixed ...$amounts): string
{
return $this->convertToString(
Money::avg(
$this->convertToMoney($amount),
...$this->convertToMoneyArray($amounts)
)
);
}
/**
* Converts a monetary amount to a Money object.
*
* @param mixed $amount a monetary amount
*/
public function convertToMoney(mixed $amount): Money
{
return $this->parser->parse((string) $amount, $this->currency);
}
/**
* Converts an array of monetary amounts to an array of Money objects.
*
* @param array<int|string, mixed> $amounts an array of monetary amounts
*
* @return Money[]
*/
public function convertToMoneyArray(array $amounts): array
{
$converted = [];
/** @var mixed $amount */
foreach ($amounts as $key => $amount) {
$converted[$key] = $this->convertToMoney($amount);
}
return $converted;
}
/**
* Converts a monetary amount into a Money object, then into a string.
*
* @param mixed $amount typically a Money object, int, float, or string
* representing a monetary amount
*/
public function convertToString(mixed $amount): string
{
if ($amount instanceof Money === false) {
$amount = $this->convertToMoney($amount);
}
return $this->formatter->format($amount);
}
/**
* Converts an array of monetary amounts into Money objects, then into
* strings.
*
* @param array<int|string, mixed> $amounts an array of monetary amounts
*
* @return string[]
*/
public function convertToStringArray(array $amounts): array
{
$converted = [];
/** @var mixed $amount */
foreach ($amounts as $key => $amount) {
$converted[$key] = $this->convertToString($amount);
}
return $converted;
}
/**
* Returns a "zero" monetary amount.
*/
public function zero(): string
{
return '0.00';
}
}
|