Part-DB.Part-DB-server/src/Twig/FormatExtension.php

90 lines
3.9 KiB
PHP
Raw Normal View History

<?php
2020-02-22 18:14:36 +01:00
/**
* This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
*
2022-11-29 22:28:53 +01:00
* Copyright (C) 2019 - 2022 Jan Böhmer (https://github.com/jbtronics)
2020-02-22 18:14:36 +01:00
*
* 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/>.
*/
2020-01-05 15:46:58 +01:00
declare(strict_types=1);
namespace App\Twig;
use App\Entity\Parts\MeasurementUnit;
use App\Entity\PriceInformations\Currency;
2022-12-18 17:28:42 +01:00
use App\Services\Formatters\AmountFormatter;
use App\Services\Formatters\MarkdownParser;
use App\Services\Formatters\MoneyFormatter;
use App\Services\Formatters\SIFormatter;
use Brick\Math\BigDecimal;
use Twig\Extension\AbstractExtension;
use Twig\TwigFilter;
2022-08-14 19:32:53 +02:00
2022-09-18 17:50:25 +02:00
final class FormatExtension extends AbstractExtension
{
public function __construct(protected MarkdownParser $markdownParser, protected MoneyFormatter $moneyFormatter, protected SIFormatter $siformatter, protected AmountFormatter $amountFormatter)
{
}
2022-08-14 19:09:07 +02:00
public function getFilters(): array
{
return [
2022-09-18 17:50:25 +02:00
/* Mark the given text as markdown, which will be rendered in the browser */
new TwigFilter('format_markdown', fn(string $markdown, bool $inline_mode = false): string => $this->markdownParser->markForRendering($markdown, $inline_mode), [
2020-01-05 22:49:00 +01:00
'pre_escape' => 'html',
'is_safe' => ['html'],
]),
2022-09-18 17:50:25 +02:00
/* Format the given amount as money, using a given currency */
new TwigFilter('format_money', fn($amount, ?\App\Entity\PriceInformations\Currency $currency = null, int $decimals = 5): string => $this->formatCurrency($amount, $currency, $decimals)),
2022-09-18 17:50:25 +02:00
/* Format the given number using SI prefixes and the given unit (string) */
new TwigFilter('format_si', fn($value, $unit, $decimals = 2, bool $show_all_digits = false): string => $this->siFormat($value, $unit, $decimals, $show_all_digits)),
2022-09-18 17:50:25 +02:00
/** Format the given amount using the given MeasurementUnit */
new TwigFilter('format_amount', fn($value, ?\App\Entity\Parts\MeasurementUnit $unit, array $options = []): string => $this->amountFormat($value, $unit, $options)),
2023-04-15 23:14:53 +02:00
/** Format the given number of bytes as human-readable number */
new TwigFilter('format_bytes', fn(int $bytes, int $precision = 2): string => $this->formatBytes($bytes, $precision)),
];
}
2020-08-21 22:43:37 +02:00
public function formatCurrency($amount, ?Currency $currency = null, int $decimals = 5): string
{
if ($amount instanceof BigDecimal) {
$amount = (string) $amount;
}
return $this->moneyFormatter->format($amount, $currency, $decimals);
}
2019-08-16 16:43:31 +02:00
2020-08-21 22:43:37 +02:00
public function siFormat($value, $unit, $decimals = 2, bool $show_all_digits = false): string
2019-08-16 16:43:31 +02:00
{
2020-08-21 22:43:37 +02:00
return $this->siformatter->format($value, $unit, $decimals);
2019-08-16 16:43:31 +02:00
}
2020-08-21 22:43:37 +02:00
public function amountFormat($value, ?MeasurementUnit $unit, array $options = []): string
{
return $this->amountFormatter->format($value, $unit, $options);
}
2023-01-16 00:06:14 +01:00
/**
* @param $bytes
*/
public function formatBytes(int $bytes, int $precision = 2): string
{
$size = ['B','kB','MB','GB','TB','PB','EB','ZB','YB'];
$factor = floor((strlen((string) $bytes) - 1) / 3);
//We use the real (10 based) SI prefix here
return sprintf("%.{$precision}f", $bytes / (1000 ** $factor)) . ' ' . @$size[$factor];
2023-01-16 00:06:14 +01:00
}
}