【PHP8.x】rewind()関数の使い方

Copy
1<?php
2
3/**
4 * このサンプルコードは、PHPの `rewind()` 関数を、
5 * 「巻き戻し可能なジェネレータ」（rewindable generator）の概念と組み合わせて示します。
6 *
7 * PHPのネイティブジェネレータは、一度イテレーションが完了すると、通常は巻き戻すことができません。
8 * しかし、ジェネレータが内部でファイルなどのストリームリソースを扱い、
9 * そのストリームリソースを再利用する場合、`rewind()` 関数を使用してストリームポインタをリセットできます。
10 *
11 * ここでは `IteratorAggregate` インターフェースを実装したクラス `RewindableStreamGenerator` を使用し、
12 * `rewind()` 関数がファイルストリームを巻き戻すことで、`foreach` ループが複数回実行されても、
13 * ジェネレータが「最初から」データを生成するように見える振る舞いを実現します。
14 */
15
16/**
17 * 一時的なデータファイルを作成するヘルパー関数。
18 *
19 * @param string $filename ファイルパス。
20 * @param array $lines ファイルに書き込む行の配列。
21 */
22function createTemporaryDataFile(string $filename, array $lines): void
23{
24    file_put_contents($filename, implode("\n", $lines));
25}
26
27/**
28 * ファイルストリームを巻き戻し可能なジェネレータとして機能させるクラス。
29 * `IteratorAggregate` を実装することで、`foreach` で複数回イテレーション可能になります。
30 */
31class RewindableStreamGenerator implements IteratorAggregate
32{
33    private string $filePath;
34    private ?resource $fileHandle = null; // ファイルリソースを保持
35
36    /**
37     * コンストラクタ。
38     *
39     * @param string $filePath 読み込むファイルのパス。
40     */
41    public function __construct(string $filePath)
42    {
43        $this->filePath = $filePath;
44    }
45
46    /**
47     * `IteratorAggregate` インターフェースの必須メソッド。
48     * このメソッドが呼び出されるたびに新しいジェネレータが作成されます。
49     * 内部でファイルストリームを開き直すか、既存のストリームを巻き戻します。
50     *
51     * @return Generator ファイルの各行を yield するジェネレータ。
52     * @throws RuntimeException ファイルのオープンに失敗した場合。
53     */
54    public function getIterator(): Generator
55    {
56        // ファイルハンドルがまだ開かれていない場合、または閉じられている場合に開く
57        if (!is_resource($this->fileHandle) || feof($this->fileHandle)) {
58            $this->fileHandle = fopen($this->filePath, 'r'); // 読み取りモードでファイルを開く
59            if (!$this->fileHandle) {
60                throw new RuntimeException("ファイルのオープンに失敗しました: " . $this->filePath);
61            }
62        } else {
63            // 既に開かれているファイルハンドルがある場合、それを巻き戻す
64            // ここで `rewind()` 関数が利用され、ファイルポインタが先頭に戻ります
65            rewind($this->fileHandle);
66        }
67
68        // ファイルから行を読み込み、yield（生成）する
69        while (!feof($this->fileHandle)) {
70            $line = trim(fgets($this->fileHandle));
71            if ($line !== '') {
72                yield $line;
73            }
74        }
75        // ここでファイルハンドルは閉じない。
76        // 同じファイルハンドルを次のイテレーションで再利用するため。
77        // ファイルハンドルはデストラクタで閉じられる。
78    }
79
80    /**
81     * クラスのインスタンスが破棄されるときに、開いているファイルハンドルを閉じます。
82     */
83    public function __destruct()
84    {
85        if (is_resource($this->fileHandle)) {
86            fclose($this->fileHandle);
87            $this->fileHandle = null; // リソースを解放
88        }
89    }
90}
91
92// --- サンプルコードの実行 ---
93
94// 一時ファイルのパスを定義
95$tempFilePath = 'temp_data_rewindable.txt';
96
97// サンプルデータを含む一時ファイルを作成
98createTemporaryDataFile($tempFilePath, [
99    'Line 1: Apple',
100    'Line 2: Banana',
101    'Line 3: Cherry',
102    'Line 4: Date'
103]);
104
105try {
106    // RewindableStreamGenerator のインスタンスを作成
107    $generatorWrapper = new RewindableStreamGenerator($tempFilePath);
108
109    echo "--- 1回目のイテレーション ---\n";
110    // 最初のイテレーション。ファイルが先頭から読み込まれる。
111    foreach ($generatorWrapper as $line) {
112        echo $line . "\n";
113    }
114
115    echo "\n--- 2回目のイテレーション（rewind() 後）---\n";
116    // 2回目のイテレーション。
117    // `foreach` が再度実行されると `getIterator()` メソッドが再度呼び出され、
118    // 内部で `rewind()` が適用されてファイルストリームが先頭に巻き戻される。
119    // そのため、再び最初からデータが読み込まれる。
120    foreach ($generatorWrapper as $line) {
121        echo $line . "\n";
122    }
123
124} catch (RuntimeException $e) {
125    echo "エラー: " . $e->getMessage() . "\n";
126} finally {
127    // 後処理: 作成した一時ファイルを削除
128    if (file_exists($tempFilePath)) {
129        unlink($tempFilePath);
130    }
131}

