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

Copy
1<?php
2
3/**
4 * AppendIterator を使用して複数のイテレータを連結し、
5 * その current() メソッドの動作をデモンストレーションします。
6 * 現在のスクリプトのディレクトリにあるファイルと、定義済みの配列データを順に処理します。
7 */
8function demonstrateAppendIteratorCurrent(): void
9{
10    // 1. ArrayIterator の準備:
11    // シンプルな配列データを保持するイテレータを作成します。
12    $arrayData = ['apple', 'banana', 'cherry'];
13    $arrayIterator = new ArrayIterator($arrayData);
14
15    // 2. FilesystemIterator の準備:
16    // 現在のスクリプトが実行されているディレクトリ(__DIR__)を対象に、
17    // ファイルシステムを反復処理するイテレータを作成します。
18    // これにより「php current directory」というキーワードに関連付けます。
19    $currentDirectoryPath = __DIR__;
20    echo "Processing items from current directory: " . $currentDirectoryPath . "\n";
21    $filesystemIterator = new FilesystemIterator($currentDirectoryPath);
22
23    // 3. AppendIterator のインスタンスを作成し、他のイテレータを追加:
24    // AppendIterator は複数のイテレータを順に処理するためのイテレータです。
25    $appendIterator = new AppendIterator();
26    $appendIterator->append($arrayIterator);       // まず ArrayIterator を追加
27    $appendIterator->append($filesystemIterator);  // 次に FilesystemIterator を追加
28
29    echo "\n--- Iterating through combined elements ---\n";
30
31    // AppendIterator をループして、結合された要素を順に処理します。
32    // foreach ループ内で取得される $value は、
33    // 内部的に AppendIterator::current() が返す要素です。
34    foreach ($appendIterator as $key => $value) {
35        // AppendIterator::current() は、現在アクティブなイテレータの現在の要素を返します。
36        // foreach ループでは、$value 変数として自動的に取得されますが、
37        // 必要に応じて $appendIterator->current() と明示的に呼び出すことも可能です。
38        // $currentElement = $appendIterator->current();
39
40        if ($value instanceof SplFileInfo) {
41            // FilesystemIterator から返される要素は SplFileInfo オブジェクトです。
42            echo "  [File]   " . $value->getFilename() . " (Path: " . $value->getPathname() . ")\n";
43        } else {
44            // ArrayIterator から返される要素は文字列です。
45            echo "  [Array]  " . $value . "\n";
46        }
47    }
48
49    echo "\n--- Demonstration complete ---\n";
50}
51
52// デモンストレーション関数を実行します。
53demonstrateAppendIteratorCurrent();

PHP 8のAppendIterator::current()メソッドは、複数のイテレータを連結して一つのイテレータとして扱えるAppendIteratorクラスにおいて、現在アクティブなイテレータが指し示す要素を取得するために使用されます。このメソッドは引数を一切取りません。

AppendIteratorは、内部に追加されたイテレータを順番に処理するため、current()が返す値は、現在処理中のイテレータの型や内容によって異なります。そのため、戻り値の型はmixedとなります。

提供されたサンプルコードでは、まずシンプルな配列データを持つArrayIteratorと、現在のスクリプトが実行されているディレクトリ（__DIR__）内のファイルシステムを反復処理するFilesystemIteratorを準備しています。このFilesystemIteratorが「php current directory」というキーワードに関連する部分です。これらのイテレータをAppendIteratorに追加することで、配列の要素の後にディレクトリ内のファイルが続くような一つのイテレーションを作成しています。

foreachループでAppendIteratorを処理すると、内部的にcurrent()メソッドが自動的に呼び出され、現在のアクティブなイテレータから要素が順に取得されます。例えば、最初はArrayIteratorから文字列が、次にFilesystemIteratorからSplFileInfoオブジェクトが返される様子を確認できます。これにより、異なるソースのデータを一貫した方法で処理できるのです。

