【PHP8.x】stream_isatty()関数の使い方

Copy
1<?php
2
3/**
4 * 標準入力(STDIN)からの入力を監視し、stream_isattyとstream_selectの使用例を示します。
5 *
6 * この関数は、STDINが対話型端末であるかを確認し、
7 * その後、STDINからの入力をノンブロッキングで監視します。
8 * 入力があればそれを読み込み、コンソールに出力します。
9 * プログラムはCtrl+Cで終了できます。
10 */
11function monitorStdinWithStreamFunctions(): void
12{
13    $stdin = STDIN;
14
15    // stream_isatty() を使用して、STDINが対話型端末に関連付けられているかを確認します。
16    // パイプやファイルリダイレクトの場合は 'false' を返します。
17    if (stream_isatty($stdin)) {
18        echo "標準入力は対話型端末に関連付けられています。\n";
19        echo "何か入力してEnterキーを押してください (終了するには Ctrl+C)。\n";
20    } else {
21        echo "標準入力は対話型端末に関連付けられていません (例: パイプ、ファイルリダイレクト)。\n";
22        echo "入力があるか監視します (終了するには Ctrl+C)。\n";
23    }
24
25    // stream_select() を効率的に使用するため、STDINをノンブロッキングモードに設定します。
26    stream_set_blocking($stdin, false);
27
28    $read = [$stdin]; // 読み込みを監視するストリームの配列
29    $write = [];       // 書き込みを監視するストリーム (今回は使用しません)
30    $except = [];      // 例外を監視するストリーム (今回は使用しません)
31
32    echo "入力監視を開始します...\n";
33
34    // 無限ループでSTDINからの入力を監視します。
35    while (true) {
36        // stream_select() は引数の配列を変更するため、ループごとに元の配列をコピーします。
37        $readableStreams = $read;
38
39        // stream_select() を使用して、指定されたストリームが読み込み可能になるのを待ちます。
40        // 第4引数はタイムアウト秒数、第5引数はタイムアウトマイクロ秒数です。
41        // ここでは1秒間のタイムアウトを設定しています。
42        $numChangedStreams = stream_select($readableStreams, $write, $except, 1);
43
44        if ($numChangedStreams === false) {
45            // エラーが発生した場合
46            echo "エラー: stream_select() の実行中に問題が発生しました。\n";
47            break;
48        } elseif ($numChangedStreams > 0) {
49            // 読み込み可能なストリームがある場合
50            foreach ($readableStreams as $stream) {
51                if ($stream === $stdin) {
52                    // STDINから1行読み込みます。
53                    $input = fgets($stdin);
54
55                    if ($input === false) {
56                        // EOF (ファイルの終端) または読み込みエラーの場合
57                        echo "標準入力が閉じられました。プログラムを終了します。\n";
58                        break 2; // 外側のループも終了
59                    }
60
61                    $input = trim($input); // 余分な空白や改行を削除
62
63                    if (!empty($input)) {
64                        echo "入力されました: " . $input . "\n";
65                    }
66                }
67            }
68        }
69        // タイムアウトし、読み込み可能なストリームがない場合は、次のループに進みます。
70        // 無駄なCPU使用を避けるため、短い間隔で待機することもできます。
71        // usleep(100000); // 0.1秒待機
72    }
73
74    echo "監視が終了しました。\n";
75}
76
77// 関数を実行します。
78monitorStdinWithStreamFunctions();

このPHPサンプルコードは、標準入力（STDIN）の状態を確認し、ユーザー入力を効率的に監視する方法をシステムエンジニアを目指す初心者の方向けに示しています。

まず、stream_isatty($stream)関数は、引数として渡されたストリーム（ここではSTDIN）が対話型端末（キーボードなど）に関連付けられているかを確認し、その結果を真偽値（bool）で返します。これにより、プログラムがユーザーと直接対話しているのか、それともパイプやファイルから入力を受け取っているのかを判別できます。

次に、STDINをノンブロッキングモードに設定します。これは、stream_select関数を効率的に使用するために不可欠です。stream_select()は、監視対象のストリームが読み込み可能になったり、書き込み可能になったり、例外が発生したりするのを待つ関数で、指定されたタイムアウト時間までCPUを占有せずに待機できます。この関数は、監視対象のストリームの配列を引数に取り、イベントが発生したストリームのみをその配列に残し、実際にイベントが発生したストリームの数を整数値で返します。

サンプルコードでは、stream_selectを1秒のタイムアウトで繰り返し実行し、STDINからの入力を監視しています。入力があればそれを読み込み、コンソールに表示します。これらの関数を組み合わせることで、ユーザーからの入力を待つ間も他の処理を続けたり、複数の入出力を同時に処理したりするCLIアプリケーションなどを効率的に構築できるようになります。

