萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> PHP 程式設計

PHP 掃描目錄獲取子目錄列表:scandir 與 FilesystemIterator 實作

前言

獲取目錄下子目錄列表是文件管理、模板加載、插件掃描常見需求。本文對比 scandir()、glob()、FilesystemIterator (SPL) 三種方案,提供生產級封裝類。

方案對比

函數/類優點缺點適用場景
scandir()簡單、返回陣列、PHP 4+ 可用含 . 和 ..、需手動過濾、大目錄記憶體佔用高簡單腳本、小目錄
glob()支援模式匹配、自動過濾 . ..模式限制、大目錄慢、Windows 大小寫不敏感按擴展名/前綴篩選
FilesystemIterator迭代器模式、記憶體效率高、豐富資訊 (SplFileInfo)、可鏈式過濾語法稍複雜生產環境推薦

FilesystemIterator 最佳實踐

<?php
class DirectoryScanner {
    /** 獲取子目錄列表
     * @param string $path 掃描路徑
     * @param bool $fullPath 是否返回完整路徑
     * @param callable|null $filter 過濾回調 fn(SplFileInfo) => bool
     * @return array
     */
    public static function getSubdirectories(string $path, bool $fullPath = false, callable $filter = null): array {
        if (!is_dir($path)) {
            throw new InvalidArgumentException("路徑不存在或非目錄: $path");
        }

        $dirs = [];
        $iterator = new FilesystemIterator($path, FilesystemIterator::SKIP_DOTS | FilesystemIterator::CURRENT_AS_FILEINFO);

        foreach ($iterator as $fileInfo) {
            if (!$fileInfo->isDir()) continue;
            if ($filter && !$filter($fileInfo)) continue;

            $dirs[] = $fullPath ? $fileInfo->getPathname() : $fileInfo->getFilename();
        }
        return $dirs;
    }

    /** 遞歸獲取所有子目錄 */
    public static function getAllSubdirectories(string $path): array {
        $result = [];
        $iterator = new RecursiveIteratorIterator(
            new RecursiveDirectoryIterator($path, FilesystemIterator::SKIP_DOTS),
            RecursiveIteratorIterator::SELF_FIRST
        );
        foreach ($iterator as $fileInfo) {
            if ($fileInfo->isDir()) {
                $result[] = $fileInfo->getPathname();
            }
        }
        return $result;
    }
}

// 使用範例
$baseDir = __DIR__ . '/templates';

// 1. 只獲取一級子目錄名稱
$subdirs = DirectoryScanner::getSubdirectories($baseDir);
print_r($subdirs); // ['default', 'admin', 'mobile']

// 2. 獲取完整路徑並過濾以 _ 開頭的隱藏目錄
$dirs = DirectoryScanner::getSubdirectories($baseDir, true, fn($f) => $f->getFilename()[0] !== '_');

// 3. 遞歸獲取所有子目錄
$allDirs = DirectoryScanner::getAllSubdirectories($baseDir);
?>

舊版 scandir 寫法 (兼容性)

<?php
function getSubdirsScandir(string $path): array {
    $items = scandir($path);
    $dirs = [];
    foreach ($items as $item) {
        if ($item === '.' || $item === '..') continue;
        $full = $path . DIRECTORY_SEPARATOR . $item;
        if (is_dir($full)) {
            $dirs[] = $item;
        }
    }
    return $dirs;
}
?>

模板引擎整合範例 (Smarty/Twig/Blade)

<?php
// 控制器
$themes = DirectoryScanner::getSubdirectories(VIEW_PATH . '/themes');
$selected = config('app.theme') ?? 'default';
$view->assign('themes', $themes);
$view->assign('selected', $selected);

// 模板
<select name="theme">
    <?php foreach ($themes as $theme): ?>
        <option value="<?= $theme ?>" <?= $theme === $selected ? 'selected' : '' ?>>
            <?= ucfirst($theme) ?>
        </option>
    <?php endforeach; ?>
</select>

權限與安全注意

  • 掃描前檢查 is_readable($path)。
  • 避免掃描用戶上傳目錄 (可能包含惡意文件/符號鏈接)。
  • 開放基於路徑的掃描介面時,嚴格驗證路徑遍歷攻擊 (../),使用 realpath() 限制在允許根目錄下。
copyright © 萬盛學電腦網 all rights reserved