<!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 entry object</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="pharfileinfo.compress.html">PharFileInfo::compress</a></div>
<div class="next" style="text-align: right; float: right;"><a href="pharfileinfo.decompress.html">PharFileInfo::decompress</a></div>
<div class="up"><a href="class.pharfileinfo.html">PharFileInfo</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="pharfileinfo.construct" class="refentry">
<div class="refnamediv">
<h1 class="refname">PharFileInfo::__construct</h1>
<p class="verinfo">(PHP >= 5.3.0, PECL phar >= 1.0.0)</p><p class="refpurpose"><span class="refname">PharFileInfo::__construct</span> — <span class="dc-title">Construct a Phar entry object</span></p>
</div>
<div class="refsect1 description" id="refsect1-pharfileinfo.construct-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><strong>PharFileInfo::__construct</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$entry</code></span>
)</div>
<p class="para rdfs-comment">
This should not be called directly. Instead, a PharFileInfo object
is initialized by calling <span class="function"><a href="phar.offsetget.html" class="function">Phar::offsetGet()</a></span>
through array access.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-pharfileinfo.construct-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">entry</code></em></span>
<dd>
<p class="para">
The full url to retrieve a file. If you wish to retrieve the information
for the file <em>my/file.php</em> from the phar <em>boo.phar</em>,
the entry should be <em>phar://boo.phar/my/file.php</em>.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 errors" id="refsect1-pharfileinfo.construct-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Throws <a href="class.badmethodcallexception.html" class="classname">BadMethodCallException</a> if
<a href="language.oop5.decon.html#object.construct" class="link">__construct()</a> is called twice.
Throws <a href="class.unexpectedvalueexception.html" class="classname">UnexpectedValueException</a> if
the phar URL requested is malformed, the requested
phar cannot be opened, or the file can't be found within the phar.
</p>
</div>
<div class="refsect1 examples" id="refsect1-pharfileinfo.construct-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-727">
<p><strong>Example #1 A <span class="function"><strong>PharFileInfo::__construct()</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: #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 /> </span><span style="color: #0000BB">$p</span><span style="color: #007700">[</span><span style="color: #DD0000">'testfile.txt'</span><span style="color: #007700">] = </span><span style="color: #DD0000">"hi\nthere\ndude"</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$file </span><span style="color: #007700">= </span><span style="color: #0000BB">$p</span><span style="color: #007700">[</span><span style="color: #DD0000">'testfile.txt'</span><span style="color: #007700">];<br /> foreach (</span><span style="color: #0000BB">$file </span><span style="color: #007700">as </span><span style="color: #0000BB">$line </span><span style="color: #007700">=> </span><span style="color: #0000BB">$text</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"line number </span><span style="color: #0000BB">$line</span><span style="color: #DD0000">: </span><span style="color: #0000BB">$text</span><span style="color: #DD0000">"</span><span style="color: #007700">;<br /> }<br /> </span><span style="color: #FF8000">// this also works<br /> </span><span style="color: #0000BB">$file </span><span style="color: #007700">= new </span><span style="color: #0000BB">PharFileInfo</span><span style="color: #007700">(</span><span style="color: #DD0000">'phar:///path/to/my.phar/testfile.txt'</span><span style="color: #007700">);<br /> foreach (</span><span style="color: #0000BB">$file </span><span style="color: #007700">as </span><span style="color: #0000BB">$line </span><span style="color: #007700">=> </span><span style="color: #0000BB">$text</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"line number </span><span style="color: #0000BB">$line</span><span style="color: #DD0000">: </span><span style="color: #0000BB">$text</span><span style="color: #DD0000">"</span><span style="color: #007700">;<br /> }<br />} catch (</span><span style="color: #0000BB">Exception $e</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">'Phar operations failed: '</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>
line number 1: hi
line number 2: there
line number 3: dude
line number 1: hi
line number 2: there
line number 3: dude
</pre></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="pharfileinfo.compress.html">PharFileInfo::compress</a></div>
<div class="next" style="text-align: right; float: right;"><a href="pharfileinfo.decompress.html">PharFileInfo::decompress</a></div>
<div class="up"><a href="class.pharfileinfo.html">PharFileInfo</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
