mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2024-12-25 08:21:08 -06:00
155 lines
4.7 KiB
PHP
155 lines
4.7 KiB
PHP
<?php
|
|
|
|
/**
|
|
* AmountFormat.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\Twig;
|
|
|
|
use FireflyIII\Models\Account as AccountModel;
|
|
use FireflyIII\Models\TransactionCurrency;
|
|
use FireflyIII\Repositories\Account\AccountRepositoryInterface;
|
|
use Twig\Extension\AbstractExtension;
|
|
use Twig\TwigFilter;
|
|
use Twig\TwigFunction;
|
|
|
|
/**
|
|
* Contains all amount formatting routines.
|
|
*/
|
|
class AmountFormat extends AbstractExtension
|
|
{
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function getFilters(): array
|
|
{
|
|
return [
|
|
$this->formatAmount(),
|
|
$this->formatAmountPlain(),
|
|
];
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function getFunctions(): array
|
|
{
|
|
return [
|
|
$this->formatAmountByAccount(),
|
|
$this->formatAmountBySymbol(),
|
|
$this->formatAmountByCurrency(),
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @return TwigFilter
|
|
*/
|
|
protected function formatAmount(): TwigFilter
|
|
{
|
|
return new TwigFilter(
|
|
'formatAmount',
|
|
static function (string $string): string {
|
|
$currency = app('amount')->getDefaultCurrency();
|
|
|
|
return app('amount')->formatAnything($currency, $string, true);
|
|
},
|
|
['is_safe' => ['html']]
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Will format the amount by the currency related to the given account.
|
|
*
|
|
* @return TwigFunction
|
|
* TODO remove me when layout v1 is deprecated.
|
|
*/
|
|
protected function formatAmountByAccount(): TwigFunction
|
|
{
|
|
return new TwigFunction(
|
|
'formatAmountByAccount',
|
|
static function (AccountModel $account, string $amount, bool $coloured = null): string {
|
|
$coloured = $coloured ?? true;
|
|
/** @var AccountRepositoryInterface $accountRepos */
|
|
$accountRepos = app(AccountRepositoryInterface::class);
|
|
$currency = $accountRepos->getAccountCurrency($account) ?? app('amount')->getDefaultCurrency();
|
|
|
|
return app('amount')->formatAnything($currency, $amount, $coloured);
|
|
},
|
|
['is_safe' => ['html']]
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Will format the amount by the currency related to the given account.
|
|
*
|
|
* @return TwigFunction
|
|
*/
|
|
protected function formatAmountByCurrency(): TwigFunction
|
|
{
|
|
return new TwigFunction(
|
|
'formatAmountByCurrency',
|
|
static function (TransactionCurrency $currency, string $amount, bool $coloured = null): string {
|
|
$coloured = $coloured ?? true;
|
|
|
|
return app('amount')->formatAnything($currency, $amount, $coloured);
|
|
},
|
|
['is_safe' => ['html']]
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Will format the amount by the currency related to the given account.
|
|
*
|
|
* @return TwigFunction
|
|
*/
|
|
protected function formatAmountBySymbol(): TwigFunction
|
|
{
|
|
return new TwigFunction(
|
|
'formatAmountBySymbol',
|
|
static function (string $amount, string $symbol, int $decimalPlaces = null, bool $coloured = null): string {
|
|
$decimalPlaces = $decimalPlaces ?? 2;
|
|
$coloured = $coloured ?? true;
|
|
$currency = new TransactionCurrency();
|
|
$currency->symbol = $symbol;
|
|
$currency->decimal_places = $decimalPlaces;
|
|
|
|
return app('amount')->formatAnything($currency, $amount, $coloured);
|
|
},
|
|
['is_safe' => ['html']]
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @return TwigFilter
|
|
*/
|
|
protected function formatAmountPlain(): TwigFilter
|
|
{
|
|
return new TwigFilter(
|
|
'formatAmountPlain',
|
|
static function (string $string): string {
|
|
$currency = app('amount')->getDefaultCurrency();
|
|
|
|
return app('amount')->formatAnything($currency, $string, false);
|
|
},
|
|
['is_safe' => ['html']]
|
|
);
|
|
}
|
|
}
|