DateFormatHelper::toPHPDateFormat() - Code Metrics - Inspection of "Option to return formatted dates instead of PHP ob..." - box/spout - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#226)

by Adrien

created 2016-05-20 22:39 UTC

DateFormatHelper::toPHPDateFormat() B

↳ Parent: DateFormatHelper

Complexity

Conditions	4
Paths	4

Size

Total Lines	51
Code Lines	21

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	51
rs	8.8981
cc	4
eloc	21
nc	4
nop	1

How to fix Long Method

<?php

namespace Box\Spout\Reader\XLSX\Helper;

/**
 * Class DateFormatHelper
 * This class provides helper functions to format Excel dates
 *
 * @package Box\Spout\Reader\XLSX\Helper
 */
class DateFormatHelper
{
    const KEY_GENERAL = 'general';
    const KEY_HOUR_12 = '12h';
    const KEY_HOUR_24 = '24h';

    /**
     * This map is used to replace Excel format characters by their PHP equivalent.
     * Keys should be ordered from longest to smallest.
     *
     * @var array Mapping between Excel format characters and PHP format characters
     */
    private static $excelDateFormatToPHPDateFormatMapping = [
        self::KEY_GENERAL => [
            // Time
            'am/pm' => 'A',  // Uppercase Ante meridiem and Post meridiem
            ':mm'   => ':i', // Minutes with leading zeros - if preceded by a ":" (otherwise month)
            'mm:'   => 'i:', // Minutes with leading zeros - if followed by a ":" (otherwise month)
            'ss'    => 's',  // Seconds, with leading zeros
            '.s'    => '',   // Ignore (fractional seconds format does not exist in PHP)

            // Date
            'e'     => 'Y',  // Full numeric representation of a year, 4 digits
            'yyyy'  => 'Y',  // Full numeric representation of a year, 4 digits
            'yy'    => 'y',  // Two digit representation of a year
            'mmmmm' => 'M',  // Short textual representation of a month, three letters ("mmmmm" should only contain the 1st letter...)
            'mmmm'  => 'F',  // Full textual representation of a month
            'mmm'   => 'M',  // Short textual representation of a month, three letters
            'mm'    => 'm',  // Numeric representation of a month, with leading zeros
            'm'     => 'n',  // Numeric representation of a month, without leading zeros
            'dddd'  => 'l',  // Full textual representation of the day of the week
            'ddd'   => 'D',  // Textual representation of a day, three letters
            'dd'    => 'd',  // Day of the month, 2 digits with leading zeros
            'd'     => 'j',  // Day of the month without leading zeros
        ],
        self::KEY_HOUR_12 => [
            'hh'    => 'h',  // 12-hour format of an hour without leading zeros
            'h'     => 'g',  // 12-hour format of an hour without leading zeros
        ],
        self::KEY_HOUR_24 => [
            'hh'    => 'H',  // 24-hour hours with leading zero
            'h'     => 'G',  // 24-hour format of an hour without leading zeros
        ],
    ];

