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

Copy
1<?php
2
3/**
4 * cURLリクエストを実行し、エラーが発生した場合はその詳細情報を表示する関数。
5 *
6 * この関数は、PHPのcurl_error、curl_errno、そしてcurl_strerror関数を
7 * どのように組み合わせてcURLのエラーを効果的に処理するかを示します。
8 * システムエンジニアを目指す初心者向けに、各関数の役割を理解しやすいように
9 * 必要最低限のコメントを加えています。
10 *
11 * @param string $url リクエストを送信するURL。
12 */
13function executeCurlRequestWithErrorHandling(string $url): void
14{
15    // cURLセッションを初期化します。
16    $ch = curl_init();
17
18    // cURLオプションを設定します。
19    // ここでは指定されたURLを設定しています。
20    curl_setopt($ch, CURLOPT_URL, $url);
21    // 戻り値を文字列として取得するように設定します（通常のエラー表示に影響しませんが、一般的な設定です）。
22    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
23    // サーバー証明書の検証を無効にする（開発環境などで一時的に利用。本番環境では非推奨）。
24    // 意図的にエラーを起こしやすくするため、無効にしない方が良い場合もありますが、
25    // ここではシンプルなエラー例のためにこの設定は行いません。
26    // エラーを発生させるために存在しないホストやポートを指定するなどの工夫も可能です。
27    // 例: curl_setopt($ch, CURLOPT_PORT, 8080); // 存在しないポートを試みる
28
29    // cURLセッションを実行します。
30    // 失敗した場合は false を返します。
31    $response = curl_exec($ch);
32
33    // cURL実行後にエラーが発生したかを確認します。
34    if ($response === false) {
35        // curl_errno() を使用して、最後のエラーの数値をコードとして取得します。
36        $errorCode = curl_errno($ch);
37
38        // curl_strerror() を使用して、エラーコードに対応する人間が読める形式の文字列を取得します。
39        // リファレンス情報にあるように、引数にint $error_codeを取ります。
40        $errorString = curl_strerror($errorCode);
41
42        // curl_error() を使用して、最後のエラーの詳細な文字列メッセージを取得します。
43        $errorMessage = curl_error($ch);
44
45        echo "cURLエラーが発生しました。\n";
46        echo "エラーコード (数値): " . $errorCode . "\n";
47        echo "エラー説明 (curl_strerror): " . ($errorString ?? '不明なエラー') . "\n"; // ?string の戻り値に対応
48        echo "エラーメッセージ (curl_error): " . $errorMessage . "\n";
49    } else {
50        echo "cURLリクエストは成功しました。\n";
51        // 取得したレスポンスの最初の100文字を表示（長すぎる場合を考慮）
52        // echo "レスポンス:\n" . substr($response, 0, 100) . (strlen($response) > 100 ? "..." : "") . "\n";
53    }
54
55    // cURLセッションを閉じ、リソースを解放します。
56    curl_close($ch);
57}
58
59// -------------------------------------------------------------------
60// サンプル実行
61// -------------------------------------------------------------------
62
63// 1. 存在するURLで成功例を試す場合 (通常は成功)
64echo "--- 成功するはずのcURLリクエストの例 ---\n";
65executeCurlRequestWithErrorHandling("https://www.example.com");
66echo "\n";
67
68// 2. 存在しないURLや間違ったプロトコルなどでエラーを発生させる例
69//    これにより、curl_errno, curl_strerror, curl_error の動作が確認できます。
70echo "--- エラーが発生するcURLリクエストの例 ---\n";
71executeCurlRequestWithErrorHandling("http://nonexistent-domain-12345.xyz/"); // 存在しないドメイン
72// または、間違ったポートを指定して接続エラーを発生させる例
73// executeCurlRequestWithErrorHandling("http://localhost:9999"); // 実行中のサーバーに9999ポートが開いていなければエラー
74echo "\n";
75
76?>

このサンプルコードは、PHPでcURLリクエストを実行した際に発生するエラーを効果的に処理する方法を示しています。外部のURLにHTTPリクエストを送信し、エラーが発生した場合にその詳細情報を表示します。

