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

Copy
1<?php
2
3/**
4 * readline_on_new_line 関数の使用例です。
5 *
6 * この関数は、プログラムが標準出力に何らかのテキストを出力した後に、
7 * readline の入力プロンプトを正しい位置に再描画するために使用されます。
8 * 通常、readline_redisplay() と組み合わせて使用することで、
9 * ユーザー入力の見た目をきれいに保ちます。
10 *
11 * 注意:
12 * - このコードは CLI (コマンドラインインターフェース) 環境でのみ動作します。
13 * - PHP の readline 拡張モジュールが有効になっている必要があります。
14 */
15
16// ユーザーに最初の入力を促します。
17$firstName = readline("お名前を入力してください: ");
18echo "こんにちは、" . $firstName . "さん！\n";
19
20// ここで、ユーザーがまだ入力中であるか、または入力行がアクティブな状態で、
21// プログラムが別の情報を出力したと仮定します。
22// この出力によって、readline の入力プロンプトの位置がずれてしまう可能性があります。
23echo "現在時刻: " . date('H:i:s') . "\n";
24echo "この行は、ユーザー入力の途中に割り込んだ出力だと考えてください。\n";
25
26// readline_on_new_line() を呼び出すことで、readline は現在のカーソル位置を
27// 新しい入力行の開始点として扱う準備をします。
28// これ自体は画面に何も表示しませんが、後続の再描画のための準備です。
29readline_on_new_line();
30
31// readline_redisplay() を呼び出すことで、readline が認識している新しい行の開始点に
32// プロンプトが再描画されます。これにより、以前の出力によって乱れた表示が修正されます。
33readline_redisplay();
34
35// 新しい行として適切にプロンプトが再描画された状態で、次の入力を促します。
36$lastName = readline("名字も入力してください: ");
37
38echo $firstName . " " . $lastName . "さん、ありがとうございます！\n";
39
40?>

readline_on_new_line関数は、PHPのCLI（コマンドラインインターフェース）環境でユーザーからの入力を受け付ける際に利用されるreadline拡張機能の一部です。この関数は引数を取らず、戻り値もありません（void）。その主な役割は、プログラムが標準出力に何らかのテキストを出力した後で、readlineの入力プロンプトを正しい位置に再描画するための準備をすることです。

サンプルコードでは、まずユーザーに名前を入力してもらい、その後に現在の時刻などの情報がプログラムによって出力されています。このように、ユーザーが入力中であったり、入力プロンプトが表示されている途中でプログラムが別のテキストを出力すると、readlineの入力プロンプトの位置がずれてしまうことがあります。

このような状況で、readline_on_new_line()を呼び出すと、readlineは現在のカーソル位置を新しい入力行の開始点として認識するよう準備します。この関数自体は画面に何も表示しませんが、後続の再描画のための重要なステップです。続いてreadline_redisplay()を呼び出すことで、readlineは認識した新しい行の開始点にプロンプトを再描画し、以前の出力によって乱れた表示を修正します。これにより、ユーザーは乱れることなく次の入力を行えるようになります。この機能は、インタラクティブなCLIアプリケーションで、ユーザーエクスペリエンスを向上させるために役立ちます。本関数はPHPのreadline拡張モジュールが有効なCLI環境でのみ動作します。

