Currency and Accounting Formats

Fix PHPOffice#4125. Currency and Accounting Wizards generate styles for ISO codes, but these are incorrect and cause a problem when Excel tries to open a spreadsheet containing these styles. Debugging that problem, other problems with Wizards came to light:
- Currency Wizard should permit four different styles for negative numbers (as Excel does) - minus sign, minus sign and red font, paretheses, and parenthese and red font. It currently uses only minus sign.
- Accounting Wizard should use parentheses for negative numbers (as Excel does). It currently uses minus sign.
- Accounting Wizard should always use SYMBOL_WITH_SPACING (as Excel does). It currently permits the use of SYMBOL_WITHOUT_SPACING. What WITH_SPACING really does is to ensure decimal-point alignment among adjacent cells in a column with the same format.
- Currency Wizard should always use SYMBOL_WITHOUT_SPACING (as Excel does). It currently permits the use of SYMBOL_WITH_SPACING.

I am correcting these problems by:
- renaming Currency Wizard to CurrencyBase
- adding a `negative` property with setter to it and its constructor.
- adding a new Currency which extends CurrencyBase, always using SYMBOL_WITHOUT_SPACING when formatting.
- having Accounting extend CurrencyBase rather than Currency, always using SYMBOL_WITH_SPACING and NEGATIVE_PARENS when formatting.
- CurrencyBase can be used if the restrictions on Currency and Accounting are not desired (e.g. the suggested accounting constant from [this unimplemented PR](PHPOffice#1576)).

Excel does some funny stuff with these formats. In particular, it might try to guess if you have a particular Accounting format in mind. So the Accounting wizard for dollar sign generates a format which (a) matches FORMAT_ACCOUNTING_USD, and (b) Excel (correctly) interprets as an Accounting format for symbol $. On the other hand, the Accounting wizard for euro sign generates a format which (a) matches FORMAT_ACCOUNTING_EUR, but (b) Excel interprets as a custom code rather than an Accounting format. This in itself is not a particularly big deal, but it has made it impossible for me to see exactly what format Excel uses for trailing currency symbols for negative numbers. I can't get them to decimal-point align with positive numbers if I put any kind of space between the trailing parenthesis and the currency symbol, so I omit that. It doesn't look terrible, and it keeps everything aligned, but it might not be what people are used to.

I've also changed the formatting to use spaces rather than non-breaking spaces. They seem to work just fine, and the constants mentioned above use them rather than nbsp.

Fix PHPOffice#4124. Currency formats that contain an ISO currency code which contains one of the characters used to recognize a date format (hmsdy), e.g. [$HUF], are being formatted by PhpSpreadsheet as dates rather than currencies. Code is changed to recognize open bracket followed by dollar sign followed by 3 Latin alphabetic characters followed by close bracket as a non-date.

Author: oleibman

samples/Basic4/52_Currency.php

@@ -162,6 +162,8 @@ public static function toFormattedString($value, string $format, ?array $callBac
         if (
             //  Check for date/time characters (not inside quotes)
             (preg_match('/(\[\$[A-Z]*-[0-9A-F]*\])*[hmsdy](?=(?:[^"]|"[^"]*")*$)/miu', $format))
+            //  Look out for Currency formats Issue 4124
+            && !(preg_match('/\[\$[A-Z]{3}\]/miu', $format))
             // A date/time with a decimal time shouldn't have a digit placeholder before the decimal point
             && (preg_match('/[0\?#]\.(?![^\[]*\])/miu', $format) === 0)
         ) {

src/PhpSpreadsheet/Style/NumberFormat/Formatter.php

@@ -236,6 +236,7 @@ public static function format(mixed $value, string $format): string
 
         if (preg_match('/\[\$(.*)\]/u', $format, $m)) {
             //  Currency or Accounting
+            $value = preg_replace('/-0+(( |\\xc2\\xa0))?\\[/', '- [', (string) $value) ?? $value;
             $currencyCode = $m[1];
             [$currencyCode] = explode('-', $currencyCode);
             if ($currencyCode == '') {

src/PhpSpreadsheet/Style/NumberFormat/NumberFormatter.php

@@ -5,40 +5,11 @@
 use NumberFormatter;
 use PhpOffice\PhpSpreadsheet\Exception;
 
-class Accounting extends Currency
+class Accounting extends CurrencyBase
 {
-    /**
-     * @param string $currencyCode the currency symbol or code to display for this mask
-     * @param int $decimals number of decimal places to display, in the range 0-30
-     * @param bool $thousandsSeparator indicator whether the thousands separator should be used, or not
-     * @param bool $currencySymbolPosition indicates whether the currency symbol comes before or after the value
-     *              Possible values are Currency::LEADING_SYMBOL and Currency::TRAILING_SYMBOL
-     * @param bool $currencySymbolSpacing indicates whether there is spacing between the currency symbol and the value
-     *              Possible values are Currency::SYMBOL_WITH_SPACING and Currency::SYMBOL_WITHOUT_SPACING
-     * @param ?string $locale Set the locale for the currency format; or leave as the default null.
-     *          If provided, Locale values must be a valid formatted locale string (e.g. 'en-GB', 'fr', uz-Arab-AF).
-     *          Note that setting a locale will override any other settings defined in this class
-     *          other than the currency code; or decimals (unless the decimals value is set to 0).
-     *
-     * @throws Exception If a provided locale code is not a valid format
-     */
-    public function __construct(
-        string $currencyCode = '$',
-        int $decimals = 2,
-        bool $thousandsSeparator = true,
-        bool $currencySymbolPosition = self::LEADING_SYMBOL,
-        bool $currencySymbolSpacing = self::SYMBOL_WITHOUT_SPACING,
-        ?string $locale = null,
-        bool $stripLeadingRLM = self::DEFAULT_STRIP_LEADING_RLM
-    ) {
-        $this->setCurrencyCode($currencyCode);
-        $this->setThousandsSeparator($thousandsSeparator);
-        $this->setDecimals($decimals);
-        $this->setCurrencySymbolPosition($currencySymbolPosition);
-        $this->setCurrencySymbolSpacing($currencySymbolSpacing);
-        $this->setLocale($locale);
-        $this->stripLeadingRLM = $stripLeadingRLM;
-    }
+    protected ?bool $overrideSpacing = true;
+
+    protected ?string $overrideNegative = self::NEGATIVE_PARENS;
 
     /**
      * @throws Exception if the Intl extension and ICU version don't support Accounting formats
@@ -76,27 +47,4 @@ private function formatCurrencyCode(): string
 
         return "[\${$this->currencyCode}-{$this->locale}]";
     }
-
-    public function format(): string
-    {
-        if ($this->localeFormat !== null) {
-            return $this->localeFormat;
-        }
-
-        return sprintf(
-            '_-%s%s%s0%s%s%s_-',
-            $this->currencySymbolPosition === self::LEADING_SYMBOL ? $this->formatCurrencyCode() : null,
-            (
-                $this->currencySymbolPosition === self::LEADING_SYMBOL
-                && $this->currencySymbolSpacing === self::SYMBOL_WITH_SPACING
-            ) ? "\u{a0}" : '',
-            $this->thousandsSeparator ? '#,##' : null,
-            $this->decimals > 0 ? '.' . str_repeat('0', $this->decimals) : null,
-            (
-                $this->currencySymbolPosition === self::TRAILING_SYMBOL
-                && $this->currencySymbolSpacing === self::SYMBOL_WITH_SPACING
-            ) ? "\u{a0}" : '',
-            $this->currencySymbolPosition === self::TRAILING_SYMBOL ? $this->formatCurrencyCode() : null
-        );
-    }
 }

src/PhpSpreadsheet/Style/NumberFormat/Wizard/Accounting.php

@@ -2,124 +2,9 @@
 
 namespace PhpOffice\PhpSpreadsheet\Style\NumberFormat\Wizard;
 
-use NumberFormatter;
-use PhpOffice\PhpSpreadsheet\Exception;
-
-class Currency extends Number
+class Currency extends CurrencyBase
 {
-    public const LEADING_SYMBOL = true;
-
-    public const TRAILING_SYMBOL = false;
-
-    public const SYMBOL_WITH_SPACING = true;
-
-    public const SYMBOL_WITHOUT_SPACING = false;
-
-    protected string $currencyCode = '$';
-
-    protected bool $currencySymbolPosition = self::LEADING_SYMBOL;
-
-    protected bool $currencySymbolSpacing = self::SYMBOL_WITHOUT_SPACING;
-
-    protected const DEFAULT_STRIP_LEADING_RLM = false;
-
-    protected bool $stripLeadingRLM = self::DEFAULT_STRIP_LEADING_RLM;
-
-    /**
-     * @param string $currencyCode the currency symbol or code to display for this mask
-     * @param int $decimals number of decimal places to display, in the range 0-30
-     * @param bool $thousandsSeparator indicator whether the thousands separator should be used, or not
-     * @param bool $currencySymbolPosition indicates whether the currency symbol comes before or after the value
-     *              Possible values are Currency::LEADING_SYMBOL and Currency::TRAILING_SYMBOL
-     * @param bool $currencySymbolSpacing indicates whether there is spacing between the currency symbol and the value
-     *              Possible values are Currency::SYMBOL_WITH_SPACING and Currency::SYMBOL_WITHOUT_SPACING
-     * @param ?string $locale Set the locale for the currency format; or leave as the default null.
-     *          If provided, Locale values must be a valid formatted locale string (e.g. 'en-GB', 'fr', uz-Arab-AF).
-     *          Note that setting a locale will override any other settings defined in this class
-     *          other than the currency code; or decimals (unless the decimals value is set to 0).
-     * @param bool $stripLeadingRLM remove leading RLM added with
-     *          ICU 72.1+.
-     *
-     * @throws Exception If a provided locale code is not a valid format
-     */
-    public function __construct(
-        string $currencyCode = '$',
-        int $decimals = 2,
-        bool $thousandsSeparator = true,
-        bool $currencySymbolPosition = self::LEADING_SYMBOL,
-        bool $currencySymbolSpacing = self::SYMBOL_WITHOUT_SPACING,
-        ?string $locale = null,
-        bool $stripLeadingRLM = self::DEFAULT_STRIP_LEADING_RLM
-    ) {
-        $this->setCurrencyCode($currencyCode);
-        $this->setThousandsSeparator($thousandsSeparator);
-        $this->setDecimals($decimals);
-        $this->setCurrencySymbolPosition($currencySymbolPosition);
-        $this->setCurrencySymbolSpacing($currencySymbolSpacing);
-        $this->setLocale($locale);
-        $this->stripLeadingRLM = $stripLeadingRLM;
-    }
-
-    public function setCurrencyCode(string $currencyCode): void
-    {
-        $this->currencyCode = $currencyCode;
-    }
-
-    public function setCurrencySymbolPosition(bool $currencySymbolPosition = self::LEADING_SYMBOL): void
-    {
-        $this->currencySymbolPosition = $currencySymbolPosition;
-    }
-
-    public function setCurrencySymbolSpacing(bool $currencySymbolSpacing = self::SYMBOL_WITHOUT_SPACING): void
-    {
-        $this->currencySymbolSpacing = $currencySymbolSpacing;
-    }
-
-    public function setStripLeadingRLM(bool $stripLeadingRLM): void
-    {
-        $this->stripLeadingRLM = $stripLeadingRLM;
-    }
-
-    protected function getLocaleFormat(): string
-    {
-        $formatter = new Locale($this->fullLocale, NumberFormatter::CURRENCY);
-        $mask = $formatter->format($this->stripLeadingRLM);
-        if ($this->decimals === 0) {
-            $mask = (string) preg_replace('/\.0+/miu', '', $mask);
-        }
-
-        return str_replace('¤', $this->formatCurrencyCode(), $mask);
-    }
-
-    private function formatCurrencyCode(): string
-    {
-        if ($this->locale === null) {
-            return $this->currencyCode;
-        }
-
-        return "[\${$this->currencyCode}-{$this->locale}]";
-    }
-
-    public function format(): string
-    {
-        if ($this->localeFormat !== null) {
-            return $this->localeFormat;
-        }
+    protected ?bool $overrideSpacing = false;
 
-        return sprintf(
-            '%s%s%s0%s%s%s',
-            $this->currencySymbolPosition === self::LEADING_SYMBOL ? $this->formatCurrencyCode() : null,
-            (
-                $this->currencySymbolPosition === self::LEADING_SYMBOL
-                && $this->currencySymbolSpacing === self::SYMBOL_WITH_SPACING
-            ) ? "\u{a0}" : '',
-            $this->thousandsSeparator ? '#,##' : null,
-            $this->decimals > 0 ? '.' . str_repeat('0', $this->decimals) : null,
-            (
-                $this->currencySymbolPosition === self::TRAILING_SYMBOL
-                && $this->currencySymbolSpacing === self::SYMBOL_WITH_SPACING
-            ) ? "\u{a0}" : '',
-            $this->currencySymbolPosition === self::TRAILING_SYMBOL ? $this->formatCurrencyCode() : null
-        );
-    }
+    protected ?string $overrideNegative = null;
 }