【PHP8.x】nextメソッドの使い方

Copy
1<?php
2
3/**
4 * ネットから取得したJSONデータを反復処理するためのカスタムイテレータクラス
5 *
6 * PHPのイテレータの仕組みを理解するため、Iteratorインターフェースを実装します。
7 * foreachループでこのクラスのインスタンスを使用すると、PHPの内部エンジンが
8 * 自動的に rewind, valid, current, key, next メソッドを呼び出します。
9 * InternalIterator::next は、この next() メソッドに相当する内部機能です。
10 */
11class JsonFeedIterator implements Iterator
12{
13    private int $position = 0;
14    private array $items = [];
15
16    /**
17     * コンストラクタ
18     *
19     * @param string $jsonString ネットから取得したJSON形式の文字列
20     */
21    public function __construct(string $jsonString)
22    {
23        // JSON文字列をデコードしてPHPの配列に変換します。
24        $data = json_decode($jsonString, true);
25        // 'articles'キーが存在し、かつそれが配列であれば、その内容を処理対象として格納します。
26        if (isset($data['articles']) && is_array($data['articles'])) {
27            $this->items = $data['articles'];
28        }
29    }
30
31    /**
32     * イテレータを最初の要素に巻き戻します。 (foreach開始時に1回呼ばれます)
33     */
34    public function rewind(): void
35    {
36        $this->position = 0;
37    }
38
39    /**
40     * 現在の要素を返します。
41     */
42    public function current(): mixed
43    {
44        return $this->items[$this->position];
45    }
46
47    /**
48     * 現在の要素のキー (この場合は配列のインデックス) を返します。
49     */
50    public function key(): int
51    {
52        return $this->position;
53    }
54
55    /**
56     * 次の要素に進みます。 (foreachループの各サイクルの終わりに呼ばれます)
57     * このメソッドが InternalIterator::next の役割を果たします。
58     * 戻り値は void で、内部のポインタを進めることだけが目的です。
59     */
60    public function next(): void
61    {
62        ++$this->position;
63    }
64
65    /**
66     * 現在のポインタ位置が有効かどうかをチェックします。
67     * (falseを返すとforeachループが終了します)
68     */
69    public function valid(): bool
70    {
71        return isset($this->items[$this->position]);
72    }
73}
74
75// --- サンプルコードの実行部分 ---
76
77// ネット上のニュースフィードAPIから取得したと仮定するJSONデータ
78$jsonFromNet = <<<JSON
79{
80    "status": "ok",
81    "totalResults": 3,
82    "articles": [
83        {
84            "author": "Taro Yamada",
85            "title": "PHP 8の新機能について",
86            "publishedAt": "2023-12-08T10:00:00Z"
87        },
88        {
89            "author": "Hanako Suzuki",
90            "title": "モダンPHPにおけるコーディングスタイル",
91            "publishedAt": "2023-12-07T15:30:00Z"
92        },
93        {
94            "author": "Jiro Sato",
95            "title": "Composerを使った依存関係管理入門",
96            "publishedAt": "2023-12-06T09:00:00Z"
97        }
98    ]
99}
100JSON;
101
102// JSONデータを使ってイテレータのインスタンスを生成します。
103$feedIterator = new JsonFeedIterator($jsonFromNet);
104
105// foreachループを使って、ネットニュースのタイトルを一つずつ表示します。
106echo "最新ニュースフィード:\n";
107foreach ($feedIterator as $index => $article) {
108    printf(
109        "[%d] %s (著: %s)\n",
110        $index + 1,
111        $article['title'],
112        $article['author']
113    );
114}

このPHPサンプルコードは、ネットから取得したJSON形式のデータをforeachループで一つずつ処理するための、JsonFeedIteratorという独自のクラスを定義する例です。

PHPのforeachループが配列などを処理する際、内部ではInternalIteratorという仕組みが、要素を順番に辿るために機能しています。このサンプルでは、その仕組みをIteratorインターフェースを実装することで、自作のクラスでも利用可能にしています。

