The FilesystemIterator class
(PHP 5 >= 5.3.0, PHP 7, PHP 8)
Introduction
The Filesystem iterator
Class synopsis
$directory
, int $flags
= FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_FILEINFO | FilesystemIterator::SKIP_DOTS)$mode
= "r", bool $useIncludePath
= false
, ?resource $context
= null
): SplFileObjectPredefined 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
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
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.
Table of Contents
- 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