【PHP8.x】getIteratorメソッドの使い方

Copy
1<?php
2
3/**
4 * WeakMap::getIterator() のサンプルコード
5 */
6
7// WeakMap を利用するには PHP 7.4 以降が必要です。
8if (PHP_VERSION_ID < 70400) {
9    exit("PHP 7.4 以降が必要です。\n");
10}
11
12use WeakMap;
13
14class MyClass {
15    public string $name;
16
17    public function __construct(string $name) {
18        $this->name = $name;
19    }
20}
21
22$wm = new WeakMap();
23
24$obj1 = new MyClass("Object 1");
25$obj2 = new MyClass("Object 2");
26
27$wm[$obj1] = "Data for Object 1";
28$wm[$obj2] = "Data for Object 2";
29
30// getIterator() でイテレータを取得
31$iterator = $wm->getIterator();
32
33// イテレータを使って WeakMap の内容をループ処理
34foreach ($iterator as $key => $value) {
35    // $key は WeakMap のキー (オブジェクト)
36    // $value は WeakMap の値
37    echo "Key: " . $key->name . ", Value: " . $value . "\n";
38}
39
40// オブジェクトの参照を削除すると、WeakMap からも削除される
41unset($obj1);
42
43echo "After unsetting \$obj1:\n";
44
45$iterator = $wm->getIterator();
46foreach ($iterator as $key => $value) {
47    echo "Key: " . $key->name . ", Value: " . $value . "\n";
48}

WeakMap::getIterator() は、PHP 8 で利用可能な WeakMap クラスのメソッドで、WeakMap オブジェクトの内容を反復処理するためのイテレータを取得します。引数はなく、戻り値として Iterator インターフェースを実装したオブジェクトを返します。

サンプルコードでは、まず WeakMap オブジェクトを作成し、キーとして MyClass のインスタンス、値として文字列を格納しています。getIterator() を呼び出すことで、この WeakMap の内容を走査できるイテレータを取得できます。

取得したイテレータは foreach ループで使用し、WeakMap に格納されたキーと値を順番に処理します。キーは MyClass のインスタンスであり、値は対応する文字列です。ループ内では、キーオブジェクトの name プロパティと値を表示しています。

WeakMap の重要な特性として、キーとして使用されているオブジェクトへの参照がなくなると、WeakMap から自動的に削除される点が挙げられます。サンプルコードでは、$obj1 への参照を unset() で削除した後、再度イテレータを取得してループ処理を行うことで、$obj1 に関連付けられたデータが WeakMap から削除されていることを確認できます。この挙動により、メモリリークを防ぎ、効率的なメモリ管理を実現できます。