<!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>Check if filesystem supports extended attributes</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.xattr-set.html">xattr_set</a></div>
<div class="next" style="text-align: right; float: right;"><a href="book.xdiff.html">xdiff</a></div>
<div class="up"><a href="ref.xattr.html">xattr Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.xattr-supported" class="refentry">
<div class="refnamediv">
<h1 class="refname">xattr_supported</h1>
<p class="verinfo">(PECL xattr >= 1.0.0)</p><p class="refpurpose"><span class="refname">xattr_supported</span> — <span class="dc-title">
Check if filesystem supports extended attributes
</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.xattr-supported-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>xattr_supported</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$filename</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$flags</code><span class="initializer"> = 0</span></span>
] )</div>
<p class="para rdfs-comment">
This functions checks if the filesystem holding the given file supports
extended attributes. Read access to the file is required.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.xattr-supported-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">
The path of the tested file.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">flags</code></em></span>
<dd>
<p class="para">
<table class="doctable table">
<caption><strong>Supported xattr flags</strong></caption>
<tbody class="tbody">
<tr>
<td><strong><code>XATTR_DONTFOLLOW</code></strong></td>
<td>Do not follow the symbolic link but operate on symbolic link itself.</td>
</tr>
</tbody>
</table>
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.xattr-supported-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
This function returns <strong><code>TRUE</code></strong> if filesystem supports extended attributes,
<strong><code>FALSE</code></strong> if it doesn't and <strong><code>NULL</code></strong> if it can't be determined (for example
wrong path or lack of permissions to file).
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.xattr-supported-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2448">
<p><strong>Example #1 <span class="function"><strong>xattr_supported()</strong></span> example</strong></p>
<div class="example-contents"><p>
The following code checks if we can use extended attributes.
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$file </span><span style="color: #007700">= </span><span style="color: #DD0000">'some_file'</span><span style="color: #007700">;<br /><br />if (</span><span style="color: #0000BB">xattr_supported</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">)) {<br /> </span><span style="color: #FF8000">/* ... make use of some xattr_* functions ... */<br /></span><span style="color: #007700">}<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.xattr-supported-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.xattr-get.html" class="function" rel="rdfs-seeAlso">xattr_get()</a> - Get an extended attribute</span></li>
<li class="member"> <span class="function"><a href="function.xattr-list.html" class="function" rel="rdfs-seeAlso">xattr_list()</a> - Get a list of extended attributes</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.xattr-set.html">xattr_set</a></div>
<div class="next" style="text-align: right; float: right;"><a href="book.xdiff.html">xdiff</a></div>
<div class="up"><a href="ref.xattr.html">xattr Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
