DirectoryTreeIterator Class Reference

Inheritance diagram for DirectoryTreeIterator:

Collaboration diagram for DirectoryTreeIterator:

Public Member Functions
	__call ($func, $params)
	__construct ($path)
	beginChildren ()
	callGetChildren ()
	callHasChildren ()
	current ()
	endChildren ()
	getDepth ()
	getInnerIterator ()
	getSubIterator ($level=NULL)
	key ()
	next ()
	nextElement ()
	rewind ()
	valid ()

Public Attributes
const	CATCH_GET_CHILD = 0x00000002
const	CHILD_FIRST = 2
const	LEAVES_ONLY = 0
const	SELF_FIRST = 1

Detailed Description

DirectoryIterator to generate ASCII graphic directory trees.

Author

Marcus Boerger

Version

1.1

Definition at line 17 of file directorytreeiterator.inc.

Constructor & Destructor Documentation

DirectoryTreeIterator::__construct

(

$path

)

Construct from a path.

Parameters

$path

directory to iterate

Definition at line 22 of file directorytreeiterator.inc.

References CachingIterator\CALL_TOSTRING, CachingIterator\CATCH_GET_CHILD, and RecursiveDirectoryIterator\KEY_AS_FILENAME.

    {
        parent::__construct(
            new RecursiveCachingIterator(
                new RecursiveDirectoryIterator($path, RecursiveDirectoryIterator::KEY_AS_FILENAME
                ), 
                CachingIterator::CALL_TOSTRING|CachingIterator::CATCH_GET_CHILD
            ), 
            parent::SELF_FIRST
        );
    }

Member Function Documentation

DirectoryTreeIterator::__call	(		$func,
			$params
	)

Aggregates the inner iterator.

Definition at line 48 of file directorytreeiterator.inc.

References RecursiveIteratorIterator\getSubIterator().

    {
        return call_user_func_array(array($this->getSubIterator(), $func), $params);
    }

Here is the call graph for this function:

RecursiveIteratorIterator::beginChildren ( )

inherited

Called right after calling getChildren() and its rewind().

Since

PHP 5.1

Definition at line 201 of file recursiveiteratoriterator.inc.

Referenced by RecursiveIteratorIterator\next().

    {
    }

RecursiveIteratorIterator::callGetChildren ( )

inherited

Returns

current sub iterators current children

Since

PHP 5.1

Definition at line 193 of file recursiveiteratoriterator.inc.

References RecursiveIteratorIterator\$count.

Referenced by RecursiveIteratorIterator\next().

    {
        return $this->ait[$this->count]->getChildren();
    }

RecursiveIteratorIterator::callHasChildren ( )

inherited

Returns

whether current sub iterators current element has children

Since

PHP 5.1

Definition at line 185 of file recursiveiteratoriterator.inc.

References RecursiveIteratorIterator\$count.

Referenced by RecursiveIteratorIterator\callNextElement(), and RecursiveIteratorIterator\next().

    {
        return $this->ait[$this->count]->hasChildren();
    }

DirectoryTreeIterator::current

(

)

Returns

the current element prefixed with ASCII graphics

Implements Iterator.

Definition at line 36 of file directorytreeiterator.inc.

References RecursiveIteratorIterator\getDepth(), and RecursiveIteratorIterator\getSubIterator().

    {
        $tree = '';
        for ($l=0; $l < $this->getDepth(); $l++) {
            $tree .= $this->getSubIterator($l)->hasNext() ? '| ' : '  ';
        }
        return $tree . ($this->getSubIterator($l)->hasNext() ? '|-' : '\-') 
               . $this->getSubIterator($l)->__toString();
    }

Here is the call graph for this function:

RecursiveIteratorIterator::endChildren ( )

inherited

Called after current child iterator is invalid and right before it gets destructed.

Since

PHP 5.1

Definition at line 209 of file recursiveiteratoriterator.inc.

Referenced by RecursiveIteratorIterator\next(), RecursiveIteratorIterator\rewind(), and RecursiveIteratorIterator\valid().

    {
    }

RecursiveIteratorIterator::getDepth ( )

inherited

Returns

Current Depth (Number of parents)

Definition at line 177 of file recursiveiteratoriterator.inc.

Referenced by current(), and RecursiveTreeIterator\getPrefix().

    {
        return $this->level;
    }

RecursiveIteratorIterator::getInnerIterator ( )

inherited

Returns

The inner iterator

Implements OuterIterator.

Definition at line 170 of file recursiveiteratoriterator.inc.

References $it.

Referenced by RecursiveCompareDualIterator\areEqual(), RecursiveCompareDualIterator\areIdentical(), and RecursiveCompareDualIterator\endChildren().

    {
        return $this->it;
    }

