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

Copy
1<?php
2
3/**
4 * ArrayIterator::count() メソッドの動作をデモンストレーションします。
5 *
6 * このメソッドは、イテレータが扱う配列内の要素の数を返します。
7 * PHPのグローバルな `count()` 関数が `null` を渡された場合に `0` を返すのとは異なり、
8 * ArrayIterator::count() は、配列内に `null` 値が含まれていても、それらを有効な要素として数えます。
9 * イテレータが空の配列から作成された場合は `0` を返します。
10 */
11function demonstrateArrayIteratorCount(): void
12{
13    echo "ArrayIterator::count() メソッドのデモンストレーション:\n\n";
14
15    // ケース1: 空の配列から作成されたArrayIterator
16    // count() は 0 を返します。
17    $emptyArray = [];
18    $iteratorEmpty = new ArrayIterator($emptyArray);
19    echo "元の配列: " . json_encode($emptyArray) . "\n";
20    echo "ArrayIterator::count() (空の配列): " . $iteratorEmpty->count() . "\n\n";
21
22    // ケース2: 通常の要素を持つ配列から作成されたArrayIterator
23    // count() は要素の総数を返します。
24    $regularArray = ['apple', 'banana', 'cherry'];
25    $iteratorRegular = new ArrayIterator($regularArray);
26    echo "元の配列: " . json_encode($regularArray) . "\n";
27    echo "ArrayIterator::count() (通常の配列): " . $iteratorRegular->count() . "\n\n";
28
29    // ケース3: null値を含む配列から作成されたArrayIterator
30    // ArrayIterator::count() は、null値も他の要素と同様に数えます。
31    // PHPのグローバルな `count(null)` が `0` を返すのとは異なります。
32    $arrayWithNulls = [1, null, 3, 'four', null, 6];
33    $iteratorWithNulls = new ArrayIterator($arrayWithNulls);
34    echo "元の配列: " . json_encode($arrayWithNulls) . "\n";
35    echo "ArrayIterator::count() (null値を含む配列): " . $iteratorWithNulls->count() . "\n\n";
36
37    // ケース4: 連想配列で、値がnullである要素を含む場合
38    $associativeArrayWithNull = ['id' => 101, 'name' => 'John Doe', 'email' => null];
39    $iteratorAssociativeWithNull = new ArrayIterator($associativeArrayWithNull);
40    echo "元の配列: " . json_encode($associativeArrayWithNull) . "\n";
41    echo "ArrayIterator::count() (連想配列でnull値を含む): " . $iteratorAssociativeWithNull->count() . "\n\n";
42}
43
44// デモンストレーションを実行
45demonstrateArrayIteratorCount();

PHPのArrayIterator::count()メソッドは、ArrayIteratorオブジェクトがラップしている（＝扱っている）配列の要素数を数え、その結果を整数値（int）として返す機能です。このメソッドは引数を一切必要としません。

例えば、空の配列から作成されたArrayIteratorに対してcount()を呼び出すと、結果は0となります。通常の文字列や数値などの要素を持つ配列であれば、その要素数通りの値が正確に返されます。

特に注意すべき点は、配列内にnull値が含まれている場合の挙動です。PHPの標準的なグローバル関数であるcount()は、引数にnullを渡すと0を返しますが、ArrayIterator::count()は配列内のnullも他の要素と同様に有効な要素として数え上げます。つまり、[1, null, 'text']という配列を扱うArrayIteratorに対してcount()を呼び出すと、3が返されます。連想配列において値がnullであっても、そのキーと値のペアは一つの要素として数えられます。この挙動の違いを理解することで、ArrayIteratorを使用した配列の要素数取得をより正確に制御できます。

Copy
1<?php
2
3// 数える対象となる配列を準備します。
4$fruits = [
5    'apple',
6    'banana',
7    'cherry',
8    'date',
9    'elderberry',
10];
11
12// ArrayIterator クラスは、配列を反復処理（ループ処理）可能なオブジェクトとして扱うためのものです。
13// ここでは、$fruits 配列を基に ArrayIterator オブジェクトを作成します。
14$arrayIterator = new ArrayIterator($fruits);
15
16// ArrayIterator の count() メソッドを使って、
17// このイテレータが内部に保持している要素（配列の要素）の総数を取得します。
18// このメソッドは引数を取らず、整数値 (int) を返します。
19$numberOfElements = $arrayIterator->count();
20
21// 取得した要素の数を表示します。
22echo "ArrayIterator が保持する要素の数: " . $numberOfElements . "\n";
23
24// 空の配列の場合も確認してみましょう。
25$emptyArray = [];
26$emptyArrayIterator = new ArrayIterator($emptyArray);
27$numberOfEmptyElements = $emptyArrayIterator->count();
28echo "空の ArrayIterator が保持する要素の数: " . $numberOfEmptyElements . "\n";
29
30?>

PHP 8のArrayIteratorクラスにおけるcount()メソッドは、配列を反復処理（ループ処理）可能なオブジェクトとして扱うArrayIteratorが、現在内部に保持している要素の総数を取得するために使われます。このメソッドは、どのような引数も取らず、数えられた要素の数を整数値（int）として返します。

サンプルコードでは、まず数える対象となる$fruits配列を準備しています。次に、この$fruits配列をもとにnew ArrayIterator($fruits)とすることで、配列を操作するためのArrayIteratorオブジェクトを生成します。

生成された$arrayIteratorオブジェクトに対して$arrayIterator->count()と呼び出すことで、このイテレータが保持している要素の数を取得します。この例では$fruits配列に5つの要素があるため、count()メソッドは5という整数値を返します。この結果は$numberOfElements変数に代入され、画面に表示されます。

さらに、$emptyArrayという空の配列を使った場合も確認しています。空の配列から作成したArrayIteratorにcount()メソッドを適用すると、正しく0が返されます。これにより、ArrayIterator::count()メソッドが、どのような状態の配列オブジェクトに対しても正確な要素数を簡潔に取得できることがわかります。