Docs For Class DirectoryIterator

Class DirectoryIterator

DirectoryIterator

Classes extended from DirectoryIterator:
Location: Program_Root/iterator/DirectoryIterator.php

Class DirectoryIterator provides a simple iterator for traversing the
 files in a directory.
 
   On construction a directory name must be passed, and the contents can then be
   iterated over like any other Iterator. If the iterator is used
   normally (from front to back completely), the internal directory pointer is
   closed automatically when the end of the directory is reached. If the standard
   iteration loop is not completed, the directory pointer should be closed
   explicitly by calling close() on the iterator. For example:
 
    $closed =  true;
   $it     =& new DirectoryIterator('/home/user');
   for ( ; $it->isValid(); $it->next())
   {
       $file =& $it->getCurrent();
       if ($file == 'stopfile.txt')
       {
           $closed = false;
           break;
       }
       echo $file . "\n";
   }
   if (!$closed)
   {
       $it->close();
   }
 
 
   If the directory to be read can't be opened for one reason or another, this
   class will not fail. Instead, it will simply 'iterate over nothing'. Of
   course, PHP will still log warnings and/or errors somewhere, depending on
   how this is configured.

Package: iterator
Since: Japha 1.0
Author: Ryan Gantt @

Class Variable Summary

Inherited Class Variable Summary

Method Summary

Inherited Method Summary

Variable Detail

Method Detail

void close()

Usage: close ( )

Close the internal directory pointer.  This method must be called
 if the iteration is stopped before it is completed (that is: before the
 end of the directory is reached).

Parameters

Info

Access: public

String current()

Usage: current ( )
```
Get the current file
```
Parameters
Info
- Return: the name of the current file
boolean hasNext()

Usage: hasNext ( )
```
Returns true iff there is another file in the directory
```
Parameters
Info
- Return: true iff there is another file in the directory
- Access: public
boolean isValid()

Usage: isValid ( )
```
Determine if we are at the end of the directory
```
Parameters
Info
- Return: true iff the current file is actually a file @
- Access: public
void next()

Usage: next ( )
```
Move to the next file
```
Parameters
Info
- Access: public
String readFile()

Usage: readFile ( )
```
Read a file from the directory
```
Parameters
Info
- Return: the name of the current file (not . or .. ) @
- Access: private
void reset()

Usage: reset ( )
```
Rewind to the beginning of the directory
```
Parameters
Info
- Return: @
- Access: public
void __construct()

Usage: __construct ( $dirname )
```
Constructor... Creates a new iterator
```
Parameters
- dirname $dirname - the name of the directory to iterate over
Info
- Access: public