第詳解PHP中時間處理類Carbon常用方法的使用目錄1.StringFormatting2.CommonFormats3.Comparison4.AdditionandSubtraction5.Difference6.DifferenceforHumans7.Modifiers8.Constants9.CarbonInterval

1.StringFormatting

所有類似toXXXString()這樣的方法都依賴于DateTime::format()。__toString()方法允許Carbon實例被打印時以一種可讀性更好的方式被打印出來。

$dt=Carbon::create(1975,12,25,14,15,16);

var_dump($dt-toDateTimeString()==$dt);//bool(true)=uses__toString()

echo$dt-toDateString();//1975-12-25

echo$dt-toFormattedDateString();//Dec25,1975

echo$dt-toTimeString();//14:15:16

echo$dt-toDateTimeString();//1975-12-2514:15:16

echo$dt-toDayDateTimeString();//Thu,Dec25,19752:15PM

//...ofcourseformat()isstillavailable

echo$dt-format('ljS\\ofFYh:i:sA');//Thursday25thofDecember197502:15:16PM

另外可以默認設置__toString()方法所要顯示的時間日期格式。

Carbon::setToStringFormat('jS\o\fF,Yg:i:sa');

echo$dt;//25thofDecember,19752:15:16pm

Carbon::resetToStringFormat();

echo$dt;//1975-12-2514:15:16

如果需要設定特定的語言顯示，請參考Localization部分。

2.CommonFormats

下面是對DateTime類提供的通用格式的一些封裝。

$dt=Carbon::now();

//$dt-toAtomString()isthesameas$dt-format(DateTime::ATOM);

echo$dt-toAtomString();//1975-12-25T14:15:16-05:00

echo$dt-toCookieString();//Thursday,25-Dec-197514:15:16EST

echo$dt-toIso8601String();//1975-12-25T14:15:16-0500

echo$dt-toRfc822String();//Thu,25Dec7514:15:16-0500

echo$dt-toRfc850String();//Thursday,25-Dec-7514:15:16EST

echo$dt-toRfc1036String();//Thu,25Dec7514:15:16-0500

echo$dt-toRfc1123String();//Thu,25Dec197514:15:16-0500

echo$dt-toRfc2822String();//Thu,25Dec197514:15:16-0500

echo$dt-toRfc3339String();//1975-12-25T14:15:16-05:00

echo$dt-toRssString();//Thu,25Dec197514:15:16-0500

echo$dt-toW3cString();//1975-12-25T14:15:16-05:00

3.Comparison

通過以下方式可以對兩個Carbon實例進行簡單的比較。牢記這些比較都是在UTC時區(qū)下完成的。

echoCarbon::now()-tzName;//America/Toronto

$first=Carbon::create(2012,9,5,23,26,11);

$second=Carbon::create(2012,9,5,20,26,11,'America/Vancouver');

echo$first-toDateTimeString();//2012-09-0523:26:11

echo$first-tzName;//America/Toronto

echo$second-toDateTimeString();//2012-09-0520:26:11

echo$second-tzName;//America/Vancouver

var_dump($first-eq($second));//bool(true)

var_dump($first-ne($second));//bool(false)

var_dump($first-gt($second));//bool(false)

var_dump($first-gte($second));//bool(true)

var_dump($first-lt($second));//bool(false)

var_dump($first-lte($second));//bool(true)

$first-setDateTime(2012,1,1,0,0,0);

$second-setDateTime(2012,1,1,0,0,0);//Remembertzis'America/Vancouver'

var_dump($first-eq($second));//bool(false)

var_dump($first-ne($second));//bool(true)

var_dump($first-gt($second));//bool(false)

var_dump($first-gte($second));//bool(false)

var_dump($first-lt($second));//bool(true)

var_dump($first-lte($second));//bool(true)

如果要判斷當前實例對應的時間，是否在其他兩個實例對應的時間之間，可以用between()方法。如果提供了第三個參數(shù)，并且為true，將會進行=和=的操作。如果為false，會進行和的操作。該參數(shù)默認是true。

$first=Carbon::create(2012,9,5,1);

$second=Carbon::create(2012,9,5,5);

var_dump(Carbon::create(2012,9,5,3)-between($first,$second));//bool(true)

var_dump(Carbon::create(2012,9,5,5)-between($first,$second));//bool(true)

var_dump(Carbon::create(2012,9,5,5)-between($first,$second,false));//bool(false)

還記得min()和max()嗎？min()將會返回兩個實例中時間較早的實例，max()返回時間較晚的那個。如果沒有提供給min()或max()任何參數(shù)，將會拿當前時間和調(diào)用該方法的實例進行比較。

