【PHP8.x】getdate()関数の使い方

Copy
1<?php
2
3/**
4 * getdate() と date() の違いを比較するための関数
5 *
6 * getdate() は日付/時刻の各要素を連想配列として返します。
7 * 一方、date() は指定されたフォーマットに従って整形された文字列を返します。
8 * このサンプルでは、両方の関数を引数なしで呼び出し、現在の時刻を基にした
9 * 返り値の構造と型の違いを示します。
10 */
11function compareGetdateAndDate(): void
12{
13    // 1. getdate(): 日付/時刻の情報を「連想配列」で取得します。
14    // 'year', 'mon', 'mday' などのキーを使って、特定の日付要素にアクセスできます。
15    echo '--- getdate() の実行結果 (戻り値: array) ---' . PHP_EOL;
16    $dateInfoArray = getdate();
17    print_r($dateInfoArray);
18    echo PHP_EOL;
19
20    // 2. date(): 日付/時刻を、指定した書式の「文字列」で取得します。
21    // 'Y-m-d H:i:s' のようなフォーマット文字で、出力形式を自由に定義できます。
22    echo '--- date() の実行結果 (戻り値: string) ---' . PHP_EOL;
23    $formattedDateString = date('Y-m-d H:i:s');
24    echo $formattedDateString . PHP_EOL;
25
26    // getdate()で取得した配列の要素を使って、date()と同様の文字列を組み立てる例
27    echo PHP_EOL . '--- getdate() の配列から文字列を組み立てる例 ---' . PHP_EOL;
28    printf(
29        '%04d-%02d-%02d %02d:%02d:%02d',
30        $dateInfoArray['year'],
31        $dateInfoArray['mon'],
32        $dateInfoArray['mday'],
33        $dateInfoArray['hours'],
34        $dateInfoArray['minutes'],
35        $dateInfoArray['seconds']
36    );
37    echo PHP_EOL;
38}
39
40// 関数を実行して、2つの関数の出力の違いを確認します。
41compareGetdateAndDate();

PHPのgetdate()関数とdate()関数は、どちらも日付や時刻を扱いますが、その目的と戻り値の形式に大きな違いがあります。

getdate()関数は、日付と時刻の各要素を個別に格納した「連想配列」を返します。引数にタイムスタンプ（1970年からの経過秒数）を指定できますが、省略した場合は現在の時刻が使用されます。返される配列には 'year'（年）、'mon'（月）、'mday'（日）といったキーが含まれており、特定の日付要素を個別に取り出して計算などに使いたい場合に便利です。

一方、date()関数は、指定した書式（フォーマット）に従って整形された一つの「文字列」を返します。例えば、'Y-m-d H:i:s' のようなフォーマット文字を使うことで、日付や時刻を希望の形式で出力できます。主にログの記録や画面表示など、整形済みの文字列がそのまま必要な場面で利用されます。

結論として、日付情報を部品の集まりとして配列で取得したい場合はgetdate()を、決まった書式の文字列として取得したい場合はdate()を使用するという明確な使い分けがあります。

Copy
1<?php
2
3/**
4 * PHPの getdate() 関数を使用して、現在および特定のタイムスタンプの日時情報を表示します。
5 *
6 * getdate() は、指定されたタイムスタンプ（または現在のローカル日時）から
7 * 年、月、日、時、分、秒などの日付と時刻の情報を連想配列として取得する組み込み関数です。
8 * システムエンジニアを目指す初心者の方が、日付時刻の情報を簡単に扱う方法を理解することを目的とします。
9 *
10 * @return void
11 */
12function demonstrateGetdateUsage(): void
13{
14    echo "--- 現在のローカル日時情報 ---\n";
15
16    // 引数を省略すると、getdate() は現在のローカル日時を返します。
17    $currentDateTime = getdate();
18
19    // 取得した連想配列から、日付と時刻の各要素にアクセスできます。
20    echo "  年: " . $currentDateTime['year'] . "\n";
21    echo "  月: " . $currentDateTime['mon'] . " (" . $currentDateTime['month'] . ")\n";
22    echo "  日: " . $currentDateTime['mday'] . "\n";
23    echo "  時: " . $currentDateTime['hours'] . "\n";
24    echo "  分: " . $currentDateTime['minutes'] . "\n";
25    echo "  秒: " . $currentDateTime['seconds'] . "\n";
26    echo "  曜日: " . $currentDateTime['weekday'] . " (" . $currentDateTime['wday'] . ")\n";
27    echo "  年間通算日: " . $currentDateTime['yday'] . "日目\n"; // その年の何日目か
28    echo "  Unixタイムスタンプ: " . $currentDateTime[0] . "\n"; // Unixタイムスタンプ (キー '0' または '0')
29    echo "\n";
30
31    echo "--- 特定のタイムスタンプの日時情報 ---\n";
32
33    // 特定の時点の日時情報を取得するには、getdate() にUnixタイムスタンプを引数として渡します。
34    // 例として、2023年1月1日 00:00:00 UTC のタイムスタンプを mktime() で生成します。
35    // mktime(時, 分, 秒, 月, 日, 年)
36    $specificTimestamp = mktime(0, 0, 0, 1, 1, 2023);
37    $specificDateTime = getdate($specificTimestamp);
38
39    echo "  対象日時: 2023年1月1日 00:00:00 (タイムゾーン設定による)\n";
40    echo "  年: " . $specificDateTime['year'] . "\n";
41    echo "  月: " . $specificDateTime['mon'] . " (" . $specificDateTime['month'] . ")\n";
42    echo "  日: " . $specificDateTime['mday'] . "\n";
43    echo "  時: " . $specificDateTime['hours'] . "\n";
44    echo "  分: " . $specificDateTime['minutes'] . "\n";
45    echo "  秒: " . $specificDateTime['seconds'] . "\n";
46    echo "  曜日: " . $specificDateTime['weekday'] . "\n";
47    echo "  Unixタイムスタンプ: " . $specificDateTime[0] . "\n";
48}
49
50// 定義した関数を実行して、getdate() の動作を確認します。
51demonstrateGetdateUsage();
52
53?>

