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

Copy
1<?php
2
3/**
4 * カスタムストリームフィルタの例。
5 * このフィルタは、ストリームに書き込まれるすべてのテキストデータを大文字に変換します。
6 * php_user_filter クラスを継承して実装します。
7 */
8class MyUpperCaseFilter extends php_user_filter
9{
10    /**
11     * ストリームフィルタリングのメインロジックを定義するメソッドです。
12     *
13     * @param resource $in  入力バケットブリゲート（フィルターに入るデータ）
14     * @param resource $out 出力バケットブリゲート（フィルターから出るデータ）
15     * @param int      &$consumed 処理されたバイト数を追跡するための参照変数
16     * @param bool     $closing ストリームが閉じられているかどうかを示すフラグ
17     * @return int フィルタリングの結果ステータス（例: PSFS_PASS_ON は処理を続行）
18     */
19    public function filter($in, $out, &$consumed, $closing): int
20    {
21        // 入力バケットブリゲートから利用可能なすべてのバケットを処理します。
22        while ($bucket = stream_bucket_make_writeable($in)) {
23            // バケット内のデータを大文字に変換します。
24            $bucket->data = strtoupper($bucket->data);
25            // 処理されたバイト数を加算します。
26            $consumed += $bucket->datalen;
27            // 処理済みのバケットを出力バケットブリゲートに追加します。
28            stream_bucket_append($out, $bucket);
29        }
30
31        // フィルタリング処理を継続することを示します。
32        return PSFS_PASS_ON;
33    }
34}
35
36// 'my_uppercase_filter' という名前でカスタムフィルタを登録します。
37// これにより、他の PHP 関数からこのフィルタ名を指定して使用できるようになります。
38stream_filter_register('my_uppercase_filter', MyUpperCaseFilter::class);
39
40// メモリストリーム（一時的にメモリ上に作成される仮想ファイル）を
41// 書き込みと読み込みが可能なモード ('w+') で開きます。
42$fp = fopen('php://memory', 'w+');
43
44// 開いたストリームにカスタムフィルタをアタッチします。
45// 'my_uppercase_filter' を適用し、第三引数 STREAM_FILTER_WRITE は、
46// このフィルタがストリームへの「書き込み」操作に適用されることを指定します。
47stream_filter_append($fp, 'my_uppercase_filter', STREAM_FILTER_WRITE);
48
49// ストリームにデータを書き込みます。
50// ここで書き込まれたデータは、アタッチされた MyUpperCaseFilter によって処理されます。
51fwrite($fp, "hello, world!\n");
52fwrite($fp, "php 8 is awesome.\n");
53
54// ストリームのポインタを先頭に戻します。
55// これにより、書き込まれた（そしてフィルタされた）内容を最初から読み出すことができます。
56rewind($fp);
57
58// フィルタが適用された後のストリームの内容をすべて読み込みます。
59// $filteredContent 変数には、大文字に変換されたテキストが格納されます。
60$filteredContent = stream_get_contents($fp);
61
62// ストリームを閉じ、リソースを解放します。
63fclose($fp);
64
65// $filteredContent の内容を検査することで、フィルタが正しく動作したことを確認できます。
66// (例: "HELLO, WORLD!\nPHP 8 IS AWESOME.\n" となります)

このPHPサンプルコードは、ストリーム（データの流れ）に対してカスタムフィルタを適用し、書き込み操作時にデータを自動的に加工する方法を示しています。

STREAM_FILTER_WRITEは、ストリームにフィルタをアタッチする際に、そのフィルタがストリームへの「書き込み」操作に適用されることを指定するための定数です。この定数の値は整数（int）です。

コードではまず、MyUpperCaseFilterというクラスを定義し、ストリームに書き込まれるテキストデータをすべて大文字に変換するカスタムフィルタを実装しています。次に、stream_filter_register関数を使って、このMyUpperCaseFilterをmy_uppercase_filterという名前でPHPシステムに登録します。

