La clase FilesystemIterator

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

Introducción

El iterador Filesystem

Sinopsis de la Clase

class FilesystemIterator extends DirectoryIterator implements SeekableIterator {

/* Constantes */

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;

/* Métodos */

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

/* Métodos heredados */

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

}

Constantes predefinidas

FilesystemIterator::CURRENT_AS_PATHNAME: Hace que FilesystemIterator::current() devuelva el nombre de la ruta.
FilesystemIterator::CURRENT_AS_FILEINFO: Hace que FilesystemIterator::current() devuelva una instancia de SplFileInfo .
FilesystemIterator::CURRENT_AS_SELF: Hace que FilesystemIterator::current() devuelva $this (el objeto FilesystemIterator).
FilesystemIterator::CURRENT_MODE_MASK: Enmascara FilesystemIterator::current()
FilesystemIterator::KEY_AS_PATHNAME: Hace que FilesystemIterator::key() devuelva el nombre de la ruta.
FilesystemIterator::KEY_AS_FILENAME: Hace que FilesystemIterator::key() devuelva el nombre de fichero.
FilesystemIterator::FOLLOW_SYMLINKS: Hace que RecursiveDirectoryIterator::hasChildren() siga enlaces simbólicos.
FilesystemIterator::KEY_MODE_MASK: Enmascara FilesystemIterator::key()
FilesystemIterator::NEW_CURRENT_AND_KEY: Igual que FilesystemIterator::KEY_AS_FILENAME | FilesystemIterator::CURRENT_AS_FILEINFO.
FilesystemIterator::SKIP_DOTS: Ignora los ficheros punto (. y ..).
FilesystemIterator::UNIX_PATHS: Hace que las rutas usen la barra hacia adelante del estilo Unix independientemente de la predeterminada del sistema. Observe que la ruta path pasada al constructor no se modifica.

Historial de cambios

Versión	Descripción
5.3.1	Añadido `FilesystemIterator::FOLLOW_SYMLINKS`

Tabla de contenidos

FilesystemIterator::__construct — Construye un nuevo iterador filesystem
FilesystemIterator::current — El fichero actual
FilesystemIterator::getFlags — Obtiene el manejo de flags
FilesystemIterator::key — Recupera la clave del fichero actual
FilesystemIterator::next — Moverse al siguiente fichero
FilesystemIterator::rewind — Rebobina hasta volver al inicio
FilesystemIterator::setFlags — Establece las flags de manejo

Improve This Page

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 4 notes

down

paul at paulgarvin dot net ¶

10 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

blackout at drunkenlords dot com ¶

3 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

thedilab at gmail dot com ¶

9 years ago

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

down

spamblocker1@yahoo ¶

4 months ago

Here's the difference between DirectoryIterator and FileSystemIterator.

FileSystemIterator extends DirectoryIterator, inheriting all of it's functionalities, but extending it with additional options and features:

- Additional flags and options (e.g., FileSystemIterator::SKIP_DOTS to skip . and .. entries).
- Offers more control and flexibility over the iteration process.
- Suitable for more complex directory traversal requirements where additional control is needed.

So if you just need the contents of a directory, use DirectoryIterator.

If you need to do directory traversal, use FileSystemIterator.

＋add a note