StyleManager::getCustomNumberFormats() - Code Metrics - box/spout - Measure and Improve Code Quality continuously with Scrutinizer

StyleManager::getCustomNumberFormats() A
last analyzed 2021-06-07 10:47 UTC

↳ Parent: StyleManager

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	2.0625

Importance

Changes

Metric	Value
dl	0
loc	8
ccs	3
cts	4
cp	0.75
rs	10
c	0
b	0
f	0
cc	2
nc	2
nop	0
crap	2.0625

<?php

namespace Box\Spout\Reader\XLSX\Manager;

use Box\Spout\Reader\XLSX\Creator\InternalEntityFactory;

/**
 * Class StyleManager
 * This class manages XLSX styles
 */
class StyleManager
{
    /** Nodes used to find relevant information in the styles XML file */
    const XML_NODE_NUM_FMTS = 'numFmts';
    const XML_NODE_NUM_FMT = 'numFmt';
    const XML_NODE_CELL_XFS = 'cellXfs';
    const XML_NODE_XF = 'xf';

    /** Attributes used to find relevant information in the styles XML file */
    const XML_ATTRIBUTE_NUM_FMT_ID = 'numFmtId';
    const XML_ATTRIBUTE_FORMAT_CODE = 'formatCode';
    const XML_ATTRIBUTE_APPLY_NUMBER_FORMAT = 'applyNumberFormat';

    /** By convention, default style ID is 0 */
    const DEFAULT_STYLE_ID = 0;

    const NUMBER_FORMAT_GENERAL = 'General';

    /**
     * @see https://msdn.microsoft.com/en-us/library/ff529597(v=office.12).aspx
     * @var array Mapping between built-in numFmtId and the associated format - for dates only
     */
    protected static $builtinNumFmtIdToNumFormatMapping = [
        14 => 'm/d/yyyy', // @NOTE: ECMA spec is 'mm-dd-yy'
        15 => 'd-mmm-yy',
        16 => 'd-mmm',
        17 => 'mmm-yy',
        18 => 'h:mm AM/PM',
        19 => 'h:mm:ss AM/PM',
        20 => 'h:mm',
        21 => 'h:mm:ss',
        22 => 'm/d/yyyy h:mm', // @NOTE: ECMA spec is 'm/d/yy h:mm',
        45 => 'mm:ss',
        46 => '[h]:mm:ss',
        47 => 'mm:ss.0',  // @NOTE: ECMA spec is 'mmss.0',
    ];

    /** @var string Path of the XLSX file being read */
    protected $filePath;

    /** @var bool Whether the XLSX file contains a styles XML file */
    protected $hasStylesXMLFile;

    /** @var string|null Path of the styles XML file */
    protected $stylesXMLFilePath;

    /** @var InternalEntityFactory Factory to create entities */
    protected $entityFactory;

    /** @var array Array containing the IDs of built-in number formats indicating a date */
    protected $builtinNumFmtIdIndicatingDates;

    /** @var array Array containing a mapping NUM_FMT_ID => FORMAT_CODE */
    protected $customNumberFormats;

    /** @var array Array containing a mapping STYLE_ID => [STYLE_ATTRIBUTES] */
    protected $stylesAttributes;

    /** @var array Cache containing a mapping NUM_FMT_ID => IS_DATE_FORMAT. Used to avoid lots of recalculations */
    protected $numFmtIdToIsDateFormatCache = [];

    /**
     * @param string $filePath Path of the XLSX file being read
     * @param WorkbookRelationshipsManager $workbookRelationshipsManager Helps retrieving workbook relationships
     * @param InternalEntityFactory $entityFactory Factory to create entities
     */
    public function __construct($filePath, $workbookRelationshipsManager, $entityFactory)
    {
        $this->filePath = $filePath;
        $this->entityFactory = $entityFactory;
        $this->builtinNumFmtIdIndicatingDates = \array_keys(self::$builtinNumFmtIdToNumFormatMapping);
        $this->hasStylesXMLFile = $workbookRelationshipsManager->hasStylesXMLFile();
        if ($this->hasStylesXMLFile) {
            $this->stylesXMLFilePath = $workbookRelationshipsManager->getStylesXMLFilePath();
        }
    }

