DirectoryIterator

class DirectoryIterator extends SplFileInfo implements SeekableIterator (View source)

The DirectoryIterator class provides a simple interface for viewing the contents of filesystem directories.

Methods

__construct(string $directory)

Constructs a new directory iterator from a path

string
getPath()

Gets the path without filename

from  SplFileInfo
string
getFilename()

Gets the filename

from  SplFileInfo
string
getExtension()

Gets the file extension

from  SplFileInfo
string
getBasename(string $suffix = '')

Gets the base name of the file

from  SplFileInfo
string
getPathname()

Gets the path to the file

from  SplFileInfo
int|false
getPerms()

Gets file permissions

from  SplFileInfo
int|false
getInode()

Gets the inode for the file

from  SplFileInfo
int|false
getSize()

Gets file size

from  SplFileInfo
int|false
getOwner()

Gets the owner of the file

from  SplFileInfo
int|false
getGroup()

Gets the file group

from  SplFileInfo
int|false
getATime()

Gets last access time of the file

from  SplFileInfo
int|false
getMTime()

Gets the last modified time

from  SplFileInfo
int|false
getCTime()

Gets the inode change time

from  SplFileInfo
string|false
getType()

Gets file type

from  SplFileInfo
bool
isWritable()

Tells if the entry is writable

from  SplFileInfo
bool
isReadable()

Tells if file is readable

from  SplFileInfo
bool
isExecutable()

Tells if the file is executable

from  SplFileInfo
bool
isFile()

Tells if the object references a regular file

from  SplFileInfo
bool
isDir()

Tells if the file is a directory

from  SplFileInfo
bool
isLink()

Tells if the file is a link

from  SplFileInfo
string|false
getLinkTarget()

Gets the target of a link

from  SplFileInfo
string|false
getRealPath()

Gets absolute path to file

from  SplFileInfo
SplFileInfo
getFileInfo(T> $class = null)

Gets an SplFileInfo object for the file

from  SplFileInfo
SplFileInfo|null
getPathInfo(T> $class = null)

Gets an SplFileInfo object for the path

from  SplFileInfo
SplFileObject
openFile(string $mode = 'r', bool $useIncludePath = false, resource $context = null)

Gets an SplFileObject object for the file

from  SplFileInfo
void
setFileClass(T> $class = SplFileObject::class)

Sets the class name used with SplFileInfo::openFile

from  SplFileInfo
void
setInfoClass(T> $class = SplFileInfo::class)

Sets the class used with getFileInfo and getPathInfo

from  SplFileInfo
string
__toString()

Returns the path to the file as a string

from  SplFileInfo
void
_bad_state_ex()

No description

from  SplFileInfo
__wakeup()

No description

from  SplFileInfo
array
__debugInfo()

No description

from  SplFileInfo
bool
isDot()

Determine if current DirectoryIterator item is '.' or '..'

void
rewind()

Rewind the DirectoryIterator back to the start

bool
valid()

Check whether current DirectoryIterator position is a valid file

mixed
key()

Return the key for the current DirectoryIterator item

mixed
current()

Return the current DirectoryIterator item.

void
next()

Move forward to next DirectoryIterator item

void
seek(int $offset)

Seek to a DirectoryIterator item

Details

at line 347
__construct(string $directory)

Constructs a new directory iterator from a path

Parameters

string $directory

Exceptions

UnexpectedValueException
RuntimeException

in SplFileInfo at line 30
string getPath()

Since: 5.1.2

Gets the path without filename

Return Value

string

the path to the file.

in SplFileInfo at line 39
string getFilename()

Since: 5.1.2

Gets the filename

Return Value

string

The filename.

in SplFileInfo at line 49
string getExtension()

Since: 5.3.6

Gets the file extension

Return Value

string

a string containing the file extension, or an empty string if the file has no extension.

in SplFileInfo at line 61
string getBasename(string $suffix = '')

Since: 5.2.2

Gets the base name of the file

Parameters

string $suffix

[optional]

Optional suffix to omit from the base name returned.

Return Value

string

the base name without path information.

in SplFileInfo at line 70
string getPathname()

Since: 5.1.2

Gets the path to the file

Return Value

string

The path to the file.

in SplFileInfo at line 79
int|false getPerms()

Since: 5.1.2

Gets file permissions

Return Value

int|false

The file permissions on success, or FALSE on failure.

in SplFileInfo at line 89
int|false getInode()

Since: 5.1.2

Gets the inode for the file

Return Value

int|false

The inode number for the filesystem object on success, or FALSE on failure.

Exceptions

RuntimeException

in SplFileInfo at line 99
int|false getSize()

Since: 5.1.2

Gets file size

Return Value

int|false

The filesize in bytes on success, or FALSE on failure.

Exceptions

RuntimeException

in SplFileInfo at line 109
int|false getOwner()

Since: 5.1.2

Gets the owner of the file

Return Value

int|false

The owner id in numerical format on success, or FALSE on failure.

Exceptions

RuntimeException

in SplFileInfo at line 119
int|false getGroup()

Since: 5.1.2

Gets the file group

Return Value

int|false

The group id in numerical format on success, or FALSE on failure.

Exceptions

RuntimeException

in SplFileInfo at line 129
int|false getATime()

