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

Copy
1<?php
2
3/**
4 * SplObjectStorage::removeAllExcept メソッドの基本的な使用例を示すスクリプト。
5 * 指定されたオブジェクトのリストに含まれないオブジェクトをストレージからすべて削除します。
6 */
7
8// 1. SplObjectStorage の初期化
9// SplObjectStorage は、オブジェクトをキーとして保存できる特別なコレクションです。
10$storage = new SplObjectStorage();
11
12// 2. ダミーのオブジェクトを作成
13// 例として、stdClass のインスタンスをいくつか作成します。
14$objectA = new stdClass();
15$objectB = new stdClass();
16$objectC = new stdClass();
17$objectD = new stdClass();
18
19// オブジェクトに識別しやすいようにプロパティを追加（必須ではないがデバッグに役立つ）
20$objectA->name = 'Object A';
21$objectB->name = 'Object B';
22$objectC->name = 'Object C';
23$objectD->name = 'Object D';
24
25// 3. オブジェクトを SplObjectStorage に追加（attach）
26echo "--- 初期状態 ---" . PHP_EOL;
27$storage->attach($objectA);
28$storage->attach($objectB);
29$storage->attach($objectC);
30$storage->attach($objectD);
31
32echo "ストレージ内のオブジェクト数: " . $storage->count() . PHP_EOL;
33echo "格納されているオブジェクト: " . PHP_EOL;
34foreach ($storage as $object) {
35    echo "- " . $object->name . " (ID: " . spl_object_id($object) . ")" . PHP_EOL;
36}
37echo PHP_EOL;
38
39// 4. 残したいオブジェクトのリスト（配列）を定義
40// ここでは、$objectB と $objectD のみをストレージに残したいとします。
41$objectsToKeep = [$objectB, $objectD];
42
43echo "--- removeAllExcept() の実行 ---" . PHP_EOL;
44echo "残したいオブジェクトのリスト:" . PHP_EOL;
45foreach ($objectsToKeep as $obj) {
46    echo "- " . $obj->name . " (ID: " . spl_object_id($obj) . ")" . PHP_EOL;
47}
48echo PHP_EOL;
49
50// 5. removeAllExcept メソッドを呼び出し
51// $objectsToKeep に含まれるオブジェクト以外をすべて削除します。
52$storage->removeAllExcept($objectsToKeep);
53
54echo "--- 実行後の状態 ---" . PHP_EOL;
55echo "ストレージ内のオブジェクト数: " . $storage->count() . PHP_EOL;
56echo "格納されているオブジェクト: " . PHP_EOL;
57if ($storage->count() > 0) {
58    foreach ($storage as $object) {
59        echo "- " . $object->name . " (ID: " . spl_object_id($object) . ")" . PHP_EOL;
60    }
61} else {
62    echo "ストレージは空です。" . PHP_EOL;
63}
64
65// 期待される出力: Object B と Object D のみが残ります。
66
67?>

PHP 8のSplObjectStorageクラスは、オブジェクトをキーとして管理できる特別なコレクションです。その中のremoveAllExceptメソッドは、SplObjectStorageに現在格納されているオブジェクトの中から、引数で指定されたオブジェクトのリストに含まれないものをすべて削除する機能を提供します。

このメソッドには、残したいオブジェクトをまとめた配列を引数として渡します。渡された配列に含められたオブジェクトだけがSplObjectStorage内に保持され、それ以外のオブジェクトはすべて削除されます。このメソッドは処理を実行するだけで、値を返しません（戻り値なし）。

サンプルコードでは、まず複数のオブジェクトをSplObjectStorageに追加しています。その後、removeAllExceptメソッドを呼び出す際に、残したいオブジェクト（例では$objectBと$objectD）のみを含む配列を引数として渡しています。これにより、実行後にはSplObjectStorage内に$objectBと$objectDだけが残り、他のオブジェクトはすべて削除されていることが確認できます。この機能は、特定のオブジェクトだけを効率的にコレクション内に維持したい場合に役立ちます。

