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

Copy
1<?php
2
3// システムエンジニアを目指す初心者向けに、PHPのInfiniteIterator::current() メソッドの使い方を説明します。
4// キーワード「php current directory」に合わせて、現在のディレクトリのファイルを
5// 無限に反復するイテレータとして扱います。
6
7// 1. 現在のディレクトリのファイルやディレクトリを扱うイテレータを作成します。
8//    __DIR__ は、現在のスクリプトが置かれているディレクトリのパスを返します。
9//    DirectoryIterator は、そのディレクトリ内の各項目（ファイルやサブディレクトリ）
10//    を SplFileInfo オブジェクトとして扱います。
11$directoryIterator = new DirectoryIterator(__DIR__);
12
13// 2. DirectoryIterator を InfiniteIterator でラップします。
14//    InfiniteIterator は、内側のイテレータが終わりに達しても、
15//    自動的に最初に戻って繰り返し処理を継続する特別なイテレータです。
16$infiniteIterator = new InfiniteIterator($directoryIterator);
17
18// 3. InfiniteIterator を使って、現在のディレクトリの項目を繰り返し表示します。
19//    無限ループになるのを避けるため、ここでは最初の数項目だけ表示します。
20echo "現在のディレクトリ内の項目を InfiniteIterator で繰り返し表示します (最初の10回):\n";
21$count = 0;
22foreach ($infiniteIterator as $item) {
23    // InfiniteIterator::current() メソッドは、現在のイテレータ要素を返します。
24    // ここでは DirectoryIterator が提供する SplFileInfo オブジェクトです。
25    // そのオブジェクトから getPathname() メソッドを使ってファイルパスを取得し表示します。
26    echo $infiniteIterator->current()->getPathname() . "\n";
27    $count++;
28    if ($count >= 10) {
29        break; // 無限ループを避けるためにここで停止します。
30    }
31}
32
33// 4. foreach ループを使わずに current() メソッドを直接呼び出す例も示します。
34//    foreach ループの後、イテレータは特定の場所で停止している場合があります。
35//    InfiniteIterator は内部イテレータをリワインドせずに、前の繰り返しからの
36//    続きとして処理を続けます。
37echo "\nforeach ループ後、イテレータの現在の要素を current() で直接取得する例:\n";
38
39// この時点でのイテレータの現在の要素を表示します。
40echo "現在の要素: " . $infiniteIterator->current()->getPathname() . "\n";
41
42// next() メソッドを呼び出してイテレータを次の要素に進めます。
43$infiniteIterator->next();
44echo "next() 後の要素: " . $infiniteIterator->current()->getPathname() . "\n";
45
46// さらに next() を数回実行して、イテレータがディレクトリの終わりに達した後に
47// 自動的に最初に戻り、繰り返しが継続する様子を確認してみましょう。
48echo "\nさらに進めて、イテレータが繰り返す様子を確認:\n";
49for ($i = 0; $i < 5; $i++) {
50    $infiniteIterator->next();
51    echo "次の要素 (" . ($i + 1) . "回目): " . $infiniteIterator->current()->getPathname() . "\n";
52}

PHP 8のInfiniteIterator::current()メソッドは、イテレータが現在指している要素を取得するために使用されます。このメソッドは引数を取らず、現在の要素をmixed型で返します。

サンプルコードでは、DirectoryIteratorで取得した現在のディレクトリ（__DIR__）のファイルやディレクトリのリストを、InfiniteIteratorで「無限に繰り返せる」ようにラップしています。

current()メソッドは、この無限に繰り返されるイテレータの「現在の位置」にある具体的な要素（SplFileInfoオブジェクト）を返します。foreachループ内で使用することで、各反復処理で現在のファイルやディレクトリのパス名などを取得・表示できます。

InfiniteIteratorの特長は、内部イテレータが末尾に達しても自動的に最初に戻り、処理を継続する点です。current()は、この自動的な繰り返しの中で常にその時点での現在の要素を提供します。next()と組み合わせれば、イテレータを次の要素に進め、その新しい現在の要素をcurrent()で確認することも可能です。このように、current()はイテレータの現在の状態を把握する上で中心的な役割を果たします。

Copy
1<?php
2
3/**
4 * InfiniteIterator::current() の使用例
5 *
6 * InfiniteIterator は、内部のイテレータが終端に達しても、最初に戻って無限に繰り返すイテレータです。
7 * current() メソッドは、内部イテレータが現在指している要素の値を返します。
8 *
9 * この例では、曜日を格納した配列を InfiniteIterator で無限に繰り返し、
10 * current() メソッドを使用して現在の曜日を取得する方法を示します。
11 * キーワードの「timestamp」とは直接的な関連はありませんが、「current」な要素を取得する機能を示します。
12 */
13
14// 繰り返したいデータの配列を定義します。
15$daysOfWeek = ['月曜日', '火曜日', '水曜日', '木曜日', '金曜日', '土曜日', '日曜日'];
16
17// ArrayIterator を使用して、配列をイテレータとして扱えるようにします。
18$arrayIterator = new ArrayIterator($daysOfWeek);
19
20// InfiniteIterator で ArrayIterator をラップし、イテレータが終端に達しても最初に戻って無限に繰り返すようにします。
21$infiniteIterator = new InfiniteIterator($arrayIterator);
22
23echo "--- InfiniteIterator から current() で要素を取得する例 ---\n";
24
25// イテレータを複数回進め、その都度 current() で現在の要素を取得します。
26// 無限イテレータなので、理論的には何回でも繰り返すことができますが、ここでは10回に制限します。
27for ($i = 0; $i < 10; $i++) {
28    // current() メソッドは、イテレータが現在指している要素の「値」を返します。
29    $currentDay = $infiniteIterator->current();
30
31    // key() メソッドは、イテレータが現在指している要素の「キー」を返します。
32    // InfiniteIterator は内部イテレータのキーをそのまま使います。
33    $currentKey = $infiniteIterator->key();
34
35    echo "{$i}回目: 現在の曜日: '{$currentDay}' (キー: {$currentKey})\n";
36
37    // next() メソッドを呼び出して、イテレータを次の要素に進めます。
38    $infiniteIterator->next();
39}
40
41echo "--------------------------------------------------------\n";
42echo "InfiniteIterator::current() はイテレータが現在指している要素の値を返します。\n";
43echo "このメソッドは、PHPで現在のタイムスタンプを取得する機能とは直接関係ありません。\n";

このコードは、PHPのInfiniteIteratorクラスとそのcurrent()メソッドの基本的な使い方を示しています。InfiniteIteratorは、内部に持つイテレータが最後まで到達しても、最初に戻って繰り返し、要素を「無限」に提供する特別なイテレータです。

InfiniteIterator::current()メソッドは引数を取らず、イテレータが現在指している要素の「値」を返します。戻り値はmixed型で、要素の種類に応じて変化します。

サンプルコードでは、曜日の配列をArrayIteratorでイテレータ化し、それをInfiniteIteratorでラップしています。これにより、曜日の配列が繰り返し無限に利用できるようになります。forループの中で$infiniteIterator->current()を呼び出すと、現在指している曜日の文字列が取得できます。その後、$infiniteIterator->next()を呼ぶことで、イテレータは次の要素へと進みます。無限イテレータであるため、週末の「日曜日」の次には再び「月曜日」が返されます。

キーワードの「timestamp」とは直接関係ありませんが、このcurrent()メソッドはイテレータが「現在」指している要素を取得する機能を提供します。したがって、このメソッドはPHPで現在のタイムスタンプを取得する機能とは異なることにご注意ください。