PHP 将文件的前 2 行读入变量并通过子文件夹循环

Question

我正在尝试使用 PHP 执行以下操作...

1. 读取目录
2. 查找所有 .md 和 .markdown 文件
3. 读取这些 Markdown 文件的前 2 行。
4. 如果在第 1 行上找到标题：文件标题，则将其添加到数组中
5. 如果在<上找到描述：简短描述，则将 其添加到数组中strong>第2行然后将其添加到数组中
6. 如果找到子目录，则对其重复步骤1-5
7. 现在应该有一个不错的列表/数组
8. 将此列表/数组打印到屏幕以像这样显示。 ...

---

Directory 1 Name

<a href="LINK TO MARKDOWN FILE 1"> TITLE from line 1 of Markdown FILE 1</a> <br>
Description from Markdown FILE 1 line 2

<a href="LINK TO MARKDOWN FILE 2"> TITLE from line 1 of Markdown FILE 1</a> <br>
Description from Markdown FILE 2 line 2

<a href="LINK TO MARKDOWN FILE 3"> TITLE from line 1 of Markdown FILE 1</a> <br>
Description from Markdown FILE 3 line 2

Directory 2 Name

<a href="LINK TO MARKDOWN FILE 1"> TITLE from line 1 of Markdown FILE 1</a> <br>
Description from Markdown FILE 1 line 2

<a href="LINK TO MARKDOWN FILE 2"> TITLE from line 1 of Markdown FILE 1</a> <br>
Description from Markdown FILE 2 line 2

<a href="LINK TO MARKDOWN FILE 3"> TITLE from line 1 of Markdown FILE 1</a> <br>
Description from Markdown FILE 3 line 2

etc..........

---

到目前为止的代码

function getFilesFromDir($dir)
{
    $files = array();
    //scan directory passsed into function
    if ($handle = opendir($dir)) {
        while (false !== ($file = readdir($handle))) {

            // If file is .md or .markdown continue
            if (preg_match('/\.(md|markdown)$/', $file)) {

                // Grab first 2 lines of Markdown file
                $content = file($dir . '/' . $file);
                $title = $content[0];
                $description = $content[1];

                // If first 2 lines of Markdown file have a 
                // "Title: file title" and "Description: file description" lines we then
                // add these key/value pairs to the array for meta data

                // Match Title line
                $pattern = '/^(Title|Description):(.+)/';
                if (preg_match($pattern, $title, $matched)) {
                    $title = trim($matched[2]);
                }

                // match Description line 
                if (preg_match($pattern, $description, $matched)) {
                    $description = trim($matched[2]);
                }

                // Add .m and .markdown files and folder path to array
                // Add captured Title and Description to array as well
                $files[$dir][] = array("filepath" => $dir . '/' . $file,
                                       "title" => $title,
                                       "description" => $description
                                    );

            }
        }
        closedir($handle);
    }

    return $files;
}

用法

$dir = 'mdfiles';
$fileArray = getFilesFromDir($dir);

需要帮助

到目前为止，代码只需要添加在子目录上执行操作的功能以及匹配前两行代码然后运行正则表达式两次的方式，可能可以用不同的方式完成吗？

我认为有一个更好的方法，使我必须匹配标题和描述的正则表达式可以只运行一次？

有人可以帮助我修改以使此代码检测并在子目录上运行，并改进它读取 Markdown 文件的前两行以获取标题和描述（如果存在）的方式吗？

还需要帮助将数组打印到屏幕上，使其不仅显示数据，我知道如何做到这一点，但必须分解文件以在每组顶部显示文件夹名称，如上面的演示输出所示。

我很感激任何帮助

Answer 1

要递归地迭代文件，RecursiveDirectoryIterator 非常方便（相关：PHP 递归目录路径） 。它已经提供了对 FileSystemObject 的轻松访问，这在您想要获取文件内容的情况下看起来很有用。

此外，可以运行一个正则表达式来解析文件的前两行，因为当您更频繁地执行它们时模式会被缓存，这应该没问题。一种模式的优点是代码更加结构化，但缺点是模式更加复杂。配置可能如下所示：

#
# configuration
#

$path = 'md';
$fileFilter = '~\.(md|markdown)$~';
$pattern = '~^(?:Title: (.*))?(?:(?:\r\n|\n)(?:Description: (.*)))?~u';

为了防止 markdown 文件实际上是 UTF-8 编码，我添加了 u 修饰符 (PCRE8)。

然后，代码的处理部分是在 $path 上使用递归目录迭代器，跳过与 $fileFilter 不匹配的文件，然后解析每个文件的前两行（如果文件至少可读并且至少有一行）并将其存储到基于目录的哈希表/数组 $result：

#
# main
#

# init result array (the nice one)
$result = array();

# recursive iterator for files
$iterator = new RecursiveIteratorIterator(
               new RecursiveDirectoryIterator($path, FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_FILEINFO), 
               RecursiveIteratorIterator::SELF_FIRST);

foreach($iterator as $path => $info)
{
    # filter out files that don't match
    if (!preg_match($fileFilter, $path)) continue;

    # get first two lines
    try
    {
        for
        (
            $maxLines = 2,
            $lines = '',
            $file = $info->openFile()
            ; 
            !$file->eof() && $maxLines--
            ; 
            $lines .= $file->fgets()
        );
        $lines = rtrim($lines, "\n");

        if (!strlen($lines)) # skip empty files 
            continue;
    }
    catch (RuntimeException $e)
    {
        continue; # files which are not readable are skipped.
    }

    # parse md file
    $r = preg_match($pattern, $lines, $matches);
    if (FALSE === $r)
    {
        throw new Exception('Regular expression failed.');
    }
    list(, $title, $description) = $matches + array('', '', '');

    # grow result array
    $result[dirname($path)][] = array($path, $title, $description);
}

剩下的是输出。由于哈希表是按目录哈希预先排序的，因此首先遍历目录，然后遍历其中的文件，这是相当直接的：

#
# output
#

$dirCounter = 0;
foreach ($result as $name => $dirs)
{
    printf("Directory %d %s\n", ++$dirCounter, basename($name));
    foreach ($dirs as $entry)
    {
        list($path, $title, $description) = $entry;
        printf("<a href='%s'>%s from line 1 of Markdown %s</a> <br>\n%s\n\n", 
                htmlspecialchars($path), 
                htmlspecialchars($title),               
                htmlspecialchars(basename($path)),
                htmlspecialchars($description)
              );
    }
}

Answer 2

这应该可行：

if (preg_match('/\.(md|markdown)$/', $file)) {
   // ...
} elseif (is_dir($file)) {
    $files = array_merge($files, getFilesFromDir($dir . '/' . $file));
}

运行正则表达式两次并不是那么糟糕，并且可能比尝试在两行中将某些内容散列在一起更好。但是，您可以使用 preg_replace 获得相同的结果：

$title = trim(preg_replace('/^Title:(.+)/', '$1', $content[0]));
$description = trim(preg_replace('/^Description:(.+)/', '$1', $content[1]));

要按照示例输出数组，请执行以下操作：

foreach ($filesArray as $directory => $files) {
    echo $directory . "\n\n";

    foreach ($files as $fileData) {
        echo '<a href="' . $fileData['filepath'] . '">' . $fileData['title'] . "</a><br />\n";
        echo $fileData['description'] . "\n\n";
    }
}