PHPのrewind()関数は、開かれたファイルやネットワーク接続などのストリームリソースの読み書きポインタを、そのストリームの先頭に戻すために使用されます。引数にはresource $streamとして操作対象のストリームリソースを指定し、処理が成功した場合はtrue、失敗した場合はfalseが戻り値として返されます。

このサンプルコードは、PHPのrewind()関数を活用して「巻き戻し可能なジェネレータ」という概念を示しています。PHPの通常のジェネレータは一度データを生成し終えると、通常は巻き戻して最初から再度生成することはできません。しかし、RewindableStreamGeneratorクラスはIteratorAggregateインターフェースを実装し、内部でファイルストリームを管理しています。foreachループが複数回実行され、getIterator()メソッドが呼び出されるたびに、rewind($this->fileHandle)が適用されます。これにより、既に開かれているファイルストリームの読み込みポインタがファイルの先頭にリセットされるため、ジェネレータは常に最初からファイルの内容を生成し直すことができます。これは、ファイルの内容を複数回にわたって処理したい場合に非常に有効な手法です。

Copy
1<?php
2
3/**
4 * ファイルを作成し、内容を書き込み、rewind関数でファイルポインタを先頭に戻す例。
5 *
6 * rewind関数は、オープンされたファイルポインタをファイルの先頭にセットします。
7 * 主に、一度読み込んだファイルを再度最初から読み込みたい場合などに使用します。
8 */
9function demonstrateRewind(): void
10{
11    // 一時ファイル名を設定
12    $filename = 'example_rewind.txt';
13    $content = "Hello, PHP!\nThis is a test file.\n";
14
15    // ファイルを作成し、内容を書き込む
16    // 'w+' モードは、ファイルが存在すれば内容を空にし、存在しなければ作成します。
17    // そして、読み書き両方が可能です。
18    $handle = fopen($filename, 'w+');
19
20    if ($handle === false) {
21        echo "Error: Could not open or create file '{$filename}'.\n";
22        return;
23    }
24
25    // ファイルに内容を書き込む
26    fwrite($handle, $content);
27    echo "ファイルに内容を書き込みました。\n";
28    echo "ファイルポインタの位置: " . ftell($handle) . " バイト (ファイルの末尾近く)\n";
29
30    // ファイルポインタをファイルの先頭に戻す
31    if (rewind($handle)) {
32        echo "rewind関数を実行しました。ファイルポインタが先頭に戻りました。\n";
33        echo "ファイルポインタの位置: " . ftell($handle) . " バイト (ファイルの先頭)\n";
34
35        // ファイルの内容を最初から再度読み込む
36        // rewindでポインタが先頭に戻っているので、全ての内容が読み込める
37        fseek($handle, 0); // 念のためfseekでも先頭に移動させているが、rewindで十分
38        $readContent = fread($handle, filesize($filename));
39        echo "\nrewind後、ファイル先頭から再度読み込んだ内容:\n";
40        echo "----------------------------------------\n";
41        echo $readContent;
42        echo "----------------------------------------\n";
43    } else {
44        echo "Error: rewind関数が失敗しました。\n";
45    }
46
47    // ファイルリソースを閉じる
48    fclose($handle);
49    echo "ファイル '{$filename}' を閉じました。\n";
50
51    // 作成したファイルを削除（クリーンアップ）
52    if (file_exists($filename)) {
53        unlink($filename);
54        echo "ファイル '{$filename}' を削除しました。\n";
55    }
56}
57
58// 関数の実行
59demonstrateRewind();
60
61?>