    /**
     * Returns whether the style with the given ID should consider
     * numeric values as timestamps and format the cell as a date.
     *
     * @param int $styleId Zero-based style ID
     * @return bool Whether the cell with the given cell should display a date instead of a numeric value
     */
    public function shouldFormatNumericValueAsDate($styleId)
    {
        if (!$this->hasStylesXMLFile) {
            return false;
        }

        $stylesAttributes = $this->getStylesAttributes();

        // Default style (0) does not format numeric values as timestamps. Only custom styles do.
        // Also if the style ID does not exist in the styles.xml file, format as numeric value.
        // Using isset here because it is way faster than array_key_exists...
        if ($styleId === self::DEFAULT_STYLE_ID || !isset($stylesAttributes[$styleId])) {
            return false;
        }

        $styleAttributes = $stylesAttributes[$styleId];

        return $this->doesStyleIndicateDate($styleAttributes);
    }

    /**
     * Reads the styles.xml file and extract the relevant information from the file.
     *
     * @return void
     */
    protected function extractRelevantInfo()
    {
        $this->customNumberFormats = [];
        $this->stylesAttributes = [];

        $xmlReader = $this->entityFactory->createXMLReader();

        if ($xmlReader->openFileInZip($this->filePath, $this->stylesXMLFilePath)) {
            while ($xmlReader->read()) {
                if ($xmlReader->isPositionedOnStartingNode(self::XML_NODE_NUM_FMTS)) {
                    $this->extractNumberFormats($xmlReader);
                } elseif ($xmlReader->isPositionedOnStartingNode(self::XML_NODE_CELL_XFS)) {
                    $this->extractStyleAttributes($xmlReader);
                }
            }

            $xmlReader->close();
        }
    }

    /**
     * Extracts number formats from the "numFmt" nodes.
     * For simplicity, the styles attributes are kept in memory. This is possible thanks
     * to the reuse of formats. So 1 million cells should not use 1 million formats.
     *
     * @param \Box\Spout\Reader\Wrapper\XMLReader $xmlReader XML Reader positioned on the "numFmts" node
     * @return void
     */
    protected function extractNumberFormats($xmlReader)
    {
        while ($xmlReader->read()) {
            if ($xmlReader->isPositionedOnStartingNode(self::XML_NODE_NUM_FMT)) {
                $numFmtId = (int) ($xmlReader->getAttribute(self::XML_ATTRIBUTE_NUM_FMT_ID));
                $formatCode = $xmlReader->getAttribute(self::XML_ATTRIBUTE_FORMAT_CODE);
                $this->customNumberFormats[$numFmtId] = $formatCode;
            } elseif ($xmlReader->isPositionedOnEndingNode(self::XML_NODE_NUM_FMTS)) {
                // Once done reading "numFmts" node's children
                break;
            }
        }
    }

    /**
     * Extracts style attributes from the "xf" nodes, inside the "cellXfs" section.
     * For simplicity, the styles attributes are kept in memory. This is possible thanks
     * to the reuse of styles. So 1 million cells should not use 1 million styles.
     *
     * @param \Box\Spout\Reader\Wrapper\XMLReader $xmlReader XML Reader positioned on the "cellXfs" node
     * @return void
     */
    protected function extractStyleAttributes($xmlReader)
    {
        while ($xmlReader->read()) {
            if ($xmlReader->isPositionedOnStartingNode(self::XML_NODE_XF)) {
                $numFmtId = $xmlReader->getAttribute(self::XML_ATTRIBUTE_NUM_FMT_ID);
                $normalizedNumFmtId = ($numFmtId !== null) ? (int) $numFmtId : null;

                $applyNumberFormat = $xmlReader->getAttribute(self::XML_ATTRIBUTE_APPLY_NUMBER_FORMAT);
                $normalizedApplyNumberFormat = ($applyNumberFormat !== null) ? (bool) $applyNumberFormat : null;

                $this->stylesAttributes[] = [
                    self::XML_ATTRIBUTE_NUM_FMT_ID          => $normalizedNumFmtId,
                    self::XML_ATTRIBUTE_APPLY_NUMBER_FORMAT => $normalizedApplyNumberFormat,
                ];
            } elseif ($xmlReader->isPositionedOnEndingNode(self::XML_NODE_CELL_XFS)) {
                // Once done reading "cellXfs" node's children
                break;
            }
        }
    }

