PHP中的日期相关函数(二)

上回文章中我们介绍了三个时间日期相关的对象,不过它们的出镜频率并不是特别地高。今天学习的对象虽说可能不少人使用过,但是它的出镜频率也是非常低的。它们其实就是我们非常常用的那些面向过程的日期函数的面向对象式的封装。但,酒香不怕巷子深,好东西还是值得我们去深入的学习研究的,当然更好的情况是可以在面对不同的业务场景时灵活地使用这些对象才是我们学习的根本目的。

DateTime 对象

没错,今天我们学习的就是 DateTime 对象。从名字就可以看出,它就是一个标准的日期时间类。

$date = new DateTime('now', new DateTimeZone('Asia/Tokyo'));
echo $date->format('Y-m-d H:i:sP'), PHP_EOL;
// 2020-09-29 09:47:57+09:00

$date = new DateTime();
echo $date->format('Y-m-d H:i:sP'), PHP_EOL;
// 2020-09-29 10:22:45+08:00

我们可以为它指定时间,指定时区。在第一行的测试代码中,我们指定了时间为 now ,也就是当前时间,这里还可以传递字符串的时间格式给这个参数。第二个参数就是指定时区,我们传递了日本的区域时区,所以它的 P 格式化后输入的就是 +9:00 ,也就是东九区,比我们的北京时间东八区早 1 个小时。DateTime 实例化时不传递任何参数的话,默认情况就是当前的时间以及 php.ini 中指定的时区。

还可以通过其它的方式来创建 DateTime 对象。

$date = DateTime::createFromFormat('Y年m月j日 H时i分s秒', '2020年09月22日 22时13分35秒');
echo $date->format('Y-m-d H:i:sP'), PHP_EOL;
// 2020-09-22 22:13:35+08:00

$date = DateTime::createFromImmutable(new DateTimeImmutable("2020-09-22 11:45"));
echo $date->format('Y-m-d H:i:sP'), PHP_EOL;
// 2020-09-22 11:45:00+08:00

createFromFormat() 静态方法是按照指定的格式来生成 DateTime 时间对象。在这里我们指定的格式是我们中文常用的格式,后面紧跟着具体的日期。createFromImmutable() 则是通过 DateTimeImmutable 对象来创建 DateTime 对象。

DateTime 与 DateTimeImmutable

DateTimeImmutable 是日期表示对象,它与 DateTime 基本没什么区别,方法、属性都和 DateTime 是一样的,唯一的区别就是在后面介绍的操作方法中它不会修改自身,而是返回一个新的对象。在 DateTimeImmutable 对象中也有一个静态方法 createFromMutable() 是从 DateTime 对象创建一个 DateTimeImmutable 对象。

$di = new DateTimeImmutable("2020-09-22 11:45");
var_dump($di);
// object(DateTimeImmutable)#1 (3) {
// ["date"]=>
// string(26) "2020-09-22 11:45:00.000000"
// ["timezone_type"]=>
// int(3)
// ["timezone"]=>
// string(13) "Asia/Shanghai"
// }
var_dump($di->add(new DateInterval('P3D')));
// object(DateTimeImmutable)#4 (3) {
// ["date"]=>
// string(26) "2020-09-25 11:45:00.000000"
// ["timezone_type"]=>
// int(3)
// ["timezone"]=>
// string(13) "Asia/Shanghai"
// }

$date = new DateTime("2020-09-22 11:45");
var_dump($date);
// object(DateTime)#4 (3) {
// ["date"]=>
// string(26) "2020-09-22 11:45:00.000000"
// ["timezone_type"]=>
// int(3)
// ["timezone"]=>
// string(13) "Asia/Shanghai"
// }
var_dump($date->add(new DateInterval('P3D')));
// object(DateTime)#4 (3) {
// ["date"]=>
// string(26) "2020-09-25 11:45:00.000000"
// ["timezone_type"]=>
// int(3)
// ["timezone"]=>
// string(13) "Asia/Shanghai"
// }

从上面的测试代码就可以看出 DateTimeImmutable 在使用 add() 方法之后返回的对象是一个新的对象,object(DateTimeImmutable)#1 (3) 变成了 object(DateTimeImmutable)#4 (3) 。而 DateTime 则是在自身进行的修改,对象标识符并没有发生改变。

DateTime 操作

上文中 add() 方法就是增加日期的方法,它需要一个 DateInterval 时间间隔对象作为参数,然后就会给对应的日期增加指定的时间间隔。

$date->add(new DateInterval('P3D'));
echo $date->format('Y-m-d H:i:sP'), PHP_EOL;
// 2020-09-29 09:22:45+08:00

这里我们就是为当前的时间增加了3天,关于 DateInterval 对象的内容可以查阅上篇文章中的介绍。当然,除了增加之外,还有减少以及修改的方法。

$date->sub(new DateInterval('P3D'));
echo $date->format('Y-m-d H:i:sP'), PHP_EOL;
// 2020-10-02 09:22:45+08:00

$date->modify('+5 day');
echo $date->format('Y-m-d H:i:sP'), PHP_EOL;
// 2020-10-04 09:22:45+08:00

$date->modify('-4 day -4 hours');
echo $date->format('Y-m-d H:i:sP'), PHP_EOL;
// 2020-09-30 05:22:45+08:00

