The RecursiveDirectoryIterator class

(PHP 5, PHP 7, PHP 8)

Introduction

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

Class synopsis

classRecursiveDirectoryIteratorextendsFilesystemIteratorimplementsRecursiveIterator {

publicconstintFilesystemIterator::CURRENT_MODE_MASK;

publicconstintFilesystemIterator::CURRENT_AS_PATHNAME;

publicconstintFilesystemIterator::CURRENT_AS_FILEINFO;

publicconstintFilesystemIterator::CURRENT_AS_SELF;

publicconstintFilesystemIterator::KEY_MODE_MASK;

publicconstintFilesystemIterator::KEY_AS_PATHNAME;

publicconstintFilesystemIterator::FOLLOW_SYMLINKS;

publicconstintFilesystemIterator::KEY_AS_FILENAME;

publicconstintFilesystemIterator::NEW_CURRENT_AND_KEY;

publicconstintFilesystemIterator::OTHER_MODE_MASK;

publicconstintFilesystemIterator::SKIP_DOTS;

publicconstintFilesystemIterator::UNIX_PATHS;

public__construct(string$directory, int$flags = FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_FILEINFO)

publicgetChildren(): RecursiveDirectoryIterator

publicgetSubPath(): string

publicgetSubPathname(): string

publichasChildren(bool$allowLinks = false): bool

publickey(): string

publicnext(): void

publicrewind(): void

publicFilesystemIterator::current(): string|SplFileInfo|FilesystemIterator

publicFilesystemIterator::getFlags(): int

publicFilesystemIterator::key(): string

publicFilesystemIterator::next(): void

publicFilesystemIterator::rewind(): void

publicFilesystemIterator::setFlags(int$flags): void

publicDirectoryIterator::current(): mixed

publicDirectoryIterator::getBasename(string$suffix = ""): string

publicDirectoryIterator::getExtension(): string

publicDirectoryIterator::getFilename(): string

publicDirectoryIterator::isDot(): bool

publicDirectoryIterator::key(): mixed

publicDirectoryIterator::next(): void

publicDirectoryIterator::rewind(): void

publicDirectoryIterator::seek(int$offset): void

publicDirectoryIterator::__toString(): string

publicDirectoryIterator::valid(): bool

publicSplFileInfo::getATime(): int|false

publicSplFileInfo::getBasename(string$suffix = ""): string

publicSplFileInfo::getCTime(): int|false

publicSplFileInfo::getExtension(): string

publicSplFileInfo::getFileInfo(?string$class = null): SplFileInfo

publicSplFileInfo::getFilename(): string

publicSplFileInfo::getGroup(): int|false

publicSplFileInfo::getInode(): int|false

publicSplFileInfo::getLinkTarget(): string|false

publicSplFileInfo::getMTime(): int|false

publicSplFileInfo::getOwner(): int|false

publicSplFileInfo::getPath(): string

publicSplFileInfo::getPathInfo(?string$class = null): ?SplFileInfo

publicSplFileInfo::getPathname(): string

publicSplFileInfo::getPerms(): int|false

publicSplFileInfo::getRealPath(): string|false

publicSplFileInfo::getSize(): int|false

publicSplFileInfo::getType(): string|false

publicSplFileInfo::isDir(): bool

publicSplFileInfo::isExecutable(): bool

publicSplFileInfo::isFile(): bool

publicSplFileInfo::isLink(): bool

publicSplFileInfo::isReadable(): bool

publicSplFileInfo::isWritable(): bool

publicSplFileInfo::openFile(string$mode = "r", bool$useIncludePath = false, ?resource$context = null): SplFileObject

publicSplFileInfo::setFileClass(string$class = SplFileObject::class): void

publicSplFileInfo::setInfoClass(string$class = SplFileInfo::class): void

publicSplFileInfo::__toString(): string

}

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

The RecursiveDirectoryIterator class

Introduction

Class synopsis

Table of Contents