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

Copy
1<?php
2
3/**
4 * PHPのreadline拡張機能を使用したインタラクティブなシェルデモを実行します。
5 *
6 * readline_callback_read_char() 関数は、readlineが非同期にターミナル入力を
7 * 処理できるように、入力バッファから1文字を読み取るよう指示します。
8 * これは通常、イベントループ内で定期的に呼び出され、ユーザーからの入力を
9 * ブロックせずに受け付けるために使用されます。
10 *
11 * このデモでは、以下の機能を示します:
12 * - readline_callback_handler_install(): 入力ハンドラを設定し、非同期モードを有効にします。
13 * - readline_callback_read_char(): 非同期入力処理を駆動します。
14 * - readline_add_history(): 入力履歴を管理します。
15 * - readline_callback_handler_remove(): ハンドラを解除し、readlineの状態をリセットします。
16 */
17function runInteractiveReadlineDemo(): void
18{
19    // readline拡張がロードされているか確認
20    if (!extension_loaded('readline')) {
21        echo "エラー: PHP readline 拡張がロードされていません。\n";
22        echo "PHPの設定 (php.ini) で 'extension=readline' を有効にするか、\n";
23        echo "PHPのビルド時に '--with-readline' オプションを使用してください。\n";
24        exit(1);
25    }
26
27    // プログラムの終了を制御するためのフラグ
28    $shouldExit = false;
29
30    // ユーザーがEnterを押したときに呼び出されるコールバック関数を定義
31    // このクロージャは $shouldExit 変数を参照 (use (&$shouldExit)) して、プログラムの終了を制御します。
32    $lineHandler = function (?string $line) use (&$shouldExit) {
33        // null が渡された場合は、EOF (通常は Ctrl+D) が入力されたことを意味します。
34        if ($line === null) {
35            echo "EOF (Ctrl+D) が検出されました。終了します。\n";
36            $shouldExit = true;
37            readline_callback_handler_remove(); // ハンドラを解除
38            return;
39        }
40
41        // 入力された文字列の前後の空白を削除
42        $line = trim($line);
43
44        // 特定のコマンドでプログラムを終了
45        if ($line === 'exit') {
46            echo "終了コマンドが入力されました。プログラムを終了します。\n";
47            $shouldExit = true;
48            readline_callback_handler_remove(); // ハンドラを解除
49        } elseif ($line !== '') {
50            // 空ではない入力は履歴に追加し、表示
51            readline_add_history($line);
52            echo "入力されたテキスト: " . $line . "\n";
53        }
54        // readline_callback_handler_install() が設定したプロンプトは自動で再表示されます。
55    };
56
57    // readlineコールバックハンドラをインストールし、readlineをコールバックモードにする
58    // これにより、"プロンプト> " が表示され、$lineHandler がユーザーがEnterを押したときに呼び出されます。
59    readline_callback_handler_install("プロンプト> ", $lineHandler);
60
61    echo "----------------------------------------\n";
62    echo "インタラクティブシェルデモを開始します。\n";
63    echo "「exit」と入力してEnterを押すとプログラムが終了します。\n";
64    echo "「Ctrl+D」でも終了できます。\n";
65    echo "----------------------------------------\n";
66
67    // メインループ: プログラムが終了するまで実行
68    while (!$shouldExit) {
69        // readline_callback_read_char() は、readlineが入力バッファから1文字を読み取るよう指示します。
70        // これは非同期でユーザー入力を処理するために、ループ内で定期的に呼び出す必要があります。
71        // この関数自体は入力をブロックしません。
72        readline_callback_read_char();
73
74        // 他の非ブロッキングな処理（例: ネットワーク通信、ファイル操作など）をここで行うことができます。
75        // この例では、特別な処理は行いません。
76
77        // CPU使用率を抑えるために短い時間スリープ
78        // これにより、ループがCPUを消費し続けるのを防ぎ、システムリソースを効率的に利用します。
79        usleep(100000); // 100ミリ秒 (0.1秒) 待機
80    }
81
82    // プログラム終了時、もしハンドラがまだインストールされている場合は削除する
83    // readline_callback_handler_remove() は、成功した場合は true、
84    // ハンドラがインストールされていない場合は false を返します。
85    if (readline_callback_handler_remove() !== false) {
86        // 既に$lineHandler内でremoveされている可能性もあるため、ここでは追加の処理は不要
87    }
88
89    echo "----------------------------------------\n";
90    echo "プログラムが正常に終了しました。\n";
91    echo "----------------------------------------\n";
92}
93
94// デモ関数を実行
95runInteractiveReadlineDemo();
96
97?>

PHPのreadline_callback_read_char関数は、readline拡張機能の一部で、ターミナルからのユーザー入力を非同期に処理するために使われます。この関数は引数を取らず、戻り値もありません（void）。

この関数は、readline_callback_handler_installによって設定されたコールバックハンドラと組み合わせて使用されます。プログラムのメインループ内でreadline_callback_read_charを定期的に呼び出すことで、PHPはターミナルから1文字ずつ入力を読み取ろうとします。これにより、ユーザーからの入力を待っている間もプログラムの実行がブロックされず、他の処理を並行して行えます。

