[TASK] Streamline phpdoc annotations in EXT:fluid
[Packages/TYPO3.CMS.git] / typo3 / sysext / fluid / Classes / ViewHelpers / Format / CurrencyViewHelper.php
index f40545b..7861543 100644 (file)
@@ -1,15 +1,23 @@
 <?php
 namespace TYPO3\CMS\Fluid\ViewHelpers\Format;
 
-/*                                                                        *
- * This script is backported from the FLOW3 package "TYPO3.Fluid".        *
- *                                                                        *
- * It is free software; you can redistribute it and/or modify it under    *
- * the terms of the GNU Lesser General Public License, either version 3   *
- *  of the License, or (at your option) any later version.                *
- *                                                                        *
- * The TYPO3 project - inspiring people to share!                         *
- *                                                                        */
+/*
+ * 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!
+ */
+
+use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
+use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
+use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
+
 /**
  * Formats a given float to a currency representation.
  *
@@ -23,7 +31,7 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Format;
  * </output>
  *
  * <code title="All parameters">
- * <f:format.currency currencySign="$" decimalSeparator="." thousandsSeparator="," prependCurrency="TRUE" separateCurrency="FALSE">54321</f:format.currency>
+ * <f:format.currency currencySign="$" decimalSeparator="." thousandsSeparator="," prependCurrency="true" separateCurrency="false" decimals="2">54321</f:format.currency>
  * </code>
  * <output>
  * $54,321.00
@@ -37,39 +45,79 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Format;
  * (depending on the value of {someNumber})
  * </output>
  *
- * @api
+ * <code title="use dash for decimals without value">
+ * <f:format.currency useDash="true">123.00</f:format.currency>
+ * </code>
+ * <output>
+ * 123,-
+ * </output>
  */
-class CurrencyViewHelper extends \TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper {
+class CurrencyViewHelper extends AbstractViewHelper
+{
+    use CompileWithRenderStatic;
 
-       /**
-        * @param string $currencySign (optional) The currency sign, eg $ or €.
-        * @param string $decimalSeparator (optional) The separator for the decimal point.
-        * @param string $thousandsSeparator (optional) The thousands separator.
-        * @param boolean $prependCurrency (optional) Select if the curreny sign should be prepended
-        * @param boolean $separateCurrency (optional) Separate the currency sign from the number by a single space, defaults to true due to backwards compatibility
-        * @return string the formatted amount.
-        * @api
-        */
-       public function render($currencySign = '', $decimalSeparator = ',', $thousandsSeparator = '.', $prependCurrency = FALSE, $separateCurrency = TRUE) {
-               $floatToFormat = $this->renderChildren();
-               if (empty($floatToFormat)) {
-                       $floatToFormat = 0.0;
-               } else {
-                       $floatToFormat = floatval($floatToFormat);
-               }
-               $output = number_format($floatToFormat, 2, $decimalSeparator, $thousandsSeparator);
-               if ($currencySign !== '') {
-                       $currencySeparator = $separateCurrency ? ' ' : '';
-                       if ($prependCurrency === TRUE) {
-                               $output = $currencySign . $currencySeparator . $output;
-                       } else {
-                               $output = $output . $currencySeparator . $currencySign;
-                       }
-               }
-               return $output;
-       }
+    /**
+     * Output is escaped already. We must not escape children, to avoid double encoding.
+     *
+     * @var bool
+     */
+    protected $escapeChildren = false;
 
-}
+    /**
+     * Initialize arguments.
+     *
+     * @throws \TYPO3Fluid\Fluid\Core\ViewHelper\Exception
+     */
+    public function initializeArguments()
+    {
+        $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);
+    }
 
+    /**
+     * Formats a float to currency formatting
+     *
+     * @param array $arguments
+     * @param \Closure $renderChildrenClosure
+     * @param RenderingContextInterface $renderingContext
+     *
+     * @return string the formatted amount
+     */
+    public static function renderStatic(array $arguments, \Closure $renderChildrenClosure, RenderingContextInterface $renderingContext)
+    {
+        $currencySign = $arguments['currencySign'];
+        $decimalSeparator = $arguments['decimalSeparator'];
+        $thousandsSeparator = $arguments['thousandsSeparator'];
+        $prependCurrency = $arguments['prependCurrency'];
+        $separateCurrency = $arguments['separateCurrency'];
+        $decimals = $arguments['decimals'];
+        $useDash = $arguments['useDash'];
 
-?>
\ No newline at end of file
+        $floatToFormat = $renderChildrenClosure();
+        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;
+    }
+}