如何用 stream_filter_append 创建简单的文本转换过滤器？

gitbox 2025-09-29

如何用 stream_filter_append 创建简单的文本转换过滤器？

在 PHP 中，stream_filter_append() 函数允许我们为流（stream）附加一个过滤器，这样就可以对流中的数据进行实时的处理和转换。本文将介绍如何利用 stream_filter_append() 创建一个简单的文本转换过滤器，操作流中的数据并进行一些常见的文本转换，如大写转换、小写转换等。

什么是 stream_filter_append()？

stream_filter_append() 是一个 PHP 内建函数，它允许你为某个流附加一个过滤器。过滤器的作用是对流中的数据进行处理，例如：修改、转换、压缩等。流过滤器可以是内建的，也可以是你自定义的。

基本语法

<span><span><span class="hljs-title function_ invoke__">stream_filter_append</span></span><span>(resource </span><span><span class="hljs-variable">$stream</span></span><span>, </span><span><span class="hljs-keyword">string</span></span><span> </span><span><span class="hljs-variable">$filtername</span></span><span>, </span><span><span class="hljs-keyword">int</span></span><span> </span><span><span class="hljs-variable">$read_write</span></span><span> = STREAM_FILTER_READ, </span><span><span class="hljs-keyword">mixed</span></span><span> </span><span><span class="hljs-variable">$params</span></span><span> = </span><span><span class="hljs-literal">null</span></span><span>): </span><span><span class="hljs-keyword">bool</span></span><span>
</span></span>

$stream：要附加过滤器的流。
$filtername：过滤器的名称，可以是内建的过滤器或自定义的过滤器。
$read_write：指定是读取流还是写入流。STREAM_FILTER_READ 表示读取流，STREAM_FILTER_WRITE 表示写入流。
$params：传递给过滤器的参数（可选）。

创建一个简单的文本转换过滤器

下面是一个创建文本转换过滤器的例子，我们将实现一个将文本转换为大写的过滤器。

步骤一：定义自定义过滤器

首先，我们需要创建一个简单的过滤器类，继承 php_user_filter 类并实现它的方法。这个过滤器将会把流中的文本转换成大写。

<span><span><span class="hljs-class"><span class="hljs-keyword">class</span></span></span><span> </span><span><span class="hljs-title">UppercaseFilter</span></span><span> </span><span><span class="hljs-keyword">extends</span></span><span> </span><span><span class="hljs-title">php_user_filter</span></span><span> {
    </span><span><span class="hljs-keyword">public</span></span><span> </span><span><span class="hljs-function"><span class="hljs-keyword">function</span></span></span><span> </span><span><span class="hljs-title">filter</span></span><span>(</span><span><span class="hljs-params"><span class="hljs-variable">$in</span></span></span><span>, </span><span><span class="hljs-variable">$out</span></span><span>, &amp;</span><span><span class="hljs-variable">$consumed</span></span><span>, </span><span><span class="hljs-variable">$closing</span></span><span>) {
        </span><span><span class="hljs-keyword">while</span></span><span> (</span><span><span class="hljs-variable">$bucket</span></span><span> = </span><span><span class="hljs-title function_ invoke__">stream_bucket_make_writeable</span></span><span>(</span><span><span class="hljs-variable">$in</span></span><span>)) {
            </span><span><span class="hljs-comment">// 将流中的数据转换为大写</span></span><span>
            </span><span><span class="hljs-variable">$bucket</span></span><span>-&gt;data = </span><span><span class="hljs-title function_ invoke__">strtoupper</span></span><span>(</span><span><span class="hljs-variable">$bucket</span></span><span>-&gt;data);
            </span><span><span class="hljs-comment">// 将转换后的数据输出到目标流</span></span><span>
            </span><span><span class="hljs-title function_ invoke__">stream_bucket_append</span></span><span>(</span><span><span class="hljs-variable">$out</span></span><span>, </span><span><span class="hljs-variable">$bucket</span></span><span>);
        }
        </span><span><span class="hljs-keyword">return</span></span><span> PSFS_PASS_ON;
    }
}
</span></span>

在这个类中，filter() 方法是最关键的部分，它会接收输入流的数据，将其转换为大写后再输出到目标流。

步骤二：注册过滤器

