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

Copy
1<?php
2
3/**
4 * SplTempFileObject::current() メソッドの使用例。
5 *
6 * この関数は、現在のディレクトリの内容を一時ファイルに書き込み、
7 * その後 SplTempFileObject::current() メソッドを使用して、
8 * 一時ファイルから各項目を読み取り、表示する方法を示します。
9 * これにより、ファイルポインタの現在位置にある行を取得する current() の機能と、
10 * "php current directory" のキーワードを関連付けます。
11 *
12 * システムエンジニアを目指す初心者向けに、一時的なデータ処理と
13 * イテレータの基本を理解するのに役立ちます。
14 */
15function demonstrateSplTempFileObjectWithDirectoryContent(): void
16{
17    // 現在の作業ディレクトリのパスを取得します。
18    // SplTempFileObject の操作とは直接関係ありませんが、一時ファイルに書き込むデータを提供します。
19    $currentDirectory = getcwd();
20    if ($currentDirectory === false) {
21        echo "エラー: 現在の作業ディレクトリを取得できませんでした。\n";
22        return;
23    }
24    echo "現在のディレクトリ: " . $currentDirectory . "\n\n";
25
26    // 一時ファイルオブジェクトを作成します。
27    // データはメモリ内または一時ディスクファイルに保存されます。
28    $tempFile = new SplTempFileObject();
29
30    // 現在のディレクトリ内の項目 (ファイルとディレクトリ) のリストを取得します。
31    // '.' と '..' は出力から除外します。
32    $directoryItems = array_filter(scandir($currentDirectory), function ($item) {
33        return !in_array($item, ['.', '..'], true);
34    });
35
36    // 各ディレクトリ項目を改行とともに一時ファイルに書き込みます。
37    // 書き込みごとにファイルポインタは自動的に移動します。
38    echo "--- 現在のディレクトリの内容を一時ファイルに書き込み中 ---\n";
39    foreach ($directoryItems as $item) {
40        $tempFile->fwrite($item . "\n");
41        echo "書き込み: " . $item . "\n";
42    }
43    echo "--- 書き込み完了 ---\n\n";
44
45    // ファイルポインタを先頭に戻し、読み取りを開始します。
46    $tempFile->rewind();
47    echo "--- 一時ファイルからディレクトリ項目を読み取り中 ---\n";
48
49    // SplTempFileObject のイテレータメソッドを使用して一時ファイルを反復処理します。
50    // current() はファイルポインタの現在位置にある行を返します。
51    // valid() はファイルポインタがファイルの終端にないことを確認します。
52    // next() はポインタを次の行に移動します。
53    while ($tempFile->valid()) {
54        $line = $tempFile->current();
55        if ($line !== false) {
56            echo "一時ファイルから読み取り: " . trim($line) . "\n";
57        }
58        $tempFile->next();
59    }
60
61    echo "--- 一時ファイルからの読み取り完了 ---\n";
62
63    // $tempFile がスコープ外に出ると、一時ファイルは自動的に閉じられ、削除されます。
64}
65
66// デモンストレーション関数を実行します。
67demonstrateSplTempFileObjectWithDirectoryContent();
68

SplTempFileObject::current()は、PHPのSplTempFileObjectクラスが提供するメソッドで、ファイルポインタの現在位置にある行の内容を取得します。このメソッドは引数を取りません。戻り値は、読み取った行の内容をstring型で返しますが、ファイルの終端に達した場合や読み取りに失敗した場合はfalseを返します。

このサンプルコードでは、getcwd()関数で取得した「現在のディレクトリ（php current directory）」のファイルやディレクトリ名を一時的にSplTempFileObjectへ書き込んでいます。その後、rewind()でファイルポインタを先頭に戻し、ループ処理内でcurrent()メソッドを使用して一時ファイルから各行を順に読み出し、表示しています。

SplTempFileObjectは、メモリ上または一時的なディスク領域にファイルを扱うためのクラスで、スクリプトの実行中に一時的にデータを保存し、処理するのに非常に便利です。current()メソッドは、この一時ファイル内のデータをイテレータとして順次処理する際に、現在の要素（行）を取り出す役割を担います。システムエンジニアを目指す初心者の方にとって、一時的なデータ処理の基本と、ファイル内容を効率的に読み取るイテレータの仕組みを理解する上で役立つでしょう。

