CakePHP4のFrozenDateで1ヵ月前、先月、今月1日、来月末の日付などを算出する方法

2024/09/07 2024/09/27

CakePHP4のFrozenDateで1ヵ月前、今月1日、来月末などの条件を指定して日付を算出する方法

　
プログラムを作成する際に、下記のような特定の条件に基づいて日付を算出する場合があるかと思います。
・先月の 1日
・来月の月末
・1ヵ月前の日付
　
CakePHP4では「FrozenTime」「FrozenDate」という便利な関数が用意されていますので、これを使用すると簡単に算出することができますので、ご紹介します。
　
　

CakePHPで「FrozenDate」を使用して指定の日付を取得する 3つの方法

　
CakePHPの「FrozenDate」を使用して、例えば「今月の最終日」を取得する記述方法は下記の 3つあります。
　
　
まず最初に、use句で使用する処理を設定します。
（「FrozenDate」と「FrozenTime」の違いについては後述します。）
　

use Cake\I18n\FrozenDate;  // FrozenDate を使用する場合
use Cake\I18n\FrozenTime;  // FrozenTime を使用する場合

1 2	use Cake\I18n\FrozenDate; // FrozenDate を使用する場合 use Cake\I18n\FrozenTime; // FrozenTime を使用する場合

　
続けて、Controller内の Action内で下記を記述します。
　

// modify を使用する方法
$today = new FrozenDate();
$lastDay = $today->modify('last day of this month');
$firstDay = $today->modify('first day of this month');

// new FrozenDate を使用する方法
$lastDay = new FrozenDate("last day of this month");

// FrozenDate::parse を使用する方法
$lastDay = FrozenDate::parse("last day of this month");

// modify を使用する方法

$today = new FrozenDate();

$lastDay = $today->modify('last day of this month');

$firstDay = $today->modify('first day of this month');

// new FrozenDate を使用する方法

$lastDay = new FrozenDate("last day of this month");

// FrozenDate::parse を使用する方法

$lastDay = FrozenDate::parse("last day of this month");

　
いずれの場合も、結果は下記のようなオブジェクトとして取得できます。
　

Cake\I18n\FrozenDate::__set_state(array(
   'date' => '2024-08-01 00:00:00.000000',
   'timezone_type' => 3,
   'timezone' => 'Asia/Tokyo',
))

Cake\I18n\FrozenDate::__set_state(array(

'date' => '2024-08-01 00:00:00.000000',

'timezone_type' => 3,

'timezone' => 'Asia/Tokyo',

))

CakePHPで「FrozenDate」を使用して様々な条件を指定する方法

　
先のサンプルでは「last day of this month」と記述して、「今月末の日付」を取得していましたが、「last day of this month」を以下のように書き換えることで、いろいろな条件の日付を取得することができます。
　

// 今月末の日付（「last day」で月末の日付、「this month」で今月）
var_export( FrozenDate::parse("last day of this month") );

// 今月の初日（「first day」で月初の日付）
var_export( FrozenDate::parse("first day of this month") );

// 来月末の日付（「next month」で来月）
var_export( FrozenDate::parse("last day of next month") );

// 先月末の日付（「last month」で先月）
var_export( FrozenDate::parse("last day of last month") );

// 今日から 5日後（前後を「+」「-」で表記もできる）
var_export( FrozenDate::parse("+5 day") );

// 今日から 2ヶ月後（前後を「+」「-」で表記もできる）
var_export( FrozenDate::parse("+2 month") );

// 3年前の 3日後（「-3 year」「+3day」を組み合わせることもできる）
var_export( FrozenDate::parse("-3 year +3day") );

// 3年前（「ago」を付けると過去に）
var_export( FrozenDate::parse("3 year ago") );

// 3年後（「ago」を付けなければ未来に）
var_export( FrozenDate::parse("3 year") );

// 3か月後の月末日
var_export( FrozenDate::parse("last day of 3 month") );

