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

Copy
1<?php
2
3/**
4 * このスクリプトは、SplObjectStorage クラスの addAll メソッドの使用方法を示します。
5 * addAll は、別の SplObjectStorage インスタンス内のすべてのオブジェクトを
6 * 現在のストレージに追加するために使用されます。
7 *
8 * SplObjectStorage は、オブジェクトをキーとして保存するための特別なコレクションクラスで、
9 * オブジェクトの参照を追跡し、それらを高速に検索・管理するのに適しています。
10 */
11
12/**
13 * SplObjectStorage::addAll メソッドの使用例をデモンストレーションする関数。
14 */
15function demonstrateSplObjectStorageAddAll(): void
16{
17    echo "--- SplObjectStorage::addAll デモンストレーション ---\n\n";
18
19    // 1. 最初の SplObjectStorage インスタンスを作成し、オブジェクトを追加
20    $storage1 = new SplObjectStorage();
21    $objA = new stdClass();
22    $objA->name = 'Object A';
23    $objB = new stdClass();
24    $objB->name = 'Object B';
25
26    $storage1->attach($objA);
27    $storage1->attach($objB);
28
29    echo "最初のストレージ (storage1) の初期状態:\n";
30    foreach ($storage1 as $obj) {
31        echo "- " . $obj->name . "\n";
32    }
33    echo "storage1 のオブジェクト数: " . $storage1->count() . "\n\n";
34
35
36    // 2. 2番目の SplObjectStorage インスタンスを作成し、オブジェクトを追加
37    $storage2 = new SplObjectStorage();
38    $objC = new stdClass();
39    $objC->name = 'Object C';
40    $objD = new stdClass();
41    $objD->name = 'Object D';
42    $objA_duplicate = $objA; // 同じオブジェクトを参照する別の変数
43
44    $storage2->attach($objC);
45    $storage2->attach($objD);
46    $storage2->attach($objA_duplicate); // storage1 にも存在するオブジェクト
47
48    echo "2番目のストレージ (storage2) の初期状態:\n";
49    foreach ($storage2 as $obj) {
50        echo "- " . $obj->name . "\n";
51    }
52    echo "storage2 のオブジェクト数: " . $storage2->count() . "\n\n";
53
54
55    // 3. storage2 のすべてのオブジェクトを storage1 に追加
56    echo "storage1 に storage2 のすべてのオブジェクトを追加中 (addAll メソッドを使用)...\n\n";
57    $storage1->addAll($storage2);
58
59
60    // 4. addAll 後の storage1 の状態を表示
61    echo "addAll 後の最初のストレージ (storage1) の状態:\n";
62    foreach ($storage1 as $obj) {
63        echo "- " . $obj->name . "\n";
64    }
65    echo "addAll 後の storage1 のオブジェクト数: " . $storage1->count() . "\n\n";
66
67    echo "--- ポイント ---\n";
68    echo "- storage1 には objA, objB, objC, objD が含まれています。\n";
69    echo "- objA は元々 storage1 にあり、storage2 にも存在しましたが、重複して追加されることはありません。\n";
70    echo "  SplObjectStorage はオブジェクトをキーとして扱うため、同じオブジェクトは一度しか格納されません。\n";
71    echo "- オブジェクトの追加は、オブジェクトそのものの参照によって行われます。\n";
72}
73
74// 関数の実行
75demonstrateSplObjectStorageAddAll();

PHPのSplObjectStorageは、オブジェクトそのものをキーとして効率的に管理するための特殊なコレクションクラスです。このクラスは、追加されたオブジェクトの参照を追跡し、同じオブジェクトが複数回追加されてもストレージ内には一度しか格納しないというユニークな特性を持っています。

SplObjectStorageクラスのaddAllメソッドは、引数として渡された別のSplObjectStorageインスタンス内のすべてのオブジェクトを、現在のSplObjectStorageインスタンスに追加する機能を提供します。

このメソッドは、SplObjectStorage $storageという引数を一つだけ受け取ります。この引数には、現在のストレージに追加したいオブジェクトを保持しているSplObjectStorageのインスタンスを指定します。addAllメソッド自体は、処理の成功や失敗を示す特定の値を戻り値として返しません。

サンプルコードでは、$storage1にobjAとobjBを、$storage2にobjC、objD、そしてobjAと同じオブジェクトの参照であるobjA_duplicateを追加しています。その後、$storage1->addAll($storage2)を実行すると、$storage2に含まれるobjCとobjDが$storage1に追加されます。objAは元々$storage1に存在し、$storage2にも含まれていましたが、SplObjectStorageの特性により重複して追加されることはありません。結果として$storage1には、objA、objB、objC、objDというユニークな4つのオブジェクトが格納された状態となります。これにより、オブジェクトの重複を気にすることなく、複数のSplObjectStorageの内容を効率的に結合できます。