まず、curl_init()でcURLセッションを初期化し、curl_setopt()でリクエスト先のURLなどの設定を行います。その後、curl_exec()関数で実際にリクエストを実行します。curl_exec()がfalseを返した場合、リクエストの実行中にエラーが発生したことを意味します。

エラー発生時には、複数の関数を使ってエラー情報を取得します。curl_errno($ch)は、発生した最後のエラーを示す数値コードを返します。curl_error($ch)は、より詳細なエラー内容を説明する文字列メッセージを返します。

今回の主題であるcurl_strerror関数は、int $error_codeを引数として受け取り、その数値エラーコードに対応する、人間が理解しやすい一般的な説明文字列を返します。戻り値は?string型であり、該当するエラーコードの説明がない場合はnullが返される可能性があります。

これらの関数を組み合わせることで、数値コード、詳細メッセージ、そして一般的な説明という多角的な情報からエラーの原因を特定し、システムエンジニアとして適切な対応を取るための手がかりを得ることができます。最後にcurl_close()でセッションを閉じ、リソースを解放します。

Copy
1<?php
2
3// CURLセッションを初期化します。
4$ch = curl_init();
5
6// 存在するURLを指定します。
7$url = "http://www.google.com";
8curl_setopt($ch, CURLOPT_URL, $url);
9
10// 接続タイムアウトを非常に短く設定し、意図的にエラーを発生させます。
11// これにより、ほとんどの場合、CURLE_OPERATION_TIMEDOUT (エラーコード: 28) が発生します。
12curl_setopt($ch, CURLOPT_CONNECTTIMEOUT_MS, 1);
13
14// 戻り値を文字列として取得する設定です。
15// エラーが発生しない場合は、取得したウェブページのコンテンツが返されます。
16curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
17
18// CURLリクエストを実行します。
19$response = curl_exec($ch);
20
21// CURL操作でエラーが発生したかを確認します。
22if (curl_errno($ch)) {
23    // エラーが発生した場合、curl_errno() でエラーコードを取得します。
24    $errorCode = curl_errno($ch);
25
26    // curl_strerror() を使用して、取得したエラーコードを人間が読める文字列に変換します。
27    $errorMessage = curl_strerror($errorCode);
28
29    // 取得したエラーコードとエラーメッセージを表示します。
30    echo "CURLエラーが発生しました。\n";
31    echo "エラーコード: " . $errorCode . "\n";
32    // エラーメッセージが null の可能性もあるため、フォールバックを用意します。
33    echo "エラーメッセージ: " . ($errorMessage ?: "不明なエラー") . "\n";
34} else {
35    // エラーがなければ、CURLリクエストが成功したことを示します。
36    // この例では通常エラーが発生するはずですが、成功した場合の分岐も示します。
37    echo "CURLリクエストが成功しました。\n";
38    // 成功した場合のレスポンスの冒頭を表示します。
39    echo "レスポンス:\n" . substr((string)$response, 0, 200) . "...\n";
40}
41
42// CURLセッションを閉じます。これにより、リソースが解放されます。
43curl_close($ch);

PHP 8のcurl_strerror関数は、CURL（Client URL Library）通信中に発生したエラーの数値コードを、人間が理解しやすいエラーメッセージの文字列に変換するために使用される関数です。

このサンプルコードでは、curl_init()でCURLセッションを開始し、curl_setopt()で接続タイムアウトを極端に短く設定することで、意図的にCURLエラーを発生させています。curl_exec()の実行後にcurl_errno($ch)を使用すると、発生したエラーの整数型のエラーコードを取得できます。

curl_strerror関数は、このcurl_errno()で取得した整数型の$error_codeを引数として受け取ります。そして、そのエラーコードに対応するエラー内容を説明する文字列を戻り値として返します。対応するエラーメッセージが見つからない場合や、エラーコードが無効な場合はnullを返します。サンプルコードでは、戻り値がnullの場合に備えて「不明なエラー」と表示する処理も組み込まれています。

このようにcurl_strerrorを利用することで、CURL操作で何らかの問題が発生した際に、数値だけでは分かりにくいエラーコードを具体的なメッセージに変換し、デバッグやエラー通知を効率的に行うことが可能になります。最後にcurl_close()でCURLセッションを閉じ、リソースを適切に解放しています。