導入

readline 関数群は、GNU Readline ライブラリへの インターフェースを実装したものです。これらの関数は、コマンドラインの 編集機能を提供します。一例をあげると、Bash において文字を挿入したり コマンド履歴を走査したりする際に、矢印キーを使用することを 可能にしているものです。 このライブラリは対話的なものであるため、Web アプリケーションで 使用されることはほとんどないでしょう。しかし、 コマンドライン から PHP を使用するスクリプトを書く際には有用です。
注意: この拡張モジュールは Windows 環境では利用できません。

要件

readline 関数を使用するには、libreadline をインストールすることが 必要です。libreadline は、» https://cnswww.cns.cwru.edu/~chet/readline/rltop.html にある GNU Readline プロジェクトのホームページから入手可能です。このライブラリは、Bash の 作者でもある Chet Ramey により管理されています。
この関数を libeditライブラリで使用することも可能です。これは readline ライブラリの代替品で、非 GPL です。 libeditライブラリは BSD ライセンスで配布され、 » https://www.thrysoee.dk/editline/ から入手可能です。

インストール手順

この関数を使用するには、readline サポートを有効にして CGI 版または CLI 版の PHP をコンパイルする必要があります。PHP の configure に --with-readline[=DIR] を指定する必要が あります。readline の代替品である libedit を使用したい場合、PHP の configure に --with-libedit[=DIR] を指定してください。

実行時設定

設定ディレクティブは定義されていません。

リソース型

リソース型は定義されていません。

定義済み定数

定数は定義されていません。

目次

readline_add_history — ヒストリに 1 行追加する

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

readline_callback_handler_remove — インストールされたハンドラを削除し、端末の設定をもとに戻す

readline_callback_read_char — 文字を読み込み、改行を受け取ると readline コールバックインターフェースに通知する

readline_clear_history — ヒストリをクリアする

readline_completion_function — 補完関数を登録する

readline_info — 種々の readline の内部変数を取得/設定する

readline_list_history — ヒストリを一覧表示する

readline_on_new_line — カーソルが新しい行に移動したことを readline に通知する

readline_read_history — ヒストリを読み込む

readline_redisplay — 画面を再描画する

readline_write_history — ヒストリを書きこむ

readline — 一行読み込む

(PHP 4, PHP 5)
readline — 一行読み込む

説明

string readline ( [string prompt] )
ユーザからの入力を一行読み込みます。 この行を readline_add_history(). を用いてヒストリに追加する必要があります。

パラメータ

prompt

ユーザに示す確認文字列を指定します。

返り値

ユーザから取得した文字列を一つだけ返します。 返り値の最後の改行は取り除かれます。

例

例 1930. readline() の例
<?php
// ユーザから 3 回コマンドを取得
for ($i=0; $i < 3; $i++) {
       $line = readline("Command: ");
       readline_add_history($line);
}

// ヒストリをダンプ
print_r(readline_list_history());

// 変数をダンプ
print_r(readline_info());
?>