PHP 7.0.6 Released

    The FilesystemIterator class

    (PHP 5 >= 5.3.0, PHP 7)

    Introduction

    The Filesystem iterator

    Class synopsis

    FilesystemIterator extends DirectoryIterator implements SeekableIterator {
    /* Constants */
    const integer CURRENT_AS_PATHNAME = 32 ;
    const integer CURRENT_AS_FILEINFO = 0 ;
    const integer CURRENT_AS_SELF = 16 ;
    const integer CURRENT_MODE_MASK = 240 ;
    const integer KEY_AS_PATHNAME = 0 ;
    const integer KEY_AS_FILENAME = 256 ;
    const integer FOLLOW_SYMLINKS = 512 ;
    const integer KEY_MODE_MASK = 3840 ;
    const integer NEW_CURRENT_AND_KEY = 256 ;
    const integer SKIP_DOTS = 4096 ;
    const integer UNIX_PATHS = 8192 ;
    /* Methods */
    public __construct ( string $path [, int $flags = FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_FILEINFO | FilesystemIterator::SKIP_DOTS ] )
    public mixed current ( void )
    public int getFlags ( void )
    public string key ( void )
    public void next ( void )
    public void rewind ( void )
    public void setFlags ([ int $flags ] )
    /* Inherited methods */
    public DirectoryIterator DirectoryIterator::current ( void )
    public int DirectoryIterator::getATime ( void )
    public string DirectoryIterator::getBasename ([ string $suffix ] )
    public int DirectoryIterator::getCTime ( void )
    public string DirectoryIterator::getExtension ( void )
    public string DirectoryIterator::getFilename ( void )
    public int DirectoryIterator::getGroup ( void )
    public int DirectoryIterator::getInode ( void )
    public int DirectoryIterator::getMTime ( void )
    public int DirectoryIterator::getOwner ( void )
    public string DirectoryIterator::getPath ( void )
    public string DirectoryIterator::getPathname ( void )
    public int DirectoryIterator::getPerms ( void )
    public int DirectoryIterator::getSize ( void )
    public string DirectoryIterator::getType ( void )
    public bool DirectoryIterator::isDir ( void )
    public bool DirectoryIterator::isDot ( void )
    public bool DirectoryIterator::isExecutable ( void )
    public bool DirectoryIterator::isFile ( void )
    public bool DirectoryIterator::isLink ( void )
    public bool DirectoryIterator::isReadable ( void )
    public bool DirectoryIterator::isWritable ( void )
    public string DirectoryIterator::key ( void )
    public void DirectoryIterator::next ( void )
    public void DirectoryIterator::rewind ( void )
    public void DirectoryIterator::seek ( int $position )
    public string DirectoryIterator::__toString ( void )
    public bool DirectoryIterator::valid ( void )
    }

    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::SKIP_DOTS

    Skips dot files (. and ..).

    FilesystemIterator::UNIX_PATHS

    Makes paths use Unix-style forward slash irrespective of system default.

    Changelog

    Version Description
    5.3.1 Added FilesystemIterator::FOLLOW_SYMLINKS

    Table of Contents

    User Contributed Notes

    paul at paulgarvin dot net
    1 year ago
    You may be wondering, like I did, what is the difference between this class and DirectoryIterator?

    When you iteterate using DirectoryIterator each "value" returned is the same DirectoryIterator object. The internal state is changed so when you call isDir(), getPathname(), etc the correct information is returned. If you were to ask for a key when iterating you will get an integer index value.

    FilesystemIterator (and RecursiveDirectoryIterator) on the other hand returns a new, different SplFileInfo object for each iteration step. The key is the full pathname of the file. This is by default. You can change what is returned for the key or value using the "flags" arguement to the constructor.
    thedilab at gmail dot com
    6 months ago
    DirectoryIterator returns virtual directories "." and ".." in a loop.
    But FilesystemIterator ignores them.
    To Top