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

Copy
1<?php
2
3/**
4 * SplTempFileObject::getCurrentLine() の使い方を示すサンプル関数。
5 *
6 * このメソッドは、SplFileObject クラス (SplTempFileObject が継承) の一部であり、
7 * ファイルポインタが現在指している行の内容を返します。
8 * fgets() などの読み込み操作の後に呼び出すと、ポインタが移動した後の行が返される点に注意してください。
9 *
10 * @return void
11 */
12function demonstrateSplTempFileObjectGetCurrentLine(): void
13{
14    // メモリ内の一時ファイルを作成します。
15    // 'w+' モードで読み書き可能にし、後で内容を読み込めるようにします。
16    $file = new SplTempFileObject('w+');
17
18    // 一時ファイルに複数行のデータを書き込みます。
19    $file->fwrite("これは1行目の内容です。\n");
20    $file->fwrite("これは2行目の内容です。\n");
21    $file->fwrite("これは3行目の内容です。\n");
22
23    echo "--- SplTempFileObject::getCurrentLine() の動作確認 ---\n\n";
24
25    // ファイルポインタをファイルの先頭に戻します。
26    $file->rewind();
27
28    // 1行目を読み込みます。fgets() はファイルポインタを次の行に進めます。
29    $readFirstLine = $file->fgets();
30    echo "fgets() で読み込んだ行 (1行目): " . trim((string)$readFirstLine) . "\n";
31    // fgets() の後、ファイルポインタは2行目の先頭に移動しています。
32    // そのため、getCurrentLine() は現在のポインタが指す2行目の内容を返します。
33    echo "getCurrentLine() で取得した行 (ポインタは2行目): " . trim((string)$file->getCurrentLine()) . "\n\n";
34
35    // 2行目を読み込みます。fgets() はファイルポインタを次の行に進めます。
36    $readSecondLine = $file->fgets();
37    echo "fgets() で読み込んだ行 (2行目): " . trim((string)$readSecondLine) . "\n";
38    // fgets() の後、ファイルポインタは3行目の先頭に移動しています。
39    // そのため、getCurrentLine() は現在のポインタが指す3行目の内容を返します。
40    echo "getCurrentLine() で取得した行 (ポインタは3行目): " . trim((string)$file->getCurrentLine()) . "\n\n";
41
42    // 3行目を読み込みます。fgets() はファイルポインタを次の行に進めます。
43    $readThirdLine = $file->fgets();
44    echo "fgets() で読み込んだ行 (3行目): " . trim((string)$readThirdLine) . "\n";
45    // 3行目を読み込んだ後、ファイルポインタはファイルの終端に移動しています。
46    // そのため、getCurrentLine() は空文字列または false を返します。
47    echo "getCurrentLine() で取得した行 (ポインタは終端): " . var_export($file->getCurrentLine(), true) . "\n\n";
48
49    // ファイルポインタがファイルの終端 (EOF) に到達しているか確認します。
50    echo "ファイルの終端 (EOF) に到達しているか: " . ($file->eof() ? "はい" : "いいえ") . "\n";
51}
52
53// 上記の関数を実行して、SplTempFileObject::getCurrentLine() の動作を確認します。
54demonstrateSplTempFileObjectGetCurrentLine();
55

PHPのSplTempFileObject::getCurrentLine()メソッドは、一時ファイルオブジェクトのファイルポインタが現在指している行の内容を文字列として取得します。このメソッドは引数を必要としません。戻り値は該当する行の文字列、またはファイル終端に達している場合や読み込みに失敗した場合はfalseを返します。

サンプルコードでは、メモリ上の一時ファイルに複数行のデータを書き込み、その動作を確認しています。fgets()メソッドでファイルを読み込むと、ファイルポインタは自動的に次の行に進みますが、getCurrentLine()はポインタの位置を移動させません。そのため、例えばfgets()で1行目を読み込んだ直後にgetCurrentLine()を呼び出すと、すでにポインタが2行目を指しているため、2行目の内容が取得されます。同様に、2行目を読み込んだ後では3行目の内容が返されます。ファイルポインタがファイルの終端に達した状態でgetCurrentLine()を呼び出した場合、戻り値はfalseとなることがあります。このメソッドは、ファイルポインタの位置を変えずに現在の行の内容を確認したい場合に利用できます。

