PHP scandir函数介绍

一、概述

scandir() 函数用于返回指定目录中的文件和目录的数组。该函数返回一个数组，其中包括目标目录中所有的文件和子目录的名称。该函数可接受俩个参数，第一个参数必选且为需要获取文件和目录的目标目录，第二个参数为可选参数，表示列出的文件类型的规则，支持通配符匹配，也支持数组形式的匹配。如果执行失败将返回 FALSE。

scandir()函数不会列出隐藏文件和文件夹。

二、函数语法

    scandir(directory,sorting_order)

参数：
– directory 必须。规定要搜索的目录。
– sorting_order 可选。规定排序顺序。可能的值：0 或 SORT_ASC – 默认。按英文字母升序排序；1 或 SORT_DESC – 按英文字母降序排序。

三、函数返回值

scandir() 函数返回指定目录中的文件和目录的数组。

四、使用示例

以下示例演示了如何使用 scandir() 函数。

    $dir = "/test/";
    $files1 = scandir($dir);//以默认方式扫描目录
    $files2 = scandir($dir, 1);//按名称反向扫描目录

    print_r($files1);
    print_r($files2);

运行结果：

    Array
    (
        [0] => .
        [1] => ..
        [2] => file1.txt
        [3] => file2.txt
        [4] => dir1
    )
    Array
    (
        [0] => dir1
        [1] => file2.txt
        [2] => file1.txt
        [3] => ..
        [4] => .
    )

上述代码先定义了一个目录，然后使用 scandir() 函数扫描该目录并返回目录下的子目录和文件名。同时，示例还展示了如何以不同的排序顺序返回查找结果。

五、案例分析

1、列出目录中指定类型的文件

scandir() 函数可以通过指定排序顺序和文件类型规则来获取指定类型的文件。例如：

    $dir = "/test/";
    $allowed = array('gif', 'jpeg', 'jpg', 'png');

    $files = array_diff(scandir($dir), array('.', '..'));
    $result = [];

    foreach($files as $file) {
        $ext = pathinfo($file, PATHINFO_EXTENSION);
        if(in_array($ext, $allowed)) {
            $result[] = $file;
        }
    }

    print_r($result);

在上述示例中，$allowed 数组指定了允许获取的文件类型。scandir() 函数首先获取指定目录的所有文件和目录，接着使用 array_diff() 函数将点（.）和双点（..）排除。接下来，遍历每个文件，提取每个文件的扩展名，如果允许的文件类型数组包含该扩展名，则将文件添加到结果数组中。

2、列出目录中所有文件的元数据

scandir() 函数可以实现获取目录下所有文件的元数据。这个案例展示了如何使用 scandir() 和其他几个信息查找函数实现。

    $dir = "/test/";
    $dirHandle = opendir($dir);
    $results = [];

    while (($file = readdir($dirHandle)) !== false) {
        if ($file !== '.' && $file !== '..') {
            //创建一个零时数组
            $info = array();
            $info['name'] = $file;

            // 检查文件是否是目录
            if (is_dir($dir . '/' . $file)) {
                $info['type'] = "Directory";
            } else {
                $info['type'] = "File";
            }

            $info['size'] = filesize($dir . '/' . $file);

            $info['last_accessed'] = fileatime($dir . '/' . $file);
            $info['last_modified'] = filemtime($dir . '/' . $file);

            //将数组添加到$results
            $results[] = $info;
        }
    }

    // 关闭目录句柄
    closedir($dirHandle);

    // 显示所有文件的元信息（字节数，上一次访问时间，上次文件修改时间）
    foreach ($results as $result) {
        echo $result['name'] . ': ' . $result['type'] . ', Size: ' . $result['size'] . ', Last Accessed: ' . date("j F Y H:i:s", $result['last_accessed']) . ', Last Modified: '
            . date("j F Y H:i:s", $result['last_modified']) . '
';
    }

在上述示例中，首先使用 opendir() 函数获取目录的处理句柄。然后遍历该目录中的每个文件并提取元数据，包括文件名、类型（文件或目录）、大小、上一次访问时间和上一次修改时间。最后，将文件元数据存储在名为 $results 的数组中，并根据日期和时间格式使用 date() 函数显示结果。

六、总结

scandir() 函数是 PHP 中一个强大的文件系统函数，可用于获取指定目录的所有文件和目录。此函数非常适合获取目录内容，并此函数可以方便地过滤结果以获取所需的内容。了解 PHP 文件系统函数的开发人员将能够更好地管理他们的 web 应用程序并快速定位问题。