<!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>Reads the currently executed file (a phar) and registers its manifest</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="phar.loadphar.html">Phar::loadPhar</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phar.mount.html">Phar::mount</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.mapphar" class="refentry">
<div class="refnamediv">
<h1 class="refname">Phar::mapPhar</h1>
<p class="verinfo">(PHP >= 5.3.0, PECL phar >= 1.0.0)</p><p class="refpurpose"><span class="refname">Phar::mapPhar</span> — <span class="dc-title">Reads the currently executed file (a phar) and registers its manifest</span></p>
</div>
<div class="refsect1 description" id="refsect1-phar.mapphar-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="modifier">static</span> <span class="type">bool</span> <span class="methodname"><strong>Phar::mapPhar</strong></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$alias</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$dataoffset</code><span class="initializer"> = 0</span></span>
]] )</div>
<p class="para rdfs-comment">
This static method can only be used inside a Phar archive's loader stub
in order to initialize the phar when it is directly executed, or when
it is included in another script.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-phar.mapphar-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">alias</code></em></span>
<dd>
<p class="para">
The alias that can be used in <em>phar://</em> URLs to
refer to this archive, rather than its full path.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">dataoffset</code></em></span>
<dd>
<p class="para">
Unused variable, here for compatibility with PEAR's PHP_Archive.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-phar.mapphar-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 errors" id="refsect1-phar.mapphar-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
<a href="class.pharexception.html" class="classname">PharException</a> is thrown if not called directly within PHP execution,
if no __HALT_COMPILER(); token is found in the current source file, or if
the file cannot be opened for reading.
</p>
</div>
<div class="refsect1 examples" id="refsect1-phar.mapphar-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-688">
<p><strong>Example #1 A <span class="function"><strong>Phar::mapPhar()</strong></span> example</strong></p>
<div class="example-contents"><p>
mapPhar should be used only inside a phar's loader stub. Use
loadPhar to load an external phar into memory.
</p></div>
<div class="example-contents"><p>
Here is a sample Phar loader stub that uses mapPhar.
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #007700">function </span><span style="color: #0000BB">__autoload</span><span style="color: #007700">(</span><span style="color: #0000BB">$class</span><span style="color: #007700">)<br />{<br /> include </span><span style="color: #DD0000">'phar://me.phar/' </span><span style="color: #007700">. </span><span style="color: #0000BB">str_replace</span><span style="color: #007700">(</span><span style="color: #DD0000">'_'</span><span style="color: #007700">, </span><span style="color: #DD0000">'/'</span><span style="color: #007700">, </span><span style="color: #0000BB">$class</span><span style="color: #007700">) . </span><span style="color: #DD0000">'.php'</span><span style="color: #007700">;<br />}<br />try {<br /> </span><span style="color: #0000BB">Phar</span><span style="color: #007700">::</span><span style="color: #0000BB">mapPhar</span><span style="color: #007700">(</span><span style="color: #DD0000">'me.phar'</span><span style="color: #007700">);<br /> include </span><span style="color: #DD0000">'phar://me.phar/startup.php'</span><span style="color: #007700">;<br />} catch (</span><span style="color: #0000BB">PharException $e</span><span style="color: #007700">) {<br /> echo </span><span style="color: #0000BB">$e</span><span style="color: #007700">-></span><span style="color: #0000BB">getMessage</span><span style="color: #007700">();<br /> die(</span><span style="color: #DD0000">'Cannot initialize Phar'</span><span style="color: #007700">);<br />}<br />__HALT_COMPILER();</span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-phar.mapphar-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="phar.loadphar.html" class="function" rel="rdfs-seeAlso">Phar::loadPhar()</a> - Loads any phar archive with an alias</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.loadphar.html">Phar::loadPhar</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phar.mount.html">Phar::mount</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>
