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

Copy
1<?php
2
3/**
4 * SplObjectStorage::setInfo の使用例を示す関数。
5 *
6 * この関数は、SplObjectStorage を使ってオブジェクトに付加情報を設定し、
7 * その情報を取得する方法をシステムエンジニアを目指す初心者向けに示します。
8 * キーワード "php getinfo" に基づき、setInfo と getInfo の両方を使用します。
9 */
10function demonstrateSplObjectStorageInfoHandling(): void
11{
12    // 1. SplObjectStorage のインスタンスを作成します。
13    //    これは、オブジェクトを格納し、それらに付加情報を紐付けるための特殊なコレクションです。
14    $storage = new SplObjectStorage();
15
16    // 2. いくつかのオブジェクトを作成します。
17    //    ここでは、シンプルな stdClass のインスタンスを使います。
18    $objectA = new stdClass();
19    $objectB = new stdClass();
20    $objectC = new stdClass();
21
22    // 3. オブジェクトを SplObjectStorage に追加（アタッチ）します。
23    //    attach() メソッドを使って、オブジェクトをストレージに登録します。
24    $storage->attach($objectA);
25    $storage->attach($objectB);
26    $storage->attach($objectC);
27
28    // 4. setInfo() メソッドを使って、各オブジェクトに付加情報を設定します。
29    //    setInfo(オブジェクト, 情報) の形式で、任意の情報をオブジェクトに関連付けられます。
30    //    情報は、文字列、数値、配列、オブジェクトなど、どんな型でも設定できます。
31    $storage->setInfo($objectA, ['name' => 'ユーザーA', 'role' => '管理者']);
32    $storage->setInfo($objectB, 'これはユーザーBに関する簡単なメモです。');
33    $storage->setInfo($objectC, ['status' => '有効', '登録日時' => (new DateTime())->format('Y-m-d H:i:s')]);
34
35    echo "--- SplObjectStorage に格納されたオブジェクトと付加情報 ---" . PHP_EOL;
36
37    // 5. ストレージをループして、各オブジェクトとその付加情報を取得（getInfo）します。
38    //    SplObjectStorage は foreach ループで直接イテレートできます。
39    //    ループ内で getInfo() を引数なしで呼び出すと、現在イテレート中のオブジェクトの情報を取得できます。
40    foreach ($storage as $object) {
41        // オブジェクトを一意に識別するためのハッシュ値を取得します。
42        // これはデバッグや識別に役立ちます。
43        $objectId = spl_object_hash($object);
44
45        // 現在イテレート中のオブジェクトに関連付けられた情報を取得します。
46        $info = $storage->getInfo();
47
48        echo "オブジェクトID: " . $objectId . PHP_EOL;
49        echo "付加情報: ";
50        if (is_array($info)) {
51            // 情報が配列の場合は、print_rで見やすく表示します。
52            print_r($info);
53        } else {
54            // それ以外の場合は、そのまま表示します。
55            echo $info . PHP_EOL;
56        }
57        echo PHP_EOL;
58    }
59
60    echo "--- 特定のオブジェクトの情報を直接取得する例 ---" . PHP_EOL;
61
62    // 6. getInfo() メソッドに直接オブジェクトを渡して、特定のオブジェクトの情報を取得することもできます。
63    echo "ユーザーAの付加情報: ";
64    print_r($storage->getInfo($objectA));
65    echo PHP_EOL;
66
67    echo "ユーザーBの付加情報: ";
68    echo $storage->getInfo($objectB) . PHP_EOL;
69    echo PHP_EOL;
70
71    // SplObjectStorage に存在しないオブジェクトの情報を取得しようとすると null が返されます。
72    $nonExistentObject = new stdClass();
73    echo "存在しないオブジェクトの付加情報: " . var_export($storage->getInfo($nonExistentObject), true) . PHP_EOL;
74}
75
76// 上記の関数を実行します。
77demonstrateSplObjectStorageInfoHandling();

PHPのSplObjectStorageは、オブジェクトそのものをキーとして利用し、それに関連する情報を格納できる特殊なコレクションです。SplObjectStorage::setInfoメソッドは、このSplObjectStorageに登録されたオブジェクトに対し、任意の付加情報を設定するために使用されます。