Copy
1<?php
2
3/**
4 * Reads a file line by line based on user input from the command line.
5 *
6 * This function demonstrates how to prompt a user for a file path,
7 * read the content of that file line by line, and includes the use of
8 * `readline_on_new_line` from the `readline` extension.
9 *
10 * The `readline_on_new_line` function is typically used in interactive CLI
11 * environments (like a custom shell) to notify the `readline` library that
12 * a new input line has started. While its direct effect might not be
13 * immediately visible in simple scripts, it's relevant for managing
14 * the command-line prompt and cursor state in more complex interactive scenarios.
15 *
16 * For full functionality of `readline()` and `readline_on_new_line()`,
17 * the PHP `readline` extension must be enabled (e.g., in php.ini).
18 */
19function readFileLineByLineFromUserInput(): void
20{
21    // Check if the readline extension is enabled.
22    // This extension provides functions like readline() and readline_on_new_line().
23    if (!extension_loaded('readline')) {
24        echo "Warning: The 'readline' extension is not enabled.\n";
25        echo "Interactive input features (like history) will not be available.\n";
26        echo "Please enter the path to the file you want to read: ";
27        // Fallback to basic input if readline extension is not available
28        $filePath = trim(fgets(STDIN));
29    } else {
30        echo "Please enter the path to the file you want to read: ";
31        
32        // readline_on_new_line() informs the readline library that a new line for input
33        // has begun. This helps in managing prompt display and cursor position,
34        // especially if the prompt itself contains newlines or for advanced
35        // interactive features. In a simple readline() call, its effect might be subtle.
36        readline_on_new_line(); 
37        
38        // Use readline() to get user input, which offers features like command history
39        // and line editing if available in the terminal.
40        $filePath = readline();
41    }
42
43    // Remove leading/trailing whitespace from the input path.
44    $filePath = trim($filePath);
45
46    // Validate if a file path was provided.
47    if (empty($filePath)) {
48        echo "Error: No file path provided. Exiting.\n";
49        return;
50    }
51
52    // Check if the specified file exists and is readable.
53    if (!file_exists($filePath)) {
54        echo "Error: File not found at '{$filePath}'.\n";
55        return;
56    }
57    if (!is_readable($filePath)) {
58        echo "Error: File '{$filePath}' is not readable. Check permissions.\n";
59        return;
60    }
61
62    echo "\n--- Reading file: {$filePath} ---\n";
63
64    // Open the file in read-only mode ('r').
65    $fileHandle = fopen($filePath, 'r');
66
67    if ($fileHandle) {
68        $lineNumber = 1;
69        // Read the file line by line until the end of the file is reached.
70        while (($line = fgets($fileHandle)) !== false) {
71            // Output each line, stripping potential trailing newline characters for clean display.
72            echo sprintf("%03d: %s", $lineNumber, rtrim($line)) . "\n";
73            $lineNumber++;
74        }
75        // Close the file handle to release resources.
76        fclose($fileHandle);
77        echo "--- End of file ---\n";
78    } else {
79        echo "Error: Could not open file '{$filePath}' for reading.\n";
80    }
81}
82
83// Execute the function to start the file reading process.
84readFileLineByUserInput();
85

このPHPサンプルコードは、コマンドラインでユーザーにファイルパスを入力させ、指定されたファイルを1行ずつ読み込んでその内容を表示するプログラムです。特に、PHPのreadline拡張機能が提供するreadline_on_new_line関数の使用例を含んでいます。

readline_on_new_line関数は、引数を取らず、void（何も返さない）型の戻り値を持つ関数です。この関数は、対話型のコマンドラインインターフェース（CUI）環境での使用を想定しており、readlineライブラリに対して、新しい入力行が開始されたことを通知する役割があります。これにより、コマンドラインのプロンプトの表示やカーソル位置の管理を適切に行うために役立ちます。単純な入力処理ではその効果が分かりにくいこともありますが、より複雑なインタラクティブ処理でその真価を発揮します。

サンプルコードでは、ユーザーからのファイルパスの入力にreadline()関数を使用しており、その前にreadline_on_new_line()を呼び出して、入力準備を整えています。もしreadline拡張機能が有効でない場合は、代わりに標準的なfgets(STDIN)関数を使って入力を行うようにフォールバック処理も含まれています。ユーザーからファイルパスが入力された後、コードは指定されたファイルが存在し、読み込み可能であることを確認します。その後、fopen関数でファイルを読み込みモードで開き、fgets関数を使ってファイルを1行ずつ読み込み、その内容を画面に出力します。ファイルの読み込みが完了したら、fclose関数でファイルを閉じ、リソースを解放しています。