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

Copy
1<?php
2
3// WeakMap は PHP 8 で導入された機能で、キーとして使用されたオブジェクトへの参照を弱参照として保持します。
4// これは、キーオブジェクトが他の場所から参照されなくなると、ガベージコレクションによって自動的に WeakMap から削除されることを意味します。
5// offsetUnset メソッドは、指定されたキーオブジェクトとその関連値を WeakMap から明示的に削除するために使用します。
6
7// 1. WeakMap のインスタンスを作成します。
8$weakMap = new WeakMap();
9
10// 2. WeakMap のキーとなるオブジェクトをいくつか作成します。
11// WeakMap のキーは常にオブジェクトである必要があります。
12$keyObject1 = new stdClass();
13$keyObject1->name = 'オブジェクト1';
14
15$keyObject2 = new stdClass();
16$keyObject2->name = 'オブジェクト2';
17
18// 3. offsetSet (または配列風アクセス) を使用して、キーと値を WeakMap に追加します。
19// キーワードに関連するため、offsetSet の使用例も含みます。
20$weakMap->offsetSet($keyObject1, 'これはキーオブジェクト1に関連するデータです。');
21// 配列風アクセスでも同様に値を設定できます。
22$weakMap[$keyObject2] = 'これはキーオブジェクト2に関連するデータです。';
23
24echo "--- WeakMap にデータを追加後の状態 ---\n";
25var_dump($weakMap);
26
27// 4. offsetUnset を使用して、特定のキーオブジェクトとその値を WeakMap から削除します。
28// この例では、$keyObject1 を WeakMap から削除します。
29$weakMap->offsetUnset($keyObject1);
30
31echo "--- WeakMap から 'キーオブジェクト1' を削除後の状態 ---\n";
32var_dump($weakMap);
33
34// 5. 削除されたキーオブジェクトが WeakMap に存在しないことを確認します。
35if (!isset($weakMap[$keyObject1])) {
36    echo "メッセージ: キーオブジェクト1はWeakMapから正常に削除されました。\n";
37} else {
38    echo "エラー: キーオブジェクト1がまだWeakMapに存在します。\n";
39}
40
41// 6. 削除されていないキーオブジェクトが WeakMap にまだ存在することを確認します。
42if (isset($weakMap[$keyObject2])) {
43    echo "メッセージ: キーオブジェクト2はまだWeakMapに存在します。\n";
44    echo "キーオブジェクト2の値: " . $weakMap[$keyObject2] . "\n";
45} else {
46    echo "エラー: キーオブジェクト2がWeakMapから削除されました。\n";
47}
48
49?>

PHP 8で導入されたWeakMapは、キーとして使用されたオブジェクトへの参照を「弱参照」として保持する特殊なマップです。これは、キーオブジェクトが他の場所から参照されなくなると、ガベージコレクションによって自動的にWeakMapから削除される特徴があります。

WeakMap::offsetUnsetメソッドは、このWeakMapの中から、指定されたキーオブジェクトとその関連する値を明示的に削除するために使用します。引数object $objectには削除したいキーとなるオブジェクトを指定します。このメソッドは内部処理を実行するだけで、呼び出し元に何も値を返しません（戻り値はvoidです）。

サンプルコードでは、まずWeakMapのインスタンスを作成し、offsetSetメソッド（または配列風アクセス）を使って$keyObject1と$keyObject2という二つのオブジェクトをキーとしてデータを追加しています。その後、$weakMap->offsetUnset($keyObject1);を実行することで、$keyObject1に関連付けられたデータがWeakMapから削除されます。この操作により、$keyObject1はWeakMap内に存在しなくなりますが、削除を指定していない$keyObject2はWeakMap内に残っていることが確認できます。このように、offsetUnsetは特定のキーオブジェクトを指定して、効率的にWeakMapからデータを削除する機能を提供します。

