stream_filter_prepend

stream_filter_prepend

(PHP 4 >= 4.3.0, PHP 5, PHP 7)

stream_filter_prepend - 将过滤器附加到流中

描述

resource stream_filter_prepend ( resource $stream , string $filtername [, int $read_write [, mixed $params ]] )

添加filtername到附加的过滤器列表中stream。

参数

stream

目标流。

filtername

过滤器名称。

read_write

默认情况下，如果打开文件（即文件模式：r和/或+），stream_filter_prepend()会将过滤器附加到读取过滤器链中。如果文件被打开进行写入（即文件模式：w，a和/或+），则过滤器也将附加到写入过滤器链中。，和/或也可以传递给参数以覆盖此行为。有关使用此参数的示例，请参阅stream_filter_append()。STREAM_FILTER_READSTREAM_FILTER_WRITESTREAM_FILTER_ALLread_write

params

该过滤器将与指定的列表一起添加params到列表的开头，因此将在流操作期间首先调用该过滤器。要将过滤器添加到列表的末尾，请使用stream_filter_append()。

返回值

成功返回资源或失败时返回FALSE。在调用stream_filter_remove()期间，资源可用于引用此过滤器实例。

如果stream不是资源或者filtername不能定位，则返回FALSE。

Changelog

注意

注意：使用自定义（用户）过滤器时， 必须首先调用stream_filter_register()，以便将所需的用户过滤器注册为filtername。

注意：流数据是从资源（包括本地和远程）中以块读取的，任何未使用的数据保存在内部缓冲区中。当一个新的过滤器被添加到流中时，内部缓冲区中已经通过其他过滤器处理过的数据将不会通过新过滤器进行重新处理。这与stream_filter_append()的行为不同。

注意：添加过滤器进行读取和写入时，会创建两个过滤器实例。stream_filter_prepend()必须被调用两次，STREAM_FILTER_READ并STREAM_FILTER_WRITE获取两个过滤器资源。

另请参阅

• stream_filter_register() - 注册一个用户定义的流过滤器

• stream_filter_append() - 将过滤器附加到流中

← stream_filter_append

stream_filter_register →