このメソッドは二つの引数を取ります。第一引数object $objectには、情報を関連付けたい対象のオブジェクトを指定します。第二引数mixed $infoには、文字列、配列、数値、他のオブジェクトなど、どのような型でも可能な関連付ける情報を渡します。setInfoメソッド自体は戻り値を持ちません。

設定された情報は、SplObjectStorage::getInfoメソッドを使って取得できます。getInfoを引数なしで呼び出した場合、SplObjectStorageをforeachループで処理している際に、現在イテレート中のオブジェクトに設定された情報を返します。また、引数にobject $objectを渡すことで、特定のオブジェクトに紐付けられた情報を直接取得することも可能です。もしSplObjectStorageに存在しないオブジェクトの情報を取得しようとすると、getInfoはnullを返します。

サンプルコードでは、複数のstdClassオブジェクトを作成し、それらをSplObjectStorageに登録した後、setInfoを使って各オブジェクトに異なる型の付加情報を設定しています。その後、ループ処理とgetInfoを組み合わせることで、設定した情報が正確に取得・表示される様子を示しており、オブジェクトとデータを柔軟に紐付けたい場面で役立つことを理解できます。

Copy
1<?php
2
3/**
4 * SplObjectStorage と curl_getinfo を組み合わせて、複数のCURLリクエストの情報を保存・表示するデモンストレーション関数です。
5 * システムエンジニア初心者向けに、オブジェクトをキーとして情報を関連付けて管理する SplObjectStorage の有用性を示します。
6 */
7function demonstrateSplObjectStorageWithCurlInfo(): void
8{
9    echo "CURLリクエストの情報をSplObjectStorageに保存するデモンストレーションを開始します。\n\n";
10
11    // SplObjectStorageを初期化します。
12    // SplObjectStorageは、オブジェクトをキーとして、それに関連する追加情報（任意のデータ）を格納できる特殊なコレクションです。
13    // これにより、例えば複数のCURLリクエスト（それぞれがオブジェクト）に、そのリクエストの実行結果を関連付けて管理できます。
14    $storage = new SplObjectStorage();
15
16    // 複数のターゲットURLを定義
17    $urls = [
18        'https://www.example.com',
19        'https://www.google.com',
20        'https://www.php.net',
21    ];
22
23    $curlHandles = []; // 後でCURLリクエストを実行するために、CURLハンドルを保持する配列
24
25    // 各URLに対してCURLハンドルを初期化し、SplObjectStorageにアタッチ
26    foreach ($urls as $url) {
27        // PHP 8以降では、curl_init() 関数は CurlHandle クラスのオブジェクトを返します。
28        // これは SplObjectStorage がオブジェクトをキーとして扱えるため、非常に相性が良いです。
29        $ch = curl_init($url);
30        if ($ch === false) {
31            echo "CURLハンドルの初期化に失敗しました: {$url}\n";
32            continue;
33        }
34
35        // CURLオプションを設定します。
36        // CURLOPT_RETURNTRANSFER: CURL_EXEC() の戻り値を、取得したデータを含む文字列として取得します。
37        // CURLOPT_TIMEOUT: リクエストのタイムアウト時間を秒単位で設定します。
38        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
39        curl_setopt($ch, CURLOPT_TIMEOUT, 5);
40
41        // SplObjectStorageにCURLハンドルオブジェクトをアタッチします。
42        // この時点では、まだ関連情報（Info）は設定しません。後で setInfo() を使って設定します。
43        $storage->attach($ch);
44        $curlHandles[] = $ch; // 後でリクエストを実行するためにハンドルを保存
45        echo "CURLハンドルを初期化し、URL '{$url}' のためにSplObjectStorageにアタッチしました。\n";
46    }
47
48    echo "\nCURLリクエストを実行し、その詳細情報を取得・保存します...\n";
49
50    // 各CURLリクエストを実行し、その詳細情報を取得して SplObjectStorage に保存します。
51    foreach ($curlHandles as $ch) {
52        // リクエスト実行前のURL情報を取得（表示用）
53        $currentUrl = curl_getinfo($ch, CURLINFO_EFFECTIVE_URL);
54        echo "  URL '{$currentUrl}' のリクエストを実行中...\n";
55
56        // CURLリクエストを実行します。
57        $response = curl_exec($ch);
58
59        // curl_getinfo() を使用して、実行されたCURLリクエストに関する詳細情報を取得します。
60        // この情報には、HTTPステータスコード、合計処理時間、リダイレクト情報など、
61        // HTTPヘッダーに関連する情報も含まれる連想配列が返されます。
62        $info = curl_getinfo($ch);
63
64        if ($response === false) {
65            // リクエストが失敗した場合、エラー情報を追加します。
66            $info['error_message'] = curl_error($ch);
67            $info['error_code'] = curl_errno($ch);
68            echo "  エラー発生: {$info['error_message']}\n";
69        }
70
71        // SplObjectStorage::setInfo($object, $info) を使用して、
72        // 指定したCURLハンドルオブジェクト ($ch) に取得した詳細情報を関連付けます。
73        // これにより、後でこのオブジェクトからその情報を簡単に取得できるようになります。
74        $storage->setInfo($ch, $info);
75        echo "  URL '{$currentUrl}' のCURL情報を取得し、SplObjectStorageに保存しました。\n";
76
77        // CURLハンドルをクローズします。
78        // 各リソースは使用後に適切に解放することが推奨されます。
79        curl_close($ch);
80    }
81
82    echo "\nSplObjectStorageに保存されたCURL情報を表示します。\n";
83
84    // SplObjectStorageの内容を反復処理し、保存されたCURL情報を表示します。
85    foreach ($storage as $ch) {
86        // SplObjectStorage::getInfo($object) を使って、setInfo() で設定した情報を取得します。
87        // ここで `$ch` は、元の CurlHandle オブジェクト（ただし既にクローズ済み）の参照です。
88        // オブジェクト自体はキーとして機能し続けますが、情報は取得できます。
89        $info = $storage->getInfo($ch);
90
91        // 取得したCURL情報を整形して表示
92        // null合体演算子 (??) を使用して、キーが存在しない場合のデフォルト値を設定しています。
93        $effectiveUrl = $info['url'] ?? 'N/A';
94        $httpCode = $info['http_code'] ?? 'N/A';
95        $totalTime = $info['total_time'] ?? 'N/A';
96        $errorMessage = $info['error_message'] ?? 'なし';
97
98        echo "----------------------------------------\n";
99        echo "対象URL: {$effectiveUrl}\n";
100        echo "HTTPステータスコード: {$httpCode}\n";
101        echo "合計処理時間: {$totalTime}秒\n";
102        echo "エラーメッセージ: {$errorMessage}\n";
103    }
104
105    echo "\nデモンストレーションが完了しました。\n";
106}
107
108// 上記で定義した関数を実行して、サンプルコードの動作を確認します。
109demonstrateSplObjectStorageWithCurlInfo();

