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

Copy
1<?php
2
3/**
4 * SplTempFileObject::seek メソッドの使用例。
5 *
6 * SplTempFileObject は、ファイルシステムではなくメモリ内または一時ファイルとしてデータを扱うオブジェクトです。
7 * seek メソッドは、ファイルのポインタを指定された行番号（0から始まる）に移動させます。
8 * これにより、大きな配列データをファイルのように扱い、メモリに全て展開することなく
9 * 特定の行に直接アクセスするようなシナリオで役立ちます。
10 *
11 * @param array $data 操作する配列データ。
12 */
13function demonstrateSplTempFileObjectSeek(array $data): void
14{
15    // SplTempFileObject のインスタンスを作成
16    // 'php://memory' を使用すると、実際のファイルI/Oを発生させずに
17    // ファイルの内容をメモリ内で保持し、ファイル操作をシミュレートできます。
18    $fileObject = new SplTempFileObject('php://memory');
19
20    // 配列の各要素をファイルオブジェクトに1行ずつ書き込む
21    // 各要素の後に改行文字 (\n) を追加し、それぞれが独立した行になるようにします。
22    foreach ($data as $index => $item) {
23        $fileObject->fwrite("{$index}: {$item}\n");
24    }
25
26    echo "--- データ書き込み完了 ---\n\n";
27
28    // ファイルポインタをファイルの先頭（0行目）にリセット
29    // seek() を呼び出す前に、現在のポインタ位置をリセットすることが重要です。
30    // そうしないと、意図しない場所からseekが始まる可能性があります。
31    $fileObject->rewind();
32    echo "ファイルポインタを先頭（0行目）にリセットしました。\n\n";
33
34    // 2行目（インデックス1）にシークして内容を読み込む
35    // seek() の引数は0から始まる行番号を指定します。
36    // 例: 0で1行目、1で2行目、2で3行目...
37    $targetLine1 = 1; // 0から始まるインデックスなので、2行目は1を指定
38    $fileObject->seek($targetLine1);
39    
40    // seek() の後、fgets() で現在のポインタ位置から1行読み込みます。
41    // fgets() は行末の改行文字も含むため、trim() で不要な空白や改行を削除します。
42    $lineContent1 = trim($fileObject->fgets());
43    echo "{$targetLine1}行目（0から数えて）にシークしました。\n";
44    echo "読み込んだ内容: '{$lineContent1}'\n\n";
45
46    // 4行目（インデックス3）にシークして内容を読み込む
47    $targetLine2 = 3; // 0から始まるインデックスなので、4行目は3を指定
48    $fileObject->seek($targetLine2);
49    $lineContent2 = trim($fileObject->fgets());
50    echo "{$targetLine2}行目（0から数えて）にシークしました。\n";
51    echo "読み込んだ内容: '{$lineContent2}'\n\n";
52
53    // 存在しない行にシークした場合の動作
54    // seek メソッドは、指定された行が存在しなくてもエラーを発生させません。
55    // ポインタはファイルの終端に移動し、その後の読み込み (fgets) は空の文字列を返します。
56    $outOfRangeLine = count($data) + 5; // データ数より大きな行番号を指定
57    $fileObject->seek($outOfRangeLine);
58    $lineContentOutOfRange = trim($fileObject->fgets());
59    echo "存在しない{$outOfRangeLine}行目（0から数えて）にシークしました。\n";
60    echo "読み込んだ内容（空文字列が返る）: '{$lineContentOutOfRange}'\n";
61}
62
63// サンプルとして使用する配列データ
64$sampleArray = [
65    "りんご",
66    "バナナ",
67    "チェリー",
68    "ぶどう",
69    "オレンジ",
70    "マンゴー",
71];
72
73// 関数を実行して SplTempFileObject::seek の動作を確認
74demonstrateSplTempFileObjectSeek($sampleArray);
75

PHPのSplTempFileObject::seekメソッドは、メモリ内や一時ファイルとしてデータを扱うSplTempFileObjectのファイルポインタを指定された行番号に移動させるための機能です。

SplTempFileObjectは、ファイルシステムに実際に保存せず、メモリ上でファイルのようなデータ操作を可能にするクラスで、php://memoryを使用することで、実際のファイルI/Oなしにデータ処理をシミュレートできます。このクラスとseekメソッドを組み合わせることで、大きな配列データを一時的にファイルのように扱い、メモリにすべて展開することなく特定の行へ直接アクセスできるため、メモリ効率の良いデータ処理に役立ちます。

seekメソッドは、引数としてint $lineを取り、この$lineで指定された0から始まる行番号にファイルポインタを移動させます。戻り値はありません。

サンプルコードでは、まず配列データをSplTempFileObjectに1行ずつ書き込みます。その後、seekメソッドを用いてポインタを特定の行に移動させ、fgets()でその行の内容を読み出しています。例えば、$fileObject->seek(1)とすると2行目にポインタが移動し、2行目の内容を取得できます。seekを呼び出す前にrewind()でポインタをファイルの先頭に戻すことで、常に0行目から数え直して正確な行にアクセスできます。指定した行が存在しない場合でもエラーにはならず、ポインタはファイルの終端に移動し、その後の読み込みは空の文字列を返します。