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

Copy
1<?php
2// readline拡張機能が有効になっているかを確認します。
3// この機能は通常CLI環境で利用され、php.iniで有効にする必要があります。
4if (!extension_loaded('readline')) {
5    echo "エラー: 'readline' 拡張機能がロードされていません。\n";
6    echo "php.iniファイルで 'extension=readline' の行を有効にしてください。\n";
7    exit(1);
8}
9
10/**
11 * PHPのreadline_redisplay関数の使用例。
12 *
13 * readline_redisplay関数は、Readlineが管理する現在の入力行を画面に再表示するために使用されます。
14 * 主に、Readlineのプロンプトや入力内容が外部からの出力によって乱れた場合や、
15 * プロンプト自体を動的に変更して即座に反映させたい場合に役立ちます。
16 *
17 * この例では、ユーザーが入力している最中にプロンプトを変更し、その変更を
18 * readline_redisplay関数で即座に画面に反映させる様子を示します。
19 */
20function demonstrateReadlineRedisplayUsage(): void
21{
22    echo "Readlineセッションを開始します。入力待ちの間にプロンプトが変更されます。\n";
23    echo "変更後もそのまま入力するか、Enterキーを押して終了してください。\n";
24
25    // Readlineの履歴を追加します（これは必須ではありませんが、一般的な使い方です）。
26    readline_add_history("コマンド1");
27    readline_add_history("コマンド2");
28
29    // readline_callback_handler_install を使ってReadlineを非同期モードで開始します。
30    // これにより、ユーザーが入力している最中に他の処理を行ったり、プロンプトを
31    // 動的に変更したりできます。ユーザーがEnterキーを押すと、このコールバック関数が実行されます。
32    $initialPrompt = "入力 (初期プロンプト)> ";
33    readline_callback_handler_install($initialPrompt, function(?string $line) {
34        if ($line !== null) {
35            echo "\n入力された内容: " . $line . "\n";
36        } else {
37            echo "\n入力がキャンセルされました。\n";
38        }
39        // Readlineセッションを終了するためにコールバックハンドラを削除します。
40        readline_callback_handler_remove();
41    });
42
43    echo "\n何か入力してください。2秒後にプロンプトが更新されます。\n";
44
45    // ユーザーが入力している間に、別の処理が行われる状況をシミュレートします。
46    // ここでは、一時停止してプロンプトを変更します。
47    sleep(2); // 2秒間待機
48
49    // 新しいプロンプト文字列を設定します。
50    $newPrompt = "入力 (更新プロンプト)> ";
51    readline_set_prompt($newPrompt);
52
53    // readline_redisplay() を呼び出して、変更されたプロンプトを即座に画面に反映させます。
54    // ユーザーが入力中の文字列はそのままに、プロンプト部分のみが更新されます。
55    // この関数は引数を取りません。
56    readline_redisplay();
57
58    echo "プロンプトが更新されました！引き続き入力するか、Enterキーを押してください。\n";
59
60    // ユーザーがEnterキーを押す（コールバックが呼ばれ、ハンドラが削除される）まで、
61    // Readlineのイベントループを続行します。
62    while (readline_callback_handler_is_install()) {
63        readline_callback_read_char();
64    }
65
66    echo "スクリプトが終了しました。\n";
67}
68
69// サンプル関数の実行
70demonstrateReadlineRedisplayUsage();

PHPのreadline_redisplay関数は、コマンドラインインターフェース（CLI）でユーザーからの入力を扱うreadline拡張機能が提供する便利な機能です。この関数は引数を一切取らず、また特定の値を返すこともありません（void）。その主な目的は、readlineライブラリが現在管理している入力行の内容を、画面に再表示することにあります。

この関数は、特にインタラクティブなCLIアプリケーションにおいて役立ちます。たとえば、ユーザーが何かのテキストを入力している最中に、プログラムが状況に応じてプロンプト（「>」のような入力待ちを示す文字列）を動的に変更したい場合が考えられます。readline_set_prompt関数でプロンプトを変更した後、readline_redisplayを呼び出すことで、ユーザーが入力中の内容はそのままに、新しいプロンプトを直ちに画面へ反映させることができます。また、プログラムの実行中に他の出力が表示され、ユーザーの入力行の表示が乱れてしまった場合にも、readline_redisplayを使うことで元の状態に整え直すことが可能です。これにより、ユーザーは常に正しい入力インターフェースを見ながら作業を続けることができます。