接下来，我们需要使用 stream_filter_register() 函数将这个自定义的过滤器注册到 PHP 环境中。

<span><span><span class="hljs-title function_ invoke__">stream_filter_register</span></span><span>(</span><span><span class="hljs-string">"uppercase"</span></span><span>, </span><span><span class="hljs-string">"UppercaseFilter"</span></span><span>) </span><span><span class="hljs-keyword">or</span></span><span> </span><span><span class="hljs-keyword">die</span></span><span>(</span><span><span class="hljs-string">"Filter registration failed"</span></span><span>);
</span></span>

通过这个步骤，我们将 UppercaseFilter 注册为一个名为 uppercase 的过滤器，供我们在流处理中使用。

步骤三：使用 stream_filter_append() 添加过滤器

我们可以通过 stream_filter_append() 将注册的过滤器附加到一个流上。下面是一个例子，展示如何读取一个文本文件，并通过流过滤器将其内容转换为大写。

<span><span><span class="hljs-meta">&lt;?php</span></span><span>
</span><span><span class="hljs-comment">// 注册过滤器</span></span><span>
</span><span><span class="hljs-title function_ invoke__">stream_filter_register</span></span><span>(</span><span><span class="hljs-string">"uppercase"</span></span><span>, </span><span><span class="hljs-string">"UppercaseFilter"</span></span><span>) </span><span><span class="hljs-keyword">or</span></span><span> </span><span><span class="hljs-keyword">die</span></span><span>(</span><span><span class="hljs-string">"Filter registration failed"</span></span><span>);

</span><span><span class="hljs-comment">// 打开文件流</span></span><span>
</span><span><span class="hljs-variable">$stream</span></span><span> = </span><span><span class="hljs-title function_ invoke__">fopen</span></span><span>(</span><span><span class="hljs-string">"example.txt"</span></span><span>, </span><span><span class="hljs-string">"r"</span></span><span>);

</span><span><span class="hljs-comment">// 将自定义的转换过滤器附加到文件流上</span></span><span>
</span><span><span class="hljs-title function_ invoke__">stream_filter_append</span></span><span>(</span><span><span class="hljs-variable">$stream</span></span><span>, </span><span><span class="hljs-string">"uppercase"</span></span><span>, STREAM_FILTER_READ);

</span><span><span class="hljs-comment">// 读取文件内容并输出</span></span><span>
</span><span><span class="hljs-keyword">while</span></span><span> (</span><span><span class="hljs-variable">$line</span></span><span> = </span><span><span class="hljs-title function_ invoke__">fgets</span></span><span>(</span><span><span class="hljs-variable">$stream</span></span><span>)) {
    </span><span><span class="hljs-keyword">echo</span></span><span> </span><span><span class="hljs-variable">$line</span></span><span>;
}

</span><span><span class="hljs-comment">// 关闭文件流</span></span><span>
</span><span><span class="hljs-title function_ invoke__">fclose</span></span><span>(</span><span><span class="hljs-variable">$stream</span></span><span>);
</span><span><span class="hljs-meta">?&gt;</span></span><span>
</span></span>

在上面的例子中，我们打开了一个名为 example.txt 的文件，并将 uppercase 过滤器附加到文件流上。每当我们读取流中的数据时，过滤器会自动将其转换为大写字母，然后再输出。

步骤四：测试和验证

假设 example.txt 文件中的内容如下：

<span><span>hello world
</span><span><span class="hljs-keyword">this</span></span><span> </span><span><span class="hljs-keyword">is</span></span><span> a test.
</span></span>

运行以上代码后，输出将会是：

<span><span>HELLO WORLD
THIS IS </span><span><span class="hljs-selector-tag">A</span></span><span> TEST.
</span></span>

可以看到，所有的文本都被转换成了大写字母。

总结

通过 stream_filter_append()，我们可以轻松地为流添加过滤器，以实现对数据的实时处理。在本文中，我们创建了一个简单的文本转换过滤器，将输入文本转换为大写。通过自定义过滤器和流的组合，PHP 提供了强大的流数据处理能力，能够满足各种复杂的场景需求。

希望通过这个简单的例子，您能够理解如何使用 stream_filter_append() 来创建自己的流过滤器并应用于文本处理。