Copy
1<?php
2
3/**
4 * WeakMap はPHP 8.0で導入されたデータ構造です。
5 * キーとしてオブジェクトのみを許容し、キーオブジェクトがどこからも参照されなくなった場合、
6 * WeakMapからそのエントリは自動的に削除されるという特徴があります。
7 *
8 * offsetUnset メソッドは、ArrayAccess インターフェースの一部であり、
9 * 通常は unset($weakMap[$object]) の形で呼び出されます。
10 * この操作は、指定されたオブジェクトをキーとするエントリを WeakMap から削除します。
11 */
12
13// サンプルで使用する単純なオブジェクトクラス
14class MyObject
15{
16    public string $name;
17
18    public function __construct(string $name)
19    {
20        $this->name = $name;
21    }
22}
23
24// 1. WeakMap を初期化します
25$weakMap = new WeakMap();
26
27// 2. キーとして使用するオブジェクトを作成します
28$objA = new MyObject('Object A');
29$objB = new MyObject('Object B');
30$objC = new MyObject('Object C'); // WeakMapに存在しないキーとして使用
31
32// 3. WeakMap にエントリを追加します
33$weakMap[$objA] = 'Value for Object A';
34$weakMap[$objB] = 'Value for Object B';
35
36echo "--- 初期状態のWeakMap ---" . PHP_EOL;
37var_dump($weakMap);
38echo PHP_EOL;
39
40// 4. 存在するキー ($objA) のエントリを削除します
41//    offsetUnset は unset($weakMap[$object]) の形で呼び出されます。
42echo "--- 存在するキー (\$objA) を削除 ---" . PHP_EOL;
43unset($weakMap[$objA]);
44echo "削除後のWeakMapの状態:" . PHP_EOL;
45var_dump($weakMap);
46echo PHP_EOL;
47
48// 5. 存在しないキー ($objC) のエントリを削除しようと試みます
49//    PHPのWeakMapでは、存在しないオフセット(キー)に対してunset()を呼び出しても
50//    WarningやErrorは発生せず、単に何も起こりません。
51//    これが「php offset エラー」に対する重要なポイントです。
52echo "--- 存在しないキー (\$objC) を削除しようと試みる (エラーは発生しません) ---" . PHP_EOL;
53unset($weakMap[$objC]);
54echo "存在しないキーを削除しようとした後のWeakMapの状態:" . PHP_EOL;
55var_dump($weakMap);
56echo PHP_EOL;
57
58// WeakMapに存在しない、別の新しいオブジェクトを作成して試す
59$objNonExistent = new MyObject('Non-existent Object');
60echo "--- まったく新しいオブジェクト (\$objNonExistent) を削除しようと試みる (依然としてエラーは発生しません) ---" . PHP_EOL;
61unset($weakMap[$objNonExistent]);
62echo "WeakMapの状態 (変更なし):" . PHP_EOL;
63var_dump($weakMap);
64echo PHP_EOL;
65
66?>

PHP 8で導入されたWeakMapは、オブジェクトをキーとしてデータを格納する特殊なデータ構造です。その最大の特徴は、キーとして使用されたオブジェクトがどこからも参照されなくなった場合に、対応するエントリがWeakMapから自動的に削除される点です。

WeakMap::offsetUnsetメソッドは、指定されたオブジェクトをキーとするエントリをWeakMapから削除する役割を持ちます。このメソッドは通常、unset($weakMap[$object])という形式で呼び出されます。引数$objectには、WeakMapから削除したいエントリのキーとなるオブジェクトを指定します。この操作は値を返さず（戻り値はvoid）、単に指定されたエントリを削除するだけです。

重要な点として、もしWeakMap内に指定されたキーのオブジェクトが存在しない場合でも、unset($weakMap[$object])を実行してもPHPはWarningやErrorなどの何らかのエラーを発生させません。これは、存在しないオフセットに対してunset操作を行っても安全であることを意味し、システム開発において予期せぬエラーで処理が中断される心配がないため、コードの堅牢性を高める上で役立ちます。