OuterIterator Interface Reference

Interface to access the current inner iteraor of iterator wrappers. More...

Inheritance diagram for OuterIterator:

Inheritance graph
{AppendIterator\n|- $iterators\l|+ __call()\l+ __construct()\l+ append()\l+ current()\l+ getInnerIterator()\l+ key()\l+ next()\l+ rewind()\l+ valid()\l}{CachingIterator\n|+ CALL_TOSTRING\l+ CATCH_GET_CHILD\l+ TOSTRING_USE_CURRENT\l+ TOSTRING_USE_KEY\l- $current\l- $it\l- $key\l- $strValue\l- $valid\l|+ __call()\l+ __construct()\l+ __toString()\l+ current()\l+ getInnerIterator()\l+ hasNext()\l+ key()\l+ next()\l+ rewind()\l+ valid()\l}{\< FilterIterator \>\n|- $it\l|+ __call()\l+ __construct()\l+ accept()\l+ current()\l+ getInnerIterator()\l+ key()\l+ next()\l+ rewind()\l+ valid()\l# __clone()\l# fetch()\l}{IteratorIterator\n|- $iterator\l|+ __call()\l+ __construct()\l+ current()\l+ getInnerIterator()\l+ key()\l+ next()\l+ rewind()\l+ valid()\l}{LimitIterator\n|- $count\l- $it\l- $offset\l- $pos\l|+ __call()\l+ __construct()\l+ current()\l+ getInnerIterator()\l+ getPosition()\l+ key()\l+ next()\l+ rewind()\l+ seek()\l+ valid()\l}{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}{Iterator\n||+ current()\l+ key()\l+ next()\l+ rewind()\l+ valid()\l}{Traversable\n||}{RecursiveCachingIterator\n|- $getChildren\l- $hasChildren\l|+ __construct()\l+ getChildren()\l+ hasChildren()\l+ rewind()\l}{CachingRecursiveIterator\n||}{InfiniteIterator\n||+ next()\l}{NoRewindIterator\n||+ rewind()\l}{DirectoryTree\n||+ __construct()\l}{DirectoryTreeIterator\n||+ __call()\l+ __construct()\l+ current()\l}{RecursiveCompareDualIterator\n|# $equal\l|+ __construct()\l+ areEqual()\l+ areIdentical()\l+ endChildren()\l+ rewind()\l}{RecursiveTreeIterator\n|+ $prefix\l+ BYPASS_CURRENT\l+ BYPASS_KEY\l- $rit_flags\l|+ __call()\l+ __construct()\l+ current()\l+ getEntry()\l+ getPostfix()\l+ getPrefix()\l+ key()\l}{DirectoryGraphIterator\n||+ __construct()\l}
[legend]
Collaboration diagram for OuterIterator:

Collaboration graph
{Iterator\n||+ current()\l+ key()\l+ next()\l+ rewind()\l+ valid()\l}{Traversable\n||}
[legend]
List of all members.

Public Member Functions

 current ()
 getInnerIterator ()
 key ()
 next ()
 rewind ()
 valid ()

Detailed Description

Interface to access the current inner iteraor of iterator wrappers.

Author:
Marcus Boerger
Version:
1.0
Since:
PHP 5.1

Definition at line 18 of file outeriterator.inc.

Member Function Documentation

Iterator::current (  )  [inherited]

Return the current element.

Implemented in ArrayIterator, DirectoryIterator, RecursiveDirectoryIterator, SimpleXMLIterator, SubClasses, DbaReader, DirectoryTreeIterator, DualIterator, RecursiveTreeIterator, AppendIterator, CachingIterator, EmptyIterator, < FilterIterator >, IteratorIterator, LimitIterator, RecursiveIteratorIterator, SplFileObject, and SplObjectStorage.

OuterIterator::getInnerIterator (  ) 

Returns:
inner iterator

Implemented in AppendIterator, CachingIterator, < FilterIterator >, IteratorIterator, LimitIterator, and RecursiveIteratorIterator.

Iterator::key (  )  [inherited]

Return the key of the current element.

Implemented in ArrayIterator, DirectoryIterator, RecursiveDirectoryIterator, SimpleXMLIterator, DbaReader, DualIterator, RecursiveTreeIterator, AppendIterator, CachingIterator, EmptyIterator, < FilterIterator >, IteratorIterator, LimitIterator, RecursiveIteratorIterator, SplFileObject, and SplObjectStorage.

Iterator::next (  )  [inherited]

Move forward to next element.

Implemented in ArrayIterator, DirectoryIterator, SimpleXMLIterator, DbaReader, DualIterator, AppendIterator, CachingIterator, EmptyIterator, < FilterIterator >, InfiniteIterator, IteratorIterator, LimitIterator, RecursiveIteratorIterator, SplFileObject, and SplObjectStorage.

Iterator::rewind (  )  [inherited]

Rewind the Iterator to the first element.

Implemented in ArrayIterator, DirectoryIterator, SimpleXMLIterator, DbaReader, DualIterator, RecursiveCompareDualIterator, AppendIterator, CachingIterator, EmptyIterator, < FilterIterator >, IteratorIterator, LimitIterator, NoRewindIterator, RecursiveCachingIterator, RecursiveIteratorIterator, SplFileObject, and SplObjectStorage.

Iterator::valid (  )  [inherited]

Check if there is a current element after calls to rewind() or next().

Implemented in ArrayIterator, DirectoryIterator, SimpleXMLIterator, DbaReader, DualIterator, AppendIterator, CachingIterator, EmptyIterator, < FilterIterator >, IteratorIterator, LimitIterator, RecursiveIteratorIterator, SplFileObject, and SplObjectStorage.

The documentation for this interface was generated from the following file:
Generated on Thu Apr 26 01:06:30 2007 for SPL-StandardPHPLibrary by  doxygen 1.5.2