1
0
mirror of https://github.com/php/doc-ja.git synced 2026-03-24 07:02:08 +01:00
Files
archived-doc-ja/reference/phar/Phar/offsetGet.xml
2022-12-13 19:58:20 +09:00

123 lines
3.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: f03806fcd8fe03a0501bd40b6e3939ff6589a1d2 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="phar.offsetget" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>Phar::offsetGet</refname>
<refpurpose>指定したファイルの <classname>PharFileInfo</classname> オブジェクトを取得する</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="Phar">
<modifier>public</modifier> <type>SplFileInfo</type><methodname>Phar::offsetGet</methodname>
<methodparam><type>string</type><parameter>localName</parameter></methodparam>
</methodsynopsis>
<para>
これは <interfacename>ArrayAccess</interfacename> インターフェイスを実装したものです。
これにより、Phar アーカイブの内容に対して配列形式の角括弧を使用したアクセスが可能となります。
<methodname>Phar::offsetGet</methodname> を使用して、Phar アーカイブからファイルを取得します。
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>localName</parameter></term>
<listitem>
<para>
Phar 内で探すファイル名 (相対パス)。
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<classname>PharFileInfo</classname> オブジェクトを返します。
これを使用して、ファイルの内容を順に処理したりファイルの情報を取得したりします。
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
そのファイルが Phar アーカイブ内に存在しない場合に、このメソッドは
<classname>BadMethodCallException</classname> をスローします。
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>Phar::offsetGet</function> の例</title>
<para>
<classname>ArrayAccess</classname> インターフェイスを実装した他のクラスと同様、
<methodname>Phar::offsetGet</methodname>
<literal>[]</literal> 演算子を使用した場合に自動的にコールされます。
</para>
<programlisting role="php">
<![CDATA[
<?php
$p = new Phar(dirname(__FILE__) . '/myphar.phar', 0, 'myphar.phar');
$p['exists.txt'] = "file exists\n";
try {
// 自動的に 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
-->