Copy
1<?php
2
3/**
4 * readline_redisplay関数のサンプルコード
5 *
6 * この関数は、PHPのreadline拡張機能が提供する入力バッファの内容を
7 * ユーザーのターミナル上に再表示するために使用されます。
8 *
9 * 主に、プログラムがユーザーの入力中にバッファの内容をプログラム的に変更した場合に、
10 * その変更を画面に反映させる目的で利用されます。
11 *
12 * @param string $prompt 表示するプロンプト文字列
13 */
14function demonstrateReadlineRedisplay(string $prompt): void
15{
16    // 1. readline 拡張が有効かチェックします。
17    //    この拡張がなければ、readline_redisplayを含む関連関数は動作しません。
18    if (!extension_loaded('readline')) {
19        echo "エラー: readline 拡張が有効になっていません。\n";
20        echo "PHPの設定 (php.ini) を確認し、CLI (コマンドラインインターフェース) 環境で実行してください。\n";
21        return;
22    }
23
24    echo "--- readline_redisplay デモンストレーション --- \n";
25    echo "ヒント: 'hello' と入力すると、自動で ' World!' が追加され、画面が更新されます。\n";
26    echo " 'exit' と入力してデモを終了します。\n\n";
27
28    // 2. readline_callback_handler_install を使用して、
29    //    非同期的な入力処理を設定します。
30    //    ユーザーがキーを押すたびに、ここで定義された無名関数がコールバックとして呼び出されます。
31    readline_callback_handler_install($prompt, function() {
32        // 2.1. readline_callback_read_char() を呼び出し、入力された文字を処理し、
33        //      readlineの内部バッファを更新します。
34        //      これを怠ると、バッファが更新されず、以下の処理が無意味になります。
35        readline_callback_read_char();
36
37        // 2.2. 現在のreadlineバッファの内容 (ユーザーがタイプ中の文字列) を取得します。
38        $currentBuffer = readline_info('line_buffer');
39
40        // 2.3. 特定の条件が満たされた場合に、バッファをプログラム的に操作する例。
41        //      ここでは、ユーザーが 'hello' で始まる文字列を入力し、
42        //      まだ ' World!' が追加されていない場合に実行します。
43        if (str_starts_with($currentBuffer, 'hello') && !str_contains($currentBuffer, ' World!')) {
44            // 2.4. readline_insert_text() を使用して、
45            //      現在のカーソル位置にテキスト (' World!') を挿入します。
46            //      これにより、readlineの内部バッファが変更されます。
47            readline_insert_text(' World!');
48
49            // 2.5. readline_redisplay() を呼び出して、
50            //      変更されたreadlineバッファの内容をターミナルに再表示します。
51            //      この関数がなければ、ユーザーは追加された ' World!' をリアルタイムで見ることができません。
52            readline_redisplay();
53        }
54    });
55
56    // 3. メインループ: ユーザーがEnterキーを押して入力を確定するのを待ちます。
57    while (true) {
58        // 3.1. readline_read_and_dispatch() を呼び出して、
59        //      入力イベントを待ち、発生したイベントを上記で登録したコールバックにディスパッチします。
60        //      この関数は入力があるまでブロック (待機) します。
61        readline_read_and_dispatch();
62
63        // 3.2. ユーザーがEnterキーを押して入力が確定すると、
64        //      readline_info('line_buffer') は最終的な入力文字列を返します。
65        $line = readline_info('line_buffer');
66
67        // 3.3. 次のプロンプトのために、readlineのメッセージを再度設定します。
68        //      これは、前の入力後のバッファ状態をクリアするための一貫した方法です。
69        readline_set_message($prompt);
70
71        // 3.4. 終了条件のチェック
72        if (strtolower(trim($line)) === 'exit') {
73            echo "デモンストレーションを終了します。\n";
74            break;
75        }
76
77        echo "確定された入力: " . $line . "\n\n";
78    }
79
80    // 4. readline_callback_handler_remove() を呼び出して、
81    //    設定したコールバックハンドラをアンインストールし、
82    //    readlineの通常の動作 (ブロックする readline() 関数) に戻します。
83    readline_callback_handler_remove();
84}
85
86// サンプル関数の実行
87demonstrateReadlineRedisplay("あなたの名前を入力してください: ");

PHPのreadline_redisplay関数は、コマンドラインインターフェース（CLI）環境でユーザーからの入力を扱う際に利用されるreadline拡張機能に属します。この関数は引数を取らず、戻り値もありません（void）。

主な役割は、PHPのreadline拡張機能が内部的に保持している「入力バッファ」の内容を、現在のカーソル位置からユーザーのターミナル画面に再表示することです。通常、ユーザーがキーボードで文字を入力すると、その文字は自動的に画面に表示されます。しかし、プログラムがreadline_insert_textのような他の関数を使って、この入力バッファの内容をプログラム的に変更した場合、その変更はリアルタイムでは画面に反映されません。

readline_redisplay関数は、このような状況で利用されます。プログラムが入力バッファの内容を更新した後、この関数を呼び出すことで、変更された最新のバッファ内容を即座にユーザーの画面に表示し、あたかもユーザーが入力したかのように見せることができます。

サンプルコードでは、ユーザーが「hello」と入力し始めると、プログラムが自動的に「 World!」という文字列をバッファに追加し、その直後にreadline_redisplayを呼び出しています。これにより、ユーザーの画面には入力途中で「 World!」が追加された状態がリアルタイムで表示され、入力補完のような体験を提供します。この関数は、readline拡張機能がPHPに読み込まれている環境でのみ機能します。