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

Copy
1<?php
2
3// SplObjectStorage::removeAll() の使用例
4// このメソッドは、現在の SplObjectStorage から、
5// 引数で指定された別の SplObjectStorage に含まれるすべてのオブジェクトを削除します。
6
7// オブジェクトを識別するために使用するダミーのクラス
8class MyTask {}
9
10// 1. メインとなる SplObjectStorage を作成し、複数のタスクオブジェクトを追加します。
11$mainTasks = new SplObjectStorage();
12
13$taskA = new MyTask();
14$taskB = new MyTask();
15$taskC = new MyTask();
16$taskD = new MyTask();
17$taskE = new MyTask();
18
19$mainTasks->attach($taskA, '重要タスク A'); // オブジェクトと関連データを追加
20$mainTasks->attach($taskB, '通常タスク B');
21$mainTasks->attach($taskC, '緊急タスク C');
22$mainTasks->attach($taskD, '通常タスク D');
23$mainTasks->attach($taskE, '重要タスク E');
24
25echo "--- 最初のタスクリスト (mainTasks) 初期状態 ---\n";
26echo "格納されているオブジェクト数: " . $mainTasks->count() . "\n";
27foreach ($mainTasks as $task) {
28    echo "  - オブジェクトハッシュ: " . spl_object_hash($task) . ", データ: " . $mainTasks[$task] . "\n";
29}
30echo "\n";
31
32// 2. 削除したいタスクオブジェクトを含む別の SplObjectStorage を作成します。
33// 例として、完了済みまたはキャンセルされたタスクをまとめるストレージとします。
34$tasksToRemove = new SplObjectStorage();
35$tasksToRemove->attach($taskB); // taskB を削除対象に追加
36$tasksToRemove->attach($taskD); // taskD を削除対象に追加
37// この $tasksToRemove に、メインストレージには存在しないオブジェクトが含まれていても問題ありません。
38// removeAll() は、メインストレージに存在するオブジェクトのみを削除します。
39
40echo "--- 削除するタスクを含むリスト (tasksToRemove) ---\n";
41echo "格納されているオブジェクト数: " . $tasksToRemove->count() . "\n";
42foreach ($tasksToRemove as $task) {
43    echo "  - オブジェクトハッシュ: " . spl_object_hash($task) . "\n";
44}
45echo "\n";
46
47// 3. mainTasks から tasksToRemove に含まれるすべてのタスクを削除します。
48echo "--- SplObjectStorage::removeAll() を実行 ---\n";
49$mainTasks->removeAll($tasksToRemove);
50echo "mainTasks から指定されたオブジェクトが削除されました。\n";
51echo "\n";
52
53// 4. 削除後の mainTasks の状態を表示し、効果を確認します。
54echo "--- 削除後のタスクリスト (mainTasks) ---\n";
55echo "格納されているオブジェクト数: " . $mainTasks->count() . "\n";
56foreach ($mainTasks as $task) {
57    echo "  - オブジェクトハッシュ: " . spl_object_hash($task) . ", データ: " . $mainTasks[$task] . "\n";
58}
59echo "\n";
60
61// 期待される結果:
62// $taskB と $taskD が $mainTasks から削除され、
63// $taskA, $taskC, $taskE のみが残ります。

SplObjectStorageは、PHPでオブジェクトをキーとしてデータを格納・管理できる特別なコレクションクラスです。SplObjectStorage::removeAll()メソッドは、このSplObjectStorageインスタンスから、引数で指定された別のSplObjectStorageインスタンスに含まれるすべてのオブジェクトを一括で削除する際に使用されます。

引数$storageには、現在のSplObjectStorageから削除したいオブジェクトが格納されている別のSplObjectStorageを指定します。このメソッドは、引数として渡されたストレージ内の各オブジェクトを参照し、もし現在のSplObjectStorageにも同じオブジェクトが存在すれば、それと関連付けられたデータをまとめて削除します。削除処理が完了しても、特に何らかの結果を返す必要がないため、戻り値はありません。

このサンプルコードでは、まずメインとなるタスクリスト（$mainTasks）を作成し、複数のタスクオブジェクトを追加しています。次に、完了したタスクやキャンセルされたタスクなど、$mainTasksから取り除きたい特定のタスクを別のSplObjectStorage（$tasksToRemove）にまとめています。そして、$mainTasks->removeAll($tasksToRemove)を実行することで、$tasksToRemoveに含まれるタスクを効率的に$mainTasksから一斉に削除しています。これにより、特定の条件でグループ化されたオブジェクトをコレクションからまとめて取り除くような場面で、非常に便利に活用できます。