    /**
     * @return array The custom number formats
     */
    protected function getCustomNumberFormats()
    {
        if (!isset($this->customNumberFormats)) {
            $this->extractRelevantInfo();
        }

        return $this->customNumberFormats;
    }

    /**
     * @return array The styles attributes
     */
    protected function getStylesAttributes()
    {
        if (!isset($this->stylesAttributes)) {
            $this->extractRelevantInfo();
        }

        return $this->stylesAttributes;
    }

    /**
     * @param array $styleAttributes Array containing the style attributes (2 keys: "applyNumberFormat" and "numFmtId")
     * @return bool Whether the style with the given attributes indicates that the number is a date
     */
    protected function doesStyleIndicateDate($styleAttributes)
    {
        $applyNumberFormat = $styleAttributes[self::XML_ATTRIBUTE_APPLY_NUMBER_FORMAT];
        $numFmtId = $styleAttributes[self::XML_ATTRIBUTE_NUM_FMT_ID];

        // A style may apply a date format if it has:
        //  - "applyNumberFormat" attribute not set to "false"
        //  - "numFmtId" attribute set
        // This is a preliminary check, as having "numFmtId" set just means the style should apply a specific number format,
        // but this is not necessarily a date.
        if ($applyNumberFormat === false || $numFmtId === null) {
            return false;
        }

        return $this->doesNumFmtIdIndicateDate($numFmtId);
    }

    /**
     * Returns whether the number format ID indicates that the number is a date.
     * The result is cached to avoid recomputing the same thing over and over, as
     * "numFmtId" attributes can be shared between multiple styles.
     *
     * @param int $numFmtId
     * @return bool Whether the number format ID indicates that the number is a date
     */
    protected function doesNumFmtIdIndicateDate($numFmtId)
    {
        if (!isset($this->numFmtIdToIsDateFormatCache[$numFmtId])) {
            $formatCode = $this->getFormatCodeForNumFmtId($numFmtId);

            $this->numFmtIdToIsDateFormatCache[$numFmtId] = (
                $this->isNumFmtIdBuiltInDateFormat($numFmtId) ||
                $this->isFormatCodeCustomDateFormat($formatCode)
            );
        }

        return $this->numFmtIdToIsDateFormatCache[$numFmtId];
    }

    /**
     * @param int $numFmtId
     * @return string|null The custom number format or NULL if none defined for the given numFmtId
     */
    protected function getFormatCodeForNumFmtId($numFmtId)
    {
        $customNumberFormats = $this->getCustomNumberFormats();

        // Using isset here because it is way faster than array_key_exists...
        return (isset($customNumberFormats[$numFmtId])) ? $customNumberFormats[$numFmtId] : null;
    }

    /**
     * @param int $numFmtId
     * @return bool Whether the number format ID indicates that the number is a date
     */
    protected function isNumFmtIdBuiltInDateFormat($numFmtId)
    {
        return \in_array($numFmtId, $this->builtinNumFmtIdIndicatingDates);
    }

    /**
     * @param string|null $formatCode
     * @return bool Whether the given format code indicates that the number is a date
     */
    protected function isFormatCodeCustomDateFormat($formatCode)
    {
        // if no associated format code or if using the default "General" format
        if ($formatCode === null || \strcasecmp($formatCode, self::NUMBER_FORMAT_GENERAL) === 0) {
            return false;
        }

        return $this->isFormatCodeMatchingDateFormatPattern($formatCode);
    }

