DirectoryIterator Class Reference

Inheritance diagram for DirectoryIterator:

Collaboration diagram for DirectoryIterator:

Public Member Functions
	__construct ($path)
	__toString ()
	current ()
	getATime ()
	getCTime ()
	getFileInfo (string class_name=NULL)
	getFilename ()
	getGroup ()
	getInode ()
	getLinkTarget ()
	getMTime ()
	getOwner ()
	getPath ()
	getPathInfo (string class_name=NULL)
	getPathname ()
	getPerms ()
	getRealPath ()
	getSize ()
	getType ()
	isDir ()
	isDot ()
	isExecutable ()
	isFile ()
	isLink ()
	isReadable ()
	isWritable ()
	key ()
	next ()
	openFile ($mode= 'r', $use_include_path=false, $context=NULL)
	rewind ()
	setFileClass (string class_name="SplFileObject")
	setInfoClass (string class_name="SplFileInfo")
	valid ()

Detailed Description

Directory iterator.

Version

1.1

Since

PHP 5.0

Definition at line 991 of file spl.php.

Constructor & Destructor Documentation

DirectoryIterator::__construct

(

$path

)

Construct a directory iterator from a path-string.

Parameters

$path

directory to iterate.

Definition at line 997 of file spl.php.

{}

Member Function Documentation

DirectoryIterator::__toString

(

)

Returns

getFilename()

Definition at line 1026 of file spl.php.

{}

DirectoryIterator::current

(

)

Returns

$this

Implements Iterator.

Definition at line 1011 of file spl.php.

{}

SplFileInfo::getATime ( )

inherited

Returns

The current entry's last access time.

Definition at line 910 of file spl.php.

{}

SplFileInfo::getCTime ( )

inherited

Returns

The current entry's last change time.

Definition at line 918 of file spl.php.

{}

SplFileInfo::getFileInfo ( string  class_name = NULL )

inherited

Returns

SplFileInfo created for the file

Parameters

class_name

name of class to instantiate

See Also

SplFileInfo::setInfoClass()

Definition at line 876 of file spl.php.

{}

SplFileInfo::getFilename ( )

inherited

Returns

the filename only.

Definition at line 870 of file spl.php.

{}

SplFileInfo::getGroup ( )

inherited

Returns

The current entry's group name.

Definition at line 906 of file spl.php.

{}

SplFileInfo::getInode ( )

inherited

Returns

The current entry's inode.

Definition at line 894 of file spl.php.

{}

SplFileInfo::getLinkTarget ( )

inherited

Returns

target of link.

Definition at line 950 of file spl.php.

{}

SplFileInfo::getMTime ( )

inherited

Returns

The current entry's last modification time.

Definition at line 914 of file spl.php.

{}

SplFileInfo::getOwner ( )

inherited

Returns

The current entry's owner name.

Definition at line 902 of file spl.php.

{}

SplFileInfo::getPath ( )

inherited

Returns

the path part only.

Definition at line 866 of file spl.php.

{}

SplFileInfo::getPathInfo ( string  class_name = NULL )

inherited

Returns

SplFileInfo created for the path

Parameters

class_name

name of class to instantiate

See Also

SplFileInfo::setInfoClass()

Definition at line 886 of file spl.php.

{}

SplFileInfo::getPathname ( )

inherited

Returns

The current entries path and file name.

Definition at line 880 of file spl.php.

{}

SplFileInfo::getPerms ( )

inherited

Returns

The current entry's permissions.

Definition at line 890 of file spl.php.

{}

SplFileInfo::getRealPath ( )

inherited

Returns

The resolved path

Definition at line 954 of file spl.php.

{}

SplFileInfo::getSize ( )

inherited

Returns

The current entry's size in bytes .

Definition at line 898 of file spl.php.

{}

SplFileInfo::getType ( )

inherited

Returns

The current entry's file type.

Definition at line 922 of file spl.php.

{}

SplFileInfo::isDir ( )

inherited

Returns

Whether the current entry is a directory.

Definition at line 942 of file spl.php.

{}

DirectoryIterator::isDot

(

)

Returns

Whether the current entry is either '.' or '..'.

Definition at line 1018 of file spl.php.

{}

SplFileInfo::isExecutable ( )

inherited

Returns

Whether the current entry is executable.

Definition at line 934 of file spl.php.

{}

SplFileInfo::isFile ( )

inherited

Returns

Whether the current entry is .

Definition at line 938 of file spl.php.

{}

DirectoryIterator::isLink

(

)

Returns

whether the current entry is a link.

Definition at line 1022 of file spl.php.

{}

SplFileInfo::isReadable ( )

inherited

Returns

Whether the current entry is readable.

Definition at line 930 of file spl.php.

{}

SplFileInfo::isWritable ( )

inherited

Returns

Whether the current entry is writeable.

Definition at line 926 of file spl.php.

{}

DirectoryIterator::key

(

)

Returns

index of entry

Implements Iterator.

Definition at line 1007 of file spl.php.

{}

DirectoryIterator::next

(

)

Move forward to next element.

Implements Iterator.

Definition at line 1014 of file spl.php.

{}

SplFileInfo::openFile (   $mode = 'r',   $use_include_path = false,   $context = NULL  )

inherited

Open the current file as a SplFileObject instance.

Parameters

mode	open mode
use_include_path	whether to search include paths (don't use)
context	resource context to pased to open function

Exceptions

RuntimeException

if file cannot be opened (e.g. insufficient access rights).

Returns

The opened file as a SplFileObject instance

See Also

SplFileObject

SplFileInfo::setFileClass()

file()

Definition at line 973 of file spl.php.

{}

DirectoryIterator::rewind

(

)

Rewind the Iterator to the first element.

Implements Iterator.

Definition at line 1000 of file spl.php.

{}

SplFileInfo::setFileClass ( string  class_name = "SplFileObject" )

inherited

Parameters

class_name

name of class used with openFile(). Must be derived from SPLFileObject.

Definition at line 978 of file spl.php.

{}

SplFileInfo::setInfoClass ( string  class_name = "SplFileInfo" )

inherited

Parameters

class_name

name of class used with getFileInfo(), getPathInfo(). Must be derived from SplFileInfo.

Definition at line 983 of file spl.php.

{}

DirectoryIterator::valid

(

)

Check if there is a current element after calls to rewind() or next().

Implements Iterator.

Definition at line 1003 of file spl.php.

{}

---

The documentation for this class was generated from the following file:

• spl.php