Copy
1<?php
2
3/**
4 * PHPのストリーム操作の基本例
5 *
6 * このサンプルコードは、以下の二つの関数に焦点を当てています。
7 * - stream_isatty(): 標準出力がターミナルに接続されているか（インタラクティブな環境か）を判断します。
8 * - stream_set_timeout(): ストリームの読み込み操作に時間制限を設定します。
9 *
10 * システムエンジニアを目指す初心者向けに、それぞれの関数の基本的な使い方と、
11 * 異なるストリーム（標準出力、標準入力）での適用方法を示します。
12 *
13 * PHP 8 で動作確認済み。
14 */
15function demonstrateStreamCapabilities(): void
16{
17    // -------------------------------------------------------------------------
18    // stream_isatty() の使用例
19    // 標準出力 (STDOUT) がターミナルに接続されているかを確認します。
20    // コマンドラインから実行した場合（例: php your_script.php）は通常 true を返しますが、
21    // Webサーバーから実行された場合や、出力をファイルにリダイレクトした場合などは false を返します。
22    // -------------------------------------------------------------------------
23    echo "--- stream_isatty のデモンストレーション ---\n";
24    if (stream_isatty(STDOUT)) {
25        echo "標準出力はターミナルに接続されています。\n";
26        echo "インタラクティブな表示（例: \033[32m色付きテキスト\033[0m）が可能です。\n";
27    } else {
28        echo "標準出力はターミナルに接続されていません。\n";
29        echo "通常のテキスト出力が行われます。\n";
30    }
31    echo "\n";
32
33    // -------------------------------------------------------------------------
34    // stream_set_timeout() の使用例
35    // 標準入力 (php://stdin) からの読み込みにタイムアウトを設定します。
36    // プログラムがユーザーからの入力を待つ時間を制限するために使用されます。
37    // -------------------------------------------------------------------------
38    echo "--- stream_set_timeout のデモンストレーション ---\n";
39    echo "標準入力から何か入力してください (5秒でタイムアウトします)。\n";
40
41    // 標準入力ストリームを開く
42    $stdin = fopen('php://stdin', 'r');
43    if ($stdin === false) {
44        echo "エラー: 標準入力ストリームを開けませんでした。\n";
45        return;
46    }
47
48    // 標準入力ストリームに5秒のタイムアウトを設定 (秒, マイクロ秒)
49    if (stream_set_timeout($stdin, 5, 0)) {
50        echo "標準入力に5秒のタイムアウトを設定しました。\n";
51    } else {
52        echo "エラー: タイムアウトの設定に失敗しました。\n";
53        fclose($stdin);
54        return;
55    }
56
57    $startTime = microtime(true);
58    // 標準入力から一行読み込む
59    $inputLine = fgets($stdin);
60    $endTime = microtime(true);
61
62    // ストリームのメタデータを取得して、タイムアウトしたかを確認
63    $metadata = stream_get_meta_data($stdin);
64
65    if ($metadata['timed_out']) {
66        echo "読み込みがタイムアウトしました。経過時間: " . round($endTime - $startTime, 2) . "秒\n";
67    } elseif ($inputLine !== false) {
68        echo "入力されました: '" . trim($inputLine) . "'。経過時間: " . round($endTime - $startTime, 2) . "秒\n";
69    } else {
70        echo "標準入力の読み込み中にエラーが発生しました。\n";
71    }
72
73    // ストリームを閉じる
74    fclose($stdin);
75}
76
77// デモンストレーション関数を実行
78demonstrateStreamCapabilities();

このPHPサンプルコードは、ストリーム操作に役立つ二つの関数、stream_isattyとstream_set_timeoutの基本的な使い方をデモンストレーションしています。

まず、stream_isatty関数は、指定されたストリームがターミナル（インタラクティブな環境）に接続されているかどうかを判断します。引数にはresource型のストリーム（例: STDOUT）を渡し、戻り値はbool型で、ターミナル接続時はtrue、それ以外はfalseを返します。これにより、コマンドラインからの実行時に色付きテキストを表示するなど、インタラクティブな出力を制御できます。Webサーバー経由やファイルへのリダイレクト時はfalseを返すことが多いです。

次に、stream_set_timeout関数は、ストリームからの読み込み操作に時間制限を設定します。引数にはresource型のストリーム（例: php://stdin）、タイムアウト秒数、マイクロ秒数を指定します。戻り値は設定が成功したかを示すbool型です。この機能は、ユーザーからの入力待ちなど、I/O操作が長時間ブロックされるのを防ぎ、プログラムの安定性を高めるために利用されます。サンプルでは、標準入力からの読み込みに5秒のタイムアウトを設定し、stream_get_meta_data関数でタイムアウトしたかどうかを確認する例を示しています。

これらの関数は、システムの入出力処理を柔軟に制御し、さまざまな実行環境に対応した堅牢なアプリケーションを開発する際に役立ちます。