Submit a Pull Request Report a Bug

    FilesystemIterator クラス

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

    はじめに

    Filesystem イテレータです。

    クラス概要

    FilesystemIterator extends DirectoryIterator implements SeekableIterator {
    /* 定数 */
    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 ;
    /* メソッド */
    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
    /* 継承したメソッド */
    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
    }

    定義済み定数

    FilesystemIterator::CURRENT_AS_PATHNAME

    FilesystemIterator::current() がパス名を返すようにします。

    FilesystemIterator::CURRENT_AS_FILEINFO

    FilesystemIterator::current() が SplFileInfo のインスタンスを返すようにします。

    FilesystemIterator::CURRENT_AS_SELF

    FilesystemIterator::current() が $this (FilesystemIterator) を返すようにします。

    FilesystemIterator::CURRENT_MODE_MASK

    FilesystemIterator::current() をマスクします。

    FilesystemIterator::KEY_AS_PATHNAME

    FilesystemIterator::key() がパス名を返すようにします。

    FilesystemIterator::KEY_AS_FILENAME

    FilesystemIterator::key() がファイル名を返すようにします。

    RecursiveDirectoryIterator::hasChildren() がシンボリックリンクのリンク先をたどるようにします。

    FilesystemIterator::KEY_MODE_MASK

    FilesystemIterator::key() をマスクします。

    FilesystemIterator::NEW_CURRENT_AND_KEY

    FilesystemIterator::KEY_AS_FILENAME | FilesystemIterator::CURRENT_AS_FILEINFO と同じ。

    FilesystemIterator::SKIP_DOTS

    ドットファイル (. および ..) をスキップします。

    FilesystemIterator::UNIX_PATHS

    システムのデフォルトにかかわらず、Unix スタイルのスラッシュでパスをあらわすようにします。 コンストラクタから渡された path は変更されないことに注意しましょう。

    目次

    add a note add a note

    User Contributed Notes 3 notes

    up
    57
    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.
    up
    4
    thedilab at gmail dot com
    8 years ago
    DirectoryIterator returns virtual directories "." and ".." in a loop.
    But FilesystemIterator ignores them.
    up
    -1
    ohcc at 163 dot com
    3 years ago
    It's impossible to return dots (. and ..) by FilesystemIterator.
    add a note add a note
    To Top