Since: 5.1.2

Gets last access time of the file

Return Value

int|false

The time the file was last accessed on success, or FALSE on failure.

Exceptions

RuntimeException

in SplFileInfo at line 138
int|false getMTime()

Since: 5.1.2

Gets the last modified time

Return Value

int|false

The last modified time for the file, in a Unix timestamp on success, or FALSE on failure.

in SplFileInfo at line 148
int|false getCTime()

Since: 5.1.2

Gets the inode change time

Return Value

int|false

The last change time, in a Unix timestamp on success, or FALSE on failure.

Exceptions

RuntimeException

in SplFileInfo at line 160
string|false getType()

Since: 5.1.2

Gets file type

Return Value

string|false

A string representing the type of the entry. May be one of file, link, dir, block, fifo, char, socket, or unknown, or FALSE on failure. May be one of file, link, or dir

Exceptions

RuntimeException

in SplFileInfo at line 169
bool isWritable()

Since: 5.1.2

Tells if the entry is writable

Return Value

bool

true if writable, false otherwise;

in SplFileInfo at line 178
bool isReadable()

Since: 5.1.2

Tells if file is readable

Return Value

bool

true if readable, false otherwise.

in SplFileInfo at line 187
bool isExecutable()

Since: 5.1.2

Tells if the file is executable

Return Value

bool

true if executable, false otherwise.

in SplFileInfo at line 196
bool isFile()

Since: 5.1.2

Tells if the object references a regular file

Return Value

bool

true if the file exists and is a regular file (not a link), false otherwise.

in SplFileInfo at line 205
bool isDir()

Since: 5.1.2

Tells if the file is a directory

Return Value

bool

true if a directory, false otherwise.
Since: 5.1.2

Tells if the file is a link

Return Value

bool

true if the file is a link, false otherwise.

in SplFileInfo at line 224
string|false getLinkTarget()

Since: 5.2.2

Gets the target of a link

Return Value

string|false

The target of the filesystem link on success, or FALSE on failure.

Exceptions

RuntimeException

in SplFileInfo at line 233
string|false getRealPath()

Since: 5.2.2

Gets absolute path to file

Return Value

string|false

the path to the file, or FALSE if the file does not exist.

in SplFileInfo at line 246
SplFileInfo getFileInfo(T> $class = null)

Since: 5.1.2

Gets an SplFileInfo object for the file

Parameters

T> $class

[optional]

Name of an SplFileInfo derived class to use.

Return Value

SplFileInfo

An SplFileInfo object created for the file.

in SplFileInfo at line 259
SplFileInfo|null getPathInfo(T> $class = null)

Since: 5.1.2

Gets an SplFileInfo object for the path

Parameters

T> $class

[optional]

Name of an SplFileInfo derived class to use.

Return Value

SplFileInfo|null

A SplFileInfo object for the parent path of the file on success, or NULL on failure.

in SplFileInfo at line 278
SplFileObject openFile(string $mode = 'r', bool $useIncludePath = false, resource $context = null)

Since: 5.1.2

Gets an SplFileObject object for the file

Parameters

string $mode

[optional]

The mode for opening the file. See the fopen documentation for descriptions of possible modes. The default is read only.

bool $useIncludePath

[optional]

resource $context

[optional]

Return Value

SplFileObject

The opened file as an SplFileObject object.

Exceptions

RuntimeException

in SplFileInfo at line 295
void setFileClass(T> $class = SplFileObject::class)

Since: 5.1.2

Sets the class name used with SplFileInfo::openFile

Parameters

T> $class

[optional]

The class name to use when openFile() is called.

Return Value

void

in SplFileInfo at line 308
void setInfoClass(T> $class = SplFileInfo::class)

Since: 5.1.2

Sets the class used with getFileInfo and getPathInfo

Parameters

T> $class

[optional]

The class name to use.

Return Value

void

in SplFileInfo at line 317
string __toString()

Since: 5.1.2

Returns the path to the file as a string

Return Value

string

Returns string representation of the object that implements this interface (and/or "__toString" magic method).

in SplFileInfo at line 320
final void _bad_state_ex()

No description

Return Value

void

in SplFileInfo at line 323
__wakeup()

No description

in SplFileInfo at line 329
array __debugInfo()

Since: 7.4

No description

Return Value

array

at line 355
bool isDot()

Determine if current DirectoryIterator item is '.' or '..'

Return Value

bool

true if the entry is . or .., otherwise false

at line 363
void rewind()

Rewind the DirectoryIterator back to the start

Return Value

void

Any returned value is ignored.

at line 371
bool valid()

Check whether current DirectoryIterator position is a valid file

Return Value

bool

The return value will be casted to boolean and then evaluated. Returns true on success or false on failure.

at line 379
mixed key()

Return the key for the current DirectoryIterator item

Return Value

mixed

TKey on success, or null on failure.

at line 387
mixed current()

Return the current DirectoryIterator item.

Return Value

mixed

Can return any type.

at line 395
void next()

Move forward to next DirectoryIterator item

Return Value

void

Any returned value is ignored.

at line 406
void seek(int $offset)

Seek to a DirectoryIterator item

Parameters

int $offset

The position to seek to.

Return Value

void