PHP中的國際化日曆類 https://www.php.net/manual/zh/class.intlcalendar.php

在 PHP 的國際化組件中,還有一個我們並不是很常用的日期操作類,它就是日曆操作類。說是日曆,其實大部分還是對日期時間的操作,一般也是主要用於日期的格式化和比較之類的。但是通常我們直接使用 date 相關的函數或者 DateTime 相關的類操作日期相關的功能,反而比這套功能更方便靈活。當然,本着學習的目的,我們還是來簡單地瞭解一下。

格式化時間

首先還是從格式化時間說起。

$cal = IntlCalendar::createInstance(IntlTimeZone::getGMT());
var_dump(get_class($cal), IntlDateFormatter::formatObject($cal, IntlDateFormatter::FULL));
// string(21) "IntlGregorianCalendar"
// string(66) "2020年11月18日星期三 格林尼治標準時間 上午12:58:14"

$cal1 = IntlCalendar::fromDateTime('2013-02-28 00:01:02 Europe/Berlin');
var_dump(get_class($cal1), IntlDateFormatter::formatObject($cal1, 'yyyy MMMM d HH:mm:ss VVVV', 'de_DE'));
// string(21) "IntlGregorianCalendar"
// string(41) "2013 Februar 28 00:01:02 Deutschland Zeit"

IntlCalendar 類的 createInstance() 方法會返回一個 IntlCalendar 對象,它的參數是可選的,不過必須是 TimeZone 類型的參數。fromDateTime() 方法同樣也是生成一個 IntlCalendar 對象,不過它可以設置一個 DateTime 對象或者日期類型的字符串爲參數。

可以看到,我們返回的對象使用 get_class() 方法後看到實際返回的是一個 IntlGregorianCalendar 格林格里日曆對象。這時,就可以使用 IntlDateFormatter 類的 formatObject() 方法來格式化輸出內容,它是可以指定地區的,不同的地區設置就會顯示不同的格式化語言結果。

返回時間戳

echo IntlCalendar::getNow(), PHP_EOL; // 1605661094417

不多做解釋了,不過這個靜態方法返的是帶毫秒數的時間戳。

時區相關設置

只要是國際化相關的功能,都多少和時區 TimeZone 有關,日曆類也不例外。

ini_set('intl.default_locale', 'de_DE');
ini_set('date.timezone', 'Europe/Berlin');
$cal = IntlCalendar::createInstance();
print_r($cal->getTimeZone());
// IntlTimeZone Object
// (
//     [valid] => 1
//     [id] => Europe/Berlin
//     [rawOffset] => 3600000
//     [currentOffset] => 3600000
// )

echo $cal->getLocale(Locale::ACTUAL_LOCALE), PHP_EOL; // de
echo $cal->getLocale(Locale::VALID_LOCALE), PHP_EOL; // de_DE

使用 getTimeZone() 就可以獲得當前的時區信息,getLocale() 和之前我們文章中其它相關功能類的 getLocale() 方法沒有什麼區別,大家可以看下之前講過的內容。當然,這個 TimeZone 屬性除了通過 ini_set() 之外,也是可以直接通過對象的 setTimeZone() 方法進行修改的。

ini_set('intl.default_locale', 'zh_CN');
ini_set('date.timezone', 'Asia/Shanghai');
$cal = IntlCalendar::createInstance();
print_r($cal->getTimeZone());
// IntlTimeZone Object
// (
//     [valid] => 1
//     [id] => Asia/Shanghai
//     [rawOffset] => 28800000
//     [currentOffset] => 28800000
// )

$cal->setTimeZone('UTC');
print_r($cal->getTimeZone());
// IntlTimeZone Object
// (
//     [valid] => 1
//     [id] => UTC
//     [rawOffset] => 0
//     [currentOffset] => 0
// )

echo $cal->getLocale(Locale::ACTUAL_LOCALE), PHP_EOL; // zh
echo $cal->getLocale(Locale::VALID_LOCALE), PHP_EOL; // zh_Hans_CN

日曆相關操作

時間字段最大、最小值相關信息

這是什麼意思呢?先看下代碼。

$cal = IntlCalendar::fromDateTime('2020-02-15');
var_dump($cal->getActualMaximum(IntlCalendar::FIELD_DAY_OF_MONTH)); //29
var_dump($cal->getMaximum(IntlCalendar::FIELD_DAY_OF_MONTH)); //31
var_dump($cal->getActualMinimum(IntlCalendar::FIELD_DAY_OF_MONTH)); //1
var_dump($cal->getMinimum(IntlCalendar::FIELD_DAY_OF_MONTH)); //1
var_dump($cal->getLeastMaximum(IntlCalendar::FIELD_DAY_OF_MONTH));// 28 

