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

Copy
1<?php
2
3// RecursiveArrayIterator の seek メソッドの使用例を示します。
4// seek メソッドは、イテレータの内部ポインタを特定のオフセット（位置）に移動させます。
5// RecursiveArrayIterator は SeekableIterator インターフェースを実装しているため、seek が使用可能です。
6
7$data = [
8    'apple',
9    'banana',
10    'cherry',
11    'date',
12    'elderberry',
13];
14
15// RecursiveArrayIterator のインスタンスを作成します。
16$iterator = new RecursiveArrayIterator($data);
17
18echo "--- 元の順序でのイテレーション ---\n";
19// 最初は通常通り、先頭から最後までイテレーションします。
20foreach ($iterator as $key => $value) {
21    echo "キー: $key, 値: $value\n";
22}
23
24echo "\n--- オフセット 2 にシーク後、そこからイテレーション ---\n";
25// イテレータは現在終端にいるため、まず rewind() で先頭に戻します。
26// seek は現在の位置から移動させるため、意図した位置に到達させるためには、
27// 通常 rewind() で先頭に戻してから seek するか、イテレーション前に seek を実行します。
28$iterator->rewind();
29
30// オフセット 2 (0-indexed) にイテレータのポインタを移動させます。
31// この場合、'cherry' の位置に移動します。
32$iterator->seek(2);
33
34// シーク後の現在の要素を表示します。
35echo "シーク後の現在の要素: キー: " . $iterator->key() . ", 値: " . $iterator->current() . "\n";
36
37echo "シークした位置から最後までイテレーション:\n";
38// seek した位置から残りの要素をイテレーションします。
39while ($iterator->valid()) {
40    echo "キー: " . $iterator->key() . ", 値: " . $iterator->current() . "\n";
41    $iterator->next();
42}
43
44echo "\n--- オフセット 0 にシーク後、そこからイテレーション ---\n";
45// もう一度、オフセット 0 (配列の先頭) にシークして、そこから全てをイテレーションします。
46$iterator->seek(0);
47echo "シーク後の現在の要素: キー: " . $iterator->key() . ", 値: " . $iterator->current() . "\n";
48
49echo "シークした位置から最後までイテレーション:\n";
50while ($iterator->valid()) {
51    echo "キー: " . $iterator->key() . ", 値: " . $iterator->current() . "\n";
52    $iterator->next();
53}

RecursiveArrayIterator::seekメソッドは、PHPのRecursiveArrayIteratorクラスが提供する機能で、イテレータの内部ポインタを特定のオフセット（位置）に直接移動させるために使用されます。このメソッドは、RecursiveArrayIteratorがSeekableIteratorインターフェースを実装しているため利用可能です。

引数にはint $offsetを指定し、これはイテレータ内のどの位置（0から始まるインデックス）に移動したいかを示す整数値です。例えば、seek(2)と指定すると、イテレータのポインタは3番目の要素に移動します。このメソッド自体は、移動が成功したかどうかを示すような戻り値を持たず、内部ポインタを操作するのみです。

サンプルコードでは、まず配列全体を通常通りイテレーションしています。その後、seek(2)を使用してイテレータのポインタを3番目の要素「cherry」の位置に移動させ、そこから残りの要素をイテレーションする様子を示しています。イテレータのポインタを特定のオフセットに移動させることで、途中の要素をスキップしたり、任意の場所から処理を開始したりできる点が特徴です。rewind()メソッドと組み合わせることで、イテレータを先頭に戻してから任意のオフセットにシークするといった柔軟な操作が可能になります。再度seek(0)を使って先頭に戻り、最初からイテレーションする例も示されており、イテレータのポインタを自由に操れることが分かります。

Copy
1<?php
2
3/**
4 * RecursiveArrayIterator::seek() メソッドの使用例。
5 *
6 * seek() メソッドは、イテレータの内部ポインタを指定されたオフセット（インデックス）に直接移動させます。
7 * これにより、イテレータの現在位置を特定の要素に設定し、その要素にアクセスできます。
8 */
9
10// テスト用のシンプルな配列を準備します。
11$data = [
12    'Apple',      // オフセット 0
13    'Banana',     // オフセット 1
14    'Cherry',     // オフセット 2
15    'Date',       // オフセット 3
16    'Elderberry', // オフセット 4
17];
18
19// RecursiveArrayIterator のインスタンスを作成します。
20$iterator = new RecursiveArrayIterator($data);
21
22echo "=== 元の配列の内容 ===\n";
23// 配列の内容を分かりやすく表示します。
24foreach ($data as $key => $value) {
25    echo sprintf("  [%d] => %s\n", $key, $value);
26}
27echo "\n";
28
29// イテレータをオフセット 2 ('Cherry') に移動します。
30$targetOffset = 2;
31$iterator->seek($targetOffset);
32
33echo "=== オフセット {$targetOffset} に移動後 ===\n";
34// valid() メソッドでイテレータが有効な位置にあるか確認します。
35if ($iterator->valid()) {
36    echo sprintf("現在のキー: %d, 現在の値: %s\n", $iterator->key(), $iterator->current());
37} else {
38    echo sprintf("オフセット %d は配列の範囲外であるか、無効な位置です。\n", $targetOffset);
39}
40echo "\n";
41
42// イテレータをオフセット 0 ('Apple') に移動します。
43$targetOffset = 0;
44$iterator->seek($targetOffset);
45
46echo "=== オフセット {$targetOffset} に移動後 ===\n";
47if ($iterator->valid()) {
48    echo sprintf("現在のキー: %d, 現在の値: %s\n", $iterator->key(), $iterator->current());
49} else {
50    echo sprintf("オフセット %d は配列の範囲外であるか、無効な位置です。\n", $targetOffset);
51}
52echo "\n";
53
54// 存在しないオフセットに移動しようとします。
55// seek() メソッドは無効なオフセットでも例外を投げませんが、
56// その後 valid() メソッドが false を返すようになります。
57$invalidOffset = 10;
58$iterator->seek($invalidOffset);
59
60echo "=== 存在しないオフセット {$invalidOffset} に移動後 ===\n";
61if ($iterator->valid()) {
62    // このブロックは実行されません。
63    echo sprintf("現在のキー: %d, 現在の値: %s\n", $iterator->key(), $iterator->current());
64} else {
65    echo sprintf("オフセット %d は配列の範囲外であるため、イテレータは無効な位置にあります。\n", $invalidOffset);
66}
67
68?>

RecursiveArrayIterator::seek()メソッドは、イテレータの現在位置を配列の特定のインデックス（オフセット）へ直接移動させる機能です。これにより、イテレータを先頭から順に要素をたどるのではなく、目的の要素へ直接アクセスしてデータを取得できます。

このメソッドはint $offsetという整数型の引数を一つ受け取り、移動したい要素のインデックスを指定します。戻り値はありませんが、イテレータの現在位置を変更します。実行後、current()でその位置の要素値、key()で現在のインデックスを取得できます。

サンプルコードでは、文字列の配列をRecursiveArrayIteratorに渡し、seek(2)でインデックス2番目の'Cherry'へ直接移動し、その値を取得する例を示しています。

重要な点として、存在しないオフセット（配列の範囲外のインデックス）を指定しても例外は発生しませんが、イテレータは無効な状態となり、valid()メソッドはfalseを返します。そのため、seek()で位置を移動させた後は、常にvalid()でイテレータが有効な位置にあるかを確認することが推奨されます。この機能は、特定のデータに直接アクセスしたい場合に便利です。