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

Copy
1<?php
2
3// 一時ファイルのパスを定義します。
4$filePath = 'example.txt';
5
6// サンプルデータをファイルに書き込みます。
7// 各行の終わりには改行文字(\n)を含めます。
8file_put_contents($filePath, "Hello, PHP!\nThis is a test file.\nThird line for testing ftell.");
9
10try {
11    // SplFileObject のインスタンスを作成し、ファイルを読み込みモードで開きます。
12    $file = new SplFileObject($filePath, 'r');
13
14    echo "--- SplFileObject::ftell() の使用例 ---\n\n";
15
16    // 1. ファイルポインタの初期位置を取得します。
17    // 通常、ファイルの先頭なので0を返します。
18    $initialPosition = $file->ftell();
19    if ($initialPosition !== false) {
20        echo "初期ファイルポインタ位置: " . $initialPosition . "バイト\n";
21    } else {
22        echo "エラー: 初期ファイルポインタ位置の取得に失敗しました。\n";
23    }
24
25    // 2. ファイルから最初の行を読み込みます。
26    $line1 = $file->fgets();
27    echo "1行目読み込み: '" . trim($line1) . "'\n"; // trim()で改行文字を削除して表示
28
29    // 3. 最初の行を読み込んだ後のファイルポインタの位置を取得します。
30    // 読み込んだバイト数分、ポインタが進んでいます。
31    $positionAfterLine1 = $file->ftell();
32    if ($positionAfterLine1 !== false) {
33        echo "1行読み込み後のファイルポインタ位置: " . $positionAfterLine1 . "バイト\n";
34    } else {
35        echo "エラー: 1行読み込み後のファイルポインタ位置の取得に失敗しました。\n";
36    }
37
38    // 4. ファイルから2番目の行を読み込みます。
39    $line2 = $file->fgets();
40    echo "2行目読み込み: '" . trim($line2) . "'\n";
41
42    // 5. 2番目の行を読み込んだ後のファイルポインタの位置を取得します。
43    // さらに読み込んだバイト数分、ポインタが進んでいます。
44    $positionAfterLine2 = $file->ftell();
45    if ($positionAfterLine2 !== false) {
46        echo "2行読み込み後のファイルポインタ位置: " . $positionAfterLine2 . "バイト\n";
47    } else {
48        echo "エラー: 2行読み込み後のファイルポインタ位置の取得に失敗しました。\n";
49    }
50
51    // 6. ファイルポインタをファイルの先頭に戻します。
52    $file->rewind();
53    echo "\nファイルポインタをファイルの先頭にリセットしました。\n";
54
55    // 7. rewind()後のファイルポインタの位置を取得します。
56    // ポインタは0に戻っているはずです。
57    $positionAfterRewind = $file->ftell();
58    if ($positionAfterRewind !== false) {
59        echo "rewind()後のファイルポインタ位置: " . $positionAfterRewind . "バイト\n";
60    } else {
61        echo "エラー: rewind()後のファイルポインタ位置の取得に失敗しました。\n";
62    }
63
64} catch (RuntimeException $e) {
65    // SplFileObject の作成失敗など、ファイル操作に関する例外を処理します。
66    echo "エラーが発生しました: " . $e->getMessage() . "\n";
67} finally {
68    // スクリプトの終了時に、作成した一時ファイルを削除します。
69    if (file_exists($filePath)) {
70        unlink($filePath);
71        echo "\n一時ファイル '{$filePath}' を削除しました。\n";
72    }
73}
74

SplFileObject::ftell()メソッドは、PHPでファイルの内容を扱う際に、現在ファイル内のどの位置にいるかを示す「ファイルポインタ」の現在位置を、バイト単位で取得するために使われます。ファイルを読み進めたり書き込んだりするたびに、このポインタは自動的に移動します。例えば、ファイルの途中まで読み込んだ後にftell()を呼び出すと、そこまでに読み込んだバイト数の合計が返されます。

このメソッドは引数を取りません。成功するとファイルポインタの現在位置をバイト単位の整数で返し、失敗した場合はfalseを返します。

サンプルコードでは、まず一時ファイルにデータを書き込み、SplFileObjectでファイルを読み込みモードで開いています。そして、ftell()を使ってファイルを開いた直後の初期位置（0バイト目）を取得します。次に、fgets()メソッドでファイルを一行ずつ読み進めるたびにftell()を呼び出し、ファイルポインタが読み込んだバイト数分だけ進んでいることを確認しています。また、rewind()メソッドでファイルポインタをファイルの先頭に戻した後に、ftell()が再び0を返すことも示し、ファイルポインタの基本的な操作と位置確認の方法を理解できます。