NumberFormat::setLongDateFormat() - Code Metrics - Inspection of "cache the md5 sum in Style/Supervisor.php and subc..." - PHPOffice/PhpSpreadsheet - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#4426)

unknown

created 2025-03-27 12:43 UTC

NumberFormat::setLongDateFormat() A

↳ Parent: NumberFormat

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
eloc	1
dl	0
loc	3
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	1

<?php

namespace PhpOffice\PhpSpreadsheet\Style;

use PhpOffice\PhpSpreadsheet\RichText\RichText;

class NumberFormat extends Supervisor
{
    // Pre-defined formats
    const FORMAT_GENERAL = 'General';

    const FORMAT_TEXT = '@';

    const FORMAT_NUMBER = '0';
    const FORMAT_NUMBER_0 = '0.0';
    const FORMAT_NUMBER_00 = '0.00';
    const FORMAT_NUMBER_COMMA_SEPARATED1 = '#,##0.00';
    const FORMAT_NUMBER_COMMA_SEPARATED2 = '#,##0.00_-';

    const FORMAT_PERCENTAGE = '0%';
    const FORMAT_PERCENTAGE_0 = '0.0%';
    const FORMAT_PERCENTAGE_00 = '0.00%';

    const FORMAT_DATE_YYYYMMDD = 'yyyy-mm-dd';
    const FORMAT_DATE_DDMMYYYY = 'dd/mm/yyyy';
    const FORMAT_DATE_DMYSLASH = 'd/m/yy';
    const FORMAT_DATE_DMYMINUS = 'd-m-yy';
    const FORMAT_DATE_DMMINUS = 'd-m';
    const FORMAT_DATE_MYMINUS = 'm-yy';
    const FORMAT_DATE_XLSX14 = 'mm-dd-yy';
    const FORMAT_DATE_XLSX14_ACTUAL = 'm/d/yyyy';
    const FORMAT_DATE_XLSX15 = 'd-mmm-yy';
    const FORMAT_DATE_XLSX16 = 'd-mmm';
    const FORMAT_DATE_XLSX17 = 'mmm-yy';
    const FORMAT_DATE_XLSX22 = 'm/d/yy h:mm';
    const FORMAT_DATE_XLSX22_ACTUAL = 'm/d/yyyy h:mm';
    const FORMAT_DATE_DATETIME = 'd/m/yy h:mm';
    const FORMAT_DATE_TIME1 = 'h:mm AM/PM';
    const FORMAT_DATE_TIME2 = 'h:mm:ss AM/PM';
    const FORMAT_DATE_TIME3 = 'h:mm';
    const FORMAT_DATE_TIME4 = 'h:mm:ss';
    const FORMAT_DATE_TIME5 = 'mm:ss';
    const FORMAT_DATE_TIME6 = 'h:mm:ss';
    const FORMAT_DATE_TIME7 = 'i:s.S';
    const FORMAT_DATE_TIME8 = 'h:mm:ss;@';
    const FORMAT_DATE_YYYYMMDDSLASH = 'yyyy/mm/dd;@';
    const FORMAT_DATE_LONG_DATE = 'dddd, mmmm d, yyyy';

    const DATE_TIME_OR_DATETIME_ARRAY = [
        self::FORMAT_DATE_YYYYMMDD,
        self::FORMAT_DATE_DDMMYYYY,
        self::FORMAT_DATE_DMYSLASH,
        self::FORMAT_DATE_DMYMINUS,
        self::FORMAT_DATE_DMMINUS,
        self::FORMAT_DATE_MYMINUS,
        self::FORMAT_DATE_XLSX14,
        self::FORMAT_DATE_XLSX14_ACTUAL,
        self::FORMAT_DATE_XLSX15,
        self::FORMAT_DATE_XLSX16,
        self::FORMAT_DATE_XLSX17,
        self::FORMAT_DATE_XLSX22,
        self::FORMAT_DATE_XLSX22_ACTUAL,
        self::FORMAT_DATE_DATETIME,
        self::FORMAT_DATE_TIME1,
        self::FORMAT_DATE_TIME2,
        self::FORMAT_DATE_TIME3,
        self::FORMAT_DATE_TIME4,
        self::FORMAT_DATE_TIME5,
        self::FORMAT_DATE_TIME6,
        self::FORMAT_DATE_TIME7,
        self::FORMAT_DATE_TIME8,
        self::FORMAT_DATE_YYYYMMDDSLASH,
        self::FORMAT_DATE_LONG_DATE,
    ];
    const TIME_OR_DATETIME_ARRAY = [
        self::FORMAT_DATE_XLSX22,
        self::FORMAT_DATE_DATETIME,
        self::FORMAT_DATE_TIME1,
        self::FORMAT_DATE_TIME2,
        self::FORMAT_DATE_TIME3,
        self::FORMAT_DATE_TIME4,
        self::FORMAT_DATE_TIME5,
        self::FORMAT_DATE_TIME6,
        self::FORMAT_DATE_TIME7,
        self::FORMAT_DATE_TIME8,
    ];

