<!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>Deletes the global metadata of a zip archive</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="phardata.decompressfiles.html">PharData::decompressFiles</a></div> <div class="next" style="text-align: right; float: right;"><a href="phardata.delete.html">PharData::delete</a></div> <div class="up"><a href="class.phardata.html">PharData</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="phardata.delmetadata" class="refentry"> <div class="refnamediv"> <h1 class="refname">PharData::delMetadata</h1> <p class="verinfo">(PHP >= 5.3.0, PECL phar >= 2.0.0)</p><p class="refpurpose"><span class="refname">PharData::delMetadata</span> — <span class="dc-title">Deletes the global metadata of a zip archive</span></p> </div> <div class="refsect1 description" id="refsect1-phardata.delmetadata-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><strong>PharData::delMetadata</strong></span> ( <span class="methodparam">void</span> )</div> <blockquote class="note"><p><strong class="note">Note</strong>: <p class="para">This method requires the <var class="filename">php.ini</var> setting <em>phar.readonly</em> to be set to <em>0</em> in order to work for <a href="class.phar.html" class="classname">Phar</a> objects. Otherwise, a <a href="class.pharexception.html" class="classname">PharException</a> will be thrown.</p></p></blockquote> <p class="para"> Deletes the global metadata of the zip archive </p> </div> <div class="refsect1 parameters" id="refsect1-phardata.delmetadata-parameters"> <h3 class="title">Parameters</h3> <p class="para"> </p> </div> <div class="refsect1 returnvalues" id="refsect1-phardata.delmetadata-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> returns <strong><code>TRUE</code></strong> on success, but it is better to check for thrown exception, and assume success if none is thrown. </p> </div> <div class="refsect1 errors" id="refsect1-phardata.delmetadata-errors"> <h3 class="title">Errors/Exceptions</h3> <p class="para"> Throws <a href="class.pharexception.html" class="classname">PharException</a> if errors occur while flushing changes to disk. </p> </div> <div class="refsect1 examples" id="refsect1-phardata.delmetadata-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-719"> <p><strong>Example #1 A <span class="function"><strong>PharData::delMetaData()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /></span><span style="color: #007700">try {<br /> </span><span style="color: #0000BB">$phar </span><span style="color: #007700">= new </span><span style="color: #0000BB">PharData</span><span style="color: #007700">(</span><span style="color: #DD0000">'myphar.zip'</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$phar</span><span style="color: #007700">-></span><span style="color: #0000BB">getMetadata</span><span style="color: #007700">());<br /> </span><span style="color: #0000BB">$phar</span><span style="color: #007700">-></span><span style="color: #0000BB">setMetadata</span><span style="color: #007700">(</span><span style="color: #DD0000">"hi there"</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$phar</span><span style="color: #007700">-></span><span style="color: #0000BB">getMetadata</span><span style="color: #007700">());<br /> </span><span style="color: #0000BB">$phar</span><span style="color: #007700">-></span><span style="color: #0000BB">delMetadata</span><span style="color: #007700">();<br /> </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$phar</span><span style="color: #007700">-></span><span style="color: #0000BB">getMetadata</span><span style="color: #007700">());<br />} catch (</span><span style="color: #0000BB">Exception $e</span><span style="color: #007700">) {<br /> </span><span style="color: #FF8000">// handle errors<br /></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:</p></div> <div class="example-contents screen"> <div class="cdata"><pre> NULL string(8) "hi there" NULL </pre></div> </div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-phardata.delmetadata-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="phar.delmetadata.html" class="function" rel="rdfs-seeAlso">Phar::delMetadata()</a> - Deletes the global metadata of the phar</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="phardata.decompressfiles.html">PharData::decompressFiles</a></div> <div class="next" style="text-align: right; float: right;"><a href="phardata.delete.html">PharData::delete</a></div> <div class="up"><a href="class.phardata.html">PharData</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>