$dt1=Carbon::create(2012,1,1,0,0,0);

$dt2=Carbon::create(2014,1,30,0,0,0);

echo$dt1-min($dt2);//2012-01-0100:00:00

$dt1=Carbon::create(2012,1,1,0,0,0);

$dt2=Carbon::create(2014,1,30,0,0,0);

echo$dt1-max($dt2);//2014-01-3000:00:00

//nowisthedefaultparam

$dt1=Carbon::create(2000,1,1,0,0,0);

echo$dt1-max();//2016-06-2415:18:34

Carbon提供了一些見名知意的輔助方法去處理大部分用到的場景。需要執(zhí)行比較操作的方法都會與當前時區(qū)的當前時間進行比較。

$dt=Carbon::now();

$dt-isWeekday();

$dt-isWeekend();

$dt-isYesterday();

$dt-isToday();

$dt-isTomorrow();

$dt-isFuture();

$dt-isPast();

$dt-isLeapYear();

$dt-isSameDay(Carbon::now());

$born=Carbon::createFromDate(1987,4,23);

$noCake=Carbon::createFromDate(2014,9,26);

$yesCake=Carbon::createFromDate(2014,4,23);

$overTheHill=Carbon::now()-subYears(50);

var_dump($born-isBirthday($noCake));//bool(false)

var_dump($born-isBirthday($yesCake));//bool(true)

var_dump($overTheHill-isBirthday());//bool(true)-defaultcompareittotoday!

4.AdditionandSubtraction

默認的DateTime類提供了一對方便增加和減少時間的方法。有modify()，add()和sub()。modify()方法接受一個標準的data/time字符串，該方法會對字符串進行解析，當牽扯到add()和sub()時會隱式調(diào)用DateInterval類進行處理。用鏈式調(diào)用的方式進行操作，代碼將會更加的清晰和易讀。當然，由于繼承關系這并不會影響你使用底層的方法進行操作。

$dt=Carbon::create(2012,1,31,0);

echo$dt-toDateTimeString();//2012-01-3100:00:00

echo$dt-addYears(5);//2017-01-3100:00:00

echo$dt-addYear();//2025-01-3100:00:00

echo$dt-subYear();//2017-01-3100:00:00

echo$dt-subYears(5);//2012-01-3100:00:00

echo$dt-addMonths(60);//2017-01-3100:00:00

echo$dt-addMonth();//2017-03-0300:00:00equivalentof$dt-month($dt-month+1);soitwraps

echo$dt-subMonth();//2017-02-0300:00:00

echo$dt-subMonths(60);//2012-02-0300:00:00

echo$dt-addDays(29);//2012-03-0300:00:00

echo$dt-addDay();//2012-03-0400:00:00

echo$dt-subDay();//2012-03-0300:00:00

echo$dt-subDays(29);//2012-02-0300:00:00

echo$dt-addWeekdays(4);//2012-02-0900:00:00

echo$dt-addWeekday();//2012-02-1000:00:00

echo$dt-subWeekday();//2012-02-0900:00:00

echo$dt-subWeekdays(4);//2012-02-0300:00:00

echo$dt-addWeeks(3);//2012-02-2400:00:00

echo$dt-addWeek();//2012-03-0200:00:00

echo$dt-subWeek();//2012-02-2400:00:00

echo$dt-subWeeks(3);//2012-02-0300:00:00

echo$dt-addHours(24);//2012-02-0400:00:00

echo$dt-addHour();//2012-02-0401:00:00

echo$dt-subHour();//2012-02-0400:00:00

echo$dt-subHours(24);//2012-02-0300:00:00

echo$dt-addMinutes(61);//2012-02-0301:01:00

echo$dt-addMinute();//2012-02-0301:02:00

echo$dt-subMinute();//2012-02-0301:01:00

echo$dt-subMinutes(61);//2012-02-0300:00:00

echo$dt-addSeconds(61);//2012-02-0300:01:01

echo$dt-addSecond();//2012-02-0300:01:02

echo$dt-subSecond();//2012-02-0300:01:01

echo$dt-subSeconds(61);//2012-02-0300:00:00

當然你也可以傳遞負值到addXXX()方法，實際這正是subXXX()方法所實現(xiàn)的功能。

5.Difference

以下方法總是返回兩個實例之間的時間差。與基類中的diff()方法不同的是，diff()方法會通過DateInterval實例將61秒轉(zhuǎn)化成1分1秒來返回。下邊的這些方法第一個參數(shù)是將會用來比較的Carbon實例，默認為now()方法創(chuàng)建的當前時間實例。第二個參數(shù)也是可選的,指明了你是否需要返回一個比較結(jié)果的絕對值，默認為true，當?shù)诙€參數(shù)為false，并且用于比較的實例時間早于被比較的實例時，返回負數(shù)。所有的比較操作都在UTC時區(qū)下完成。

