file_scan_directory

  1. drupal
    1. 5
    2. 6
    3. 7
    4. 8
Versions
5 – 6 file_scan_directory($dir, $mask, $nomask = array('.', '..', 'CVS'), $callback = 0, $recurse = TRUE, $key = 'filename', $min_depth = 0, $depth = 0)
7 – 8 file_scan_directory($dir, $mask, $options = array(), $depth = 0)

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.

Parameters

$dir The base directory or URI to 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 elements:

  • '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 associative array of files. Possible values are 'uri', for the file's URI; 'filename', for the basename of the file; and 'name' for the name of the file without the extension. Defaults to 'uri'.
  • '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 in.

Return value

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

Related topics

▾ 25 functions call file_scan_directory()

DrupalWebTestCase::drupalGetTestFiles in modules/simpletest/drupal_web_test_case.php
Get a list files that can be used in tests.
drupal_clear_css_cache in includes/common.inc
Deletes old cached CSS files.
drupal_clear_js_cache in includes/common.inc
Deletes old cached JavaScript files and variables.
drupal_get_database_types in includes/install.inc
Return all supported database installer objects that are compiled into PHP.
drupal_system_listing in includes/common.inc
Returns information about system object files (modules, themes, etc.).
FileScanDirectoryTest::testOptionCallback in modules/simpletest/tests/file.test
Check that the callback function is called correctly.
FileScanDirectoryTest::testOptionKey in modules/simpletest/tests/file.test
Check that key parameter sets the return value's key.
FileScanDirectoryTest::testOptionMinDepth in modules/simpletest/tests/file.test
Check that the min_depth options lets us ignore files in the starting directory.
FileScanDirectoryTest::testOptionNoMask in modules/simpletest/tests/file.test
Check that the no-mask parameter is honored.
FileScanDirectoryTest::testOptionRecurse in modules/simpletest/tests/file.test
Check that the recurse option decends into subdirectories.
FileScanDirectoryTest::testReturn in modules/simpletest/tests/file.test
Check the format of the returned values.
file_scan_directory in includes/file.inc
Finds all files that match a given mask in a given directory.
ImageAdminStylesUnitTest::getImageCount in modules/image/image.test
Count the number of images currently create for a style.
install_find_locales in includes/install.core.inc
Find all .po files for the current profile.
install_find_profiles in includes/install.core.inc
Finds all .profile files.
locale_batch_by_component in includes/locale.inc
Prepare a batch to run when installing modules or enabling themes.
locale_batch_by_language in includes/locale.inc
Prepare a batch to import translations for all enabled modules in a given language.
locale_uninstall in modules/locale/locale.install
Implements hook_uninstall().
ModuleUpdater::canUpdateDirectory in modules/system/system.updater.inc
Determine if the Updater can handle the project provided in $directory.
st in includes/install.inc
Functional equivalent of t(), used when some systems are not available.
ThemeUpdater::canUpdateDirectory in modules/system/system.updater.inc
Determine if the Updater can handle the project provided in $directory.
Updater::findInfoFile in includes/updater.inc
Figure out what the most important (or only) info file is in a directory.
update_clear_update_disk_cache in modules/update/update.module
Clear the temporary files and directories based on file age from disk.
update_verify_update_archive in modules/update/update.module
Implements hook_verify_update_archive().
_registry_update in includes/registry.inc
Does the work for registry_update().

Code

includes/file.inc, line 2014

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

  $options['key'] = in_array($options['key'], array('uri', 'filename', 'name')) ? $options['key'] : 'uri';
  $files = array();
  if (is_dir($dir) && $handle = opendir($dir)) {
    while (FALSE !== ($filename = readdir($handle))) {
      if (!preg_match($options['nomask'], $filename) && $filename[0] != '.') {
        $uri = "$dir/$filename";
        $uri = file_stream_wrapper_uri_normalize($uri);
        if (is_dir($uri) && $options['recurse']) {
          // Give priority to files in this folder by merging them in after any subdirectory files.
          $files = array_merge(file_scan_directory($uri, $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 = new stdClass();
          $file->uri = $uri;
          $file->filename = $filename;
          $file->name = pathinfo($filename, PATHINFO_FILENAME);
          $key = $options['key'];
          $files[$file->$key] = $file;
          if ($options['callback']) {
            $options['callback']($uri);
          }
        }
      }
    }

    closedir($handle);
  }

  return $files;
}
?>