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

Copy
1<?php
2
3/**
4 * readline_list_history() 関数を使用して、PHPのコマンドライン履歴を表示するサンプルコードです。
5 * この関数は、readline 拡張機能が有効な場合にのみ利用可能です。
6 */
7
8// readline 拡張機能がロードされているか確認します。
9// ロードされていない場合、この関数は利用できません。
10if (!extension_loaded('readline')) {
11    echo "エラー: 'readline' 拡張機能が有効ではありません。\n";
12    echo "php.ini を確認するか、PHPを'--with-readline'オプション付きでコンパイルしてください。\n";
13    exit(1);
14}
15
16// readline 履歴にいくつかのコマンドを追加します。
17// これにより、readline_list_history() で取得できるデータが作成されます。
18readline_add_history('ls -al');
19readline_add_history('cd /var/www/html');
20readline_add_history('git pull origin main');
21readline_add_history('php artisan migrate');
22
23// readline_list_history() を呼び出して、現在の履歴リストを取得します。
24// この関数は、履歴の各項目を要素とする配列を返します。
25$history = readline_list_history();
26
27// 取得した履歴リストが空でないことを確認し、表示します。
28if (!empty($history)) {
29    echo "現在の readline 履歴:\n";
30    foreach ($history as $index => $command) {
31        // 履歴のインデックスは通常1から始まるため、$index + 1 としています。
32        echo ($index + 1) . ": " . $command . "\n";
33    }
34} else {
35    echo "readline 履歴は空です。\n";
36}
37
38?>

readline_list_history関数は、PHPのコマンドラインインターフェース（CLI）で利用されるreadline拡張機能の一部で、現在のセッションで入力されたコマンドの履歴リストを取得するために使用されます。この関数を利用するには、PHP環境でreadline拡張機能が有効になっている必要があります。有効でない場合、この関数は利用できずエラーが発生します。

readline_list_history関数は引数を取りません。関数を呼び出すと、これまでに履歴として追加された各コマンドの文字列を要素とする配列が戻り値として返されます。サンプルコードでは、まずextension_loaded関数でreadline拡張機能が有効かを確認しています。次に、readline_add_history関数を使用していくつかのダミーコマンドを履歴に追加し、readline_list_historyでその履歴を配列として取得しています。取得された履歴は$history変数に格納され、その配列をループ処理で一つずつ取り出し、コマンドの順序（インデックス）とともに画面に表示しています。これにより、ユーザーは現在のコマンド履歴を一覧で確認することが可能です。もし履歴が空であれば、その旨のメッセージが表示されます。

Copy
1<?php
2
3// readline拡張機能が利用可能かを確認します。
4// readline_list_history関数はこの拡張機能の一部であり、主にPHP CLI (コマンドラインインターフェース) 環境で使われます。
5if (!extension_loaded('readline')) {
6    echo "エラー: PHP readline 拡張機能が有効になっていません。\n";
7    echo "このサンプルコードは、PHP CLI環境でreadline拡張が有効な場合にのみ機能します。\n";
8    exit(1);
9}
10
11// デモンストレーションのために、いくつかの文字列をreadline履歴に追加します。
12// 通常、これらの履歴はユーザーがPHPのインタラクティブシェルなどで入力したコマンドから自動的に生成されます。
13readline_add_history('echo "Hello, PHP!";');
14readline_add_history('var_dump($_SERVER);');
15readline_add_history('$x = 10; $y = 20; echo $x + $y;');
16
17// readline_list_history() 関数を呼び出して、現在の履歴リストを取得します。
18// この関数は引数を取らず、履歴エントリの配列を返します。
19$historyList = readline_list_history();
20
21echo "readline の履歴リスト:\n";
22
23// 取得した履歴リストが配列であり、空でない場合に各履歴エントリを表示します。
24if (is_array($historyList) && !empty($historyList)) {
25    foreach ($historyList as $index => $command) {
26        // 各履歴エントリを1から始まる番号付きで表示します。
27        echo sprintf("%d: %s\n", $index + 1, $command);
28    }
29} else {
30    // 履歴が空の場合、その旨を通知します。
31    echo "履歴は現在空です。\n";
32}
33
34?>

PHPのreadline_list_history関数は、主にPHPのコマンドラインインターフェース（CLI）環境でユーザーが入力したコマンドの履歴を取得するために使用されます。この関数はreadline拡張機能の一部であり、対話型のPHPシェルなどで過去のコマンドを確認したい場合に役立ちます。

この関数は引数を必要とせず、呼び出すだけで現在の履歴リストを自動的に取得します。戻り値は配列形式で、各要素が履歴に保存されているコマンドの文字列となります。履歴が一つもない場合は空の配列が返されます。

サンプルコードでは、まずreadline拡張機能が有効かを確認します。その後、デモンストレーションとしてreadline_add_history関数を使って履歴をいくつか追加しています。そしてreadline_list_historyを呼び出して履歴の配列を取得し、その内容を番号付きで画面に表示しています。これにより、関数が履歴情報をどのように返すかを具体的に確認できます。この関数は、CLI環境でのユーザー入力履歴をプログラム的に操作・表示する際に便利です。