mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-10-31 02:36:28 +00:00
276 lines
9.2 KiB
PHP
276 lines
9.2 KiB
PHP
<?php
|
|
|
|
/**
|
|
* Amount.php
|
|
* Copyright (c) 2019 james@firefly-iii.org
|
|
*
|
|
* This file is part of Firefly III (https://github.com/firefly-iii).
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as
|
|
* published by the Free Software Foundation, either version 3 of the
|
|
* License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
*/
|
|
declare(strict_types=1);
|
|
|
|
namespace FireflyIII\Support;
|
|
|
|
use FireflyIII\Exceptions\FireflyException;
|
|
use FireflyIII\Models\TransactionCurrency;
|
|
use FireflyIII\Models\UserGroup;
|
|
use FireflyIII\User;
|
|
use Illuminate\Support\Collection;
|
|
|
|
/**
|
|
* Class Amount.
|
|
*/
|
|
class Amount
|
|
{
|
|
/**
|
|
* This method will properly format the given number, in color or "black and white",
|
|
* as a currency, given two things: the currency required and the current locale.
|
|
*
|
|
* @throws FireflyException
|
|
*/
|
|
public function formatAnything(TransactionCurrency $format, string $amount, ?bool $coloured = null): string
|
|
{
|
|
return $this->formatFlat($format->symbol, $format->decimal_places, $amount, $coloured);
|
|
}
|
|
|
|
/**
|
|
* This method will properly format the given number, in color or "black and white",
|
|
* as a currency, given two things: the currency required and the current locale.
|
|
*
|
|
* @throws FireflyException
|
|
*
|
|
* @SuppressWarnings(PHPMD.MissingImport)
|
|
*/
|
|
public function formatFlat(string $symbol, int $decimalPlaces, string $amount, ?bool $coloured = null): string
|
|
{
|
|
$locale = app('steam')->getLocale();
|
|
$rounded = app('steam')->bcround($amount, $decimalPlaces);
|
|
$coloured ??= true;
|
|
|
|
$fmt = new \NumberFormatter($locale, \NumberFormatter::CURRENCY);
|
|
$fmt->setSymbol(\NumberFormatter::CURRENCY_SYMBOL, $symbol);
|
|
$fmt->setAttribute(\NumberFormatter::MIN_FRACTION_DIGITS, $decimalPlaces);
|
|
$fmt->setAttribute(\NumberFormatter::MAX_FRACTION_DIGITS, $decimalPlaces);
|
|
$result = (string) $fmt->format((float) $rounded); // intentional float
|
|
|
|
if (true === $coloured) {
|
|
if (1 === bccomp($rounded, '0')) {
|
|
return sprintf('<span class="text-success money-positive">%s</span>', $result);
|
|
}
|
|
if (-1 === bccomp($rounded, '0')) {
|
|
return sprintf('<span class="text-danger money-negative">%s</span>', $result);
|
|
}
|
|
|
|
return sprintf('<span class="money-neutral">%s</span>', $result);
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
public function formatByCurrencyId(int $currencyId, string $amount, ?bool $coloured = null): string
|
|
{
|
|
$format = TransactionCurrency::find($currencyId);
|
|
|
|
return $this->formatFlat($format->symbol, $format->decimal_places, $amount, $coloured);
|
|
}
|
|
|
|
public function getAllCurrencies(): Collection
|
|
{
|
|
return TransactionCurrency::orderBy('code', 'ASC')->get();
|
|
}
|
|
|
|
public function getCurrencies(): Collection
|
|
{
|
|
/** @var User $user */
|
|
$user = auth()->user();
|
|
|
|
return $user->currencies()->orderBy('code', 'ASC')->get();
|
|
}
|
|
|
|
public function getDefaultCurrency(): TransactionCurrency
|
|
{
|
|
/** @var User $user */
|
|
$user = auth()->user();
|
|
|
|
return $this->getDefaultCurrencyByUserGroup($user->userGroup);
|
|
}
|
|
|
|
public function getDefaultCurrencyByUserGroup(UserGroup $userGroup): TransactionCurrency
|
|
{
|
|
$cache = new CacheProperties();
|
|
$cache->addProperty('getDefaultCurrencyByGroup');
|
|
$cache->addProperty($userGroup->id);
|
|
if ($cache->has()) {
|
|
return $cache->get();
|
|
}
|
|
$default = $userGroup->currencies()->where('group_default', true)->first();
|
|
if (null === $default) {
|
|
$default = $this->getSystemCurrency();
|
|
// could be the user group has no default right now.
|
|
$userGroup->currencies()->sync([$default->id => ['group_default' => true]]);
|
|
}
|
|
$cache->store($default);
|
|
|
|
return $default;
|
|
}
|
|
|
|
public function getSystemCurrency(): TransactionCurrency
|
|
{
|
|
return TransactionCurrency::where('code', 'EUR')->first();
|
|
}
|
|
|
|
/**
|
|
* @deprecated use getDefaultCurrencyByUserGroup instead
|
|
*/
|
|
public function getDefaultCurrencyByUser(User $user): TransactionCurrency
|
|
{
|
|
return $this->getDefaultCurrencyByUserGroup($user->userGroup);
|
|
}
|
|
|
|
/**
|
|
* This method returns the correct format rules required by accounting.js,
|
|
* the library used to format amounts in charts.
|
|
*
|
|
* Used only in one place.
|
|
*
|
|
* @throws FireflyException
|
|
*/
|
|
public function getJsConfig(): array
|
|
{
|
|
$config = $this->getLocaleInfo();
|
|
$negative = self::getAmountJsConfig($config['n_sep_by_space'], $config['n_sign_posn'], $config['negative_sign'], $config['n_cs_precedes']);
|
|
$positive = self::getAmountJsConfig($config['p_sep_by_space'], $config['p_sign_posn'], $config['positive_sign'], $config['p_cs_precedes']);
|
|
|
|
return [
|
|
'mon_decimal_point' => $config['mon_decimal_point'],
|
|
'mon_thousands_sep' => $config['mon_thousands_sep'],
|
|
'format' => [
|
|
'pos' => $positive,
|
|
'neg' => $negative,
|
|
'zero' => $positive,
|
|
],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @throws FireflyException
|
|
*
|
|
* @SuppressWarnings(PHPMD.MissingImport)
|
|
*/
|
|
private function getLocaleInfo(): array
|
|
{
|
|
// get config from preference, not from translation:
|
|
$locale = app('steam')->getLocale();
|
|
$array = app('steam')->getLocaleArray($locale);
|
|
|
|
setlocale(LC_MONETARY, $array);
|
|
$info = localeconv();
|
|
|
|
// correct variables
|
|
$info['n_cs_precedes'] = $this->getLocaleField($info, 'n_cs_precedes');
|
|
$info['p_cs_precedes'] = $this->getLocaleField($info, 'p_cs_precedes');
|
|
|
|
$info['n_sep_by_space'] = $this->getLocaleField($info, 'n_sep_by_space');
|
|
$info['p_sep_by_space'] = $this->getLocaleField($info, 'p_sep_by_space');
|
|
|
|
$fmt = new \NumberFormatter($locale, \NumberFormatter::CURRENCY);
|
|
|
|
$info['mon_decimal_point'] = $fmt->getSymbol(\NumberFormatter::MONETARY_SEPARATOR_SYMBOL);
|
|
$info['mon_thousands_sep'] = $fmt->getSymbol(\NumberFormatter::MONETARY_GROUPING_SEPARATOR_SYMBOL);
|
|
|
|
return $info;
|
|
}
|
|
|
|
private function getLocaleField(array $info, string $field): bool
|
|
{
|
|
return (is_bool($info[$field]) && true === $info[$field])
|
|
|| (is_int($info[$field]) && 1 === $info[$field]);
|
|
}
|
|
|
|
/**
|
|
* bool $sepBySpace is $localeconv['n_sep_by_space']
|
|
* int $signPosn = $localeconv['n_sign_posn']
|
|
* string $sign = $localeconv['negative_sign']
|
|
* bool $csPrecedes = $localeconv['n_cs_precedes'].
|
|
*/
|
|
public static function getAmountJsConfig(bool $sepBySpace, int $signPosn, string $sign, bool $csPrecedes): string
|
|
{
|
|
// negative first:
|
|
$space = ' ';
|
|
|
|
// require space between symbol and amount?
|
|
if (false === $sepBySpace) {
|
|
$space = ''; // no
|
|
}
|
|
|
|
// there are five possible positions for the "+" or "-" sign (if it is even used)
|
|
// pos_a and pos_e could be the ( and ) symbol.
|
|
$posA = ''; // before everything
|
|
$posB = ''; // before currency symbol
|
|
$posC = ''; // after currency symbol
|
|
$posD = ''; // before amount
|
|
$posE = ''; // after everything
|
|
|
|
// format would be (currency before amount)
|
|
// AB%sC_D%vE
|
|
// or:
|
|
// AD%v_B%sCE (amount before currency)
|
|
// the _ is the optional space
|
|
|
|
// switch on how to display amount:
|
|
switch ($signPosn) {
|
|
default:
|
|
case 0:
|
|
// ( and ) around the whole thing
|
|
$posA = '(';
|
|
$posE = ')';
|
|
|
|
break;
|
|
|
|
case 1:
|
|
// The sign string precedes the quantity and currency_symbol
|
|
$posA = $sign;
|
|
|
|
break;
|
|
|
|
case 2:
|
|
// The sign string succeeds the quantity and currency_symbol
|
|
$posE = $sign;
|
|
|
|
break;
|
|
|
|
case 3:
|
|
// The sign string immediately precedes the currency_symbol
|
|
$posB = $sign;
|
|
|
|
break;
|
|
|
|
case 4:
|
|
// The sign string immediately succeeds the currency_symbol
|
|
$posC = $sign;
|
|
}
|
|
|
|
// default is amount before currency
|
|
$format = $posA.$posD.'%v'.$space.$posB.'%s'.$posC.$posE;
|
|
|
|
if ($csPrecedes) {
|
|
// alternative is currency before amount
|
|
$format = $posA.$posB.'%s'.$posC.$space.$posD.'%v'.$posE;
|
|
}
|
|
|
|
return $format;
|
|
}
|
|
}
|