その後、fopen関数で一時的なメモリストリームを開き、stream_filter_append関数を使って、登録したmy_uppercase_filterをこのストリームにアタッチしています。ここでSTREAM_FILTER_WRITE定数を指定することで、フィルタがストリームへのデータ「書き込み」時のみに適用されるように設定しています。

fwrite関数で「hello, world!」のような小文字のデータをストリームに書き込むと、アタッチされたMyUpperCaseFilterが自動的にそのデータを大文字に変換します。最後に、rewindでストリームの読み取り位置を先頭に戻し、stream_get_contentsで変換後のデータをすべて読み出すと、「HELLO, WORLD!」のように大文字に変換されたテキストが取得できることを確認できます。これにより、ストリームを介したデータの流れを透過的に加工できる仕組みを理解できます。

Copy
1<?php
2
3/**
4 * ストリームに書き込みフィルターを適用するサンプル
5 *
6 * この関数は、一時ファイルストリームを作成し、`STREAM_FILTER_WRITE`定数を使用して
7 * 書き込み操作にのみフィルターを適用する方法を示します。
8 * `stream_filter_append`関数を使って、書き込まれるデータを大文字に変換するフィルターを追加します。
9 */
10function demonstrateStreamFilterWrite(): void
11{
12    // 一時ファイルストリームを作成し、書き込みモードで開く
13    // `tmpfile()`は、ユニークな一時ファイルを作成し、そのファイルポインタを返します。
14    $tempFileStream = tmpfile();
15    if ($tempFileStream === false) {
16        echo "一時ファイルの作成に失敗しました。\n";
17        return;
18    }
19
20    // ストリームに「string.toupper」フィルターを書き込みモードで追加
21    // `STREAM_FILTER_WRITE`定数は、フィルターが書き込み操作にのみ適用されることを指定します。
22    // これにより、ストリームに書き込まれるデータは、ファイルに保存される前にすべて大文字に変換されます。
23    $filter = stream_filter_append($tempFileStream, 'string.toupper', STREAM_FILTER_WRITE);
24
25    if ($filter === false) {
26        echo "フィルターの追加に失敗しました。\n";
27        fclose($tempFileStream); // エラー時はストリームを閉じる
28        return;
29    }
30
31    // データをストリームに書き込む
32    $originalData = "Hello world from PHP stream filters!\n";
33    fwrite($tempFileStream, $originalData);
34    echo "元データ: " . $originalData;
35
36    // ストリームのポインタを先頭に戻し、書き込まれた内容を読み込む
37    // 書き込み時にフィルターが適用されているため、読み込まれるデータはすでに変換済みです。
38    fseek($tempFileStream, 0);
39    $filteredData = stream_get_contents($tempFileStream);
40    echo "フィルター適用後（ファイルから読み込み）: " . $filteredData;
41
42    // ストリームを閉じる（一時ファイルは自動的に削除されます）
43    fclose($tempFileStream);
44}
45
46// 関数の実行
47demonstrateStreamFilterWrite();
48

PHP 8のSTREAM_FILTER_WRITEは、ストリームに適用されるフィルターを「書き込み操作時のみ」に限定するための整数型の定数です。この定数自体に引数はなく、戻り値としてその整数値を示します。

このサンプルコードは、STREAM_FILTER_WRITE定数とstream_filter_append関数を組み合わせて、ストリームへの書き込みデータを自動的に加工する方法を示しています。まず、tmpfile()関数でユニークな一時ファイルストリームを作成します。次に、stream_filter_append関数を用いて、このストリームに「string.toupper」（書き込まれるデータを全て大文字に変換する）フィルターをSTREAM_FILTER_WRITEモードで追加します。

これにより、fwrite()関数でストリームにデータを書き込む際、そのデータは一時ファイルに保存される前に自動的に大文字に変換されます。データ書き込み後、fseek()関数でストリームのポインタを先頭に戻し、stream_get_contents()関数で内容を読み出すと、フィルターによって変換された大文字のデータが確認できます。処理完了後、fclose()関数でストリームを閉じると、一時ファイルは自動的に削除されます。この例は、ストリームへの書き込み操作時に、データを透過的に加工する基本的な流れを実演しています。