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

Copy
1<?php
2
3/**
4 * SplFixedArray クラスとその getIterator() メソッドの使用例を示します。
5 *
6 * SplFixedArray は、PHPで固定サイズの配列を扱うためのクラスで、
7 * 特にメモリ使用量を最適化したい場合に有用です。
8 * getIterator() メソッドは、この配列の内容を一つずつ順番に処理するための
9 * イテレータ（反復子）オブジェクトを返します。
10 * これにより、foreach ループなどを使って配列の要素を簡単に列挙できます。
11 */
12function demonstrateSplFixedArrayGetIterator(): void
13{
14    // 1. SplFixedArray の作成
15    // サイズが3の固定配列を作成します。一度サイズを設定すると、変更はできません。
16    $fixedArray = new SplFixedArray(3);
17
18    // 2. 配列に要素を格納
19    // インデックスを指定して値を代入します。
20    $fixedArray[0] = "Item A";
21    $fixedArray[1] = "Item B";
22    $fixedArray[2] = "Item C";
23
24    echo "--- SplFixedArray の内容を getIterator() を使って反復処理 ---\n";
25
26    // 3. getIterator() メソッドを呼び出し
27    // SplFixedArray から Iterator インターフェースを実装したオブジェクトを取得します。
28    // このイテレータは、配列の各要素を順番にアクセスする機能を提供します。
29    $iterator = $fixedArray->getIterator();
30
31    // 4. foreach ループでイテレータを処理
32    // 取得したイテレータを foreach ループで回すことで、
33    // 配列の全要素をキーと値のペアで簡単に列挙できます。
34    // これはPHPでイテレータを扱う最も一般的な方法です。
35    foreach ($iterator as $key => $value) {
36        echo "キー: {$key}, 値: {$value}\n";
37    }
38
39    echo "\ngetIterator() メソッドは、SplFixedArray の内容を標準的かつ効率的に読み取るための手段を提供します。\n";
40}
41
42// 上記の関数を実行して、SplFixedArray::getIterator() の動作を確認します。
43demonstrateSplFixedArrayGetIterator();
44

PHPのSplFixedArrayクラスは、要素の数を一度決めたら変更しない「固定サイズ」の配列を扱うためのもので、特にメモリ使用量を抑えたい場合に役立ちます。このSplFixedArrayに用意されているgetIterator()メソッドは、配列の要素を一つずつ順番に処理するための「イテレータ（反復子）」と呼ばれる特別なオブジェクトを返します。このメソッドは引数を一切取りません。

getIterator()メソッドを呼び出すと、Iteratorインターフェースを実装したオブジェクトが戻り値として得られます。このイテレータオブジェクトは、SplFixedArrayの内部にあるデータに対して、先頭から順にアクセスする機能を提供します。サンプルコードでは、まずSplFixedArrayを作成して要素を格納した後、$fixedArray->getIterator()を呼び出してイテレータを取得しています。このイテレータをPHPのforeachループで使用すると、配列の全要素をキーと値のペアとして簡単に列挙し、処理することができます。これにより、SplFixedArrayのデータを標準的かつ効率的な方法で読み取ることが可能になります。