<!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>Returns the index of the entry in the archive</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ziparchive.getstream.html">ZipArchive::getStream</a></div>
<div class="next" style="text-align: right; float: right;"><a href="ziparchive.open.html">ZipArchive::open</a></div>
<div class="up"><a href="class.ziparchive.html">ZipArchive</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="ziparchive.locatename" class="refentry">
<div class="refnamediv">
<h1 class="refname">ZipArchive::locateName</h1>
<p class="verinfo">(PHP 5 >= 5.2.0, PECL zip >= 1.5.0)</p><p class="refpurpose"><span class="refname">ZipArchive::locateName</span> — <span class="dc-title">Returns the index of the entry in the archive</span></p>
</div>
<div class="refsect1 description" id="refsect1-ziparchive.locatename-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>ZipArchive::locateName</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$flags</code></span>
] )</div>
<p class="para rdfs-comment">
Locates an entry using its name.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-ziparchive.locatename-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">name</code></em></span>
<dd>
<p class="para">
The name of the entry to look up
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">flags</code></em></span>
<dd>
<p class="para">
The flags are specified by ORing the following values,
or 0 for none of them.
<ul class="itemizedlist">
<li class="listitem">
<p class="para">
<strong><code>ZipArchive::FL_NOCASE</code></strong>
</p>
</li>
<li class="listitem">
<p class="para">
<strong><code>ZipArchive::FL_NODIR</code></strong>
</p>
</li>
</ul>
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-ziparchive.locatename-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the index of the entry on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-ziparchive.locatename-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-800">
<p><strong>Example #1 Create an archive and then use it with <span class="function"><strong>ZipArchive::locateName()</strong></span></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">'testlocate.zip'</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$zip </span><span style="color: #007700">= new </span><span style="color: #0000BB">ZipArchive</span><span style="color: #007700">;<br />if (</span><span style="color: #0000BB">$zip</span><span style="color: #007700">-></span><span style="color: #0000BB">open</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">, </span><span style="color: #0000BB">ZipArchive</span><span style="color: #007700">::</span><span style="color: #0000BB">CREATE</span><span style="color: #007700">) !== </span><span style="color: #0000BB">TRUE</span><span style="color: #007700">) {<br /> exit(</span><span style="color: #DD0000">'failed'</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #0000BB">$zip</span><span style="color: #007700">-></span><span style="color: #0000BB">addFromString</span><span style="color: #007700">(</span><span style="color: #DD0000">'entry1.txt'</span><span style="color: #007700">, </span><span style="color: #DD0000">'entry #1'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$zip</span><span style="color: #007700">-></span><span style="color: #0000BB">addFromString</span><span style="color: #007700">(</span><span style="color: #DD0000">'entry2.txt'</span><span style="color: #007700">, </span><span style="color: #DD0000">'entry #2'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$zip</span><span style="color: #007700">-></span><span style="color: #0000BB">addFromString</span><span style="color: #007700">(</span><span style="color: #DD0000">'dir/entry2d.txt'</span><span style="color: #007700">, </span><span style="color: #DD0000">'entry #2'</span><span style="color: #007700">);<br /><br />if (!</span><span style="color: #0000BB">$zip</span><span style="color: #007700">-></span><span style="color: #0000BB">status </span><span style="color: #007700">== </span><span style="color: #0000BB">ZipArchive</span><span style="color: #007700">::</span><span style="color: #0000BB">ER_OK</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"failed to write zip\n"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">$zip</span><span style="color: #007700">-></span><span style="color: #0000BB">close</span><span style="color: #007700">();<br /><br />if (</span><span style="color: #0000BB">$zip</span><span style="color: #007700">-></span><span style="color: #0000BB">open</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">) !== </span><span style="color: #0000BB">TRUE</span><span style="color: #007700">) {<br /> exit(</span><span style="color: #DD0000">'failed'</span><span style="color: #007700">);<br />}<br /><br />echo </span><span style="color: #0000BB">$zip</span><span style="color: #007700">-></span><span style="color: #0000BB">locateName</span><span style="color: #007700">(</span><span style="color: #DD0000">'entry1.txt'</span><span style="color: #007700">) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #0000BB">$zip</span><span style="color: #007700">-></span><span style="color: #0000BB">locateName</span><span style="color: #007700">(</span><span style="color: #DD0000">'eNtry2.txt'</span><span style="color: #007700">) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #0000BB">$zip</span><span style="color: #007700">-></span><span style="color: #0000BB">locateName</span><span style="color: #007700">(</span><span style="color: #DD0000">'eNtry2.txt'</span><span style="color: #007700">, </span><span style="color: #0000BB">ZipArchive</span><span style="color: #007700">::</span><span style="color: #0000BB">FL_NOCASE</span><span style="color: #007700">) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #0000BB">$zip</span><span style="color: #007700">-></span><span style="color: #0000BB">locateName</span><span style="color: #007700">(</span><span style="color: #DD0000">'enTRy2d.txt'</span><span style="color: #007700">, </span><span style="color: #0000BB">ZipArchive</span><span style="color: #007700">::</span><span style="color: #0000BB">FL_NOCASE</span><span style="color: #007700">|</span><span style="color: #0000BB">ZipArchive</span><span style="color: #007700">::</span><span style="color: #0000BB">FL_NODIR</span><span style="color: #007700">) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$zip</span><span style="color: #007700">-></span><span style="color: #0000BB">close</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
<p class="para">The above example will output:</p>
<div class="example-contents screen">
<div class="cdata"><pre>
0
1
2
</pre></div>
</div>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ziparchive.getstream.html">ZipArchive::getStream</a></div>
<div class="next" style="text-align: right; float: right;"><a href="ziparchive.open.html">ZipArchive::open</a></div>
<div class="up"><a href="class.ziparchive.html">ZipArchive</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