PHPのSplObjectStorage::setInfoメソッドは、SplObjectStorageコレクションに格納されたオブジェクトに追加情報を関連付けるために使用されます。SplObjectStorageは、オブジェクトをキーとしてデータを管理できる特殊なコレクションで、これにより、特定のオブジェクトに紐づく詳細なデータを効率的に管理することが可能になります。

引数$objectには、情報を関連付けたい対象のオブジェクトを指定します。このオブジェクトは、事前にSplObjectStorage::attach()メソッドでコレクションに追加されている必要があります。もう一つの引数$infoには、そのオブジェクトに関連付けたい任意のデータ（文字列、配列、数値など、どんな型でも可）を指定します。

サンプルコードでは、CURLリクエストのハンドル（CurlHandleオブジェクト）を$objectとし、curl_getinfo関数で取得したリクエストの詳細情報（HTTPステータスコード、処理時間、HTTPヘッダーに関連する情報など）を$infoとして設定しています。これにより、それぞれのCURLハンドルに対して個別の実行結果や詳細情報を保存し、後からそのオブジェクトをキーとして簡単に取り出せるようになります。

setInfoメソッドは情報を設定するだけで、特に戻り値はありません。複数のオブジェクトに関する異なる情報を一元的に管理したい場合に非常に便利な機能です。