sub() 方法就是给一个时间对象减少指定的时间间隔,而 modify() 方法就是根据参数来直接修改日期,比如我们这里测试了增加5天和减少4天4小时的操作。

$origin = new DateTime('now');
$target = new DateTime('2020-09-11');
$interval = $origin->diff($target);
echo $interval->format('%a days'), PHP_EOL;
echo $interval->format('%R%a days'), PHP_EOL;
// 18 days
// -18 days

diff() 方法就是返回两个日期之间的差值,相信这个方法不少人使用过它的面向过程的函数,也就是 date_diff() 函数,相对于其它方法来说,它的出镜率就非常高了。%R 返回的是符号位,如果是负号就是比指定的日期少了多少时间间隔。

设置日期时间

除了操作日期时间之外,我们在实例化 DateTime 对象之后,也可以为它重新指定日期。

$date = new DateTime();
$date->setDate(2020, 9, 25);
echo $date->format('Y-m-d H:i:sP'), PHP_EOL;
// 2020-09-25 09:22:45+08:00

$date->setISODate(2020, 9, 25);
echo $date->format('Y-m-d H:i:sP'), PHP_EOL;
// 2020-03-19 09:22:45+08:00

$date->setTime(14, 55);
echo $date->format('Y-m-d H:i:sP'), PHP_EOL;
// 2020-10-03 14:55:00+08:00

$date->setDate(2020, 9, 33);
echo $date->format('Y-m-d H:i:sP'), PHP_EOL;
// 2020-10-03 09:22:45+08:00

$date->setTime(14, 63);
echo $date->format('Y-m-d H:i:sP'), PHP_EOL;
// 2020-10-03 15:03:00+08:00

setDate() 方法就是指定日期,setTime() 方法是指定时间,它们是分开的两个方法哦。setISODate() 设置的是 ISO 标准时间,这又是另一套日期时间规范了,感兴趣的朋友可以自行查阅下相关的知识,这里就不多做赘述了。如果我们设置的日期不是一个正常的日期格式,比如我们在测试代码中设置了 9月33号 这个日期,那么它会自动向后延,输出的结果就是 10月3号 这个日期,包括 setTime() 方法也是可以这样顺延的。其实所有日期相关的对象、方法、函数都有这样的能力。

另外,我们还可以通过时间戳进行 DateTime 对象的日期时间设置。同理,时区也是可以单独设置的。

$date->setTimestamp(time()-84400);
echo $date->format('U = Y-m-d H:i:s'), PHP_EOL;
// 1601258165 = 2020-09-28 09:56:05

$date->setTimezone(new DateTimeZone('Asia/Tokyo'));
echo $date->format('U = Y-m-d H:i:s'), PHP_EOL;
// 1601258165 = 2020-09-28 10:56:05

获取属性及错误信息

既然 DateTime 对象有这么多设置的东西,那么相对应的它也有一些属性是可以让我们获取的。

echo $date->getOffset(), PHP_EOL;
// 32400

echo $date->getTimestamp(), PHP_EOL;
// 1601258070

var_dump($date->getTimezone());
// object(DateTimeZone)#6 (2) {
// ["timezone_type"]=>
// int(3)
// ["timezone"]=>
// string(10) "Asia/Tokyo"
// }

getOffset() 方法就是获取得我们与标准时区的差值,也就是对应的北京相差 8 个小时的信息,这个在之前的文章中与 DateTimeZone 对象的同名方法的作用是类似的。getTimestamp() 和 getTimezone() 方法相信也不用多解释了,一个是返回当前 DateTime 对象对应的时间戳,一个是返回一个时区对象。

最后,我们再来看看 DateTime() 对象的错误处理。DateTime 对象其实也是可以用过程化的方式来写的,所以它提供了一个 getLastErrors() 方法,不过我们在使用面向对象的方式时,DateTime 对象会以异常的形式进行抛出。

$date = date_create('asdfasdf');
print_r(DateTime::getLastErrors());
// Array
// (
// [warning_count] => 1
// [warnings] => Array
// (
// [6] => Double timezone specification
// )

// [error_count] => 1
// [errors] => Array
// (
// [0] => The timezone could not be found in the database
// )

// )

try {
$date = new DateTime('asdfasdf');
} catch (Exception $e) {
echo $e->getMessage(), PHP_EOL;
}
// DateTime::__construct(): Failed to parse time string (asdfasdf) at position 0 (a): The timezone could not be found in the database

第一段代码就是以面向过程的函数方式来创建的一个 DateTime 对象,它不会抛出异常,这样我们就可以通过 getLastErrors() 方法获得错误信息。但是现在还是更推荐以面向对象的方式来操作 DateTime ,所以我们应该尽量使用第二段代码的方式来处理错误信息。

总结

怎么样,DateTime 对象的是不是很有意思?思考一下,我们日常的很多日期操作是不是也可以通过它来实现了。关于 DateTimeImmutable 的内容就不会再单独讲解了,大家可以自己查阅一下相关的资料,因为内容其实都是和 DateTime 一样的,唯一的区别在上文中也已经说明了。

测试代码:

​https://github.com/zhangyue0503/dev-blog/blob/master/php/202009/source/13.PHP中的日期相关函数(二).php​

参考文档:

​https://www.php.net/manual/zh/class.datetime.php​

​https://www.php.net/manual/zh/class.datetimeimmutable.php​