Submit a Pull Request Report a Bug

    The FilesystemIterator class

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

    Introduction

    The Filesystem iterator

    Class synopsis

    class FilesystemIterator extends DirectoryIterator {
    /* Constants */
    public const int CURRENT_MODE_MASK;
    public const int CURRENT_AS_PATHNAME;
    public const int CURRENT_AS_FILEINFO;
    public const int CURRENT_AS_SELF;
    public const int KEY_MODE_MASK;
    public const int KEY_AS_PATHNAME;
    public const int FOLLOW_SYMLINKS;
    public const int KEY_AS_FILENAME;
    public const int NEW_CURRENT_AND_KEY;
    public const int OTHER_MODE_MASK;
    public const int SKIP_DOTS;
    public const int UNIX_PATHS;
    /* Methods */
    public __construct(string $directory, int $flags = FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_FILEINFO | FilesystemIterator::SKIP_DOTS)
    public current(): string|SplFileInfo|FilesystemIterator
    public getFlags(): int
    public key(): string
    public next(): void
    public rewind(): void
    public setFlags(int $flags): void
    /* Inherited methods */
    public DirectoryIterator::current(): mixed
    public DirectoryIterator::getBasename(string $suffix = ""): string
    public DirectoryIterator::getExtension(): string
    public DirectoryIterator::getFilename(): string
    public DirectoryIterator::isDot(): bool
    public DirectoryIterator::key(): mixed
    public DirectoryIterator::next(): void
    public DirectoryIterator::rewind(): void
    public DirectoryIterator::seek(int $offset): void
    public DirectoryIterator::__toString(): string
    public DirectoryIterator::valid(): bool
    public SplFileInfo::getATime(): int|false
    public SplFileInfo::getBasename(string $suffix = ""): string
    public SplFileInfo::getCTime(): int|false
    public SplFileInfo::getExtension(): string
    public SplFileInfo::getFileInfo(?string $class = null): SplFileInfo
    public SplFileInfo::getFilename(): string
    public SplFileInfo::getGroup(): int|false
    public SplFileInfo::getInode(): int|false
    public SplFileInfo::getLinkTarget(): string|false
    public SplFileInfo::getMTime(): int|false
    public SplFileInfo::getOwner(): int|false
    public SplFileInfo::getPath(): string
    public SplFileInfo::getPathInfo(?string $class = null): ?SplFileInfo
    public SplFileInfo::getPathname(): string
    public SplFileInfo::getPerms(): int|false
    public SplFileInfo::getRealPath(): string|false
    public SplFileInfo::getSize(): int|false
    public SplFileInfo::getType(): string|false
    public SplFileInfo::isDir(): bool
    public SplFileInfo::isExecutable(): bool
    public SplFileInfo::isFile(): bool
    public SplFileInfo::isLink(): bool
    public SplFileInfo::isReadable(): bool
    public SplFileInfo::isWritable(): bool
    public SplFileInfo::openFile(string $mode = "r", bool $useIncludePath = false, ?resource $context = null): SplFileObject
    public SplFileInfo::setFileClass(string $class = SplFileObject::class): void
    public SplFileInfo::setInfoClass(string $class = SplFileInfo::class): void
    public SplFileInfo::__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

    ＋add a note

    User Contributed Notes

    There are no user contributed notes for this page.
    To Top