<!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>Set the alias for the Phar archive</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="phar.running.html">Phar::running</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phar.setdefaultstub.html">Phar::setDefaultStub</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.setalias" class="refentry">
<div class="refnamediv">
<h1 class="refname">Phar::setAlias</h1>
<p class="verinfo">(PHP >= 5.3.0, PECL phar >= 1.2.1)</p><p class="refpurpose"><span class="refname">Phar::setAlias</span> — <span class="dc-title">Set the alias for the Phar archive</span></p>
</div>
<div class="refsect1 description" id="refsect1-phar.setalias-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::setAlias</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$alias</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">
Set the alias for the Phar archive, and write it as the permanent alias
for this phar archive. An alias can be used internally to a phar archive to
ensure that use of the <em>phar</em> stream wrapper to access internal
files always works regardless of the location of the phar archive on the
filesystem. Another alternative is to rely upon Phar's interception of
<span class="function"><a href="function.include.html" class="function">include</a></span> or to use <span class="function"><a href="phar.interceptfilefuncs.html" class="function">Phar::interceptFileFuncs()</a></span>
and use relative paths.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-phar.setalias-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">
A shorthand string that this archive can be referred to in <em>phar</em>
stream wrapper access.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-phar.setalias-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
</p>
</div>
<div class="refsect1 errors" id="refsect1-phar.setalias-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Throws <a href="class.unexpectedvalueexception.html" class="classname">UnexpectedValueException</a> when write access
is disabled, and <a href="class.pharexception.html" class="classname">PharException</a> if the alias is
already in use or any problems were encountered flushing changes to disk.
</p>
</div>
<div class="refsect1 examples" id="refsect1-phar.setalias-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-696">
<p><strong>Example #1 A <span class="function"><strong>Phar::setAlias()</strong></span> example</strong></p>
<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">setAlias</span><span style="color: #007700">(</span><span style="color: #DD0000">'myp.phar'</span><span style="color: #007700">);<br />} catch (</span><span style="color: #0000BB">Exception $e</span><span style="color: #007700">) {<br /> </span><span style="color: #FF8000">// handle error<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.setalias-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="phar.construct.html" class="function" rel="rdfs-seeAlso">Phar::__construct()</a> - Construct a Phar archive object</span></li>
<li class="member"> <span class="function"><a href="phar.interceptfilefuncs.html" class="function" rel="rdfs-seeAlso">Phar::interceptFileFuncs()</a> - instructs phar to intercept fopen, file_get_contents, opendir, and all of the stat-related functions</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.running.html">Phar::running</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phar.setdefaultstub.html">Phar::setDefaultStub</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>