//Carbon::diffInYears(Carbon$dt=null,$abs=true)

echoCarbon::now('America/Vancouver')-diffInSeconds(Carbon::now('Europe/London'));//0

$dtOttawa=Carbon::createFromDate(2000,1,1,'America/Toronto');

$dtVancouver=Carbon::createFromDate(2000,1,1,'America/Vancouver');

echo$dtOttawa-diffInHours($dtVancouver);//3

echo$dtOttawa-diffInHours($dtVancouver,false);//3

echo$dtVancouver-diffInHours($dtOttawa,false);//-3

$dt=Carbon::create(2012,1,31,0);

echo$dt-diffInDays($dt-copy()-addMonth());//31

echo$dt-diffInDays($dt-copy()-subMonth(),false);//-31

$dt=Carbon::create(2012,4,30,0);

echo$dt-diffInDays($dt-copy()-addMonth());//30

echo$dt-diffInDays($dt-copy()-addWeek());//7

$dt=Carbon::create(2012,1,1,0);

echo$dt-diffInMinutes($dt-copy()-addSeconds(59));//0

echo$dt-diffInMinutes($dt-copy()-addSeconds(60));//1

echo$dt-diffInMinutes($dt-copy()-addSeconds(119));//1

echo$dt-diffInMinutes($dt-copy()-addSeconds(120));//2

echo$dt-addSeconds(120)-secondsSinceMidnight();//120

一些特殊的過濾方法，像diffInDaysFiltered()、diffInHoursFiltered()和diffFiltered(),可以幫助你過濾時間差中的days、hour或者一個自定義的時間間隔。下邊是統(tǒng)計兩個實例之間的周末天數(shù)。

$dt=Carbon::create(2014,1,1);

$dt2=Carbon::create(2014,12,31);

$daysForExtraCoding=$dt-diffInDaysFiltered(function(Carbon$date){

return$date-isWeekend();

},$dt2);

echo$daysForExtraCoding;//104

$dt=Carbon::create(2014,1,1)-startOfDay();

$dt2=$dt-copy()-endOfDay();

$littleHandRotations=$dt-diffFiltered(CarbonInterval::minute(),function(Carbon$date){

return$date-minute===0;

},$dt2);

echo$littleHandRotations;//24

//othersthataredefined

//diffInYears(),diffInMonths(),diffInWeeks()

//diffInDays(),diffInWeekdays(),diffInWeekendDays()

//diffInHours(),diffInMinutes(),diffInSeconds()

//secondsSinceMidnight(),secondsUntilEndOfDay()

6.DifferenceforHumans

對于人們來說,一月前比30天前更加易與理解。這是一個常見的方法在許多日期處理類庫中，所以他想也應該把這個加進來。這里把一個月看做四周，這些方法需要一個可選的Carbon實例作為參數(shù)來進行比較，默認為當前時間的實例。

這些方法會在兩個時間差值后增加一寫描述，可能類似下邊這四種：

Whencomparingavalueinthepasttodefaultnow:

1hourago5monthsago

Whencomparingavalueinthefuturetodefaultnow:

1hourfromnow5monthsfromnow

Whencomparingavalueinthepasttoanothervalue:

1hourbefore5monthsbefore

Whencomparingavalueinthefuturetoanothervalue:

1hourafter5monthsafter

你也可以傳遞第二個參數(shù)去掉類似ago，fromnow這種修飾符，類似這樣的用法diffForHumans(Carbon$other,true)等。

//Themosttypicalusageisforcomments

//Theinstanceisthedatethecommentwascreatedanditsbeingcomparedtodefaultnow()

echoCarbon::now()-subDays(5)-diffForHumans();//5daysago

echoCarbon::now()-diffForHumans(Carbon::now()-subYear());//1yearafter

$dt=Carbon::createFromDate(2011,8,1);

echo$dt-diffForHumans($dt-copy()-addMonth());//1monthbefore

echo$dt-diffForHumans($dt-copy()-subMonth());//1monthafter

echoCarbon::now()-addSeconds(5)-diffForHumans();//5secondsfromnow

echoCarbon::now()-subDays(24)-diffForHumans();//3weeksago

echoCarbon::now()-subDays(24)-diffForHumans(null,true);//3weeks

你也通過在diffForHumans()被調(diào)用前，使用Carbon::setLocale(fr)來改變語言設置。詳細請參考localization部分。

