Carbon を拡張して祝日と干支を表示できるようにした

PHP で日付操作が簡単にできる Carbon を拡張して、祝日と干支（十二支）に対応した JpCarbon を公開しました。

インストール

他のパッケージと同様、composer 経由でインストールします。

$ composer require enomotodev/jp-carbon

使い方

祝日を取得する

Carbon と同じようにインスタンスを作成して、holiday プロパティにアクセスすると、祝日を取得できます。

なお、振替休日にも対応しています。

<?php

require 'vendor/autoload.php';

use JpCarbon\JpCarbon;

$instance = JpCarbon::createFromDate(2017, 1, 1)->holiday;
var_dump($instance);
// => string(6) "元日"

$instance = JpCarbon::createFromDate(2017, 1, 2)->holiday;
var_dump($instance);
// => string(12) "振替休日"

$instance = JpCarbon::createFromDate(2017, 1, 3)->holiday;
var_dump($instance);
// => string(0) ""

このように祝日の場合は名称が取得でき、祝日ではない場合は空文字が返却されます。

干支（十二支）を取得する

こちらもインスタンスを作成し、eto プロパティにアクセスすると干支（十二支）が取得できます。

<?php

require 'vendor/autoload.php';

use JpCarbon\JpCarbon;

$eto = JpCarbon::createFromDate(2017)->eto;
var_dump($eto);
// => string(3) "酉"

まとめ

PHP でカレンダーを作る機会があり、Carbon インスタンスのプロパティで祝日と干支を取得できたら良いなぁと思って作ってみました。

日付に関する日本独自のものとしては他に六曜や星座などもあるので、今後こちらにも対応していきたいと思います！

初めてのPHP

暦の科学 (BERET SCIENCE)