<!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>Gets a PharFileInfo object for a specific file</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="phar.offsetexists.html">Phar::offsetExists</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phar.offsetset.html">Phar::offsetSet</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.offsetget" class="refentry">
<div class="refnamediv">
<h1 class="refname">Phar::offsetGet</h1>
<p class="verinfo">(PHP >= 5.3.0, PECL phar >= 1.0.0)</p><p class="refpurpose"><span class="refname">Phar::offsetGet</span> — <span class="dc-title">Gets a <a href="class.pharfileinfo.html" class="classname">PharFileInfo</a> object for a specific file</span></p>
</div>
<div class="refsect1 description" id="refsect1-phar.offsetget-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><strong>Phar::offsetGet</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$offset</code></span>
)</div>
<p class="para rdfs-comment">
This is an implementation of the <span class="interfacename"><a href="class.arrayaccess.html" class="interfacename">ArrayAccess</a></span>
interface allowing direct manipulation of the contents of a Phar archive using
array access brackets. <span class="methodname"><strong>Phar::offsetGet()</strong></span> is used
for retrieving files from a Phar archive.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-phar.offsetget-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">offset</code></em></span>
<dd>
<p class="para">
The filename (relative path) to look for in a Phar.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-phar.offsetget-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
A <a href="class.pharfileinfo.html" class="classname">PharFileInfo</a> object is returned that can be used to
iterate over a file's contents or to retrieve information about the current file.
</p>
</div>
<div class="refsect1 errors" id="refsect1-phar.offsetget-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
This method throws <a href="class.badmethodcallexception.html" class="classname">BadMethodCallException</a> if the file
does not exist in the Phar archive.
</p>
</div>
<div class="refsect1 examples" id="refsect1-phar.offsetget-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-692">
<p><strong>Example #1 <span class="function"><strong>Phar::offsetGet()</strong></span> example</strong></p>
<div class="example-contents"><p>
As with all classes that implement the <a href="class.arrayaccess.html" class="classname">ArrayAccess</a>
interface, <span class="methodname"><strong>Phar::offsetGet()</strong></span> is automatically
called when using the <em>[]</em> angle bracket operator.
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$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">'/myphar.phar'</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #DD0000">'myphar.phar'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$p</span><span style="color: #007700">[</span><span style="color: #DD0000">'exists.txt'</span><span style="color: #007700">] = </span><span style="color: #DD0000">"file exists\n"</span><span style="color: #007700">;<br />try {<br /> </span><span style="color: #FF8000">// automatically calls offsetGet()<br /> </span><span style="color: #007700">echo </span><span style="color: #0000BB">$p</span><span style="color: #007700">[</span><span style="color: #DD0000">'exists.txt'</span><span style="color: #007700">];<br /> echo </span><span style="color: #0000BB">$p</span><span style="color: #007700">[</span><span style="color: #DD0000">'doesnotexist.txt'</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: #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>
file exists
Entry doesnotexist.txt does not exist
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-phar.offsetget-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="phar.offsetexists.html" class="function" rel="rdfs-seeAlso">Phar::offsetExists()</a> - determines whether a file exists in the phar</span></li>
<li class="member"> <span class="function"><a href="phar.offsetset.html" class="function" rel="rdfs-seeAlso">Phar::offsetSet()</a> - set the contents of an internal file to those of an external file</span></li>
<li class="member"> <span class="function"><a href="phar.offsetunset.html" class="function" rel="rdfs-seeAlso">Phar::offsetUnset()</a> - remove a file from a phar</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.offsetexists.html">Phar::offsetExists</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phar.offsetset.html">Phar::offsetSet</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>
