日期及时间处理包 Carbon 在 Laravel 中的简单使用 | Specs' Blog-就爱PHP

在编写 PHP 应用时经常需要处理日期和时间，这篇文章带你了解一下 Carbon – 继承自 PHP DateTime 类的 API 扩展，它使得处理日期和时间更加简单。Laravel 中默认使用的时间处理类就是 Carbon。

  1. <?php
  2. namespace Carbon;
  3. class Carbon extends \DateTime
  4. {
  5. // code here
  6. }

你可以在 Carbon 命名空间的 Carbon 类中看到上面声明的代码片段。

安装

可以通过 Composer 来安装 Carbon：

  1. composer require nesbot/carbon

PS：由于 Laravel 项目已默认安装了此包，所以不需要再次执行上面的命令。

使用

你需要通过命名空间导入 Carbon 来使用，而不需每次都提供完整的名称。

  1. use Carbon\Carbon;

获取当前时间

可以同 now() 方法获取当前的日期和时间。如果你不指定参数，它会使用 PHP 配置中的时区：

  1. <?php
  2. echo Carbon::now(); //2016-10-14 20:21:20
  3. ?>

如果你想使用一个不同的时区，你需要传递一个有效的时区作为参数：

  1. // 直接使用字符串
  2. echo Carbon::now('Europe/London'); //2016-10-14 20:21:20
  3. // 或者
  4. echo Carbon::now(new DateTimeZone('Europe/London'));

除 now() 外，还提供了 today()、tomorrow()、yesterday() 等静态函数，不过，它们的时间都是 00:00:00 ：

  1. echo Carbon::now(); // 2016-10-14 15:18:34
  2. echo Carbon::today(); // 2016-10-14 00:00:00
  3. echo Carbon::tomorrow('Europe/London'); // 2016-10-14 00:00:00
  4. echo Carbon::yesterday(); // 2016-10-14 00:00:00

以上输出结果其实是一个 Carbon 类型的日期时间对象：

  1. Carbon {#179 ▼
  2. +"date": "2016-06-14 00:00:00.000000"
  3. +"timezone_type": 3
  4. +"timezone": "UTC"
  5. }

要想获取字符串类型的日期，可以使用下面的代码：

  1. echo Carbon::today()->toDateTimeString();
  2. echo Carbon::yesterday()->toDateTimeString();
  3. echo Carbon::tomorrow()->toDateTimeString();

日期类型转为字符串

如上所述，默认情况下，Carbon 的方法返回的为一个日期时间对象。虽然它是一个对象，但是你却可以直接使用 echo 输出结果，因为有 __toString 魔术方法。但是如果你想把它转为字符串，可以使用 toDateString 或 toDateTimeString 方法：

  1. echo Carbon::now()->toDateString(); //2016-10-14
  2. echo Carbon::now()->toDateTimeString(); //2016-10-14 20:22:50

日期解析

你还可以使用 parse 方法解析任何顺序和类型的日期（结果为 Carbon 类型的日期时间对象）：

  1. echo Carbon::parse('2016-10-15')->toDateTimeString(); //2016-10-15 00:00:00
  2. echo Carbon::parse('2016-10-15')->toDateTimeString(); //2016-10-15 00:00:00
  3. echo Carbon::parse('2016-10-15 00:10:25')->toDateTimeString(); //2016-10-15 00:10:25
  4. echo Carbon::parse('today')->toDateTimeString(); //2016-10-15 00:00:00
  5. echo Carbon::parse('yesterday')->toDateTimeString(); //2016-10-14 00:00:00
  6. echo Carbon::parse('tomorrow')->toDateTimeString(); //2016-10-16 00:00:00
  7. echo Carbon::parse('2 days ago')->toDateTimeString(); //2016-10-13 20:49:53
  8. echo Carbon::parse('+3 days')->toDateTimeString(); //2016-10-18 20:49:53
  9. echo Carbon::parse('+2 weeks')->toDateTimeString(); //2016-10-29 20:49:53
  10. echo Carbon::parse('+4 months')->toDateTimeString(); //2017-02-15 20:49:53
  11. echo Carbon::parse('-1 year')->toDateTimeString(); //2015-10-15 20:49:53
  12. echo Carbon::parse('next wednesday')->toDateTimeString(); //2016-10-19 00:00:00
  13. echo Carbon::parse('last friday')->toDateTimeString(); //2016-10-14 00:00:00

构造日期

你还可以使用单独的年月日来构造日期：

  1. $year = '2015';
  2. $month = '04';
  3. $day = '12';
  4. echo Carbon::createFromDate($year, $month, $day); //2015-04-12 20:55:59
  5. $hour = '02';
  6. $minute = '15':
  7. $second = '30';
  8. echo Carbon::create($year, $month, $day, $hour, $minute, $second); //2015-04-12 02:15:30
  9. echo Carbon::createFromDate(null, 12, 25); // 年默认为当前年份

此外，还可以传递一个有效的时区作为最后一个参数。

日期操作

日期操作可以通过 add （增加）或 sub （减去）跟上要增加或减去的单位来完成。例如，你想给一个日期增加指定的天数，你可以使用 addDays 方法。此外还提供了一个 modify 方法，参数格式为 + 或 - 跟上值及单位。所以，如果你想给当前日期增加一年，你可以传递 +1 year：

  1. echo Carbon::now()->addDays(25); //2016-11-09 14:00:01
  2. echo Carbon::now()->addWeeks(3); //2016-11-05 14:00:01
  3. echo Carbon::now()->addHours(25); //2016-10-16 15:00:01
  4. echo Carbon::now()->subHours(2); //2016-10-15 12:00:01
  5. echo Carbon::now()->addHours(2)->addMinutes(12); //2016-10-15 16:12:01
  6. echo Carbon::now()->modify('+15 days'); //2016-10-30 14:00:01
  7. echo Carbon::now()->modify('-2 days'); //2016-10-13 14:00:01