$cal->add(IntlCalendar::FIELD_EXTENDED_YEAR, -1);
var_dump($cal->getActualMaximum(IntlCalendar::FIELD_DAY_OF_MONTH)); //28
var_dump($cal->getMaximum(IntlCalendar::FIELD_DAY_OF_MONTH)); //31
var_dump($cal->getActualMinimum(IntlCalendar::FIELD_DAY_OF_MONTH)); //1
var_dump($cal->getMinimum(IntlCalendar::FIELD_DAY_OF_MONTH)); //1
var_dump($cal->getLeastMaximum(IntlCalendar::FIELD_DAY_OF_MONTH));// 28

樓上這一堆是什麼鬼?其實這幾個方法就是返回的指定參數字段內容的最大、最小值,比如我們查看的是 FIELD_DAY_OF_MONTH ,也就是月份有多少天。getActualMaximum() 返回的是實際值,比如 2020 年的 2 月份是有 29 天的 。getMaximum() 返回的是正常月份的最大值,都是 31 。getActualMinimum() 、getMinimum() 返回的是實際最小值和正常最小值,這個對於月份來說都是 1 ,每個月都肯定會有 1 天。getLeastMaximum() 方法是獲取字段的最小局部最大值,怎麼理解呢?2月份最小天數是28天,它的局部最大值也就是28天,其它月份則分 30 和 31 天。

一週的起始日期

這個功能主要是可以設置一週的起始日期是周幾。比如對於歐美的國際標準時間來說,週一並不是一週的開始,週日纔是這一週的第一天。大家從各種日曆應用中就能發現這個問題。

$cal = IntlCalendar::createInstance();
$cal->set(2020, 5, 30);
var_dump($cal->getFirstDayOfWeek()); // 1
echo IntlDateFormatter::formatObject($cal, <<<EOD
'local day of week: 'cc'
week of month    : 'W'
week of year     : 'ww
EOD
), PHP_EOL;
// local day of week: 3
// week of month    : 5
// week of year     : 27

在當前的時區中,我們 getFirstDayOfWeek() 返回的結果是 1 ,也就是週一爲一週的起點,周幾是從 0 開始計算的。set() 方法可以設置具體的日期,需要注意月份也是從 0 開始的。我們再使用 IntlDateFormatter::formatObject() 輸出當前日期在周幾、在月中的第幾周以及當前周是今年的第幾周。在這裏我們設置的是 2020年的 6 月 30 號,'cc' 表示的當前日期在週中是週四,是一週中的第四天(不是指定的6月30號,是我們運行代碼時的時間,方便我們修改後查看),當前周是在當前月是第五週,當前周在整年裏的是第 27 周。如果我們改變這個每週開始的時間呢?

$cal->setFirstDayOfWeek(3);
var_dump($cal->getFirstDayOfWeek());  // int(5)
echo IntlDateFormatter::formatObject($cal, <<<EOD
'local day of week: 'cc'
week of month    : 'W'
week of year     : 'ww
EOD
), PHP_EOL;
// local day of week: 1
// week of month    : 6
// week of year     : 27

嗯,'cc' 變爲 1 了,當前成爲了週一。現在是在當前月份的第 6 周了,因爲我們現在一週的開始是從週四開始算的啦。

日曆比較

日曆對象比較

$cal1 = IntlCalendar::createInstance();
$cal2 = IntlCalendar::createInstance();
var_dump($cal1->equals($cal2)); // bool(true)
$cal2->setTime($cal1->getTime() + 1);
var_dump($cal1->equals($cal2)); // bool(false)

這個比較簡單,日曆對象內部的屬性不同,當然 equals() 方法返回的結果就是 false 了。

日曆對象差值

除了比較日曆對象外,還可以獲取兩個日曆時間之前的差值信息。

$cal1 = IntlCalendar::fromDateTime('2019-1-29 09:00:11');
$cal2 = IntlCalendar::fromDateTime('2020-03-01 09:19:29');
$time = $cal2->getTime();

echo "之前的時間: ", IntlDateFormatter::formatObject($cal1), "\n";
// 之前的時間: 2019年1月29日 上午9:00:11

