【PHP8.x】SplObjectStorage::getInfo()メソッドの使い方

Copy
1<?php
2
3/**
4 * SplObjectStorage を利用して、複数の cURL リクエストの結果を管理するサンプルコードです。
5 * 特に、cURL 実行時の http_code が 0 となるような接続エラーの情報を格納し、
6 * SplObjectStorage::getInfo() メソッドでその情報を取得する方法を示します。
7 *
8 * SplObjectStorage は、オブジェクト自体をキーとしてデータを紐付けることができる特殊なコレクションです。
9 * ここでは、各リクエストを表すオブジェクトに、そのリクエストの cURL 実行結果を紐付けます。
10 */
11function manageCurlRequestOutcomes(): void
12{
13    // SplObjectStorage のインスタンスを作成します。
14    // これにより、異なるオブジェクトに対してそれぞれ異なる情報を関連付けて保存できます。
15    $requestOutcomes = new SplObjectStorage();
16
17    // --- 1. cURL リクエストの失敗 (http_code: 0) をシミュレート ---
18    // このオブジェクトが、失敗した特定のリクエストを表します。
19    // どんなオブジェクトでも SplObjectStorage のキーとして使えます。
20    $failedRequest = new stdClass();
21    $failedRequest->id = 'REQ_001_FAILED';
22    $failedRequest->targetUrl = 'http://nonexistent.domain.test/path';
23
24    // curl_getinfo() が返すような情報をシミュレートします。
25    // http_code が 0 は、通常、ホスト解決失敗や接続確立失敗などのエラーを示します。
26    $failedCurlInfo = [
27        'url' => $failedRequest->targetUrl,
28        'http_code' => 0, // キーワードに合致する「接続エラー」の状態
29        'total_time' => 0.000,
30        'error_message' => 'Failed to connect to nonexistent.domain.test',
31        'error_code' => 6, // CURLE_COULDNT_RESOLVE_HOST のようなエラーコードを想定
32    ];
33
34    // failedRequest オブジェクトに、失敗時の cURL 情報を紐付けて SplObjectStorage に追加します。
35    $requestOutcomes->attach($failedRequest, $failedCurlInfo);
36    echo "リクエストID: {$failedRequest->id} (失敗) を登録しました。\n";
37
38    // --- 2. cURL リクエストの成功 (http_code: 200) をシミュレート ---
39    // こちらは成功した特定のリクエストを表すオブジェクトです。
40    $successfulRequest = new stdClass();
41    $successfulRequest->id = 'REQ_002_SUCCESS';
42    $successfulRequest->targetUrl = 'http://example.com';
43
44    // 成功時の curl_getinfo() 結果をシミュレートします。
45    $successfulCurlInfo = [
46        'url' => $successfulRequest->targetUrl,
47        'http_code' => 200, // 成功の状態
48        'total_time' => 0.150,
49        'error_message' => null,
50        'error_code' => 0,
51    ];
52
53    // successfulRequest オブジェクトに、成功時の cURL 情報を紐付けて SplObjectStorage に追加します。
54    $requestOutcomes->attach($successfulRequest, $successfulCurlInfo);
55    echo "リクエストID: {$successfulRequest->id} (成功) を登録しました。\n\n";
56
57    // --- SplObjectStorage::getInfo() を使って特定のオブジェクトの情報を取得 ---
58    echo "--- 登録されたリクエストの情報を取得します ---\n";
59
60    // 失敗したリクエストオブジェクトに関連付けられた情報を取得します。
61    // getInfo() メソッドは、attach() の際に第2引数で渡したデータ（ここでは $failedCurlInfo）を返します。
62    $retrievedFailedInfo = $requestOutcomes->getInfo($failedRequest);
63    echo "[{$failedRequest->id}] の結果:\n";
64    echo "  ターゲットURL: {$retrievedFailedInfo['url']}\n";
65    echo "  HTTPステータスコード: {$retrievedFailedInfo['http_code']}";
66    if ($retrievedFailedInfo['http_code'] === 0) {
67        echo " (★接続エラーまたは応答なし★)"; // http_code 0 の条件を強調
68    }
69    echo "\n";
70    echo "  エラーメッセージ: " . ($retrievedFailedInfo['error_message'] ?? 'なし') . "\n";
71    echo "  エラーコード: {$retrievedFailedInfo['error_code']}\n\n";
72
73    // 成功したリクエストオブジェクトに関連付けられた情報を取得します。
74    $retrievedSuccessfulInfo = $requestOutcomes->getInfo($successfulRequest);
75    echo "[{$successfulRequest->id}] の結果:\n";
76    echo "  ターゲットURL: {$retrievedSuccessfulInfo['url']}\n";
77    echo "  HTTPステータスコード: {$retrievedSuccessfulInfo['http_code']}\n";
78    echo "  エラーメッセージ: " . ($retrievedSuccessfulInfo['error_message'] ?? 'なし') . "\n";
79    echo "  エラーコード: {$retrievedSuccessfulInfo['error_code']}\n\n";
80
81    // SplObjectStorage は Iterator インターフェースを実装しているため、
82    // foreach ループで保存されたすべてのオブジェクトとその情報を取得することもできます。
83    echo "--- 全てのリクエスト結果の概要 ---\n";
84    foreach ($requestOutcomes as $object) {
85        $info = $requestOutcomes->getInfo($object); // 各オブジェクトに紐付いた情報を取得
86        echo "  リクエストID: {$object->id}, URL: {$info['url']}, HTTP Code: {$info['http_code']}\n";
87    }
88}
89
90// サンプル関数を実行します。
91manageCurlRequestOutcomes();

PHP 8のSplObjectStorage::getInfoメソッドは、SplObjectStorageクラスに格納された特定のオブジェクトに紐付けられた情報を取得するために利用されます。SplObjectStorageは、通常の配列のようにキーと値でデータを保存するのではなく、オブジェクト自体をユニークなキーとして、それに関連する任意のデータ（情報）を紐付けて管理できる特別なコレクションです。

getInfoメソッドは、情報を取得したい対象のオブジェクトを引数 $object として受け取ります。そして、attach()メソッドでその $object に関連付けて保存したデータが、戻り値 mixed としてそのまま返されます。

サンプルコードでは、複数のcURLリクエストの実行結果を効率的に管理する具体例を示しています。ここでは、各リクエストを表すオブジェクトに対して、curl_getinfoで得られる詳細な実行結果を紐付けています。特に、ウェブサイトへの接続に失敗し、http_codeが0（ホスト解決失敗や接続エラーなどを示す）となるような状況の情報も格納しており、getInfoメソッドを使うことで、対象のオブジェクトからその具体的なエラー情報を正確に取得できることを確認できます。これにより、個々のリクエストの状態をオブジェクトと情報として一元的に管理し、必要に応じて簡単に取り出すことが可能になります。