7.Modifiers

Carbonargument.這些方法組對修改當前實例很有幫助。你會注意到startOfXXX()，next()，和previous()方法將會設置時間為00:00:00，另外endOfXXX()方法將會設置時間為23:59:59。

$dt=Carbon::create(2012,1,31,12,0,0);

echo$dt-startOfDay();//2012-01-3100:00:00

$dt=Carbon::create(2012,1,31,12,0,0);

echo$dt-endOfDay();//2012-01-3123:59:59

$dt=Carbon::create(2012,1,31,12,0,0);

echo$dt-startOfMonth();//2012-01-0100:00:00

$dt=Carbon::create(2012,1,31,12,0,0);

echo$dt-endOfMonth();//2012-01-3123:59:59

$dt=Carbon::create(2012,1,31,12,0,0);

echo$dt-startOfYear();//2012-01-0100:00:00

$dt=Carbon::create(2012,1,31,12,0,0);

echo$dt-endOfYear();//2012-12-3123:59:59

$dt=Carbon::create(2012,1,31,12,0,0);

echo$dt-startOfDecade();//2010-01-0100:00:00

$dt=Carbon::create(2012,1,31,12,0,0);

echo$dt-endOfDecade();//2025-12-3123:59:59

$dt=Carbon::create(2012,1,31,12,0,0);

echo$dt-startOfCentury();//2000-01-0100:00:00

$dt=Carbon::create(2012,1,31,12,0,0);

echo$dt-endOfCentury();//2099-12-3123:59:59

$dt=Carbon::create(2012,1,31,12,0,0);

echo$dt-startOfWeek();//2012-01-3000:00:00

var_dump($dt-dayOfWeek==Carbon::MONDAY);//bool(true):ISO8601weekstartsonMonday

$dt=Carbon::create(2012,1,31,12,0,0);

echo$dt-endOfWeek();//2012-02-0523:59:59

var_dump($dt-dayOfWeek==Carbon::SUNDAY);//bool(true):ISO8601weekendsonSunday

$dt=Carbon::create(2012,1,31,12,0,0);

echo$dt-next(Carbon::WEDNESDAY);//2012-02-0100:00:00

var_dump($dt-dayOfWeek==Carbon::WEDNESDAY);//bool(true)

$dt=Carbon::create(2012,1,1,12,0,0);

echo$dt-next();//2012-01-0800:00:00

$dt=Carbon::create(2012,1,31,12,0,0);

echo$dt-previous(Carbon::WEDNESDAY);//2012-01-2500:00:00

var_dump($dt-dayOfWeek==Carbon::WEDNESDAY);//bool(true)

$dt=Carbon::create(2012,1,1,12,0,0);

echo$dt-previous();//2011-12-2500:00:00

$start=Carbon::create(2014,1,1,0,0,0);

$end=Carbon::create(2014,1,30,0,0,0);

echo$start-average($end);//2014-01-1512:00:00

//othersthataredefinedthataresimilar

//firstOfMonth(),lastOfMonth(),nthOfMonth()

//firstOfQuarter(),lastOfQuarter(),nthOfQuarter()

//firstOfYear(),lastOfYear(),nthOfYear()

8.Constants

Carbon中定義了以下常量。

//Thesegettersspecificallyreturnintegers,ieintval()

var_dump(Carbon::SUNDAY);//int(0)

var_dump(Carbon::MONDAY);//int(1)

var_dump(Carbon::TUESDAY);//int(2)

var_dump(Carbon::WEDNESDAY);//int(3)

var_dump(Carbon::THURSDAY);//int(4)

var_dump(Carbon::FRIDAY);//int(5)

var_dump(Carbon::SATURDAY);//int(6)

var_dump(Carbon::YEARS_PER_CENTURY);//int(100)

var_dump(Carbon::YEARS_PER_DECADE);//int(10)

var_dump(Carbon::MONTHS_PER_YEAR);//int(12)

var_dump(Carbon::WEEKS_PER_YEAR);//int(52)

var_dump(Carbon::DAYS_PER_WEEK);//int(7)

var_dump(Carbon::HOURS_PER_DAY);//int(24)

var_dump(Carbon::MINUTES_PER_HOUR);//int(60)

var_dump(Carbon::SECONDS_PER_MINUTE);//int(60)

還有

$dt=Carbon::createFromDate(2012,10,6);

if($dt-dayOfWeek===Carbon::SATURDAY){

echo'PlacebetsonOttawaSenatorsWinning!';

}

9.CarbonInterval

Carbon類繼承了PHP的DateInterval類。

php