printf(
    "兩個時間的差別: %d year(s), %d month(s), "
  . "%d day(s), %d hour(s) and %d minute(s)\n",
    $cal1->fieldDifference($time, IntlCalendar::FIELD_YEAR),
    $cal1->fieldDifference($time, IntlCalendar::FIELD_MONTH),
    $cal1->fieldDifference($time, IntlCalendar::FIELD_DAY_OF_MONTH),
    $cal1->fieldDifference($time, IntlCalendar::FIELD_HOUR_OF_DAY),
    $cal1->fieldDifference($time, IntlCalendar::FIELD_MINUTE)
);
// 兩個時間的差別: 1 year(s), 1 month(s), 1 day(s), 0 hour(s) and 19 minute(s)


echo "之後的時間: ", IntlDateFormatter::formatObject($cal1), "\n";
// 之後的時間: 2020年3月1日 上午9:19:11

可以看到使用 fieldDifference() 方法就可以獲得日曆對象和比較日期之間相關的信息。需要注意的是,使用 fieldDifference() 之後,原來的日曆對象全變成新的日期信息。

其它信息

查看區域設置關鍵字值集

print_r(iterator_to_array(IntlCalendar::getKeywordValuesForLocale('calendar', 'zh_CN', true)));
// Array
// (
//     [0] => gregorian
//     [1] => chinese
// )
print_r(iterator_to_array(IntlCalendar::getKeywordValuesForLocale('calendar', 'zh_CN', false)));
// Array
// (
//     [0] => gregorian
//     [1] => chinese
//     [2] => japanese
//     [3] => buddhist
//     [4] => roc
//     [5] => persian
//     [6] => islamic-civil
//     [7] => islamic
//     [8] => hebrew
//     [9] => indian
//     [10] => coptic
//     [11] => ethiopic
//     [12] => ethiopic-amete-alem
//     [13] => iso8601
//     [14] => dangi
//     [15] => islamic-umalqura
//     [16] => islamic-tbla
//     [17] => islamic-rgsa
// )

getKeywordValuesForLocale() 方法的第一個參數只能固定寫 calendar ,後面是填寫相關的區域,返回的內容就是當前語言環境下所支持的相關字值信息。

區域語言類型

$cal = IntlCalendar::createInstance(NULL, '@calendar=ethiopic-amete-alem');
var_dump($cal->getType());
// string(19) "ethiopic-amete-alem"

$cal = new IntlGregorianCalendar();
var_dump($cal->getType());
// string(9) "gregorian"

很明顯,getType() 方法返回的就是指定語言區域信息的類型。

滾動日曆

var_dump(IntlDateFormatter::formatObject($cal)); // string(31) "2020年11月18日 上午9:14:59"
$cal->roll(IntlCalendar::FIELD_DAY_OF_MONTH, true);
var_dump(IntlDateFormatter::formatObject($cal)); // string(31) "2020年11月19日 上午9:14:59"

使用 roll() 方法可以滾動或者說是捲動日曆,在這裏我們將日曆滾動一天,也就是加了一天的時間。

轉換爲 DateTime 對象

var_dump($cal->toDateTime());
// object(DateTime)#4 (3) {
//     ["date"]=>
//     string(26) "2020-11-19 09:14:59.000000"
//     ["timezone_type"]=>
//     int(3)
//     ["timezone"]=>
//     string(13) "Asia/Shanghai"
//   }

使用 toDateTime() 方法就可以將當前的 IntlCalendar 對象轉換成 DateTime 對象。

當前系統中支持的所有區域信息

print_r(IntlCalendar::getAvailableLocales());
// Array
// (
//     [0] => af
//     [1] => af_NA
//     [2] => af_ZA
//     [3] => agq
//     [4] => agq_CM
//     [5] => ak
//     [6] => ak_GH
//     [7] => am
//     [8] => am_ET
//     [9] => ar
//     ……
//     ……

getAvailableLocales() 返回的是當前系統中所有支持可用的 Locale 信息。

總結

關於日曆類其實還有很多方法函數,但是看得人非常頭暈,英文解釋不多,資料也不清晰,所以這裏就是簡單的列舉了一些內容。大家還是報以學習的心態瞭解即可,當需要使用到的時候可以快速地想起還這些功能就可以了。

測試代碼:

參考文檔:

https://www.php.net/manual/zh/class.intlcalendar.php

各自媒體平臺均可搜索【硬核項目經理】

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章