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

Copy
1<?php
2
3// readline_callback_handler_install を使用して、非同期でユーザー入力を処理するサンプルコードです。
4// このスクリプトはCLI（コマンドラインインターフェース）環境でのみ動作します。
5// 実行にはPHPの'readline'拡張が有効になっている必要があります。
6
7// プログラムの終了を制御するためのフラグ
8$should_exit = false;
9
10/**
11 * readline_callback_handler_install で登録されるコールバック関数。
12 * ユーザーがプロンプトに対して入力し、Enterキーを押したときに呼び出されます。
13 *
14 * @param string $line ユーザーが入力した文字列
15 * @return void
16 */
17$input_callback = function (string $line): void {
18    // グローバルスコープの $should_exit 変数にアクセスするため 'global' を使用
19    global $should_exit; 
20
21    // 入力された文字列の先頭と末尾の空白を除去
22    $trimmed_line = trim($line);
23
24    // ユーザーの入力内容を表示
25    echo "入力されました: " . $trimmed_line . "\n";
26
27    // "exit" と入力されたらプログラムを終了
28    if (strtolower($trimmed_line) === 'exit') {
29        echo "プログラムを終了します。\n";
30        $should_exit = true; // 終了フラグを立てる
31    }
32};
33
34// readline_callback_handler_install を使用してコールバックハンドラをインストールします。
35// 最初の引数はユーザーに表示されるプロンプト文字列、2番目の引数は入力があったときに呼び出される関数です。
36if (readline_callback_handler_install("入力してください (終了するには 'exit' と入力): ", $input_callback)) {
37    echo "非同期入力ハンドラがインストールされました。\n";
38    echo "プロンプトが表示されたら文字を入力し、Enterキーを押してください。\n";
39
40    // プログラムが終了するまで、入力イベントを処理するためのループを回します。
41    while (!$should_exit) {
42        // readline_callback_read_char を呼び出すことで、readlineの入力イベントキューを処理します。
43        // これにより、ユーザーの入力がコールバック関数に渡されます。
44        // この関数は非ブロッキングなので、入力がなくてもすぐに制御を返します。
45        readline_callback_read_char();
46
47        // CPUの使用率を抑えるため、短時間（100ミリ秒）スリープします。
48        usleep(100000); 
49    }
50
51    // プログラム終了時に、インストールしたコールバックハンドラを解除します。
52    readline_callback_handler_remove();
53    echo "非同期入力ハンドラが解除されました。\n";
54} else {
55    echo "エラー: readline_callback_handler_install に失敗しました。\n";
56    echo "PHPの'readline'拡張が有効になっているか確認してください。\n";
57}
58
59?>

PHP 8のreadline_callback_handler_install関数は、コマンドラインインターフェース（CLI）環境において、ユーザーからの入力を非同期で処理するためのコールバックハンドラをインストールするために使用されます。

この関数は、ユーザーに表示するプロンプト文字列を$prompt引数として受け取ります。そして、ユーザーがこのプロンプトに対して文字を入力し、Enterキーを押したときに実行される関数を$callback引数として登録します。登録されたコールバック関数には、ユーザーが入力した文字列が自動的に引数として渡されます。関数の戻り値はブール値で、ハンドラのインストールが成功した場合はtrue、失敗した場合はfalseを返します。通常、PHPのreadline拡張が有効でない場合にインストールが失敗します。

提供されたサンプルコードは、"入力してください..."というプロンプトをユーザーに表示し、ユーザーが入力した内容を画面に表示する例です。「exit」と入力された場合はプログラムを終了するように制御されています。readline_callback_handler_installでハンドラをインストールした後、whileループ内でreadline_callback_read_char()を繰り返し呼び出すことで、ユーザーの入力イベントを監視し、入力があった際に登録したコールバック関数（$input_callback）が実行されるようにしています。プログラムの終了時には、必ずreadline_callback_handler_remove()関数を呼び出して、インストールしたハンドラを解除する必要があります。これにより、CLIアプリケーションでインタラクティブなユーザー入力処理を効率的に実装できるようになります。

Copy
1<?php
2
3// グローバル変数でループの実行状態を管理します。
4// コールバック関数からこの変数を変更して、対話モードを終了させます。
5$running = true;
6
7/**
8 * ユーザーがEnterキーを押したときに呼び出されるコールバック関数。
9 *
10 * @param string $line ユーザーが入力した文字列
11 */
12function handleInput(string $line): void
13{
14    global $running;
15
16    $trimmedLine = strtolower(trim($line));
17
18    if ($trimmedLine === 'exit') {
19        echo "Exiting interactive mode.\n";
20        $running = false; // ループ終了フラグを設定
21        // コールバックハンドラを削除します。
22        // これにより、以降の readline_callback_read_char() 呼び出しは効果がなくなります。
23        readline_callback_handler_remove();
24    } else {
25        echo "You entered: " . $line . "\n";
26        // 必要に応じて、ここでさらに処理を行うことができます。
27        // 例: readline_add_history($line); // 入力履歴に追加
28    }
29}
30
31// readline_callback_handler_install を使用してコールバックハンドラをインストールします。
32// これにより、「readline_callback_read_char() called with no handler」というエラーを回避できます。
33// 第1引数はプロンプト文字列、第2引数はユーザーがEnterを押したときに実行される関数です。
34if (readline_callback_handler_install('PHP> ', 'handleInput')) {
35    echo "Interactive PHP console started. Type 'exit' to quit.\n";
36
37    // コールバックモードで入力を継続的に監視します。
38    // readline_callback_read_char() は、入力バッファに文字がある場合にそれを処理し、
39    // 必要に応じてインストールされたコールバックを呼び出します。
40    // 入力がない場合でもブロックせず、すぐに制御を返します。
41    while ($running) {
42        readline_callback_read_char();
43        // CPU使用率を抑えるため、短い時間スリープします。
44        // 実際のアプリケーションでは、イベントループや非同期I/Oと組み合わせることが多いです。
45        usleep(100000); // 0.1秒 (100ミリ秒) 待機
46    }
47} else {
48    echo "Failed to install readline callback handler.\n";
49}
50
51?>

readline_callback_handler_install関数は、PHPでユーザーと対話するコマンドラインプログラムを作成する際に使われる重要な関数です。この関数を呼び出すことで、ユーザーからの入力をリアルタイムで受け付けて処理するための「コールバックハンドラ」を設定します。これにより、「readline_callback_read_char() called with no handler」というエラーの発生を防ぐことができます。

第1引数には、ユーザーに入力を促す「プロンプト」となる文字列を指定します（例: PHP> ）。第2引数には、ユーザーが何かを入力してEnterキーを押したときに自動的に呼び出される「コールバック関数」を指定します。この関数は、ユーザーの入力文字列を引数として受け取ります。関数のインストールが成功すればtrueが、失敗すればfalseが戻り値として返されます。

サンプルコードでは、handleInputという関数がコールバックとして設定されています。プログラムは、readline_callback_handler_installでこのハンドラを設定した後、whileループの中でreadline_callback_read_char()を繰り返し実行し、ユーザーからの入力を待ち続けます。ユーザーが「exit」と入力すると、handleInput関数がそれを検知し、readline_callback_handler_remove()を呼び出して対話モードを終了させます。これにより、ユーザーとの双方向な対話を通じて操作を進めるアプリケーションが実現可能です。