diff --git a/framework/helpers/BaseFormatConverter.php b/framework/helpers/BaseFormatConverter.php new file mode 100644 index 0000000..fd3fa80 --- /dev/null +++ b/framework/helpers/BaseFormatConverter.php @@ -0,0 +1,494 @@ + + * @author Enrica Ruedin + * @since 2.0 + */ +class BaseFormatConverter +{ + /** + * @var array the php fallback definition to use for the ICU short patterns `short`, `medium`, `long` and `full`. + * This is used as fallback when the intl extension is not installed. + */ + public static $phpFallbackDatePatterns = [ + 'short' => [ + 'date' => 'n/j/y', + 'time' => 'H:i', + 'datetime' => 'n/j/y H:i', + ], + 'medium' => [ + 'date' => 'M j, Y', + 'time' => 'g:i:s A', + 'datetime' => 'M j, Y g:i:s A', + ], + 'long' => [ + 'date' => 'F j, Y', + 'time' => 'g:i:sA', + 'datetime' => 'F j, Y g:i:sA', + ], + 'full' => [ + 'date' => 'l, F j, Y', + 'time' => 'g:i:sA T', + 'datetime' => 'l, F j, Y g:i:sA T', + ], + ]; + /** + * @var array the jQuery UI fallback definition to use for the ICU short patterns `short`, `medium`, `long` and `full`. + * This is used as fallback when the intl extension is not installed. + */ + public static $juiFallbackDatePatterns = [ + 'short' => [ + 'date' => 'd/m/y', + 'time' => '', + 'datetime' => 'd/m/y', + ], + 'medium' => [ + 'date' => 'M d, yy', + 'time' => '', + 'datetime' => 'M d, yy', + ], + 'long' => [ + 'date' => 'MM d, yy', + 'time' => '', + 'datetime' => 'MM d, yy', + ], + 'full' => [ + 'date' => 'DD, MM d, yy', + 'time' => '', + 'datetime' => 'DD, MM d, yy', + ], + ]; + + private static $_icuShortFormats = [ + 'short' => 3, // IntlDateFormatter::SHORT, + 'medium' => 2, // IntlDateFormatter::MEDIUM, + 'long' => 1, // IntlDateFormatter::LONG, + 'full' => 0, // IntlDateFormatter::FULL, + ]; + + + /** + * Converts a date format pattern from [ICU format][] to [php date() function format][]. + * + * The conversion is limited to date patterns that do not use escaped characters. + * Patterns like `d 'of' MMMM yyyy` which will result in a date like `1 of December 2014` may not be converted correctly + * because of the use of escaped characters. + * + * Pattern constructs that are not supported by the PHP format will be removed. + * + * [php date() function format]: http://php.net/manual/en/function.date.php + * [ICU format]: http://userguide.icu-project.org/formatparse/datetime#TOC-Date-Time-Format-Syntax + * + * @param string $pattern date format pattern in ICU format. + * @param string $type 'date', 'time', or 'datetime'. + * @param string $locale the locale to use for converting ICU short patterns `short`, `medium`, `long` and `full`. + * If not given, `Yii::$app->language` will be used. + * @return string The converted date format pattern. + */ + public static function convertDateIcuToPhp($pattern, $type = 'date', $locale = null) + { + if (isset(self::$_icuShortFormats[$pattern])) { + if ($locale === null) { + $locale = Yii::$app->language; + } + if (extension_loaded('intl')) { + if ($type === 'date') { + $formatter = new IntlDateFormatter($locale, self::$_icuShortFormats[$pattern], IntlDateFormatter::NONE); + } elseif ($type === 'time') { + $formatter = new IntlDateFormatter($locale, IntlDateFormatter::NONE, self::$_icuShortFormats[$pattern]); + } else { + $formatter = new IntlDateFormatter($locale, self::$_icuShortFormats[$pattern], self::$_icuShortFormats[$pattern]); + } + $pattern = $formatter->getPattern(); + } else { + return static::$phpFallbackDatePatterns[$pattern][$type]; + } + } + // http://userguide.icu-project.org/formatparse/datetime#TOC-Date-Time-Format-Syntax + return strtr($pattern, [ + 'G' => '', // era designator like (Anno Domini) + 'Y' => 'o', // 4digit year of "Week of Year" + 'y' => 'Y', // 4digit year e.g. 2014 + 'yyyy' => 'Y', // 4digit year e.g. 2014 + 'yy' => 'y', // 2digit year number eg. 14 + 'u' => '', // extended year e.g. 4601 + 'U' => '', // cyclic year name, as in Chinese lunar calendar + 'r' => '', // related Gregorian year e.g. 1996 + 'Q' => '', // number of quarter + 'QQ' => '', // number of quarter '02' + 'QQQ' => '', // quarter 'Q2' + 'QQQQ' => '', // quarter '2nd quarter' + 'QQQQQ' => '', // number of quarter '2' + 'q' => '', // number of Stand Alone quarter + 'qq' => '', // number of Stand Alone quarter '02' + 'qqq' => '', // Stand Alone quarter 'Q2' + 'qqqq' => '', // Stand Alone quarter '2nd quarter' + 'qqqqq' => '', // number of Stand Alone quarter '2' + 'M' => 'n', // Numeric representation of a month, without leading zeros + 'MM' => 'm', // Numeric representation of a month, with leading zeros + 'MMM' => 'M', // A short textual representation of a month, three letters + 'MMMM' => 'F', // A full textual representation of a month, such as January or March + 'MMMMM' => '', // + 'L' => 'm', // Stand alone month in year + 'LL' => 'm', // Stand alone month in year + 'LLL' => 'M', // Stand alone month in year + 'LLLL' => 'F', // Stand alone month in year + 'LLLLL' => '', // Stand alone month in year + 'w' => 'W', // ISO-8601 week number of year + 'ww' => 'W', // ISO-8601 week number of year + 'W' => '', // week of the current month + 'd' => 'j', // day without leading zeros + 'dd' => 'd', // day with leading zeros + 'D' => 'z', // day of the year 0 to 365 + 'F' => '', // Day of Week in Month. eg. 2nd Wednesday in July + 'g' => '', // Modified Julian day. This is different from the conventional Julian day number in two regards. + 'E' => 'D', // day of week written in short form eg. Sun + 'EE' => 'D', + 'EEE' => 'D', + 'EEEE' => 'l', // day of week fully written eg. Sunday + 'EEEEE' => '', + 'EEEEEE' => '', + 'e' => 'N', // ISO-8601 numeric representation of the day of the week 1=Mon to 7=Sun + 'ee' => 'N', // php 'w' 0=Sun to 6=Sat isn't supported by ICU -> 'w' means week number of year + 'eee' => 'D', + 'eeee' => 'l', + 'eeeee' => '', + 'eeeeee' => '', + 'c' => 'N', // ISO-8601 numeric representation of the day of the week 1=Mon to 7=Sun + 'cc' => 'N', // php 'w' 0=Sun to 6=Sat isn't supported by ICU -> 'w' means week number of year + 'ccc' => 'D', + 'cccc' => 'l', + 'ccccc' => '', + 'cccccc' => '', + 'a' => 'a', // am/pm marker + 'h' => 'g', // 12-hour format of an hour without leading zeros 1 to 12h + 'hh' => 'h', // 12-hour format of an hour with leading zeros, 01 to 12 h + 'H' => 'G', // 24-hour format of an hour without leading zeros 0 to 23h + 'HH' => 'H', // 24-hour format of an hour with leading zeros, 00 to 23 h + 'k' => '', // hour in day (1~24) + 'kk' => '', // hour in day (1~24) + 'K' => '', // hour in am/pm (0~11) + 'KK' => '', // hour in am/pm (0~11) + 'm' => 'i', // Minutes without leading zeros, not supported by php but we fallback + 'mm' => 'i', // Minutes with leading zeros + 's' => 's', // Seconds, without leading zeros, not supported by php but we fallback + 'ss' => 's', // Seconds, with leading zeros + 'S' => '', // fractional second + 'SS' => '', // fractional second + 'SSS' => '', // fractional second + 'SSSS' => '', // fractional second + 'A' => '', // milliseconds in day + 'z' => 'T', // Timezone abbreviation + 'zz' => 'T', // Timezone abbreviation + 'zzz' => 'T', // Timezone abbreviation + 'zzzz' => 'T', // Timzone full name, not supported by php but we fallback + 'Z' => 'O', // Difference to Greenwich time (GMT) in hours + 'ZZ' => 'O', // Difference to Greenwich time (GMT) in hours + 'ZZZ' => 'O', // Difference to Greenwich time (GMT) in hours + 'ZZZZ' => '\G\M\TP', // Time Zone: long localized GMT (=OOOO) e.g. GMT-08:00 + 'ZZZZZ' => '', // TIme Zone: ISO8601 extended hms? (=XXXXX) + 'O' => '', // Time Zone: short localized GMT e.g. GMT-8 + 'OOOO' => '\G\M\TP', // Time Zone: long localized GMT (=ZZZZ) e.g. GMT-08:00 + 'v' => '\G\M\TP', // Time Zone: generic non-location (falls back first to VVVV and then to OOOO) using the ICU defined fallback here + 'vvvv' => '\G\M\TP', // Time Zone: generic non-location (falls back first to VVVV and then to OOOO) using the ICU defined fallback here + 'V' => '', // Time Zone: short time zone ID + 'VV' => 'e', // Time Zone: long time zone ID + 'VVV' => '', // Time Zone: time zone exemplar city + 'VVVV' => '\G\M\TP', // Time Zone: generic location (falls back to OOOO) using the ICU defined fallback here + 'X' => '', // Time Zone: ISO8601 basic hm?, with Z for 0, e.g. -08, +0530, Z + 'XX' => 'O, \Z', // Time Zone: ISO8601 basic hm, with Z, e.g. -0800, Z + 'XXX' => 'P, \Z', // Time Zone: ISO8601 extended hm, with Z, e.g. -08:00, Z + 'XXXX' => '', // Time Zone: ISO8601 basic hms?, with Z, e.g. -0800, -075258, Z + 'XXXXX' => '', // Time Zone: ISO8601 extended hms?, with Z, e.g. -08:00, -07:52:58, Z + 'x' => '', // Time Zone: ISO8601 basic hm?, without Z for 0, e.g. -08, +0530 + 'xx' => 'O', // Time Zone: ISO8601 basic hm, without Z, e.g. -0800 + 'xxx' => 'P', // Time Zone: ISO8601 extended hm, without Z, e.g. -08:00 + 'xxxx' => '', // Time Zone: ISO8601 basic hms?, without Z, e.g. -0800, -075258 + 'xxxxx' => '', // Time Zone: ISO8601 extended hms?, without Z, e.g. -08:00, -07:52:58 + ]); + } + + /** + * Converts a date format pattern from [php date() function format][] to [ICU format][]. + * + * The conversion is limited to date patterns that do not use escaped characters. + * Patterns like `jS \o\f F Y` which will result in a date like `1st of December 2014` may not be converted correctly + * because of the use of escaped characters. + * + * Pattern constructs that are not supported by the ICU format will be removed. + * + * [php date() function format]: http://php.net/manual/en/function.date.php + * [ICU format]: http://userguide.icu-project.org/formatparse/datetime#TOC-Date-Time-Format-Syntax + * + * @param string $pattern date format pattern in php date()-function format. + * @return string The converted date format pattern. + */ + public static function convertDatePhpToIcu($pattern) + { + // http://php.net/manual/en/function.date.php + return strtr($pattern, [ + // Day + 'd' => 'dd', // Day of the month, 2 digits with leading zeros 01 to 31 + 'D' => 'eee', // A textual representation of a day, three letters Mon through Sun + 'j' => 'd', // Day of the month without leading zeros 1 to 31 + 'l' => 'eeee', // A full textual representation of the day of the week Sunday through Saturday + 'N' => 'e', // ISO-8601 numeric representation of the day of the week, 1 (for Monday) through 7 (for Sunday) + 'S' => '', // English ordinal suffix for the day of the month, 2 characters st, nd, rd or th. Works well with j + 'w' => '', // Numeric representation of the day of the week 0 (for Sunday) through 6 (for Saturday) + 'z' => 'D', // The day of the year (starting from 0) 0 through 365 + // Week + 'W' => 'w', // ISO-8601 week number of year, weeks starting on Monday (added in PHP 4.1.0) Example: 42 (the 42nd week in the year) + // Month + 'F' => 'MMMM', // A full textual representation of a month, January through December + 'm' => 'MM', // Numeric representation of a month, with leading zeros 01 through 12 + 'M' => 'MMM', // A short textual representation of a month, three letters Jan through Dec + 'n' => 'M', // Numeric representation of a month, without leading zeros 1 through 12, not supported by ICU but we fallback to "with leading zero" + 't' => '', // Number of days in the given month 28 through 31 + // Year + 'L' => '', // Whether it's a leap year, 1 if it is a leap year, 0 otherwise. + 'o' => 'Y', // ISO-8601 year number. This has the same value as Y, except that if the ISO week number (W) belongs to the previous or next year, that year is used instead. + 'Y' => 'yyyy', // A full numeric representation of a year, 4 digits Examples: 1999 or 2003 + 'y' => 'yy', // A two digit representation of a year Examples: 99 or 03 + // Time + 'a' => 'a', // Lowercase Ante meridiem and Post meridiem, am or pm + 'A' => 'a', // Uppercase Ante meridiem and Post meridiem, AM or PM, not supported by ICU but we fallback to lowercase + 'B' => '', // Swatch Internet time 000 through 999 + 'g' => 'h', // 12-hour format of an hour without leading zeros 1 through 12 + 'G' => 'H', // 24-hour format of an hour without leading zeros 0 to 23h + 'h' => 'hh', // 12-hour format of an hour with leading zeros, 01 to 12 h + 'H' => 'HH', // 24-hour format of an hour with leading zeros, 00 to 23 h + 'i' => 'mm', // Minutes with leading zeros 00 to 59 + 's' => 'ss', // Seconds, with leading zeros 00 through 59 + 'u' => '', // Microseconds. Example: 654321 + // Timezone + 'e' => 'VV', // Timezone identifier. Examples: UTC, GMT, Atlantic/Azores + 'I' => '', // Whether or not the date is in daylight saving time, 1 if Daylight Saving Time, 0 otherwise. + 'O' => 'xx', // Difference to Greenwich time (GMT) in hours, Example: +0200 + 'P' => 'xxx', // Difference to Greenwich time (GMT) with colon between hours and minutes, Example: +02:00 + 'T' => 'zzz', // Timezone abbreviation, Examples: EST, MDT ... + 'Z' => '', // Timezone offset in seconds. The offset for timezones west of UTC is always negative, and for those east of UTC is always positive. -43200 through 50400 + // Full Date/Time + 'c' => 'yyyy-MM-dd\'T\'HH:mm:ssxxx', // ISO 8601 date, e.g. 2004-02-12T15:19:21+00:00 + 'r' => 'eee, dd MMM yyyy HH:mm:ss xx', // RFC 2822 formatted date, Example: Thu, 21 Dec 2000 16:01:07 +0200 + 'U' => '', // Seconds since the Unix Epoch (January 1 1970 00:00:00 GMT) + ]); + } + + /** + * Converts a date format pattern from [ICU format][] to [jQuery UI date format][]. + * + * Pattern constructs that are not supported by the jQuery UI format will be removed. + * + * [jQuery UI date format]: http://api.jqueryui.com/datepicker/#utility-formatDate + * [ICU format]: http://userguide.icu-project.org/formatparse/datetime#TOC-Date-Time-Format-Syntax + * + * @param string $pattern date format pattern in ICU format. + * @param string $type 'date', 'time', or 'datetime'. + * @param string $locale the locale to use for converting ICU short patterns `short`, `medium`, `long` and `full`. + * If not given, `Yii::$app->language` will be used. + * @return string The converted date format pattern. + */ + public static function convertDateIcuToJui($pattern, $type = 'date', $locale = null) + { + if (isset(self::$_icuShortFormats[$pattern])) { + if ($locale === null) { + $locale = Yii::$app->language; + } + if (extension_loaded('intl')) { + if ($type === 'date') { + $formatter = new IntlDateFormatter($locale, self::$_icuShortFormats[$pattern], IntlDateFormatter::NONE); + } elseif ($type === 'time') { + $formatter = new IntlDateFormatter($locale, IntlDateFormatter::NONE, self::$_icuShortFormats[$pattern]); + } else { + $formatter = new IntlDateFormatter($locale, self::$_icuShortFormats[$pattern], self::$_icuShortFormats[$pattern]); + } + $pattern = $formatter->getPattern(); + } else { + return static::$juiFallbackDatePatterns[$pattern][$type]; + } + } + // http://userguide.icu-project.org/formatparse/datetime#TOC-Date-Time-Format-Syntax + return strtr($pattern, [ + 'G' => '', // era designator like (Anno Domini) + 'Y' => '', // 4digit year of "Week of Year" + 'y' => 'yy', // 4digit year e.g. 2014 + 'yyyy' => 'yy', // 4digit year e.g. 2014 + 'yy' => 'y', // 2digit year number eg. 14 + 'u' => '', // extended year e.g. 4601 + 'U' => '', // cyclic year name, as in Chinese lunar calendar + 'r' => '', // related Gregorian year e.g. 1996 + 'Q' => '', // number of quarter + 'QQ' => '', // number of quarter '02' + 'QQQ' => '', // quarter 'Q2' + 'QQQQ' => '', // quarter '2nd quarter' + 'QQQQQ' => '', // number of quarter '2' + 'q' => '', // number of Stand Alone quarter + 'qq' => '', // number of Stand Alone quarter '02' + 'qqq' => '', // Stand Alone quarter 'Q2' + 'qqqq' => '', // Stand Alone quarter '2nd quarter' + 'qqqqq' => '', // number of Stand Alone quarter '2' + 'M' => 'm', // Numeric representation of a month, without leading zeros + 'MM' => 'mm', // Numeric representation of a month, with leading zeros + 'MMM' => 'M', // A short textual representation of a month, three letters + 'MMMM' => 'MM', // A full textual representation of a month, such as January or March + 'MMMMM' => '', // + 'L' => 'mm', // Stand alone month in year + 'LL' => 'mm', // Stand alone month in year + 'LLL' => 'M', // Stand alone month in year + 'LLLL' => 'MM', // Stand alone month in year + 'LLLLL' => '', // Stand alone month in year + 'w' => '', // ISO-8601 week number of year + 'ww' => '', // ISO-8601 week number of year + 'W' => '', // week of the current month + 'd' => 'd', // day without leading zeros + 'dd' => 'dd', // day with leading zeros + 'D' => 'o', // day of the year 0 to 365 + 'F' => '', // Day of Week in Month. eg. 2nd Wednesday in July + 'g' => '', // Modified Julian day. This is different from the conventional Julian day number in two regards. + 'E' => 'D', // day of week written in short form eg. Sun + 'EE' => 'D', + 'EEE' => 'D', + 'EEEE' => 'DD', // day of week fully written eg. Sunday + 'EEEEE' => '', + 'EEEEEE' => '', + 'e' => '', // ISO-8601 numeric representation of the day of the week 1=Mon to 7=Sun + 'ee' => '', // php 'w' 0=Sun to 6=Sat isn't supported by ICU -> 'w' means week number of year + 'eee' => 'D', + 'eeee' => '', + 'eeeee' => '', + 'eeeeee' => '', + 'c' => '', // ISO-8601 numeric representation of the day of the week 1=Mon to 7=Sun + 'cc' => '', // php 'w' 0=Sun to 6=Sat isn't supported by ICU -> 'w' means week number of year + 'ccc' => 'D', + 'cccc' => 'DD', + 'ccccc' => '', + 'cccccc' => '', + 'a' => '', // am/pm marker + 'h' => '', // 12-hour format of an hour without leading zeros 1 to 12h + 'hh' => '', // 12-hour format of an hour with leading zeros, 01 to 12 h + 'H' => '', // 24-hour format of an hour without leading zeros 0 to 23h + 'HH' => '', // 24-hour format of an hour with leading zeros, 00 to 23 h + 'k' => '', // hour in day (1~24) + 'kk' => '', // hour in day (1~24) + 'K' => '', // hour in am/pm (0~11) + 'KK' => '', // hour in am/pm (0~11) + 'm' => '', // Minutes without leading zeros, not supported by php but we fallback + 'mm' => '', // Minutes with leading zeros + 's' => '', // Seconds, without leading zeros, not supported by php but we fallback + 'ss' => '', // Seconds, with leading zeros + 'S' => '', // fractional second + 'SS' => '', // fractional second + 'SSS' => '', // fractional second + 'SSSS' => '', // fractional second + 'A' => '', // milliseconds in day + 'z' => '', // Timezone abbreviation + 'zz' => '', // Timezone abbreviation + 'zzz' => '', // Timezone abbreviation + 'zzzz' => '', // Timzone full name, not supported by php but we fallback + 'Z' => '', // Difference to Greenwich time (GMT) in hours + 'ZZ' => '', // Difference to Greenwich time (GMT) in hours + 'ZZZ' => '', // Difference to Greenwich time (GMT) in hours + 'ZZZZ' => '', // Time Zone: long localized GMT (=OOOO) e.g. GMT-08:00 + 'ZZZZZ' => '', // TIme Zone: ISO8601 extended hms? (=XXXXX) + 'O' => '', // Time Zone: short localized GMT e.g. GMT-8 + 'OOOO' => '', // Time Zone: long localized GMT (=ZZZZ) e.g. GMT-08:00 + 'v' => '', // Time Zone: generic non-location (falls back first to VVVV and then to OOOO) using the ICU defined fallback here + 'vvvv' => '', // Time Zone: generic non-location (falls back first to VVVV and then to OOOO) using the ICU defined fallback here + 'V' => '', // Time Zone: short time zone ID + 'VV' => '', // Time Zone: long time zone ID + 'VVV' => '', // Time Zone: time zone exemplar city + 'VVVV' => '', // Time Zone: generic location (falls back to OOOO) using the ICU defined fallback here + 'X' => '', // Time Zone: ISO8601 basic hm?, with Z for 0, e.g. -08, +0530, Z + 'XX' => '', // Time Zone: ISO8601 basic hm, with Z, e.g. -0800, Z + 'XXX' => '', // Time Zone: ISO8601 extended hm, with Z, e.g. -08:00, Z + 'XXXX' => '', // Time Zone: ISO8601 basic hms?, with Z, e.g. -0800, -075258, Z + 'XXXXX' => '', // Time Zone: ISO8601 extended hms?, with Z, e.g. -08:00, -07:52:58, Z + 'x' => '', // Time Zone: ISO8601 basic hm?, without Z for 0, e.g. -08, +0530 + 'xx' => '', // Time Zone: ISO8601 basic hm, without Z, e.g. -0800 + 'xxx' => '', // Time Zone: ISO8601 extended hm, without Z, e.g. -08:00 + 'xxxx' => '', // Time Zone: ISO8601 basic hms?, without Z, e.g. -0800, -075258 + 'xxxxx' => '', // Time Zone: ISO8601 extended hms?, without Z, e.g. -08:00, -07:52:58 + ]); + } + + /** + * Converts a date format pattern from [php date() function format][] to [jQuery UI date format][]. + * + * The conversion is limited to date patterns that do not use escaped characters. + * Patterns like `jS \o\f F Y` which will result in a date like `1st of December 2014` may not be converted correctly + * because of the use of escaped characters. + * + * Pattern constructs that are not supported by the jQuery UI format will be removed. + * + * [php date() function format]: http://php.net/manual/en/function.date.php + * [jQuery UI date format]: http://api.jqueryui.com/datepicker/#utility-formatDate + * + * @param string $pattern date format pattern in php date()-function format. + * @return string The converted date format pattern. + */ + public static function convertDatePhpToJui($pattern) + { + // http://php.net/manual/en/function.date.php + return strtr($pattern, [ + // Day + 'd' => 'dd', // Day of the month, 2 digits with leading zeros 01 to 31 + 'D' => 'D', // A textual representation of a day, three letters Mon through Sun + 'j' => 'd', // Day of the month without leading zeros 1 to 31 + 'l' => 'DD', // A full textual representation of the day of the week Sunday through Saturday + 'N' => '', // ISO-8601 numeric representation of the day of the week, 1 (for Monday) through 7 (for Sunday) + 'S' => '', // English ordinal suffix for the day of the month, 2 characters st, nd, rd or th. Works well with j + 'w' => '', // Numeric representation of the day of the week 0 (for Sunday) through 6 (for Saturday) + 'z' => 'o', // The day of the year (starting from 0) 0 through 365 + // Week + 'W' => '', // ISO-8601 week number of year, weeks starting on Monday (added in PHP 4.1.0) Example: 42 (the 42nd week in the year) + // Month + 'F' => 'MM', // A full textual representation of a month, January through December + 'm' => 'mm', // Numeric representation of a month, with leading zeros 01 through 12 + 'M' => 'M', // A short textual representation of a month, three letters Jan through Dec + 'n' => 'm', // Numeric representation of a month, without leading zeros 1 through 12 + 't' => '', // Number of days in the given month 28 through 31 + // Year + 'L' => '', // Whether it's a leap year, 1 if it is a leap year, 0 otherwise. + 'o' => '', // ISO-8601 year number. This has the same value as Y, except that if the ISO week number (W) belongs to the previous or next year, that year is used instead. + 'Y' => 'yy', // A full numeric representation of a year, 4 digits Examples: 1999 or 2003 + 'y' => 'y', // A two digit representation of a year Examples: 99 or 03 + // Time + 'a' => '', // Lowercase Ante meridiem and Post meridiem, am or pm + 'A' => '', // Uppercase Ante meridiem and Post meridiem, AM or PM, not supported by ICU but we fallback to lowercase + 'B' => '', // Swatch Internet time 000 through 999 + 'g' => '', // 12-hour format of an hour without leading zeros 1 through 12 + 'G' => '', // 24-hour format of an hour without leading zeros 0 to 23h + 'h' => '', // 12-hour format of an hour with leading zeros, 01 to 12 h + 'H' => '', // 24-hour format of an hour with leading zeros, 00 to 23 h + 'i' => '', // Minutes with leading zeros 00 to 59 + 's' => '', // Seconds, with leading zeros 00 through 59 + 'u' => '', // Microseconds. Example: 654321 + // Timezone + 'e' => '', // Timezone identifier. Examples: UTC, GMT, Atlantic/Azores + 'I' => '', // Whether or not the date is in daylight saving time, 1 if Daylight Saving Time, 0 otherwise. + 'O' => '', // Difference to Greenwich time (GMT) in hours, Example: +0200 + 'P' => '', // Difference to Greenwich time (GMT) with colon between hours and minutes, Example: +02:00 + 'T' => '', // Timezone abbreviation, Examples: EST, MDT ... + 'Z' => '', // Timezone offset in seconds. The offset for timezones west of UTC is always negative, and for those east of UTC is always positive. -43200 through 50400 + // Full Date/Time + 'c' => 'yyyy-MM-dd', // ISO 8601 date, e.g. 2004-02-12T15:19:21+00:00, skipping the time here because it is not supported + 'r' => 'D, d M yy', // RFC 2822 formatted date, Example: Thu, 21 Dec 2000 16:01:07 +0200, skipping the time here because it is not supported + 'U' => '@', // Seconds since the Unix Epoch (January 1 1970 00:00:00 GMT) + ]); + } +} diff --git a/framework/helpers/FormatConverter.php b/framework/helpers/FormatConverter.php new file mode 100644 index 0000000..4b75325 --- /dev/null +++ b/framework/helpers/FormatConverter.php @@ -0,0 +1,21 @@ + + * @author Enrica Ruedin + * @since 2.0 + */ +class FormatConverter extends BaseFormatConverter +{ +} diff --git a/framework/i18n/Formatter.php b/framework/i18n/Formatter.php index f5fa6cc..adc0684 100644 --- a/framework/i18n/Formatter.php +++ b/framework/i18n/Formatter.php @@ -15,6 +15,7 @@ use Yii; use yii\base\Component; use yii\base\InvalidConfigException; use yii\base\InvalidParamException; +use yii\helpers\FormatConverter; use yii\helpers\HtmlPurifier; use yii\helpers\Html; @@ -72,7 +73,7 @@ class Formatter extends Component * @var string the default format string to be used to format a [[asDate()|date]]. * This can be "short", "medium", "long", or "full", which represents a preset format of different lengths. * - * It can also be a custom format as specified in the [ICU manual](http://userguide.icu-project.org/formatparse/datetime). + * It can also be a custom format as specified in the [ICU manual](http://userguide.icu-project.org/formatparse/datetime#TOC-Date-Time-Format-Syntax). * Alternatively this can be a string prefixed with `php:` representing a format that can be recognized by the * PHP [date()](http://php.net/manual/de/function.date.php)-function. */ @@ -81,7 +82,7 @@ class Formatter extends Component * @var string the default format string to be used to format a [[asTime()|time]]. * This can be "short", "medium", "long", or "full", which represents a preset format of different lengths. * - * It can also be a custom format as specified in the [ICU manual](http://userguide.icu-project.org/formatparse/datetime). + * It can also be a custom format as specified in the [ICU manual](http://userguide.icu-project.org/formatparse/datetime#TOC-Date-Time-Format-Syntax). * Alternatively this can be a string prefixed with `php:` representing a format that can be recognized by the * PHP [date()](http://php.net/manual/de/function.date.php)-function. */ @@ -90,7 +91,7 @@ class Formatter extends Component * @var string the default format string to be used to format a [[asDateTime()|date and time]]. * This can be "short", "medium", "long", or "full", which represents a preset format of different lengths. * - * It can also be a custom format as specified in the [ICU manual](http://userguide.icu-project.org/formatparse/datetime). + * It can also be a custom format as specified in the [ICU manual](http://userguide.icu-project.org/formatparse/datetime#TOC-Date-Time-Format-Syntax). * * Alternatively this can be a string prefixed with `php:` representing a format that can be recognized by the * PHP [date()](http://php.net/manual/de/function.date.php)-function. @@ -464,34 +465,6 @@ class Formatter extends Component ]; /** - * @var array with the standard php definition for short, medium, long an full - * format as pattern for date, time and datetime. - * This is used as fallback when the intl extension is not installed. - */ - private $_phpNameToPattern = [ - 'short' => [ - 'date' => 'n/j/y', - 'time' => 'H:i', - 'datetime' => 'n/j/y H:i', - ], - 'medium' => [ - 'date' => 'M j, Y', - 'time' => 'g:i:s A', - 'datetime' => 'M j, Y g:i:s A', - ], - 'long' => [ - 'date' => 'F j, Y', - 'time' => 'g:i:sA', - 'datetime' => 'F j, Y g:i:sA', - ], - 'full' => [ - 'date' => 'l, F j, Y', - 'time' => 'g:i:sA T', - 'datetime' => 'l, F j, Y g:i:sA T', - ], - ]; - - /** * @param integer $value normalized datetime value * @param string $format the format used to convert the value into a date string. * @param string $type 'date', 'time', or 'datetime'. @@ -506,7 +479,9 @@ class Formatter extends Component } if ($this->_intlLoaded) { - $format = $this->getIntlDatePattern($format); + if (strpos($format, 'php:') === 0) { + $format = FormatConverter::convertDatePhpToIcu(substr($format, 4)); + } if (isset($this->_dateFormats[$format])) { if ($type === 'date') { $formatter = new IntlDateFormatter($this->locale, $this->_dateFormats[$format], IntlDateFormatter::NONE, $this->timeZone); @@ -523,11 +498,10 @@ class Formatter extends Component } return $formatter->format($value); } else { - // replace short, medium, long and full with real patterns in case intl is not loaded. - if (isset($this->_phpNameToPattern[$format][$type])) { - $format = $this->_phpNameToPattern[$format][$type]; + if (strpos($format, 'php:') === 0) { + $format = substr($format, 4); } else { - $format = $this->getPhpDatePattern($format); + $format = FormatConverter::convertDateIcuToPhp($format, $type, $this->locale); } $date = new DateTime(null, new \DateTimeZone($this->timeZone)); $date->setTimestamp($value); @@ -561,170 +535,6 @@ class Formatter extends Component } } - private function getIntlDatePattern($pattern) - { - if (strpos($pattern, 'php:') === 0) { - return $this->convertPatternPhpToIcu(substr($pattern, 4)); - } else { - return $pattern; - } - } - - private function getPhpDatePattern($pattern) - { - if (strpos($pattern, 'php:') === 0) { - return substr($pattern, 4); - } else { - return $this->convertPatternIcuToPhp($pattern); - } - } - - /** - * intlFormatter class (ICU based) and DateTime class don't have same format string. - * These format patterns are completely incompatible and must be converted. - * - * This method converts an ICU (php intl) formatted date, time or datetime string in - * a php compatible format string. - * - * @param string $pattern dateformat pattern like 'dd.mm.yyyy' or 'short'/'medium'/ - * 'long'/'full' or 'db - * @return string with converted date format pattern. - * @throws InvalidConfigException - */ - private function convertPatternIcuToPhp($pattern) - { - return strtr($pattern, [ - 'dd' => 'd', // day with leading zeros - 'd' => 'j', // day without leading zeros - 'E' => 'D', // day written in short form eg. Sun - 'EE' => 'D', - 'EEE' => 'D', - 'EEEE' => 'l', // day fully written eg. Sunday - 'e' => 'N', // ISO-8601 numeric representation of the day of the week 1=Mon to 7=Sun - 'ee' => 'N', // php 'w' 0=Sun to 6=Sat isn't supported by ICU -> 'w' means week number of year - // engl. ordinal st, nd, rd; it's not support by ICU but we added - 'D' => 'z', // day of the year 0 to 365 - 'w' => 'W', // ISO-8601 week number of year, weeks starting on Monday - 'W' => '', // week of the current month; isn't supported by php - 'F' => '', // Day of Week in Month. eg. 2nd Wednesday in July - 'g' => '', // Modified Julian day. This is different from the conventional Julian day number in two regards. - 'M' => 'n', // Numeric representation of a month, without leading zeros - 'MM' => 'm', // Numeric representation of a month, with leading zeros - 'MMM' => 'M', // A short textual representation of a month, three letters - 'MMMM' => 'F', // A full textual representation of a month, such as January or March - 'Q' => '', // number of quarter not supported in php - 'QQ' => '', // number of quarter '02' not supported in php - 'QQQ' => '', // quarter 'Q2' not supported in php - 'QQQQ' => '', // quarter '2nd quarter' not supported in php - 'QQQQQ' => '', // number of quarter '2' not supported in php - 'Y' => 'Y', // 4digit year number eg. 2014 - 'y' => 'Y', // 4digit year also - 'yyyy' => 'Y', // 4digit year also - 'yy' => 'y', // 2digit year number eg. 14 - 'r' => '', // related Gregorian year, not supported by php - 'G' => '', // ear designator like AD - 'a' => 'a', // Lowercase Ante meridiem and Post - 'h' => 'g', // 12-hour format of an hour without leading zeros 1 to 12h - 'K' => 'g', // 12-hour format of an hour without leading zeros 0 to 11h, not supported by php - 'H' => 'G', // 24-hour format of an hour without leading zeros 0 to 23h - 'k' => 'G', // 24-hour format of an hour without leading zeros 1 to 24h, not supported by php - 'hh' => 'h', // 12-hour format of an hour with leading zeros, 01 to 12 h - 'KK' => 'h', // 12-hour format of an hour with leading zeros, 00 to 11 h, not supported by php - 'HH' => 'H', // 24-hour format of an hour with leading zeros, 00 to 23 h - 'kk' => 'H', // 24-hour format of an hour with leading zeros, 01 to 24 h, not supported by php - 'm' => 'i', // Minutes without leading zeros, not supported by php - 'mm' => 'i', // Minutes with leading zeros - 's' => 's', // Seconds, without leading zeros, not supported by php - 'ss' => 's', // Seconds, with leading zeros - 'SSS' => '', // millisecond (maximum of 3 significant digits), not supported by php - 'A' => '', // milliseconds in day, not supported by php - 'Z' => 'O', // Difference to Greenwich time (GMT) in hours - 'ZZ' => 'O', // Difference to Greenwich time (GMT) in hours - 'ZZZ' => 'O', // Difference to Greenwich time (GMT) in hours - 'z' => 'T', // Timezone abbreviation - 'zz' => 'T', // Timezone abbreviation - 'zzz' => 'T', // Timezone abbreviation - 'zzzz' => 'T', // Timzone full name, not supported by php - 'V' => 'e', // Timezone identifier eg. Europe/Berlin - 'VV' => 'e', - 'VVV' => 'e', - 'VVVV' => 'e' - ]); - } - - /** - * intlFormatter class (ICU based) and DateTime class don't have same format string. - * These format patterns are completely incompatible and must be converted. - * - * This method converts PHP formatted date, time or datetime string in - * an ICU (php intl) compatible format string. - * - * @param string $pattern dateformat pattern like 'd.m.Y' or 'short'/'medium'/ - * 'long'/'full' or 'db - * @return string with converted date format pattern. - * @throws InvalidConfigException - */ - private function convertPatternPhpToIcu($pattern) - { - return strtr($pattern, [ - 'd' => 'dd', // day with leading zeros - 'j' => 'd', // day without leading zeros - 'D' => 'EEE', // day written in short form eg. Sun - 'l' => 'EEEE', // day fully written eg. Sunday - 'N' => 'e', // ISO-8601 numeric representation of the day of the week 1=Mon to 7=Sun - // php 'w' 0=Sun to 6=Sat isn't supported by ICU -> 'w' means week number of year - 'S' => '', // engl. ordinal st, nd, rd; it's not support by ICU - 'z' => 'D', // day of the year 0 to 365 - 'W' => 'w', // ISO-8601 week number of year, weeks starting on Monday - // week of the current month; isn't supported by php - // Day of Week in Month. eg. 2nd Wednesday in July not supported by php - // Modified Julian day. This is different from the conventional Julian day number in two regards. - 'n'=> 'M', // Numeric representation of a month, without leading zeros - 'm' => 'MM', // Numeric representation of a month, with leading zeros - 'M' => 'MMM', // A short textual representation of a month, three letters - 'F' => 'MMMM', // A full textual representation of a month, such as January or March - // number of quarter not supported in php - // number of quarter '02' not supported in php - // quarter 'Q2' not supported in php - // quarter '2nd quarter' not supported in php - // number of quarter '2' not supported in php - 'Y' => 'yyyy', // 4digit year eg. 2014 - 'y' => 'yy', // 2digit year number eg. 14 - // related Gregorian year, not supported by php - // ear designator like AD - 'a' => 'a', // Lowercase Ante meridiem and Post am. or pm. - 'A' => 'a', // Upercase Ante meridiem and Post AM or PM, not supported by ICU - 'g' => 'h', // 12-hour format of an hour without leading zeros 1 to 12h - // 12-hour format of an hour without leading zeros 0 to 11h, not supported by php - 'G' => 'H', // 24-hour format of an hour without leading zeros 0 to 23h - // 24-hour format of an hour without leading zeros 1 to 24h, not supported by php - 'h' => 'hh', // 12-hour format of an hour with leading zeros, 01 to 12 h - // 12-hour format of an hour with leading zeros, 00 to 11 h, not supported by php - 'H' => 'HH', // 24-hour format of an hour with leading zeros, 00 to 23 h - // 24-hour format of an hour with leading zeros, 01 to 24 h, not supported by php - // Minutes without leading zeros, not supported by php - 'i' => 'mm', // Minutes with leading zeros - // Seconds, without leading zeros, not supported by php - 's' => 'ss', // Seconds, with leading zeros - // millisecond (maximum of 3 significant digits), not supported by php - // milliseconds in day, not supported by php - 'O' => 'Z', // Difference to Greenwich time (GMT) in hours - 'T' => 'z', // Timezone abbreviation - // Timzone full name, not supported by php - 'e' => 'VV', // Timezone identifier eg. Europe/Berlin - 'w' => '', // Numeric representation of the day of the week 0=Sun, 6=Sat, not sup. ICU - 'L' => '', //Whether it's a leap year 1= leap, 0= normal year, not sup. ICU - 'B' => '', // Swatch Internet time, 000 to 999, not sup. ICU - 'u' => '', // Microseconds Note that date() will always generate 000000 since it takes an integer parameter, not sup. ICU - 'P' => '', // Difference to Greenwich time (GMT) with colon between hours and minutes, not sup. ICU - 'Z' => '', // Timezone offset in seconds. The offset for timezones west of UTC is always negative, and for those east of UTC is always positive, not sup. ICU - 'c' => 'yyy-MM-dd\'T\'mm:HH:ssZ', //ISO 8601 date, it works only if nothing else than 'c' is in pattern. - 'r' => 'eee, dd MMM yyyy mm:HH:ss Z', // ยป RFC 2822 formatted date, it works only if nothing else than 'r' is in pattern - 'U' => '' // Seconds since the Unix Epoch (January 1 1970 00:00:00 GMT), not supported in ICU - - ]); - } - /** * Formats a date, time or datetime in a float number as UNIX timestamp (seconds since 01-01-1970). * @param integer|string|DateTime|\DateInterval $value the value to be formatted. The following diff --git a/tests/unit/framework/helpers/FormatConverterTest.php b/tests/unit/framework/helpers/FormatConverterTest.php new file mode 100644 index 0000000..8305ebe --- /dev/null +++ b/tests/unit/framework/helpers/FormatConverterTest.php @@ -0,0 +1,78 @@ +getName(false), 'testIntl', 8) === 0) { + if (!extension_loaded('intl')) { + $this->markTestSkipped('intl extension is not installed.'); + } + FormatterTest::$enableIntl = true; + } else { + FormatterTest::$enableIntl = false; + } + + $this->mockApplication([ + 'timeZone' => 'UTC', + 'language' => 'ru-RU', + ]); + } + + protected function tearDown() + { + parent::tearDown(); + FormatterTest::$enableIntl = null; + } + + public function testIntlIcuToPhpShortForm() + { + $this->assertEquals('m/j/y', FormatConverter::convertDateIcuToPhp('short', 'date', 'en-US')); + $this->assertEquals('d.m.y', FormatConverter::convertDateIcuToPhp('short', 'date', 'de-DE')); + } + + public function testIntlOneDigitIcu() + { + $formatter = new Formatter(['locale' => 'en-US']); + $this->assertEquals('24.8.2014', $formatter->asDate('2014-8-24', 'php:d.n.Y')); + $this->assertEquals('24.8.2014', $formatter->asDate('2014-8-24', 'd.M.yyyy')); + } + + public function testOneDigitIcu() + { + $formatter = new Formatter(['locale' => 'en-US']); + $this->assertEquals('24.8.2014', $formatter->asDate('2014-8-24', 'php:d.n.Y')); + $this->assertEquals('24.8.2014', $formatter->asDate('2014-8-24', 'd.M.yyyy')); + } +} +} \ No newline at end of file diff --git a/tests/unit/framework/i18n/FormatterTest.php b/tests/unit/framework/i18n/FormatterTest.php index 6f34253..7be03cf 100644 --- a/tests/unit/framework/i18n/FormatterTest.php +++ b/tests/unit/framework/i18n/FormatterTest.php @@ -1,24 +1,33 @@ formatter = null; } @@ -794,3 +804,4 @@ class FormatterTest extends TestCase $this->assertSame("1023 bytes", $this->formatter->asSize(1023)); } } +}