1<?php 2 3// phpcs:disable Generic.Files.LineLength.TooLong 4 5namespace dokuwiki\plugin\struct\meta; 6 7/** 8 * Class DateFormatConverter 9 * 10 * Allows conversion between the two format strings used in PHP. Not all placeholders are available in both 11 * formats. The conversion tries will use similar but not exactly the same placeholders if possible. When no suitable 12 * replacement can be found, the placeholder is removed. 13 * 14 * Do not use this where formats are used in creating machine readable data (like feeds, APIs whatever). This is 15 * only meant for cases where human read output is created. 16 * 17 * @package dokuwiki\plugin\struct\meta 18 */ 19class DateFormatConverter 20{ 21 protected static $strftime = [ 22 // Day 23 '%a' => 'D', // An abbreviated textual representation of the day Sun through Sat 24 '%A' => 'l', // A full textual representation of the day Sunday through Saturday 25 '%d' => 'd', // Two-digit day of the month (with leading zeros) 01 to 31 26 '%e' => 'j', // Day of the month, with a space preceding single digits. Not implemented as described on Windows. See below for more information. 1 to 31 27 '%j' => '', // NOT SUPPORTED Day of the year, 3 digits with leading zeros 001 to 366 28 '%u' => 'N', // ISO-8601 numeric representation of the day of the week 1 (for Monday) through 7 (for Sunday) 29 '%w' => 'w', // Numeric representation of the day of the week 0 (for Sunday) through 6 (for Saturday) 30 // Week 31 '%U' => '', // NOT SUPPORTED Week number of the given year, starting with the first Sunday as the first week 13 (for the 13th full week of the year) 32 '%V' => 'W', // ISO-8601:1988 week number of the given year, starting with the first week of the year with at least 4 weekdays, with Monday being the start of the week 01 through 53 (where 53 accounts for an overlapping week) 33 '%W' => '', // NOT SUPPORTED A numeric representation of the week of the year, starting with the first Monday as the first week 46 (for the 46th week of the year beginning with a Monday) 34 // Month 35 '%b' => 'M', // Abbreviated month name, based on the locale Jan through Dec 36 '%B' => 'F', // Full month name, based on the locale January through December 37 '%h' => 'M', // Abbreviated month name, based on the locale (an alias of %b) Jan through Dec 38 '%m' => 'm', // Two digit representation of the month 01 (for January) through 12 (for December) 39 // Year 40 '%C' => '', // NOT SUPPORTED Two digit representation of the century (year divided by 100, truncated to an integer) 19 for the 20th Century 41 '%g' => 'y', // Two digit representation of the year going by ISO-8601:1988 standards (see %V) Example: 09 for the week of January 6, 2009 42 '%G' => 'Y', // The full four-digit version of %g Example: 2008 for the week of January 3, 2009 43 '%y' => 'y', // Two digit representation of the year Example: 09 for 2009, 79 for 1979 44 '%Y' => 'Y', // Four digit representation for the year Example: 2038 45 // Time 46 '%H' => 'H', // Two digit representation of the hour in 24-hour format 00 through 23 47 '%k' => 'G', // Two digit representation of the hour in 24-hour format, with a space preceding single digits 0 through 23 48 '%I' => 'h', // Two digit representation of the hour in 12-hour format 01 through 12 49 '%l' => 'g', // (lower-case 'L') Hour in 12-hour format, with a space preceding single digits 1 through 12 50 '%M' => 'i', // Two digit representation of the minute 00 through 59 51 '%p' => 'A', // UPPER-CASE 'AM' or 'PM' based on the given time Example: AM for 00:31, PM for 22:23 52 '%P' => 'a', // lower-case 'am' or 'pm' based on the given time Example: am for 00:31, pm for 22:23 53 '%r' => 'h:i:s A', // Same as %I:%M:%S %p Example: 09:34:17 PM for 21:34:17 54 '%R' => 'H:i', // Same as %H:%M Example: 00:35 for 12:35 AM, 16:44for 4:44 PM 55 '%S' => 's', // Two digit representation of the second 00 through 59 56 '%T' => 'H:i:s', // Same as %H:%M:%S Example: 21:34:17 for 09:34:17 PM 57 '%X' => 'H:i:s', // Preferred time representation based on locale, without the date Example: 03:59:16 or 15:59:16 58 '%z' => 'z', // The time zone offset. Not implemented as described on Windows. See below for more information. Example: -0500 for US Eastern Time 59 '%Z' => 'T', // The time zone abbreviation. Not implemented as described on Windows. See below for more information. Example: EST for Eastern Time 60 // Time and Date Stamps 61 '%c' => 'D M j H:i:s Y', // Preferred date and time stamp based on locale Example: Tue Feb 5 00:45:10 2009 for February 5, 2009 at 12:45:10 AM 62 '%D' => 'm/d/y', // Same as %m/%d/%y Example: 02/05/09 for February 5, 2009 63 '%F' => 'Y/m/d', // Same as %Y-%m-%d (commonly used in database datestamps) Example: 2009-02-05 for February 5, 2009 64 '%s' => 'U', // Unix Epoch Time timestamp (same as the time() function) Example: 305815200 for September 10, 1979 08:40:00 AM 65 '%x' => 'm/d/y', // Preferred date representation based on locale, without the time Example: 02/05/09 for February 5, 2009 66 // Miscellaneous 67 '%n' => "\n", // A newline character (\n) --- 68 '%t' => "\t", // A Tab character (\t) --- 69 '%%' => '%', 70 ]; 71 72 protected static $date = [ 73 // Day 74 'd' => '%d', // Day of the month, 2 digits with leading zeros 01 to 31 75 'D' => '%a', // A textual representation of a day, three letters Mon through Sun 76 'j' => '%e', // Day of the month without leading zeros 1 to 31 77 'l' => '%A', // (lowercase 'L') A full textual representation of the day of the week Sunday through Saturday 78 'N' => '%u', // ISO-8601 numeric representation of the day of the week (added in PHP 5.1.0) 1 (for Monday) through 7 (for Sunday) 79 'S' => '', // NOT SUPPORTED English ordinal suffix for the day of the month, 2 characters st, nd, rd or th. Works well with j 80 'w' => '%w', // Numeric representation of the day of the week 0 (for Sunday) through 6 (for Saturday) 81 'z' => '', // NOT SUPPORTED The day of the year (starting from 0) 0 through 365 82 // Week 83 'W' => '%V', // ISO-8601 week number of year, weeks starting on Monday (added in PHP 4.1.0) Example: 42 (the 42nd week in the year) 84 // Month 85 'F' => '%B', // A full textual representation of a month, such as January or March January through December 86 'm' => '%m', // Numeric representation of a month, with leading zeros 01 through 12 87 'M' => '%b', // A short textual representation of a month, three letters Jan through Dec 88 'n' => '%m', // Numeric representation of a month, without leading zeros 1 through 12 89 't' => '', // NOT SUPPORTED Number of days in the given month 28 through 31 90 // Year 91 'L' => '', // NOT SUPPORTED Whether it's a leap year 1 if it is a leap year, 0 otherwise. 92 'o' => '%g', // ISO-8601 week-numbering year. 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. (added in PHP 5.1.0) Examples: 1999or 2003 93 'Y' => '%Y', // A full numeric representation of a year, 4 digits Examples: 1999or 2003 94 'y' => '%y', // A two digit representation of a year Examples: 99 or03 95 // Time 96 'a' => '%P', // Lowercase Ante meridiem and Post meridiem am or pm 97 'A' => '%p', // Uppercase Ante meridiem and Post meridiem AM or PM 98 'B' => '', // NOT SUPPORTED Swatch Internet time 000 through 999 99 'g' => '%l', // 12-hour format of an hour without leading zeros 1 through 12 100 'G' => '%k', // 24-hour format of an hour without leading zeros 0 through 23 101 'h' => '%I', // 12-hour format of an hour with leading zeros 01 through 12 102 'H' => '%H', // 24-hour format of an hour with leading zeros 00 through 23 103 'i' => '%M', // Minutes with leading zeros 00 to 59 104 's' => '%S', // Seconds, with leading zeros 00 through 59 105 'u' => '%s000000', // Microseconds (added in PHP 5.2.2). Note that date() will always generate000000 since it takes an integer parameter, whereas DateTime::format()does support microseconds if DateTime was created with microseconds. Example: 654321 106 // Timezone 107 'e' => '%Z', // Timezone identifier (added in PHP 5.1.0) Examples: UTC,GMT,Atlantic/Azores 108 'I' => '', // NOT SUPPORTED (capital i) Whether or not the date is in daylight saving time 1 if Daylight Saving Time, 0otherwise. 109 'O' => '%z', // Difference to Greenwich time (GMT) in hours Example: +0200 110 'P' => '%z', // Difference to Greenwich time (GMT) with colon between hours and minutes (added in PHP 5.1.3) Example: +02:00 111 'T' => '%Z', // Timezone abbreviation Examples: EST,MDT ... 112 'Z' => '', // NOT SUPPORTED Timezone offset in seconds. The offset for timezones west of UTC is always negative, and for those east of UTC is always positive. -43200 through50400 113 // Full Date/Time 114 'c' => '', // NOT SUPPORTED ISO 8601 date (added in PHP 5) 2004-02-12T15:19:21+00:00 115 'r' => '%a, %e %b %Y %H:%M:%S %s', // » RFC 2822 formatted date Example: Thu, 21 Dec 2000 16:01:07 +0200 116 'U' => '%s', 117 ]; 118 119 /** 120 * Convert a strftime format string to a date format string 121 * 122 * @param string $strftime 123 * @return string 124 */ 125 public static function toDate($strftime) 126 { 127 $date = $strftime; 128 129 /* All characters that are not strftime placeholders need to be escaped */ 130 { 131 $datekeys = array_keys(self::$date); 132 // create negative lookbehind regex to match all known date chars that are not a strtime pattern now 133 $from = array_map( 134 static fn($in) => '/(?<!%)' . $in . '/', 135 $datekeys 136 ); 137 // those need to be escaped 138 $to = array_map( 139 static fn($in) => '\\' . $in, 140 $datekeys 141 ); 142 // escape date chars 143 $date = preg_replace($from, $to, $date); 144 } 145 146 /* strftime to date conversion */ 147 { 148 $date = str_replace( 149 array_keys(self::$strftime), 150 array_values(self::$strftime), 151 $date 152 ); 153 } 154 155 return $date; 156 } 157 158 /** 159 * Convert a date format string to a strftime format string 160 * 161 * @param string $date 162 * @return string 163 */ 164 public static function toStrftime($date) 165 { 166 /* date to strftime conversion */ 167 { 168 // create negative lookbehind regex to match all unescaped known chars 169 $from = array_keys(self::$date); 170 $from = array_map( 171 static fn($in) => '/(?<!\\\\)' . $in . '/', 172 $from 173 ); 174 $to = array_values(self::$date); 175 176 // percents need escaping: 177 array_unshift($from, '/%/'); 178 array_unshift($to, '%%'); 179 180 // replace all the placeholders 181 $strftime = preg_replace($from, $to, $date); 182 } 183 184 /* unescape date escapes */ 185 { 186 $datekeys = array_keys(self::$date); 187 $from = array_map( 188 static fn($in) => '/\\\\' . $in . '/', 189 $datekeys 190 ); 191 $strftime = preg_replace($from, $datekeys, $strftime); 192 } 193 194 return $strftime; 195 } 196} 197