    /**
     * Converts the given Excel date format to a format understandable by the PHP date function.
     *
     * @param string $excelDateFormat Excel date format
     * @return string PHP date format (as defined here: http://php.net/manual/en/function.date.php)
     */
    public static function toPHPDateFormat($excelDateFormat)
    {
        // Remove brackets potentially present at the beginning of the format string
        $dateFormat = preg_replace('/^(\[\$[^\]]+?\])/i', '', $excelDateFormat);

        // Double quotes are used to escape characters that must not be interpreted.
        // For instance, ["Day " dd] should result in "Day 13" and we should not try to interpret "D", "a", "y"
        // By exploding the format string using double quote as a delimiter, we can get all parts
        // that must be transformed (even indexes) and all parts that must not be (odd indexes).
        $dateFormatParts = explode('"', $dateFormat);

        foreach ($dateFormatParts as $partIndex => $dateFormatPart) {
            // do not look at odd indexes
            if ($partIndex % 2 === 1) {
                continue;
            }

            // Make sure all characters are lowercase, as the mapping table is using lowercase characters
            $transformedPart = strtolower($dateFormatPart);

            // Remove escapes related to non-format characters
            $transformedPart = str_replace('\\', '', $transformedPart);

            // Apply general transformation first...
            $transformedPart = strtr($transformedPart, self::$excelDateFormatToPHPDateFormatMapping[self::KEY_GENERAL]);

            // ... then apply hour transformation, for 12-hour or 24-hour format
            if (self::has12HourFormatMarker($dateFormatPart)) {
                $transformedPart = strtr($transformedPart, self::$excelDateFormatToPHPDateFormatMapping[self::KEY_HOUR_12]);
            } else {
                $transformedPart = strtr($transformedPart, self::$excelDateFormatToPHPDateFormatMapping[self::KEY_HOUR_24]);
            }

            // overwrite the parts array with the new transformed part
            $dateFormatParts[$partIndex] = $transformedPart;
        }

        // Merge all transformed parts back together
        $phpDateFormat = implode('"', $dateFormatParts);

        // Finally, to have the date format compatible with the DateTime::format() function, we need to escape
        // all characters that are inside double quotes (and double quotes must be removed).
        // For instance, ["Day " dd] should become [\D\a\y\ dd]
        $phpDateFormat = preg_replace_callback('/"(.+?)"/', function($matches) {
            $stringToEscape = $matches[1];
            $letters = preg_split('//u', $stringToEscape, -1, PREG_SPLIT_NO_EMPTY);
            return '\\' . implode('\\', $letters);
        }, $phpDateFormat);

        return $phpDateFormat;
    }

    /**
     * @param string $excelDateFormat Date format as defined by Excel
     * @return bool Whether the given date format has the 12-hour format marker
     */
    private static function has12HourFormatMarker($excelDateFormat)
    {
        return (stripos($excelDateFormat, 'am/pm') !== false);
    }
}


