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

Copy
1<?php
2
3/**
4 * WeakMap の count メソッドのサンプルコード.
5 *
6 * WeakMap に登録されているキーの数を取得します。
7 */
8class WeakMapExample
9{
10    public function run(): void
11    {
12        $map = new WeakMap();
13
14        $obj1 = new stdClass();
15        $obj2 = new stdClass();
16
17        $map[$obj1] = 'data1';
18        $map[$obj2] = 'data2';
19
20        echo "WeakMap の要素数: " . $map->count() . PHP_EOL; // 出力: WeakMap の要素数: 2
21
22        unset($obj1); // $obj1 への参照を削除
23
24        echo "WeakMap の要素数 (obj1 削除後): " . $map->count() . PHP_EOL; // 出力: WeakMap の要素数 (obj1 削除後): 1
25    }
26}
27
28$example = new WeakMapExample();
29$example->run();

このサンプルコードは、PHP 8 の WeakMap クラスにおける count メソッドの使い方を示しています。WeakMap は、キーがオブジェクトである連想配列のようなもので、キーのオブジェクトが破棄されると、自動的に WeakMap からそのキーと値のペアが削除されるという特徴を持ちます。

count メソッドは、WeakMap に現在登録されているキーの数を取得するために使用します。引数は不要で、戻り値として整数のカウントを返します。サンプルコードでは、まず WeakMap のインスタンスを作成し、2つのオブジェクト $obj1 と $obj2 をキーとして、それぞれに値を登録しています。この時点で $map->count() を実行すると、WeakMap には2つの要素が存在するため、2 が出力されます。

次に、unset($obj1) を実行して $obj1 への参照を削除します。これにより、$obj1 が指していたオブジェクトがガーベジコレクションの対象となり、WeakMap からも自動的に削除されます。その結果、再度 $map->count() を実行すると、WeakMap に残っている要素は1つだけになるため、1 が出力されます。このように、count メソッドを使用することで、WeakMap の現在のサイズを簡単に確認できます。

Copy
1<?php
2
3/**
4 * WeakMap::count() の使用例
5 */
6
7// WeakMapのインスタンスを生成
8$weakMap = new WeakMap();
9
10// オブジェクトをキーとしてWeakMapに値を設定
11$obj1 = new stdClass();
12$obj2 = new stdClass();
13$obj3 = new stdClass();
14
15$weakMap[$obj1] = 'value1';
16$weakMap[$obj2] = 'value2';
17$weakMap[$obj3] = 'value3';
18
19// WeakMap内の要素数を取得
20$count = $weakMap->count();
21
22// 結果を出力
23echo "WeakMap内の要素数: " . $count . PHP_EOL; // 出力: WeakMap内の要素数: 3
24
25// オブジェクトへの参照を削除し、ガベージコレクションを強制
26unset($obj1);
27unset($obj2);
28unset($obj3);
29gc_collect_cycles();
30
31// 再度要素数を取得(ガベージコレクションによりオブジェクトが破棄されると要素数が減る)
32$count = $weakMap->count();
33
34// 結果を出力 (環境によって0になる場合がある)
35echo "WeakMap内の要素数 (ガベージコレクション後): " . $count . PHP_EOL;

PHP 8 の WeakMap クラスにおける count メソッドについて解説します。WeakMap は、オブジェクトをキーとして、そのオブジェクトが破棄された際に自動的にエントリを削除する特別な連想配列のようなものです。

このサンプルコードでは、まず WeakMap のインスタンスを生成し、stdClass のインスタンスである $obj1、$obj2、$obj3 をキーとして、それぞれに対応する値を WeakMap に設定しています。

$weakMap->count() を実行することで、WeakMap に現在格納されているキーと値のペアの数を取得できます。戻り値は int 型で、WeakMap 内の要素数を表します。初期状態では3つのオブジェクトがキーとして登録されているため、count メソッドの戻り値は3になります。

その後、unset 関数を使って $obj1、$obj2、$obj3 への参照を削除し、gc_collect_cycles() でガベージコレクションを強制的に実行しています。これにより、これらのオブジェクトが破棄されると、WeakMap から対応するエントリが削除されます。再度 $weakMap->count() を実行すると、ガベージコレクションによってオブジェクトが破棄されていれば、要素数が減少し、環境によっては0になることがあります。

count メソッドは引数を取らず、WeakMap 内の要素数を調べるために使用します。オブジェクトの生存状況によって要素数が変動する WeakMap の特性を理解する上で、count メソッドは重要な役割を果たします。