具体的には、この関数が呼び出されるたびに、入力バッファから利用可能な文字を読み込みます。ユーザーがEnterキーを押すか、Ctrl+D（EOF）が入力されると、登録されたコールバック関数が実行され、入力された内容が処理されます。usleepのような関数と組み合わせてループ内で呼び出すことで、CPUリソースを効率的に使いながら、インタラクティブなコマンドラインインターフェースを構築する際に役立ちます。

Copy
1<?php
2
3/**
4 * CSVデータを読み込み、ユーザーの入力に応じてインタラクティブに表示するCLIツールです。
5 *
6 * この関数は、PHPのreadline拡張機能と、特定の入力イベントを処理するための
7 * readline_callback_read_char() の使用例を組み合わせています。
8 * readline_callback_read_char() は通常、readlineの内部で利用される関数で、
9 * 入力ストリームから1文字を読み込み、readlineライブラリに提供します。
10 * これは、イベント駆動型プログラムでreadlineの動作をカスタマイズする際に役立ちます。
11 *
12 * @return void
13 */
14function process_csv_interactively(): void
15{
16    echo "--- CSVデータ表示ツール ---\n";
17    echo "Enterキーで次の行に進むか、'q' を入力して終了してください。\n";
18    echo "-----------------------------\n";
19
20    // 実際のCSVファイル読み込みの代わりに、シンプルな配列を模擬データとして使用します。
21    // 通常は `fgetcsv` などの関数を使用してファイルからデータを読み込みます。
22    $csv_data = [
23        ['ID', '商品名', '価格'],
24        ['101', 'リンゴ', '120'],
25        ['102', 'バナナ', '80'],
26        ['103', 'ミカン', '60'],
27        ['104', 'ブドウ', '250'],
28    ];
29
30    // readlineコールバックハンドラをインストールします。
31    // readline() 関数がユーザーの入力を待っている間に、
32    // ターミナルで何か入力があると、このコールバック関数が呼び出されます。
33    // 第1引数のプロンプトは空文字列にし、readline() のプロンプトを使用します。
34    readline_callback_handler_install('', function () {
35        // readline_callback_read_char() は、ターミナルから1文字を読み込み、
36        // readlineライブラリの内部バッファに供給します。
37        // この関数は void を返すため、直接文字の値を取得することはできませんが、
38        // 入力があったことを readline に伝え、処理を継続させる役割があります。
39        // 外部のイベントループと readline を統合する際などに特に有用です。
40        readline_callback_read_char();
41
42        // ユーザーが 'q' を入力して終了したい場合を検出します。
43        // readline_info() で現在の入力バッファの内容を確認します。
44        $line_buffer = readline_info('line_buffer');
45        if (str_ends_with($line_buffer, 'q')) {
46            echo "\n'q' が入力されました。処理を中断します。\n";
47            // コールバックハンドラを解除し、スクリプトを終了します。
48            readline_callback_handler_remove();
49            exit(0);
50        }
51    });
52
53    foreach ($csv_data as $index => $row) {
54        // 最初の行（ヘッダー）はそのまま表示し、それ以降はユーザー入力を待ちます。
55        if ($index > 0) {
56            echo "\n--- 次の行を表示します --- (入力待ち)\n";
57            // readline() を呼び出すと、ユーザーからの入力を待ちます。
58            // この入力待ちの間、ユーザーがキーを押すたびに、
59            // 上記で設定したコールバック関数がトリガーされる可能性があります。
60            $input = readline(">");
61            if (strtolower(trim($input)) === 'q') {
62                echo "ユーザーにより処理が中断されました。\n";
63                break; // ループを中断
64            }
65        }
66        echo "行 " . ($index + 1) . ": " . implode(', ', $row) . "\n";
67    }
68
69    // 全ての処理が終了したら、インストールしたコールバックハンドラを解除します。
70    readline_callback_handler_remove();
71    echo "\nCSVデータの表示が完了しました。\n";
72}
73
74// 関数を実行します。
75// このスクリプトはCLI (コマンドラインインターフェース) で実行してください。
76process_csv_interactively();

PHP 8のreadline_callback_read_char関数は、コマンドラインインターフェース（CLI）でユーザーからのインタラクティブな入力を処理するreadline拡張機能の一部です。この関数は引数を取らず、戻り値もありません（void）。その主な役割は、入力ストリームから1文字を読み込み、それをreadlineライブラリの内部バッファに供給することです。これにより、readlineがユーザーのキー入力を認識し、その後の処理を継続できるようになります。

この関数は通常、readline_callback_handler_install関数で設定されたコールバック関数内で使用されます。readline()関数がユーザーからの入力を待機している間に、ユーザーがキーを押すと、このコールバック関数が呼び出されます。その中でreadline_callback_read_charを実行することで、readlineライブラリは入力があったことを検知し、外部のイベントと連携しながら柔軟な入力処理を実現します。

サンプルコードでは、CSVデータをインタラクティブに表示するCLIツールが作成されています。ユーザーがEnterキーで次の行に進んだり、「q」と入力して処理を中断したりする際、この関数が背後で入力処理を支援しています。このように、ユーザーの操作に応じて動的に動作する高度なCLIアプリケーションを構築する際に、この関数が重要な役割を果たします。