関数・クラス解説

php_user_filter::filter

version:PHP 5, PHP 7 (公式)

フィルタを適用するときにコールされる

public php_user_filter::filter ( resource $in , resource $out , int &$consumed , bool $closing ) : int

このメソッドがコールされるのは、アタッチしたストリームとの間で (fread() や fwrite() による) データの読み書きを行ったときです。

in: in はバケット群を指すリソースで、この中には一つあるいは複数のバケットオブジェクトが含まれています。このオブジェクトに、フィルタ対象のデータが含まれます。
out: out はもう一つのバケット群を指すリソースで、変更した内容をここに保存します。
consumed: consumed は常に参照渡しとする必要があります。フィルタで読み込んだり変更したりしたデータの長さをここで加算します。大半の場合、各 $bucket 上で $bucket->datalen をコールするたびに consumed を増やすことになります。
closing: ストリームが終了処理の最中である場合 (つまり、フィルタチェインの最後の処理を行っている場合) に、closing パラメータが TRUE となります。

filter() メソッドは、処理を終えたときに次のいずれかの値を返す必要があります。

返り値	意味
PSFS_PASS_ON	フィルタの処理が成功し、データが out バケット群に保存されました。
PSFS_FEED_ME	フィルタの処理は成功しましたが、返すデータはありません。ストリームあるいは一つ前のフィルタから、さらにデータが必要です。
PSFS_ERR_FATAL (デフォルト)	フィルタで対処不能なエラーが発生し、処理を続行できません。

※入力キーワードが、関数名・説明文・タグに含まれるものを検索

●stristr
　大文字小文字を区別せず文字列を検索し、ヒット箇所以降（あるいは以前）の文字列を返却

●stripslashes
　バックスラッシュでエスケープされた文字列から、バックスラッシュを取り除く

●stripos
　大文字小文字を区別せずに文字列が最初に現れる位置を取得する

●stripcslashes
　addcslashes() でクォートされた文字列をアンクォートする

●strip_tags
　文字列から HTML と PHP のタグを除去して返却

●strcspn
　指定した文字が最初に現れる位置を調べる

●strcoll
　ロケールに基づいて2つの文字列を比較し同じか（あるいは大小）を判定する

●strcmp
　2つの文字列を比較し同じか（あるいは大小）を判定する

●strchr
　strstr() のエイリアス

●strcasecmp
　2つの文字列を比較（大文字小文字を区別せず同じとみなす）