<!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>Used to set 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.setsignaturealgorithm.html">Phar::setSignatureAlgorithm</a></div> <div class="next" style="text-align: right; float: right;"><a href="phar.startbuffering.html">Phar::startBuffering</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.setstub" class="refentry"> <div class="refnamediv"> <h1 class="refname">Phar::setStub</h1> <p class="verinfo">(PHP >= 5.3.0, PECL phar >= 1.0.0)</p><p class="refpurpose"><span class="refname">Phar::setStub</span> — <span class="dc-title">Used to set the PHP loader or bootstrap stub of a Phar archive</span></p> </div> <div class="refsect1 description" id="refsect1-phar.setstub-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>Phar::setStub</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$stub</code></span> [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$len</code><span class="initializer"> = -1</span></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"> This method is used to add a PHP bootstrap loader stub to a new Phar archive, or to replace the loader stub in an existing Phar archive. </p> <p class="para"> The loader stub for a Phar archive is used whenever an archive is included directly as in this example: </p> <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> <p class="para"> The loader is not accessed when including a file through the <em>phar</em> stream wrapper like so: </p> <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">'phar://myphar.phar/somefile.php'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> <div class="refsect1 parameters" id="refsect1-phar.setstub-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">stub</code></em></span> <dd> <p class="para"> A string or an open stream handle to use as the executable stub for this phar archive. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">len</code></em></span> <dd> <p class="para"> </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-phar.setstub-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.setstub-errors"> <h3 class="title">Errors/Exceptions</h3> <p class="para"> <a href="class.unexpectedvalueexception.html" class="classname">UnexpectedValueException</a> is thrown if <a href="phar.configuration.html#ini.phar.readonly" class="link">phar.readonly</a> is enabled in php.ini. <a href="class.pharexception.html" class="classname">PharException</a> is thrown if any problems are encountered flushing changes to disk. </p> </div> <div class="refsect1 examples" id="refsect1-phar.setstub-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-699"> <p><strong>Example #1 A <span class="function"><strong>Phar::setStub()</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: #007700">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">'a.php'</span><span style="color: #007700">] = </span><span style="color: #DD0000">'<?php var_dump("Hello");'</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 var_dump("First"); Phar::mapPhar("brandnewphar.phar"); __HALT_COMPILER(); ?>'</span><span style="color: #007700">);<br /> include </span><span style="color: #DD0000">'phar://brandnewphar.phar/a.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">getStub</span><span style="color: #007700">());<br /> </span><span style="color: #0000BB">$p</span><span style="color: #007700">[</span><span style="color: #DD0000">'b.php'</span><span style="color: #007700">] = </span><span style="color: #DD0000">'<?php var_dump("World");'</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 var_dump("Second"); Phar::mapPhar("brandnewphar.phar"); __HALT_COMPILER(); ?>'</span><span style="color: #007700">);<br /> include </span><span style="color: #DD0000">'phar://brandnewphar.phar/b.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">getStub</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">'Write operations failed on brandnewphar.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> string(5) "Hello" string(82) "<?php var_dump("First"); Phar::mapPhar("brandnewphar.phar"); __HALT_COMPILER(); ?>" string(5) "World" string(83) "<?php var_dump("Second"); Phar::mapPhar("brandnewphar.phar"); __HALT_COMPILER(); ?>" </pre></div> </div> </div> </p> </div> <div class="refsect1 changelog" id="refsect1-phar.setstub-changelog"> <h3 class="title">Changelog</h3> <p class="para"> <table class="doctable informaltable"> <thead> <tr> <th>Version</th> <th>Description</th> </tr> </thead> <tbody class="tbody"> <tr> <td>5.4.0</td> <td> Added <em><code class="parameter">len</code></em> parameter. </td> </tr> </tbody> </table> </p> </div> <div class="refsect1 seealso" id="refsect1-phar.setstub-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="phar.getstub.html" class="function" rel="rdfs-seeAlso">Phar::getStub()</a> - Return 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.setsignaturealgorithm.html">Phar::setSignatureAlgorithm</a></div> <div class="next" style="text-align: right; float: right;"><a href="phar.startbuffering.html">Phar::startBuffering</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>