日期比较

在 Carbon 中你可以使用下面的方法来比较日期：

  • min –返回最小日期。
  • max – 返回最大日期。
  • eq – 判断两个日期是否相等。
  • gt – 判断第一个日期是否比第二个日期大。
  • lt – 判断第一个日期是否比第二个日期小。
  • gte – 判断第一个日期是否大于等于第二个日期。
  • lte – 判断第一个日期是否小于等于第二个日期。
  1. echo Carbon::now()->tzName; // America/Toronto
  2. $first = Carbon::create(2012, 9, 5, 23, 26, 11);
  3. $second = Carbon::create(2012, 9, 5, 20, 26, 11, 'America/Vancouver');
  4. echo $first->toDateTimeString(); // 2012-09-05 23:26:11
  5. echo $first->tzName; // America/Toronto
  6. echo $second->toDateTimeString(); // 2012-09-05 20:26:11
  7. echo $second->tzName; // America/Vancouver
  8. var_dump($first->eq($second)); // bool(true)
  9. var_dump($first->ne($second)); // bool(false)
  10. var_dump($first->gt($second)); // bool(false)
  11. var_dump($first->gte($second)); // bool(true)
  12. var_dump($first->lt($second)); // bool(false)
  13. var_dump($first->lte($second)); // bool(true)
  14. $first->setDateTime(2012, 1, 1, 0, 0, 0);
  15. $second->setDateTime(2012, 1, 1, 0, 0, 0); // Remember tz is 'America/Vancouver'
  16. var_dump($first->eq($second)); // bool(false)
  17. var_dump($first->ne($second)); // bool(true)
  18. var_dump($first->gt($second)); // bool(false)
  19. var_dump($first->gte($second)); // bool(false)
  20. var_dump($first->lt($second)); // bool(true)
  21. var_dump($first->lte($second)); // bool(true)

要判断一个日期是否介于两个日期之间，可以使用 between() 方法，第三个可选参数指定比较是否可以相等，默认为 true：

  1. $first = Carbon::create(2012, 9, 5, 1);
  2. $second = Carbon::create(2012, 9, 5, 5);
  3. var_dump(Carbon::create(2012, 9, 5, 3)->between($first, $second)); // bool(true)
  4. var_dump(Carbon::create(2012, 9, 5, 5)->between($first, $second)); // bool(true)
  5. var_dump(Carbon::create(2012, 9, 5, 5)->between($first, $second, false)); // bool(false)

此外还提供了一些辅助方法，你可以从它们的名字中明白其含义：

  1. $dt = Carbon::now();
  2. $dt->isWeekday();
  3. $dt->isWeekend();
  4. $dt->isYesterday();
  5. $dt->isToday();
  6. $dt->isTomorrow();
  7. $dt->isFuture();
  8. $dt->isPast();
  9. $dt->isLeapYear();
  10. $dt->isSameDay(Carbon::now());
  11. $born = Carbon::createFromDate(1987, 4, 23);
  12. $noCake = Carbon::createFromDate(2014, 9, 26);
  13. $yesCake = Carbon::createFromDate(2014, 4, 23);
  14. $overTheHill = Carbon::now()->subYears(50);
  15. var_dump($born->isBirthday($noCake)); // bool(false)
  16. var_dump($born->isBirthday($yesCake)); // bool(true)
  17. var_dump($overTheHill->isBirthday()); // bool(true) -> default compare it to today!

diffForHumans

“一个月前”比“30 天前”更便于阅读，很多日期库都提供了这个常见的功能，日期被解析后，有下面四种可能性：

  • 当比较的时间超过当前默认时间

    • 1天前
    • 5月前

  • 当用将来的时间与当前默认时间比较

    • 1小时距现在
    • 5月距现在

  • 当比较的值超过另一个值

    • 1小时前
    • 5月前

  • 当比较的值在另一个值之后

    • 1小时后
    • 5月后

你可以把第二个参数设置为 true 来删除“前”、“距现在”等修饰语：diffForHumans(Carbon $other, true)。

  1. echo Carbon::now()->subDays(5)->diffForHumans(); // 5天前
  2. echo Carbon::now()->diffForHumans(Carbon::now()->subYear()); // 1年后
  3. $dt = Carbon::createFromDate(2011, 8, 1);
  4. echo $dt->diffForHumans($dt->copy()->addMonth()); // 1月前
  5. echo $dt->diffForHumans($dt->copy()->subMonth()); // 11月后
  6. echo Carbon::now()->addSeconds(5)->diffForHumans(); // 5秒距现在
  7. echo Carbon::now()->subDays(24)->diffForHumans(); // 3周前
  8. echo Carbon::now()->subDays(24)->diffForHumans(null, true); // 3周

本地化

关于时间本地化，可以参考之前写的文章：《Laravel中Carbon时间格式本地化》

更多详细用法，可以参考 Carbon 文档。

Original url: Access
Created at: 2018-11-14 16:29:34
Category: default
Tags: none

未标明原创文章均为采集，版权归作者所有，转载无需和我联系，请注明原出处，南摩阿彌陀佛，知识，不只知道，要得到

请先后发表评论
  • 最新评论
  • 总共0条评论