    /**
     * @param string $formatCode
     * @return bool Whether the given format code matches a date format pattern
     */
    protected function isFormatCodeMatchingDateFormatPattern($formatCode)
    {
        // Remove extra formatting (what's between [ ], the brackets should not be preceded by a "\")
        $pattern = '((?<!\\\)\[.+?(?<!\\\)\])';
        $formatCode = \preg_replace($pattern, '', $formatCode);

        // custom date formats contain specific characters to represent the date:
        // e - yy - m - d - h - s
        // and all of their variants (yyyy - mm - dd...)
        $dateFormatCharacters = ['e', 'yy', 'm', 'd', 'h', 's'];

        $hasFoundDateFormatCharacter = false;
        foreach ($dateFormatCharacters as $dateFormatCharacter) {
            // character not preceded by "\" (case insensitive)
            $pattern = '/(?<!\\\)' . $dateFormatCharacter . '/i';

            if (\preg_match($pattern, $formatCode)) {
                $hasFoundDateFormatCharacter = true;
                break;
            }
        }

        return $hasFoundDateFormatCharacter;
    }

    /**
     * Returns the format as defined in "styles.xml" of the given style.
     * NOTE: It is assumed that the style DOES have a number format associated to it.
     *
     * @param int $styleId Zero-based style ID
     * @return string The number format code associated with the given style
     */
    public function getNumberFormatCode($styleId)
    {
        $stylesAttributes = $this->getStylesAttributes();
        $styleAttributes = $stylesAttributes[$styleId];
        $numFmtId = $styleAttributes[self::XML_ATTRIBUTE_NUM_FMT_ID];

        if ($this->isNumFmtIdBuiltInDateFormat($numFmtId)) {
            $numberFormatCode = self::$builtinNumFmtIdToNumFormatMapping[$numFmtId];
        } else {
            $customNumberFormats = $this->getCustomNumberFormats();
            $numberFormatCode = $customNumberFormats[$numFmtId];
        }

        return $numberFormatCode;
    }
}


