<!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 name of the entry</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="rarentry.getmethod.html">RarEntry::getMethod</a></div>
<div class="next" style="text-align: right; float: right;"><a href="rarentry.getpackedsize.html">RarEntry::getPackedSize</a></div>
<div class="up"><a href="class.rarentry.html">RarEntry</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="rarentry.getname" class="refentry">
<div class="refnamediv">
<h1 class="refname">RarEntry::getName</h1>
<p class="verinfo">(PECL rar >= 0.1)</p><p class="refpurpose"><span class="refname">RarEntry::getName</span> — <span class="dc-title">Get name of the entry</span></p>
</div>
<div class="refsect1 description" id="refsect1-rarentry.getname-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><strong>RarEntry::getName</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
Returns the name (with path) of the archive entry.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-rarentry.getname-parameters">
<h3 class="title">Parameters</h3>
<p class="para">This function has no parameters.</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-rarentry.getname-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the entry name as a string, or <strong><code>FALSE</code></strong> on error.
</p>
</div>
<div class="refsect1 changelog" id="refsect1-rarentry.getname-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>2.0.0</td>
<td>
As of version 2.0.0, the returned string is encoded in Unicode/UTF-8.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-rarentry.getname-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-769">
<p><strong>Example #1 <span class="methodname"><strong>RarEntry::getName()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #FF8000">//this example is safe even in pages not encoded in UTF-8<br />//for those encoded in UTF-8, the call to mb_convert_encoding is unnecessary<br /><br /></span><span style="color: #0000BB">$rar_file </span><span style="color: #007700">= </span><span style="color: #0000BB">rar_open</span><span style="color: #007700">(</span><span style="color: #DD0000">'example.rar'</span><span style="color: #007700">) or die(</span><span style="color: #DD0000">"Failed to open Rar archive"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$entry </span><span style="color: #007700">= </span><span style="color: #0000BB">rar_entry_get</span><span style="color: #007700">(</span><span style="color: #0000BB">$rar_file</span><span style="color: #007700">, </span><span style="color: #DD0000">'Dir/file.txt'</span><span style="color: #007700">) or die(</span><span style="color: #DD0000">"Failed to find such entry"</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #DD0000">"Entry name: " </span><span style="color: #007700">. </span><span style="color: #0000BB">mb_convert_encoding</span><span style="color: #007700">(<br /> </span><span style="color: #0000BB">htmlentities</span><span style="color: #007700">(<br /> </span><span style="color: #0000BB">$entry</span><span style="color: #007700">-></span><span style="color: #0000BB">getName</span><span style="color: #007700">(),<br /> </span><span style="color: #0000BB">ENT_COMPAT</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">"UTF-8"<br /> </span><span style="color: #007700">),<br /> </span><span style="color: #DD0000">"HTML-ENTITIES"</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">"UTF-8"<br /></span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="rarentry.getmethod.html">RarEntry::getMethod</a></div>
<div class="next" style="text-align: right; float: right;"><a href="rarentry.getpackedsize.html">RarEntry::getPackedSize</a></div>
<div class="up"><a href="class.rarentry.html">RarEntry</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
