【PHP8.x】php_user_filter::filternameプロパティの使い方

filternameプロパティは、ユーザー定義のストリームフィルターの名前を保持するプロパティです。このプロパティは、PHPの組み込みクラスであるphp_user_filterを継承して、独自のストリームフィルターを実装する際に利用されます。php_user_filterクラスは、ファイルやネットワーク通信などのデータストリームに対して、データを読み書きする途中で加工や変換を行うための仕組みを提供する基盤となります。

このfilternameプロパティには、ユーザーがstream_filter_register()関数を使ってPHPにフィルターを登録した際に指定した正式名称が格納されます。例えば、「my_custom_filter」という名前でフィルターを登録した場合、このプロパティには「my_custom_filter」という文字列が設定されます。このフィルター名は、その後stream_filter_append()やstream_filter_prepend()といった関数を使用して、実際にストリームにフィルターを適用する際に指定する識別子として機能します。

ユーザーが定義したフィルターのインスタンスが作成される際、具体的にはphp_user_filter::onCreate()メソッドが実行されるタイミングで、このfilternameプロパティには該当するフィルター名が自動的に設定されます。これにより、フィルターの実装者は、自身のフィルターがどの名前でシステムに登録され、現在利用されているかをプログラム内部で参照できるようになります。この情報は、複数のフィルターを扱う場合や、特定のフィルター名に応じた挙動の変更、あるいはデバッグを行う際に役立ち、より柔軟で堅牢なストリームフィルターの開発に貢献します。

Copy
1<?php
2
3class MyCustomFilter extends php_user_filter
4{
5    public string $filtername;
6}

引数なし

引数はありません

戻り値なし

戻り値はありません