(PHP 5, PHP 7, PHP 8)
stream_filter_register — 注册用户定义的流过滤器
filter_name要注册的过滤器名称。
class要实现过滤器，您需要定义一个类作为 php_user_filter 的扩展，并包含多个成员函数。当对附加了过滤器的流执行读/写操作时，PHP 将数据通过您的过滤器（以及附加到该流的任何其他过滤器）传递，以便可以根据需要修改数据。您必须按照 php_user_filter 中的描述完全实现这些方法 - 否则会导致未定义的行为。
范例 #1 对 foo-bar.txt 流中的字符进行大写
以下示例在 foo-bar.txt 流上实现了一个名为 strtoupper 的过滤器，它将对写入/读取该流的所有字母字符进行大写。
<?php
/* 定义我们的过滤器类 */
class strtoupper_filter extends php_user_filter {
function filter($in, $out, &$consumed, $closing)
{
while ($bucket = stream_bucket_make_writeable($in)) {
$bucket->data = strtoupper($bucket->data);
$consumed += $bucket->datalen;
stream_bucket_append($out, $bucket);
}
return PSFS_PASS_ON;
}
}
/* 将我们的过滤器注册到 PHP 中 */
stream_filter_register("strtoupper", "strtoupper_filter")
or die("Failed to register filter");
$fp = fopen("foo-bar.txt", "w");
/* 将注册的过滤器附加到刚刚打开的流 */
stream_filter_append($fp, "strtoupper");
fwrite($fp, "Line1\n");
fwrite($fp, "Word - 2\n");
fwrite($fp, "Easy As 123\n");
fclose($fp);
/* 读取回内容
*/
readfile("foo-bar.txt");
?>上面的示例将输出
LINE1 WORD - 2 EASY AS 123
范例 #2 注册通用过滤器类以匹配多个过滤器名称。
<?php
/* 定义我们的过滤器类 */
class string_filter extends php_user_filter {
var $mode;
function filter($in, $out, &$consumed, $closing)
{
while ($bucket = stream_bucket_make_writeable($in)) {
if ($this->mode == 1) {
$bucket->data = strtoupper($bucket->data);
} elseif ($this->mode == 0) {
$bucket->data = strtolower($bucket->data);
}
$consumed += $bucket->datalen;
stream_bucket_append($out, $bucket);
}
return PSFS_PASS_ON;
}
function onCreate()
{
if ($this->filtername == 'str.toupper') {
$this->mode = 1;
} elseif ($this->filtername == 'str.tolower') {
$this->mode = 0;
} else {
/* 请求了其他 str.* 过滤器，
报告失败，以便 PHP 继续查找 */
return false;
}
return true;
}
}
/* 向 PHP 注册我们的过滤器 */
stream_filter_register("str.*", "string_filter")
or die("Failed to register filter");
$fp = fopen("foo-bar.txt", "w");
/* 将注册的过滤器附加到刚刚打开的流
我们也可以在这里绑定到 str.tolower */
stream_filter_append($fp, "str.toupper");
fwrite($fp, "Line1\n");
fwrite($fp, "Word - 2\n");
fwrite($fp, "Easy As 123\n");
fclose($fp);
/* 读取回内容
*/
readfile("foo-bar.txt");
?>上面的示例将输出
LINE1 WORD - 2 EASY AS 123