How to enumerate all the files in a specified directory?

dmitry_fedyuk · February 16, 2016, 11:12am

API

Use readDirectory or readDirectoryRecursively methods of the \Magento\Framework\Filesystem\Driver\File class:

magento/magento2/blob/2ea8cdd7/lib/internal/Magento/Framework/Filesystem/Driver/File.php#L242-L257


public function readDirectory($path)
{
    try {
        $flags = \FilesystemIterator::SKIP_DOTS | \FilesystemIterator::UNIX_PATHS;
        $iterator = new \FilesystemIterator($path, $flags);
        $result = [];
        /** @var \FilesystemIterator $file */
        foreach ($iterator as $file) {
            $result[] = $file->getPathname();
        }
        sort($result);
        return $result;
    } catch (\Exception $e) {
        throw new FileSystemException(new \Magento\Framework\Phrase($e->getMessage()), $e);
    }
}

github.com

magento/magento2/blob/2ea8cdd7/lib/internal/Magento/Framework/Filesystem/Driver/File.php#L896-L913


public function readDirectoryRecursively($path = null)
{
    $result = [];
    $flags = \FilesystemIterator::SKIP_DOTS | \FilesystemIterator::UNIX_PATHS;
    try {
        $iterator = new \RecursiveIteratorIterator(
            new \RecursiveDirectoryIterator($path, $flags),
            \RecursiveIteratorIterator::CHILD_FIRST
        );
        /** @var \FilesystemIterator $file */
        foreach ($iterator as $file) {
            $result[] = $file->getPathname();
        }
    } catch (\Exception $e) {
        throw new FileSystemException(new \Magento\Framework\Phrase($e->getMessage()), $e);
    }
    return $result;
}

Usage examples

github.com

magento/magento2/blob/2ea8cdd7/app/code/Magento/Deploy/Model/Filesystem.php#L188-L203


$directoryPath = $this->directoryList->getPath(DirectoryList::STATIC_VIEW);
if ($this->driverFile->isExists($directoryPath)) {
    $files = $this->driverFile->readDirectory($directoryPath);
    foreach ($files as $file) {
        foreach ($excludePatterns as $pattern) {
            if (preg_match($pattern, $file)) {
                continue 2;
            }
        }
        if ($this->driverFile->isFile($file)) {
            $this->driverFile->deleteFile($file);
        } else {
            $this->driverFile->deleteDirectory($file);
        }
    }
}

github.com

magento/magento2/blob/2ea8cdd7/setup/src/Magento/Setup/Console/Command/InfoBackupsListCommand.php#L67-L87


if ($this->file->isExists($backupsDir)) {
    $contents = $this->file->readDirectoryRecursively($backupsDir);
    $tempTable = [];
    foreach ($contents as $path) {
        $partsOfPath = explode('/', str_replace('\\', '/', $path));
        $fileName = $partsOfPath[count($partsOfPath) - 1];
        // if filename starts with '.' skip, e.g. '.git'
        if (!(strpos($fileName, '.') === 0)) {
            $filenameWithoutExtension = explode('.', $fileName);
            // actually first part of $filenameWithoutExtension contains only the filename without extension
            // and filename contains the type of backup separated by '_'
            $fileNameParts = explode('_', $filenameWithoutExtension[0]);
            if (in_array(Factory::TYPE_MEDIA, $fileNameParts)) {
                $tempTable[$fileName] = Factory::TYPE_MEDIA;
            } elseif (in_array(Factory::TYPE_DB, $fileNameParts)) {
                $tempTable[$fileName] = Factory::TYPE_DB;
            } elseif (in_array('code', $fileNameParts)) {
                $tempTable[$fileName] = 'code';
            }
        }
    }