【PHP8.x】STREAM_FILTER_READ定数の使い方

Copy
1<?php
2
3/**
4 * カスタムストリームフィルターを定義するクラス。
5 * 入力されたデータをすべて大文字に変換します。
6 */
7class UppercaseFilter extends php_user_filter
8{
9    /**
10     * ストリームを通過するデータをフィルタリングします。
11     *
12     * @param resource $in       入力バケットブリゲード（フィルタリング前のデータを含む）
13     * @param resource $out      出力バケットブリゲード（フィルタリング後のデータを格納）
14     * @param int      $consumed このフィルタによって消費されたバイト数
15     * @param bool     $closing  ストリームが閉じられようとしているかどうかのフラグ
16     * @return int 成功時はPSFS_PASS_ON_SUCCESS、エラー時はPSFS_ERR_FATAL
17     */
18    public function filter($in, $out, &$consumed, $closing)
19    {
20        while ($bucket = stream_bucket_make_writeable($in)) {
21            // バケット内のデータを大文字に変換する処理
22            $bucket->data = strtoupper($bucket->data);
23            $consumed += $bucket->datalen; // 消費したバイト数を加算
24            stream_bucket_append($out, $bucket); // フィルタリングされたデータを$outに追加
25        }
26
27        return PSFS_PASS_ON_SUCCESS; // 処理成功を返す
28    }
29}
30
31// 1. カスタムストリームフィルターを登録する
32// 'uppercase.filter' はこのフィルタを参照するための名前です。
33if (!stream_filter_register('uppercase.filter', UppercaseFilter::class)) {
34    die("Error: Failed to register filter 'uppercase.filter'.\n");
35}
36
37// 2. 処理対象のストリームを開く（ここでは一時的なメモリ上ストリームを使用）
38$stream = fopen('php://temp', 'r+');
39if (!$stream) {
40    die("Error: Failed to open stream.\n");
41}
42
43// 3. ストリームにデータを書き込む
44$originalData = "hello, php stream filters! this is a test.";
45fwrite($stream, $originalData);
46
47// ストリームポインタを先頭に戻す（読み込みのために必要）
48rewind($stream);
49
50// 4. ストリームに登録したフィルタを追加する
51// STREAM_FILTER_READ は、フィルタがストリームからの「読み込み」操作時に適用されることを示します。
52$filterResource = stream_filter_append($stream, 'uppercase.filter', STREAM_FILTER_READ);
53
54if (!$filterResource) {
55    fclose($stream);
56    die("Error: Failed to append filter to stream.\n");
57}
58
59// 5. フィルタが適用されたストリームからデータを読み込む
60// ここでUppercaseFilterが適用され、データが大文字に変換されて読み込まれます。
61$filteredData = stream_get_contents($stream);
62
63// 結果を出力
64echo "Original data: " . $originalData . PHP_EOL;
65echo "Filtered data (read from stream): " . $filteredData . PHP_EOL;
66
67// 6. ストリームとフィルタのリソースをクリーンアップする
68stream_filter_remove($filterResource); // フィルタをストリームから削除
69fclose($stream); // ストリームを閉じる
70

PHPのSTREAM_FILTER_READ定数は、PHPのストリームフィルタ機能において、フィルタを適用するタイミングを指定するために使用されます。この定数を指定すると、ストリームからデータを「読み込む」際にフィルタが適用されるようになります。STREAM_FILTER_READ自体に引数はなく、整数値（int）を返しますが、これはstream_filter_appendなどの関数に渡すことで、フィルタの適用方向を制御する役割を果たします。

提供されたサンプルコードでは、UppercaseFilterというクラスで、ストリームを通過するデータをすべて大文字に変換するカスタムフィルタを定義しています。まず、stream_filter_register関数を使って、このカスタムフィルタをPHPシステムに「uppercase.filter」という名前で登録しています。次に、一時的なメモリ上にストリームを開き、元のデータを書き込みます。その後、stream_filter_append関数を使って、このストリームに「uppercase.filter」を追加する際にSTREAM_FILTER_READを指定しています。これにより、このストリームからデータを読み出すときに、UppercaseFilterが適用され、データが自動的に大文字に変換されるようになります。実際にstream_get_contentsでデータを読み込むと、元のデータがすべて大文字に変換されて取得されることが確認できます。このように、STREAM_FILTER_READは、データの読み込み処理に特定の加工処理を透過的に組み込む際に利用される重要な定数です。

