jjsm01/kimai2
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

invoices: unified money, number and date formats and fully respect configured language (#1814)

Browse Source
This commit is contained in:
Kevin Papst
2020-07-10 15:09:52 +02:00
committed by GitHub
parent 19e4ebf88c
commit 32c1e3258e
67 changed files with 1593 additions and 2335 deletions
Download Patch File Download Diff File Expand all files Collapse all files

213
src/Twig/Extensions.php
View File

@@ -10,14 +10,6 @@
namespace App\Twig;
use App\Constants;
use App\Entity\Timesheet;
use App\Utils\Duration;
use App\Utils\LocaleSettings;
use NumberFormatter;
use Symfony\Component\Intl\Countries;
use Symfony\Component\Intl\Currencies;
use Symfony\Component\Intl\Languages;
use Symfony\Component\Intl\Locales;
use Twig\Extension\AbstractExtension;
use Twig\TwigFilter;
use Twig\TwigFunction;
@@ -27,49 +19,12 @@ use Twig\TwigFunction;
*/
class Extensions extends AbstractExtension
{
/**
* @var LocaleSettings
*/
protected $localeSettings;
/**
* @var string
*/
protected $locale;
/**
* @var Duration
*/
protected $durationFormatter;
/**
* @var NumberFormatter
*/
protected $numberFormatter;
/**
* @var NumberFormatter
*/
protected $moneyFormatter;
/**
* @param LocaleSettings $localeSettings
*/
public function __construct(LocaleSettings $localeSettings)
{
$this->localeSettings = $localeSettings;
$this->durationFormatter = new Duration();
}
/**
* {@inheritdoc}
*/
public function getFilters()
{
return [
new TwigFilter('duration', [$this, 'duration']),
new TwigFilter('duration_decimal', [$this, 'durationDecimal']),
new TwigFilter('money', [$this, 'money']),
new TwigFilter('currency', [$this, 'currency']),
new TwigFilter('country', [$this, 'country']),
new TwigFilter('language', [$this, 'language']),
new TwigFilter('amount', [$this, 'amount']),
new TwigFilter('docu_link', [$this, 'documentationLink']),
new TwigFilter('multiline_indent', [$this, 'multilineIndent']),
];
@@ -81,7 +36,6 @@ class Extensions extends AbstractExtension
public function getFunctions()
{
return [
new TwigFunction('locales', [$this, 'getLocales']),
new TwigFunction('class_name', [$this, 'getClassName']),
];
}
@@ -120,115 +74,6 @@ class Extensions extends AbstractExtension
return implode(PHP_EOL, $parts);
}
/**
* Transforms seconds into a duration string.
*
* @param int|Timesheet $duration
* @param bool $decimal
* @return string
*/
public function duration($duration, $decimal = false)
{
if ($decimal) {
return $this->durationDecimal($duration);
}
$duration = $this->getSecondsForDuration($duration);
$format = $this->localeSettings->getDurationFormat();
return $this->formatDuration($duration, $format);
}
/**
* Transforms seconds into a decimal formatted duration string.
*
* @param int|Timesheet $duration
* @return string
*/
public function durationDecimal($duration)
{
$duration = $this->getSecondsForDuration($duration);
return $this->getNumberFormatter()->format(number_format($duration / 3600, 2));
}
/**
* @param string|float $amount
* @return bool|false|string
*/
public function amount($amount)
{
return $this->getNumberFormatter()->format($amount);
}
private function getSecondsForDuration($duration): int
{
if (null === $duration) {
$duration = 0;
}
if ($duration instanceof Timesheet) {
if (null === $duration->getEnd()) {
$duration = time() - $duration->getBegin()->getTimestamp();
} else {
$duration = $duration->getDuration();
}
}
return (int) $duration;
}
protected function formatDuration(int $seconds, string $format): string
{
if ($seconds < 0) {
return '?';
}
return $this->durationFormatter->format($seconds, $format);
}
/**
* @param string $currency
* @return string
*/
public function currency($currency)
{
try {
return Currencies::getSymbol(strtoupper($currency));
} catch (\Exception $ex) {
}
return $currency;
}
/**
* @param string $language
* @return string
*/
public function language($language)
{
try {
return Languages::getName(strtolower($language), $this->locale);
} catch (\Exception $ex) {
}
return $language;
}
/**
* @param string $country
* @return string
*/
public function country($country)
{
try {
return Countries::getName(strtoupper($country));
} catch (\Exception $ex) {
}
return $country;
}
/**
* @param string $url
* @return string
@@ -237,62 +82,4 @@ class Extensions extends AbstractExtension
{
return Constants::HOMEPAGE . '/documentation/' . $url;
}
private function initLocale()
{
$locale = $this->localeSettings->getLocale();
if ($this->locale === $locale) {
return;
}
$this->locale = $locale;
$this->numberFormatter = new NumberFormatter($locale, NumberFormatter::DECIMAL);
$this->moneyFormatter = new NumberFormatter($locale, NumberFormatter::CURRENCY);
}
private function getNumberFormatter(): NumberFormatter
{
$this->initLocale();
return $this->numberFormatter;
}
private function getMoneyFormatter(): NumberFormatter
{
$this->initLocale();
return $this->moneyFormatter;
}
/**
* @param float $amount
* @param string $currency
* @return string
*/
public function money($amount, $currency = null)
{
if (null !== $currency) {
return $this->getMoneyFormatter()->formatCurrency($amount, $currency);
}
return $this->getNumberFormatter()->format($amount);
}
/**
* Takes the list of codes of the locales (languages) enabled in the
* application and returns an array with the name of each locale written
* in its own language (e.g. English, Français, Español, etc.)
*
* @return array
*/
public function getLocales()
{
$locales = [];
foreach ($this->localeSettings->getAvailableLanguages() as $locale) {
$locales[] = ['code' => $locale, 'name' => Locales::getName($locale, $locale)];
}
return $locales;
}
}