组合递归迭代器结果：孩子与父母

Question

我正在尝试迭代包含 PHP 文件负载的目录，并检测每个文件中定义了哪些类。

考虑以下情况：

$php_files_and_content = new PhpFileAndContentIterator($dir);
foreach($php_files_and_content as $filepath => $sourceCode) {
    // echo $filepath, $sourceCode
}

上面的 $php_files_and_content 变量表示一个迭代器，其中键是文件路径，内容是文件的源代码（就好像这在示例中并不明显）。

然后将其提供给另一个迭代器，该迭代器将匹配源代码中所有定义的类，ala：

class DefinedClassDetector extends FilterIterator implements RecursiveIterator {
    public function accept() {
        return $this->hasChildren();
    }

    public function hasChildren() {
        $classes = getDefinedClasses($this->current());
        return !empty($classes);
    }

    public function getChildren() {
        return new RecursiveArrayIterator(getDefinedClasses($this->current()));
    }
}

$defined_classes = new RecursiveIteratorIterator(new DefinedClassDetector($php_files_and_content));

foreach($defined_classes as $index => $class) {
    // print "$index => $class"; outputs:
    // 0 => Class A
    // 1 => Class B
    // 0 => Class C
}

$index 不是按数字顺序排列的原因是因为“Class C”是在第二个源中定义的代码文件，因此返回的数组又从索引0开始。 这被保留在 RecursiveIteratorIterator 中，因为每组结果代表一个单独的迭代器（以及键/值对）。

不管怎样，我现在想做的是找到组合这些的最佳方法，这样当我迭代新的迭代器时，我可以得到关键是类名（来自 $define_classes 迭代器），该值是原始文件路径，ala：

foreach($classes_and_paths as $filepath => $class) {
    // print "$class => $filepath"; outputs
    // Class A => file1.php
    // Class B => file1.php
    // Class C => file2.php
}

这就是我到目前为止所陷入的困境。

目前，想到的唯一解决方案是创建一个新的 RecursiveIterator，它重写 current() 方法以返回外部迭代器 key() （这将是原始文件路径），并覆盖 key() 方法以返回当前 iterator() 值。 但我不赞成这个解决方案，因为：

• 它听起来很复杂（这意味着代码看起来很丑陋，而且不直观。
• 业务规则是在类中硬编码的，而我想定义一些通用迭代器并能够以这种方式组合它们以产生所需的结果，

我很高兴收到任何想法或建议，

我也意识到有更快、更有效的方法来做到这一点，但这也是我自己使用迭代器的一个练习。练习促进代码重用，因此必须编写的任何新迭代器都应尽可能少，并尝试利用现有功能，

谢谢。

Answer 1

好吧，我想我终于明白了这一点。 以下是我在伪代码中所做的大致操作：

第 1 步
我们需要列出目录内容，因此我们可以执行以下操作：

// Reads through the $dir directory
// traversing children, and returns all contents
$dirIterator = new RecursiveDirectoryIterator($dir);

// Flattens the recursive iterator into a single
// dimension, so it doesn't need recursive loops
$dirContents = new RecursiveIteratorIterator($dirIterator);

第 2 步
我们只需要考虑 PHP 文件

class PhpFileIteratorFilter {
    public function accept() {
        $current = $this->current();
        return    $current instanceof SplFileInfo
               && $current->isFile()
               && end(explode('.', $current->getBasename())) == 'php';
    }
}


// Extends FilterIterator, and accepts only .php files
$php_files = new PhpFileIteratorFilter($dirContents);

PhpFileIteratorFilter 并不是可重用代码的一个很好的用途。 更好的方法是能够提供文件扩展名作为构建的一部分，并让过滤器与之匹配。 尽管如此，我还是试图摆脱不需要的构造参数，而更多地依赖于组合，因为这样可以更好地利用策略模式。 PhpFileIteratorFilter 可以简单地使用通用 FileExtensionIteratorFilter 并进行内部设置。

第 3 步
我们现在必须读入文件内容

class SplFileInfoReader extends FilterIterator {

    public function accept() {
        // make sure we use parent, this one returns the contents
        $current = parent::current();
        return    $current instanceof SplFileInfo
               && $current->isFile()
               && $current->isReadable();
    }

