<!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>Return the PHP loader or bootstrap stub of a Phar archive</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="phar.getsignature.html">Phar::getSignature</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phar.getsupportedcompression.html">Phar::getSupportedCompression</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.getstub" class="refentry">
<div class="refnamediv">
<h1 class="refname">Phar::getStub</h1>
<p class="verinfo">(PHP >= 5.3.0, PECL phar >= 1.0.0)</p><p class="refpurpose"><span class="refname">Phar::getStub</span> — <span class="dc-title">Return the PHP loader or bootstrap stub of a Phar archive</span></p>
</div>
<div class="refsect1 description" id="refsect1-phar.getstub-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><strong>Phar::getStub</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
Phar archives contain a bootstrap loader, or <em>stub</em>
written in PHP that is executed when the archive is executed in PHP either via
include:
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #007700">include </span><span style="color: #DD0000">'myphar.phar'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
or by simple execution:
<div class="example-contents screen">
<div class="cdata"><pre>
php myphar.phar
</pre></div>
</div>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-phar.getstub-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a string containing the contents of the bootstrap loader (stub) of
the current Phar archive.
</p>
</div>
<div class="refsect1 errors" id="refsect1-phar.getstub-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Throws <a href="class.runtimeexception.html" class="classname">RuntimeException</a> if it is not possible to read
the stub from the Phar archive.
</p>
</div>
<div class="refsect1 examples" id="refsect1-phar.getstub-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-681">
<p><strong>Example #1 A <span class="function"><strong>Phar::getStub()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$p </span><span style="color: #007700">= new </span><span style="color: #0000BB">Phar</span><span style="color: #007700">(</span><span style="color: #DD0000">'/path/to/my.phar'</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #DD0000">'my.phar'</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$p</span><span style="color: #007700">-></span><span style="color: #0000BB">getStub</span><span style="color: #007700">();<br />echo </span><span style="color: #DD0000">"==NEXT==\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$p</span><span style="color: #007700">-></span><span style="color: #0000BB">setStub</span><span style="color: #007700">(</span><span style="color: #DD0000">"<?php<br />function __autoload(</span><span style="color: #0000BB">$class</span><span style="color: #DD0000">)<br />{<br /> include 'phar://' . str_replace('_', '/', </span><span style="color: #0000BB">$class</span><span style="color: #DD0000">);<br />}<br />Phar::mapPhar('myphar.phar');<br />include 'phar://myphar.phar/startup.php';<br />__HALT_COMPILER(); ?>"</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$p</span><span style="color: #007700">-></span><span style="color: #0000BB">getStub</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>
<?php __HALT_COMPILER(); ?>
==NEXT==
<?php
function __autoload($class)
{
include 'phar://' . str_replace('_', '/', $class);
}
Phar::mapPhar('myphar.phar');
include 'phar://myphar.phar/startup.php';
__HALT_COMPILER(); ?>
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-phar.getstub-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="phar.setstub.html" class="function" rel="rdfs-seeAlso">Phar::setStub()</a> - Used to set the PHP loader or bootstrap stub of a Phar archive</span></li>
<li class="member"> <span class="function"><a href="phar.createdefaultstub.html" class="function" rel="rdfs-seeAlso">Phar::createDefaultStub()</a> - Create a phar-file format specific stub</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.getsignature.html">Phar::getSignature</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phar.getsupportedcompression.html">Phar::getSupportedCompression</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>