Copy
1<?php
2
3// SplObjectStorage は、オブジェクトをキーとしてデータを格納するコレクションです。
4// 通常の配列とは異なり、オブジェクトの同一性を厳密に比較します。
5
6// サンプル用のクラスを定義します。
7class User
8{
9    public string $name;
10
11    public function __construct(string $name)
12    {
13        $this->name = $name;
14    }
15}
16
17class Product
18{
19    public string $itemCode;
20
21    public function __construct(string $itemCode)
22    {
23        $this->itemCode = $itemCode;
24    }
25}
26
27// 1. SplObjectStorage のインスタンスを作成します。
28$objectStorage = new SplObjectStorage();
29
30// 2. いくつかのオブジェクトを作成し、ストレージに追加します。
31$userA = new User("Alice");
32$userB = new User("Bob");
33$productX = new Product("P-001");
34$productY = new Product("P-002");
35$userC = new User("Charlie");
36
37$objectStorage->attach($userA);
38$objectStorage->attach($userB);
39$objectStorage->attach($productX);
40$objectStorage->attach($productY);
41$objectStorage->attach($userC);
42
43echo "--- 削除前のオブジェクトストレージの内容 ---" . PHP_EOL;
44echo "現在のオブジェクト数: " . $objectStorage->count() . PHP_EOL;
45foreach ($objectStorage as $object) {
46    echo "  - " . get_class($object) . " (名前/コード: " . (property_exists($object, 'name') ? $object->name : (property_exists($object, 'itemCode') ? $object->itemCode : 'N/A')) . ", ハッシュ: " . spl_object_hash($object) . ")" . PHP_EOL;
47}
48echo PHP_EOL;
49
50// 3. ストレージに残したいオブジェクトの配列を作成します。
51// ここでは、$userA と $productY を残したいとします。
52$objectsToKeep = [$userA, $productY];
53
54echo "--- 残したいオブジェクト ---" . PHP_EOL;
55foreach ($objectsToKeep as $object) {
56    echo "  - " . get_class($object) . " (名前/コード: " . (property_exists($object, 'name') ? $object->name : (property_exists($object, 'itemCode') ? $object->itemCode : 'N/A')) . ", ハッシュ: " . spl_object_hash($object) . ")" . PHP_EOL;
57}
58echo PHP_EOL;
59
60// 4. removeAllExcept() メソッドを呼び出します。
61//    このメソッドは、$objectsToKeep に含まれるオブジェクトのみをストレージに残し、
62//    他のすべてのオブジェクトを削除します。
63$objectStorage->removeAllExcept($objectsToKeep);
64
65echo "--- removeAllExcept 実行後のオブジェクトストレージの内容 ---" . PHP_EOL;
66echo "現在のオブジェクト数: " . $objectStorage->count() . PHP_EOL;
67if ($objectStorage->count() > 0) {
68    foreach ($objectStorage as $object) {
69        echo "  - " . get_class($object) . " (名前/コード: " . (property_exists($object, 'name') ? $object->name : (property_exists($object, 'itemCode') ? $object->itemCode : 'N/A')) . ", ハッシュ: " . spl_object_hash($object) . ")" . PHP_EOL;
70    }
71} else {
72    echo "  ストレージは空です。" . PHP_EOL;
73}
74
75?>

SplObjectStorage::removeAllExceptメソッドは、PHPのSplObjectStorageクラスに格納されたオブジェクトを効率的に管理するための機能です。SplObjectStorageは、オブジェクトそのものをキーとして利用する特別なコレクションで、一般的な配列とは異なり、オブジェクトの同一性に基づいて要素を扱います。

このremoveAllExceptメソッドは、指定された配列に含まれるオブジェクトだけをSplObjectStorage内に残し、それ以外のすべてのオブジェクトを削除するという役割を持っています。サンプルコードでは、まず複数のUserオブジェクトとProductオブジェクトをSplObjectStorageに追加しています。その後、$objectsToKeepという配列に、ストレージ内に残したい特定のオブジェクト（この例では$userAと$productY）を格納します。

$objectStorage->removeAllExcept($objectsToKeep)と呼び出すことで、$objectsToKeepに含まれていない$userB、$productX、$userCといったオブジェクトがSplObjectStorageからすべて削除されます。引数$storageには、SplObjectStorageから削除せずに保持したいオブジェクトの配列を指定します。このメソッドには戻り値がなく、SplObjectStorageインスタンス自身の内容が直接変更されます。これにより、必要なオブジェクトだけをストレージに保持し、不要なものを一括でクリーンアップできるため、特定の条件でオブジェクトをフィルタリングする際に非常に便利です。