<!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 metadata of the entry</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="pharfileinfo.decompress.html">PharFileInfo::decompress</a></div>
<div class="next" style="text-align: right; float: right;"><a href="pharfileinfo.getcrc32.html">PharFileInfo::getCRC32</a></div>
<div class="up"><a href="class.pharfileinfo.html">PharFileInfo</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="pharfileinfo.delmetadata" class="refentry">
<div class="refnamediv">
<h1 class="refname">PharFileInfo::delMetadata</h1>
<p class="verinfo">(PHP >= 5.3.0, PECL phar >= 1.2.0)</p><p class="refpurpose"><span class="refname">PharFileInfo::delMetadata</span> — <span class="dc-title">Deletes the metadata of the entry</span></p>
</div>
<div class="refsect1 description" id="refsect1-pharfileinfo.delmetadata-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>PharFileInfo::delMetadata</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
Deletes the metadata of the entry, if any.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-pharfileinfo.delmetadata-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
No parameters.
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-pharfileinfo.delmetadata-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> if successful, <strong><code>FALSE</code></strong> if the entry had no metadata.
As with all functionality that modifies the contents of
a phar, the <a href="phar.configuration.html#ini.phar.readonly" class="link">phar.readonly</a> INI variable
must be off in order to succeed if the file is within a <a href="class.phar.html" class="classname">Phar</a>
archive. Files within <a href="class.phardata.html" class="classname">PharData</a> archives do not have
this restriction.
</p>
</div>
<div class="refsect1 errors" id="refsect1-pharfileinfo.delmetadata-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Throws <a href="class.pharexception.html" class="classname">PharException</a> if errors occurred while flushing
changes to disk, and <a href="class.badmethodcallexception.html" class="classname">BadMethodCallException</a> if
write access is disabled.
</p>
</div>
<div class="refsect1 examples" id="refsect1-pharfileinfo.delmetadata-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-729">
<p><strong>Example #1 A <span class="function"><strong>PharFileInfo::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">$a </span><span style="color: #007700">= new </span><span style="color: #0000BB">Phar</span><span style="color: #007700">(</span><span style="color: #DD0000">'myphar.phar'</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$a</span><span style="color: #007700">[</span><span style="color: #DD0000">'hi'</span><span style="color: #007700">] = </span><span style="color: #DD0000">'hi'</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$a</span><span style="color: #007700">[</span><span style="color: #DD0000">'hi'</span><span style="color: #007700">]-></span><span style="color: #0000BB">delMetadata</span><span style="color: #007700">());<br /> </span><span style="color: #0000BB">$a</span><span style="color: #007700">[</span><span style="color: #DD0000">'hi'</span><span style="color: #007700">]-></span><span style="color: #0000BB">setMetadata</span><span style="color: #007700">(</span><span style="color: #DD0000">'there'</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$a</span><span style="color: #007700">[</span><span style="color: #DD0000">'hi'</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">$a</span><span style="color: #007700">[</span><span style="color: #DD0000">'hi'</span><span style="color: #007700">]-></span><span style="color: #0000BB">delMetadata</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>
bool(false)
bool(true)
bool(false)
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-pharfileinfo.delmetadata-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="pharfileinfo.setmetadata.html" class="function" rel="rdfs-seeAlso">PharFileInfo::setMetadata()</a> - Sets file-specific meta-data saved with a file</span></li>
<li class="member"> <span class="function"><a href="pharfileinfo.hasmetadata.html" class="function" rel="rdfs-seeAlso">PharFileInfo::hasMetadata()</a> - Returns the metadata of the entry</span></li>
<li class="member"> <span class="function"><a href="pharfileinfo.getmetadata.html" class="function" rel="rdfs-seeAlso">PharFileInfo::getMetadata()</a> - Returns file-specific meta-data saved with a file</span></li>
<li class="member"> <span class="function"><a href="phardata.setmetadata.html" class="function" rel="rdfs-seeAlso">Phar::setMetadata()</a> - Sets phar archive meta-data</span></li>
<li class="member"> <span class="function"><a href="phar.hasmetadata.html" class="function" rel="rdfs-seeAlso">Phar::hasMetadata()</a> - Returns whether phar has global meta-data</span></li>
<li class="member"> <span class="function"><a href="phar.getmetadata.html" class="function" rel="rdfs-seeAlso">Phar::getMetadata()</a> - Returns phar archive meta-data</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="pharfileinfo.decompress.html">PharFileInfo::decompress</a></div>
<div class="next" style="text-align: right; float: right;"><a href="pharfileinfo.getcrc32.html">PharFileInfo::getCRC32</a></div>
<div class="up"><a href="class.pharfileinfo.html">PharFileInfo</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
