RecursiveRegexIterator insufficiently documented

[WinterSilence]

Description

For example, __DIR__ contain symfony/console.

<?php
$iterator = new RecursiveRegexIterator(
    new RecursiveDirectoryIterator( __DIR__, RecursiveDirectoryIterator::UNIX_PATHS),
    '/((?:[A-Z][a-zA-Z\d]+\/)*[A-Z][a-zA-Z\d]+)\.php$/',
    RegexIterator::GET_MATCH,
    RegexIterator::USE_KEY
);

Resulted in this output :
Matches all class files in directory and sub-directories

But I expected this output instead:
Matches all class files only in root directory

PHP Version

tested only in PHP 7.3

Operating System

No response

[cmb69]

From the docs:

The RecursiveDirectoryIterator provides an interface for iterating recursively over filesystem directories.

You're looking for DirectoryIterator and RegexIterator.

[WinterSilence]

@cmb69 don't understand you, how RecursiveRegexIterator work with RecursiveIterator?

[cmb69]

If you don't want to recurse into subdirecties, there is no need for Recursive*Iterators. Try:

$iterator = new RegexIterator(
    new FilesystemIterator( __DIR__, FilesystemIterator ::UNIX_PATHS),
    '/((?:[A-Z][a-zA-Z\d]+\/)*[A-Z][a-zA-Z\d]+)\.php$/',
    RegexIterator::GET_MATCH,
    RegexIterator::USE_KEY
);

[WinterSilence]

@cmb69 ups.. I confused expected and received result

[iluuu1994]

@WinterSilence If you want recursion you also need RecursiveIteratorIterator. That's because the RecursiveDirectoryIterator actually yields other iterators, not just a flat list of directories.

$directory = new RecursiveDirectoryIterator(__DIR__);
$iterator = new RecursiveIteratorIterator($directory);
$regex = new RegexIterator(
    $iterator,
    '/((?:[A-Z][a-zA-Z\d]+\/)*[A-Z][a-zA-Z\d]+)\.php$/',
    RegexIterator::GET_MATCH,
    RegexIterator::USE_KEY
);
var_dump(iterator_to_array($regex));

[WinterSilence]

@iluuu1994 i'm know how it work, but it's not correct: you pass RecursiveIterator to RecursiveRegexIterator and it's must work without hacks

[WinterSilence]

@iluuu1994 @cmb69 why issue closed? I don't find any reason why RecursiveRegexIterator can't recursive iterate RecursiveDirectoryIterator (or any other RecursiveIterator's)

[iluuu1994]

@WinterSilence The same applies to RecursiveRegexIterator, it's a recursive iterator. You'll need a RecursiveIteratorIterator to flatten its result.

$directory = new RecursiveDirectoryIterator(__DIR__);
$regex = new RecursiveRegexIterator(
    $directory,
    '/((?:[A-Z][a-zA-Z\d]+\/)*[A-Z][a-zA-Z\d]+)\.php$/',
    RegexIterator::GET_MATCH,
    RegexIterator::USE_KEY
);
$iterator = new RecursiveIteratorIterator($regex);
var_dump(iterator_to_array($iterator));

There is, however, something fishy going on. This snippet only yields files in the current directory. However, changing the regex to /.*/ yields all the files recursively, including files ending in .php. Even /\.php$/ doesn't seem to work. This will need some further investigation.

[WinterSilence]

@iluuu1994 you test Windows?

[iluuu1994]

I see, the regex only applies to the root iterator. I'm not sure if that's by design or a bug. The documentation is very sparse.

[WinterSilence]

@iluuu1994 it doesn't explain why recursive iterator can't work with expected recursive iterator without class-wrapper.