Copy
1<?php
2
3/**
4 * STREAM_FILTER_READ 定数と stream_filter_append 関数を使用して、
5 * 読み込みストリームフィルターの動作を実演するサンプルコード。
6 *
7 * この関数は、ファイルからデータを読み込む際に、指定したフィルターを適用する方法を示します。
8 * 例として、ファイルにROT13エンコードされたテキストを書き込み、
9 * 読み込み時に 'string.rot13' フィルターを適用して元のテキストにデコードします。
10 */
11function demonstrateStreamFilterRead(): void
12{
13    // 1. テスト用のファイルパスを定義します。
14    $filename = 'stream_filter_test_file.txt';
15    
16    // 2. 元のデータと、ファイルに書き込むROT13エンコード済みデータを準備します。
17    $originalData = "Hello, System Engineer Beginner!";
18    // ファイルには、あらかじめROT13でエンコードされたデータを書き込みます。
19    $dataToWrite = str_rot13($originalData); 
20
21    // 3. テストファイルを一時的に作成し、エンコード済みデータを書き込みます。
22    if (file_put_contents($filename, $dataToWrite) === false) {
23        echo "エラー: テストファイルの作成または書き込みに失敗しました。" . PHP_EOL;
24        return;
25    }
26
27    echo "ファイルに書き込まれたデータ (ROT13エンコード済み): " . $dataToWrite . PHP_EOL;
28
29    // 4. ファイルを読み込みモード ('r') でオープンし、ストリームリソースを取得します。
30    $handle = fopen($filename, 'r');
31    if ($handle === false) {
32        echo "エラー: ファイルのオープンに失敗しました。" . PHP_EOL;
33        unlink($filename); // エラー時は作成したファイルを削除
34        return;
35    }
36
37    // 5. stream_filter_append を使用して、ROT13フィルターを読み込みモードで追加します。
38    // STREAM_FILTER_READ 定数を指定することで、ストリームからの「読み込み時」にのみフィルターが適用されます。
39    // これにより、ファイルからデータが読み出される際に、自動的にROT13デコードが行われます。
40    $filterResource = stream_filter_append($handle, 'string.rot13', STREAM_FILTER_READ);
41
42    if ($filterResource === false) {
43        echo "エラー: ストリームフィルターの追加に失敗しました。" . PHP_EOL;
44        fclose($handle);    // ファイルハンドルをクローズ
45        unlink($filename);  // 作成したファイルを削除
46        return;
47    }
48
49    // 6. ファイルからデータを読み込みます。
50    // 読み込み時に 'string.rot13' フィルターが自動的に適用され、データがデコードされます。
51    $readData = stream_get_contents($handle);
52
53    echo "フィルター適用後の読み込みデータ: " . $readData . PHP_EOL;
54
55    // 7. 読み込まれたデータが元のデータと一致するか確認します。
56    if ($readData === $originalData) {
57        echo "結果: フィルターが正しく適用され、データがデコードされました。" . PHP_EOL;
58    } else {
59        echo "結果: エラーが発生しました。フィルターの適用に問題がある可能性があります。" . PHP_EOL;
60    }
61
62    // 8. ストリームリソースをクローズし、テストファイルを削除してクリーンアップします。
63    fclose($handle);
64    unlink($filename);
65}
66
67// 上記のデモンストレーション関数を実行します。
68demonstrateStreamFilterRead();
69

このサンプルコードは、PHPのSTREAM_FILTER_READ定数とstream_filter_append関数を用いて、ファイルからデータを読み込む際にストリームフィルターを適用する仕組みを実演しています。STREAM_FILTER_READは整数型の定数で、stream_filter_append関数の引数として指定すると、ストリームからデータが「読み込まれる時」にのみフィルターを適用するよう指示します。stream_filter_append関数は、ファイルハンドルなどのストリームリソースに特定のフィルターを追加する役割を持ち、成功するとフィルターリソースを、失敗するとfalseを返します。

具体的には、まず元のテキストをROT13でエンコードしたデータを一時ファイルに書き込みます。次に、そのファイルを読み込みモードで開き、stream_filter_append関数にファイルハンドル、'string.rot13'フィルター名、そしてSTREAM_FILTER_READ定数を指定してフィルターを追加します。これにより、ファイルからデータを読み込む際に、ストリームは自動的にROT13デコード処理を実行します。最終的に、読み込まれたデータが元のテキストと一致することを確認し、フィルターが正しく適用されたことを示しています。この機能は、ファイルに保存された圧縮データや暗号化データを透過的に処理する際に役立ちます。