RecursiveIterator Interface Reference

Interface for recursive iteration with RecursiveIteratorIterator. More...

Inheritance diagram for RecursiveIterator:

Inheritance graph
{RecursiveArrayIterator\n|- $ref\l|+ getChildren()\l+ hasChildren()\l}{RecursiveCachingIterator\n|- $getChildren\l- $hasChildren\l|+ __construct()\l+ getChildren()\l+ hasChildren()\l+ rewind()\l}{RecursiveDirectoryIterator\n|+ x00000010\l+ x00000020\l+ x00000030\l|+ __construct()\l+ current()\l+ getChildren()\l+ getSubPath()\l+ getSubPathname()\l+ hasChildren()\l+ key()\l}{RecursiveDualIterator\n|- $ref\l|+ __construct()\l+ areEqual()\l+ areIdentical()\l+ getChildren()\l+ hasChildren()\l}{\< RecursiveFilterIterator \>\n|- $ref\l|+ __construct()\l+ getChildren()\l+ hasChildren()\l}{RecursiveRegexIterator\n|- $ref\l|+ __construct()\l+ getChildren()\l+ hasChildren()\l}{SimpleXMLIterator\n||+ count()\l+ current()\l+ getChildren()\l+ hasChildren()\l+ key()\l+ next()\l+ rewind()\l+ valid()\l}{SplFileObject\n|+ DROP_NEW_LINE\l- $delimiter\l- $enclosure\l- $flags\l- $fname\l- $fp\l- $line\l- $lnum\l- $max_len\l|+ __construct()\l+ __toString()\l+ current()\l+ eof()\l+ fflush()\l+ fgetc()\l+ fgetcsv()\l+ fgets()\l+ fgetss()\l+ flock()\l+ fpassthru()\l+ fscanf()\l+ fseek()\l+ fstat()\l+ ftell()\l+ ftruncate()\l+ fwrite()\l+ getChildren()\l+ getCsvControl()\l+ getCurrentLine()\l+ getFlags()\l+ getMaxLineLen()\l+ hasChildren()\l+ key()\l+ next()\l+ rewind()\l+ seek()\l+ setCsvControl()\l+ setFlags()\l+ setMaxLineLen()\l+ valid()\l- freeLine()\l- readLine()\l}{Iterator\n||+ current()\l+ key()\l+ next()\l+ rewind()\l+ valid()\l}{Traversable\n||}{SubClasses\n||+ __construct()\l+ current()\l}{CachingRecursiveIterator\n||}
[legend]
Collaboration diagram for RecursiveIterator:

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 ()
 getChildren ()
 hasChildren ()
 key ()
 next ()
 rewind ()
 valid ()

Detailed Description

Interface for recursive iteration with RecursiveIteratorIterator.

Author:
Marcus Boerger
Version:
1.0
Since:
PHP 5.0

Definition at line 18 of file recursiveiterator.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.

RecursiveIterator::getChildren (  ) 

Returns:
the sub iterator for the current element

Note:
The returned object must implement RecursiveIterator.

Implemented in RecursiveDirectoryIterator, SimpleXMLIterator, RecursiveDualIterator, RecursiveArrayIterator, RecursiveCachingIterator, < RecursiveFilterIterator >, RecursiveRegexIterator, and SplFileObject.

Referenced by < RecursiveFilterIterator >::getChildren().

RecursiveIterator::hasChildren (  ) 

Returns:
whether the current element has children

Implemented in RecursiveDirectoryIterator, SimpleXMLIterator, RecursiveDualIterator, RecursiveArrayIterator, RecursiveCachingIterator, < RecursiveFilterIterator >, RecursiveRegexIterator, and SplFileObject.

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:07:07 2007 for SPL-StandardPHPLibrary by  doxygen 1.5.2