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

Copy
1<?php
2
3/**
4 * readline_write_history 関数の使用例。
5 *
6 * このスクリプトは、ユーザーからの入力を受け取り、
7 * その履歴をファイルに保存する方法を示します。
8 * システムエンジニアを目指す初心者向けに、readline拡張機能の
9 * 基本的な操作を簡潔に示します。
10 */
11function handleReadlineHistory(): void
12{
13    // readline 拡張機能がロードされているかを確認
14    if (!extension_loaded('readline')) {
15        echo "エラー: PHP readline 拡張機能が有効になっていません。\n";
16        echo "php.ini ファイルで 'extension=readline' を有効にするか、\n";
17        echo "PHPの環境を確認してください。\n";
18        exit(1);
19    }
20
21    // 履歴を保存するファイルの名前を定義
22    $historyFileName = 'my_command_history.txt';
23
24    echo "readline 履歴ファイル保存の例を開始します。\n";
25    echo "いくつかのコマンドを入力してください。'exit' と入力すると終了します。\n";
26
27    // ユーザーからの入力を受け付け、履歴に追加
28    while (true) {
29        // readline() 関数でユーザーからの入力を受け取る
30        // 入力された文字列は自動的に readline の履歴に追加される
31        $line = readline("プロンプト> ");
32
33        // 'exit' と入力されたらループを終了
34        if ($line === 'exit') {
35            break;
36        }
37
38        // 空行でない場合のみ、明示的に履歴に追加（readline()が自動追加するため冗長だが、理解のために残す）
39        if (trim($line) !== '') {
40            // readline_add_history() を使って履歴に項目を追加することも可能
41            // readline_add_history($line);
42        }
43    }
44
45    echo "履歴をファイルに書き込み中...\n";
46
47    // readline_write_history() を使って現在の履歴をファイルに保存
48    // 成功した場合は true、失敗した場合は false を返す
49    if (readline_write_history($historyFileName)) {
50        echo "成功: 履歴が '{$historyFileName}' に書き込まれました。\n";
51        echo "このファイルの内容を確認するには、ターミナルで 'cat {$historyFileName}' を実行してください。\n";
52    } else {
53        echo "失敗: 履歴の書き込みに失敗しました。\n";
54        echo "書き込み権限やファイルパスを確認してください。\n";
55    }
56
57    echo "スクリプトを終了します。\n";
58}
59
60// 関数を実行
61handleReadlineHistory();

readline_write_history関数は、PHPのreadline拡張機能が提供する機能の一つで、ユーザーがコマンドラインインターフェース（CLI）で入力した内容の履歴をファイルに保存するために使われます。この関数は、保存先のファイルパスを文字列（$filename）として引数に取ります。この引数を省略した場合、PHPの標準的な履歴ファイルパスが使用されます。処理が正常に完了し履歴がファイルに書き込まれた場合はtrueを、書き込みに失敗した場合はfalseを戻り値として返します。

システムエンジニアを目指す方にとって、CLIツール開発などでユーザーの入力履歴を管理する際に重要な機能です。提供されたサンプルコードでは、まずreadline()関数を使ってユーザーから複数回の入力を受け取ります。これにより入力内容は自動的に内部の履歴に蓄積されます。その後、readline_write_history()を呼び出すことで、蓄積されたすべての入力履歴が指定されたファイルにまとめて書き出されます。この機能を使うことで、スクリプトが終了した後もユーザーの操作履歴が保持され、後の分析や再利用が可能になります。利用する際は、php.iniでreadline拡張機能が有効になっているかを確認してください。

Copy
1<?php
2
3/**
4 * readline_write_history 関数のサンプルコード。
5 *
6 * このスクリプトは、PHP CLI (コマンドラインインターフェース) 環境で
7 * ユーザーからの入力を受け付け、その履歴をファイルに保存する方法を示します。
8 * readline 拡張は、対話的なシェル環境での入力履歴管理に使用されます。
9 */
10
11// readline 拡張がロードされているか確認します。
12// このスクリプトは CLI 環境で readline 拡張が必要です。
13if (!extension_loaded('readline')) {
14    echo "エラー: 'readline' 拡張がロードされていません。CLI環境で実行してください。\n";
15    exit(1);
16}
17
18// 履歴を保存するファイルパスを定義します。
19// システムの一時ディレクトリを使用すると、OSに依存しないパスを作成できます。
20$historyFile = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'php_cli_history.txt';
21
22echo "PHPインタラクティブシェルを開始します ('exit' または 'quit' で終了)。\n";
23
24// ユーザーからの入力を受け付けるループ
25while (true) {
26    // readline() 関数はプロンプトを表示し、ユーザーからの入力を読み込みます。
27    // 入力された文字列は readline の内部履歴バッファに保存されます。
28    $input = readline('PHP > ');
29
30    // 入力が false (EOF) でなく、かつ空でない場合にのみ履歴に追加します。
31    // readline_add_history() を明示的に呼び出すことで、内部履歴バッファに確実に項目を追加します。
32    if ($input !== false && $input !== '') {
33        readline_add_history($input);
34    }
35
36    // ユーザーが 'exit' または 'quit' と入力したらループを終了します。
37    if (in_array(strtolower($input), ['exit', 'quit'])) {
38        break;
39    }
40}
41
42// 収集した入力履歴をファイルに書き込みます。
43// readline_write_history() は成功した場合に true を、失敗した場合に false を返します。
44if (readline_write_history($historyFile)) {
45    echo "入力履歴がファイルに正常に保存されました。\n";
46    echo "履歴ファイル: " . $historyFile . "\n";
47} else {
48    echo "エラー: 入力履歴をファイルに保存できませんでした。\n";
49}
50
51echo "スクリプトを終了します。\n";

readline_write_history関数は、PHPのCLI（コマンドラインインターフェース）環境において、ユーザーが入力したコマンドの履歴をファイルに保存するために使用されます。この関数は、PHPのreadline拡張機能が提供する対話的な入力履歴管理機能の一部です。

サンプルコードでは、まずreadline拡張がPHPにロードされていることを確認し、システムの一時ディレクトリ内に履歴を保存するためのファイルパスを定義しています。次に、無限ループ内でreadline()関数を使ってユーザーからの入力を受け付けます。入力された文字列は、readline_add_history()関数によってPHP内部の履歴バッファに逐次追加され、入力履歴として記憶されます。

ユーザーが「exit」または「quit」と入力してループを終了した後、readline_write_history()関数が呼び出されます。この関数の引数$filenameには、これまでに集められた履歴を書き込むファイルパスを指定します。引数を省略したりnullを渡した場合は、システム既定の履歴ファイル（環境依存）に書き込まれます。関数は、履歴の書き込みが成功した場合はtrueを、失敗した場合はfalseを戻り値として返します。この機能により、開発者は対話型CLIツールの入力履歴を永続化し、次回のセッションで利用できるような利便性の高いアプリケーションを構築できます。