PHPのrewind関数は、オープンされたファイルリソースのポインタを、そのファイルの先頭に戻すための関数です。

この関数は、引数として操作したいファイルリソース（resource $stream）を一つ受け取ります。例えば、fopen関数で開いたファイルハンドルなどが該当します。処理が成功した場合はtrueを、失敗した場合はfalseを戻り値（bool）として返します。

サンプルコードでは、まず一時的なファイルを作成し、内容を書き込んでいます。ファイルへの書き込みが完了すると、ファイルポインタは書き込んだ内容の末尾近くに移動します。この状態でrewind関数を実行すると、ファイルポインタはファイルの先頭（0バイト目）に瞬時に戻されます。これにより、一度書き込んだり読み込んだりしたファイルを、もう一度最初から読み込み直したい場合などに非常に役立ちます。

rewindが成功した後、サンプルコードでは再度ファイルの先頭から内容を読み込み、正常に全ての情報が取得できることを示しています。このように、ファイルへのアクセスを最初からやり直したいときにrewind関数は利用されます。

Copy
1<?php
2
3// このサンプルコードは、`rewind(resource $stream)` 関数が
4// ファイルストリームを巻き戻すためにどのように使用されるか、
5// 特にPHPのIteratorインターフェースの実装内で示します。
6// これにより、「rewind」関数と「iterator」の概念が結びつきます。
7
8// デモンストレーション用に一時的なファイルを作成します。
9$filePath = 'example_rewind_iterator.txt';
10file_put_contents($filePath, "最初の行です。\n2番目の行です。\nこれが最後の行です。");
11
12/**
13 * ファイルの各行を反復処理するためのカスタムイテレータクラス。
14 * グローバルな `rewind()` 関数を、イテレータの `rewind()` メソッド内で
15 * ファイルストリームをリセットするために使用する方法を示します。
16 */
17class FileLineIterator implements Iterator
18{
19    /** @var resource|false ファイルポインタのリソース、またはエラーの場合はfalse */
20    private $filePointer;
21
22    /** @var string|false 現在の行の内容、またはファイルの終端の場合はfalse */
23    private $currentLine;
24
25    /** @var int 現在の行番号（キー） */
26    private $lineNumber;
27
28    /** @var string ファイルパス */
29    private $filePath;
30
31    /**
32     * @param string $filePath 反復処理するファイルのパス。
33     * @throws InvalidArgumentException ファイルを開けない場合。
34     */
35    public function __construct(string $filePath)
36    {
37        $this->filePath = $filePath;
38        // ファイルを読み込みモードで開こうとします。
39        $this->filePointer = fopen($filePath, 'r');
40        if ($this->filePointer === false) {
41            throw new InvalidArgumentException("ファイルを開けませんでした: {$filePath}");
42        }
43    }
44
45    /**
46     * イテレータが破棄されるときにファイルポインタを閉じます。
47     */
48    public function __destruct()
49    {
50        if (is_resource($this->filePointer)) {
51            fclose($this->filePointer);
52        }
53    }
54
55    /**
56     * イテレータを最初の要素に巻き戻します。
57     * ここでは、グローバルな `rewind()` 関数を使用して、
58     * ファイルストリームポインタをファイルの先頭にリセットします。
59     */
60    public function rewind(): void
61    {
62        // グローバルな `rewind()` 関数を使用し、ファイルストリームをリセットします。
63        // これはリファレンス情報に記載されている `rewind(resource $stream)` 関数です。
64        rewind($this->filePointer);
65        $this->lineNumber = 0;
66        $this->currentLine = fgets($this->filePointer); // 最初の行を読み込みます。
67    }
68
69    /**
70     * 現在の要素を返します。
71     *
72     * @return string|false 現在の行の内容、またはファイルの終端の場合はfalse。
73     */
74    public function current(): string|false
75    {
76        // 出力をきれいにするために改行文字を削除します。
77        return rtrim((string)$this->currentLine, "\r\n");
78    }
79
80    /**
81     * 現在の要素のキーを返します。
82     *
83     * @return int 現在の行番号。
84     */
85    public function key(): int
86    {
87        return $this->lineNumber;
88    }
89
90    /**
91     * 次の要素に進みます。
92     */
93    public function next(): void
94    {
95        $this->lineNumber++;
96        $this->currentLine = fgets($this->filePointer);
97    }
98
99    /**
100     * `rewind()` または `next()` の呼び出し後に現在の要素があるかどうかを確認します。
101     *
102     * @return bool 現在の位置が有効な場合はtrue、そうでない場合はfalse。
103     */
104    public function valid(): bool
105    {
106        // `fgets` がfalseを返さなかった場合（ファイルの終端ではない場合）は、行は有効です。
107        return $this->currentLine !== false;
108    }
109}
110
111// --- デモンストレーションの実行 ---
112try {
113    $fileIterator = new FileLineIterator($filePath);
114
115    echo "最初の反復処理:\n";
116    foreach ($fileIterator as $lineNumber => $lineContent) {
117        echo "{$lineNumber}: {$lineContent}\n";
118    }
119
120    echo "\n巻き戻して再度反復処理:\n";
121    // カスタムイテレータを使用する場合、2回目の `foreach` ループは
122    // 暗黙的にイテレータの `rewind()` メソッドを再度呼び出します。
123    // これにより、ファイルの先頭から再反復処理できることが示されます。
124    foreach ($fileIterator as $lineNumber => $lineContent) {
125        echo "{$lineNumber}: {$lineContent}\n";
126    }
127
128} catch (InvalidArgumentException $e) {
129    echo "エラー: " . $e->getMessage() . "\n";
130} finally {
131    // デモンストレーション用に作成したファイルをクリーンアップします。
132    if (file_exists($filePath)) {
133        unlink($filePath);
134    }
135}

