DrupalAPI.de

1. drupal
   1. drupal6
   2. drupal7

Finds all files that match a given mask in a given directory.

Directories and files beginning with a period are excluded; this prevents hidden files and directories (such as SVN working directories) from being scanned.

Übergabeparameter

$dir The base directory for the scan, without trailing slash.

$mask The preg_match() regular expression of the files to find.

$options An associative array of additional options, with the following keys:

• 'nomask' The preg_match() regular expression of the files to ignore. Defaults to '/(\.\.?|CVS)$/'.
• 'callback' The callback function to call for each match. There is no default callback.
• 'recurse' When TRUE, the directory scan will recurse the entire tree starting at the provided directory. Defaults to TRUE.
• 'key' The key to be used for the returned array of files. Possible values are 'filepath', for the path starting with $dir, 'filename', for the basename of the file, and 'name' for the name of the file without an extension. Defaults to 'filepath'.
• 'min_depth' Minimum depth of directories to return files from. Defaults to 0.

$depth Current depth of recursion. This parameter is only used internally and should not be passed.

Rückgabewert

An associative array (keyed on the provided key) of objects with 'filepath', 'filename', and 'name' members corresponding to the matching files.

Verwandte Themen

File interface

Common file handling functions.

Code

includes/file.inc, line 1406

<?php
function file_scan_directory($dir, $mask, $options = array(), $depth = 0) {
  // Merge in defaults.
  $options += array(
    'nomask' => '/(\.\.?|CVS)$/',
    'callback' => 0,
    'recurse' => TRUE,
    'key' => 'filepath',
    'min_depth' => 0,
  );

  $options['key'] = in_array($options['key'], array('filepath', 'filename', 'name')) ? $options['key'] : 'filepath';
  $files = array();
  if (is_dir($dir) && $handle = opendir($dir)) {
    while (FALSE !== ($filename = readdir($handle))) {
      if (!preg_match($options['nomask'], $filename) && $filename[0] != '.') {
        $filepath = "$dir/$filename";
        if (is_dir($filepath) && $options['recurse']) {
          // Give priority to files in this folder by merging them in after any subdirectory files.
          $files = array_merge(file_scan_directory($filepath, $mask, $options, $depth + 1), $files);
        }
        elseif ($depth >= $options['min_depth'] && preg_match($mask, $filename)) {
          // Always use this match over anything already set in $files with the
          // same $$options['key'].
          $file = (object) array(
            'filepath' => $filepath,
            'filename' => $filename,
            'name' => pathinfo($filename, PATHINFO_FILENAME),
          );
          $key = $options['key'];
          $files[$file->$key] = $file;
          if ($options['callback']) {
            $options['callback']($filepath);
          }
        }
      }
    }

    closedir($handle);
  }

  return $files;
}
?>