    const FORMAT_CURRENCY_USD_INTEGER = '$#,##0_-';
    const FORMAT_CURRENCY_USD = '$#,##0.00_-';
    const FORMAT_CURRENCY_EUR_INTEGER = '#,##0_-[$€]';
    const FORMAT_CURRENCY_EUR = '#,##0.00_-[$€]';
    const FORMAT_ACCOUNTING_USD = '_("$"* #,##0.00_);_("$"* \(#,##0.00\);_("$"* "-"??_);_(@_)';
    const FORMAT_ACCOUNTING_EUR = '_("€"* #,##0.00_);_("€"* \(#,##0.00\);_("€"* "-"??_);_(@_)';

    const SHORT_DATE_INDEX = 14;
    const DATE_TIME_INDEX = 22;
    const FORMAT_SYSDATE_X = '[$-x-sysdate]';
    const FORMAT_SYSDATE_F800 = '[$-F800]';
    const FORMAT_SYSTIME_X = '[$-x-systime]';
    const FORMAT_SYSTIME_F400 = '[$-F400]';

    protected static string $shortDateFormat = self::FORMAT_DATE_XLSX14_ACTUAL;

    protected static string $longDateFormat = self::FORMAT_DATE_LONG_DATE;

    protected static string $dateTimeFormat = self::FORMAT_DATE_XLSX22_ACTUAL;

    protected static string $timeFormat = self::FORMAT_DATE_TIME2;

    /**
     * Excel built-in number formats.
     */
    protected static array $builtInFormats;

    /**
     * Excel built-in number formats (flipped, for faster lookups).
     */
    protected static array $flippedBuiltInFormats;

    /**
     * Format Code.
     */
    protected ?string $formatCode = self::FORMAT_GENERAL;

    /**
     * Built-in format Code.
     *
     * @var false|int
     */
    protected $builtInFormatCode = 0;

    /**
     * Create a new NumberFormat.
     *
     * @param bool $isSupervisor Flag indicating if this is a supervisor or not
     *                                    Leave this value at default unless you understand exactly what
     *                                        its ramifications are
     * @param bool $isConditional Flag indicating if this is a conditional style or not
     *                                    Leave this value at default unless you understand exactly what
     *                                        its ramifications are
     */
    public function __construct(bool $isSupervisor = false, bool $isConditional = false)
    {
        // Supervisor?
        parent::__construct($isSupervisor);

        if ($isConditional) {
            $this->formatCode = null;
            $this->builtInFormatCode = false;
        }
    }

    /**
     * Get the shared style component for the currently active cell in currently active sheet.
     * Only used for style supervisor.
     */
    public function getSharedComponent(): self
    {
        /** @var Style $parent */
        $parent = $this->parent;

        return $parent->getSharedComponent()->getNumberFormat();
    }

    /**
     * Build style array from subcomponents.
     */
    public function getStyleArray(array $array): array
    {
        return ['numberFormat' => $array];
    }

    /**
     * Apply styles from array.
     *
     * <code>
     * $spreadsheet->getActiveSheet()->getStyle('B2')->getNumberFormat()->applyFromArray(
     *     [
     *         'formatCode' => NumberFormat::FORMAT_CURRENCY_EUR_SIMPLE
     *     ]
     * );
     * </code>
     *
     * @param array $styleArray Array containing style information
     *
     * @return $this
     */
    public function applyFromArray(array $styleArray): static
    {
        if ($this->isSupervisor) {
            $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($this->getStyleArray($styleArray));
        } else {
            if (isset($styleArray['formatCode'])) {
                $this->setFormatCode($styleArray['formatCode']);
            }
        }

        return $this;
    }

    /**
     * Get Format Code.
     */
    public function getFormatCode(bool $extended = false): ?string
    {
        if ($this->isSupervisor) {
            return $this->getSharedComponent()->getFormatCode($extended);
        }
        $builtin = $this->getBuiltInFormatCode();
        if (is_int($builtin)) {
            if ($extended) {
                if ($builtin === self::SHORT_DATE_INDEX) {
                    return self::$shortDateFormat;
                }
                if ($builtin === self::DATE_TIME_INDEX) {
                    return self::$dateTimeFormat;
                }
            }

            return self::builtInFormatCode($builtin);
        }

        return $extended ? self::convertSystemFormats($this->formatCode) : $this->formatCode;
    }

    public static function convertSystemFormats(?string $formatCode): ?string
    {
        if (is_string($formatCode)) {
            if (stripos($formatCode, self::FORMAT_SYSDATE_F800) !== false || stripos($formatCode, self::FORMAT_SYSDATE_X) !== false) {
                return self::$longDateFormat;
            }
            if (stripos($formatCode, self::FORMAT_SYSTIME_F400) !== false || stripos($formatCode, self::FORMAT_SYSTIME_X) !== false) {
                return self::$timeFormat;
            }
        }

        return $formatCode;
    }

    /**
     * Set Format Code.
     *
     * @param string $formatCode see self::FORMAT_*
     *
     * @return $this
     */
    public function setFormatCode(string $formatCode): static
    {
        if ($formatCode == '') {
            $formatCode = self::FORMAT_GENERAL;
        }
        if ($this->isSupervisor) {
            $styleArray = $this->getStyleArray(['formatCode' => $formatCode]);
            $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
        } else {
            $this->formatCode = $formatCode;
            $this->builtInFormatCode = self::builtInFormatCodeIndex($formatCode);
        }
        $this->updateHashBeforeUse();

        return $this;
    }

