## 前言
啥是流操作?简单来讲就是对一些文件,网络的IO操作。PHP已经把这些IO操作,封装成流操作。这节,我们将使用PHP扩展实现一个目录遍历的功能。PHP示例代码如下:
```
<?php
function list_dir($dir) {
if (is_dir($dir) === false) {
return;
}
$dh = opendir($dir);
if ($dh == false) {
return;
}
while (($file = readdir($dh)) !== false) {
if(is_dir($dir."/".$file) && $file != "." && $file != "..") {
list_dir($dir."/".$file);
} else if ($file != "." && $file != "..") {
echo $dir."/".$file."\n";
}
}
closedir($dh);
}
list_dir("/Users/canglong/dev/test/gc");
?>
```
执行后输出内容是:
```
/Users/canglong/dev/test/gc/blog/www.bo56.com
/Users/canglong/dev/test/gc/www.bo56.com
```
我们将在扩展中list_dir方法。
## 代码
### 基础代码
这个扩展,我们将在say扩展上增加`list_dir`方法代码。say扩展相关代码大家请看这篇博文。PHP7扩展开发之hello word 文中已经详细介绍了如何创建一个扩展和提供了源码下载。
### 代码实现
#### 第一步,先引入头文件:
```c
#include "ext/standard/php_filestat.h"
```
#### 第二步,实现list_dir函数
`list_dir`函数的代码如下:
```c
void list_dir(const char *dir);
PHP_FUNCTION(list_dir)
{
char *dir;
size_t dir_len;
#ifndef FAST_ZPP
/* Get function parameters and do error-checking. */
if (zend_parse_parameters(ZEND_NUM_ARGS(), "s", &dir, &dir_len) == FAILURE) {
return;
}
#else
ZEND_PARSE_PARAMETERS_START(1, 1)
Z_PARAM_PATH(dir, dir_len)
ZEND_PARSE_PARAMETERS_END();
#endif
php_stat(dir, (php_stat_len) dir_len, FS_IS_DIR, return_value);
if (Z_TYPE_P(return_value) == IS_FALSE) {
RETURN_NULL();
}
list_dir(dir);
RETURN_NULL();
}
void list_dir(const char *dir)
{
php_stream *stream;
int options = REPORT_ERRORS;
php_stream_dirent entry;
int path_len;
char path[MAXPATHLEN];
zend_stat_t st;
stream = php_stream_opendir(dir, options, NULL);
if (!stream) {
return;
}
while(php_stream_readdir(stream, &entry)) {
if ((path_len = snprintf(path, sizeof(path), "%s/%s", dir, entry.d_name)) 小于 0) {
break;
}
if (zend_stat(path, &st) != -1 && S_ISDIR(st.st_mode) && strcmp(entry.d_name, ".") != 0
&& strcmp(entry.d_name, "..") != 0) {
list_dir(path);
} else if (strcmp(entry.d_name, ".") != 0 && strcmp(entry.d_name, "..") != 0) {
PUTS(path);
PUTS("\n");
}
}
php_stream_closedir(stream);
}
```
### 代码解读
首先说下路径状态的判断。
`php_stat`函数是PHP中`is_dir`函数在实现的时候,使用的一个函数。具体代码参见[ext/standard/filestat.c](https://github.com/php/php-src/blob/master/ext/standard/filestat.c)文件的FileFunction宏方法。在1092行附近。这个函数是判断一个路径的状态。如,是否是文件夹等。一般在扩展实现的时候,不建议使用。这里只是为了演示,才使用的。
`zend_stat`宏方法。也是实现判断一个路径的状态。推荐在扩展中使用。如果调用有问题,会返回-1。
PHP把一些IO操作都封装成了流操作。这些流操作都声明在[main/php_streams.h](https://github.com/php/php-src/blob/master/main/php_streams.h)文件中。下面我们说下,我们用到的流操作函数。
`php_stream_opendir`函数是用于打开一个目录。
* 第一个参数:路径
* 第二个参数:选项。控制一些函数调用行为。定义在main/php_streams.h中。多个选项可以使用异或操作。如 int options = IGNORE_PATH | REPORT_ERRORS;
`php_stream_readdir`读取目录流。
* 第一个参数:上面函数打开的stream流
* 第二个参数:php_stream_dirent 用于存储当前读取的信息。
`php_stream_closedir`关闭目录流。参数是之前打开的流。