Copy
1<?php
2
3// AppendIterator クラスは、複数のイテレータを一つの論理的なイテレータとして連結するために使用されます。
4// ここでは、複数のイテレータに格納されたタイムスタンプを連結し、
5// AppendIterator::current() メソッドが返す「現在の要素」（この例ではタイムスタンプ）の動作を示します。
6
7// タイムスタンプのリストを格納する配列を2つ用意します。
8// 各タイムスタンプは、DateTime オブジェクトから Unix タイムスタンプ (秒) として取得しています。
9$timestampsSet1 = [
10    (new DateTime('2023-01-01 10:00:00'))->getTimestamp(), // 2023年1月1日 10:00:00
11    (new DateTime('2023-01-02 11:30:00'))->getTimestamp(), // 2023年1月2日 11:30:00
12];
13
14$timestampsSet2 = [
15    (new DateTime('2023-01-03 14:00:00'))->getTimestamp(), // 2023年1月3日 14:00:00
16    (new DateTime('2023-01-04 16:45:00'))->getTimestamp(), // 2023年1月4日 16:45:00
17];
18
19// それぞれのタイムスタンプセットを ArrayIterator でラップします。
20// ArrayIterator は配列をイテレータとして扱えるようにする標準クラスです。
21$iteratorA = new ArrayIterator($timestampsSet1);
22$iteratorB = new ArrayIterator($timestampsSet2);
23
24// AppendIterator をインスタンス化します。
25$combinedIterator = new AppendIterator();
26
27// AppendIterator にイテレータを追加します。
28// これにより、$iteratorA の要素の後に $iteratorB の要素が続きます。
29$combinedIterator->append($iteratorA);
30$combinedIterator->append($iteratorB);
31
32echo "--- 連結されたタイムスタンプの表示 ---\n";
33
34// AppendIterator を foreach ループで反復処理します。
35// foreach ループは内部的に AppendIterator::current() メソッドを呼び出し、
36// 現在のイテレータが指す要素の値を取得します。
37foreach ($combinedIterator as $key => $timestamp) {
38    // AppendIterator::current() が返したタイムスタンプ値 ($timestamp) を表示します。
39    // date() 関数を使用して、UNIXタイムスタンプを人間が読める形式に変換しています。
40    echo sprintf(
41        "キー: %s, タイムスタンプ (UNIX): %s, タイムスタンプ (日時): %s\n",
42        $key,
43        $timestamp,
44        date('Y-m-d H:i:s', $timestamp)
45    );
46}
47
48// ループ終了後の AppendIterator の状態を確認し、
49// AppendIterator::current() を明示的に呼び出す例を示します。
50// 通常、current() は foreach ループ内で暗黙的に利用されますが、
51// メソッドが引数なしで現在の要素を返すことを示すために、ここで呼び出します。
52echo "\n--- ループ終了後の現在の要素の確認 ---\n";
53if ($combinedIterator->valid()) {
54    // valid() メソッドは、イテレータが有効な位置（終端に達していない）にあるかを確認します。
55    $lastTimestamp = $combinedIterator->current();
56    echo sprintf(
57        "ループ終了後の現在のタイムスタンプ: %s (%s)\n",
58        $lastTimestamp,
59        date('Y-m-d H:i:s', $lastTimestamp)
60    );
61} else {
62    echo "イテレータは終端に達しており、現在の要素はありません。\n";
63}
64
65?>

PHPのAppendIterator::current()メソッドは、複数のイテレータを一つに連結して扱うAppendIteratorクラスにおいて、現在イテレータが指している要素の「値」を取得するために使用されます。引数はなく、現在の要素の値を直接返します。戻り値はmixed型であり、連結されたイテレータが保持するデータ型に応じて、さまざまな型の値が返されます。

このサンプルコードでは、複数のUNIXタイムスタンプのリストをArrayIteratorでラップし、それらをAppendIteratorに順に追加しています。これにより、2つのタイムスタンプリストがまるで一つのリストであるかのように連結されます。

foreachループでAppendIteratorを反復処理すると、内部的にcurrent()メソッドが呼び出され、連結されたイテレータの各タイムスタンプが順番に取得されて表示されます。このように、current()はイテレータの各ステップで「今、どこを指しているか」を具体的な値として提供する役割を担います。

ループ終了後にcurrent()を明示的に呼び出す例も示していますが、イテレータが終端に達している場合、current()は有効な要素を返しません。そのため、有効な位置にあるかを確認するvalid()メソッドと組み合わせて使用することが一般的です。