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

Copy
1<?php
2
3/**
4 * 特定の場所と日付における日の出時刻を取得するPHPサンプルコードです。
5 *
6 * このコードは、date_sunrise() 関数を使用して、指定されたタイムスタンプ（日付）
7 * と緯度経度に基づき、日の出時刻を計算し表示します。
8 *
9 * 対象PHPバージョン: 8
10 */
11
12// 1. 基準となる日付のタイムスタンプを設定します。
13// ここでは現在の日付（今日）を使用します。
14$timestamp = time(); // 現在のタイムスタンプ
15
16// 2. 日の出時刻を計算したい場所の緯度と経度を設定します。
17// 例として、日本の東京の緯度と経度を使用します。
18$latitude = 35.6895;  // 北緯 (度)
19$longitude = 139.6917; // 東経 (度)
20
21// 3. date_sunrise() 関数を呼び出し、日の出時刻を取得します。
22//    - 第1引数: 基準となるタイムスタンプ
23//    - 第2引数: 戻り値のフォーマット。SUNFUNCS_RET_STRING は時刻を文字列で返します。
24//    - 第3引数: 緯度
25//    - 第4引数: 経度
26//    他の引数 (天頂角、UTCオフセット) はデフォルト値を使用します。
27$sunriseTime = date_sunrise(
28    $timestamp,
29    SUNFUNCS_RET_STRING, // 日の出時刻を 'HH:MM' 形式の文字列で返す
30    $latitude,
31    $longitude
32);
33
34// 4. 結果を表示します。
35//    計算が成功した場合は時刻が表示され、失敗した場合は false が返されます。
36//    失敗の例: 極地で日の出がない日、無効な引数など。
37if ($sunriseTime !== false) {
38    echo "今日 (" . date('Y-m-d', $timestamp) . ") の東京における日の出時刻: " . $sunriseTime . "\n";
39} else {
40    echo "日の出時刻の計算に失敗しました。緯度、経度、または日付を確認してください。\n";
41}
42

このPHPサンプルコードは、date_sunrise()関数を使って、特定の場所と日付における日の出時刻を計算し表示する方法を、システムエンジニアを目指す初心者向けに示しています。対象PHPバージョンは8です。

コードはまず、基準となる日付をタイムスタンプで設定します。ここでは現在の日付を使用していますが、任意の過去や未来の日付を指定することも可能です。次に、日の出時刻を計算したい場所の緯度と経度を設定します。例として、日本の東京の緯度と経度が使われています。

これらの準備ができた後、date_sunrise()関数を呼び出します。第一引数には設定したタイムスタンプ、第二引数には戻り値の形式を指定します。SUNFUNCS_RET_STRINGを指定すると、結果は「HH:MM」形式の文字列として返されます。第三引数には緯度、第四引数には経度を渡します。その他の引数は省略可能で、デフォルト値が適用されます。

関数の戻り値は、計算が成功した場合は日の出時刻を示す文字列、整数、または浮動小数点数となりますが、計算に失敗した場合はfalseが返されます。例えば、極地で日の出がない日や、無効な引数が渡された場合などです。そのため、コードでは戻り値がfalseでないかを確認し、成功した場合は日の出時刻を、失敗した場合はその旨をユーザーにわかりやすく表示しています。