foreachでこのクラスのインスタンスを扱うと、PHPエンジンが自動的にrewind、valid、current、key、nextの各メソッドを呼び出します。ここで重要なのがnext()メソッドで、これはリファレンスにあるInternalIterator::nextと同じ役割を果たします。このメソッドは、foreachループの各サイクルの終わりに呼び出されます。引数はなく、戻り値もvoid（何も返さない）です。その唯一の目的は、内部で保持している位置情報（$position）を一つ進め、次の要素を指すように状態を更新することです。このnext()によるポインタの移動と、valid()による存在チェックを繰り返すことで、すべてのデータが順番に処理されます。

Copy
1<?php
2
3/**
4 * PHPの組み込みイテレータ(InternalIterator)の動作を理解するために、
5 * 同様の機能を持つIteratorインターフェースを実装したカスタムクラスを作成します。
6 * foreachループが内部でどのように要素を次に進めるかを示します。
7 */
8class CustomDataIterator implements Iterator
9{
10    /**
11     * @var int 現在の配列のインデックス
12     */
13    private int $position = 0;
14
15    /**
16     * @var array 反復処理を行うデータ配列
17     */
18    private array $data;
19
20    public function __construct(array $data)
21    {
22        $this->data = $data;
23    }
24
25    /**
26     * イテレータを最初の要素に巻き戻します。
27     * foreach ループの開始時に一度だけ呼び出されます。
28     */
29    public function rewind(): void
30    {
31        $this->position = 0;
32    }
33
34    /**
35     * 現在の要素が有効かどうかをチェックします。
36     * ループの各反復処理の前に呼び出されます。
37     *
38     * @return bool
39     */
40    public function valid(): bool
41    {
42        return isset($this->data[$this->position]);
43    }
44
45    /**
46     * 現在の要素のキー(この場合はインデックス)を返します。
47     *
48     * @return int
49     */
50    public function key(): int
51    {
52        return $this->position;
53    }
54
55    /**
56     * 現在の要素の値を返します。
57     *
58     * @return mixed
59     */
60    public function current(): mixed
61    {
62        return $this->data[$this->position];
63    }
64
65    /**
66     * 次の要素に進みます。
67     * このメソッドが `InternalIterator::next()` に相当する機能です。
68     * ループの各反復処理の最後に呼び出されます。
69     */
70    public function next(): void
71    {
72        $this->position++;
73    }
74}
75
76// 反復処理の対象となるデータ
77$items = [
78    'id-1' => 'PHP',
79    'id-2' => 'JavaScript',
80    'id-3' => 'Next.js',
81];
82
83// カスタムイテレータのインスタンスを生成
84$iterator = new CustomDataIterator($items);
85
86// foreach ループでイテレータを使用します。
87// 内部では rewind(), valid(), current(), key(), next() が自動的に呼び出されます。
88foreach ($iterator as $key => $value) {
89    echo "{$key}: {$value}" . PHP_EOL;
90}
91
92?>

このPHPサンプルコードは、foreachループが配列などの要素を順番に処理する内部的な仕組みを解説するものです。PHPの組み込みクラスで使われるInternalIterator::next()メソッドの動作を理解するため、同様の機能を持つIteratorインターフェースを実装したCustomDataIteratorクラスを作成しています。

このコードの中心となるのがnext()メソッドです。このメソッドの役割は、イテレータ（反復処理を行うオブジェクト）が指し示している内部的な位置を、現在の要素から次の要素へと一つ進めることです。サンプルコード内の$this->position++という記述がこの処理に該当します。next()メソッドは引数を取らず、特定の値を返すこともないため戻り値はvoidとなります。その目的は、単にオブジェクトの内部状態を更新することにあります。

foreachループが実行されると、ループの各処理が終わるたびにこのnext()メソッドが自動的に呼び出されます。そして、次のループ処理の開始時にvalid()メソッドで次の要素が存在するかを確認し、存在すれば処理を続行します。このようにnext()メソッドは、foreachがコレクションの全要素を順番に辿るための、前に進む一歩の役割を担っています。