1		<?php
2
3		namespace Box\Spout\Reader\XLSX\Manager;
4
5		use Box\Spout\Reader\XLSX\Creator\InternalEntityFactory;
6
7		/**
8		* Class StyleManager
9		* This class manages XLSX styles
10		*/
11		class StyleManager
12		{
13		/** Nodes used to find relevant information in the styles XML file */
14		const XML_NODE_NUM_FMTS = 'numFmts';
15		const XML_NODE_NUM_FMT = 'numFmt';
16		const XML_NODE_CELL_XFS = 'cellXfs';
17		const XML_NODE_XF = 'xf';
18
19		/** Attributes used to find relevant information in the styles XML file */
20		const XML_ATTRIBUTE_NUM_FMT_ID = 'numFmtId';
21		const XML_ATTRIBUTE_FORMAT_CODE = 'formatCode';
22		const XML_ATTRIBUTE_APPLY_NUMBER_FORMAT = 'applyNumberFormat';
23
24		/** By convention, default style ID is 0 */
25		const DEFAULT_STYLE_ID = 0;
26
27		const NUMBER_FORMAT_GENERAL = 'General';
28
29		/**
30		* @see https://msdn.microsoft.com/en-us/library/ff529597(v=office.12).aspx
31		* @var array Mapping between built-in numFmtId and the associated format - for dates only
32		*/
33		protected static $builtinNumFmtIdToNumFormatMapping = [
34		14 => 'm/d/yyyy', // @NOTE: ECMA spec is 'mm-dd-yy'
35		15 => 'd-mmm-yy',
36		16 => 'd-mmm',
37		17 => 'mmm-yy',
38		18 => 'h:mm AM/PM',
39		19 => 'h:mm:ss AM/PM',
40		20 => 'h:mm',
41		21 => 'h:mm:ss',
42		22 => 'm/d/yyyy h:mm', // @NOTE: ECMA spec is 'm/d/yy h:mm',
43		45 => 'mm:ss',
44		46 => '[h]:mm:ss',
45		47 => 'mm:ss.0', // @NOTE: ECMA spec is 'mmss.0',
46		];
47
48		/** @var string Path of the XLSX file being read */
49		protected $filePath;
50
51		/** @var bool Whether the XLSX file contains a styles XML file */
52		protected $hasStylesXMLFile;
53
54		/** @var string\|null Path of the styles XML file */
55		protected $stylesXMLFilePath;
56
57		/** @var InternalEntityFactory Factory to create entities */
58		protected $entityFactory;
59
60		/** @var array Array containing the IDs of built-in number formats indicating a date */
61		protected $builtinNumFmtIdIndicatingDates;
62
63		/** @var array Array containing a mapping NUM_FMT_ID => FORMAT_CODE */
64		protected $customNumberFormats;
65
66		/** @var array Array containing a mapping STYLE_ID => [STYLE_ATTRIBUTES] */
67		protected $stylesAttributes;
68
69		/** @var array Cache containing a mapping NUM_FMT_ID => IS_DATE_FORMAT. Used to avoid lots of recalculations */
70		protected $numFmtIdToIsDateFormatCache = [];
71
72		/**
73		* @param string $filePath Path of the XLSX file being read
74		* @param WorkbookRelationshipsManager $workbookRelationshipsManager Helps retrieving workbook relationships
75		* @param InternalEntityFactory $entityFactory Factory to create entities
76		*/
77	74	public function __construct($filePath, $workbookRelationshipsManager, $entityFactory)
78		{
79	74	$this->filePath = $filePath;
80	74	$this->entityFactory = $entityFactory;
81	74	$this->builtinNumFmtIdIndicatingDates = \array_keys(self::$builtinNumFmtIdToNumFormatMapping);
82	74	$this->hasStylesXMLFile = $workbookRelationshipsManager->hasStylesXMLFile();
83	74	if ($this->hasStylesXMLFile) {
84	73	$this->stylesXMLFilePath = $workbookRelationshipsManager->getStylesXMLFilePath();
85		}
86	74	}
87
88		/**
89		* Returns whether the style with the given ID should consider
90		* numeric values as timestamps and format the cell as a date.
91		*
92		* @param int $styleId Zero-based style ID
93		* @return bool Whether the cell with the given cell should display a date instead of a numeric value
94		*/
95	46	public function shouldFormatNumericValueAsDate($styleId)
96		{
97	46	if (!$this->hasStylesXMLFile) {
98		return false;
99		}
100
101	46	$stylesAttributes = $this->getStylesAttributes();
102
103		// Default style (0) does not format numeric values as timestamps. Only custom styles do.
104		// Also if the style ID does not exist in the styles.xml file, format as numeric value.
105		// Using isset here because it is way faster than array_key_exists...
106	46	if ($styleId === self::DEFAULT_STYLE_ID \|\| !isset($stylesAttributes[$styleId])) {
107	8	return false;
108		}
109
110	38	$styleAttributes = $stylesAttributes[$styleId];
111
112	38	return $this->doesStyleIndicateDate($styleAttributes);
113		}
114
115		/**
116		* Reads the styles.xml file and extract the relevant information from the file.
117		*
118		* @return void
119		*/
120	13	protected function extractRelevantInfo()
121		{
122	13	$this->customNumberFormats = [];
123	13	$this->stylesAttributes = [];
124
125	13	$xmlReader = $this->entityFactory->createXMLReader();
126
127	13	if ($xmlReader->openFileInZip($this->filePath, $this->stylesXMLFilePath)) {
128	13	while ($xmlReader->read()) {
129	13	if ($xmlReader->isPositionedOnStartingNode(self::XML_NODE_NUM_FMTS)) {
130	9	$this->extractNumberFormats($xmlReader);
131	13	} elseif ($xmlReader->isPositionedOnStartingNode(self::XML_NODE_CELL_XFS)) {
132	13	$this->extractStyleAttributes($xmlReader);
133		}
134		}
135
136	13	$xmlReader->close();
137		}
138	13	}
139
140		/**
141		* Extracts number formats from the "numFmt" nodes.
142		* For simplicity, the styles attributes are kept in memory. This is possible thanks
143		* to the reuse of formats. So 1 million cells should not use 1 million formats.
144		*
145		* @param \Box\Spout\Reader\Wrapper\XMLReader $xmlReader XML Reader positioned on the "numFmts" node
146		* @return void
147		*/
148	9	protected function extractNumberFormats($xmlReader)
149		{
150	9	while ($xmlReader->read()) {
151	9	if ($xmlReader->isPositionedOnStartingNode(self::XML_NODE_NUM_FMT)) {
152	9	$numFmtId = (int) ($xmlReader->getAttribute(self::XML_ATTRIBUTE_NUM_FMT_ID));
153	9	$formatCode = $xmlReader->getAttribute(self::XML_ATTRIBUTE_FORMAT_CODE);
154	9	$this->customNumberFormats[$numFmtId] = $formatCode;
155	9	} elseif ($xmlReader->isPositionedOnEndingNode(self::XML_NODE_NUM_FMTS)) {
156		// Once done reading "numFmts" node's children
157	9	break;
158		}
159		}
160	9	}
161
162		/**
163		* Extracts style attributes from the "xf" nodes, inside the "cellXfs" section.
164		* For simplicity, the styles attributes are kept in memory. This is possible thanks
165		* to the reuse of styles. So 1 million cells should not use 1 million styles.
166		*
167		* @param \Box\Spout\Reader\Wrapper\XMLReader $xmlReader XML Reader positioned on the "cellXfs" node
168		* @return void
169		*/
170	13	protected function extractStyleAttributes($xmlReader)
171		{
172	13	while ($xmlReader->read()) {
173	13	if ($xmlReader->isPositionedOnStartingNode(self::XML_NODE_XF)) {
174	13	$numFmtId = $xmlReader->getAttribute(self::XML_ATTRIBUTE_NUM_FMT_ID);
175	13	$normalizedNumFmtId = ($numFmtId !== null) ? (int) $numFmtId : null;
176
177	13	$applyNumberFormat = $xmlReader->getAttribute(self::XML_ATTRIBUTE_APPLY_NUMBER_FORMAT);
178	13	$normalizedApplyNumberFormat = ($applyNumberFormat !== null) ? (bool) $applyNumberFormat : null;
179
180	13	$this->stylesAttributes[] = [
181	13	self::XML_ATTRIBUTE_NUM_FMT_ID => $normalizedNumFmtId,
182	13	self::XML_ATTRIBUTE_APPLY_NUMBER_FORMAT => $normalizedApplyNumberFormat,
183		];
184	13	} elseif ($xmlReader->isPositionedOnEndingNode(self::XML_NODE_CELL_XFS)) {
185		// Once done reading "cellXfs" node's children
186	13	break;
187		}
188		}
189	13	}
190
191		/**
192		* @return array The custom number formats
193		*/
194	6	protected function getCustomNumberFormats()
195		{
196	6	if (!isset($this->customNumberFormats)) {
197		$this->extractRelevantInfo();
198		}
199
200	6	return $this->customNumberFormats;
201		}
202
203		/**
204		* @return array The styles attributes
205		*/
206	13	protected function getStylesAttributes()
207		{
208	13	if (!isset($this->stylesAttributes)) {
209	13	$this->extractRelevantInfo();
210		}
211
212	13	return $this->stylesAttributes;
213		}
214
215		/**
216		* @param array $styleAttributes Array containing the style attributes (2 keys: "applyNumberFormat" and "numFmtId")
217		* @return bool Whether the style with the given attributes indicates that the number is a date
218		*/
219	38	protected function doesStyleIndicateDate($styleAttributes)
220		{
221	38	$applyNumberFormat = $styleAttributes[self::XML_ATTRIBUTE_APPLY_NUMBER_FORMAT];
222	38	$numFmtId = $styleAttributes[self::XML_ATTRIBUTE_NUM_FMT_ID];
223
224		// A style may apply a date format if it has:
225		// - "applyNumberFormat" attribute not set to "false"
226		// - "numFmtId" attribute set
227		// This is a preliminary check, as having "numFmtId" set just means the style should apply a specific number format,
228		// but this is not necessarily a date.
229	38	if ($applyNumberFormat === false \|\| $numFmtId === null) {
230	2	return false;
231		}
232
233	36	return $this->doesNumFmtIdIndicateDate($numFmtId);
234		}
235
236		/**
237		* Returns whether the number format ID indicates that the number is a date.
238		* The result is cached to avoid recomputing the same thing over and over, as
239		* "numFmtId" attributes can be shared between multiple styles.
240		*
241		* @param int $numFmtId
242		* @return bool Whether the number format ID indicates that the number is a date
243		*/
244	36	protected function doesNumFmtIdIndicateDate($numFmtId)
245		{
246	36	if (!isset($this->numFmtIdToIsDateFormatCache[$numFmtId])) {
247	36	$formatCode = $this->getFormatCodeForNumFmtId($numFmtId);
248
249	36	$this->numFmtIdToIsDateFormatCache[$numFmtId] = (
250	36	$this->isNumFmtIdBuiltInDateFormat($numFmtId) \|\|
251	34	$this->isFormatCodeCustomDateFormat($formatCode)
252		);
253		}
254
255	36	return $this->numFmtIdToIsDateFormatCache[$numFmtId];
256		}
257
258		/**
259		* @param int $numFmtId
260		* @return string\|null The custom number format or NULL if none defined for the given numFmtId
261		*/
262	36	protected function getFormatCodeForNumFmtId($numFmtId)
263		{
264	36	$customNumberFormats = $this->getCustomNumberFormats();
265
266		// Using isset here because it is way faster than array_key_exists...
267	36	return (isset($customNumberFormats[$numFmtId])) ? $customNumberFormats[$numFmtId] : null;
268		}
269
270		/**
271		* @param int $numFmtId
272		* @return bool Whether the number format ID indicates that the number is a date
273		*/
274	36	protected function isNumFmtIdBuiltInDateFormat($numFmtId)
275		{
276	36	return \in_array($numFmtId, $this->builtinNumFmtIdIndicatingDates);
277		}
278
279		/**
280		* @param string\|null $formatCode
281		* @return bool Whether the given format code indicates that the number is a date
282		*/
283	34	protected function isFormatCodeCustomDateFormat($formatCode)
284		{
285		// if no associated format code or if using the default "General" format
286	34	if ($formatCode === null \|\| \strcasecmp($formatCode, self::NUMBER_FORMAT_GENERAL) === 0) {
287	7	return false;
288		}
289
290	28	return $this->isFormatCodeMatchingDateFormatPattern($formatCode);
291		}
292
293		/**
294		* @param string $formatCode
295		* @return bool Whether the given format code matches a date format pattern
296		*/
297	28	protected function isFormatCodeMatchingDateFormatPattern($formatCode)
298		{
299		// Remove extra formatting (what's between [ ], the brackets should not be preceded by a "\")
300	28	$pattern = '((?<!\\\)\[.+?(?<!\\\)\])';
301	28	$formatCode = \preg_replace($pattern, '', $formatCode);
302
303		// custom date formats contain specific characters to represent the date:
304		// e - yy - m - d - h - s
305		// and all of their variants (yyyy - mm - dd...)
306	28	$dateFormatCharacters = ['e', 'yy', 'm', 'd', 'h', 's'];
307
308	28	$hasFoundDateFormatCharacter = false;
309	28	foreach ($dateFormatCharacters as $dateFormatCharacter) {
310		// character not preceded by "\" (case insensitive)
311	28	$pattern = '/(?<!\\\)' . $dateFormatCharacter . '/i';
312
313	28	if (\preg_match($pattern, $formatCode)) {
314	26	$hasFoundDateFormatCharacter = true;
315	26	break;
316		}
317		}
318
319	28	return $hasFoundDateFormatCharacter;
320		}
321
322		/**
323		* Returns the format as defined in "styles.xml" of the given style.
324		* NOTE: It is assumed that the style DOES have a number format associated to it.
325		*
326		* @param int $styleId Zero-based style ID
327		* @return string The number format code associated with the given style
328		*/
329	2	public function getNumberFormatCode($styleId)
330		{
331	2	$stylesAttributes = $this->getStylesAttributes();
332	2	$styleAttributes = $stylesAttributes[$styleId];
333	2	$numFmtId = $styleAttributes[self::XML_ATTRIBUTE_NUM_FMT_ID];
334
335	2	if ($this->isNumFmtIdBuiltInDateFormat($numFmtId)) {
336	1	$numberFormatCode = self::$builtinNumFmtIdToNumFormatMapping[$numFmtId];
337		} else {
338	2	$customNumberFormats = $this->getCustomNumberFormats();
339	2	$numberFormatCode = $customNumberFormats[$numFmtId];
340		}
341
342	2	return $numberFormatCode;
343		}
344		}
345

box / spout

StyleManager::getCustomNumberFormats() A last analyzed 2021-06-07 10:47 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

StyleManager::getCustomNumberFormats() A
last analyzed 2021-06-07 10:47 UTC