<!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 to the default loader</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="phar.setalias.html">Phar::setAlias</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phar.setmetadata.html">Phar::setMetadata</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.setdefaultstub" class="refentry">
<div class="refnamediv">
<h1 class="refname">Phar::setDefaultStub</h1>
<p class="verinfo">(Unknown)</p><p class="refpurpose"><span class="refname">Phar::setDefaultStub</span> — <span class="dc-title">Used to set the PHP loader or bootstrap stub of a Phar archive to the default loader</span></p>
</div>
<div class="refsect1 description" id="refsect1-phar.setdefaultstub-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::setDefaultStub</strong></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$index</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$webindex</code></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 a convenience method that combines the functionality of
<span class="function"><a href="phar.createdefaultstub.html" class="function">Phar::createDefaultStub()</a></span> and <span class="function"><a href="phar.setstub.html" class="function">Phar::setStub()</a></span>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-phar.setdefaultstub-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">index</code></em></span>
<dd>
<p class="para">
Relative path within the phar archive to run if accessed on the command-line
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">webindex</code></em></span>
<dd>
<p class="para">
Relative path within the phar archive to run if accessed through a web browser
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-phar.setdefaultstub-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.setdefaultstub-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.setdefaultstub-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-697">
<p><strong>Example #1 A <span class="function"><strong>Phar::setDefaultStub()</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">$phar </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">$phar</span><span style="color: #007700">-></span><span style="color: #0000BB">setDefaultStub</span><span style="color: #007700">(</span><span style="color: #DD0000">'cli.php'</span><span style="color: #007700">, </span><span style="color: #DD0000">'web/index.php'</span><span style="color: #007700">);<br /> </span><span style="color: #FF8000">// this is the same as:<br /> // $phar->setStub($phar->createDefaultStub('cli.php', 'web/index.php'));<br /></span><span style="color: #007700">} 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>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-phar.setdefaultstub-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.setalias.html">Phar::setAlias</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phar.setmetadata.html">Phar::setMetadata</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>
