RecursiveCompareDualIterator Class Reference
[Example classes]

Recursive comparison iterator for a RecursiveDualIterator. More...

Inheritance diagram for RecursiveCompareDualIterator:

Inheritance graph
{RecursiveIteratorIterator\n|+ CATCH_GET_CHILD\l+ CHILD_FIRST\l+ LEAVES_ONLY\l+ SELF_FIRST\l- $ait\l- $count\l- $flags\l- $mode\l|+ __construct()\l+ beginChildren()\l+ callGetChildren()\l+ callHasChildren()\l+ current()\l+ endChildren()\l+ getDepth()\l+ getInnerIterator()\l+ getSubIterator()\l+ key()\l+ next()\l+ nextElement()\l+ rewind()\l+ valid()\l- callNextElement()\l}{OuterIterator\n||+ getInnerIterator()\l}{Iterator\n||+ current()\l+ key()\l+ next()\l+ rewind()\l+ valid()\l}{Traversable\n||}
[legend]
Collaboration diagram for RecursiveCompareDualIterator:

Collaboration graph
{RecursiveIteratorIterator\n|+ CATCH_GET_CHILD\l+ CHILD_FIRST\l+ LEAVES_ONLY\l+ SELF_FIRST\l- $ait\l- $count\l- $flags\l- $mode\l|+ __construct()\l+ beginChildren()\l+ callGetChildren()\l+ callHasChildren()\l+ current()\l+ endChildren()\l+ getDepth()\l+ getInnerIterator()\l+ getSubIterator()\l+ key()\l+ next()\l+ nextElement()\l+ rewind()\l+ valid()\l- callNextElement()\l}{OuterIterator\n||+ getInnerIterator()\l}{Iterator\n||+ current()\l+ key()\l+ next()\l+ rewind()\l+ valid()\l}{Traversable\n||}
[legend]
List of all members.

Public Member Functions

 __construct (RecursiveDualIterator $it, $mode=self::LEAVES_ONLY, $flags=0)
 areEqual ()
 areIdentical ()
 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

Protected Attributes

 $equal = false

Detailed Description

Recursive comparison iterator for a RecursiveDualIterator.

Author:
Marcus Boerger
Version:
1.0

Definition at line 17 of file recursivecomparedualiterator.inc.


Constructor & Destructor Documentation

RecursiveCompareDualIterator::__construct ( RecursiveDualIterator it,
mode = self::LEAVES_ONLY,
flags = 0 
)

Construct from RecursiveDualIterator.

Parameters:
$it RecursiveDualIterator
$mode should be LEAVES_ONLY
$flags should be 0

Definition at line 30 of file recursivecomparedualiterator.inc.

References $it.

00031     {
00032         parent::__construct($it);
00033     }


Member Function Documentation

RecursiveCompareDualIterator::areEqual (  ) 

Returns:
whether both inner iterators are valid and have equal current and key values or both are non valid.

Definition at line 63 of file recursivecomparedualiterator.inc.

References RecursiveIteratorIterator::getInnerIterator().

00064     {
00065         return $this->equal && $this->getInnerIterator()->areEqual();
00066     }

Here is the call graph for this function:

RecursiveIteratorIterator::getInnerIterator

RecursiveCompareDualIterator::areIdentical (  ) 

Returns:
whether both inner iterators are valid and have identical current and key values or both are non valid.

Definition at line 55 of file recursivecomparedualiterator.inc.

References RecursiveIteratorIterator::getInnerIterator().

00056     {
00057         return $this->equal && $this->getInnerIterator()->areIdentical();
00058     }

Here is the call graph for this function:

RecursiveIteratorIterator::getInnerIterator

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().

00202     {
00203     }

RecursiveIteratorIterator::callGetChildren (  )  [inherited]

Returns:
current sub iterators current children

Since:
PHP 5.1

Definition at line 193 of file recursiveiteratoriterator.inc.

Referenced by RecursiveIteratorIterator::next().

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

RecursiveIteratorIterator::callHasChildren (  )  [inherited]

Returns:
whether current sub iterators current element has children

Since:
PHP 5.1

Definition at line 185 of file recursiveiteratoriterator.inc.

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

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

RecursiveIteratorIterator::current (  )  [inherited]

Returns:
current element

Implements Iterator.

Reimplemented in DirectoryTreeIterator, and RecursiveTreeIterator.

Definition at line 99 of file recursiveiteratoriterator.inc.

References $it.

00100     {
00101         $it = $this->ait[$this->count];
00102         return $it->current();
00103     }

RecursiveCompareDualIterator::endChildren (  ) 

Calculate $equal.

See also:
$equal

Reimplemented from RecursiveIteratorIterator.

Definition at line 46 of file recursivecomparedualiterator.inc.

References RecursiveIteratorIterator::getInnerIterator().

00047     {
00048         $this->equal &= !$this->getInnerIterator()->getLHS()->valid()
00049                      && !$this->getInnerIterator()->getRHS()->valid();
00050     }