    /**
     * Get Built-In Format Code.
     *
     * @return false|int
     */
    public function getBuiltInFormatCode()
    {
        if ($this->isSupervisor) {
            return $this->getSharedComponent()->getBuiltInFormatCode();
        }

        return $this->builtInFormatCode;
    }

    /**
     * Set Built-In Format Code.
     *
     * @param int $formatCodeIndex Id of the built-in format code to use
     *
     * @return $this
     */
    public function setBuiltInFormatCode(int $formatCodeIndex): static
    {
        if ($this->isSupervisor) {
            $styleArray = $this->getStyleArray(['formatCode' => self::builtInFormatCode($formatCodeIndex)]);
            $this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
        } else {
            $this->builtInFormatCode = $formatCodeIndex;
            $this->formatCode = self::builtInFormatCode($formatCodeIndex);
        }
        $this->updateHashBeforeUse();

        return $this;
    }

    /**
     * Fill built-in format codes.
     */
    private static function fillBuiltInFormatCodes(): void
    {
        //  [MS-OI29500: Microsoft Office Implementation Information for ISO/IEC-29500 Standard Compliance]
        //  18.8.30. numFmt (Number Format)
        //
        //  The ECMA standard defines built-in format IDs
        //      14: "mm-dd-yy"
        //      22: "m/d/yy h:mm"
        //      37: "#,##0 ;(#,##0)"
        //      38: "#,##0 ;[Red](#,##0)"
        //      39: "#,##0.00;(#,##0.00)"
        //      40: "#,##0.00;[Red](#,##0.00)"
        //      47: "mmss.0"
        //      KOR fmt 55: "yyyy-mm-dd"
        //  Excel defines built-in format IDs
        //      14: "m/d/yyyy"
        //      22: "m/d/yyyy h:mm"
        //      37: "#,##0_);(#,##0)"
        //      38: "#,##0_);[Red](#,##0)"
        //      39: "#,##0.00_);(#,##0.00)"
        //      40: "#,##0.00_);[Red](#,##0.00)"
        //      47: "mm:ss.0"
        //      KOR fmt 55: "yyyy/mm/dd"

        // Built-in format codes
        if (empty(self::$builtInFormats)) {
            self::$builtInFormats = [];

            // General
            self::$builtInFormats[0] = self::FORMAT_GENERAL;
            self::$builtInFormats[1] = '0';
            self::$builtInFormats[2] = '0.00';
            self::$builtInFormats[3] = '#,##0';
            self::$builtInFormats[4] = '#,##0.00';

            self::$builtInFormats[9] = '0%';
            self::$builtInFormats[10] = '0.00%';
            self::$builtInFormats[11] = '0.00E+00';
            self::$builtInFormats[12] = '# ?/?';
            self::$builtInFormats[13] = '# ??/??';
            self::$builtInFormats[14] = self::FORMAT_DATE_XLSX14_ACTUAL; // Despite ECMA 'mm-dd-yy';
            self::$builtInFormats[15] = self::FORMAT_DATE_XLSX15;
            self::$builtInFormats[16] = 'd-mmm';
            self::$builtInFormats[17] = 'mmm-yy';
            self::$builtInFormats[18] = 'h:mm AM/PM';
            self::$builtInFormats[19] = 'h:mm:ss AM/PM';
            self::$builtInFormats[20] = 'h:mm';
            self::$builtInFormats[21] = 'h:mm:ss';
            self::$builtInFormats[22] = self::FORMAT_DATE_XLSX22_ACTUAL; // Despite ECMA 'm/d/yy h:mm';

            self::$builtInFormats[37] = '#,##0_);(#,##0)'; //  Despite ECMA '#,##0 ;(#,##0)';
            self::$builtInFormats[38] = '#,##0_);[Red](#,##0)'; //  Despite ECMA '#,##0 ;[Red](#,##0)';
            self::$builtInFormats[39] = '#,##0.00_);(#,##0.00)'; //  Despite ECMA '#,##0.00;(#,##0.00)';
            self::$builtInFormats[40] = '#,##0.00_);[Red](#,##0.00)'; //  Despite ECMA '#,##0.00;[Red](#,##0.00)';

            self::$builtInFormats[44] = '_("$"* #,##0.00_);_("$"* \(#,##0.00\);_("$"* "-"??_);_(@_)';
            self::$builtInFormats[45] = 'mm:ss';
            self::$builtInFormats[46] = '[h]:mm:ss';
            self::$builtInFormats[47] = 'mm:ss.0'; //  Despite ECMA 'mmss.0';
            self::$builtInFormats[48] = '##0.0E+0';
            self::$builtInFormats[49] = '@';

            // CHT
            self::$builtInFormats[27] = '[$-404]e/m/d';
            self::$builtInFormats[30] = 'm/d/yy';
            self::$builtInFormats[36] = '[$-404]e/m/d';
            self::$builtInFormats[50] = '[$-404]e/m/d';
            self::$builtInFormats[57] = '[$-404]e/m/d';

            // THA
            self::$builtInFormats[59] = 't0';
            self::$builtInFormats[60] = 't0.00';
            self::$builtInFormats[61] = 't#,##0';
            self::$builtInFormats[62] = 't#,##0.00';
            self::$builtInFormats[67] = 't0%';
            self::$builtInFormats[68] = 't0.00%';
            self::$builtInFormats[69] = 't# ?/?';
            self::$builtInFormats[70] = 't# ??/??';

            // JPN
            self::$builtInFormats[28] = '[$-411]ggge"年"m"月"d"日"';
            self::$builtInFormats[29] = '[$-411]ggge"年"m"月"d"日"';
            self::$builtInFormats[31] = 'yyyy"年"m"月"d"日"';
            self::$builtInFormats[32] = 'h"時"mm"分"';
            self::$builtInFormats[33] = 'h"時"mm"分"ss"秒"';
            self::$builtInFormats[34] = 'yyyy"年"m"月"';
            self::$builtInFormats[35] = 'm"月"d"日"';
            self::$builtInFormats[51] = '[$-411]ggge"年"m"月"d"日"';
            self::$builtInFormats[52] = 'yyyy"年"m"月"';
            self::$builtInFormats[53] = 'm"月"d"日"';
            self::$builtInFormats[54] = '[$-411]ggge"年"m"月"d"日"';
            self::$builtInFormats[55] = 'yyyy"年"m"月"';
            self::$builtInFormats[56] = 'm"月"d"日"';
            self::$builtInFormats[58] = '[$-411]ggge"年"m"月"d"日"';

            // Flip array (for faster lookups)
            self::$flippedBuiltInFormats = array_flip(self::$builtInFormats);
        }
    }