PHPのgetdate()関数は、指定されたUnixタイムスタンプ、または現在のローカル日時から、年、月、日、時、分、秒などの詳細な日付時刻情報を連想配列として取得する際に使用します。

この関数は、オプションでUnixタイムスタンプを整数値として引数に取ります。引数を省略した場合やnullを指定した場合は、現在のローカル日時の情報が対象となります。

戻り値は、処理が成功した場合に日付時刻の各要素を含む連想配列です。この配列には、'year'、'mon'、'mday'、'hours'、'minutes'、'seconds'、'weekday'、'yday'、そして元のUnixタイムスタンプである0などのキーが含まれており、これらを使って個別の要素にアクセスできます。もし処理が失敗した場合はfalseを返します。

システム開発において、現在の日時や特定の日時の情報を取得し、表示したり、その要素を基に計算を行ったりする場面で非常に便利です。例えば、ウェブサイトでイベントの日付を表示する、ログファイルに正確なタイムスタンプを記録するなど、日付時刻を扱う基本的な操作を学ぶ上で重要な関数の一つです。

Copy
1<?php
2
3/**
4 * PHPの getdate() 関数とタイムゾーン設定の影響を示すサンプルコード。
5 *
6 * システムエンジニアを目指す初心者向けに、getdate() がPHPの現在設定されている
7 * タイムゾーンに基づいて日付と時刻の情報を返すことを示します。
8 *
9 * @return void
10 */
11function showGetdateWithTimezone(): void
12{
13    echo "--- getdate() とタイムゾーン設定の確認 ---\n\n";
14
15    // 1. PHPに設定されている現在のデフォルトタイムゾーンを取得し表示します。
16    // date_default_timezone_get() は現在PHPが使用しているタイムゾーン名を返します。
17    $originalTimezone = date_default_timezone_get();
18    echo "現在のデフォルトタイムゾーン: " . $originalTimezone . "\n";
19
20    // getdate() を引数なしで呼び出し、現在のローカル日時情報を取得します。
21    // タイムゾーン設定に基づいて時間が決定されます。
22    $dateInfoOriginal = getdate();
23    echo "現在のタイムゾーンでの日付情報:\n";
24    echo "  時刻: {$dateInfoOriginal['hours']}時{$dateInfoOriginal['minutes']}分{$dateInfoOriginal['seconds']}秒\n";
25    echo "  日付: {$dateInfoOriginal['year']}年{$dateInfoOriginal['mon']}月{$dateInfoOriginal['mday']}日\n";
26    echo "\n";
27
28    // 2. タイムゾーンを 'America/New_York' に変更し、getdate() の結果がどう変わるかを確認します。
29    // date_default_timezone_set() でPHPのタイムゾーン設定を変更します。
30    // 本番環境では、php.ini またはアプリケーション初期化時に一度設定することが推奨されます。
31    $newTimezone = 'America/New_York';
32    date_default_timezone_set($newTimezone);
33    echo "タイムゾーンを '{$newTimezone}' に変更しました。\n";
34    echo "新しいデフォルトタイムゾーン: " . date_default_timezone_get() . "\n";
35
36    // タイムゾーン変更後にもう一度 getdate() を呼び出します。
37    // 同じPHPスクリプトの実行中でも、タイムゾーン設定が変わると時刻情報も変わります。
38    $dateInfoNew = getdate();
39    echo "新しいタイムゾーンでの日付情報:\n";
40    echo "  時刻: {$dateInfoNew['hours']}時{$dateInfoNew['minutes']}分{$dateInfoNew['seconds']}秒\n";
41    echo "  日付: {$dateInfoNew['year']}年{$dateInfoNew['mon']}月{$dateInfoNew['mday']}日\n";
42    echo "\n";
43
44    echo "--- 比較と結論 ---\n";
45    echo "同じ実行時点でも、PHPのタイムゾーン設定によってgetdate()の結果が異なることがわかります。\n";
46    echo "これは、getdate()が内部的にPHPが設定している現在のタイムゾーンを使用して時刻を計算するためです。\n";
47    echo "したがって、正確な日時情報を取得するためには、PHPのタイムゾーン設定が適切であることが重要です。\n";
48
49    // サンプルの終了後、元のタイムゾーンに戻すことで他の処理への影響を避けることも可能です。
50    // date_default_timezone_set($originalTimezone);
51}
52
53// 関数を実行し、出力を行います。
54showGetdateWithTimezone();
55

