<!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>Get a list of 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-get.html">xattr_get</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.xattr-remove.html">xattr_remove</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-list" class="refentry">
<div class="refnamediv">
<h1 class="refname">xattr_list</h1>
<p class="verinfo">(PECL xattr >= 0.9.0)</p><p class="refpurpose"><span class="refname">xattr_list</span> — <span class="dc-title">
Get a list of extended attributes
</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.xattr-list-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>xattr_list</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 gets a list of names of extended attributes of a file.
</p>
<p class="para">Extended attributes have two different namespaces: user
and root. The user namespace is available to all users, while the root namespace
is available only to users with root privileges. xattr operates on the user
namespace by default, but this can be changed with the
<em><code class="parameter">flags</code></em> parameter.</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.xattr-list-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 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>
<tr>
<td><strong><code>XATTR_ROOT</code></strong></td>
<td>Set attribute in root (trusted) namespace. Requires root privileges.</td>
</tr>
</tbody>
</table>
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.xattr-list-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
This function returns an array with names of extended attributes.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.xattr-list-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2445">
<p><strong>Example #1 Prints names of all extended attributes of file</strong></p>
<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 /></span><span style="color: #0000BB">$root_attributes </span><span style="color: #007700">= </span><span style="color: #0000BB">xattr_list</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">, </span><span style="color: #0000BB">XATTR_ROOT</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$user_attributes </span><span style="color: #007700">= </span><span style="color: #0000BB">xattr_list</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #DD0000">"Root attributes: \n"</span><span style="color: #007700">;<br />foreach (</span><span style="color: #0000BB">$root_attributes </span><span style="color: #007700">as </span><span style="color: #0000BB">$attr_name</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"%s\n"</span><span style="color: #007700">, </span><span style="color: #0000BB">$attr_name</span><span style="color: #007700">);<br />}<br /><br />echo </span><span style="color: #DD0000">"\n User attributes: \n"</span><span style="color: #007700">;<br />foreach (</span><span style="color: #0000BB">$attributes </span><span style="color: #007700">as </span><span style="color: #0000BB">$attr_name</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"%s\n"</span><span style="color: #007700">, </span><span style="color: #0000BB">$attr_name</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.xattr-list-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>
</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-get.html">xattr_get</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.xattr-remove.html">xattr_remove</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>
