【PHP8.x】createFromFormatメソッドの使い方

Copy
1<?php
2
3// 日付文字列とフォーマットを指定して DateTime オブジェクトを作成する
4$format = 'Y-m-d H:i:s';
5$dateString = '2024-01-01 10:00:00';
6
7// DateTimeZone を指定しない場合
8$dateTime = DateTime::createFromFormat($format, $dateString);
9
10if ($dateTime) {
11    echo "DateTime: " . $dateTime->format('Y-m-d H:i:s') . "\n";
12} else {
13    echo "日付の作成に失敗しました。\n";
14}
15
16// DateTimeZone を指定する場合
17$timezone = new DateTimeZone('Asia/Tokyo');
18$dateTimeWithTimezone = DateTime::createFromFormat($format, $dateString, $timezone);
19
20if ($dateTimeWithTimezone) {
21    echo "DateTime (Timezone: Asia/Tokyo): " . $dateTimeWithTimezone->format('Y-m-d H:i:s') . "\n";
22} else {
23    echo "日付の作成に失敗しました。\n";
24}

PHPのDateTimeクラスのcreateFromFormatメソッドは、指定されたフォーマットに基づいて日付文字列からDateTimeオブジェクトを作成します。このメソッドは、日付文字列を解析し、DateTimeオブジェクトに変換する際に非常に便利です。

第一引数$formatには、日付文字列のフォーマットを指定します。例えば、'Y-m-d H:i:s'は、年-月-日 時:分:秒 の形式を表します。第二引数$datetimeには、実際に解析したい日付文字列を渡します。

第三引数$timezoneはオプションで、DateTimeZoneオブジェクトを指定することで、タイムゾーンを設定できます。省略した場合、システムデフォルトのタイムゾーンが使用されます。

サンプルコードでは、まずDateTimeZoneを指定せずにcreateFromFormatを使用しています。次に、Asia/Tokyoタイムゾーンを指定して同様にDateTimeオブジェクトを作成しています。

createFromFormatメソッドは、DateTimeオブジェクトの作成に成功した場合、DateTimeオブジェクトを返します。失敗した場合はfalseを返します。そのため、作成後にif文でfalseが返ってきていないか確認することで、日付文字列が正しく解析されたかどうかを確認できます。

作成されたDateTimeオブジェクトは、formatメソッドを使用して、任意のフォーマットで日付と時刻を表示できます。サンプルコードでは、'Y-m-d H:i:s'フォーマットで表示しています。