Submit a Pull Request Report a Bug

The FilesystemIterator class

(PHP 5 >= 5.3.0, PHP 7)

Introducere

The Filesystem iterator

Sinopsisul clasei

FilesystemIterator extends DirectoryIterator implements SeekableIterator {

/* Constante */

const int CURRENT_AS_PATHNAME = 32 ;

const int CURRENT_AS_FILEINFO = 0 ;

const int CURRENT_AS_SELF = 16 ;

const int CURRENT_MODE_MASK = 240 ;

const int KEY_AS_PATHNAME = 0 ;

const int KEY_AS_FILENAME = 256 ;

const int FOLLOW_SYMLINKS = 512 ;

const int KEY_MODE_MASK = 3840 ;

const int NEW_CURRENT_AND_KEY = 256 ;

const int SKIP_DOTS = 4096 ;

const int UNIX_PATHS = 8192 ;

/* Metode */

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

public current ( ) : mixed

public getFlags ( ) : int

public key ( ) : string

public next ( ) : void

public rewind ( ) : void

public setFlags ([ int $flags ] ) : void

/* Metode moștenite */

public DirectoryIterator::current ( ) : DirectoryIterator

public DirectoryIterator::getATime ( ) : int

public DirectoryIterator::getBasename ([ string $suffix ] ) : string

public DirectoryIterator::getCTime ( ) : int

public DirectoryIterator::getExtension ( ) : string

public DirectoryIterator::getFilename ( ) : string

public DirectoryIterator::getGroup ( ) : int

public DirectoryIterator::getInode ( ) : int

public DirectoryIterator::getMTime ( ) : int

public DirectoryIterator::getOwner ( ) : int

public DirectoryIterator::getPath ( ) : string

public DirectoryIterator::getPathname ( ) : string

public DirectoryIterator::getPerms ( ) : int

public DirectoryIterator::getSize ( ) : int

public DirectoryIterator::getType ( ) : string

public DirectoryIterator::isDir ( ) : bool

public DirectoryIterator::isDot ( ) : bool

public DirectoryIterator::isExecutable ( ) : bool

public DirectoryIterator::isFile ( ) : bool

public DirectoryIterator::isLink ( ) : bool

public DirectoryIterator::isReadable ( ) : bool

public DirectoryIterator::isWritable ( ) : bool

public DirectoryIterator::key ( ) : string

public DirectoryIterator::next ( ) : void

public DirectoryIterator::rewind ( ) : void

public DirectoryIterator::seek ( int $position ) : void

public DirectoryIterator::__toString ( ) : string

public DirectoryIterator::valid ( ) : bool

}

Constante predefinite

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.
FilesystemIterator::FOLLOW_SYMLINKS: 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. Note that the path that is passed to the constructor is not modified.

Istoricul schimbărilor

Versiune	Descriere
5.3.1	Added `FilesystemIterator::FOLLOW_SYMLINKS`

Cuprins

FilesystemIterator::__construct — Constructs a new filesystem iterator
FilesystemIterator::current — The current file
FilesystemIterator::getFlags — Get the handling flags
FilesystemIterator::key — Retrieve the key for the current file
FilesystemIterator::next — Move to the next file
FilesystemIterator::rewind — Rewinds back to the beginning
FilesystemIterator::setFlags — Sets handling flags

add a note

User Contributed Notes 4 notes

down

paul at paulgarvin dot net ¶

9 years 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.

down

thedilab at gmail dot com ¶

8 years ago


DirectoryIterator returns virtual directories "." and ".." in a loop.
But FilesystemIterator ignores them.

down

blackout at drunkenlords dot com ¶

2 years ago


Here's a great little drop in replacement for FilesystemIterator I wrote to easily Iterate your filesystem, including:

* Sorting - using ArrayIterator
* Regex Matching - using RegexIterator
* Limiting - using LimitIterator

It's fully chainable

<?php

// Sort by filemtime
$files = (new AdvancedFilesystemIterator('/path/to/files'))->sortByMTime();

// Sort by filemtime -> Limit output to 10
$files = (new AdvancedFilesystemIterator('/path/to/files'))->sortByMTime()->limit(0, 10);

// Sort by filemtime -> Only get CSV files -> Limit to 10
$files = (new AdvancedFilesystemIterator('/path/to/files'))->sortByMTime()->match('/csv$/')->limit(0, 10);

// Sort by filemtime -> Only get CSV files -> Limit to 10 -> and back to sorting by Filename
$files = (new AdvancedFilesystemIterator('/path/to/files'))->sortByMTime()->match('/csv$/')->limit(0, 10)->sortByFilename();

// Sort by any of SplFileInfo's get*() methods i.e. Owner, CTime, Basename, ATime, Perms, Type, isFile, anything
$files = (new AdvancedFilesystemIterator('/path/to/files'))->sortByOwner();

// Foreach
foreach ((new AdvancedFilesystemIterator('/path/to/files'))->sortByMTime()->match('/csv$/')->limit(0, 10) AS $file)
{
    print $file->getFilename() . "<br>\n";
}

// The Class
class AdvancedFilesystemIterator extends ArrayIterator
{
    public function __construct(string $path, int $flags = FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_FILEINFO | FilesystemIterator::SKIP_DOTS)
    {
        parent::__construct(iterator_to_array(new FilesystemIterator($path, $flags)));
    }

    public function __call(string $name, array $arguments)
    {
        if (preg_match('/^sortBy(.*)/', $name, $m)) return $this->sort('get' . $m[1]);
        throw new MemberAccessException('Method ' . $methodName . ' not exists');
    }

    public function sort($method)
    {
        if (!method_exists('SplFileInfo', $method)) throw new InvalidArgumentException(sprintf('Method "%s" does not exist in SplFileInfo', $method));

        $this->uasort(function(SplFileInfo $a, SplFileInfo $b) use ($method) { return (is_string($a->$method()) ? strnatcmp($a->$method(), $b->$method()) : $b->$method() - $a->$method()); });

        return $this;
    }

    public function limit(int $offset = 0, int $limit = -1)
    {
        return parent::__construct(iterator_to_array(new LimitIterator($this, $offset, $limit))) ?? $this;
    }

    public function match(string $regex, int $mode = RegexIterator::MATCH, int $flags = 0, int $preg_flags = 0)
    {
        return parent::__construct(iterator_to_array(new RegexIterator($this, $regex, $mode, $flags, $preg_flags))) ?? $this;
    }
}

down

-12

ohcc at 163 dot com ¶

3 years ago


It's impossible to return dots (. and ..) by FilesystemIterator.

add a note