Add the possibility to set the minimum number of decimals in the numb…

psalm.xml

@@ -34,6 +34,11 @@
                 <directory name="test" />
             </errorLevel>
         </DeprecatedMethod>
+        <PossiblyUnusedMethod>
+            <errorLevel type="suppress">
+                <directory name="test" />
+            </errorLevel>
+        </PossiblyUnusedMethod>
     </issueHandlers>
     <plugins>
         <pluginClass class="Psalm\PhpUnitPlugin\Plugin"/>

src/View/Helper/NumberFormat.php

@@ -13,18 +13,25 @@
 use function serialize;
 
 /**
- * View helper for formatting dates.
+ * View helper for formatting numbers.
  */
 class NumberFormat extends AbstractHelper
 {
     use DeprecatedAbstractHelperHierarchyTrait;
 
     /**
-     * number of decimals to use.
+     * The maximum number of decimals to use.
      *
      * @var int
      */
-    protected $decimals;
+    protected $maxDecimals;
+
+    /**
+     * The minimum number of decimals to use.
+     *
+     * @var int
+     */
+    protected $minDecimals;
 
     /**
      * NumberFormat style to use
@@ -50,7 +57,7 @@
     /**
      * Text attributes.
      *
-     * @var array
+     * @var array<int, string>
      */
     protected $textAttributes = [];
 
@@ -64,21 +71,24 @@
     /**
      * Format a number
      *
-     * @param  int|float   $number
-     * @param  int|null    $formatStyle
-     * @param  int|null    $formatType
-     * @param  string|null $locale
-     * @param  int|null    $decimals
-     * @param  array|null  $textAttributes
+     * @param int|float          $number
+     * @param int|null           $formatStyle
+     * @param int|null           $formatType
+     * @param string|null        $locale
+     * @param int|null           $maxDecimals
+     * @param array<int, string> $textAttributes
+     * @param int|float          $number
+     * @param int|null           $minDecimals
      * @return string
      */
     public function __invoke(
         $number,
         $formatStyle = null,
         $formatType = null,
         $locale = null,
-        $decimals = null,
-        ?array $textAttributes = null
+        $maxDecimals = null,
+        ?array $textAttributes = null,
+        $minDecimals = null
     ) {
         if (null === $locale) {
             $locale = $this->getLocale();
@@ -89,15 +99,22 @@
         if (null === $formatType) {
             $formatType = $this->getFormatType();
         }
-        if (! is_int($decimals) || $decimals < 0) {
-            $decimals = $this->getDecimals();
+        if (! is_int($minDecimals) || $minDecimals < 0) {
+            $minDecimals = $this->getMinDecimals();
+        }
+        if (! is_int($maxDecimals) || $maxDecimals < 0) {
+            $maxDecimals = $this->getMaxDecimals();
+        }
+        if (($maxDecimals !== null) && ($minDecimals === null)) {
+            // Fallback to old behavior
+            $minDecimals = $maxDecimals;
         }
         if (! is_array($textAttributes)) {
             $textAttributes = $this->getTextAttributes();
         }
 
         $formatterId = md5(
-            $formatStyle . "\0" . $locale . "\0" . $decimals . "\0"
+            $formatStyle . "\0" . $locale . "\0" . ($minDecimals ?? '') . "\0" . ($maxDecimals ?? '') . "\0"
             . md5(serialize($textAttributes))
         );
 
@@ -106,9 +123,12 @@
         } else {
             $formatter = new NumberFormatter($locale, $formatStyle);
 
-            if ($decimals !== null) {
-                $formatter->setAttribute(NumberFormatter::MIN_FRACTION_DIGITS, $decimals);
-                $formatter->setAttribute(NumberFormatter::MAX_FRACTION_DIGITS, $decimals);
+            if ($minDecimals !== null) {
+                $formatter->setAttribute(NumberFormatter::MIN_FRACTION_DIGITS, $minDecimals);
+            }
+
+            if ($maxDecimals !== null) {
+                $formatter->setAttribute(NumberFormatter::MAX_FRACTION_DIGITS, $maxDecimals);
             }
 
             foreach ($textAttributes as $textAttribute => $value) {
@@ -173,14 +193,39 @@
     }
 
     /**
-     * Set number of decimals to use instead of the default.
+     * Set number of decimals (both min & max) to use instead of the default.
      *
      * @param  int $decimals
      * @return $this
      */
     public function setDecimals($decimals)
     {
-        $this->decimals = $decimals;
+        $this->minDecimals = $decimals;
+        $this->maxDecimals = $decimals;
+        return $this;
+    }
+
+    /**
+     * Set the maximum number of decimals to use instead of the default.
+     *
+     * @param int $maxDecimals
+     * @return $this
+     */
+    public function setMaxDecimals($maxDecimals)
+    {
+        $this->maxDecimals = $maxDecimals;
+        return $this;
+    }
+
+    /**
+     * Set the minimum number of decimals to use instead of the default.
+     *
+     * @param int $minDecimals
+     * @return $this
+     */
+    public function setMinDecimals($minDecimals)
+    {
+        $this->minDecimals = $minDecimals;
         return $this;
     }
 
@@ -191,7 +236,27 @@
      */
     public function getDecimals()
     {
-        return $this->decimals;
+        return $this->maxDecimals;
+    }
+
+    /**
+     * Get the maximum number of decimals.
+     *
+     * @return int
+     */
+    public function getMaxDecimals()
+    {
+        return $this->maxDecimals;
+    }
+
+    /**
+     * Get the minimum number of decimals.
+     *
+     * @return int
+     */
+    public function getMinDecimals()
+    {
+        return $this->minDecimals;
     }
 
     /**
@@ -221,15 +286,15 @@
     }
 
     /**
-     * @return array
+     * @return array<int, string>
      */
     public function getTextAttributes()
     {
         return $this->textAttributes;
     }
 
     /**
-     * @param array $textAttributes
+     * @param array<int, string> $textAttributes
      * @return $this
      */
     public function setTextAttributes(array $textAttributes)

src/View/HelperTrait.php

@@ -22,7 +22,7 @@
  * @method string countryCodeDataList(?string $locale = null, array $dataListAttributes = [])
  * @method string currencyFormat(float $number, string|null $currencyCode = null, bool|null $showDecimals = null, string|null $locale = null, string|null $pattern = null)
  * @method string dateFormat(\DateTimeInterface|\IntlCalendar|int|array $date, int $dateType = IntlDateFormatter::NONE, int $timeType = IntlDateFormatter::NONE, string|null $locale = null, string|null $pattern = null)
- * @method string numberFormat(int|float $number, int|null $formatStyle = null, int|null $formatType = null, string|null $locale = null, int|null $decimals = null, array|null $textAttributes = null)
+ * @method string numberFormat(int|float $number, int|null $formatStyle = null, int|null $formatType = null, string|null $locale = null, int|null $maxDecimals = null, array|null $textAttributes = null, int|null $minDecimals = null)
  * @method string plural(array|string $strings, int $number)
  * @method string translate(string $message, string|null $textDomain = null, string|null $locale = null)
  * @method string translatePlural(string $singular, string $plural, int $number, string|null $textDomain = null, string|null $locale = null)