Several Methods to Traverse Files in a Directory with PHP

Introduction

In PHP development, handling filesystems is a common task. For instance, when needing to batch process images or other files in a directory, traversing the directory and operating on each file becomes crucial. Based on common technical Q&A, this article extracts core knowledge points and introduces several methods to loop through directory files in PHP.

Using the scandir() Function to Traverse a Directory

The scandir() function is a built-in PHP function that returns an array of all files and directories in a specified directory. It is simple and easy to use, but by default includes the current directory (.) and parent directory (..), so filtering these entries may be necessary during the loop.

Here is a basic example:

$files = scandir('folder/');
foreach($files as $file) {
  // Perform file calculations here, such as checking file types or processing images
  if ($file != '.' && $file != '..') {
    echo $file . "\n";
  }
}

In this example, scandir('folder/') returns an array, and then foreach is used to iterate over each file. By excluding . and .. with a conditional statement, focus can be placed on actual files.

Using the glob() Function to Filter Files

The glob() function offers more flexible file matching capabilities, allowing wildcards to filter specific file types. This is especially useful for scenarios where only image files (e.g., JPG, PNG, GIF) need to be processed.

Example code:

$files = glob('folder/*.{jpg,png,gif}', GLOB_BRACE);
foreach($files as $file) {
  // Perform operations on each matched file, such as calculating file size or processing images
  echo $file . "\n";
}

Here, glob('folder/*.{jpg,png,gif}', GLOB_BRACE) uses brace expansion to match multiple file extensions, returning only these types of files and avoiding extra filtering steps.

Advantages and Disadvantages Comparison

The advantage of scandir() is its simplicity and directness, but it may require manual filtering of unwanted entries. In contrast, glob() can directly filter file types, improving efficiency, but its syntax is slightly more complex and relies on file extensions.

The choice of method depends on specific needs: if only all files need to be traversed, scandir() is sufficient; if file filtering based on patterns is required, glob() is more appropriate.

Supplementary Method: Using the DirectoryIterator Class

In addition to functional methods, PHP provides the object-oriented DirectoryIterator class, which encapsulates directory iteration functionality and offers a richer API, such as checking if a file is a dot directory or retrieving file information.

Referencing Answer 2, the example code is as follows:

foreach (new DirectoryIterator('../moodle') as $fileInfo) {
    if($fileInfo->isDot()) continue;
    echo $fileInfo->getFilename() . "<br>\n";
}

In this code, DirectoryIterator automatically handles directory iteration, the isDot() method is used to skip . and .., and getFilename() returns the file name. The output uses <br> for line breaks, but note that in an HTML context, escaping may be necessary.

Additionally, RecursiveDirectoryIterator can be used for recursive traversal of subdirectories, suitable for more complex filesystem operations.

Conclusion

This article introduces three main methods for traversing directory files in PHP: using the scandir() function, the glob() function, and the DirectoryIterator class. Each method has its applicable scenarios, and developers should choose the most appropriate one based on specific requirements. For simple traversal, scandir() is a quick choice; for file filtering, glob() is more efficient; and for object-oriented interfaces or advanced features, DirectoryIterator offers better flexibility.