<!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 full list of entries from the RAR archive</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="rararchive.getcomment.html">RarArchive::getComment</a></div>
<div class="next" style="text-align: right; float: right;"><a href="rararchive.getentry.html">RarArchive::getEntry</a></div>
<div class="up"><a href="class.rararchive.html">RarArchive</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="rararchive.getentries" class="refentry">
<div class="refnamediv">
<h1 class="refname">RarArchive::getEntries</h1>
<h1 class="refname">rar_list</h1>
<p class="verinfo">(PECL rar >= 2.0.0)</p><p class="refpurpose"><span class="refname">RarArchive::getEntries</span> -- <span class="refname">rar_list</span> — <span class="dc-title">Get full list of entries from the RAR archive</span></p>
</div>
<div class="refsect1 description" id="refsect1-rararchive.getentries-description">
<h3 class="title">Description</h3>
<p class="para">Object oriented style (method):</p>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><strong>RarArchive::getEntries</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">Procedural style:</p>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>rar_list</strong></span>
( <span class="methodparam"><span class="type"><a href="class.rararchive.html" class="type RarArchive">RarArchive</a></span> <code class="parameter">$rarfile</code></span>
)</div>
<p class="para rdfs-comment">
Get entries list (files and directories) from the RAR archive.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
If the archive has
entries with the same name, this method, together with <span class="type"><a href="class.rararchive.html" class="type RarArchive">RarArchive</a></span>
<em>foreach</em> iteration and array-like access with numeric indexes,
are the only ones to access all the entries (i.e.,
<span class="methodname"><a href="rararchive.getentry.html" class="methodname">RarArchive::getEntry()</a></span> and the <a href="wrappers.rar.html" class="link">
<em>rar://</em> wrapper</a> are insufficient).
</p>
</p></blockquote>
</div>
<div class="refsect1 parameters" id="refsect1-rararchive.getentries-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">rarfile</code></em></span>
<dd>
<p class="para">
A <span class="type"><a href="class.rararchive.html" class="type RarArchive">RarArchive</a></span> object, opened with <span class="function"><a href="rararchive.open.html" class="function">rar_open()</a></span>.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-rararchive.getentries-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
<span class="function"><strong>rar_list()</strong></span> returns array of <span class="type"><a href="class.rarentry.html" class="type RarEntry">RarEntry</a></span> objects
or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 changelog" id="refsect1-rararchive.getentries-changelog">
<h3 class="title">Changelog</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>3.0.0</td>
<td>
Support for RAR archives with repeated entry names is no longer defective.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-rararchive.getentries-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-749">
<p><strong>Example #1 Object oriented style</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$rar_arch </span><span style="color: #007700">= </span><span style="color: #0000BB">RarArchive</span><span style="color: #007700">::</span><span style="color: #0000BB">open</span><span style="color: #007700">(</span><span style="color: #DD0000">'solid.rar'</span><span style="color: #007700">);<br />if (</span><span style="color: #0000BB">$rar_arch </span><span style="color: #007700">=== </span><span style="color: #0000BB">FALSE</span><span style="color: #007700">)<br /> die(</span><span style="color: #DD0000">"Could not open RAR archive."</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$rar_entries </span><span style="color: #007700">= </span><span style="color: #0000BB">$rar_arch</span><span style="color: #007700">-></span><span style="color: #0000BB">getEntries</span><span style="color: #007700">();<br />if (</span><span style="color: #0000BB">$rar_entries </span><span style="color: #007700">=== </span><span style="color: #0000BB">FALSE</span><span style="color: #007700">)<br /> die(</span><span style="color: #DD0000">"Could retrieve entries."</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #DD0000">"Found " </span><span style="color: #007700">. </span><span style="color: #0000BB">count</span><span style="color: #007700">(</span><span style="color: #0000BB">$rar_entries</span><span style="color: #007700">) . </span><span style="color: #DD0000">" entries.\n"</span><span style="color: #007700">;<br /><br />foreach (</span><span style="color: #0000BB">$rar_entries </span><span style="color: #007700">as </span><span style="color: #0000BB">$e</span><span style="color: #007700">) {<br /> echo </span><span style="color: #0000BB">$e</span><span style="color: #007700">;<br /> echo </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">$rar_arch</span><span style="color: #007700">-></span><span style="color: #0000BB">close</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
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
Found 2 entries.
RarEntry for file "tese.txt" (23b93a7a)
RarEntry for file "unrardll.txt" (2ed64b6e)
</pre></div>
</div>
</div>
</p>
<p class="para">
<div class="example" id="example-750">
<p><strong>Example #2 Procedural style</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$rar_arch </span><span style="color: #007700">= </span><span style="color: #0000BB">rar_open</span><span style="color: #007700">(</span><span style="color: #DD0000">'solid.rar'</span><span style="color: #007700">);<br />if (</span><span style="color: #0000BB">$rar_arch </span><span style="color: #007700">=== </span><span style="color: #0000BB">FALSE</span><span style="color: #007700">)<br /> die(</span><span style="color: #DD0000">"Could not open RAR archive."</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$rar_entries </span><span style="color: #007700">= </span><span style="color: #0000BB">rar_list</span><span style="color: #007700">(</span><span style="color: #0000BB">$rar_arch</span><span style="color: #007700">);<br />if (</span><span style="color: #0000BB">$rar_entries </span><span style="color: #007700">=== </span><span style="color: #0000BB">FALSE</span><span style="color: #007700">)<br /> die(</span><span style="color: #DD0000">"Could retrieve entries."</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #DD0000">"Found " </span><span style="color: #007700">. </span><span style="color: #0000BB">count</span><span style="color: #007700">(</span><span style="color: #0000BB">$rar_entries</span><span style="color: #007700">) . </span><span style="color: #DD0000">" entries.\n"</span><span style="color: #007700">;<br /><br />foreach (</span><span style="color: #0000BB">$rar_entries </span><span style="color: #007700">as </span><span style="color: #0000BB">$e</span><span style="color: #007700">) {<br /> echo </span><span style="color: #0000BB">$e</span><span style="color: #007700">;<br /> echo </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">rar_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$rar_arch</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-rararchive.getentries-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="rararchive.getentry.html" class="methodname" rel="rdfs-seeAlso">RarArchive::getEntry()</a> - Get entry object from the RAR archive</span></li>
<li class="member"><a href="wrappers.rar.html" class="link"><em>rar://</em> wrapper</a></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="rararchive.getcomment.html">RarArchive::getComment</a></div>
<div class="next" style="text-align: right; float: right;"><a href="rararchive.getentry.html">RarArchive::getEntry</a></div>
<div class="up"><a href="class.rararchive.html">RarArchive</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