Copy
1<?php
2
3/**
4 * SplTempFileObject を使用して一時ファイルにシステムユーザー名を書き込み、
5 * SplTempFileObject::getCurrentLine メソッドでその内容を読み取るサンプル。
6 *
7 * この関数は、PHPの組み込み関数 get_current_user() の結果を一時ファイルに保存し、
8 * SplTempFileObject クラスの getCurrentLine メソッドを使ってそのデータを読み取ります。
9 * getCurrentLine はファイルポインタの現在の行を取得し、ファイルポインタを次の行に進めます。
10 *
11 * @return void
12 */
13function demonstrateSplTempFileObjectWithCurrentUser(): void
14{
15    // 1. 現在のシステムユーザー名を取得します。
16    // get_current_user() はスクリプトを実行しているユーザー名を返します。
17    $currentUser = get_current_user();
18
19    if ($currentUser === false) {
20        echo "エラー: 現在のユーザー名を取得できませんでした。\n";
21        return;
22    }
23
24    echo "取得した現在のシステムユーザー名: " . $currentUser . "\n";
25
26    try {
27        // 2. SplTempFileObject のインスタンスを作成します。
28        // これはメモリ上またはシステムの一時ディレクトリに一時ファイルを作成します。
29        $tempFile = new SplTempFileObject();
30
31        // 3. 取得したユーザー名を一時ファイルに書き込みます。
32        // SplTempFileObject は SplFileObject を継承しているため、fwrite メソッドが使えます。
33        // getCurrentLine で読み取るために、最後に改行コードを追加します。
34        $bytesWritten = $tempFile->fwrite($currentUser . "\n");
35
36        if ($bytesWritten === 0 || $bytesWritten === false) {
37            echo "エラー: 一時ファイルへの書き込みに失敗しました。\n";
38            return;
39        }
40        echo "一時ファイルに " . $bytesWritten . " バイト書き込みました。\n";
41
42        // 4. ファイルポインタをファイルの先頭に戻します。
43        // 書き込み操作後、ポインタはファイルの終端にあるため、読み取り前に先頭に戻す必要があります。
44        $tempFile->rewind();
45
46        // 5. SplTempFileObject::getCurrentLine メソッドで現在の行を読み取ります。
47        // このメソッドはファイルポインタの現在の行の内容を文字列で返します。
48        // 行末の改行コードも含まれる可能性があるため、trim() で除去することが推奨されます。
49        $lineContent = $tempFile->getCurrentLine();
50
51        if ($lineContent !== false) {
52            // 読み取った行の内容を出力します。
53            echo "SplTempFileObject::getCurrentLine で読み取った内容: '" . trim($lineContent) . "'\n";
54
55            // 元のユーザー名と読み取った内容が一致するか確認します。
56            if (trim($lineContent) === $currentUser) {
57                echo "結果: 読み取った内容と元のユーザー名が一致しました。\n";
58            } else {
59                echo "結果: 読み取った内容と元のユーザー名が一致しませんでした。\n";
60            }
61        } else {
62            echo "エラー: SplTempFileObject::getCurrentLine で行を読み取れませんでした。\n";
63        }
64    } catch (Throwable $e) {
65        // ファイル操作中に発生した例外をキャッチします。
66        echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
67    }
68}
69
70// 関数を実行して、上記の一連の操作をデモンストレーションします。
71demonstrateSplTempFileObjectWithCurrentUser();

PHPのSplTempFileObject::getCurrentLineメソッドは、一時ファイルから現在の行の内容を読み取るための機能です。このメソッドはSplTempFileObjectクラスの一部で、引数なしで呼び出します。実行すると、ファイルポインタが現在指している行のテキストを文字列として返し、読み込み成功後はファイルポインタを自動的に次の行へ進めます。ファイルの終端に達した場合や読み込みに失敗した場合はfalseを返します。

サンプルコードでは、まずget_current_user()関数でシステムユーザー名を取得し、SplTempFileObjectを使用して作成した一時ファイルにそのユーザー名を書き込みます。書き込み後、ファイルポインタはファイルの終端にあるため、rewind()メソッドでポインタをファイルの先頭に戻します。その後、getCurrentLineを呼び出して、一時ファイルに書き込んだユーザー名の行を読み取っています。読み取った文字列には行末の改行コードが含まれる可能性があるため、trim()関数で余分な空白や改行を除去し、書き込んだ内容が正確に読み取られていることを確認しています。このメソッドは、一時的なデータを効率的に読み出す際に活用できます。