PHPのgetdate関数は、指定されたUNIXタイムスタンプ（秒単位の整数）に基づいて、日付と時刻の情報を連想配列として返します。引数を省略した場合、現在のローカル時刻を使用します。処理に失敗した場合はfalseを返します。このサンプルコードは、getdate関数がPHPに設定されているタイムゾーンに強く依存して動作することを、システムエンジニアを目指す初心者の方に理解いただくためのものです。

コードではまず、PHPの現在のデフォルトタイムゾーン設定と、その設定下でgetdate関数が返す日時情報を表示します。次に、date_default_timezone_set関数を使用してPHPのタイムゾーンを一時的に変更し、再度getdate関数を呼び出して結果を比較します。これにより、同じスクリプト実行中の「今」の瞬間であっても、PHPのタイムゾーン設定が変わると、getdateが返す時分秒や日付といった情報が異なることが明確に示されます。

これは、getdate関数が内部的にPHPが設定している現在のタイムゾーンを参照し、それに基づいて日時情報を計算しているためです。アプリケーションで正確な日時情報を取得し、表示するためには、PHPのタイムゾーン設定が適切であることが非常に重要になります。この挙動を理解することは、将来のシステム開発において日時関連の問題を防ぐ上で役立ちます。

Copy
1<?php
2
3/**
4 * 現在の日時を getdate() で取得し、文字列に変換して返します。
5 *
6 * この関数は、getdate() が返す連想配列から年月日時分秒の値を取り出し、
7 * 人間が読みやすい "YYYY-MM-DD HH:MM:SS" 形式の文字列を生成します。
8 *
9 * @return string フォーマットされた日時文字列。
10 */
11function getCurrentDateAsString(): string
12{
13    // getdate() を引数なしで呼び出し、現在のタイムスタンプに基づく日時情報を連想配列で取得します。
14    $dateInfo = getdate();
15
16    // 取得した連想配列の各要素を sprintf() を使って特定のフォーマットの文字列に組み立てます。
17    // %04d: 4桁の整数で、足りない桁は0で埋める (年)
18    // %02d: 2桁の整数で、足りない桁は0で埋める (月、日、時、分、秒)
19    return sprintf(
20        '%04d-%02d-%02d %02d:%02d:%02d',
21        $dateInfo['year'],    // 年
22        $dateInfo['mon'],     // 月
23        $dateInfo['mday'],    // 日
24        $dateInfo['hours'],   // 時
25        $dateInfo['minutes'], // 分
26        $dateInfo['seconds']  // 秒
27    );
28}
29
30// 関数を実行し、生成された日時文字列を出力します。
31// PHP_EOL はOSに応じた改行コードを出力するための定義済み定数です。
32echo getCurrentDateAsString() . PHP_EOL;
33

このPHPコードは、getdate()関数を使って現在の日時情報を取得し、それを人間が読みやすい「YYYY-MM-DD HH:MM:SS」形式の文字列に変換する例です。

getdate()は、日時情報を要素ごとに分解した連想配列として取得するための関数です。引数としてUNIXタイムスタンプ（1970年1月1日からの経過秒数を表す整数）を指定できますが、省略した場合は現在のシステム時刻が使用されます。関数の戻り値は、成功時には'year'（年）、'mon'（月）、'mday'（日）などのキーを持つ連想配列となり、タイムスタンプが無効な場合はfalseを返します。

サンプルコード内のgetCurrentDateAsString関数では、まず引数なしでgetdate()を呼び出し、現在の時刻情報を連想配列$dateInfoに格納します。次にsprintf()関数を使い、この連想配列から年・月・日・時・分・秒の値を順番に取り出して、指定された書式の文字列を組み立てています。例えば%04dは4桁の整数、%02dは2桁の整数として表示し、桁数が足りない場合は先頭を0で埋めるという指定です。

最後に、作成した関数を呼び出し、その戻り値である整形された日時文字列を、改行コード(PHP_EOL)と共に画面に出力しています。