PHPの日付時刻ライブラリCarbonの和暦表示がWindowsでうまくいかない件

Larvelでもよく使う「日付・時刻ライブラリ」CarbonをWindows環境で試しにさわってみた時に、和暦表示とかがうまくいかなかったりしたので、そのへんをメモがわりに書いておきます。

f:id:arakan_no_boku:20190922143447p:plain

はじめに

CarbonはLaravelに同梱されています。

でも、Laravel専用ではなく、普通に素のPHPと組み合わせても使えます。

日付・時刻処理をPHPで扱うケースについて「PHP The Right Way」にも、こんな風に書かれている位、スタンダードになってます。

CarbonならDateTimeの全てを継承したうえで、地域化のサポートやDateTimeオブジェクトの加減算やフォーマット方法が追加されている

実際、非常に便利です。

自分も日付・時刻処理は、１つを除いて、ほぼCarbonでやってます。

その１つ・・とは、和暦表示などのロケール情報を使った一部フォーマットです。

ネットで情報を見てると、結構、和暦表示にCarbonの機能を使った例も紹介されていますし、実際うまくいくケースもあるのですが、少なくとも「Windows」ではうまくいかなくて・・結構、最初ははまります。

なので、今回は備忘もかねて、Carbonの機能等についてのおおまかな整理と「うまくいかない使い方」の話題を書いておきます。

CarbonをLaravel以外で使うならインストールが必要です

CarbonはLaravelをインストールしたら、いっしょにはいります。

Laravelを使わないなら、もプロジェクトにインストールする必要があります。

その場合は、プロジェクトフォルダをカレントにして、composerでインストールします。

composer require nesbot/carbon

カレントフォルダのvenderの下にインストールされます。

Carbonに関する情報について

Carbonは多機能です。

でも、インタフェースがすっきりしているので、以下のようなページで、サンプルを見れば、なんとなくでも使えてしまう敷居の低さがあります。

まずは本家の方

carbon.nesbot.com

英語なので、自動翻訳してみれば良いと思います。

日本語だと、こちらですかね

blog.capilano-fw.com

実例　217件！

お疲れ様って感じです。

DateTimeのサンプルをCarbonで書き直す

Carbonを使うには、オートローダーで読み込んで、「use Carbon\Carbon」します。

CarbonはDateTimeを全継承しています。

https://secure.php.net/book.datetime

なので、DateTimeと非常に親和性が高いです。

例として、「PHP The Right Way」のDateTimeのサンプルプログラムをCarbonで書き直してみます。

さて。

ソースはこんな感じ。

src\CarbonSample.php

<?php
require __DIR__ . "/../vendor/autoload.php";

use Carbon\Carbon;

// 開始日付オブジェクトの生成
$raw = '22. 11. 1968';
$start = Carbon::createFromFormat('d. m. Y', $raw);
echo '開始日: ' . $start->format('Y年m月d日') . "\n";

echo "--------------------------------------------\n";

// 開始日付をコピーして、1か月と6日を足して、終了日にする
$end = clone $start;
$end->add(new DateInterval('P1M6D'));

// 開始日と終了日の差を計算して何カ月・何日差があるかを表示する
$diff = $end->diff($start);
echo '開始日と終了日の差: ' . $diff->format('%m ケ月, %d 日 (合計: %a 日の差がある)') . "\n";

echo "--------------------------------------------\n";

// 日付同士を比較もできる
if ($start < $end) {
    echo "開始日は終了日よりも前の日付です。!\n";
}

echo "--------------------------------------------\n";

// 期間オブジェクトを作って、期間中の木曜日の日付をリストする
$periodInterval = DateInterval::createFromDateString('first thursday');
$periodIterator = new DatePeriod($start, $periodInterval, $end, DatePeriod::EXCLUDE_START_DATE);
echo "開始日と終了日の間の期間にある木曜日をリストします。\n";
foreach ($periodIterator as $date) {
    // 毎木曜日を表示する
    echo $date->format('Y年m月d日') . "\n";
    
}

日本語表記にするなどの表面的なところ以外で、元のDateTimeのサンプルから変更した部分は一か所だけです。

元が