php-src/ext/spl/internal/recursivefilteriterator.inc
2009-05-02 01:53:45 +00:00

62 lines
1.8 KiB
PHP
Executable File

<?php
/** @file recursivefilteriterator.inc
* @ingroup SPL
* @brief class RecursiveFilterIterator
* @author Marcus Boerger
* @date 2003 - 2009
*
* SPL - Standard PHP Library
*/
/** @ingroup SPL
* @brief Iterator to filter recursive iterators
* @author Marcus Boerger
* @version 1.0
* @since PHP 5.1
*
* Passes the RecursiveIterator interface to the inner Iterator and provides
* the same functionality as FilterIterator. This allows you to skip parents
* and all their childs before loading them all. You need to care about
* function getChildren() because it may not always suit your needs. The
* builtin behavior uses reflection to return a new instance of the exact same
* class it is called from. That is you extend RecursiveFilterIterator and
* getChildren() will create instance of that class. The problem is that doing
* this does not transport any state or control information of your accept()
* implementation to the new instance. To overcome this problem you might
* need to overwrite getChildren(), call this implementation and pass the
* control vaules manually.
*/
abstract class RecursiveFilterIterator extends FilterIterator implements RecursiveIterator
{
/** @param $it the RecursiveIterator to filter
*/
function __construct(RecursiveIterator $it)
{
parent::__construct($it);
}
/** @return whether the current element has children
*/
function hasChildren()
{
return $this->getInnerIterator()->hasChildren();
}
/** @return an iterator for the current elements children
*
* @note the returned iterator will be of the same class as $this
*/
function getChildren()
{
if (empty($this->ref))
{
$this->ref = new ReflectionClass($this);
}
return $this->ref->newInstance($this->getInnerIterator()->getChildren());
}
private $ref;
}
?>