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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * カレントディレクトリのファイル一覧から指定範囲のファイル名を表示します。
7 *
8 * このサンプルでは、カレントディレクトリの情報を取得する FilesystemIterator と、
9 * その反復処理の範囲を限定する LimitIterator を組み合わせて使用します。
10 * foreach ループ内で各要素を取得する際、内部的に LimitIterator::current() メソッドが
11 * 呼び出されます。
12 *
13 * @return void
14 */
15function displayLimitedDirectoryEntries(): void
16{
17    // 事前にサンプル用のファイルを作成しておくと、動作が確認しやすくなります。
18    // 例: touch file1.txt file2.txt file3.txt file4.txt file5.txt
19    
20    try {
21        // 1. カレントディレクトリ（このPHPファイルが存在するディレクトリ）を対象とするイテレータを作成します。
22        // FilesystemIterator::SKIP_DOTS は '.' や '..' といった特殊なディレクトリを除外するオプションです。
23        $directoryIterator = new FilesystemIterator(
24            directory: getcwd(), // getcwd() はカレントディレクトリのパスを返します。
25            flags: FilesystemIterator::SKIP_DOTS
26        );
27
28        // 2. LimitIteratorを使い、元のイテレータの取得範囲を限定します。
29        // ここでは「1番目から3つ分」の要素に範囲を絞り込んでいます (オフセットは0から始まる)。
30        $limitIterator = new LimitIterator(
31            iterator: $directoryIterator,
32            offset: 1, // 取得開始位置 (0が先頭)
33            limit: 3   // 取得する最大件数
34        );
35
36        echo "カレントディレクトリのファイル一覧（1番目から3件）:" . PHP_EOL;
37
38        // 3. 限定された範囲のイテレータをループ処理します。
39        // foreach は内部で LimitIterator::current() を呼び出し、現在の要素を取得します。
40        // $fileInfo 変数には、current() が返した SplFileInfo オブジェクトが格納されます。
41        foreach ($limitIterator as $fileInfo) {
42            // SplFileInfo::getFilename() でファイル名を取得して表示します。
43            echo '- ' . $fileInfo->getFilename() . PHP_EOL;
44        }
45    } catch (Exception $e) {
46        // ディレクトリが存在しないなどのエラーを捕捉します。
47        echo 'エラー: ' . $e->getMessage() . PHP_EOL;
48    }
49}
50
51// 関数を実行します。
52displayLimitedDirectoryEntries();
53

LimitIterator::current()は、イテレータが現在指し示している要素を取得するためのメソッドです。

このサンプルコードは、カレントディレクトリ（現在実行しているPHPファイルがある場所）のファイル一覧を取得し、その中から指定した一部分だけを表示する処理を行っています。まずFilesystemIteratorを使い、カレントディレクトリ内のファイル情報を取得するためのイテレータを作成します。次に、そのイテレータをLimitIteratorに渡すことで、取得する範囲を「2番目から最大3件」のように限定しています。

foreachループでLimitIteratorの要素を一つずつ処理する際、PHPの内部ではループの各回で自動的にLimitIterator::current()メソッドが呼び出されます。このメソッドに引数はありません。戻り値のデータ型はmixedで、その時点でイテレータが指している要素そのものを返します。この例では、FilesystemIteratorが持つファイル情報を表すSplFileInfoオブジェクトが返され、変数$fileInfoに代入されます。その後、$fileInfoからファイル名を取得して画面に出力する、という仕組みです。

Copy
1<?php
2
3/**
4 * LimitIterator を使用して、現在の月の名前を取得して表示します。
5 *
6 * このサンプルでは、12ヶ月のリストを元データとし、LimitIterator を使って
7 * 「現在の月」のみに範囲を絞り込みます。
8 * その後、current() メソッドでその月の名前を取得します。
9 */
10function displayCurrentMonthWithLimitIterator(): void
11{
12    // 1月から12月までの月の名前を持つ配列
13    $months = [
14        1 => 'January',
15        2 => 'February',
16        3 => 'March',
17        4 => 'April',
18        5 => 'May',
19        6 => 'June',
20        7 => 'July',
21        8 => 'August',
22        9 => 'September',
23        10 => 'October',
24        11 => 'November',
25        12 => 'December',
26    ];
27
28    // 配列から ArrayIterator オブジェクトを作成
29    $arrayIterator = new ArrayIterator($months);
30
31    // 現在の月を数値で取得 (例: 1月なら1, 2月なら2)
32    $currentMonthNumber = (int) date('n');
33
34    // LimitIterator を作成
35    // 第2引数(offset): 取得を開始する位置。配列のインデックスは0から始まるため、現在の月から1を引く。
36    // 第3引数(count): 取得する要素の数。今回は1つだけ。
37    $limitIterator = new LimitIterator($arrayIterator, $currentMonthNumber - 1, 1);
38
39    // イテレータの内部ポインタを先頭に巻き戻す
40    $limitIterator->rewind();
41
42    // current() メソッドで、イテレータの現在の位置にある要素（現在の月の名前）を取得
43    $currentMonthName = $limitIterator->current();
44
45    // 結果を出力
46    echo "Using LimitIterator, the current month is: " . $currentMonthName . PHP_EOL;
47}
48
49// 関数を実行
50displayCurrentMonthWithLimitIterator();

LimitIteratorクラスのcurrentメソッドは、イテレータの現在の位置にある要素を取得します。このメソッドは引数を取りません。戻り値はmixed型で、要素のデータ型に応じて様々な値が返ります。

このサンプルコードは、12ヶ月の名前が格納された配列から、LimitIteratorを使って現在の月だけを特定し、その名前を表示する例です。まず、月の名前を持つ配列からArrayIteratorを作成し、これをLimitIteratorに渡します。LimitIteratorのインスタンスを作成する際、第2引数に現在の月から1を引いた値を指定して開始位置を定め、第3引数に1を指定して取得する要素を1つだけに絞り込みます。これにより、イテレータは現在の月だけを指すようになります。

その後、rewindメソッドでイテレータの位置を先頭に戻し、currentメソッドを呼び出します。このcurrentメソッドが、絞り込まれた範囲内の現在の要素、つまり「現在の月の名前」を文字列として返します。最後に、取得した月の名前を出力しています。このように、currentメソッドはLimitIteratorで限定したデータセットから、目的の要素を取り出すために使用されます。