<!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 phar archive meta-data</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="phar.extractto.html">Phar::extractTo</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phar.getmodified.html">Phar::getModified</a></div>
<div class="up"><a href="class.phar.html">Phar</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="phar.getmetadata" class="refentry">
<div class="refnamediv">
<h1 class="refname">Phar::getMetadata</h1>
<p class="verinfo">(PHP >= 5.3.0, PECL phar >= 1.0.0)</p><p class="refpurpose"><span class="refname">Phar::getMetadata</span> — <span class="dc-title">Returns phar archive meta-data</span></p>
</div>
<div class="refsect1 description" id="refsect1-phar.getmetadata-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>Phar::getMetadata</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
Retrieve archive meta-data. Meta-data can be any PHP variable that can be serialized.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-phar.getmetadata-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
No parameters.
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-phar.getmetadata-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
any PHP variable that can be serialized and is stored as meta-data for the Phar archive,
or <strong><code>NULL</code></strong> if no meta-data is stored.
</p>
</div>
<div class="refsect1 examples" id="refsect1-phar.getmetadata-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-680">
<p><strong>Example #1 A <span class="function"><strong>Phar::getMetadata()</strong></span> example</strong></p>
<div class="example-contents"><p>
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// make sure it doesn't exist<br /></span><span style="color: #007700">@</span><span style="color: #0000BB">unlink</span><span style="color: #007700">(</span><span style="color: #DD0000">'brandnewphar.phar'</span><span style="color: #007700">);<br />try {<br /> </span><span style="color: #0000BB">$p </span><span style="color: #007700">= new </span><span style="color: #0000BB">Phar</span><span style="color: #007700">(</span><span style="color: #0000BB">dirname</span><span style="color: #007700">(</span><span style="color: #0000BB">__FILE__</span><span style="color: #007700">) . </span><span style="color: #DD0000">'/brandnewphar.phar'</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #DD0000">'brandnewphar.phar'</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$p</span><span style="color: #007700">[</span><span style="color: #DD0000">'file.php'</span><span style="color: #007700">] = </span><span style="color: #DD0000">'<?php echo "hello";'</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$p</span><span style="color: #007700">-></span><span style="color: #0000BB">setMetadata</span><span style="color: #007700">(array(</span><span style="color: #DD0000">'bootstrap' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'file.php'</span><span style="color: #007700">));<br /> </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$p</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 /> echo </span><span style="color: #DD0000">'Could not modify phar:'</span><span style="color: #007700">, </span><span style="color: #0000BB">$e</span><span style="color: #007700">;<br />}<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>
array(1) {
["bootstrap"]=>
string(8) "file.php"
}
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-phar.getmetadata-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<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.delmetadata.html" class="function" rel="rdfs-seeAlso">Phar::delMetadata()</a> - Deletes the global metadata of the phar</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>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="phar.extractto.html">Phar::extractTo</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phar.getmodified.html">Phar::getModified</a></div>
<div class="up"><a href="class.phar.html">Phar</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
