class RegexRecursiveFilterIterator

Same name in this branch
  1. 11.x core/modules/sdc/src/Plugin/Discovery/RegexRecursiveFilterIterator.php \Drupal\sdc\Plugin\Discovery\RegexRecursiveFilterIterator
Same name and namespace in other branches
  1. 10 core/modules/sdc/src/Plugin/Discovery/RegexRecursiveFilterIterator.php \Drupal\sdc\Plugin\Discovery\RegexRecursiveFilterIterator
  2. 10 core/lib/Drupal/Core/Plugin/Discovery/RegexRecursiveFilterIterator.php \Drupal\Core\Plugin\Discovery\RegexRecursiveFilterIterator

Iterates over files whose names match a regular expression in a directory.

Hierarchy

Expanded class hierarchy of RegexRecursiveFilterIterator

File

core/lib/Drupal/Core/Plugin/Discovery/RegexRecursiveFilterIterator.php, line 8

Namespace

Drupal\Core\Plugin\Discovery
View on git.drupalcode.org
View source 
class RegexRecursiveFilterIterator extends \RecursiveFilterIterator {
  
  /**
   * RegexRecursiveFilterIterator constructor.
   *
   * @param \RecursiveIterator $iterator
   *   The iterator.
   * @param string $regex
   *   The regular expression to match, including delimiters. For example,
   *   /\.yml$/ would list only files ending in .yml.
   */
  public function __construct(\RecursiveIterator $iterator, protected string $regex = '') {
    parent::__construct($iterator);
  }
  
  /**
   * {@inheritdoc}
   */
  public function accept() : bool {
    /** @var \SplFileInfo $file_info */
    $file_info = $this->getInnerIterator()
      ->current();
    if ($file_info->isDir()) {
      // Enter into subdirectory.
      return TRUE;
    }
    // Return if file matches regular expression.
    return $file_info->isFile() && preg_match($this->regex, $file_info->getFilename());
  }
  
  /**
   * {@inheritdoc}
   */
  public function getChildren() : ?\RecursiveFilterIterator {
    $children = parent::getChildren();
    if ($children instanceof self && empty($children->regex)) {
      $children->regex = $this->regex;
    }
    return $children;
  }

}

Members

Title Modifiers Object type Summary
RegexRecursiveFilterIterator::accept public function
RegexRecursiveFilterIterator::getChildren public function
RegexRecursiveFilterIterator::__construct public function RegexRecursiveFilterIterator constructor.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.