1			<?php
2
3			namespace Box\Spout\Reader\XLSX\Helper;
4
5			/**
6			* Class DateFormatHelper
7			* This class provides helper functions to format Excel dates
8			*
9			* @package Box\Spout\Reader\XLSX\Helper
10			*/
11			class DateFormatHelper
12			{
13			const KEY_GENERAL = 'general';
14			const KEY_HOUR_12 = '12h';
15			const KEY_HOUR_24 = '24h';
16
17			/**
18			* This map is used to replace Excel format characters by their PHP equivalent.
19			* Keys should be ordered from longest to smallest.
20			*
21			* @var array Mapping between Excel format characters and PHP format characters
22			*/
23			private static $excelDateFormatToPHPDateFormatMapping = [
24			self::KEY_GENERAL => [
25			// Time
26			'am/pm' => 'A', // Uppercase Ante meridiem and Post meridiem
27			':mm' => ':i', // Minutes with leading zeros - if preceded by a ":" (otherwise month)
28			'mm:' => 'i:', // Minutes with leading zeros - if followed by a ":" (otherwise month)
29			'ss' => 's', // Seconds, with leading zeros
30			'.s' => '', // Ignore (fractional seconds format does not exist in PHP)
31
32			// Date
33			'e' => 'Y', // Full numeric representation of a year, 4 digits
34			'yyyy' => 'Y', // Full numeric representation of a year, 4 digits
35			'yy' => 'y', // Two digit representation of a year
36			'mmmmm' => 'M', // Short textual representation of a month, three letters ("mmmmm" should only contain the 1st letter...)
37			'mmmm' => 'F', // Full textual representation of a month
38			'mmm' => 'M', // Short textual representation of a month, three letters
39			'mm' => 'm', // Numeric representation of a month, with leading zeros
40			'm' => 'n', // Numeric representation of a month, without leading zeros
41			'dddd' => 'l', // Full textual representation of the day of the week
42			'ddd' => 'D', // Textual representation of a day, three letters
43			'dd' => 'd', // Day of the month, 2 digits with leading zeros
44			'd' => 'j', // Day of the month without leading zeros
45			],
46			self::KEY_HOUR_12 => [
47			'hh' => 'h', // 12-hour format of an hour without leading zeros
48			'h' => 'g', // 12-hour format of an hour without leading zeros
49			],
50			self::KEY_HOUR_24 => [
51			'hh' => 'H', // 24-hour hours with leading zero
52			'h' => 'G', // 24-hour format of an hour without leading zeros
53			],
54			];
55
56			/**
57			* Converts the given Excel date format to a format understandable by the PHP date function.
58			*
59			* @param string $excelDateFormat Excel date format
60			* @return string PHP date format (as defined here: http://php.net/manual/en/function.date.php)
61			*/
62			public static function toPHPDateFormat($excelDateFormat)
63			{
64			// Remove brackets potentially present at the beginning of the format string
65			$dateFormat = preg_replace('/^(\[\$[^\]]+?\])/i', '', $excelDateFormat);
66
67			// Double quotes are used to escape characters that must not be interpreted.
68			// For instance, ["Day " dd] should result in "Day 13" and we should not try to interpret "D", "a", "y"
69			// By exploding the format string using double quote as a delimiter, we can get all parts
70			// that must be transformed (even indexes) and all parts that must not be (odd indexes).
71			$dateFormatParts = explode('"', $dateFormat);
72
73			foreach ($dateFormatParts as $partIndex => $dateFormatPart) {
74			// do not look at odd indexes
75			if ($partIndex % 2 === 1) {
76			continue;
77			}
78
79			// Make sure all characters are lowercase, as the mapping table is using lowercase characters
80			$transformedPart = strtolower($dateFormatPart);
81
82			// Remove escapes related to non-format characters
83			$transformedPart = str_replace('\\', '', $transformedPart);
84
85			// Apply general transformation first...
86			$transformedPart = strtr($transformedPart, self::$excelDateFormatToPHPDateFormatMapping[self::KEY_GENERAL]);
87
88			// ... then apply hour transformation, for 12-hour or 24-hour format
89			if (self::has12HourFormatMarker($dateFormatPart)) {
90			$transformedPart = strtr($transformedPart, self::$excelDateFormatToPHPDateFormatMapping[self::KEY_HOUR_12]);
91			} else {
92			$transformedPart = strtr($transformedPart, self::$excelDateFormatToPHPDateFormatMapping[self::KEY_HOUR_24]);
93			}
94
95			// overwrite the parts array with the new transformed part
96			$dateFormatParts[$partIndex] = $transformedPart;
97			}
98
99			// Merge all transformed parts back together
100			$phpDateFormat = implode('"', $dateFormatParts);
101
102			// Finally, to have the date format compatible with the DateTime::format() function, we need to escape
103			// all characters that are inside double quotes (and double quotes must be removed).
104			// For instance, ["Day " dd] should become [\D\a\y\ dd]
105			$phpDateFormat = preg_replace_callback('/"(.+?)"/', function($matches) {
106			$stringToEscape = $matches[1];
107			$letters = preg_split('//u', $stringToEscape, -1, PREG_SPLIT_NO_EMPTY);
108			return '\\' . implode('\\', $letters);
109			}, $phpDateFormat);
110
111			return $phpDateFormat;
112			}
113
114			/**
115			* @param string $excelDateFormat Date format as defined by Excel
116			* @return bool Whether the given date format has the 12-hour format marker
117			*/
118			private static function has12HourFormatMarker($excelDateFormat)
119			{
120			return (stripos($excelDateFormat, 'am/pm') !== false);
121			}
122			}
123

box / spout

Pull Request — master (#226)

DateFormatHelper::toPHPDateFormat() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like