php_user_filter::onCreate

(PHP 5, PHP 7, PHP 8)

php_user_filter::onCreate — フィルタを作成するときにコールされる

public php_user_filter::onCreate(): bool

このメソッドがコールされるのは、フィルタクラスのオブジェクトのインスタンスを生成するときです。他のリソース (バッファなど) を確保したり初期化したりする場合は、このメソッドで行います。

フィルタのインスタンスを作成して yourfilter->onCreate() をコールすると、以下の表に示すさまざまなプロパティが使えるようになります。

プロパティ	内容
`FilterClass->filtername`	フィルタのインスタンスを作成するときの名前を表す文字列。フィルタを登録するときには、複数の名前を使ったりワイルドカードを使ったりできます。このプロパティを使って、どの名前が用いられたのかを判断します。
`FilterClass->params`	stream_filter_append() あるいは stream_filter_prepend() に渡された `params` パラメータの内容。
`FilterClass->stream`	フィルタの対象となるストリームリソース。 `closing` パラメータが `false` の状態で filter() がコールされている間だけ存在します。

この関数にはパラメータはありません。

このメソッドを実装は、成功した場合に true そして失敗した場合に false を返す必要があります。

There are no user contributed notes for this page.