Copy
1<?php
2
3/**
4 * 指定された場所と日付の日の出時刻を取得します。
5 *
6 * この関数は、PHPのdate_sunrise関数を使用して、特定の緯度と経度における日の出時刻を計算します。
7 * システムエンジニアを目指す初心者の方にも理解しやすいよう、引数と戻り値の型ヒント、
8 * そしてタイムゾーン設定の重要性を示しています。
9 *
10 * @param float $latitude  緯度（例: 東京 35.6895）
11 * @param float $longitude 経度（例: 東京 139.6917）
12 * @param int|null $timestamp 取得したい日付のUnixタイムスタンプ。nullの場合、現在の日付を使用します。
13 * @return string|false 日の出時刻 (HH:MM形式) または計算に失敗した場合は false を返します。
14 */
15function getSunriseTimeForLocation(float $latitude, float $longitude, ?int $timestamp = null): string|false
16{
17    // タイムゾーンを設定します。これは、日付/時刻関連の関数が正しく動作し、
18    // 期待するタイムゾーンでの結果を得るために非常に重要です。
19    // ここでは、日本のタイムゾーン（東京）を例として設定しています。
20    date_default_timezone_set('Asia/Tokyo');
21
22    // タイムスタンプが指定されていない場合は、現在の日付（今日）のタイムスタンプを使用します。
23    $targetTimestamp = $timestamp ?? time();
24
25    // date_sunrise関数を呼び出し、日の出時刻を計算します。
26    // 引数:
27    // 1. $timestamp: 基準となる日付のタイムスタンプ。
28    // 2. SUNFUNCS_RET_STRING: 戻り値の形式を指定します。ここでは "HH:MM" 形式の文字列を要求しています。
29    //    他にも SUNFUNCS_RET_TIMESTAMP (Unixタイムスタンプ) や SUNFUNCS_RET_DOUBLE (時間数の浮動小数点数) があります。
30    // 3. $latitude: 観測地点の緯度。
31    // 4. $longitude: 観測地点の経度。
32    // 5. $zenith (天頂角): オプション。日の出の定義に使われる天頂角。デフォルト値で十分なため省略しています。
33    // 6. $utc_offset (UTCオフセット): オプション。計算に使うUTCオフセット。デフォルト値で十分なため省略しています。
34    $sunriseTime = date_sunrise(
35        $targetTimestamp,
36        SUNFUNCS_RET_STRING,
37        $latitude,
38        $longitude
39    );
40
41    return $sunriseTime;
42}
43
44// --- サンプルコードの実行例 ---
45// getSunriseTimeForLocation関数を実際に使用して、今日の東京の日の出時刻を取得してみましょう。
46
47// 東京の緯度と経度を設定します。
48$tokyoLatitude = 35.6895;  // 北緯35度6895分
49$tokyoLongitude = 139.6917; // 東経139度6917分
50
51// 今日の東京の日の出時刻を取得します。
52$todaySunrise = getSunriseTimeForLocation($tokyoLatitude, $tokyoLongitude);
53
54// 結果をチェックし、出力します。
55if ($todaySunrise !== false) {
56    echo "今日の東京の日の出時刻: " . $todaySunrise . "\n";
57} else {
58    echo "日の出時刻の計算に失敗しました。緯度・経度が不正であるか、極地など日の出がない期間である可能性があります。\n";
59}

PHPのdate_sunrise関数は、特定の日付と場所（緯度、経度）における日の出時刻を計算するために使用されます。このサンプルコードでは、date_sunrise関数をシステムエンジニアを目指す初心者の方にも分かりやすく利用できるよう、getSunriseTimeForLocationというカスタム関数としてラップしています。

まず、日付や時刻を扱う関数が正確な結果を返すように、date_default_timezone_set関数で「Asia/Tokyo」というタイムゾーンを設定しています。これは、計算結果が特定の地域に合わせた時刻となるために非常に重要です。

getSunriseTimeForLocation関数は、日の出時刻を計算したい地点の緯度（$latitude）と経度（$longitude）を必須で受け取ります。また、計算対象の日付を示すUnixタイムスタンプ（$timestamp）も引数として指定できますが、省略された場合は現在の日付が自動的に使われます。関数内部では、これらの情報と共にdate_sunrise関数を呼び出します。この際、結果の形式としてSUNFUNCS_RET_STRINGを指定しているため、戻り値は「HH:MM」形式の文字列となります。

戻り値は、計算が成功した場合は「HH:MM」形式の日の出時刻文字列、計算に失敗した場合はfalseとなります。これは、極地など日の出がない期間や、不正な緯度・経度が指定された場合に発生する可能性があります。

サンプルコードの実行部分では、東京の緯度と経度を使ってgetSunriseTimeForLocation関数を呼び出し、今日の日の出時刻を取得しています。取得した結果がfalseでないかを確認し、成功していれば日の出時刻を表示し、失敗していれば適切なエラーメッセージを出力する処理を示しています。