RecursiveIteratorIterator::getSubIterator (   $level = NULL )

inherited

Returns

Sub Iterator at given level or if unspecified the current sub Iterator

Definition at line 159 of file recursiveiteratoriterator.inc.

References RecursiveIteratorIterator\$count.

Referenced by __call(), RecursiveTreeIterator\__call(), current(), and RecursiveTreeIterator\getPrefix().

    {
        if (is_null($level)) {
            $level = $this->count;
        }
        return @$this->ait[$level];
    }

RecursiveIteratorIterator::key ( )

inherited

Returns

current key

Implements Iterator.

Definition at line 91 of file recursiveiteratoriterator.inc.

References RecursiveIteratorIterator\$count, and $it.

    {
        $it = $this->ait[$this->count];
        return $it->key();
    }

RecursiveIteratorIterator::next ( )

inherited

Forward to next element.

Implements Iterator.

Definition at line 107 of file recursiveiteratoriterator.inc.

References RecursiveIteratorIterator\$count, $it, RecursiveIteratorIterator\beginChildren(), RecursiveIteratorIterator\callGetChildren(), RecursiveIteratorIterator\callHasChildren(), RecursiveIteratorIterator\callNextElement(), and RecursiveIteratorIterator\endChildren().

    {
        while ($this->count) {
            $it = $this->ait[$this->count];
            if ($it->valid()) {
                if (!$it->recursed && callHasChildren()) {
                    $it->recursed = true;
                    try
                    {
                        $sub = callGetChildren();
                    }
                    catch (Exception $e)
                    {
                        if (!($this->flags & self::CATCH_GET_CHILD))
                        {
                            throw $e;
                        }
                        $it->next();
                        continue;
                    }
                    $sub->recursed = false;
                    $sub->rewind();
                    if ($sub->valid()) {
                        $this->ait[++$this->count] = $sub;
                        if (!$sub instanceof RecursiveIterator) {
                            throw new Exception(get_class($sub).'::getChildren() must return an object that implements RecursiveIterator');
                        }
                        $this->beginChildren();
                        return;
                    }
                    unset($sub);
                }
                $it->next();
                $it->recursed = false;
                if ($it->valid()) {
                    return;
                }
                $it->recursed = false;
            }
            if ($this->count) {
                unset($this->ait[$this->count--]);
                $it = $this->ait[$this->count];
                $this->endChildren();
                callNextElement(false);
            }
        }
        callNextElement(true);
    }

Here is the call graph for this function:

RecursiveIteratorIterator::nextElement ( )

inherited

Called when the next element is available.

Definition at line 232 of file recursiveiteratoriterator.inc.

Referenced by RecursiveIteratorIterator\callNextElement().

    {
    }

RecursiveIteratorIterator::rewind ( )

inherited

Rewind to top iterator as set in constructor.

Implements Iterator.

Definition at line 62 of file recursiveiteratoriterator.inc.

References RecursiveIteratorIterator\callNextElement(), and RecursiveIteratorIterator\endChildren().

    {
        while ($this->count) {
            unset($this->ait[$this->count--]);
            $this->endChildren();
        }
        $this->ait[0]->rewind();
        $this->ait[0]->recursed = false;
        callNextElement(true);
    }

Here is the call graph for this function:

RecursiveIteratorIterator::valid ( )

inherited

Returns

whether iterator is valid

Implements Iterator.

Definition at line 75 of file recursiveiteratoriterator.inc.

References RecursiveIteratorIterator\$count, $it, and RecursiveIteratorIterator\endChildren().

Referenced by RecursiveIteratorIterator\callNextElement().

    {
        $count = $this->count;
        while ($count) {
            $it = $this->ait[$count];
            if ($it->valid()) {
                return true;
            }
            $count--;
            $this->endChildren();
        }
        return false;
    }

Here is the call graph for this function:

Member Data Documentation

const RecursiveIteratorIterator::CATCH_GET_CHILD = 0x00000002

inherited

Flag: Catches exceptions during getChildren() calls and simply jumps to the next element.

Definition at line 33 of file recursiveiteratoriterator.inc.

const RecursiveIteratorIterator::CHILD_FIRST = 2

inherited

Mode: Show all children prior to their parent.

Definition at line 29 of file recursiveiteratoriterator.inc.

const RecursiveIteratorIterator::LEAVES_ONLY = 0

inherited

Mode: Only show leaves.

Definition at line 25 of file recursiveiteratoriterator.inc.

const RecursiveIteratorIterator::SELF_FIRST = 1

inherited

Mode: Show parents prior to their children.

Definition at line 27 of file recursiveiteratoriterator.inc.

---

The documentation for this class was generated from the following file:

• directorytreeiterator.inc