<!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>Construct a Phar archive object</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="phar.compressfiles.html">Phar::compressFiles</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phar.converttodata.html">Phar::convertToData</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.construct" class="refentry">
<div class="refnamediv">
<h1 class="refname">Phar::__construct</h1>
<p class="verinfo">(PHP >= 5.3.0, PECL phar >= 1.0.0)</p><p class="refpurpose"><span class="refname">Phar::__construct</span> — <span class="dc-title">Construct a Phar archive object</span></p>
</div>
<div class="refsect1 description" id="refsect1-phar.construct-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><strong>Phar::__construct</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$fname</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$flags</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$alias</code></span>
]] )</div>
</div>
<div class="refsect1 parameters" id="refsect1-phar.construct-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">fname</code></em></span>
<dd>
<p class="para">
Path to an existing Phar archive or to-be-created archive. The file name's
extension must contain .phar.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">flags</code></em></span>
<dd>
<p class="para">
Flags to pass to parent class <a href="class.recursivedirectoryiterator.html" class="classname">RecursiveDirectoryIterator</a>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">alias</code></em></span>
<dd>
<p class="para">
Alias with which this Phar archive should be referred to in calls to stream
functionality.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 errors" id="refsect1-phar.construct-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Throws <a href="class.badmethodcallexception.html" class="classname">BadMethodCallException</a> if called twice, <a href="class.unexpectedvalueexception.html" class="classname">UnexpectedValueException</a>
if the phar archive can't be opened.
</p>
</div>
<div class="refsect1 examples" id="refsect1-phar.construct-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-669">
<p><strong>Example #1 A <span class="function"><strong>Phar::__construct()</strong></span> example</strong></p>
<div class="example-contents"><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">$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">FilesystemIterator</span><span style="color: #007700">::</span><span style="color: #0000BB">CURRENT_AS_FILEINFO </span><span style="color: #007700">| </span><span style="color: #0000BB">FilesystemIterator</span><span style="color: #007700">::</span><span style="color: #0000BB">KEY_AS_FILENAME</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'my.phar'</span><span style="color: #007700">);<br />} catch (</span><span style="color: #0000BB">UnexpectedValueException $e</span><span style="color: #007700">) {<br /> die(</span><span style="color: #DD0000">'Could not open my.phar'</span><span style="color: #007700">);<br />} catch (</span><span style="color: #0000BB">BadMethodCallException $e</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">'technically, this cannot happen'</span><span style="color: #007700">;<br />}<br /></span><span style="color: #FF8000">// this works now<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">file_get_contents</span><span style="color: #007700">(</span><span style="color: #DD0000">'phar://my.phar/example.txt'</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// and works as if we had typed<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">file_get_contents</span><span style="color: #007700">(</span><span style="color: #DD0000">'phar:///path/to/my.phar/example.txt'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</p></div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="phar.compressfiles.html">Phar::compressFiles</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phar.converttodata.html">Phar::convertToData</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>
