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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * CachingIterator::hasNext() を使用して、配列からカンマ区切りの文字列を生成します。
7 *
8 * foreachループ内で次の要素が存在するかどうかを判定できるため、
9 * 最後の要素の後に不要な区切り文字を追加しない、といった処理が簡単に実装できます。
10 *
11 * @param array<int, string> $items 文字列の配列
12 * @return string カンマで区切られた文字列
13 */
14function createCommaSeparatedString(array $items): string
15{
16    // CachingIteratorは、内部のイテレータ（この場合はArrayIterator）をラップします。
17    // これにより、次の要素を「先読み」する hasNext() メソッドが使えるようになります。
18    $iterator = new CachingIterator(new ArrayIterator($items));
19
20    $result = '';
21
22    // foreachでイテレータをループ処理します。
23    foreach ($iterator as $item) {
24        // 現在の要素を結果文字列に追加します。
25        $result .= $item;
26
27        // CachingIterator::hasNext() で、次の要素が存在するかどうかをチェックします。
28        if ($iterator->hasNext()) {
29            // 次の要素が存在する場合（つまり、現在の要素が最後ではない場合）のみ区切り文字を追加します。
30            $result .= ', ';
31        }
32    }
33
34    return $result;
35}
36
37// サンプルデータ
38$fruits = ['Apple', 'Banana', 'Cherry'];
39
40// 関数を実行し、結果を出力します。
41// 出力: Apple, Banana, Cherry
42echo createCommaSeparatedString($fruits) . PHP_EOL;
43
44// 空の配列で試した場合
45// 出力: (何も表示されない)
46echo createCommaSeparatedString([]) . PHP_EOL;
47
48// 要素が1つの配列で試した場合
49// 出力: Grape
50echo createCommaSeparatedString(['Grape']) . PHP_EOL;

このサンプルコードは、PHPのCachingIterator::hasNext()メソッドを使用して、配列の要素をカンマで連結した一つの文字列を生成する方法を示しています。hasNext()メソッドは引数を取らず、ループ処理中のイテレータに次の要素が存在するかどうかを判定し、真偽値（bool）を返します。次の要素があればtrueを、なければ（現在の要素が最後であれば）falseを返します。

コード内のcreateCommaSeparatedString関数は、文字列の配列を引数として受け取り、カンマ区切りの文字列を戻り値として返します。関数内部では、まず引数の配列をCachingIteratorでラップします。これにより、hasNext()メソッドで次の要素を「先読み」する機能が使えるようになります。

foreachループで各要素を処理する際、最初に要素そのものを結果文字列に追加します。その後、hasNext()を呼び出して次の要素の有無をチェックします。次の要素が存在する場合にのみ、区切り文字である「, 」を追加します。この方法により、最後の要素の後ろに不要な区切り文字が付くことを防ぎ、ループの最終回を特別扱いするロジックを簡潔に実装できます。