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

Copy
1<?php
2
3/**
4 * SplFixedArray::count メソッドの使用例。
5 * SplFixedArray に格納された null 値も、他の要素と同様に正しくカウントされることを示します。
6 */
7function demonstrateSplFixedArrayCount(): void
8{
9    // 1. サイズが3の SplFixedArray を作成。
10    // SplFixedArray は初期状態で指定されたサイズのすべての要素が null で埋められます。
11    $arrayInitializedWithNull = new SplFixedArray(3);
12    echo "--- 初期化直後の SplFixedArray (すべての要素が null) ---\n";
13    echo "配列の内容:\n";
14    var_dump($arrayInitializedWithNull);
15    // count() メソッドは、この3つの null 要素をカウントします。
16    echo "要素数: " . $arrayInitializedWithNull->count() . "\n\n"; // 出力: 3
17
18    // 2. null 値を含む SplFixedArray を設定する例。
19    $arrayWithMixedElements = new SplFixedArray(3);
20    $arrayWithMixedElements[0] = 'Hello';
21    $arrayWithMixedElements[1] = null; // 明示的に null 値を設定
22    $arrayWithMixedElements[2] = 123;
23
24    echo "--- null 要素を含む SplFixedArray の場合 ---\n";
25    echo "配列の内容:\n";
26    var_dump($arrayWithMixedElements);
27
28    // count() メソッドを呼び出すと、null 値も1つの要素としてカウントされます。
29    $countResult = $arrayWithMixedElements->count();
30    echo "要素数 (null を含む): " . $countResult . "\n\n"; // 出力: 3
31
32    // 3. null 要素を全く含まない SplFixedArray の例。
33    $arrayWithoutNull = new SplFixedArray(2);
34    $arrayWithoutNull[0] = 'Apple';
35    $arrayWithoutNull[1] = 'Banana';
36
37    echo "--- null 要素を含まない SplFixedArray の場合 ---\n";
38    echo "配列の内容:\n";
39    var_dump($arrayWithoutNull);
40    // null 要素がない場合も同様に要素数をカウントします。
41    echo "要素数 (null を含まない): " . $arrayWithoutNull->count() . "\n"; // 出力: 2
42}
43
44// サンプルコードの関数を実行します。
45demonstrateSplFixedArrayCount();

SplFixedArray::countメソッドは、PHP 8で利用できるSplFixedArrayクラスに属する機能です。このメソッドは、固定長の配列であるSplFixedArrayオブジェクトが現在保持している要素の総数を取得するために使用されます。引数は一切不要で、実行すると配列内の要素の合計数を整数（int）で返します。

このメソッドの重要な特性として、配列内に含まれるnull値も他の値と同様に1つの有効な要素として数えられる点が挙げられます。SplFixedArrayは、指定されたサイズで初期化されると、すべての要素がデフォルトでnullで埋められます。countメソッドは、この初期状態のnull要素はもちろん、開発者が明示的にnullを代入した要素であっても、他のデータ型の要素と同じように正確にカウントし、その数を合計要素数として報告します。

サンプルコードでは、まずSplFixedArrayを初期化した直後のnullで埋められた状態、次に明示的にnullを含む混合要素の状態、そしてnullを全く含まない状態の3つのパターンでcountメソッドの挙動を確認しています。いずれのケースにおいても、SplFixedArray::countは、nullの有無に関わらず、配列の固定長で確保されているスロットの総数を正確に返していることが示されています。これにより、SplFixedArrayのサイズを確実に把握し、管理することが可能になります。

Copy
1<?php
2
3// SplFixedArray クラスは、固定サイズの配列を提供します。
4// その `count()` メソッドは、配列に現在格納されている要素の数ではなく、
5// 配列が確保している固定のサイズ（最大容量）を返します。
6// これは、通常のPHP配列でグローバルな `count()` 関数を使った場合の「要素の数」とは動作が異なります。
7
8// SplFixedArray をサイズ5で初期化します。
9// この配列は、最大5つの要素を保持できるようにメモリが確保されます。
10$fixedArray = new SplFixedArray(5);
11
12// 初期状態での SplFixedArray のサイズ（容量）を表示します。
13// ここでは、配列にまだ要素を何も代入していませんが、確保されたサイズが返されます。
14echo "SplFixedArray の初期サイズ: " . $fixedArray->count() . PHP_EOL;
15
16// 配列にいくつかの要素を代入します。
17$fixedArray[0] = "Apple";
18$fixedArray[1] = "Banana";
19$fixedArray[4] = "Cherry"; // インデックス2と3は空のままです。
20
21// 要素を代入した後でも、SplFixedArray の `count()` メソッドは
22// 確保されたサイズ（容量）を返すため、値は変わりません。
23// （代入した要素の数ではなく、最初に確保した容量が返されます。）
24echo "要素代入後の SplFixedArray のサイズ: " . $fixedArray->count() . PHP_EOL;
25
26// 補足: SplFixedArray の `count()` メソッドが返すのは「確保されたサイズ」です。
27// もし、実際に値がセットされている要素の数を数えたい場合は、
28// SplFixedArray をループで走査し、null ではない要素を数えるなどの別の処理が必要になります。
29
30?>

PHPのSplFixedArray::count()メソッドは、固定サイズの配列を提供するSplFixedArrayクラスに属するメソッドです。このメソッドは引数を取らず、配列の固定サイズを示す整数（int）を戻り値として返します。

通常のPHP配列でグローバルなcount()関数を使用すると、配列に現在格納されている要素の総数が返されますが、SplFixedArrayのcount()メソッドは、配列に値がセットされている要素の数ではなく、配列が初期化時に確保している「固定のサイズ（最大容量）」を返します。

サンプルコードでは、まずSplFixedArrayをサイズ5で初期化しています。この時点で配列は5つの要素を保持する容量が確保されているため、$fixedArray->count()は「5」を返します。その後、配列にいくつか要素を代入しても、$fixedArray->count()の戻り値は「5」のまま変化しません。これは、このメソッドが配列に代入された要素の数ではなく、最初に設定された容量を返すためです。

したがって、SplFixedArray::count()を使用する際は、これが配列の「容量」を示すものであり、通常の配列でいう「要素数」とは異なる点に注意が必要です。実際に値がセットされている要素の数を数えたい場合は、別途ループ処理などで確認する必要があります。