mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 08:58:56 +00:00
121 lines
3.2 KiB
XML
121 lines
3.2 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="phar.offsetget" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>Phar::offsetGet</refname>
|
|
<refpurpose>Gets a <classname>PharFileInfo</classname> object for a specific file</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>SplFileInfo</type><methodname>Phar::offsetGet</methodname>
|
|
<methodparam><type>string</type><parameter>localName</parameter></methodparam>
|
|
</methodsynopsis>
|
|
|
|
<para>
|
|
This is an implementation of the <interfacename>ArrayAccess</interfacename>
|
|
interface allowing direct manipulation of the contents of a Phar archive using
|
|
array access brackets. <methodname>Phar::offsetGet</methodname> is used
|
|
for retrieving files from a Phar archive.
|
|
</para>
|
|
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>localName</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The filename (relative path) to look for in a Phar.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
A <classname>PharFileInfo</classname> object is returned that can be used to
|
|
iterate over a file's contents or to retrieve information about the current file.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="errors">
|
|
&reftitle.errors;
|
|
<para>
|
|
This method throws <classname>BadMethodCallException</classname> if the file
|
|
does not exist in the Phar archive.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>Phar::offsetGet</function> example</title>
|
|
<para>
|
|
As with all classes that implement the <classname>ArrayAccess</classname>
|
|
interface, <methodname>Phar::offsetGet</methodname> is automatically
|
|
called when using the <literal>[]</literal> angle bracket operator.
|
|
</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$p = new Phar(dirname(__FILE__) . '/myphar.phar', 0, 'myphar.phar');
|
|
$p['exists.txt'] = "file exists\n";
|
|
try {
|
|
// automatically calls offsetGet()
|
|
echo $p['exists.txt'];
|
|
echo $p['doesnotexist.txt'];
|
|
} catch (BadMethodCallException $e) {
|
|
echo $e;
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
file exists
|
|
Entry doesnotexist.txt does not exist
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>Phar::offsetExists</function></member>
|
|
<member><function>Phar::offsetSet</function></member>
|
|
<member><function>Phar::offsetUnset</function></member>
|
|
</simplelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
</refentry>
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|