PHP Streams(流)介绍及使用

PHP Streams是内置核心操作，可能一般的开发者很少用，它用于统一文件、网络、数据压缩等类文件操作方式，并为这些类文件操作提供一组通用的函数接口。

一个stream就是一个具有流式行为的资源对象，每个stream对象都有一个包装类。Stream 可以通过://方式来引用。其中是包装类的名字，中的内容是由包装类的语法指定，不同的包装类的语法会有所不同。

来看看PHP 默认有哪些内置的包装类：

Registered PHP Streams => https, ftps, compress.zlib, php, file, glob, data, http, ftp, phar, zip
Registered Stream Socket Transports => tcp, udp, unix, udg, ssl, sslv3, tls,
 tlsv1.0, tlsv1.1, tlsv1.2
Registered Stream Filters => zlib.*, convert.iconv.*, string.rot13, string.toupper, 
string.tolower, string.strip_tags, convert.*, consumed, dechunk

看看PHP手册中关于PHP支持的协议和包装类。

看下面一段使用file_get_contents()获取数据的代码：

/* Read local file from /home/bar */
$localfile file_get_contents “/home/bar/foo.txt”
/* Identical to above, explicitly naming FILE scheme */
$localfile file_get_contents “file:///home/bar/foo.txt”
/* Read remote file from www.example.com using HTTP */
$httpfile file_get_contents “http://www.example.com/foo.txt”
/* Read remote file from www.example.com using HTTPS */
$httpsfile file_get_contents “https://www.example.com/foo.txt”
/* Read remote file from ftp.example.com using FTP */
$ftpfile file_get_contents “ftp://user:pass@ftp.example.com/foo.txt”
/* Read remote file from ftp.example.com using FTPS */
$ftpsfile file_get_contents “ftps://user:pass@ftp.example.com/foo.txt”

实际上readfile(‘/path/to/somefile.txt’)或者readfile(‘file:///path/to/somefile.txt’)，这两种方式是等效的。因为PHP的默认包装类就是file://。

手册上明确指出，可以通过stream_register_wrapper()注册自己的包装器 ，可以去看看手册中的例子。

OK，这里简单介绍一个PHP://，它是PHP用来处理IO流的包装类(点击这里看个例子)。通过PHP://可以访问更强大的输入输出流：

//stdin：访问PHP进程相应的输入流，比如用在获取cli执行脚本时的键盘输入。
//stdout：访问PHP进程相应的输出流。
//stderr：访问PHP进程相应的错误输出。
//input：访问请求的原始数据的只读流。
//output：只写的数据流，以 print 和 echo 一样的方式写入到输出区。
//fd：允许直接访问指定的文件描述符。例 php://fd/3 引用了文件描述符 3。
//memory：允许读写临时数据。 把数据储存在内存中。
//temp：同上，会在内存量达到预定义的限制后(默认是 2MB)存入临时文件中。
//filter：过滤器。

PHP还可以通过context和filter对包装类进行修饰和增强。

(1)关于context，如PHP通过stream_context_create()来设置获取文件超时时间，这段代码大家肯定用过：

$opts array

‘http’=>array

‘method’=>”GET”

‘timeout’=>

$context stream_context_create$opts

$html file_get_contents’http://www.phpddt.com‘false $context

(2)关于filter过滤器，首先来看看PHP有哪些内置的过滤器：

print_rstream_get_filters

通过stream_filter_register()和内置的php_user_filter可创建自定义的过滤器，如下：

/* Define our filter class */
class strtoupper_filter extends php_user_filter
function filter $consumed closingwhilebucket stream_bucket_make_writeable
$bucket -> strtoupper $bucket ->
$consumed $bucket -> datalen
stream_bucket_append $bucket
return PSFS_PASS_ON
/* Register our filter with PHP */
stream_filter_register “strtoupper”“strtoupper_filter”
“Failed to register filter”
fopen “foo-bar.txt”
/* Attach the registered filter to the stream just opened */
stream_filter_append “strtoupper”
fwrite “Line1\n”
fwrite “Word - 2\n”
fwrite “Easy As 123\n”
fclose
readfile “foo-bar.txt”
#结果如下：
LINE1
WORD - 2
EASY AS 123

提供PHP中streams函数列表如下：

stream_bucket_append函数：为队列添加数据
stream_bucket_make_writeable函数：从操作的队列中返回一个数据对象
stream_bucket_new函数：为当前队列创建一个新的数据
stream_bucket_prepend函数：预备数据到队列
stream_context_create函数：创建数据流上下文
stream_context_get_default函数：获取默认的数据流上下文
stream_context_get_options函数：获取数据流的设置
stream_context_set_option函数：对数据流、数据包或者上下文进行设置
stream_context_set_params函数：为数据流、数据包或者上下文设置参数
stream_copy_to_stream函数：在数据流之间进行复制操作
stream_filter_append函数：为数据流添加过滤器
stream_filter_prepend函数：为数据流预备添加过滤器
stream_filter_register函数：注册一个数据流的过滤器并作为
stream_filter_remove函数：从一个数据流中移除过滤器
stream_get_contents函数：读取数据流中的剩余数据到字符串
stream_get_filters函数：返回已经注册的数据流过滤器列表
stream_get_line函数：按照给定的定界符从数据流资源中获取行
stream_get_meta_data函数：从封装协议文件指针中获取报头/元数据
stream_get_transports函数：返回注册的Socket
stream_get_wrappers函数：返回注册的数据流列表
stream_register_wrapper函数：注册一个用
stream_select函数：接收数据流数组并等待它们状态的改变
stream_set_blocking函数：将一个数据流设置为堵塞或者非堵塞状态
stream_set_timeout函数：对数据流进行超时设置
stream_set_write_buffer函数：为数据流设置缓冲区
stream_socket_accept函数：接受由函数stream_ socket_server()创建的Socket
stream_socket_client函数：打开网络或者Socket
stream_socket_enable_crypto函数：为一个已经连接的Socket打开或者关闭数据加密
stream_socket_get_name函数：获取本地或者网络Socket
stream_socket_pair函数：创建两个无区别的Socket数据流连接
stream_socket_recvfromSocket获取数据，不管其连接与否
stream_socket_sendtoSocket发送数据，不管其连接与否
stream_socket_server函数：创建一个网络或者Socket
stream_wrapper_restore函数：恢复一个事先注销的数据包
stream_wrapper_unregister函数：注销一个