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

Copy
1<?php
2
3/**
4 * readline_clear_history() 関数の使用例を示します。
5 *
6 * このスクリプトは、readline 拡張機能の履歴機能をデモンストレーションします。
7 * 最初にいくつか入力を受け付けて履歴に保存し、その後 readline_clear_history() を
8 * 使用して履歴を消去する様子を示します。
9 *
10 * 注意: このコードはコマンドラインインターフェース (CLI) で実行してください。
11 * また、PHPが --with-readline オプション付きでコンパイルされている必要があります。
12 */
13
14// 1. readline() を使っていくつか入力を受け付け、履歴に保存します。
15//    readline() 関数は、入力された文字列を自動的に履歴に追加します。
16echo "履歴に追加する文字列を3つ入力してください。\n";
17readline("1つ目の入力: "); // 例: Hello
18readline("2つ目の入力: "); // 例: PHP
19readline("3つ目の入力: "); // 例: Readline
20
21echo "\n--- 現在の Readline 履歴 (クリア前) ---\n";
22// readline_list_history() を使って現在の履歴の内容を表示します。
23$historyBeforeClear = readline_list_history();
24if (!empty($historyBeforeClear)) {
25    foreach ($historyBeforeClear as $index => $item) {
26        echo ($index + 1) . ": " . $item . "\n";
27    }
28} else {
29    echo "履歴は空です。\n";
30}
31echo "-----------------------------------------\n\n";
32
33// 2. readline_clear_history() を呼び出して、保存されている履歴をすべてクリアします。
34//    この関数は引数を取りません。
35readline_clear_history();
36
37echo "readline_clear_history() を実行しました。\n\n";
38
39echo "--- 現在の Readline 履歴 (クリア後) ---\n";
40// 履歴がクリアされたことを確認するために、再度履歴の内容を表示します。
41$historyAfterClear = readline_list_history();
42if (!empty($historyAfterClear)) {
43    foreach ($historyAfterClear as $index => $item) {
44        echo ($index + 1) . ": " . $item . "\n";
45    }
46} else {
47    echo "履歴は空です。\n"; // ここで履歴が空になっているはずです。
48}
49echo "----------------------------------------\n";
50
51?>

PHPのreadline_clear_history()関数は、コマンドラインインターフェース（CLI）で動作するPHPスクリプトがユーザーからの入力を受け付ける際に使用するreadline拡張機能の入力履歴をすべて消去するための関数です。この関数は、履歴をクリアする目的のため、処理に必要な引数を一切取りません。また、処理が完了しても特に値を返すことはありません（戻り値はvoidです）。

提供されたサンプルコードでは、このreadline_clear_history()関数の動作を段階的に示しています。まず、readline()関数を複数回呼び出すことで、ユーザーからの入力文字列をReadlineの履歴に意図的に保存します。その後、readline_list_history()関数を使って現在の履歴の内容を表示し、入力が確かに記録されていることを確認します。

次に、readline_clear_history()関数を実行します。これにより、それまでにreadline()によって追加されたすべての入力履歴がクリアされます。再度readline_list_history()関数で履歴の内容を確認すると、以前に記録されていた履歴がすべて消去され、履歴が空になっていることがわかります。このコードは、PHPが--with-readlineオプション付きでコンパイルされており、CLI環境で実行されることを前提としています。特定の操作履歴をプライバシー保護のためや、一時的な記録としてのみ保持したい場合などに、この関数で履歴を簡単に消去できます。

Copy
1<?php
2
3// このスクリプトはCLI（コマンドラインインターフェース）環境での実行を想定しています。
4// readline拡張は対話的な入力履歴を管理するために使用されます。
5
6// readline履歴にいくつかの項目を追加します。
7// これらの項目は、ユーザーがCLIで入力したかのように扱われます。
8readline_add_history('ls -l');
9readline_add_history('cd /var/www/html');
10readline_add_history('php artisan migrate');
11
12echo "--- 履歴クリア前の状態 ---\n";
13echo "現在のreadline履歴の内容:\n";
14// readline_list_history() を使用して、現在の履歴の内容を表示します。
15foreach (readline_list_history() as $index => $item) {
16    echo "  " . ($index + 1) . ": " . $item . "\n";
17}
18echo "\n";
19
20// readline_clear_history() を呼び出して、保存されているすべての履歴をクリアします。
21// この関数は引数を取らず、戻り値もありません（void）。
22readline_clear_history();
23
24echo "--- 履歴クリア後の状態 ---\n";
25echo "readline_clear_history() 呼び出し後の履歴の内容:\n";
26// 履歴がクリアされたことを確認するため、再度 readline_list_history() を呼び出します。
27$currentHistory = readline_list_history();
28if (empty($currentHistory)) {
29    echo "  履歴は正常にクリアされました。\n";
30} else {
31    echo "  履歴はクリアされませんでした。現在の履歴:\n";
32    foreach ($currentHistory as $index => $item) {
33        echo "    " . ($index + 1) . ": " . $item . "\n";
34    }
35}
36
37?>

readline_clear_historyは、PHPのreadline拡張機能が提供する関数です。この関数は、主にCLI（コマンドラインインターフェース）環境において、ユーザーが過去に入力したコマンドや文字列の履歴を管理するために使用されます。

サンプルコードでは、まずreadline_add_history()関数を使って、あたかもCLIで入力されたかのようにいくつかの項目を履歴に追加しています。その後、readline_list_history()関数を用いて、追加された現在の履歴の内容を表示し、履歴が保存されている状態を確認しています。

続いて、readline_clear_history()関数が呼び出されます。この関数は引数を一切取らず、呼び出すだけでそれまでにreadline機能が保持していたすべての入力履歴を完全に消去します。戻り値もvoidであり、特に値を返しません。

関数呼び出し後、再びreadline_list_history()で履歴を確認すると、以前に存在した項目がすべてクリアされ、履歴が空になっていることがわかります。これは、readline_clear_history()が期待通りに機能し、入力履歴が正常に削除されたことを示しています。この機能は、履歴をリセットしたい場合や、機密性の高い情報を履歴に残したくない場合などに役立ちます。