    /**
     * Get built-in format code.
     */
    public static function builtInFormatCode(int $index): string
    {
        // Clean parameter
        $index = (int) $index;

        // Ensure built-in format codes are available
        self::fillBuiltInFormatCodes();

        // Lookup format code
        if (isset(self::$builtInFormats[$index])) {
            return self::$builtInFormats[$index];
        }

        return '';
    }

    /**
     * Get built-in format code index.
     *
     * @return false|int
     */
    public static function builtInFormatCodeIndex(string $formatCodeIndex)
    {
        // Ensure built-in format codes are available
        self::fillBuiltInFormatCodes();

        // Lookup format code
        if (array_key_exists($formatCodeIndex, self::$flippedBuiltInFormats)) {
            return self::$flippedBuiltInFormats[$formatCodeIndex];
        }

        return false;
    }

    /**
     * Update Hash when something changes.
     */
    protected function updateHash(): void
    {
        $this->md5Sum = md5(
            $this->formatCode
            . $this->builtInFormatCode
            . __CLASS__
        );
        $this->updateMd5Sum = false;
    }

    /**
     * Get hash code.
     *
     * @return string Hash code
     */
    public function getHashCode(): string
    {
        if ($this->isSupervisor) {
            return $this->getSharedComponent()->getHashCode();
        }

        if ($this->updateMd5Sum) {
            $this->updateHash();
        }

        return $this->md5Sum;
    }

    /**
     * Convert a value in a pre-defined format to a PHP string.
     *
     * @param null|bool|float|int|RichText|string $value Value to format
     * @param string $format Format code: see = self::FORMAT_* for predefined values;
     *                          or can be any valid MS Excel custom format string
     * @param ?array $callBack Callback function for additional formatting of string
     *
     * @return string Formatted string
     */
    public static function toFormattedString(mixed $value, string $format, ?array $callBack = null): string
    {
        return NumberFormat\Formatter::toFormattedString($value, $format, $callBack);
    }

    protected function exportArray1(): array
    {
        $exportedArray = [];
        $this->exportArray2($exportedArray, 'formatCode', $this->getFormatCode());

        return $exportedArray;
    }

    public static function getShortDateFormat(): string
    {
        return self::$shortDateFormat;
    }

    public static function setShortDateFormat(string $shortDateFormat): void
    {
        self::$shortDateFormat = $shortDateFormat;
    }

    public static function getLongDateFormat(): string
    {
        return self::$longDateFormat;
    }

    public static function setLongDateFormat(string $longDateFormat): void
    {
        self::$longDateFormat = $longDateFormat;
    }

    public static function getDateTimeFormat(): string
    {
        return self::$dateTimeFormat;
    }

    public static function setDateTimeFormat(string $dateTimeFormat): void
    {
        self::$dateTimeFormat = $dateTimeFormat;
    }

    public static function getTimeFormat(): string
    {
        return self::$timeFormat;
    }

    public static function setTimeFormat(string $timeFormat): void
    {
        self::$timeFormat = $timeFormat;
    }
}


