84 lines
3.3 KiB
PHP
84 lines
3.3 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
/*
|
|
* This file is part of the TYPO3 CMS project.
|
|
*
|
|
* It is free software; you can redistribute it and/or modify it under
|
|
* the terms of the GNU General Public License, either version 2
|
|
* of the License, or any later version.
|
|
*
|
|
* For the full copyright and license information, please read the
|
|
* LICENSE.txt file that was distributed with this source code.
|
|
*
|
|
* The TYPO3 project - inspiring people to share!
|
|
*/
|
|
|
|
namespace TYPO3\CMS\Fluid\ViewHelpers\Format;
|
|
|
|
use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
|
|
|
|
/**
|
|
* ViewHelper which formats a given float to a currency representation.
|
|
*
|
|
* ```
|
|
* <f:format.currency decimalSeparator="." thousandsSeparator="," decimals="2"
|
|
* currencySign="$" prependCurrency="true" separateCurrency="false">
|
|
* 54321
|
|
* </f:format.currency>
|
|
* ```
|
|
*
|
|
* @see https://docs.typo3.org/permalink/t3viewhelper:typo3-fluid-format-currency
|
|
*/
|
|
final class CurrencyViewHelper extends AbstractViewHelper
|
|
{
|
|
/**
|
|
* Output is escaped already. We must not escape children, to avoid double encoding.
|
|
*
|
|
* @var bool
|
|
*/
|
|
protected $escapeChildren = false;
|
|
|
|
public function initializeArguments(): void
|
|
{
|
|
$this->registerArgument('currencySign', 'string', 'The currency sign, eg $ or €.', false, '');
|
|
$this->registerArgument('decimalSeparator', 'string', 'The separator for the decimal point.', false, ',');
|
|
$this->registerArgument('thousandsSeparator', 'string', 'The thousands separator.', false, '.');
|
|
$this->registerArgument('prependCurrency', 'bool', 'Select if the currency sign should be prepended', false, false);
|
|
$this->registerArgument('separateCurrency', 'bool', 'Separate the currency sign from the number by a single space, defaults to true due to backwards compatibility', false, true);
|
|
$this->registerArgument('decimals', 'int', 'Set decimals places.', false, 2);
|
|
$this->registerArgument('useDash', 'bool', 'Use the dash instead of decimal 00', false, false);
|
|
}
|
|
|
|
public function render(): string
|
|
{
|
|
$currencySign = $this->arguments['currencySign'];
|
|
$decimalSeparator = $this->arguments['decimalSeparator'];
|
|
$thousandsSeparator = $this->arguments['thousandsSeparator'];
|
|
$prependCurrency = $this->arguments['prependCurrency'];
|
|
$separateCurrency = $this->arguments['separateCurrency'];
|
|
$decimals = (int)$this->arguments['decimals'];
|
|
$useDash = $this->arguments['useDash'];
|
|
$floatToFormat = $this->renderChildren();
|
|
if (empty($floatToFormat)) {
|
|
$floatToFormat = 0.0;
|
|
} else {
|
|
$floatToFormat = (float)$floatToFormat;
|
|
}
|
|
$output = number_format($floatToFormat, $decimals, $decimalSeparator, $thousandsSeparator);
|
|
if ($useDash && $floatToFormat === floor($floatToFormat)) {
|
|
$output = explode($decimalSeparator, $output)[0] . $decimalSeparator . '—';
|
|
}
|
|
if ($currencySign !== '') {
|
|
$currencySeparator = $separateCurrency ? ' ' : '';
|
|
if ($prependCurrency === true) {
|
|
$output = $currencySign . $currencySeparator . $output;
|
|
} else {
|
|
$output = $output . $currencySeparator . $currencySign;
|
|
}
|
|
}
|
|
return $output;
|
|
}
|
|
}
|