<!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>Gets file permissions</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.fileowner.html">fileowner</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.filesize.html">filesize</a></div>
<div class="up"><a href="ref.filesystem.html">Filesystem Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.fileperms" class="refentry">
<div class="refnamediv">
<h1 class="refname">fileperms</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">fileperms</span> — <span class="dc-title">Gets file permissions</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.fileperms-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>fileperms</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$filename</code></span>
)</div>
<p class="para rdfs-comment">
Gets permissions for the given file.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.fileperms-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">filename</code></em></span>
<dd>
<p class="para">
Path to the file.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.fileperms-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the file's permissions as a numeric mode. Lower bits of this mode
are the same as the permissions expected by <span class="function"><a href="function.chmod.html" class="function">chmod()</a></span>,
however on most platforms the return value will also include information on
the type of file given as <em><code class="parameter">filename</code></em>. The examples
below demonstrate how to test the return value for specific permissions and
file types on POSIX systems, including Linux and Mac OS X.
</p>
<p class="para">
For local files, the specific return value is that of the
<em>st_mode</em> member of the structure returned by the C
library's <span class="function"><a href="function.stat.html" class="function">stat()</a></span> function. Exactly which bits are set
can vary from platform to platform, and looking up your specific platform's
documentation is recommended if parsing the non-permission bits of the
return value is required.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.fileperms-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2378">
<p><strong>Example #1 Display permissions as an octal value</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">substr</span><span style="color: #007700">(</span><span style="color: #0000BB">sprintf</span><span style="color: #007700">(</span><span style="color: #DD0000">'%o'</span><span style="color: #007700">, </span><span style="color: #0000BB">fileperms</span><span style="color: #007700">(</span><span style="color: #DD0000">'/tmp'</span><span style="color: #007700">)), -</span><span style="color: #0000BB">4</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">substr</span><span style="color: #007700">(</span><span style="color: #0000BB">sprintf</span><span style="color: #007700">(</span><span style="color: #DD0000">'%o'</span><span style="color: #007700">, </span><span style="color: #0000BB">fileperms</span><span style="color: #007700">(</span><span style="color: #DD0000">'/etc/passwd'</span><span style="color: #007700">)), -</span><span style="color: #0000BB">4</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
1777
0644
</pre></div>
</div>
</div>
<div class="example" id="example-2379">
<p><strong>Example #2 Display full permissions</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$perms </span><span style="color: #007700">= </span><span style="color: #0000BB">fileperms</span><span style="color: #007700">(</span><span style="color: #DD0000">'/etc/passwd'</span><span style="color: #007700">);<br /><br />if ((</span><span style="color: #0000BB">$perms </span><span style="color: #007700">& </span><span style="color: #0000BB">0xC000</span><span style="color: #007700">) == </span><span style="color: #0000BB">0xC000</span><span style="color: #007700">) {<br /> </span><span style="color: #FF8000">// Socket<br /> </span><span style="color: #0000BB">$info </span><span style="color: #007700">= </span><span style="color: #DD0000">'s'</span><span style="color: #007700">;<br />} elseif ((</span><span style="color: #0000BB">$perms </span><span style="color: #007700">& </span><span style="color: #0000BB">0xA000</span><span style="color: #007700">) == </span><span style="color: #0000BB">0xA000</span><span style="color: #007700">) {<br /> </span><span style="color: #FF8000">// Symbolic Link<br /> </span><span style="color: #0000BB">$info </span><span style="color: #007700">= </span><span style="color: #DD0000">'l'</span><span style="color: #007700">;<br />} elseif ((</span><span style="color: #0000BB">$perms </span><span style="color: #007700">& </span><span style="color: #0000BB">0x8000</span><span style="color: #007700">) == </span><span style="color: #0000BB">0x8000</span><span style="color: #007700">) {<br /> </span><span style="color: #FF8000">// Regular<br /> </span><span style="color: #0000BB">$info </span><span style="color: #007700">= </span><span style="color: #DD0000">'-'</span><span style="color: #007700">;<br />} elseif ((</span><span style="color: #0000BB">$perms </span><span style="color: #007700">& </span><span style="color: #0000BB">0x6000</span><span style="color: #007700">) == </span><span style="color: #0000BB">0x6000</span><span style="color: #007700">) {<br /> </span><span style="color: #FF8000">// Block special<br /> </span><span style="color: #0000BB">$info </span><span style="color: #007700">= </span><span style="color: #DD0000">'b'</span><span style="color: #007700">;<br />} elseif ((</span><span style="color: #0000BB">$perms </span><span style="color: #007700">& </span><span style="color: #0000BB">0x4000</span><span style="color: #007700">) == </span><span style="color: #0000BB">0x4000</span><span style="color: #007700">) {<br /> </span><span style="color: #FF8000">// Directory<br /> </span><span style="color: #0000BB">$info </span><span style="color: #007700">= </span><span style="color: #DD0000">'d'</span><span style="color: #007700">;<br />} elseif ((</span><span style="color: #0000BB">$perms </span><span style="color: #007700">& </span><span style="color: #0000BB">0x2000</span><span style="color: #007700">) == </span><span style="color: #0000BB">0x2000</span><span style="color: #007700">) {<br /> </span><span style="color: #FF8000">// Character special<br /> </span><span style="color: #0000BB">$info </span><span style="color: #007700">= </span><span style="color: #DD0000">'c'</span><span style="color: #007700">;<br />} elseif ((</span><span style="color: #0000BB">$perms </span><span style="color: #007700">& </span><span style="color: #0000BB">0x1000</span><span style="color: #007700">) == </span><span style="color: #0000BB">0x1000</span><span style="color: #007700">) {<br /> </span><span style="color: #FF8000">// FIFO pipe<br /> </span><span style="color: #0000BB">$info </span><span style="color: #007700">= </span><span style="color: #DD0000">'p'</span><span style="color: #007700">;<br />} else {<br /> </span><span style="color: #FF8000">// Unknown<br /> </span><span style="color: #0000BB">$info </span><span style="color: #007700">= </span><span style="color: #DD0000">'u'</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #FF8000">// Owner<br /></span><span style="color: #0000BB">$info </span><span style="color: #007700">.= ((</span><span style="color: #0000BB">$perms </span><span style="color: #007700">& </span><span style="color: #0000BB">0x0100</span><span style="color: #007700">) ? </span><span style="color: #DD0000">'r' </span><span style="color: #007700">: </span><span style="color: #DD0000">'-'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$info </span><span style="color: #007700">.= ((</span><span style="color: #0000BB">$perms </span><span style="color: #007700">& </span><span style="color: #0000BB">0x0080</span><span style="color: #007700">) ? </span><span style="color: #DD0000">'w' </span><span style="color: #007700">: </span><span style="color: #DD0000">'-'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$info </span><span style="color: #007700">.= ((</span><span style="color: #0000BB">$perms </span><span style="color: #007700">& </span><span style="color: #0000BB">0x0040</span><span style="color: #007700">) ?<br /> ((</span><span style="color: #0000BB">$perms </span><span style="color: #007700">& </span><span style="color: #0000BB">0x0800</span><span style="color: #007700">) ? </span><span style="color: #DD0000">'s' </span><span style="color: #007700">: </span><span style="color: #DD0000">'x' </span><span style="color: #007700">) :<br /> ((</span><span style="color: #0000BB">$perms </span><span style="color: #007700">& </span><span style="color: #0000BB">0x0800</span><span style="color: #007700">) ? </span><span style="color: #DD0000">'S' </span><span style="color: #007700">: </span><span style="color: #DD0000">'-'</span><span style="color: #007700">));<br /><br /></span><span style="color: #FF8000">// Group<br /></span><span style="color: #0000BB">$info </span><span style="color: #007700">.= ((</span><span style="color: #0000BB">$perms </span><span style="color: #007700">& </span><span style="color: #0000BB">0x0020</span><span style="color: #007700">) ? </span><span style="color: #DD0000">'r' </span><span style="color: #007700">: </span><span style="color: #DD0000">'-'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$info </span><span style="color: #007700">.= ((</span><span style="color: #0000BB">$perms </span><span style="color: #007700">& </span><span style="color: #0000BB">0x0010</span><span style="color: #007700">) ? </span><span style="color: #DD0000">'w' </span><span style="color: #007700">: </span><span style="color: #DD0000">'-'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$info </span><span style="color: #007700">.= ((</span><span style="color: #0000BB">$perms </span><span style="color: #007700">& </span><span style="color: #0000BB">0x0008</span><span style="color: #007700">) ?<br /> ((</span><span style="color: #0000BB">$perms </span><span style="color: #007700">& </span><span style="color: #0000BB">0x0400</span><span style="color: #007700">) ? </span><span style="color: #DD0000">'s' </span><span style="color: #007700">: </span><span style="color: #DD0000">'x' </span><span style="color: #007700">) :<br /> ((</span><span style="color: #0000BB">$perms </span><span style="color: #007700">& </span><span style="color: #0000BB">0x0400</span><span style="color: #007700">) ? </span><span style="color: #DD0000">'S' </span><span style="color: #007700">: </span><span style="color: #DD0000">'-'</span><span style="color: #007700">));<br /><br /></span><span style="color: #FF8000">// World<br /></span><span style="color: #0000BB">$info </span><span style="color: #007700">.= ((</span><span style="color: #0000BB">$perms </span><span style="color: #007700">& </span><span style="color: #0000BB">0x0004</span><span style="color: #007700">) ? </span><span style="color: #DD0000">'r' </span><span style="color: #007700">: </span><span style="color: #DD0000">'-'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$info </span><span style="color: #007700">.= ((</span><span style="color: #0000BB">$perms </span><span style="color: #007700">& </span><span style="color: #0000BB">0x0002</span><span style="color: #007700">) ? </span><span style="color: #DD0000">'w' </span><span style="color: #007700">: </span><span style="color: #DD0000">'-'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$info </span><span style="color: #007700">.= ((</span><span style="color: #0000BB">$perms </span><span style="color: #007700">& </span><span style="color: #0000BB">0x0001</span><span style="color: #007700">) ?<br /> ((</span><span style="color: #0000BB">$perms </span><span style="color: #007700">& </span><span style="color: #0000BB">0x0200</span><span style="color: #007700">) ? </span><span style="color: #DD0000">'t' </span><span style="color: #007700">: </span><span style="color: #DD0000">'x' </span><span style="color: #007700">) :<br /> ((</span><span style="color: #0000BB">$perms </span><span style="color: #007700">& </span><span style="color: #0000BB">0x0200</span><span style="color: #007700">) ? </span><span style="color: #DD0000">'T' </span><span style="color: #007700">: </span><span style="color: #DD0000">'-'</span><span style="color: #007700">));<br /><br />echo </span><span style="color: #0000BB">$info</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
-rw-r--r--
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 errors" id="refsect1-function.fileperms-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Upon failure, an <strong><code>E_WARNING</code></strong> is emitted.
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.fileperms-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara">The results of this
function are cached. See <span class="function"><a href="function.clearstatcache.html" class="function">clearstatcache()</a></span> for
more details.</span></p></blockquote>
<div class="tip"><strong class="tip">Tip</strong><p class="simpara">As of PHP 5.0.0, this function
can also be used with <em class="emphasis">some</em> URL wrappers. Refer to
<a href="wrappers.html" class="xref">Supported Protocols and Wrappers</a> to determine which wrappers support
<span class="function"><a href="function.stat.html" class="function">stat()</a></span> family of functionality.</p></div>
</div>
<div class="refsect1 seealso" id="refsect1-function.fileperms-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.chmod.html" class="function" rel="rdfs-seeAlso">chmod()</a> - Changes file mode</span></li>
<li class="member"> <span class="function"><a href="function.is-readable.html" class="function" rel="rdfs-seeAlso">is_readable()</a> - Tells whether a file exists and is readable</span></li>
<li class="member"> <span class="function"><a href="function.stat.html" class="function" rel="rdfs-seeAlso">stat()</a> - Gives information about a file</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.fileowner.html">fileowner</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.filesize.html">filesize</a></div>
<div class="up"><a href="ref.filesystem.html">Filesystem Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
