Php/docs/function.readline-callback-handler-install

提供:Dev Guides
< Php
移動先:案内検索

readline_callback_handler_install

(PHP 5 >= 5.1.0, PHP 7)

readline_callback_handler_install readline コールバックインターフェイスと端末を初期化し、 プロンプトを表示して結果をすぐに返す


説明

readline_callback_handler_install ( string $prompt , callable $callback ) : bool

readline コールバックインターフェイスを設定し、プロンプト prompt を表示して入力を受け取ります。 コールバック関数 callback はひとつのパラメータを とり、そこにはユーザーの入力内容が格納されます。一度登録したコールバック インターフェイスを削除せずもういちどこの関数をコールした場合、もとの インターフェイスは自動的に上書きされます。

コールバック機能は stream_select() と組み合わせると 有用です。これは readline() とは異なり、 IO とユーザーの入力を交互に取り扱います。


パラメータ

prompt
確認メッセージ。
callback
callback 関数が受け取るパラメータはひとつで、 ユーザーから返された入力です。


返り値

成功した場合に true を、失敗した場合に false を返します。


例1 Readline コールバックインターフェイスの例

<?phpfunction rl_callback($ret){    global $c, $prompting;    echo "You entered: $ret\n";    $c++;    if ($c > 10) {        $prompting = false;        readline_callback_handler_remove();    } else {        readline_callback_handler_install("[$c] Enter something: ", 'rl_callback');    }}$c = 1;$prompting = true;readline_callback_handler_install("[$c] Enter something: ", 'rl_callback');while ($prompting) {    $w = NULL;    $e = NULL;    $n = stream_select($r = array(STDIN), $w, $e, null);    if ($n && in_array(STDIN, $r)) {        // read a character, will call the callback when a newline is entered        readline_callback_read_char();    }}echo "Prompting disabled. All done.\n";?>

参考

  • readline_callback_handler_remove() - インストールされたハンドラを削除し、端末の設定をもとに戻す
  • readline_callback_read_char() - 文字を読み込み、改行を受け取ると readline コールバックインターフェイスに通知する
  • stream_select() - select() システムコールと同等の操作を、 ストリームの配列に対して tv_sec と tv_usec で指定されたタイムアウト時間をもって行う