CakePHP4のFrozenDateで1ヵ月前、先月、今月1日、来月末の日付などを算出する方法
2024/09/08
CakePHP4のFrozenDateで1ヵ月前、今月1日、来月末などの条件を指定して日付を算出する方法
プログラムを作成する際に、下記のような特定の条件に基づいて日付を算出する場合があるかと思います。
・先月の 1日
・来月の月末
・1ヵ月前の日付
CakePHP4では「FrozenTime」「FrozenDate」という便利な関数が用意されていますので、これを使用すると簡単に算出することができますので、ご紹介します。
PHP8.1未満では日付を扱う関数にバグがありPHP8.1以上で使用しよう
注意点:この記事の内容は、PHP8.1以降向けです。
PHPの日付を計算する処理にはバグがあり、PHP8.1未満では正しく動作しない場合があります。
具体的には「DateTime::diff」にバグがあったようです。
https://bugs.php.net/bug.php?id=79452
該当のバグは PHP8.1では修正されていますので、この記事の内容を使用する場合は、PHPのバージョンを確認してください。
なお、PHP 8.1未満のバージョンは、すでにセキュリティサポートも終了していますので、速やかにバージョンアップする方がいいかと思います。(難しい場合があることも分かりますが...)
また、古い記事を読むと、「1ヶ月後などの計算をすると、正しくない値になる」という記事が散見されます。
https://search.yahoo.co.jp/search?ei=UTF-8&fr=mozff&p=PHP+1%E3%83%B6%E6%9C%88%E5%BE%8C%E3%81%8C%E3%83%90%E3%82%B0%E3%81%A3%E3%81%A6%E3%81%84%E3%82%8B
※「PHP 1ヶ月後がバグっている」で Google検索の結果
これは、PHP8.1未満で発生していたバグですので、これらの不具合は PHP8.1以降では発生しません。
逆に、バグがある前提での処理は、PHP8.1以降では不具合につながる可能性があるかと思います。
CakePHPで「FrozenDate」を使用して指定の日付を取得する 3つの方法
CakePHPの「FrozenDate」を使用して、例えば「今月の最終日」を取得する記述方法は下記の 3つあります。
まず最初に、use句で使用する処理を設定します。
(「FrozenDate」と「FrozenTime」の違いについては後述します。)
1 2 |
use Cake\I18n\FrozenDate; // FrozenDate を使用する場合 use Cake\I18n\FrozenTime; // FrozenTime を使用する場合 |
続けて、Controller内の Action内で下記を記述します。
1 2 3 4 5 6 7 8 9 10 |
// 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"); |
いずれの場合も、結果は下記のようなオブジェクトとして取得できます。
1 2 3 4 5 |
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」を以下のように書き換えることで、いろいろな条件の日付を取得することができます。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
// 今月末の日付(「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」の方を使用する場合は、下記のように時間・分・秒を加減算することができます。
1 |
var_export( FrozenTime::parse("+5 hour +10 minute +20 second")); |
CakePHPの日付、時間を扱う処理の「FrozenDate」「FrozenTime」
CakePHPの日付、時間を扱う処理には「FrozenDate」「FrozenTime」とあります。
「FrozenDate」は、年月日を扱う関数です。
「FrozenTime」は、年月日に加え、時分秒を扱う関数です。
これを曖昧に使うと結構な問題が発生します。
(実際に私がそれをやってしまっていましたので...)
では、実際に「FrozenDate」「FrozenTime」を使用して「現在」の情報を取得してみます。
1 2 3 4 5 |
$date = new FrozenDate(); var_export($date); $time = new FrozenTime(); var_export($time); |
上記のように実行すると、下記の結果が得られます。
1 2 3 4 5 6 7 8 9 10 11 12 13 |
// 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」を使うと、「時分秒」を持ちますので、実行した時間によって結果が変わってくる、みたいなことが発生してしまいます。
お気を付けください...
CakePHP4の関連記事
CakePHP4のFrozenDateで1ヵ月前、先月、今月1日、来月末の日付などを算出する方法CakePHP4のcake cache clear_allでPermission deniedはパーミッションの変更が必要
CakePHP4のクリエビルダーを使用してOR条件をAND条件でつなぐSQL文を作る方法
CakePHP4のController内でViewテンプレート、レイアウトの変更設定を記述する方法
CakePHP4から外部のデータベースにアクセスする方法解説
CakePHP4の数値項目は「like %10%」の部分一致検索(find select)はできない
CakePHP4でロギングスコープやログレベルを使用してログを出し分ける方法を解説
CakePHP2、CakePHP3、CakePHP4、CakePHP5のバージョンを調べる 2つの方法
Windows上のXAMPP環境のCakePHPのコマンド実行時に環境変数を指定する方法
CakePHP4で複数の引数(パラメータ)を付与してコマンドを実行する方法
その他の「CakePHP4」に関する記事一覧
GoogleAdwords
GoogleAdwords
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです!
関連記事
-
CakePHP4 のコマンドプログラムからコンポーネントを読み込む方法解説
CakePHP4でコマンドプログラムからコンポーネントを呼び出す方法を解説。コントローラーから呼び出すときと大差はないが、use句でコンポーネントを指定する事がポイント。
-
CakePHP3の画像、ファイルアップロードプラグインUpload Plugin 3.0の設置解説・その1
CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその1で基本的な導入方法の解説で読みながら簡単に導入が可能。
-
CakePHP3でkeywords、DescriptionをHTMLヘルパーを使って設定する
CakePHP3のkeywordsとdescriptionを設定する方法の解説。CakePHP3にはmetaタグを編集するHTMLヘルパーが用意されているためそれを利用すればOK!ポイントはブロック化を有効にすること。
-
CakePHP4の定数定義ファイルを環境変数によって本番と開発を振り分ける方法解説
CakePHP4で開発環境と本番環境とで違う設定ファイルを読み込ませて環境ごとに定数を切り替える方法を解説。Apacheのhttpd.confに環境変数を設定しそれを読み込み判別する。
-
CakePHP3の更新画面でUpload Plugin 3.0を使う方法、viewで使う方法解説・その3
CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその3で記事を更新する際のファイルの取り回しなどについてを解説。
-
CakePHP3でパンくずの指定は HTMLヘルパーを使って指定する方法を解説
CakePHP3でパンくずの指定方法の解説。2つのヘルパーがあるが簡単なHTMLヘルパーを使った方法を、実際の状況に合わせて3つのパターン(エレメント化、ブロック化)にして解説。
-
CakePHP 2.3 bakeの超初心者向けフォロー講座
CakePHP 2.3 bakeの超初心者向けフォロー講座
-
CakePHP3でユーザ定義の定数、変数を設定し、読み込む方法解説
CakePHP3で定数や共通で使う変数をまとめて設定し、プログラム内で読み込む方法を、bootstrap.phpに直接記述する方法と定数ファイルを分ける方法の3つの方法で解説。
-
cakephp3 カスタムバリデーションを簡易的に実装する方法
CakePHP3の独自のバリデーションをテーブルクラス内に簡単に記述する方法を解説。他のテーブルクラスでは使えないが、記述する量は少なく実装できるため、他で使わない処理を書くのには便利。
-
CakePHP3でレコードを保存(追加、更新、Insert、Update)する複数の方法を紹介
CakePHP3でレコードを追加、更新(Insert、Update)する記述方法を解説。1件ずつ処理、全件をまとめて処理、条件に該当する複数件のレコードを処理方法をサンプルコードを用いて解説。