Here is the call graph for this function:

RecursiveIteratorIterator::getInnerIterator

RecursiveIteratorIterator::getDepth (  )  [inherited]

Returns:
Current Depth (Number of parents)

Definition at line 177 of file recursiveiteratoriterator.inc.

Referenced by DirectoryTreeIterator::current(), and RecursiveTreeIterator::getPrefix().

00178     {
00179         return $this->level;
00180     }

RecursiveIteratorIterator::getInnerIterator (  )  [inherited]

Returns:
The inner iterator

Implements OuterIterator.

Definition at line 170 of file recursiveiteratoriterator.inc.

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

00171     {
00172         return $this->it;
00173     }

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.

Referenced by RecursiveTreeIterator::__call(), DirectoryTreeIterator::__call(), DirectoryTreeIterator::current(), and RecursiveTreeIterator::getPrefix().

00160     {
00161         if (is_null($level)) {
00162             $level = $this->count;
00163         }
00164         return @$this->ait[$level];
00165     }

RecursiveIteratorIterator::key (  )  [inherited]

Returns:
current key

Implements Iterator.

Reimplemented in RecursiveTreeIterator.

Definition at line 91 of file recursiveiteratoriterator.inc.

References $it.

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

RecursiveIteratorIterator::next (  )  [inherited]

Forward to next element.

Implements Iterator.

Definition at line 107 of file recursiveiteratoriterator.inc.

References $it, RecursiveIteratorIterator::beginChildren(), RecursiveIteratorIterator::callGetChildren(), RecursiveIteratorIterator::callHasChildren(), RecursiveIteratorIterator::callNextElement(), RecursiveIteratorIterator::endChildren(), and RecursiveIteratorIterator::valid().

00108     {
00109         while ($this->count) {
00110             $it = $this->ait[$this->count];
00111             if ($it->valid()) {
00112                 if (!$it->recursed && callHasChildren()) {
00113                     $it->recursed = true;
00114                     try
00115                     {
00116                         $sub = callGetChildren();
00117                     }
00118                     catch (Exception $e)
00119                     {
00120                         if (!($this->flags & self::CATCH_GET_CHILD))
00121                         {
00122                             throw $e;
00123                         }
00124                         $it->next();
00125                         continue;
00126                     }
00127                     $sub->recursed = false;
00128                     $sub->rewind();
00129                     if ($sub->valid()) {
00130                         $this->ait[++$this->count] = $sub;
00131                         if (!$sub instanceof RecursiveIterator) {
00132                             throw new Exception(get_class($sub).'::getChildren() must return an object that implements RecursiveIterator');
00133                         }
00134                         $this->beginChildren();
00135                         return;
00136                     }
00137                     unset($sub);
00138                 }
00139                 $it->next();
00140                 $it->recursed = false;
00141                 if ($it->valid()) {
00142                     return;
00143                 }
00144                 $it->recursed = false;
00145             }
00146             if ($this->count) {
00147                 unset($this->ait[$this->count--]);
00148                 $it = $this->ait[$this->count];
00149                 $this->endChildren();
00150                 callNextElement(false);
00151             }
00152         }
00153         callNextElement(true);
00154     }

Here is the call graph for this function:

RecursiveIteratorIterator::beginChildrenRecursiveIteratorIterator::callGetChildrenRecursiveIteratorIterator::callHasChildrenRecursiveIteratorIterator::callNextElementRecursiveIteratorIterator::validRecursiveIteratorIterator::endChildrenRecursiveIteratorIterator::nextElement

RecursiveIteratorIterator::nextElement (  )  [inherited]

Called when the next element is available.

Definition at line 232 of file recursiveiteratoriterator.inc.

Referenced by RecursiveIteratorIterator::callNextElement().

00233     {
00234     }

RecursiveCompareDualIterator::rewind (  ) 

Rewind iteration andcomparison process.

Starting with $equal = true.

Reimplemented from RecursiveIteratorIterator.

Definition at line 37 of file recursivecomparedualiterator.inc.

00038     {
00039         $this->equal = true;
00040         parent::rewind();
00041     }

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(), and RecursiveIteratorIterator::next().

00076     {
00077         $count = $this->count;
00078         while ($count) {
00079             $it = $this->ait[$count];
00080             if ($it->valid()) {
00081                 return true;
00082             }
00083             $count--;
00084             $this->endChildren();
00085         }
00086         return false;
00087     }

Here is the call graph for this function:

RecursiveIteratorIterator::endChildren


Member Data Documentation

RecursiveCompareDualIterator::$equal = false [protected]

Used to keep end of recursion equality.

That is en leaving a nesting level we need to check whether both child iterators are at their end.

Definition at line 22 of file recursivecomparedualiterator.inc.

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:
Generated on Thu Apr 26 01:06:50 2007 for SPL-StandardPHPLibrary by  doxygen 1.5.2