// 5か月前の初日
var_export( FrozenDate::parse("first day of -5 month") );

// 5か月前の初日（「ago」を付けると過去に）
var_export( FrozenDate::parse("first day of 5 month ago") );

// 5か月後の初日（「ago」を付けなければ未来に）
var_export( FrozenDate::parse("first day of 5 month") );

// 「2012-02」の月末日（「2012-02」のように具体的な月の指定もできる）
var_export( FrozenDate::parse("last day of 2012-02") );

// 「2012-02-12」の月末日（「2012-02-12」のように具体的な日付の指定もできる）
var_export( FrozenDate::parse("last day of 2012-02-12") );

// 今年の 2月の月末日（「February」のように月を指定する事もできる。年を指定しない場合は今年の 2月）
var_export( FrozenDate::parse("last day of February") );

// 2020年 2月の月末日（「February」「2020年」を組み合わせることもできる）
var_export( FrozenDate::parse("last day of February 2020") );

// 今月末の日付（「last day」で月末の日付、「this month」で今月）

var_export( FrozenDate::parse("last day of this month") );

// 今月の初日（「first day」で月初の日付）

var_export( FrozenDate::parse("first day of this month") );

// 来月末の日付（「next month」で来月）

var_export( FrozenDate::parse("last day of next month") );

// 先月末の日付（「last month」で先月）

var_export( FrozenDate::parse("last day of last month") );

// 今日から 5日後（前後を「+」「-」で表記もできる）

var_export( FrozenDate::parse("+5 day") );

// 今日から 2ヶ月後（前後を「+」「-」で表記もできる）

var_export( FrozenDate::parse("+2 month") );

// 3年前の 3日後（「-3 year」「+3day」を組み合わせることもできる）

var_export( FrozenDate::parse("-3 year +3day") );

// 3年前（「ago」を付けると過去に）

var_export( FrozenDate::parse("3 year ago") );

// 3年後（「ago」を付けなければ未来に）

var_export( FrozenDate::parse("3 year") );

// 3か月後の月末日

var_export( FrozenDate::parse("last day of 3 month") );

// 5か月前の初日

var_export( FrozenDate::parse("first day of -5 month") );

// 5か月前の初日（「ago」を付けると過去に）

var_export( FrozenDate::parse("first day of 5 month ago") );

// 5か月後の初日（「ago」を付けなければ未来に）

var_export( FrozenDate::parse("first day of 5 month") );

// 「2012-02」の月末日（「2012-02」のように具体的な月の指定もできる）

var_export( FrozenDate::parse("last day of 2012-02") );

// 「2012-02-12」の月末日（「2012-02-12」のように具体的な日付の指定もできる）

var_export( FrozenDate::parse("last day of 2012-02-12") );

// 今年の 2月の月末日（「February」のように月を指定する事もできる。年を指定しない場合は今年の 2月）

var_export( FrozenDate::parse("last day of February") );

// 2020年 2月の月末日（「February」「2020年」を組み合わせることもできる）

var_export( FrozenDate::parse("last day of February 2020") );

　
上記は「FrozenDate::parse()」を使用して取得していますが、「$today->modify()」でも「new FrozenDate()」でも同じように条件を指定することができます。
　
また、上記は取得した値をそのまま画面に表示するために「var_export()」関数を使用しています。
「var_export()」関数については下記に記事を書いていますので、併せて参考にしてください。
「PHPのデバッグで使う print_r、var_dump、var_exportの動作の違い」
　
　
ちなみに、「FrozenDate」は日付を扱う処理ですが、時間まで扱う「FrozenTime」の方を使用する場合は、下記のように時間・分・秒を加減算することができます。
　

var_export( FrozenTime::parse("+5 hour +10 minute +20 second"));

1	var_export( FrozenTime::parse("+5 hour +10 minute +20 second"));

日時のオブジェクトは「i18nFormat()」を使用して表示

　
取得した日時のオブジェクトですが、文字列として表示する場合は、「i18nFormat()」を使用して表示したいフォーマットに変換します。
　

