Last updated: Fri, 24 Sep 2010

The RecursiveDirectoryIterator class

Introduction

The RecursiveDirectoryIterator provides an interface for iterating recursively over filesystem directories.

Class synopsis

RecursiveDirectoryIterator extends FilesystemIterator implements Traversable , Iterator , SeekableIterator , RecursiveIterator {

/* Methods */

__construct ( string $path [, int $flags = FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_FILEINFO ] )

object getChildren ( void )

public string getSubPath ( void )

public string getSubPathname ( void )

bool hasChildren ([ bool $allow_links ] )

string key ( void )

void next ( void )

void rewind ( void )

/* Inherits */

FilesystemIterator::__construct ( string $path [, int $flags = FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_FILEINFO | FilesystemIterator::SKIP_DOTS ] )

public mixed FilesystemIterator::current ( void )

public int FilesystemIterator::getFlags ( void )

public string FilesystemIterator::key ( void )

public void FilesystemIterator::next ( void )

public void FilesystemIterator::rewind ( void )

public void FilesystemIterator::setFlags ([ int $flags ] )

}

Changelog

Version	Description
5.3.0	The FilesystemIterator was introduced as the parent class. Previously, the parent was the DirectoryIterator.
5.3.0	Implements SeekableIterator.

RecursiveDirectoryIterator::__construct — Constructs a RecursiveDirectoryIterator
RecursiveDirectoryIterator::getChildren — Returns an iterator for the current entry if it is a directory
RecursiveDirectoryIterator::getSubPath — Get sub path
RecursiveDirectoryIterator::getSubPathname — Get sub path and name
RecursiveDirectoryIterator::hasChildren — Returns whether current entry is a directory and not '.' or '..'
RecursiveDirectoryIterator::key — Return path and filename of current dir entry
RecursiveDirectoryIterator::next — Move to next entry
RecursiveDirectoryIterator::rewind — Rewind dir back to the start

RecursiveDirectoryIterator::__construct

RecursiveCachingIterator::hasChildren

Last updated: Fri, 24 Sep 2010

add a note User Contributed Notes
RecursiveDirectoryIterator

Thriault
09-Apr-2010 09:05


If you would like to get, say, all the *.php files in your project folder, recursively, you could use the following:



<?php



$Directory = new RecursiveDirectoryIterator('path/to/project/');

$Iterator = new RecursiveIteratorIterator($Directory);

$Regex = new RegexIterator($Iterator, '/^.+\.php$/i', RecursiveRegexIterator::GET_MATCH);



?>



$Regex will contain a single index array for each PHP file.

megar
15-Jul-2009 10:57


Usage example:

To see all the files, and count the space usage:



<?php

$ite=new RecursiveDirectoryIterator("/path/");



$bytestotal=0;

$nbfiles=0;

foreach (new RecursiveIteratorIterator($ite) as $filename=>$cur) {

    $filesize=$cur->getSize();

    $bytestotal+=$filesize;

    $nbfiles++;

    echo "$filename => $filesize\n";

}



$bytestotal=number_format($bytestotal);

echo "Total: $nbfiles files, $bytestotal bytes\n";

?>

Justin Deltener
10-Jun-2009 06:45


If you don't get a fully recursive listing, remember to check your permissions on the folders. I just spent 2 hours to find out my root folder didn't have +x on it. I did a chmod g+x and now get a full listing. Oddly, I was able to get a listing of files/folders one level UNDER that folder, but nothing beyond that point which was cause for the confusion.

alvaro at demogracia dot com
18-Sep-2008 05:15


Usage example:



<?php



$path = realpath('/etc');



$objects = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($path), RecursiveIteratorIterator::SELF_FIRST);

foreach($objects as $name => $object){

    echo "$name\n";

}



?>



This prints a list of all files and directories under $path (including $path ifself). If you want to omit directories, remove the RecursiveIteratorIterator::SELF_FIRST part.

add a note

RecursiveDirectoryIterator::__construct

RecursiveCachingIterator::hasChildren

Last updated: Fri, 24 Sep 2010

The RecursiveDirectoryIterator class

Introduction

Class synopsis

Changelog

Table of Contents