1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229
|
# NAME
DateTime - A date and time object for Perl
# VERSION
version 1.42
# SYNOPSIS
use DateTime;
$dt = DateTime->new(
year => 1964,
month => 10,
day => 16,
hour => 16,
minute => 12,
second => 47,
nanosecond => 500000000,
time_zone => 'Asia/Taipei',
);
$dt = DateTime->from_epoch( epoch => $epoch );
$dt = DateTime->now; # same as ( epoch => time() )
$year = $dt->year;
$month = $dt->month; # 1-12
$day = $dt->day; # 1-31
$dow = $dt->day_of_week; # 1-7 (Monday is 1)
$hour = $dt->hour; # 0-23
$minute = $dt->minute; # 0-59
$second = $dt->second; # 0-61 (leap seconds!)
$doy = $dt->day_of_year; # 1-366 (leap years)
$doq = $dt->day_of_quarter; # 1..
$qtr = $dt->quarter; # 1-4
# all of the start-at-1 methods above have corresponding start-at-0
# methods, such as $dt->day_of_month_0, $dt->month_0 and so on
$ymd = $dt->ymd; # 2002-12-06
$ymd = $dt->ymd('/'); # 2002/12/06
$mdy = $dt->mdy; # 12-06-2002
$mdy = $dt->mdy('/'); # 12/06/2002
$dmy = $dt->dmy; # 06-12-2002
$dmy = $dt->dmy('/'); # 06/12/2002
$hms = $dt->hms; # 14:02:29
$hms = $dt->hms('!'); # 14!02!29
$is_leap = $dt->is_leap_year;
# these are localizable, see Locales section
$month_name = $dt->month_name; # January, February, ...
$month_abbr = $dt->month_abbr; # Jan, Feb, ...
$day_name = $dt->day_name; # Monday, Tuesday, ...
$day_abbr = $dt->day_abbr; # Mon, Tue, ...
# May not work for all possible datetime, see the docs on this
# method for more details.
$epoch_time = $dt->epoch;
$dt2 = $dt + $duration_object;
$dt3 = $dt - $duration_object;
$duration_object = $dt - $dt2;
$dt->set( year => 1882 );
$dt->set_time_zone( 'America/Chicago' );
$dt->set_formatter( $formatter );
# DESCRIPTION
DateTime is a class for the representation of date/time combinations,
and is part of the Perl DateTime project. For details on this project
please see [http://datetime.perl.org/](http://datetime.perl.org/). The DateTime site has a FAQ
which may help answer many "how do I do X?" questions. The FAQ is at
[http://datetime.perl.org/wiki/datetime/page/FAQ](http://datetime.perl.org/wiki/datetime/page/FAQ).
It represents the Gregorian calendar, extended backwards in time
before its creation (in 1582). This is sometimes known as the
"proleptic Gregorian calendar". In this calendar, the first day of
the calendar (the epoch), is the first day of year 1, which
corresponds to the date which was (incorrectly) believed to be the
birth of Jesus Christ.
The calendar represented does have a year 0, and in that way differs
from how dates are often written using "BCE/CE" or "BC/AD".
For infinite datetimes, please see the
[DateTime::Infinite](https://metacpan.org/pod/DateTime::Infinite) module.
# USAGE
## 0-based Versus 1-based Numbers
The DateTime.pm module follows a simple logic for determining whether or not a
given number is 0-based or 1-based.
Month, day of month, day of week, and day of year are 1-based. Any
method that is 1-based also has an equivalent 0-based method ending in
"\_0". So for example, this class provides both `day_of_week()` and
`day_of_week_0()` methods.
The `day_of_week_0()` method still treats Monday as the first day of
the week.
All _time_-related numbers such as hour, minute, and second are
0-based.
Years are neither, as they can be both positive or negative, unlike
any other datetime component. There _is_ a year 0.
There is no `quarter_0()` method.
## Error Handling
Some errors may cause this module to die with an error string. This
can only happen when calling constructor methods, methods that change
the object, such as `set()`, or methods that take parameters.
Methods that retrieve information about the object, such as `year()`
or `epoch()`, will never die.
## Locales
All the object methods which return names or abbreviations return data based
on a locale. This is done by setting the locale when constructing a DateTime
object. If this is not set, then "en-US" is used.
## Floating DateTimes
The default time zone for new DateTime objects, except where stated
otherwise, is the "floating" time zone. This concept comes from the
iCal standard. A floating datetime is one which is not anchored to
any particular time zone. In addition, floating datetimes do not
include leap seconds, since we cannot apply them without knowing the
datetime's time zone.
The results of date math and comparison between a floating datetime
and one with a real time zone are not really valid, because one
includes leap seconds and the other does not. Similarly, the results
of datetime math between two floating datetimes and two datetimes with
time zones are not really comparable.
If you are planning to use any objects with a real time zone, it is
strongly recommended that you **do not** mix these with floating
datetimes.
## Math
If you are going to be doing date math, please read the section ["How DateTime
Math Works"](#how-datetime-math-works).
## Determining the Local Time Zone Can Be Slow
If `$ENV{TZ}` is not set, it may involve reading a number of files in `/etc`
or elsewhere. If you know that the local time zone won't change while your
code is running, and you need to make many objects for the local time zone, it
is strongly recommended that you retrieve the local time zone once and cache
it:
our $App::LocalTZ = DateTime::TimeZone->new( name => 'local' );
... # then everywhere else
my $dt = DateTime->new( ..., time_zone => $App::LocalTZ );
DateTime itself does not do this internally because local time zones can
change, and there's no good way to determine if it's changed without doing all
the work to look it up.
Do not try to use named time zones (like "America/Chicago") with dates
very far in the future (thousands of years). The current
implementation of `DateTime::TimeZone` will use a huge amount of
memory calculating all the DST changes from now until the future
date. Use UTC or the floating time zone and you will be safe.
## Globally Setting a Default Time Zone
**Warning: This is very dangerous. Do this at your own risk!**
By default, `DateTime` uses either the floating time zone or UTC for newly
created objects, depending on the constructor.
You can force `DateTime` to use a different time zone by setting the
`PERL_DATETIME_DEFAULT_TZ` environment variable.
As noted above, this is very dangerous, as it affects all code that creates a
`DateTime` object, including modules from CPAN. If those modules expect the
normal default, then setting this can cause confusing breakage or subtly
broken data. Before setting this variable, you are strongly encouraged to
audit your CPAN dependencies to see how they use `DateTime`. Try running the
test suite for each dependency with this environment variable set before using
this in production.
## Upper and Lower Bounds
Internally, dates are represented the number of days before or after
0001-01-01. This is stored as an integer, meaning that the upper and lower
bounds are based on your Perl's integer size (`$Config{ivsize}`).
The limit on 32-bit systems is around 2^29 days, which gets you to year
(+/-)1,469,903. On a 64-bit system you get 2^62 days,
(+/-)12,626,367,463,883,278 (12.626 quadrillion).
# METHODS
DateTime provide many methods. The documentation breaks them down into groups
based on what they do (constructor, accessors, modifiers, etc.).
## Constructors
All constructors can die when invalid parameters are given.
### Warnings
Currently, constructors will warn if you try to create a far future DateTime
(year >= 5000) with any time zone besides floating or UTC. This can be very
slow if the time zone has future DST transitions that need to be
calculated. If the date is sufficiently far in the future this can be
_really_ slow (minutes).
All warnings from DateTime use the `DateTime` category and can be suppressed
with:
no warnings 'DateTime';
This warning may be removed in the future if [DateTime::TimeZone](https://metacpan.org/pod/DateTime::TimeZone) is made
much faster.
### DateTime->new( ... )
This class method accepts parameters for each date and time component:
"year", "month", "day", "hour", "minute", "second", "nanosecond".
It also accepts "locale", "time\_zone", and "formatter" parameters.
my $dt = DateTime->new(
year => 1966,
month => 10,
day => 25,
hour => 7,
minute => 15,
second => 47,
nanosecond => 500000000,
time_zone => 'America/Chicago',
);
DateTime validates the "month", "day", "hour", "minute", and "second",
and "nanosecond" parameters. The valid values for these parameters are:
- month
An integer from 1-12.
- day
An integer from 1-31, and it must be within the valid range of days for the
specified month.
- hour
An integer from 0-23.
- minute
An integer from 0-59.
- second
An integer from 0-61 (to allow for leap seconds). Values of 60 or 61 are only
allowed when they match actual leap seconds.
- nanosecond
An integer >= 0. If this number is greater than 1 billion, it will be
normalized into the second value for the DateTime object.
Invalid parameter types (like an array reference) will cause the
constructor to die.
The value for seconds may be from 0 to 61, to account for leap
seconds. If you give a value greater than 59, DateTime does check to
see that it really matches a valid leap second.
All of the parameters are optional except for "year". The "month" and
"day" parameters both default to 1, while the "hour", "minute",
"second", and "nanosecond" parameters all default to 0.
The "locale" parameter should be a string containing a locale code, like
"en-US" or "zh-Hant-TW", or an object returned by `DateTime::Locale->load`. See the [DateTime::Locale](https://metacpan.org/pod/DateTime::Locale) documentation for details.
The "time\_zone" parameter can be either a string or a `DateTime::TimeZone`
object. A string will simply be passed to the `DateTime::TimeZone->new`
method as its "name" parameter. This string may be an Olson DB time zone name
("America/Chicago"), an offset string ("+0630"), or the words "floating" or
"local". See the `DateTime::TimeZone` documentation for more details.
The default time zone is "floating".
The "formatter" can be either a scalar or an object, but the class
specified by the scalar or the object must implement a
`format_datetime()` method.
#### Parsing Dates
**This module does not parse dates!** That means there is no
constructor to which you can pass things like "March 3, 1970 12:34".
Instead, take a look at the various `DateTime::Format::*` modules on
CPAN. These parse all sorts of different date formats, and you're
bound to find something that can handle your particular needs.
#### Ambiguous Local Times
Because of Daylight Saving Time, it is possible to specify a local
time that is ambiguous. For example, in the US in 2003, the
transition from to saving to standard time occurred on October 26, at
02:00:00 local time. The local clock changed from 01:59:59 (saving
time) to 01:00:00 (standard time). This means that the hour from
01:00:00 through 01:59:59 actually occurs twice, though the UTC time
continues to move forward.
If you specify an ambiguous time, then the latest UTC time is always
used, in effect always choosing standard time. In this case, you can
simply subtract an hour to the object in order to move to saving time,
for example:
# This object represent 01:30:00 standard time
my $dt = DateTime->new(
year => 2003,
month => 10,
day => 26,
hour => 1,
minute => 30,
second => 0,
time_zone => 'America/Chicago',
);
print $dt->hms; # prints 01:30:00
# Now the object represent 01:30:00 saving time
$dt->subtract( hours => 1 );
print $dt->hms; # still prints 01:30:00
Alternately, you could create the object with the UTC time zone, and
then call the `set_time_zone()` method to change the time zone. This
is a good way to ensure that the time is not ambiguous.
#### Invalid Local Times
Another problem introduced by Daylight Saving Time is that certain
local times just do not exist. For example, in the US in 2003, the
transition from standard to saving time occurred on April 6, at the
change to 2:00:00 local time. The local clock changes from 01:59:59
(standard time) to 03:00:00 (saving time). This means that there is
no 02:00:00 through 02:59:59 on April 6!
Attempting to create an invalid time currently causes a fatal error.
This may change in future version of this module.
### DateTime->from\_epoch( epoch => $epoch, ... )
This class method can be used to construct a new DateTime object from
an epoch time instead of components. Just as with the `new()`
method, it accepts "time\_zone", "locale", and "formatter" parameters.
If the epoch value is a floating-point value, it will be rounded to
nearest microsecond.
By default, the returned object will be in the UTC time zone.
### DateTime->now( ... )
This class method is equivalent to calling `from_epoch()` with the
value returned from Perl's `time()` function. Just as with the
`new()` method, it accepts "time\_zone" and "locale" parameters.
By default, the returned object will be in the UTC time zone.
### DateTime->today( ... )
This class method is equivalent to:
DateTime->now(@_)->truncate( to => 'day' );
### DateTime->from\_object( object => $object, ... )
This class method can be used to construct a new DateTime object from
any object that implements the `utc_rd_values()` method. All
`DateTime::Calendar` modules must implement this method in order to
provide cross-calendar compatibility. This method accepts a
"locale" and "formatter" parameter
If the object passed to this method has a `time_zone()` method, that
is used to set the time zone of the newly created `DateTime.pm`
object.
Otherwise, the returned object will be in the floating time zone.
### DateTime->last\_day\_of\_month( ... )
This constructor takes the same arguments as can be given to the
`new()` method, except for "day". Additionally, both "year" and
"month" are required.
### DateTime->from\_day\_of\_year( ... )
This constructor takes the same arguments as can be given to the
`new()` method, except that it does not accept a "month" or "day"
argument. Instead, it requires both "year" and "day\_of\_year". The
day of year must be between 1 and 366, and 366 is only allowed for
leap years.
### $dt->clone()
This object method returns a new object that is replica of the object
upon which the method is called.
## "Get" Methods
This class has many methods for retrieving information about an
object.
### $dt->year()
Returns the year.
### $dt->ce\_year()
Returns the year according to the BCE/CE numbering system. The year
before year 1 in this system is year -1, aka "1 BCE".
### $dt->era\_name()
Returns the long name of the current era, something like "Before
Christ". See the [Locales](#locales) section for more details.
### $dt->era\_abbr()
Returns the abbreviated name of the current era, something like "BC".
See the [Locales](#locales) section for more details.
### $dt->christian\_era()
Returns a string, either "BC" or "AD", according to the year.
### $dt->secular\_era()
Returns a string, either "BCE" or "CE", according to the year.
### $dt->year\_with\_era()
Returns a string containing the year immediately followed by its era
abbreviation. The year is the absolute value of `ce_year()`, so that
year 1 is "1AD" and year 0 is "1BC".
### $dt->year\_with\_christian\_era()
Like `year_with_era()`, but uses the christian\_era() method to get the era
name.
### $dt->year\_with\_secular\_era()
Like `year_with_era()`, but uses the secular\_era() method to get the
era name.
### $dt->month()
Returns the month of the year, from 1..12.
Also available as `$dt->mon()`.
### $dt->month\_name()
Returns the name of the current month. See the
[Locales](#locales) section for more details.
### $dt->month\_abbr()
Returns the abbreviated name of the current month. See the
[Locales](#locales) section for more details.
### $dt->day()
Returns the day of the month, from 1..31.
Also available as `$dt->mday()` and `$dt->day_of_month()`.
### $dt->day\_of\_week()
Returns the day of the week as a number, from 1..7, with 1 being
Monday and 7 being Sunday.
Also available as `$dt->wday()` and `$dt->dow()`.
### $dt->local\_day\_of\_week()
Returns the day of the week as a number, from 1..7. The day
corresponding to 1 will vary based on the locale.
### $dt->day\_name()
Returns the name of the current day of the week. See the
[Locales](#locales) section for more details.
### $dt->day\_abbr()
Returns the abbreviated name of the current day of the week. See the
[Locales](#locales) section for more details.
### $dt->day\_of\_year()
Returns the day of the year.
Also available as `$dt->doy()`.
### $dt->quarter()
Returns the quarter of the year, from 1..4.
### $dt->quarter\_name()
Returns the name of the current quarter. See the
[Locales](#locales) section for more details.
### $dt->quarter\_abbr()
Returns the abbreviated name of the current quarter. See the
[Locales](#locales) section for more details.
### $dt->day\_of\_quarter()
Returns the day of the quarter.
Also available as `$dt->doq()`.
### $dt->weekday\_of\_month()
Returns a number from 1..5 indicating which week day of the month this
is. For example, June 9, 2003 is the second Monday of the month, and
so this method returns 2 for that day.
### $dt->ymd( $optional\_separator ), $dt->mdy(...), $dt->dmy(...)
Each method returns the year, month, and day, in the order indicated
by the method name. Years are zero-padded to four digits. Months and
days are 0-padded to two digits.
By default, the values are separated by a dash (-), but this can be
overridden by passing a value to the method.
The `$dt->ymd()` method is also available as `$dt->date()`.
### $dt->hour()
Returns the hour of the day, from 0..23.
### $dt->hour\_1()
Returns the hour of the day, from 1..24.
### $dt->hour\_12()
Returns the hour of the day, from 1..12.
### $dt->hour\_12\_0()
Returns the hour of the day, from 0..11.
### $dt->am\_or\_pm()
Returns the appropriate localized abbreviation, depending on the
current hour.
### $dt->minute()
Returns the minute of the hour, from 0..59.
Also available as `$dt->min()`.
### $dt->second()
Returns the second, from 0..61. The values 60 and 61 are used for
leap seconds.
Also available as `$dt->sec()`.
### $dt->fractional\_second()
Returns the second, as a real number from 0.0 until 61.999999999
The values 60 and 61 are used for leap seconds.
### $dt->millisecond()
Returns the fractional part of the second as milliseconds (1E-3 seconds).
Half a second is 500 milliseconds.
This value will always be rounded down to the nearest integer.
### $dt->microsecond()
Returns the fractional part of the second as microseconds (1E-6
seconds).
Half a second is 500\_000 microseconds.
This value will always be rounded down to the nearest integer.
### $dt->nanosecond()
Returns the fractional part of the second as nanoseconds (1E-9 seconds).
Half a second is 500\_000\_000 nanoseconds.
### $dt->hms( $optional\_separator )
Returns the hour, minute, and second, all zero-padded to two digits.
If no separator is specified, a colon (:) is used by default.
Also available as `$dt->time()`.
### $dt->datetime()
This method is equivalent to:
$dt->ymd('-') . 'T' . $dt->hms(':')
This method is also available as `$dt->iso8601()`, but it's not really a
very good ISO8601 format, as it lacks a time zone.
### $dt->is\_leap\_year()
This method returns a true or false indicating whether or not the
datetime object is in a leap year.
### $dt->week()
($week_year, $week_number) = $dt->week;
Returns information about the calendar week which contains this
datetime object. The values returned by this method are also available
separately through the week\_year and week\_number methods.
The first week of the year is defined by ISO as the one which contains
the fourth day of January, which is equivalent to saying that it's the
first week to overlap the new year by at least four days.
Typically the week year will be the same as the year that the object
is in, but dates at the very beginning of a calendar year often end up
in the last week of the prior year, and similarly, the final few days
of the year may be placed in the first week of the next year.
### $dt->week\_year()
Returns the year of the week. See `$dt->week()` for details.
### $dt->week\_number()
Returns the week of the year, from 1..53. See `$dt->week()` for details.
### $dt->week\_of\_month()
The week of the month, from 0..5. The first week of the month is the
first week that contains a Thursday. This is based on the ICU
definition of week of month, and correlates to the ISO8601 week of
year definition. A day in the week _before_ the week with the first
Thursday will be week 0.
### $dt->jd(), $dt->mjd()
These return the Julian Day and Modified Julian Day, respectively.
The value returned is a floating point number. The fractional portion
of the number represents the time portion of the datetime.
### $dt->time\_zone()
This returns the `DateTime::TimeZone` object for the datetime object.
### $dt->offset()
This returns the offset from UTC, in seconds, of the datetime object
according to the time zone.
### $dt->is\_dst()
Returns a boolean indicating whether or not the datetime object is
currently in Daylight Saving Time or not.
### $dt->time\_zone\_long\_name()
This is a shortcut for `$dt->time_zone->name`. It's provided so
that one can use "%{time\_zone\_long\_name}" as a strftime format
specifier.
### $dt->time\_zone\_short\_name()
This method returns the time zone abbreviation for the current time
zone, such as "PST" or "GMT". These names are **not** definitive, and
should not be used in any application intended for general use by
users around the world.
### $dt->strftime( $format, ... )
This method implements functionality similar to the `strftime()`
method in C. However, if given multiple format strings, then it will
return multiple scalars, one for each format string.
See the ["strftime Patterns"](#strftime-patterns) section for a list of all possible
strftime patterns.
If you give a pattern that doesn't exist, then it is simply treated as
text.
### $dt->format\_cldr( $format, ... )
This method implements formatting based on the CLDR date patterns. If
given multiple format strings, then it will return multiple scalars,
one for each format string.
See the ["CLDR Patterns"](#cldr-patterns) section for a list of all possible CLDR
patterns.
If you give a pattern that doesn't exist, then it is simply treated as
text.
### $dt->epoch()
Return the UTC epoch value for the datetime object. Internally, this
is implemented using `Time::Local`, which uses the Unix epoch even on
machines with a different epoch (such as MacOS). Datetimes before the
start of the epoch will be returned as a negative number.
The return value from this method is always an integer.
Since the epoch does not account for leap seconds, the epoch time for
1972-12-31T23:59:60 (UTC) is exactly the same as that for
1973-01-01T00:00:00.
This module uses `Time::Local` to calculate the epoch, which may or
may not handle epochs before 1904 or after 2038 (depending on the size
of your system's integers, and whether or not Perl was compiled with
64-bit int support).
### $dt->hires\_epoch()
Returns the epoch as a floating point number. The floating point
portion of the value represents the nanosecond value of the object.
This method is provided for compatibility with the `Time::HiRes`
module.
Note that this method suffers from the imprecision of floating point numbers,
and the result may end up rounded to an arbitrary degree depending on your
platform.
my $dt = DateTime->new( year => 2012, nanosecond => 4 );
say $dt->hires_epoch();
On my system, this simply prints `1325376000` because adding `0.000000004`
to `1325376000` returns `1325376000`.
### $dt->is\_finite(), $dt->is\_infinite()
These methods allow you to distinguish normal datetime objects from
infinite ones. Infinite datetime objects are documented in
[DateTime::Infinite](https://metacpan.org/pod/DateTime::Infinite).
### $dt->utc\_rd\_values()
Returns the current UTC Rata Die days, seconds, and nanoseconds as a
three element list. This exists primarily to allow other calendar
modules to create objects based on the values provided by this object.
### $dt->local\_rd\_values()
Returns the current local Rata Die days, seconds, and nanoseconds as a
three element list. This exists for the benefit of other modules
which might want to use this information for date math, such as
`DateTime::Event::Recurrence`.
### $dt->leap\_seconds()
Returns the number of leap seconds that have happened up to the
datetime represented by the object. For floating datetimes, this
always returns 0.
### $dt->utc\_rd\_as\_seconds()
Returns the current UTC Rata Die days and seconds purely as seconds.
This number ignores any fractional seconds stored in the object,
as well as leap seconds.
### $dt->locale()
Returns the current locale object.
### $dt->formatter()
Returns current formatter object or class. See ["Formatters And
Stringification"](#formatters-and-stringification) for details.
## "Set" Methods
The remaining methods provided by `DateTime.pm`, except where otherwise
specified, return the object itself, thus making method chaining
possible. For example:
my $dt = DateTime->now->set_time_zone( 'Australia/Sydney' );
my $first = DateTime
->last_day_of_month( year => 2003, month => 3 )
->add( days => 1 )
->subtract( seconds => 1 );
### $dt->set( .. )
This method can be used to change the local components of a date time. This
method accepts any parameter allowed by the `new()` method except for
"locale" or "time\_zone". Use `set_locale()` and `set_time_zone()` for those
instead.
This method performs parameter validation just like the `new()` method.
**Do not use this method to do date math. Use the `add()` and `subtract()`
methods instead.**
### $dt->set\_year(), $dt->set\_month(), etc.
DateTime has a `set_*` method for every item that can be passed to the
constructor:
- $dt->set\_year()
- $dt->set\_month()
- $dt->set\_day()
- $dt->set\_hour()
- $dt->set\_minute()
- $dt->set\_second()
- $dt->set\_nanosecond()
These are shortcuts to calling `set()` with a single key. They all
take a single parameter.
### $dt->truncate( to => ... )
This method allows you to reset some of the local time components in the
object to their "zero" values. The "to" parameter is used to specify which
values to truncate, and it may be one of "year", "quarter", "month", "week",
"local\_week", "day", "hour", "minute", or "second".
For example, if "month" is specified, then the local day becomes 1, and the
hour, minute, and second all become 0.
If "week" is given, then the datetime is set to the Monday of the week in
which it occurs, and the time components are all set to 0. If you truncate to
"local\_week", then the first day of the week is locale-dependent. For example,
in the `en-US` locale, the first day of the week is Sunday.
### $dt->set\_locale( $locale )
Sets the object's locale. You can provide either a locale code like "en-US" or
an object returned by `DateTime::Locale->load`.
### $dt->set\_time\_zone( $tz )
This method accepts either a time zone object or a string that can be
passed as the "name" parameter to `DateTime::TimeZone->new()`.
If the new time zone's offset is different from the old time zone,
then the _local_ time is adjusted accordingly.
For example:
my $dt = DateTime->new(
year => 2000,
month => 5,
day => 10,
hour => 15,
minute => 15,
time_zone => 'America/Los_Angeles',
);
print $dt->hour; # prints 15
$dt->set_time_zone( 'America/Chicago' );
print $dt->hour; # prints 17
If the old time zone was a floating time zone, then no adjustments to
the local time are made, except to account for leap seconds. If the
new time zone is floating, then the _UTC_ time is adjusted in order
to leave the local time untouched.
Fans of Tsai Ming-Liang's films will be happy to know that this does
work:
my $dt = DateTime->now( time_zone => 'Asia/Taipei' );
$dt->set_time_zone( 'Europe/Paris' );
Yes, now we can know "ni3 na4 bian1 ji2dian3?"
### $dt->set\_formatter( $formatter )
Set the formatter for the object. See ["Formatters And
Stringification"](#formatters-and-stringification) for details.
You can set this to `undef` to revert to the default formatter.
## Math Methods
Like the set methods, math related methods always return the object
itself, to allow for chaining:
$dt->add( days => 1 )->subtract( seconds => 1 );
### $dt->duration\_class()
This returns `DateTime::Duration`, but exists so that a subclass of
`DateTime.pm` can provide a different value.
### $dt->add\_duration( $duration\_object )
This method adds a `DateTime::Duration` to the current datetime. See
the [DateTime::Duration](https://metacpan.org/pod/DateTime::Duration) docs for more details.
### $dt->add( parameters for DateTime::Duration )
This method is syntactic sugar around the `add_duration()` method. It
simply creates a new `DateTime::Duration` object using the parameters
given, and then calls the `add_duration()` method.
### $dt->add( $duration\_object )
A synonym of `$dt->add_duration( $duration_object )`.
### $dt->subtract\_duration( $duration\_object )
When given a `DateTime::Duration` object, this method simply calls
`invert()` on that object and passes that new duration to the
`add_duration` method.
### $dt->subtract( DateTime::Duration->new parameters )
Like `add()`, this is syntactic sugar for the `subtract_duration()`
method.
### $dt->subtract( $duration\_object )
A synonym of `$dt->subtract_duration( $duration_object )`.
### $dt->subtract\_datetime( $datetime )
This method returns a new `DateTime::Duration` object representing
the difference between the two dates. The duration is **relative** to
the object from which `$datetime` is subtracted. For example:
2003-03-15 00:00:00.00000000
- 2003-02-15 00:00:00.00000000
-------------------------------
= 1 month
Note that this duration is not an absolute measure of the amount of
time between the two datetimes, because the length of a month varies,
as well as due to the presence of leap seconds.
The returned duration may have deltas for months, days, minutes,
seconds, and nanoseconds.
### $dt->delta\_md( $datetime )
### $dt->delta\_days( $datetime )
Each of these methods returns a new `DateTime::Duration` object
representing some portion of the difference between two datetimes.
The `delta_md()` method returns a duration which contains only the
month and day portions of the duration is represented. The
`delta_days()` method returns a duration which contains only days.
The `delta_md` and `delta_days` methods truncate the duration so
that any fractional portion of a day is ignored. Both of these
methods operate on the date portion of a datetime only, and so
effectively ignore the time zone.
Unlike the subtraction methods, **these methods always return a
positive (or zero) duration**.
### $dt->delta\_ms( $datetime )
Returns a duration which contains only minutes and seconds. Any day
and month differences to minutes are converted to minutes and
seconds. This method also **always return a positive (or zero)
duration**.
### $dt->subtract\_datetime\_absolute( $datetime )
This method returns a new `DateTime::Duration` object representing
the difference between the two dates in seconds and nanoseconds. This
is the only way to accurately measure the absolute amount of time
between two datetimes, since units larger than a second do not
represent a fixed number of seconds.
Note that because of leap seconds, this may not return the same result as
doing this math based on the value returned by `$dt->epoch()`.
## Class Methods
### DateTime->DefaultLocale( $locale )
This can be used to specify the default locale to be used when
creating DateTime objects. If unset, then "en-US" is used.
### DateTime->compare( $dt1, $dt2 ), DateTime->compare\_ignore\_floating( $dt1, $dt2 )
$cmp = DateTime->compare( $dt1, $dt2 );
$cmp = DateTime->compare_ignore_floating( $dt1, $dt2 );
Compare two DateTime objects. The semantics are compatible with Perl's
`sort()` function; it returns -1 if $dt1 < $dt2, 0 if $dt1 == $dt2, 1 if $dt1
\> $dt2.
If one of the two DateTime objects has a floating time zone, it will
first be converted to the time zone of the other object. This is what
you want most of the time, but it can lead to inconsistent results
when you compare a number of DateTime objects, some of which are
floating, and some of which are in other time zones.
If you want to have consistent results (because you want to sort a
number of objects, for example), you can use the
`compare_ignore_floating()` method:
@dates = sort { DateTime->compare_ignore_floating($a, $b) } @dates;
In this case, objects with a floating time zone will be sorted as if
they were UTC times.
Since DateTime objects overload comparison operators, this:
@dates = sort @dates;
is equivalent to this:
@dates = sort { DateTime->compare($a, $b) } @dates;
DateTime objects can be compared to any other calendar class that
implements the `utc_rd_values()` method.
## Testing Code That Uses DateTime
If you are trying to test code that calls uses DateTime, you may want to be
able to explicitly set the value returned by Perl's `time()` builtin. This
builtin is called by `DateTime->now()` and `DateTime->today()`.
You can override `CORE::GLOBAL::time()`, but this will only work if you do
this **before** loading DateTime. If doing this is inconvenient, you can also
override `DateTime::_core_time()`:
no warnings 'redefine';
local *DateTime::_core_time = sub { return 42 };
DateTime is guaranteed to call this subroutine to get the current `time()`
value. You can also override the `_core_time()` sub in a subclass of DateTime
and use that.
## How DateTime Math Works
It's important to have some understanding of how datetime math is
implemented in order to effectively use this module and
`DateTime::Duration`.
### Making Things Simple
If you want to simplify your life and not have to think too hard about
the nitty-gritty of datetime math, I have several recommendations:
- use the floating time zone
If you do not care about time zones or leap seconds, use the
"floating" timezone:
my $dt = DateTime->now( time_zone => 'floating' );
Math done on two objects in the floating time zone produces very
predictable results.
Note that in most cases you will want to start by creating an object in a
specific zone and _then_ convert it to the floating time zone. When an object
goes from a real zone to the floating zone, the time for the object remains
the same.
This means that passing the floating zone to a constructor may not do what you
want.
my $dt = DateTime->now( time_zone => 'floating' );
is equivalent to
my $dt = DateTime->now( time_zone => 'UTC' )->set_time_zone('floating');
This might not be what you wanted. Instead, you may prefer to do this:
my $dt = DateTime->now( time_zone => 'local' )->set_time_zone('floating');
- use UTC for all calculations
If you do care about time zones (particularly DST) or leap seconds,
try to use non-UTC time zones for presentation and user input only.
Convert to UTC immediately and convert back to the local time zone for
presentation:
my $dt = DateTime->new( %user_input, time_zone => $user_tz );
$dt->set_time_zone('UTC');
# do various operations - store it, retrieve it, add, subtract, etc.
$dt->set_time_zone($user_tz);
print $dt->datetime;
- math on non-UTC time zones
If you need to do date math on objects with non-UTC time zones, please
read the caveats below carefully. The results `DateTime.pm` produces are
predictable and correct, and mostly intuitive, but datetime math gets
very ugly when time zones are involved, and there are a few strange
corner cases involving subtraction of two datetimes across a DST
change.
If you can always use the floating or UTC time zones, you can skip
ahead to [Leap Seconds and Date Math](https://metacpan.org/pod/Leap Seconds and Date Math)
- date vs datetime math
If you only care about the date (calendar) portion of a datetime, you
should use either `delta_md()` or `delta_days()`, not
`subtract_datetime()`. This will give predictable, unsurprising
results, free from DST-related complications.
- subtract\_datetime() and add\_duration()
You must convert your datetime objects to the UTC time zone before
doing date math if you want to make sure that the following formulas
are always true:
$dt2 - $dt1 = $dur
$dt1 + $dur = $dt2
$dt2 - $dur = $dt1
Note that using `delta_days` ensures that this formula always works,
regardless of the timezone of the objects involved, as does using
`subtract_datetime_absolute()`. Other methods of subtraction are not
always reversible.
- never do math on two objects where only one is in the floating time zone
The date math code accounts for leap seconds whenever the `DateTime` object
is not in the floating time zone. If you try to do math where one object is in
the floating zone and the other isn't, the results will be confusing and
wrong.
### Adding a Duration to a Datetime
The parts of a duration can be broken down into five parts. These are
months, days, minutes, seconds, and nanoseconds. Adding one month to
a date is different than adding 4 weeks or 28, 29, 30, or 31 days.
Similarly, due to DST and leap seconds, adding a day can be different
than adding 86,400 seconds, and adding a minute is not exactly the
same as 60 seconds.
We cannot convert between these units, except for seconds and
nanoseconds, because there is no fixed conversion between the two
units, because of things like leap seconds, DST changes, etc.
`DateTime.pm` always adds (or subtracts) days, then months, minutes, and then
seconds and nanoseconds. If there are any boundary overflows, these are
normalized at each step. For the days and months the local (not UTC) values
are used. For minutes and seconds, the local values are used. This generally
just works.
This means that adding one month and one day to February 28, 2003 will
produce the date April 1, 2003, not March 29, 2003.
my $dt = DateTime->new( year => 2003, month => 2, day => 28 );
$dt->add( months => 1, days => 1 );
# 2003-04-01 - the result
On the other hand, if we add months first, and then separately add
days, we end up with March 29, 2003:
$dt->add( months => 1 )->add( days => 1 );
# 2003-03-29
We see similar strangeness when math crosses a DST boundary:
my $dt = DateTime->new(
year => 2003,
month => 4,
day => 5,
hour => 1,
minute => 58,
time_zone => "America/Chicago",
);
$dt->add( days => 1, minutes => 3 );
# 2003-04-06 02:01:00
$dt->add( minutes => 3 )->add( days => 1 );
# 2003-04-06 03:01:00
Note that if you converted the datetime object to UTC first you would
get predictable results.
If you want to know how many seconds a duration object represents, you
have to add it to a datetime to find out, so you could do:
my $now = DateTime->now( time_zone => 'UTC' );
my $later = $now->clone->add_duration($duration);
my $seconds_dur = $later->subtract_datetime_absolute($now);
This returns a duration which only contains seconds and nanoseconds.
If we were add the duration to a different datetime object we might
get a different number of seconds.
[DateTime::Duration](https://metacpan.org/pod/DateTime::Duration) supports three different end-of-month algorithms for
adding months. This comes into play when an addition results in a day past the
end of the month (for example, adding one month to January 30).
# 2010-08-31 + 1 month = 2010-10-01
$dt->add( months => 1, end_of_month => 'wrap' );
# 2010-01-30 + 1 month = 2010-02-28
$dt->add( months => 1, end_of_month => 'limit' );
# 2010-04-30 + 1 month = 2010-05-31
$dt->add( months => 1, end_of_month => 'preserve' );
By default, it uses "wrap" for positive durations and "preserve" for negative
durations. See [DateTime::Duration](https://metacpan.org/pod/DateTime::Duration) for a detailed explanation of these
algorithms.
If you need to do lots of work with durations, take a look at Rick
Measham's `DateTime::Format::Duration` module, which lets you present
information from durations in many useful ways.
There are other subtract/delta methods in DateTime.pm to generate
different types of durations. These methods are
`subtract_datetime()`, `subtract_datetime_absolute()`,
`delta_md()`, `delta_days()`, and `delta_ms()`.
### Datetime Subtraction
Date subtraction is done solely based on the two object's local
datetimes, with one exception to handle DST changes. Also, if the two
datetime objects are in different time zones, one of them is converted
to the other's time zone first before subtraction. This is best
explained through examples:
The first of these probably makes the most sense:
my $dt1 = DateTime->new(
year => 2003,
month => 5,
day => 6,
time_zone => 'America/Chicago',
);
# not DST
my $dt2 = DateTime->new(
year => 2003,
month => 11,
day => 6,
time_zone => 'America/Chicago',
);
# is DST
my $dur = $dt2->subtract_datetime($dt1);
# 6 months
Nice and simple.
This one is a little trickier, but still fairly logical:
my $dt1 = DateTime->new(
year => 2003,
month => 4,
day => 5,
hour => 1,
minute => 58,
time_zone => "America/Chicago",
);
# is DST
my $dt2 = DateTime->new(
year => 2003,
month => 4,
day => 7,
hour => 2,
minute => 1,
time_zone => "America/Chicago",
);
# not DST
my $dur = $dt2->subtract_datetime($dt1);
# 2 days and 3 minutes
Which contradicts the result this one gives, even though they both
make sense:
my $dt1 = DateTime->new(
year => 2003,
month => 4,
day => 5,
hour => 1,
minute => 58,
time_zone => "America/Chicago",
);
# is DST
my $dt2 = DateTime->new(
year => 2003,
month => 4,
day => 6,
hour => 3,
minute => 1,
time_zone => "America/Chicago",
);
# not DST
my $dur = $dt2->subtract_datetime($dt1);
# 1 day and 3 minutes
This last example illustrates the "DST" exception mentioned earlier.
The exception accounts for the fact 2003-04-06 only lasts 23 hours.
And finally:
my $dt2 = DateTime->new(
year => 2003,
month => 10,
day => 26,
hour => 1,
time_zone => 'America/Chicago',
);
my $dt1 = $dt2->clone->subtract( hours => 1 );
my $dur = $dt2->subtract_datetime($dt1);
# 60 minutes
This seems obvious until you realize that subtracting 60 minutes from
`$dt2` in the above example still leaves the clock time at
"01:00:00". This time we are accounting for a 25 hour day.
### Reversibility
Date math operations are not always reversible. This is because of
the way that addition operations are ordered. As was discussed
earlier, adding 1 day and 3 minutes in one call to `add()` is not the
same as first adding 3 minutes and 1 day in two separate calls.
If we take a duration returned from `subtract_datetime()` and then
try to add or subtract that duration from one of the datetimes we just
used, we sometimes get interesting results:
my $dt1 = DateTime->new(
year => 2003,
month => 4,
day => 5,
hour => 1,
minute => 58,
time_zone => "America/Chicago",
);
my $dt2 = DateTime->new(
year => 2003,
month => 4,
day => 6,
hour => 3,
minute => 1,
time_zone => "America/Chicago",
);
my $dur = $dt2->subtract_datetime($dt1);
# 1 day and 3 minutes
$dt1->add_duration($dur);
# gives us $dt2
$dt2->subtract_duration($dur);
# gives us 2003-04-05 02:58:00 - 1 hour later than $dt1
The `subtract_duration()` operation gives us a (perhaps) unexpected
answer because it first subtracts one day to get 2003-04-05T03:01:00
and then subtracts 3 minutes to get the final result.
If we explicitly reverse the order we can get the original value of
`$dt1`. This can be facilitated by `DateTime::Duration`'s
`calendar_duration()` and `clock_duration()` methods:
$dt2->subtract_duration( $dur->clock_duration )
->subtract_duration( $dur->calendar_duration );
### Leap Seconds and Date Math
The presence of leap seconds can cause even more anomalies in date
math. For example, the following is a legal datetime:
my $dt = DateTime->new(
year => 1972,
month => 12,
day => 31,
hour => 23,
minute => 59,
second => 60,
time_zone => 'UTC'
);
If we do the following:
$dt->add( months => 1 );
Then the datetime is now "1973-02-01 00:00:00", because there is no
23:59:60 on 1973-01-31.
Leap seconds also force us to distinguish between minutes and seconds
during date math. Given the following datetime:
my $dt = DateTime->new(
year => 1972,
month => 12,
day => 31,
hour => 23,
minute => 59,
second => 30,
time_zone => 'UTC'
);
we will get different results when adding 1 minute than we get if we
add 60 seconds. This is because in this case, the last minute of the
day, beginning at 23:59:00, actually contains 61 seconds.
Here are the results we get:
# 1972-12-31 23:59:30 - our starting datetime
$dt->clone->add( minutes => 1 );
# 1973-01-01 00:00:30 - one minute later
$dt->clone->add( seconds => 60 );
# 1973-01-01 00:00:29 - 60 seconds later
$dt->clone->add( seconds => 61 );
# 1973-01-01 00:00:30 - 61 seconds later
### Local vs. UTC and 24 hours vs. 1 day
When math crosses a daylight saving boundary, a single day may have
more or less than 24 hours.
For example, if you do this:
my $dt = DateTime->new(
year => 2003,
month => 4,
day => 5,
hour => 2,
time_zone => 'America/Chicago',
);
$dt->add( days => 1 );
then you will produce an _invalid_ local time, and therefore an
exception will be thrown.
However, this works:
my $dt = DateTime->new(
year => 2003,
month => 4,
day => 5,
hour => 2,
time_zone => 'America/Chicago',
);
$dt->add( hours => 24 );
and produces a datetime with the local time of "03:00".
If all this makes your head hurt, there is a simple alternative. Just
convert your datetime object to the "UTC" time zone before doing date
math on it, and switch it back to the local time zone afterwards.
This avoids the possibility of having date math throw an exception,
and makes sure that 1 day equals 24 hours. Of course, this may not
always be desirable, so caveat user!
## Overloading
This module explicitly overloads the addition (+), subtraction (-),
string and numeric comparison operators. This means that the
following all do sensible things:
my $new_dt = $dt + $duration_obj;
my $new_dt = $dt - $duration_obj;
my $duration_obj = $dt - $new_dt;
foreach my $dt ( sort @dts ) { ... }
Additionally, the fallback parameter is set to true, so other
derivable operators (+=, -=, etc.) will work properly. Do not expect
increment (++) or decrement (--) to do anything useful.
The string comparison operators, `eq` or `ne`, will use the string
value to compare with non-DateTime objects.
DateTime objects do not have a numeric value, using `==` or `<=>` to compare a DateTime object with a non-DateTime object will result
in an exception. To safely sort mixed DateTime and non-DateTime
objects, use `sort { $a cmp $b } @dates`.
The module also overloads stringification using the object's
formatter, defaulting to `iso8601()` method. See ["Formatters And
Stringification"](#formatters-and-stringification) for details.
## Formatters And Stringification
You can optionally specify a "formatter", which is usually a
DateTime::Format::\* object/class, to control the stringification of
the DateTime object.
Any of the constructor methods can accept a formatter argument:
my $formatter = DateTime::Format::Strptime->new(...);
my $dt = DateTime->new(year => 2004, formatter => $formatter);
Or, you can set it afterwards:
$dt->set_formatter($formatter);
$formatter = $dt->formatter();
Once you set the formatter, the overloaded stringification method will
use the formatter. If unspecified, the `iso8601()` method is used.
A formatter can be handy when you know that in your application you
want to stringify your DateTime objects into a special format all the
time, for example to a different language.
If you provide a formatter class name or object, it must implement a
`format_datetime` method. This method will be called with just the
DateTime object as its argument.
## CLDR Patterns
The CLDR pattern language is both more powerful and more complex than
strftime. Unlike strftime patterns, you often have to explicitly
escape text that you do not want formatted, as the patterns are simply
letters without any prefix.
For example, "yyyy-MM-dd" is a valid CLDR pattern. If you want to
include any lower or upper case ASCII characters as-is, you can
surround them with single quotes ('). If you want to include a single
quote, you must escape it as two single quotes ('').
'Today is ' EEEE
'It is now' h 'o''clock' a
Spaces and any non-letter text will always be passed through as-is.
Many CLDR patterns which produce numbers will pad the number with
leading zeroes depending on the length of the format specifier. For
example, "h" represents the current hour from 1-12. If you specify
"hh" then the 1-9 will have a leading zero prepended.
However, CLDR often uses five of a letter to represent the narrow form
of a pattern. This inconsistency is necessary for backwards
compatibility.
CLDR often distinguishes between the "format" and "stand-alone" forms
of a pattern. The format pattern is used when the thing in question is
being placed into a larger string. The stand-alone form is used when
displaying that item by itself, for example in a calendar.
It also often provides three sizes for each item, wide (the full
name), abbreviated, and narrow. The narrow form is often just a single
character, for example "T" for "Tuesday", and may not be unique.
CLDR provides a fairly complex system for localizing time zones that
we ignore entirely. The time zone patterns just use the information
provided by `DateTime::TimeZone`, and _do not follow the CLDR spec_.
The output of a CLDR pattern is always localized, when applicable.
CLDR provides the following patterns:
- G{1,3}
The abbreviated era (BC, AD).
- GGGG
The wide era (Before Christ, Anno Domini).
- GGGGG
The narrow era, if it exists (and it mostly doesn't).
- y and y{3,}
The year, zero-prefixed as needed. Negative years will start with a "-",
and this will be included in the length calculation.
In other, words the "yyyyy" pattern will format year -1234 as "-1234", not
"-01234".
- yy
This is a special case. It always produces a two-digit year, so "1976" becomes
"76". Negative years will start with a "-", making them one character longer.
- Y{1,}
The year in "week of the year" calendars, from `$dt->week_year()`.
- u{1,}
Same as "y" except that "uu" is not a special case.
- Q{1,2}
The quarter as a number (1..4).
- QQQ
The abbreviated format form for the quarter.
- QQQQ
The wide format form for the quarter.
- q{1,2}
The quarter as a number (1..4).
- qqq
The abbreviated stand-alone form for the quarter.
- qqqq
The wide stand-alone form for the quarter.
- M{1,2\]
The numerical month.
- MMM
The abbreviated format form for the month.
- MMMM
The wide format form for the month.
- MMMMM
The narrow format form for the month.
- L{1,2\]
The numerical month.
- LLL
The abbreviated stand-alone form for the month.
- LLLL
The wide stand-alone form for the month.
- LLLLL
The narrow stand-alone form for the month.
- w{1,2}
The week of the year, from `$dt->week_number()`.
- W
The week of the month, from `$dt->week_of_month()`.
- d{1,2}
The numeric day of the month.
- D{1,3}
The numeric day of the year.
- F
The day of the week in the month, from `$dt->weekday_of_month()`.
- g{1,}
The modified Julian day, from `$dt->mjd()`.
- E{1,3} and eee
The abbreviated format form for the day of the week.
- EEEE and eeee
The wide format form for the day of the week.
- EEEEE and eeeee
The narrow format form for the day of the week.
- e{1,2}
The _local_ numeric day of the week, from 1 to 7. This number depends
on what day is considered the first day of the week, which varies by
locale. For example, in the US, Sunday is the first day of the week,
so this returns 2 for Monday.
- c
The numeric day of the week from 1 to 7, treating Monday as the first
of the week, regardless of locale.
- ccc
The abbreviated stand-alone form for the day of the week.
- cccc
The wide stand-alone form for the day of the week.
- ccccc
The narrow format form for the day of the week.
- a
The localized form of AM or PM for the time.
- h{1,2}
The hour from 1-12.
- H{1,2}
The hour from 0-23.
- K{1,2}
The hour from 0-11.
- k{1,2}
The hour from 1-24.
- j{1,2}
The hour, in 12 or 24 hour form, based on the preferred form for the
locale. In other words, this is equivalent to either "h{1,2}" or
"H{1,2}".
- m{1,2}
The minute.
- s{1,2}
The second.
- S{1,}
The fractional portion of the seconds, rounded based on the length of
the specifier. This returned _without_ a leading decimal point, but
may have leading or trailing zeroes.
- A{1,}
The millisecond of the day, based on the current time. In other words,
if it is 12:00:00.00, this returns 43200000.
- z{1,3}
The time zone short name.
- zzzz
The time zone long name.
- Z{1,3}
The time zone offset.
- ZZZZ
The time zone short name and the offset as one string, so something
like "CDT-0500".
- ZZZZZ
The time zone offset as a sexagesimal number, so something like "-05:00".
(This is useful for W3C format.)
- v{1,3}
The time zone short name.
- vvvv
The time zone long name.
- V{1,3}
The time zone short name.
- VVVV
The time zone long name.
### CLDR "Available Formats"
The CLDR data includes pre-defined formats for various patterns such as "month
and day" or "time of day". Using these formats lets you render information
about a datetime in the most natural way for users from a given locale.
These formats are indexed by a key that is itself a CLDR pattern. When you
look these up, you get back a different CLDR pattern suitable for the locale.
Let's look at some example We'll use `2008-02-05T18:30:30` as our example
datetime value, and see how this is rendered for the `en-US` and `fr-FR`
locales.
- `MMMd`
The abbreviated month and day as number. For `en-US`, we get the pattern
`MMM d`, which renders as `Feb 5`. For `fr-FR`, we get the pattern
`d MMM`, which renders as `5 févr.`.
- `yQQQ`
The year and abbreviated quarter of year. For `en-US`, we get the pattern
`QQQ y`, which renders as `Q1 2008`. For `fr-FR`, we get the same pattern,
`QQQ y`, which renders as `T1 2008`.
- `hm`
The 12-hour time of day without seconds. For `en-US`, we get the pattern
`h:mm a`, which renders as `6:30 PM`. For `fr-FR`, we get the exact same
pattern and rendering.
The available formats for each locale are documented in the POD for that
locale. To get back the format, you use the `$locale->format_for`
method. For example:
say $dt->format_cldr( $dt->locale->format_for('MMMd') );
## strftime Patterns
The following patterns are allowed in the format string given to the
`$dt->strftime()` method:
- %a
The abbreviated weekday name.
- %A
The full weekday name.
- %b
The abbreviated month name.
- %B
The full month name.
- %c
The default datetime format for the object's locale.
- %C
The century number (year/100) as a 2-digit integer.
- %d
The day of the month as a decimal number (range 01 to 31).
- %D
Equivalent to %m/%d/%y. This is not a good standard format if you
want folks from both the United States and the rest of the world to
understand the date!
- %e
Like %d, the day of the month as a decimal number, but a leading zero
is replaced by a space.
- %F
Equivalent to %Y-%m-%d (the ISO 8601 date format)
- %G
The ISO 8601 year with century as a decimal number. The 4-digit year
corresponding to the ISO week number (see %V). This has the same
format and value as %Y, except that if the ISO week number belongs to
the previous or next year, that year is used instead. (TZ)
- %g
Like %G, but without century, i.e., with a 2-digit year (00-99).
- %h
Equivalent to %b.
- %H
The hour as a decimal number using a 24-hour clock (range 00 to 23).
- %I
The hour as a decimal number using a 12-hour clock (range 01 to 12).
- %j
The day of the year as a decimal number (range 001 to 366).
- %k
The hour (24-hour clock) as a decimal number (range 0 to 23); single
digits are preceded by a blank. (See also %H.)
- %l
The hour (12-hour clock) as a decimal number (range 1 to 12); single
digits are preceded by a blank. (See also %I.)
- %m
The month as a decimal number (range 01 to 12).
- %M
The minute as a decimal number (range 00 to 59).
- %n
A newline character.
- %N
The fractional seconds digits. Default is 9 digits (nanoseconds).
%3N milliseconds (3 digits)
%6N microseconds (6 digits)
%9N nanoseconds (9 digits)
This value will always be rounded down to the nearest integer.
- %p
Either \`AM' or \`PM' according to the given time value, or the
corresponding strings for the current locale. Noon is treated as \`pm'
and midnight as \`am'.
- %P
Like %p but in lowercase: \`am' or \`pm' or a corresponding string for
the current locale.
- %r
The time in a.m. or p.m. notation. In the POSIX locale this is
equivalent to \`%I:%M:%S %p'.
- %R
The time in 24-hour notation (%H:%M). (SU) For a version including the
seconds, see %T below.
- %s
The number of seconds since the epoch.
- %S
The second as a decimal number (range 00 to 61).
- %t
A tab character.
- %T
The time in 24-hour notation (%H:%M:%S).
- %u
The day of the week as a decimal, range 1 to 7, Monday being 1. See
also %w.
- %U
The week number of the current year as a decimal number, range 00 to
53, starting with the first Sunday as the first day of week 01. See
also %V and %W.
- %V
The ISO 8601:1988 week number of the current year as a decimal number,
range 01 to 53, where week 1 is the first week that has at least 4
days in the current year, and with Monday as the first day of the
week. See also %U and %W.
- %w
The day of the week as a decimal, range 0 to 6, Sunday being 0. See
also %u.
- %W
The week number of the current year as a decimal number, range 00 to
53, starting with the first Monday as the first day of week 01.
- %x
The default date format for the object's locale.
- %X
The default time format for the object's locale.
- %y
The year as a decimal number without a century (range 00 to 99).
- %Y
The year as a decimal number including the century.
- %z
The time-zone as hour offset from UTC. Required to emit
RFC822-conformant dates (using "%a, %d %b %Y %H:%M:%S %z").
- %Z
The time zone or name or abbreviation.
- %%
A literal \`%' character.
- %{method}
Any method name may be specified using the format `%{method}` name
where "method" is a valid `DateTime.pm` object method.
## DateTime.pm and Storable
DateTime implements Storable hooks in order to reduce the size of a
serialized DateTime object.
# THE DATETIME PROJECT ECOSYSTEM
This module is part of a larger ecosystem of modules in the DateTime
family.
## [DateTime::Set](https://metacpan.org/pod/DateTime::Set)
The [DateTime::Set](https://metacpan.org/pod/DateTime::Set) module represents sets (including recurrences) of
datetimes. Many modules return sets or recurrences.
## Format Modules
The various format modules exist to parse and format datetimes. For example,
[DateTime::Format::HTTP](https://metacpan.org/pod/DateTime::Format::HTTP) parses dates according to the RFC 1123 format:
my $datetime
= DateTime::Format::HTTP->parse_datetime('Thu Feb 3 17:03:55 GMT 1994');
print DateTime::Format::HTTP->format_datetime($datetime);
Most format modules are suitable for use as a `formatter` with a DateTime
object.
All format modules start with `DateTime::Format::`.
## Calendar Modules
There are a number of modules on CPAN that implement non-Gregorian calendars,
such as the Chinese, Mayan, and Julian calendars.
All calendar modules start with `DateTime::Calendar::`.
## Event Modules
There are a number of modules that calculate the dates for events, such as
Easter, Sunrise, etc.
All event modules start with `DateTime::Event::`.
## Others
There are many other modules that work with DateTime, including modules in the
`DateTimeX` namespace, as well as others.
See the [datetime wiki](http://datetime.perl.org) and
[search.cpan.org](http://search.cpan.org/search?query=datetime&mode=dist) for
more details.
# KNOWN BUGS
The tests in `20infinite.t` seem to fail on some machines,
particularly on Win32. This appears to be related to Perl's internal
handling of IEEE infinity and NaN, and seems to be highly
platform/compiler/phase of moon dependent.
If you don't plan to use infinite datetimes you can probably ignore
this. This will be fixed (perhaps) in future versions.
# SEE ALSO
[A Date with
Perl](http://www.houseabsolute.com/presentations/a-date-with-perl/) - a talk
I've given at a few YAPCs.
[datetime@perl.org mailing list](http://lists.perl.org/list/datetime.html)
[http://datetime.perl.org/](http://datetime.perl.org/)
# SUPPORT
Bugs may be submitted through [https://github.com/houseabsolute/DateTime.pm/issues](https://github.com/houseabsolute/DateTime.pm/issues).
There is a mailing list available for users of this distribution,
[mailto:datetime@perl.org](mailto:datetime@perl.org).
I am also usually active on IRC as 'autarch' on `irc://irc.perl.org`.
# DONATIONS
If you'd like to thank me for the work I've done on this module, please
consider making a "donation" to me via PayPal. I spend a lot of free time
creating free software, and would appreciate any support you'd care to offer.
Please note that **I am not suggesting that you must do this** in order for me
to continue working on this particular software. I will continue to do so,
inasmuch as I have in the past, for as long as it interests me.
Similarly, a donation made in this way will probably not make me work on this
software much more, unless I get so many donations that I can consider working
on free software full time (let's all have a chuckle at that together).
To donate, log into PayPal and send money to autarch@urth.org, or use the
button at [http://www.urth.org/~autarch/fs-donation.html](http://www.urth.org/~autarch/fs-donation.html).
# AUTHOR
Dave Rolsky <autarch@urth.org>
# CONTRIBUTORS
- Ben Bennett <fiji@limey.net>
- Christian Hansen <chansen@cpan.org>
- Daisuke Maki <dmaki@cpan.org>
- David E. Wheeler <david@justatheory.com>
- Doug Bell <madcityzen@gmail.com>
- Flávio Soibelmann Glock <fglock@gmail.com>
- Gregory Oschwald <oschwald@gmail.com>
- Iain Truskett <deceased>
- Jason McIntosh <jmac@jmac.org>
- Joshua Hoblitt <jhoblitt@cpan.org>
- Karen Etheridge <ether@cpan.org>
- Michael Conrad <mike@nrdvana.net>
- Michael R. Davis <mrdvt92@users.noreply.github.com>
- Nick Tonkin <1nickt@users.noreply.github.com>
- Olaf Alders <olaf@wundersolutions.com>
- Ovid <curtis\_ovid\_poe@yahoo.com>
- Philippe Bruhat (BooK) <book@cpan.org>
- Ricardo Signes <rjbs@cpan.org>
- Richard Bowen <bowen@cpan.org>
- Ron Hill <rkhill@cpan.org>
- Sam Kington <github@illuminated.co.uk>
- viviparous <viviparous@prc>
# COPYRIGHT AND LICENSE
This software is Copyright (c) 2016 by Dave Rolsky.
This is free software, licensed under:
The Artistic License 2.0 (GPL Compatible)
|