// 現在日時をオブジェクトとして生成
$today     = new FrozenDate();
$todayTime = new FrozenDate();

// フォーマットを整えて出力
echo $today->i18nFormat('yyyy-MM-dd');
echo $todayTime->i18nFormat('yyyy年MM月dd日 HH:mm:ss');

// 現在日時をオブジェクトとして生成

$today = new FrozenDate();

$todayTime = new FrozenDate();

// フォーマットを整えて出力

echo $today->i18nFormat('yyyy-MM-dd');

echo $todayTime->i18nFormat('yyyy年MM月dd日 HH:mm:ss');

　
　
ちなみに「$today」に値が入っていない場合はエラーとなりますので、「$today」に値が入っていない可能性がある場合は、下記のように値があるか否かの判定をする処理を追加しておくことをオススメします。
　

echo $today ? $today->i18nFormat('yyyy-MM-dd') : "";

1	echo $today ? $today->i18nFormat('yyyy-MM-dd') : "";

CakePHPの日付、時間を扱う処理の「FrozenDate」「FrozenTime」

　
CakePHPの日付、時間を扱う処理には「FrozenDate」「FrozenTime」とあります。
　
「FrozenDate」は、年月日を扱う関数です。
「FrozenTime」は、年月日に加え、時分秒を扱う関数です。
　
これを曖昧に使うと結構な問題が発生します。
（実際に私がそれをやってしまっていましたので．．．）
　
　
では、実際に「FrozenDate」「FrozenTime」を使用して「現在」の情報を取得してみます。
　

$date = new FrozenDate();
var_export($date);

$time = new FrozenTime();
var_export($time);

$date = new FrozenDate();

var_export($date);

$time = new FrozenTime();

var_export($time);

　
上記のように実行すると、下記の結果が得られます。
　

// FrozenDate の場合
Cake\I18n\FrozenDate::__set_state(array(
   'date' => '2024-09-01 00:00:00.000000',
   'timezone_type' => 3,
   'timezone' => 'Asia/Tokyo',
))

// FrozenTime の場合
Cake\I18n\FrozenTime::__set_state(array(
   'date' => '2024-09-01 12:12:12.345678',
   'timezone_type' => 3,
   'timezone' => 'Asia/Tokyo',
))

// FrozenDate の場合

Cake\I18n\FrozenDate::__set_state(array(

'date' => '2024-09-01 00:00:00.000000',

'timezone_type' => 3,

'timezone' => 'Asia/Tokyo',

))

// FrozenTime の場合

Cake\I18n\FrozenTime::__set_state(array(

'date' => '2024-09-01 12:12:12.345678',

'timezone_type' => 3,

'timezone' => 'Asia/Tokyo',

))

　
「FrozenDate」では「時分秒」が「0（値がない）」のに対し、「FrozenTime」ではそれらが存在します。
　
　
この「FrozenDate」と「FrozenTime」の違いをよく理解せずに、「datetime型」の「created」「modified」などの日時の項目に対して SQLの抽出条件に使用すると、想定していない結果が返ってくることがあります。
　
　
例えば、「2024-08-10」～「2024-08-15」を条件に抽出しようとする場合は「FrozenDate」を使う必要があります。
「FrozenTime」を使うと、「時分秒」を持ちますので、実行した時間によって結果が変わってくる、みたいなことが発生してしまいます。
　
お気を付けください．．．
　
　

PHPでは月末に対して実行する「+1 month」は想定の結果にならない場合がある

　
PHPでは月末日を基準として「+1 month」を実行したとき、想定した結果にならない場合があるようです。
これは、CakePHPの「FrozenDate」に不具合があるのではなく、PHPの処理自体がそういう仕様で動いているためです。
　
具体的には以下の通りです。
　

$today = new FrozenDate("2024-01-31");
var_export($today);
var_export($today->modify('+1 month'));
var_export($today->modify('+2 month'));
var_export($today->modify('+3 month'));
var_export($today->modify('+4 month'));