    public function key() {
        return parent::current()->getRealpath();
    }

    public function current() {
        return file_get_contents($this->key());
    }    
}

// Reads the file contents of the .php files
// the key is the file path, the value is the file contents
$files_and_content = new SplFileInfoReader($php_files);

第 4 步
现在我们想要将回调应用到每个项目（文件内容）并以某种方式保留结果。 再次，尝试利用策略模式，我删除了不必要的构造函数参数，例如 $preserveKeys 或类似的

/**
 * Applies $callback to each element, and only accepts values that have children
 */
class ArrayCallbackFilterIterator extends FilterIterator implements RecursiveIterator {

    public function __construct(Iterator $it, $callback) {
        if (!is_callable($callback)) {
            throw new InvalidArgumentException('$callback is not callable');
        }

        $this->callback = $callback;
        parent::__construct($it);
    }

    public function accept() {
        return $this->hasChildren();
    }

    public function hasChildren() {
        $this->results = call_user_func($this->callback, $this->current());
        return is_array($this->results) && !empty($this->results);
    }

    public function getChildren() {
        return new RecursiveArrayIterator($this->results);
    }
}


/**
 * Overrides ArrayCallbackFilterIterator to allow a fixed $key to be returned
 */
class FixedKeyArrayCallbackFilterIterator extends ArrayCallbackFilterIterator {
    public function getChildren() {
        return new RecursiveFixedKeyArrayIterator($this->key(), $this->results);
    }
}


/**
 * Extends RecursiveArrayIterator to allow a fixed $key to be set
 */
class RecursiveFixedKeyArrayIterator extends RecursiveArrayIterator {

    public function __construct($key, $array) {
        $this->key = $key;
        parent::__construct($array);
    }

    public function key() {
        return $this->key;
    }
}

因此，这里我有我的基本迭代器，它将返回 的结果$callback 我通过提供，但我还扩展了它以创建一个也将保留键的版本，而不是使用构造函数参数。

因此我们有这样的：

// Returns a RecursiveIterator
// key: file path
// value: class name
$class_filter = new FixedKeyArrayCallbackFilterIterator($files_and_content, 'getDefinedClasses');

第 5 步
现在我们需要将其格式化为合适的方式。 我希望文件路径是值，键是类名（即为类提供到文件的直接映射，在该文件中可以为自动加载器找到它）

// Reduce the multi-dimensional iterator into a single dimension
$files_and_classes = new RecursiveIteratorIterator($class_filter);

// Flip it around, so the class names are keys
$classes_and_files = new FlipIterator($files_and_classes);

瞧，我现在可以迭代了$classes_and_files 并获取 $dir 下所有定义的类的列表，以及它们定义的文件。几乎所有用于执行此操作的代码都可以在其他上下文中重用，例如出色地。 我没有在定义的迭代器中硬编码任何内容来完成此任务，也没有在迭代器之外进行任何额外的处理

Answer 2

我认为您想要做的或多或少是反转从 PhpFileAndContent 返回的键和值。 该类返回一个 filepath => 的列表。 source，并且您希望首先反转映射，因此它是 source =>; filepath，然后为 source 中定义的每个类展开 source，因此它将是 class1 => 文件路径，class2 => 文件路径。

它应该很容易，就像在您的 getChildren() 中一样，您只需访问 $this->key() 即可获取您正在运行的源的当前文件路径getDefinedClasses() 上。 您可以将 getDefinedClasses 编写为 getDefinedClasses($path, $source) ，它不会返回所有类的索引数组，而是返回一个字典，其中当前的每个值索引数组是字典中的键，值是定义该类的文件路径。

然后它就会像你想要的那样出来。

另一种选择是放弃使用 RecursiveArrayIterator ，而是编写自己的迭代器，该迭代器已初始化（在 getChildren 中），然后

return new FilePathMapperIterator($this->key,getDefinedClasses($this->current()));

FilePathMapperIterator 将转换从 getDefinedClasses 到 class => 的类数组 我通过简单地迭代数组并在 key() 中返回当前类并始终在 current() 中返回指定的文件路径来描述文件路径映射。

我认为后者更酷，但代码肯定更多，所以如果我可以根据我的需要调整 getDefinedClasses() ，我不太可能会这样做。