Copy
1<?php
2
3/**
4 * SplTempFileObject を使用して月名リストを処理し、現在の行（月名）を取得するサンプルコード。
5 *
6 * このコードは、プログラミング言語リファレンス情報に基づき、
7 * SplTempFileObject::current() メソッドの機能と、
8 * PHPのイテレータとしてのファイルオブジェクトの基本的な使い方を示します。
9 */
10function handleMonthListUsingSplTempFileObject(): void
11{
12    // SplTempFileObject のインスタンスを作成します。
13    // このオブジェクトは、メモリ上に一時的なファイルを作成してデータを扱います。
14    $tempFile = new SplTempFileObject();
15
16    // 月名を一時ファイルに複数行で書き込みます。
17    $monthNames = [
18        "January", "February", "March", "April", "May", "June",
19        "July", "August", "September", "October", "November", "December"
20    ];
21    foreach ($monthNames as $month) {
22        $tempFile->fputs($month . "\n");
23    }
24
25    // ファイルポインタをファイルの先頭に戻します。
26    // これにより、イテレータは最初の行からデータを読み込みます。
27    $tempFile->rewind();
28
29    echo "--- 月名リストの処理と SplTempFileObject::current() の使用例 ---\n";
30
31    // SplTempFileObject は Iterator インターフェースを実装しているため、
32    // foreach ループを使ってファイルの内容を簡単にイテレートできます。
33    // ループ内で $tempFile->current() は自動的に呼び出され、$monthName に現在の行が代入されます。
34    foreach ($tempFile as $lineNumber => $monthName) {
35        // current() が返す文字列から改行文字を除去して表示します。
36        echo "行 " . ($lineNumber + 1) . ": " . trim($monthName) . "\n";
37    }
38
39    echo "--------------------------------------------------------\n";
40
41    // foreach ループ終了後、ファイルポインタは終端にあります。
42    // current() メソッドを直接呼び出すために、再度ポインタを先頭に戻します。
43    $tempFile->rewind();
44    echo "ポインタを先頭に戻した後、current() で取得: " . trim($tempFile->current()) . "\n";
45
46    // next() メソッドでポインタを次の行に進め、再度 current() を呼び出します。
47    $tempFile->next();
48    echo "ポインタを次に進めた後、current() で取得: " . trim($tempFile->current()) . "\n";
49
50    // ファイルの終端に到達するまでポインタを進めます。
51    // current() メソッドはファイルの終端で false を返すことを示します。
52    while ($tempFile->valid()) {
53        $tempFile->next();
54    }
55    echo "ファイルの終端に到達後、current() の戻り値: ";
56    var_dump($tempFile->current()); // false が出力されます
57}
58
59// 関数を実行します。
60handleMonthListUsingSplTempFileObject();
61

このPHPサンプルコードは、SplTempFileObjectクラスと、そのcurrent()メソッドの使用方法を示しています。SplTempFileObjectは、メモリ上の一時ファイルのようにデータを扱えるオブジェクトで、本コードでは月名リストを一時ファイルに書き込み、その内容を読み込んでいます。

SplTempFileObject::current()メソッドは、ファイルポインタが現在位置する行のデータを取得するために使用されます。このメソッドには引数がなく、戻り値として、現在の行のデータが文字列として返されます。もしファイルポインタがファイルの終端に達している場合は、falseが返される仕組みです。

サンプルコードでは、まず月名を一時ファイルに書き込み、rewind()メソッドでファイルポインタを先頭に戻しています。その後、foreachループでSplTempFileObjectをイテレートすることで、各行（月名）を順に処理しています。このforeachループ内ではcurrent()メソッドが自動的に呼び出され、各行のデータが取得されます。また、ループ外ではnext()メソッドでポインタを移動させながらcurrent()を明示的に呼び出し、特定の行のデータを取得する例も示されており、ファイルの終端でcurrent()がfalseを返す挙動も確認できます。このメソッドは、ファイルの内容を一行ずつ読み進める際に、現在の位置のデータを参照するために非常に役立ちます。