$today = new FrozenDate("2024-01-31");

var_export($today);

var_export($today->modify('+1 month'));

var_export($today->modify('+2 month'));

var_export($today->modify('+3 month'));

var_export($today->modify('+4 month'));

　
上記を実行すると、以下のようになります。
　

'date' => '2024-01-31 00:00:00.000000'  // today
'date' => '2024-03-02 00:00:00.000000'  // +1 month
'date' => '2024-03-31 00:00:00.000000'  // +2 month
'date' => '2024-05-01 00:00:00.000000'  // +3 month
'date' => '2024-05-31 00:00:00.000000'  // +4 month

'date' => '2024-01-31 00:00:00.000000' // today

'date' => '2024-03-02 00:00:00.000000' // +1 month

'date' => '2024-03-31 00:00:00.000000' // +2 month

'date' => '2024-05-01 00:00:00.000000' // +3 month

'date' => '2024-05-31 00:00:00.000000' // +4 month

　
　
この PHPの日付の処理については、下記に詳細な仕様の説明と、対応策を書いていますので、併せて参考にしてください。
「PHPで月末から1ヶ月後「+1 month」を算出すると想定する日付にならない場合がある」
　
　

- CakePHP 3.x 4.x CakePHP4

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです！

Message コメントをキャンセル

※入力いただいたコメントは管理者の承認後に掲載されます。

: CakePHP3のCakeDC/Users、Authでログインなしでもアクセスを許可する設定

CakePHP3の Authコンポーネントや CakeDC/Usersプラグインなどを利用したユーザ管理・認証システムにおいて、ログインしていなくても見ることができるページの設定方法を解説。

: CakePHPを学ぶ際にはオブジェクト指向を学ぼう

CakePHPはオブジェクト指向で書かれていますので、CakePHPを学ぶにはオブジェクト指向も学びましょう。

: CakePHP3のfriendsofcake/searchでツリーカテゴリーの子階層も含めて検索する方法

CakePHP3のツリービヘイビアを使ったツリーカテゴリーの子階層も含めての検索を検索プラグイン「friendsofcake/search」を使って実現する方法を解説しました。

: CakePHP 2.3でファイルをアップロード・その2　ファイル名を乱数で設定

CakePHPのアップロードするファイル名を乱数で変更しセキュリティを高める方法を解説。

: CakePHP4の規約外のカラムをキーにアソシエーション（テーブル連結）する方法

CakePHPで規定外のカラム名のキーを指定してアソシエーション（テーブル連結）をする方法を解説。アソシエーション名によってはミスが発生しやすい点もあるので注意も必要。

: CakePHP 2.3　Search Pluginで検索処理　その６ORDER、sortソートの機能

CakePHPの検索プラグイン Search Pluginの検索処理の中で order、ソートについての解説です。

: CakePHP3のOGPはHTMLヘルパーの$this->Html->meta()を使って設定

CakePHP3でOGPを設定する方法を解説。metaタグを編集するHTMLヘルパーを利用してOGPのタグを編集する。また、エレメントとして分割することでメンテナンス性も向上させる。

: CakePHP4 のコマンドプログラムからコンポーネントを読み込む方法解説

CakePHP4でコマンドプログラムからコンポーネントを呼び出す方法を解説。コントローラーから呼び出すときと大差はないが、use句でコンポーネントを指定する事がポイント。

: CakePHP4で複数の引数（パラメータ）を付与してコマンドを実行する方法

CakePHP4でコマンドを実行する際に引数（パラメータ）をコマンド内で受け取る処理について解説。複数個の引数にも対応する記述方法も解説。

: CakePHP3の検索プラグイン「friendsofcake/search」の様々な検索の仕方の実装方法

CakePHP3で検索をするプラグイン「friendsofcake/search」の検索条件のカスタマイズ方法の解説。検索項目を増やしたり、以上、以下での検索や、チェックボックスによる検索の方法などを解説。