SplFileInfo Class Reference
[Internal classes]

File info class. More...

Inheritance diagram for SplFileInfo:

Inheritance graph
{DirectoryIterator\n||+ __construct()\l+ __toString()\l+ current()\l+ isDot()\l+ isLink()\l+ key()\l+ next()\l+ rewind()\l+ valid()\l}{SplFileObject\n|+ DROP_NEW_LINE\l- $delimiter\l- $enclosure\l- $flags\l- $fname\l- $fp\l- $line\l- $lnum\l- $max_len\l|+ __construct()\l+ __toString()\l+ current()\l+ eof()\l+ fflush()\l+ fgetc()\l+ fgetcsv()\l+ fgets()\l+ fgetss()\l+ flock()\l+ fpassthru()\l+ fscanf()\l+ fseek()\l+ fstat()\l+ ftell()\l+ ftruncate()\l+ fwrite()\l+ getChildren()\l+ getCsvControl()\l+ getCurrentLine()\l+ getFlags()\l+ getMaxLineLen()\l+ hasChildren()\l+ key()\l+ next()\l+ rewind()\l+ seek()\l+ setCsvControl()\l+ setFlags()\l+ setMaxLineLen()\l+ valid()\l- freeLine()\l- readLine()\l}{RecursiveDirectoryIterator\n|+ x00000010\l+ x00000020\l+ x00000030\l|+ __construct()\l+ current()\l+ getChildren()\l+ getSubPath()\l+ getSubPathname()\l+ hasChildren()\l+ key()\l}
[legend]
List of all members.

Public Member Functions

 __construct ($file_name)
 __toString ()
 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 ()
 isExecutable ()
 isFile ()
 isLink ()
 isReadable ()
 isWritable ()
 openFile ($mode= 'r', $use_include_path=false, $context=NULL)
 setFileClass (string class_name="SplFileObject")
 setInfoClass (string class_name="SplFileInfo")

Detailed Description

File info class.

Since:
PHP 5.1.3

Definition at line 842 of file spl.php.


Constructor & Destructor Documentation

SplFileInfo::__construct ( file_name  ) 

Construct a file info object.

Parameters:
$file_name path or file name

Reimplemented in DirectoryIterator.

Definition at line 848 of file spl.php.

00848 {}


Member Function Documentation

SplFileInfo::__toString (  ) 

Returns:
getPathname()

Reimplemented in DirectoryIterator, and SplFileObject.

Definition at line 944 of file spl.php.

00944 {}

SplFileInfo::getATime (  ) 

Returns:
The current entry's last access time.

Definition at line 896 of file spl.php.

00896 {}

SplFileInfo::getCTime (  ) 

Returns:
The current entry's last change time.

Definition at line 904 of file spl.php.

00904 {}

SplFileInfo::getFileInfo ( string  class_name = NULL  ) 

Returns:
SplFileInfo created for the file

Parameters:
class_name name of class to instantiate
See also:
SplFileInfo::setInfoClass()

Definition at line 862 of file spl.php.

00862 {}

SplFileInfo::getFilename (  ) 

Returns:
the filename only.

Definition at line 856 of file spl.php.

00856 {}  

SplFileInfo::getGroup (  ) 

Returns:
The current entry's group name.

Definition at line 892 of file spl.php.

00892 {}

SplFileInfo::getInode (  ) 

Returns:
The current entry's inode.

Definition at line 880 of file spl.php.

00880 {}

SplFileInfo::getLinkTarget (  ) 

Returns:
target of link.

Definition at line 936 of file spl.php.

00936 {}

SplFileInfo::getMTime (  ) 

Returns:
The current entry's last modification time.

Definition at line 900 of file spl.php.

00900 {}

SplFileInfo::getOwner (  ) 

Returns:
The current entry's owner name.

Definition at line 888 of file spl.php.

00888 {}

SplFileInfo::getPath (  ) 

Returns:
the path part only.

Definition at line 852 of file spl.php.

00852 {}  

SplFileInfo::getPathInfo ( string  class_name = NULL  ) 

Returns:
SplFileInfo created for the path

Parameters:
class_name name of class to instantiate
See also:
SplFileInfo::setInfoClass()

Definition at line 872 of file spl.php.

00872 {}

SplFileInfo::getPathname (  ) 

Returns:
The current entries path and file name.

Definition at line 866 of file spl.php.

00866 {}  

SplFileInfo::getPerms (  ) 

Returns:
The current entry's permissions.

Definition at line 876 of file spl.php.

00876 {}

SplFileInfo::getRealPath (  ) 

Returns:
The resolved path

Definition at line 940 of file spl.php.

00940 {}

SplFileInfo::getSize (  ) 

Returns:
The current entry's size in bytes .

Definition at line 884 of file spl.php.

00884 {}

SplFileInfo::getType (  ) 

Returns:
The current entry's file type.

Definition at line 908 of file spl.php.

00908 {}

SplFileInfo::isDir (  ) 

Returns:
Whether the current entry is a directory.

Definition at line 928 of file spl.php.

00928 {}  

SplFileInfo::isExecutable (  ) 

Returns:
Whether the current entry is executable.

Definition at line 920 of file spl.php.

00920 {}

SplFileInfo::isFile (  ) 

Returns:
Whether the current entry is .

Definition at line 924 of file spl.php.

00924 {}

SplFileInfo::isLink (  ) 

Returns:
whether the current entry is a link.

Reimplemented in DirectoryIterator.

Definition at line 932 of file spl.php.

00932 {}

SplFileInfo::isReadable (  ) 

Returns:
Whether the current entry is readable.

Definition at line 916 of file spl.php.

00916 {}

SplFileInfo::isWritable (  ) 

Returns:
Whether the current entry is writeable.

Definition at line 912 of file spl.php.

00912 {}

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

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 959 of file spl.php.

00959 {}

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

Parameters:
class_name name of class used with openFile().

Must be derived from SPLFileObject.

Definition at line 964 of file spl.php.

00964 {}

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

Parameters:
class_name name of class used with getFileInfo(), getPathInfo().

Must be derived from SplFileInfo.

Definition at line 969 of file spl.php.

00969 {}


The documentation for this class was generated from the following file:
Generated on Thu Apr 26 01:07:35 2007 for SPL-StandardPHPLibrary by  doxygen 1.5.2