【PHP8.x】T_YIELD_FROM定数の使い方

Copy
1<?php
2
3/**
4 * T_YIELD_FROM 定数の値とそれが表すトークン名を表示します。
5 * この定数はPHPの内部で 'yield from' 構文を表すトークンIDとして使用されます。
6 * 通常、開発者が直接この定数を使用することは稀で、パーサーなどのツールが利用します。
7 */
8if (defined('T_YIELD_FROM')) {
9    echo "T_YIELD_FROM 定数の値: " . T_YIELD_FROM . PHP_EOL;
10    echo "T_YIELD_FROM は '" . token_name(T_YIELD_FROM) . "' を表します。" . PHP_EOL . PHP_EOL;
11} else {
12    echo "T_YIELD_FROM 定数は定義されていません。PHP 7.0 以降が必要です。" . PHP_EOL . PHP_EOL;
13}
14
15/**
16 * 子ジェネレータ関数。
17 * シンプルな数値シーケンスを生成します。
18 * @return Generator
19 */
20function generateChildSequence(): Generator
21{
22    yield 10;
23    yield 20;
24    yield 30;
25}
26
27/**
28 * 親ジェネレータ関数。
29 * 'yield from' を使用して、generateChildSequence ジェネレータからの値を委譲します。
30 * これにより、複数のジェネレータを効率的に合成できます。
31 * @return Generator
32 */
33function generateParentSequence(): Generator
34{
35    yield "--- 親ジェネレータ開始 ---";
36
37    // yield from を使用して、generateChildSequence からのすべての値を委譲します。
38    // 親ジェネレータは、子ジェネレータがすべての値を生成し終えるまで一時停止します。
39    yield from generateChildSequence();
40
41    yield "--- 親ジェネレータ終了 ---";
42    yield 40;
43}
44
45// 親ジェネレータを実行し、生成されたすべての値を出力します。
46echo "generateParentSequence() の実行結果:" . PHP_EOL;
47foreach (generateParentSequence() as $value) {
48    echo $value . PHP_EOL;
49}
50
51?>

このPHPコードは、T_YIELD_FROM定数とyield from構文の二つの主要な要素について解説しています。

まず、T_YIELD_FROMはPHPの内部で使用される定数で、yield fromキーワードを表す整数値を持ちます。この定数は主にPHPのパーサー（コードを解析する部分）が利用し、開発者が直接コード中で使うことは稀です。token_name()関数を使うと、この数値がどのキーワードに対応するかを確認できます。戻り値は整数型（int）です。

次に、yield from構文について説明します。PHPのジェネレータは、yieldキーワードを使って値を一つずつ生成し、最終的にGeneratorオブジェクトを返します。yield fromは、あるジェネレータ（親ジェネレータ）が別のジェネレータ（子ジェネレータ）に値の生成を「委譲」する際に使用します。

サンプルコードのgenerateChildSequence()関数は、シンプルな数値シーケンスを生成する子ジェネレータです。一方、generateParentSequence()関数は、yield from generateChildSequence();と記述することで、子ジェネレータが生成するすべての値を、自身が生成したかのように扱います。これにより、親ジェネレータは子ジェネレータがすべての値を生成し終えるまで一時停止し、その後に自身の処理を再開します。

このようにyield fromを利用することで、複数のジェネレータを効率的に結合し、複雑なデータ生成処理を分かりやすく記述できます。これは、特にメモリを効率的に使用したい場合や、大きなデータセットを扱う場合に役立つ機能です。

Copy
1<?php
2
3/**
4 * サブジェネレーター関数。
5 * いくつかの英字を生成します。
6 */
7function subGenerator(): Generator
8{
9    yield 'A';
10    yield 'B';
11    yield 'C';
12}
13
14/**
15 * メインジェネレーター関数。
16 * 'yield from' を使用してサブジェネレーターに処理を委譲し、
17 * その後に自身の値を生成します。
18 */
19function mainGenerator(): Generator
20{
21    yield 'メイン開始'; // メインジェネレーターからの最初の値
22    // subGenerator から生成される値をすべて順に yield します。
23    // 'T_YIELD_FROM' が表すこの構文により、他のジェネレーターの処理を組み込めます。
24    yield from subGenerator();
25    yield 'メイン終了'; // メインジェネレーターからの最後の値
26}
27
28// mainGenerator を呼び出し、生成される値をループして表示します。
29echo "ジェネレーターからの出力:\n";
30foreach (mainGenerator() as $value) {
31    echo $value . "\n";
32}

PHPのT_YIELD_FROMは、PHP 8の内部で定義されている定数の一つです。これは、プログラムが解析される際にyield fromという特別な構文が使われていることを識別するために内部的に利用されます。開発者がこの定数を直接コード内で使用することはありませんが、その存在はyield fromの機能と深く関連しています。この定数の戻り値は整数型（int）です。

yield from構文は、ジェネレーター関数内で別のジェネレーターが生成する値を、あたかも現在のジェネレーターが直接生成しているかのように委譲する機能を提供します。これにより、複数のジェネレーターの処理を繋ぎ合わせ、複雑なデータの生成ロジックをシンプルに記述できるようになります。

サンプルコードでは、まずsubGenerator関数が'A'、'B'、'C'という文字列を順に生成するジェネレーターとして定義されています。次に、mainGenerator関数が定義されており、この関数は最初に'メイン開始'という値を生成します。その後に記述されているyield from subGenerator();という部分がT_YIELD_FROMが表す構文で、これによりsubGeneratorが生成する全ての値（'A'、'B'、'C'）が、mainGeneratorから順に生成されます。最後にmainGeneratorは'メイン終了'を生成して処理を終えます。

この結果、プログラムを実行すると、mainGeneratorからの出力として「メイン開始」「A」「B」「C」「メイン終了」がこの順序で表示され、yield fromの機能によって、別のジェネレーターの値を効率的に組み込めることがわかります。