【PHP8.x】SplTempFileObject::fgets()メソッドの使い方

Copy
1<?php
2
3/**
4 * 標準入力 (STDIN) からユーザー入力を1行読み込み、それを表示するサンプルコードです。
5 * システムエンジニアを目指す初心者向けに、基本的なコンソール入力の扱い方を示します。
6 *
7 * キーワード「php fgets(stdin)」に最も関連する一般的な利用方法です。
8 * 注意: SplTempFileObject::fgets は一時ファイルからの読み込みに特化したメソッドであり、
9 * 通常の標準入力からの読み込みには、この例のようにグローバル関数 fgets() と STDIN 定数を使用します。
10 */
11function handleUserInput(): void
12{
13    echo "何か入力してください (Enterキーで確定): ";
14
15    // 標準入力 (STDIN) から1行読み込みます。
16    // fgets() 関数は、行末の改行文字 (\n) も含めて読み込みます。
17    // 読み込みに失敗した場合やストリームの終端に達した場合は false を返します。
18    $input = fgets(STDIN);
19
20    if ($input === false) {
21        // 読み込みエラーが発生した場合の処理
22        echo "エラー: 標準入力からの読み込みに失敗しました。\n";
23    } else {
24        // 読み込んだ文字列の先頭と末尾にある空白文字（改行を含む）を削除します。
25        // これにより、余分な改行文字が取り除かれたクリーンな文字列が得られます。
26        $trimmedInput = trim($input);
27
28        // ユーザーが何も入力せずにEnterを押した場合も考慮します。
29        if ($trimmedInput === '') {
30            echo "何も入力されませんでした。\n";
31        } else {
32            echo "入力された内容: " . $trimmedInput . "\n";
33        }
34    }
35}
36
37// 関数を実行して、ユーザー入力の処理を開始します。
38handleUserInput();

このサンプルコードは、PHPでユーザーからの標準入力を読み込む基本的な方法を示しています。fgets()関数は、指定されたストリームから1行を読み込むために使用され、ここではPHPの予約済み定数であるSTDINを引数に指定することで、キーボードからの標準入力を対象としています。

fgets()は、読み込んだ行の文字列を戻り値として返しますが、この文字列には行末の改行文字も含まれます。読み込みに失敗した場合やストリームの終端に達した場合はfalseを返しますので、そのチェックは重要です。読み込んだ入力から不要な改行文字などを取り除くためには、trim()関数を使用することが一般的で、これによりユーザーが入力した純粋な文字列を扱えます。

この例では、ユーザーに何か入力するよう促し、入力された内容を整形して表示しています。なお、リファレンスにあるSplTempFileObject::fgetsは一時ファイルオブジェクトからの読み込みに特化していますが、一般的な標準入力の読み込みには、このサンプルコードのようにグローバルなfgets()関数とSTDINを組み合わせて使用します。これは、コンソールアプリケーションでのユーザーインタラクションの基礎となります。

Copy
1<?php
2
3/**
4 * SplTempFileObject を使用して一時ファイルに書き込み、
5 * fgets メソッドで行を読み込むサンプルです。
6 * fgets は改行コードを含めて行を読み込む点に注目してください。
7 */
8
9// SplTempFileObject のインスタンスを作成。
10// これにより、一時的にデータを格納できるファイルライクなオブジェクトが作成されます。
11$tempFile = new SplTempFileObject();
12
13// 一時ファイルに複数行のデータを書き込みます。
14// 異なる種類の改行コード（\n, \r\n）を使用しています。
15$tempFile->fwrite("最初の行\n");
16$tempFile->fwrite("2番目の行。\r\n");
17$tempFile->fwrite("最後の行。\n");
18$tempFile->fwrite("もう一行。"); // 最後の行には意図的に改行コードを付けない
19
20// ファイルポインタを先頭に戻します。
21// 書き込み後に読み込みを行うためには、この操作が必要です。
22$tempFile->rewind();
23
24// fgets() メソッドを使用して、一時ファイルから1行ずつ読み込みます。
25// fgets は行の終わりを示す改行コードを含めて文字列を返します。
26echo "--- SplTempFileObject::fgets の動作確認 ---\n";
27
28// 1行目を読み込み
29$line1 = $tempFile->fgets();
30echo "読み込んだ1行目 (改行コード含む): " . json_encode($line1) . "\n";
31echo "改行コードを除去した1行目: " . json_encode(trim($line1)) . "\n\n";
32
33// 2行目を読み込み
34$line2 = $tempFile->fgets();
35echo "読み込んだ2行目 (改行コード含む): " . json_encode($line2) . "\n";
36echo "改行コードを除去した2行目: " . json_encode(trim($line2)) . "\n\n";
37
38// 3行目を読み込み
39$line3 = $tempFile->fgets();
40echo "読み込んだ3行目 (改行コード含む): " . json_encode($line3) . "\n";
41echo "改行コードを除去した3行目: " . json_encode(trim($line3)) . "\n\n";
42
43// 4行目を読み込み (改行コードなしで書き込んだ行)
44$line4 = $tempFile->fgets();
45echo "読み込んだ4行目 (改行コードなし): " . json_encode($line4) . "\n";
46echo "改行コードを除去した4行目: " . json_encode(trim($line4)) . "\n\n";
47
48// ファイルの終端 (EOF) に達した場合、fgets は false を返します。
49$eofResult = $tempFile->fgets();
50echo "EOF後: " . json_encode($eofResult) . " (false が返されるはずです)\n";
51
52?>

SplTempFileObject::fgetsは、PHP 8の一時ファイル操作クラスであるSplTempFileObjectに属するメソッドです。このメソッドは、引数なしで呼び出され、一時ファイルから現在のファイルポインタの位置から1行ずつデータを読み込むために使用されます。

fgetsの大きな特徴は、読み込んだ行の文字列に、行の終わりを示す改行コード（例: \nや\r\n）を含めて返す点です。したがって、読み込んだ行から改行コードを取り除きたい場合は、別途trim()関数などを使って処理する必要があります。ファイルポインタは、1行読み込むたびに次の行の先頭へ自動的に進みます。

戻り値としては、正常に1行を読み込めた場合はその行の文字列を返します。しかし、ファイルをすべて読み終えてファイルの終端（EOF: End Of File）に達した場合には、falseを返します。サンプルコードでは、一時ファイルに書き込まれた複数行のデータに対してfgetsを適用し、改行コードが含まれる挙動や、ファイル終端に達した際の戻り値がfalseになる様子を確認しています。これにより、ファイルからの行単位の読み込み処理の基本的な振る舞いを理解できます。