1		<?php
2
3		namespace PhpOffice\PhpSpreadsheet\Style;
4
5		use PhpOffice\PhpSpreadsheet\RichText\RichText;
6
7		class NumberFormat extends Supervisor
8		{
9		// Pre-defined formats
10		const FORMAT_GENERAL = 'General';
11
12		const FORMAT_TEXT = '@';
13
14		const FORMAT_NUMBER = '0';
15		const FORMAT_NUMBER_0 = '0.0';
16		const FORMAT_NUMBER_00 = '0.00';
17		const FORMAT_NUMBER_COMMA_SEPARATED1 = '#,##0.00';
18		const FORMAT_NUMBER_COMMA_SEPARATED2 = '#,##0.00_-';
19
20		const FORMAT_PERCENTAGE = '0%';
21		const FORMAT_PERCENTAGE_0 = '0.0%';
22		const FORMAT_PERCENTAGE_00 = '0.00%';
23
24		const FORMAT_DATE_YYYYMMDD = 'yyyy-mm-dd';
25		const FORMAT_DATE_DDMMYYYY = 'dd/mm/yyyy';
26		const FORMAT_DATE_DMYSLASH = 'd/m/yy';
27		const FORMAT_DATE_DMYMINUS = 'd-m-yy';
28		const FORMAT_DATE_DMMINUS = 'd-m';
29		const FORMAT_DATE_MYMINUS = 'm-yy';
30		const FORMAT_DATE_XLSX14 = 'mm-dd-yy';
31		const FORMAT_DATE_XLSX14_ACTUAL = 'm/d/yyyy';
32		const FORMAT_DATE_XLSX15 = 'd-mmm-yy';
33		const FORMAT_DATE_XLSX16 = 'd-mmm';
34		const FORMAT_DATE_XLSX17 = 'mmm-yy';
35		const FORMAT_DATE_XLSX22 = 'm/d/yy h:mm';
36		const FORMAT_DATE_XLSX22_ACTUAL = 'm/d/yyyy h:mm';
37		const FORMAT_DATE_DATETIME = 'd/m/yy h:mm';
38		const FORMAT_DATE_TIME1 = 'h:mm AM/PM';
39		const FORMAT_DATE_TIME2 = 'h:mm:ss AM/PM';
40		const FORMAT_DATE_TIME3 = 'h:mm';
41		const FORMAT_DATE_TIME4 = 'h:mm:ss';
42		const FORMAT_DATE_TIME5 = 'mm:ss';
43		const FORMAT_DATE_TIME6 = 'h:mm:ss';
44		const FORMAT_DATE_TIME7 = 'i:s.S';
45		const FORMAT_DATE_TIME8 = 'h:mm:ss;@';
46		const FORMAT_DATE_YYYYMMDDSLASH = 'yyyy/mm/dd;@';
47		const FORMAT_DATE_LONG_DATE = 'dddd, mmmm d, yyyy';
48
49		const DATE_TIME_OR_DATETIME_ARRAY = [
50		self::FORMAT_DATE_YYYYMMDD,
51		self::FORMAT_DATE_DDMMYYYY,
52		self::FORMAT_DATE_DMYSLASH,
53		self::FORMAT_DATE_DMYMINUS,
54		self::FORMAT_DATE_DMMINUS,
55		self::FORMAT_DATE_MYMINUS,
56		self::FORMAT_DATE_XLSX14,
57		self::FORMAT_DATE_XLSX14_ACTUAL,
58		self::FORMAT_DATE_XLSX15,
59		self::FORMAT_DATE_XLSX16,
60		self::FORMAT_DATE_XLSX17,
61		self::FORMAT_DATE_XLSX22,
62		self::FORMAT_DATE_XLSX22_ACTUAL,
63		self::FORMAT_DATE_DATETIME,
64		self::FORMAT_DATE_TIME1,
65		self::FORMAT_DATE_TIME2,
66		self::FORMAT_DATE_TIME3,
67		self::FORMAT_DATE_TIME4,
68		self::FORMAT_DATE_TIME5,
69		self::FORMAT_DATE_TIME6,
70		self::FORMAT_DATE_TIME7,
71		self::FORMAT_DATE_TIME8,
72		self::FORMAT_DATE_YYYYMMDDSLASH,
73		self::FORMAT_DATE_LONG_DATE,
74		];
75		const TIME_OR_DATETIME_ARRAY = [
76		self::FORMAT_DATE_XLSX22,
77		self::FORMAT_DATE_DATETIME,
78		self::FORMAT_DATE_TIME1,
79		self::FORMAT_DATE_TIME2,
80		self::FORMAT_DATE_TIME3,
81		self::FORMAT_DATE_TIME4,
82		self::FORMAT_DATE_TIME5,
83		self::FORMAT_DATE_TIME6,
84		self::FORMAT_DATE_TIME7,
85		self::FORMAT_DATE_TIME8,
86		];
87
88		const FORMAT_CURRENCY_USD_INTEGER = '$#,##0_-';
89		const FORMAT_CURRENCY_USD = '$#,##0.00_-';
90		const FORMAT_CURRENCY_EUR_INTEGER = '#,##0_-[$€]';
91		const FORMAT_CURRENCY_EUR = '#,##0.00_-[$€]';
92		const FORMAT_ACCOUNTING_USD = '_("$"* #,##0.00_);_("$"* \(#,##0.00\);_("$"* "-"??_);_(@_)';
93		const FORMAT_ACCOUNTING_EUR = '_("€"* #,##0.00_);_("€"* \(#,##0.00\);_("€"* "-"??_);_(@_)';
94
95		const SHORT_DATE_INDEX = 14;
96		const DATE_TIME_INDEX = 22;
97		const FORMAT_SYSDATE_X = '[$-x-sysdate]';
98		const FORMAT_SYSDATE_F800 = '[$-F800]';
99		const FORMAT_SYSTIME_X = '[$-x-systime]';
100		const FORMAT_SYSTIME_F400 = '[$-F400]';
101
102		protected static string $shortDateFormat = self::FORMAT_DATE_XLSX14_ACTUAL;
103
104		protected static string $longDateFormat = self::FORMAT_DATE_LONG_DATE;
105
106		protected static string $dateTimeFormat = self::FORMAT_DATE_XLSX22_ACTUAL;
107
108		protected static string $timeFormat = self::FORMAT_DATE_TIME2;
109
110		/**
111		* Excel built-in number formats.
112		*/
113		protected static array $builtInFormats;
114
115		/**
116		* Excel built-in number formats (flipped, for faster lookups).
117		*/
118		protected static array $flippedBuiltInFormats;
119
120		/**
121		* Format Code.
122		*/
123		protected ?string $formatCode = self::FORMAT_GENERAL;
124
125		/**
126		* Built-in format Code.
127		*
128		* @var false\|int
129		*/
130		protected $builtInFormatCode = 0;
131
132		/**
133		* Create a new NumberFormat.
134		*
135		* @param bool $isSupervisor Flag indicating if this is a supervisor or not
136		* Leave this value at default unless you understand exactly what
137		* its ramifications are
138		* @param bool $isConditional Flag indicating if this is a conditional style or not
139		* Leave this value at default unless you understand exactly what
140		* its ramifications are
141		*/
142	10568	public function __construct(bool $isSupervisor = false, bool $isConditional = false)
143		{
144		// Supervisor?
145	10568	parent::__construct($isSupervisor);
146
147	10568	if ($isConditional) {
148	402	$this->formatCode = null;
149	402	$this->builtInFormatCode = false;
150		}
151		}
152
153		/**
154		* Get the shared style component for the currently active cell in currently active sheet.
155		* Only used for style supervisor.
156		*/
157	129	public function getSharedComponent(): self
158		{
159		/** @var Style $parent */
160	129	$parent = $this->parent;
161
162	129	return $parent->getSharedComponent()->getNumberFormat();
163		}
164
165		/**
166		* Build style array from subcomponents.
167		*/
168	674	public function getStyleArray(array $array): array
169		{
170	674	return ['numberFormat' => $array];
171		}
172
173		/**
174		* Apply styles from array.
175		*
176		* <code>
177		* $spreadsheet->getActiveSheet()->getStyle('B2')->getNumberFormat()->applyFromArray(
178		* [
179		* 'formatCode' => NumberFormat::FORMAT_CURRENCY_EUR_SIMPLE
180		* ]
181		* );
182		* </code>
183		*
184		* @param array $styleArray Array containing style information
185		*
186		* @return $this
187		*/
188	712	public function applyFromArray(array $styleArray): static
189		{
190	712	if ($this->isSupervisor) {
191	1	$this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($this->getStyleArray($styleArray));
192		} else {
193	712	if (isset($styleArray['formatCode'])) {
194	712	$this->setFormatCode($styleArray['formatCode']);
195		}
196		}
197
198	712	return $this;
199		}
200
201		/**
202		* Get Format Code.
203		*/
204	862	public function getFormatCode(bool $extended = false): ?string
205		{
206	862	if ($this->isSupervisor) {
207	129	return $this->getSharedComponent()->getFormatCode($extended);
208		}
209	862	$builtin = $this->getBuiltInFormatCode();
210	862	if (is_int($builtin)) {
211	444	if ($extended) {
212	103	if ($builtin === self::SHORT_DATE_INDEX) {
213	2	return self::$shortDateFormat;
214		}
215	103	if ($builtin === self::DATE_TIME_INDEX) {
216	2	return self::$dateTimeFormat;
217		}
218		}
219
220	442	return self::builtInFormatCode($builtin);
221		}
222
223	486	return $extended ? self::convertSystemFormats($this->formatCode) : $this->formatCode;
224		}
225
226	175	public static function convertSystemFormats(?string $formatCode): ?string
227		{
228	175	if (is_string($formatCode)) {
229	175	if (stripos($formatCode, self::FORMAT_SYSDATE_F800) !== false \|\| stripos($formatCode, self::FORMAT_SYSDATE_X) !== false) {
230	5	return self::$longDateFormat;
231		}
232	173	if (stripos($formatCode, self::FORMAT_SYSTIME_F400) !== false \|\| stripos($formatCode, self::FORMAT_SYSTIME_X) !== false) {
233	4	return self::$timeFormat;
234		}
235		}
236
237	169	return $formatCode;
238		}
239
240		/**
241		* Set Format Code.
242		*
243		* @param string $formatCode see self::FORMAT_*
244		*
245		* @return $this
246		*/
247	1485	public function setFormatCode(string $formatCode): static
248		{
249	1485	if ($formatCode == '') {
250	16	$formatCode = self::FORMAT_GENERAL;
251		}
252	1485	if ($this->isSupervisor) {
253	673	$styleArray = $this->getStyleArray(['formatCode' => $formatCode]);
254	673	$this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
255		} else {
256	1475	$this->formatCode = $formatCode;
257	1475	$this->builtInFormatCode = self::builtInFormatCodeIndex($formatCode);
258		}
259		$this->updateHashBeforeUse();
260	1475
261		return $this;
262		}
263
264		/**
265		* Get Built-In Format Code.
266		*
267		* @return false\|int
268	1197	*/
269		public function getBuiltInFormatCode()
270	1197	{
271	1	if ($this->isSupervisor) {
272		return $this->getSharedComponent()->getBuiltInFormatCode();
273		}
274	1197
275		return $this->builtInFormatCode;
276		}
277
278		/**
279		* Set Built-In Format Code.
280		*
281		* @param int $formatCodeIndex Id of the built-in format code to use
282		*
283		* @return $this
284	3	*/
285		public function setBuiltInFormatCode(int $formatCodeIndex): static
286	3	{
287	3	if ($this->isSupervisor) {
288	3	$styleArray = $this->getStyleArray(['formatCode' => self::builtInFormatCode($formatCodeIndex)]);
289		$this->getActiveSheet()->getStyle($this->getSelectedCells())->applyFromArray($styleArray);
290	1	} else {
291	1	$this->builtInFormatCode = $formatCodeIndex;
292		$this->formatCode = self::builtInFormatCode($formatCodeIndex);
293		}
294	3	$this->updateHashBeforeUse();
295
296		return $this;
297		}
298
299		/**
300	1692	* Fill built-in format codes.
301		*/
302		private static function fillBuiltInFormatCodes(): void
303		{
304		// [MS-OI29500: Microsoft Office Implementation Information for ISO/IEC-29500 Standard Compliance]
305		// 18.8.30. numFmt (Number Format)
306		//
307		// The ECMA standard defines built-in format IDs
308		// 14: "mm-dd-yy"
309		// 22: "m/d/yy h:mm"
310		// 37: "#,##0 ;(#,##0)"
311		// 38: "#,##0 ;[Red](#,##0)"
312		// 39: "#,##0.00;(#,##0.00)"
313		// 40: "#,##0.00;[Red](#,##0.00)"
314		// 47: "mmss.0"
315		// KOR fmt 55: "yyyy-mm-dd"
316		// Excel defines built-in format IDs
317		// 14: "m/d/yyyy"
318		// 22: "m/d/yyyy h:mm"
319		// 37: "#,##0_);(#,##0)"
320		// 38: "#,##0_);[Red](#,##0)"
321		// 39: "#,##0.00_);(#,##0.00)"
322		// 40: "#,##0.00_);[Red](#,##0.00)"
323		// 47: "mm:ss.0"
324		// KOR fmt 55: "yyyy/mm/dd"
325	1692
326	171	// Built-in format codes
327		if (empty(self::$builtInFormats)) {
328		self::$builtInFormats = [];
329	171
330	171	// General
331	171	self::$builtInFormats[0] = self::FORMAT_GENERAL;
332	171	self::$builtInFormats[1] = '0';
333	171	self::$builtInFormats[2] = '0.00';
334		self::$builtInFormats[3] = '#,##0';
335	171	self::$builtInFormats[4] = '#,##0.00';
336	171
337	171	self::$builtInFormats[9] = '0%';
338	171	self::$builtInFormats[10] = '0.00%';
339	171	self::$builtInFormats[11] = '0.00E+00';
340	171	self::$builtInFormats[12] = '# ?/?';
341	171	self::$builtInFormats[13] = '# ??/??';
342	171	self::$builtInFormats[14] = self::FORMAT_DATE_XLSX14_ACTUAL; // Despite ECMA 'mm-dd-yy';
343	171	self::$builtInFormats[15] = self::FORMAT_DATE_XLSX15;
344	171	self::$builtInFormats[16] = 'd-mmm';
345	171	self::$builtInFormats[17] = 'mmm-yy';
346	171	self::$builtInFormats[18] = 'h:mm AM/PM';
347	171	self::$builtInFormats[19] = 'h:mm:ss AM/PM';
348	171	self::$builtInFormats[20] = 'h:mm';
349		self::$builtInFormats[21] = 'h:mm:ss';
350	171	self::$builtInFormats[22] = self::FORMAT_DATE_XLSX22_ACTUAL; // Despite ECMA 'm/d/yy h:mm';
351	171
352	171	self::$builtInFormats[37] = '#,##0_);(#,##0)'; // Despite ECMA '#,##0 ;(#,##0)';
353	171	self::$builtInFormats[38] = '#,##0_);[Red](#,##0)'; // Despite ECMA '#,##0 ;[Red](#,##0)';
354		self::$builtInFormats[39] = '#,##0.00_);(#,##0.00)'; // Despite ECMA '#,##0.00;(#,##0.00)';
355	171	self::$builtInFormats[40] = '#,##0.00_);[Red](#,##0.00)'; // Despite ECMA '#,##0.00;[Red](#,##0.00)';
356	171
357	171	self::$builtInFormats[44] = '_("$"* #,##0.00_);_("$"* \(#,##0.00\);_("$"* "-"??_);_(@_)';
358	171	self::$builtInFormats[45] = 'mm:ss';
359	171	self::$builtInFormats[46] = '[h]:mm:ss';
360	171	self::$builtInFormats[47] = 'mm:ss.0'; // Despite ECMA 'mmss.0';
361		self::$builtInFormats[48] = '##0.0E+0';
362		self::$builtInFormats[49] = '@';
363	171
364	171	// CHT
365	171	self::$builtInFormats[27] = '[$-404]e/m/d';
366	171	self::$builtInFormats[30] = 'm/d/yy';
367	171	self::$builtInFormats[36] = '[$-404]e/m/d';
368		self::$builtInFormats[50] = '[$-404]e/m/d';
369		self::$builtInFormats[57] = '[$-404]e/m/d';
370	171
371	171	// THA
372	171	self::$builtInFormats[59] = 't0';
373	171	self::$builtInFormats[60] = 't0.00';
374	171	self::$builtInFormats[61] = 't#,##0';
375	171	self::$builtInFormats[62] = 't#,##0.00';
376	171	self::$builtInFormats[67] = 't0%';
377	171	self::$builtInFormats[68] = 't0.00%';
378		self::$builtInFormats[69] = 't# ?/?';
379		self::$builtInFormats[70] = 't# ??/??';
380	171
381	171	// JPN
382	171	self::$builtInFormats[28] = '[$-411]ggge"年"m"月"d"日"';
383	171	self::$builtInFormats[29] = '[$-411]ggge"年"m"月"d"日"';
384	171	self::$builtInFormats[31] = 'yyyy"年"m"月"d"日"';
385	171	self::$builtInFormats[32] = 'h"時"mm"分"';
386	171	self::$builtInFormats[33] = 'h"時"mm"分"ss"秒"';
387	171	self::$builtInFormats[34] = 'yyyy"年"m"月"';
388	171	self::$builtInFormats[35] = 'm"月"d"日"';
389	171	self::$builtInFormats[51] = '[$-411]ggge"年"m"月"d"日"';
390	171	self::$builtInFormats[52] = 'yyyy"年"m"月"';
391	171	self::$builtInFormats[53] = 'm"月"d"日"';
392	171	self::$builtInFormats[54] = '[$-411]ggge"年"m"月"d"日"';
393	171	self::$builtInFormats[55] = 'yyyy"年"m"月"';
394		self::$builtInFormats[56] = 'm"月"d"日"';
395		self::$builtInFormats[58] = '[$-411]ggge"年"m"月"d"日"';
396	171
397		// Flip array (for faster lookups)
398		self::$flippedBuiltInFormats = array_flip(self::$builtInFormats);
399		}
400		}
401
402		/**
403	1160	* Get built-in format code.
404		*/
405		public static function builtInFormatCode(int $index): string
406	1160	{
407		// Clean parameter
408		$index = (int) $index;
409	1160
410		// Ensure built-in format codes are available
411		self::fillBuiltInFormatCodes();
412	1160
413	1160	// Lookup format code
414		if (isset(self::$builtInFormats[$index])) {
415		return self::$builtInFormats[$index];
416	20	}
417
418		return '';
419		}
420
421		/**
422		* Get built-in format code index.
423		*
424	1475	* @return false\|int
425		*/
426		public static function builtInFormatCodeIndex(string $formatCodeIndex)
427	1475	{
428		// Ensure built-in format codes are available
429		self::fillBuiltInFormatCodes();
430	1475
431	1073	// Lookup format code
432		if (array_key_exists($formatCodeIndex, self::$flippedBuiltInFormats)) {
433		return self::$flippedBuiltInFormats[$formatCodeIndex];
434	766	}
435
436		return false;
437		}
438
439		/**
440		* Update Hash when something changes.
441		*/
442	1248	protected function updateHash(): void
443		{
444	1248	$this->md5Sum = md5(
445	3	$this->formatCode
446		. $this->builtInFormatCode
447		. __CLASS__
448	1248	);
449	1248	$this->updateMd5Sum = false;
450	1248	}
451	1248
452	1248	/**
453		* Get hash code.
454		*
455		* @return string Hash code
456		*/
457		public function getHashCode(): string
458		{
459		if ($this->isSupervisor) {
460		return $this->getSharedComponent()->getHashCode();
461		}
462
463		if ($this->updateMd5Sum) {
464		$this->updateHash();
465	1257	}
466
467	1257	return $this->md5Sum;
468		}
469
470	14	/**
471		* Convert a value in a pre-defined format to a PHP string.
472	14	*
473	14	* @param null\|bool\|float\|int\|RichText\|string $value Value to format
474		* @param string $format Format code: see = self::FORMAT_* for predefined values;
475	14	* or can be any valid MS Excel custom format string
476		* @param ?array $callBack Callback function for additional formatting of string
477		*
478	2	* @return string Formatted string
479		*/
480	2	public static function toFormattedString(mixed $value, string $format, ?array $callBack = null): string
481		{
482		return NumberFormat\Formatter::toFormattedString($value, $format, $callBack);
483	2	}
484
485	2	protected function exportArray1(): array
486		{
487		$exportedArray = [];
488	2	$this->exportArray2($exportedArray, 'formatCode', $this->getFormatCode());
489
490	2	return $exportedArray;
491		}
492
493	2	public static function getShortDateFormat(): string
494		{
495	2	return self::$shortDateFormat;
496		}
497
498	2	public static function setShortDateFormat(string $shortDateFormat): void
499		{
500	2	self::$shortDateFormat = $shortDateFormat;
501		}
502
503	2	public static function getLongDateFormat(): string
504		{
505	2	return self::$longDateFormat;
506		}
507
508	2	public static function setLongDateFormat(string $longDateFormat): void
509		{
510	2	self::$longDateFormat = $longDateFormat;
511		}
512
513	2	public static function getDateTimeFormat(): string
514		{
515	2	return self::$dateTimeFormat;
516		}
517
518		public static function setDateTimeFormat(string $dateTimeFormat): void
519		{
520		self::$dateTimeFormat = $dateTimeFormat;
521		}
522
523		public static function getTimeFormat(): string
524		{
525		return self::$timeFormat;
526		}
527
528		public static function setTimeFormat(string $timeFormat): void
529		{
530		self::$timeFormat = $timeFormat;
531		}
532		}
533

PHPOffice / PhpSpreadsheet

Pull Request — master (#4426)

NumberFormat::setLongDateFormat() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like