Copy
1<?php
2
3/**
4 * SplObjectStorage から特定のオブジェクト群を一括で削除する方法を示すサンプルコードです。
5 * `SplObjectStorage::removeAll()` メソッドは、現在の SplObjectStorage インスタンスから、
6 * 引数で渡された別の SplObjectStorage インスタンスに含まれる全てのオブジェクトを削除します。
7 * (ただし、引数の SplObjectStorage に含まれていても、現在のインスタンスに元々存在しないオブジェクトは影響を受けません。)
8 */
9
10// サンプルで使用するシンプルなクラスを定義します。
11class MyObject
12{
13    // オブジェクトに一意のIDを付与するため、簡単なプロパティを追加
14    private static int $nextId = 1;
15    private int $id;
16
17    public function __construct()
18    {
19        $this->id = self::$nextId++;
20    }
21
22    public function getId(): int
23    {
24        return $this->id;
25    }
26}
27
28// ----------------------------------------------------------------------------------
29// 1. メインとなる SplObjectStorage を作成し、オブジェクトを追加します。
30// ----------------------------------------------------------------------------------
31$mainStorage = new SplObjectStorage();
32
33// 複数の MyObject インスタンスを作成
34$obj1 = new MyObject(); // ID: 1
35$obj2 = new MyObject(); // ID: 2
36$obj3 = new MyObject(); // ID: 3
37$obj4 = new MyObject(); // ID: 4
38
39// mainStorage にオブジェクトを追加
40$mainStorage->attach($obj1);
41$mainStorage->attach($obj2);
42$mainStorage->attach($obj3);
43$mainStorage->attach($obj4);
44
45echo "--- mainStorage 初期状態 ---\n";
46echo "要素数: " . $mainStorage->count() . "\n";
47echo "含まれるオブジェクトID: ";
48$ids = [];
49foreach ($mainStorage as $obj) {
50    $ids[] = $obj->getId();
51}
52echo implode(", ", $ids) . "\n\n"; // 例: 1, 2, 3, 4 と出力されます
53
54// ----------------------------------------------------------------------------------
55// 2. 削除対象のオブジェクト群を含む SplObjectStorage を作成します。
56// ----------------------------------------------------------------------------------
57$removeStorage = new SplObjectStorage();
58
59// removeStorage に、mainStorage にも存在するオブジェクトの一部と、
60// mainStorage には存在しない新しいオブジェクトを追加します。
61$objToRemove1 = $obj2; // mainStorage にも存在するオブジェクト (ID: 2)
62$objToRemove2 = $obj4; // mainStorage にも存在するオブジェクト (ID: 4)
63$objNew = new MyObject(); // mainStorage には存在しない新しいオブジェクト (ID: 5)
64
65$removeStorage->attach($objToRemove1);
66$removeStorage->attach($objToRemove2);
67$removeStorage->attach($objNew); // このオブジェクトは mainStorage に元々ないため、削除対象にはなりません
68
69echo "--- removeStorage (削除対象) の内容 ---\n";
70echo "要素数: " . $removeStorage->count() . "\n";
71echo "含まれるオブジェクトID: ";
72$ids = [];
73foreach ($removeStorage as $obj) {
74    $ids[] = $obj->getId();
75}
76echo implode(", ", $ids) . "\n\n"; // 例: 2, 4, 5 と出力されます
77
78// ----------------------------------------------------------------------------------
79// 3. mainStorage から removeStorage に含まれるオブジェクトを削除します。
80// ----------------------------------------------------------------------------------
81// `removeAll()` メソッドを呼び出すことで、`mainStorage`から`removeStorage`に含まれる
82// オブジェクトが全て削除されます。
83$mainStorage->removeAll($removeStorage);
84
85echo "--- mainStorage 削除後 ---\n";
86echo "要素数: " . $mainStorage->count() . "\n";
87echo "残っているオブジェクトID: ";
88$ids = [];
89foreach ($mainStorage as $obj) {
90    $ids[] = $obj->getId();
91}
92echo implode(", ", $ids) . "\n"; // 例: 1, 3 と出力されます (ID: 2と4が削除された)
93

PHP 8のSplObjectStorage::removeAll()メソッドは、オブジェクトを効率的に管理するための特殊なコレクションクラスであるSplObjectStorageにおいて、特定のオブジェクト群を一括で削除する機能を提供します。SplObjectStorageは、追加されたオブジェクトそのものをキーとして扱います。

このメソッドを呼び出すと、呼び出し元のSplObjectStorageインスタンスから、引数$storageとして渡された別のSplObjectStorageインスタンスに含まれる全てのオブジェクトが削除されます。削除の対象となるのは、現在のSplObjectStorageに元々存在しているオブジェクトに限られます。もし引数の$storageに、現在のSplObjectStorageには存在しないオブジェクトが含まれていても、それは削除対象とはならず、現在のSplObjectStorageには何も影響を与えません。メソッドの実行後、削除されたオブジェクトが$mainStorageから完全に消え、要素数が減少します。このメソッドは、削除の成否などを返す戻り値を持たず、直接呼び出し元のSplObjectStorageの状態を変更します。

サンプルコードでは、最初に$mainStorageに4つのオブジェクト（ID: 1, 2, 3, 4）を追加します。次に、削除したいオブジェクトの一部（ID: 2, 4）と、$mainStorageには含まれない新しいオブジェクト（ID: 5）を$removeStorageにまとめます。そして$mainStorage->removeAll($removeStorage)を実行すると、$mainStorageからID: 2と4のオブジェクトが削除され、結果として残るのはID: 1と3のオブジェクトのみとなります。これは、多数のオブジェクトの中から特定のグループのオブジェクトだけを一括で取り除きたい場合に非常に有用です。