PHP SPL RecursiveIterator :: getChildren()究竟返回了什么?

时间:2013-07-03 03:53:39

标签: php oop interface spl recursiveiterator

我正在了解Marcus Boerger的标准PHP库(SPL)。

我已经实现了自己的RecursiveIterator,它通过继承来实现Iterator接口。它还实现了Countable

我对current()getChildren()hasChildren方法感到困惑。这些记录在:http://www.php.net/~helly/php/ext/spl/interfaceRecursiveIterator.html

如果

  • current()引用:'返回当前元素'和
  • getChildren()返回,我引用“当前元素的子迭代器

如果与current()的情况一样,当前元素将被视为当前对象的子元素。

然后,文档肯定指定getChildren()实际上返回相关节点的孙子

因此感到困惑。

<?php

/**
*@desc Represents a node within a hierarchy
*/
class RecursableCountableIterableNode implements RecursiveIterator, Countable
    {

    public $title;

    private $_componentsArray;
    private $_iteratorPosition;

    /**
    *@desc adds component
    */
    public function addComponent( 
            RecursableCountableIterableNode $incomingNodeObj 
            )
        {

        foreach ( $this->_componentsArray as $componentNodeObj )
            {
            if ( $incomingNodeObj === $componentNodeObj )
                {
                //its is already in there
                return;
                }
            }


        //add to the next element of the numerically indexed array
        $this->_componentsArray[] = $incomingNodeObj;       
        }



    /**
    * @desc RecursiveIterator Interface 
    */

    /**
    * @desc Implements the RecursiveIterator Interface 
    * @return boolean - Whether or not the node at the current element
    *  has children.
    * 
    * Note: This method does NOT count the children of this node, 
    * it counts the components of the node at the *current* element.
    * There is a subtle but important difference. 
    * It could have been better to name 
    * the interface method 'hasGrandChildren()'.
    */
    public function hasChildren()
        {
        return ( boolean ) count( $this->current() );
        }

    /**
    * @desc Gets the node of the current element which in effect is a container
    *  for childnodes. 
    * 
    * Note: According to the SPL, it does NOT get 'the child elements of
    *  the current node' ($this->_componentsArray) which was a surprise to me.
    * 
    * @return RecursableCountableIterableNode - the 
    * sub iterator for the current element 
    * 
    */
    public function getChildren()
        {
        return $this->current();
        }


    /**
    * @desc To adhere to countable interface.
    * @returns integer - The number of elements in the compondents array.
    */
    public function count()
        {
        return count( $this->_componentsArray );
        }


    /**
    * Iterator methods
    */

    /**
    * @desc Rewind the iterator to the first element.
    * @return void
    */
    public function rewind()
        {
        $this->_iteratorPosition = 0;
        }

    /**
    * @desc Return the current element.
    * @return RecursableCountableIterableNode
    */
    public function current()
        {
        return $this->_componentsArray[ $this->_iteratorPosition ];
        }

    /**
    * @desc Return the key of the current element.
    * @return integer
    */
    public function key()
        {
        return $this->_iteratorPosition;
        }

    /**
    * @desc Move forward to the next element.
    * @return void
    */
    public function next()
        {
        ++$this->_iteratorPosition;
        }

    /**
    * @desc Checks if current position has an element
    * @return boolean
    */
    public function valid()
        {
        return isset( $this->_componentsArray[ $this->_iteratorPosition ] );
        }   

    }

在上面的类中,getChildren()返回一个实现RecursiveIterator和Countable的对象。因为每个RecursableCountableIterableNode对象都包含其他RecursableCountableIterableNode个对象的实例。我认为它是复合模式的一种形式。

通过实验,我设法通过使用count()(作为退出递归过程的终止条件)和foreach迭代每个节点的子节点来对树执行递归操作。

有趣的是,实际上,count功能隐含执行hasChildren操作,foreach结构隐式执行getChildren操作以执行递归遍历。

class NodeTreeProcessor
    {
    protected $output = '';

    public function doProcessingWithNode( 
            RecursableCountableIterableNode $treeNodeObj
            )
        {

        $this->output .= $treeNodeObj->title;

        //Base case that stops the recursion.
        if (!( count( $treeNodeObj ) > 0 ))
            {
            //it has no children
            return;
            }

        //Recursive case.
        foreach( $treeNodeObj as $childNode )
            {
            $this->doProcessingWithNode( $childNode );
            }       
        }
    }

鉴于此,我认为为了成为一个实用的RecursiveIterator,

  • getChildren确实应该返回$this而不是current()处的节点,
  • hasChildren确实应该返回count($this)
  • 的布尔强制转换结果

这是对的吗?

规格说了一件事 - 我从字面上理解。但是我的实践经验说明了另一个。

1 个答案:

答案 0 :(得分:1)

我不认为有权说“大孩子”。您只是将参考点从当前迭代器的元素更改为 当前迭代器,这会使子项成为子项。我没有看到这样做的充分理由,因为它不是我习惯使用spl迭代器的惯例。

我建议你坚持使用你发布的代码,但我想你可能不知道RecursiveIteratorIterator。 RecursiveIteratorIterator旨在处理调用hasChildren()和getChildren()的复杂性,并在进程中维护适当的迭代器堆栈。最后,您将看到一个看似是您的层次结构的扁平列表。你的NodeTreeProcessor类目前正在做一些这样的事情。然后你就可以通过RecursiveIteratorIterator进行操作,根据你使用的标志,你将获得广度优先或深度优先迭代。你不 使用RecursiveIteratorIterator。

另外,考虑在调用getChildren()时返回一个新的外部迭代器。否则,您放弃了同时使用多个迭代器迭代同一节点的可能性,因为迭代器的位置将是共享状态。目前,您正在使用内部迭代器范例,其中数据和迭代状态都存储在同一对象中。外部迭代器将迭代状态与数据分离,使您在同一条数据上拥有多个活动迭代器。