The FilesystemIterator class

    (PHP 5 >= 5.3.0, PHP 7, PHP 8)

    Introduction

    The Filesystem iterator

    Class synopsis

    classFilesystemIteratorextendsDirectoryIterator {
    publicconstintCURRENT_MODE_MASK;
    publicconstintCURRENT_AS_PATHNAME;
    publicconstintCURRENT_AS_FILEINFO;
    publicconstintCURRENT_AS_SELF;
    publicconstintKEY_MODE_MASK;
    publicconstintKEY_AS_PATHNAME;
    publicconstintFOLLOW_SYMLINKS;
    publicconstintKEY_AS_FILENAME;
    publicconstintNEW_CURRENT_AND_KEY;
    publicconstintOTHER_MODE_MASK;
    publicconstintSKIP_DOTS;
    publicconstintUNIX_PATHS;
    public__construct(string$directory, int$flags = FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_FILEINFO | FilesystemIterator::SKIP_DOTS)
    publiccurrent(): string|SplFileInfo|FilesystemIterator
    publicgetFlags(): int
    publickey(): string
    publicnext(): void
    publicrewind(): void
    publicsetFlags(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
    }

    Predefined Constants

    FilesystemIterator::CURRENT_AS_PATHNAME

    Makes FilesystemIterator::current() return the pathname.

    FilesystemIterator::CURRENT_AS_FILEINFO

    Makes FilesystemIterator::current() return an SplFileInfo instance.

    FilesystemIterator::CURRENT_AS_SELF

    Makes FilesystemIterator::current() return $this (the FilesystemIterator).

    FilesystemIterator::CURRENT_MODE_MASK

    Masks FilesystemIterator::current()

    FilesystemIterator::KEY_AS_PATHNAME

    Makes FilesystemIterator::key() return the pathname.

    FilesystemIterator::KEY_AS_FILENAME

    Makes FilesystemIterator::key() return the filename.

    Makes RecursiveDirectoryIterator::hasChildren() follow symlinks.

    FilesystemIterator::KEY_MODE_MASK

    Masks FilesystemIterator::key()

    FilesystemIterator::NEW_CURRENT_AND_KEY

    Same as FilesystemIterator::KEY_AS_FILENAME | FilesystemIterator::CURRENT_AS_FILEINFO.

    FilesystemIterator::OTHER_MODE_MASK

    Mask used for FilesystemIterator::getFlags() and FilesystemIterator::setFlags().

    FilesystemIterator::SKIP_DOTS

    Skips dot files (. and ..).

    FilesystemIterator::UNIX_PATHS

    Makes paths use Unix-style forward slash irrespective of system default. Note that the path that is passed to the constructor is not modified.

    Table of Contents

    To Top