<!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>Set the comment of an entry defined by its name</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="ziparchive.setcommentindex.html">ZipArchive::setCommentIndex</a></div> <div class="next" style="text-align: right; float: right;"><a href="ziparchive.statindex.html">ZipArchive::statIndex</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.setcommentname" class="refentry"> <div class="refnamediv"> <h1 class="refname">ZipArchive::setCommentName</h1> <p class="verinfo">(PHP 5 >= 5.2.0, PECL zip >= 1.4.0)</p><p class="refpurpose"><span class="refname">ZipArchive::setCommentName</span> — <span class="dc-title">Set the comment of an entry defined by its name</span></p> </div> <div class="refsect1 description" id="refsect1-ziparchive.setcommentname-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><strong>ZipArchive::setCommentName</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span> , <span class="methodparam"><span class="type">string</span> <code class="parameter">$comment</code></span> )</div> <p class="para rdfs-comment"> Set the comment of an entry defined by its name. </p> </div> <div class="refsect1 parameters" id="refsect1-ziparchive.setcommentname-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"> Name of the entry. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">comment</code></em></span> <dd> <p class="para"> The contents of the comment. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-ziparchive.setcommentname-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure. </p> </div> <div class="refsect1 examples" id="refsect1-ziparchive.setcommentname-examples"> <h3 class="title">Examples</h3> <div class="example" id="example-807"> <p><strong>Example #1 Open an archive and set a comment for an entry</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$zip </span><span style="color: #007700">= new </span><span style="color: #0000BB">ZipArchive</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$res </span><span style="color: #007700">= </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: #DD0000">'test.zip'</span><span style="color: #007700">);<br />if (</span><span style="color: #0000BB">$res </span><span style="color: #007700">=== </span><span style="color: #0000BB">TRUE</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$zip</span><span style="color: #007700">-></span><span style="color: #0000BB">setCommentName</span><span style="color: #007700">(</span><span style="color: #DD0000">'entry1.txt'</span><span style="color: #007700">, </span><span style="color: #DD0000">'new entry comment'</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 /> echo </span><span style="color: #DD0000">'ok'</span><span style="color: #007700">;<br />} else {<br /> echo </span><span style="color: #DD0000">'failed'</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="ziparchive.setcommentindex.html">ZipArchive::setCommentIndex</a></div> <div class="next" style="text-align: right; float: right;"><a href="ziparchive.statindex.html">ZipArchive::statIndex</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>