结合递归迭代器结果:有父母的孩子

时间:2009-03-01 13:19:31

标签: php recursion iterator code-reuse

我正在尝试遍历包含大量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不是数字顺序的原因是因为'C类'在第二个源代码文件中定义,因此返回的数组再次从索引0开始。这在RecursiveIteratorIterator中保留,因为每组结果代表一个单独的迭代器(因此键/值对)。

无论如何,我现在要做的是找到最好的方法来组合这些,这样当我遍历新的迭代器时,我可以得到键是类名(来自$defined_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()返回当前iterator()值的方法。但我不赞成这个解决方案,因为:

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

感激地收到任何想法或建议。

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

由于

2 个答案:

答案 0 :(得分:2)

好吧,我想我终于明白了。这大致是我在伪代码中所做的:

第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下所有已定义类的列表,以及它们所定义的文件。几乎所有用于执行此操作的代码都是也可以在其他环境中重复使用。我没有在定义的迭代器中硬编码任何东西来完成这个任务,也没有在迭代器之外做任何额外的处理

答案 1 :(得分:0)

我认为您想要做的事情或多或少是要反转PhpFileAndContent返回的键和值。所述类返回filepath => source列表,并且您希望首先反转映射,使其为source => filepath,然后展开source中定义的每个类的source,这样它就会是class1 => filepath, class2 => filepath

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

然后就会按照你想要的那样出来。

另一种选择是放弃使用RecursiveArrayIterator,而是编写自己的迭代器,将其初始化(在getChildren中)

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

然后FilePathMapperIterator会将类数组从getDefinedClasses转换为我描述的class => filepath映射,只需迭代数组并返回key()中的当前类并始终在current()中返回指定的文件路径。

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