PHPのrewind関数は、ファイルやネットワーク接続などのリソース型ストリームの内部ポインタを先頭に巻き戻す役割を持つ関数です。引数resource $streamには操作対象のストリームを渡し、成功すればtrue、失敗すればfalseをブール値で返します。

このサンプルコードは、rewind関数がPHPのIteratorインターフェースと組み合わさり、ファイルの反復処理を柔軟に制御する方法を示しています。具体的には、FileLineIteratorクラスがファイルの各行を読み込むカスタムイテレータとして機能します。このクラスに実装されているrewind()メソッドは、PHPのグローバルなrewind($this->filePointer)関数を呼び出しており、ファイルストリームの現在位置を強制的にファイルの先頭に戻しています。

これにより、一度読み終えたファイルも、foreachループなどで複数回、最初から反復処理することが可能となります。サンプルの実行結果からも、最初の反復処理後に再度foreachループを実行すると、ファイルの内容が最初から再び表示されることで、rewind関数の効果と、イテレータのポインタリセット機能が確認できます。この実装は、ファイルのデータを繰り返し利用する場面で非常に役立ちます。

Copy
1<?php
2
3/**
4 * ストリーム（ファイルポインタ）を先頭に巻き戻すrewind関数のサンプルです。
5 *
6 * PHPのrewind関数は、主にファイルやネットワークなどのストリームリソースの
7 * ポインタを先頭に巻き戻すために使用されます。
8 *
9 * キーワードに「mysql result」とありますが、rewind関数はMySQLの結果セットリソースには
10 * 直接適用できません。MySQLの結果セット（mysqli_resultオブジェクトなど）のポインタを
11 * 先頭に巻き戻したい場合は、mysqli_result::data_seek(0)メソッドを使用します。
12 *
13 * このサンプルでは、rewind関数の正しい使用方法としてファイル操作を例示します。
14 */
15function demonstrateRewindFunction(): void
16{
17    $filename = 'example.txt';
18    $fileContent = "Line 1\nLine 2\nLine 3\n";
19
20    // テスト用のファイルを作成し、内容を書き込みます。
21    file_put_contents($filename, $fileContent);
22
23    // ファイルを読み書きモードでオープンします。
24    $stream = fopen($filename, 'r+');
25
26    if ($stream === false) {
27        echo "Error: Could not open file '{$filename}'.\n";
28        return;
29    }
30
31    echo "--- First read ---\n";
32    // ファイルの内容を全て読み込み、ファイルポインタはファイルの終端へ移動します。
33    while (($line = fgets($stream)) !== false) {
34        echo trim($line) . "\n";
35    }
36    echo "Current position after first read: " . ftell($stream) . " bytes\n\n";
37
38    // ファイルポインタをストリームの先頭に巻き戻します。
39    // rewind() は、ストリームリソースを引数に取り、成功すれば true、失敗すれば false を返します。
40    if (rewind($stream)) {
41        echo "File pointer successfully rewound to the beginning.\n\n";
42
43        echo "--- Second read after rewind ---\n";
44        // ポインタが先頭に戻ったので、もう一度最初からファイルを読み込めます。
45        while (($line = fgets($stream)) !== false) {
46            echo trim($line) . "\n";
47        }
48        echo "Current position after second read: " . ftell($stream) . " bytes\n";
49    } else {
50        echo "Failed to rewind file pointer.\n";
51    }
52
53    // ファイルストリームを閉じます。
54    fclose($stream);
55
56    // 作成したテストファイルを削除します。
57    unlink($filename);
58}
59
60// 関数を実行してrewindの動作を確認します。
61demonstrateRewindFunction();

PHPのrewind関数は、ファイルやネットワーク接続など「ストリームリソース」と呼ばれるデータの流れにおける読み書き位置（ポインタ）を、そのストリームの先頭に巻き戻すための関数です。この関数は引数として操作したいストリームリソース（resource $stream）を一つ受け取り、ポインタの巻き戻し処理が成功した場合はtrue、失敗した場合はfalseをブール値（bool）で返します。

サンプルコードでは、まずexample.txtというファイルを準備し、その内容を一度読み込むことでファイルポインタがファイルの終端へ移動する様子を示しています。その後、rewind関数を呼び出すことで、このファイルポインタを再度ファイルの先頭に戻しています。ポインタが先頭に戻ったことで、同じファイルを最初からもう一度読み込むことが可能になり、その結果を出力しています。

キーワードにある「mysql result」についてですが、rewind関数はMySQLの結果セットのようなデータベースのリソースには直接適用できません。MySQLの結果セットのポインタを先頭に戻したい場合は、通常mysqli_result::data_seek(0)のような専用のメソッドを使用します。このサンプルは、rewind関数の正しい使い方をファイル操作の例を通して具体的に学ぶことができます。