<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>The SplFileInfo class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="spl.files.html">File Handling</a></div>
<div class="next" style="text-align: right; float: right;"><a href="splfileinfo.construct.html">SplFileInfo::__construct</a></div>
<div class="up"><a href="spl.files.html">File Handling</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.splfileinfo" class="reference">
<h1 class="title">The SplFileInfo class</h1>
<div class="partintro"><p class="verinfo">(PHP 5 >= 5.1.2)</p>
<div class="section" id="splfileinfo.intro">
<h2 class="title">Introduction</h2>
<p class="para">
The SplFileInfo class offers a high-level object oriented interface to
information for an individual file.
</p>
</div>
<div class="section" id="splfileinfo.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">SplFileInfo</strong>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><a href="splfileinfo.construct.html" class="methodname">__construct</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$file_name</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="splfileinfo.getatime.html" class="methodname">getATime</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="splfileinfo.getbasename.html" class="methodname">getBasename</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$suffix</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="splfileinfo.getctime.html" class="methodname">getCTime</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="splfileinfo.getextension.html" class="methodname">getExtension</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">SplFileInfo</span> <span class="methodname"><a href="splfileinfo.getfileinfo.html" class="methodname">getFileInfo</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$class_name</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="splfileinfo.getfilename.html" class="methodname">getFilename</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="splfileinfo.getgroup.html" class="methodname">getGroup</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="splfileinfo.getinode.html" class="methodname">getInode</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="splfileinfo.getlinktarget.html" class="methodname">getLinkTarget</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="splfileinfo.getmtime.html" class="methodname">getMTime</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="splfileinfo.getowner.html" class="methodname">getOwner</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="splfileinfo.getpath.html" class="methodname">getPath</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">SplFileInfo</span> <span class="methodname"><a href="splfileinfo.getpathinfo.html" class="methodname">getPathInfo</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$class_name</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="splfileinfo.getpathname.html" class="methodname">getPathname</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="splfileinfo.getperms.html" class="methodname">getPerms</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="splfileinfo.getrealpath.html" class="methodname">getRealPath</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="splfileinfo.getsize.html" class="methodname">getSize</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="splfileinfo.gettype.html" class="methodname">getType</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="splfileinfo.isdir.html" class="methodname">isDir</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="splfileinfo.isexecutable.html" class="methodname">isExecutable</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="splfileinfo.isfile.html" class="methodname">isFile</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="splfileinfo.islink.html" class="methodname">isLink</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="splfileinfo.isreadable.html" class="methodname">isReadable</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="splfileinfo.iswritable.html" class="methodname">isWritable</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">SplFileObject</span> <span class="methodname"><a href="splfileinfo.openfile.html" class="methodname">openFile</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$open_mode</code><span class="initializer"> = r</span></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$use_include_path</code><span class="initializer"> = false</span></span>
[, <span class="methodparam"><span class="type">resource</span> <code class="parameter">$context</code><span class="initializer"> = <strong><code>NULL</code></strong></span></span>
]]] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="splfileinfo.setfileclass.html" class="methodname">setFileClass</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$class_name</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="splfileinfo.setinfoclass.html" class="methodname">setInfoClass</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$class_name</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="splfileinfo.tostring.html" class="methodname">__toString</a></span>
( <span class="methodparam">void</span>
)</div>
}</div>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="splfileinfo.construct.html">SplFileInfo::__construct</a> — Construct a new SplFileInfo object</li><li><a href="splfileinfo.getatime.html">SplFileInfo::getATime</a> — Gets last access time of the file</li><li><a href="splfileinfo.getbasename.html">SplFileInfo::getBasename</a> — Gets the base name of the file</li><li><a href="splfileinfo.getctime.html">SplFileInfo::getCTime</a> — Gets the inode change time</li><li><a href="splfileinfo.getextension.html">SplFileInfo::getExtension</a> — Gets the file extension</li><li><a href="splfileinfo.getfileinfo.html">SplFileInfo::getFileInfo</a> — Gets an SplFileInfo object for the file</li><li><a href="splfileinfo.getfilename.html">SplFileInfo::getFilename</a> — Gets the filename</li><li><a href="splfileinfo.getgroup.html">SplFileInfo::getGroup</a> — Gets the file group</li><li><a href="splfileinfo.getinode.html">SplFileInfo::getInode</a> — Gets the inode for the file</li><li><a href="splfileinfo.getlinktarget.html">SplFileInfo::getLinkTarget</a> — Gets the target of a link</li><li><a href="splfileinfo.getmtime.html">SplFileInfo::getMTime</a> — Gets the last modified time</li><li><a href="splfileinfo.getowner.html">SplFileInfo::getOwner</a> — Gets the owner of the file</li><li><a href="splfileinfo.getpath.html">SplFileInfo::getPath</a> — Gets the path without filename</li><li><a href="splfileinfo.getpathinfo.html">SplFileInfo::getPathInfo</a> — Gets an SplFileInfo object for the path</li><li><a href="splfileinfo.getpathname.html">SplFileInfo::getPathname</a> — Gets the path to the file</li><li><a href="splfileinfo.getperms.html">SplFileInfo::getPerms</a> — Gets file permissions</li><li><a href="splfileinfo.getrealpath.html">SplFileInfo::getRealPath</a> — Gets absolute path to file</li><li><a href="splfileinfo.getsize.html">SplFileInfo::getSize</a> — Gets file size</li><li><a href="splfileinfo.gettype.html">SplFileInfo::getType</a> — Gets file type</li><li><a href="splfileinfo.isdir.html">SplFileInfo::isDir</a> — Tells if the file is a directory</li><li><a href="splfileinfo.isexecutable.html">SplFileInfo::isExecutable</a> — Tells if the file is executable</li><li><a href="splfileinfo.isfile.html">SplFileInfo::isFile</a> — Tells if the object references a regular file</li><li><a href="splfileinfo.islink.html">SplFileInfo::isLink</a> — Tells if the file is a link</li><li><a href="splfileinfo.isreadable.html">SplFileInfo::isReadable</a> — Tells if file is readable</li><li><a href="splfileinfo.iswritable.html">SplFileInfo::isWritable</a> — Tells if the entry is writable</li><li><a href="splfileinfo.openfile.html">SplFileInfo::openFile</a> — Gets an SplFileObject object for the file</li><li><a href="splfileinfo.setfileclass.html">SplFileInfo::setFileClass</a> — Sets the class name used with SplFileInfo::openFile</li><li><a href="splfileinfo.setinfoclass.html">SplFileInfo::setInfoClass</a> — Sets the class used with getFileInfo and getPathInfo</li><li><a href="splfileinfo.tostring.html">SplFileInfo::__toString</a> — Returns the path to the file as a string</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="spl.files.html">File Handling</a></div>
<div class="next" style="text-align: right; float: right;"><a href="splfileinfo.construct.html">SplFileInfo::__construct</a></div>
<div class="up"><a href="spl.files.html">File Handling</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
