mirror of
https://github.com/php/doc-ja.git
synced 2026-03-24 07:02:08 +01:00
150 lines
4.3 KiB
XML
150 lines
4.3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- EN-Revision: f03806fcd8fe03a0501bd40b6e3939ff6589a1d2 Maintainer: takagi Status: ready -->
|
|
<refentry xml:id="phar.addfile" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>Phar::addFile</refname>
|
|
<refpurpose>ファイルシステム上のファイルを phar アーカイブに追加する</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis role="Phar">
|
|
<modifier>public</modifier> <type>void</type><methodname>Phar::addFile</methodname>
|
|
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
|
|
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>localName</parameter><initializer>&null;</initializer></methodparam>
|
|
</methodsynopsis>
|
|
&phar.write;
|
|
|
|
<para>
|
|
このメソッドを使用すると、任意のファイルあるいは URL を phar アーカイブに追加することができます。
|
|
オプションの 2 番目のパラメータ <parameter>localName</parameter> が文字列の場合、
|
|
ファイルはその名前でアーカイブ内に格納されます。指定しなかった場合は、
|
|
<literal>file</literal> パラメータをアーカイブ内のパスとして使用します。
|
|
URL を使用する場合は、localname を指定しないと例外がスローされます。
|
|
このメソッドは <function>ZipArchive::addFile</function> と同じようなものです。
|
|
</para>
|
|
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>filename</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
phar アーカイブに追加したいディスク上のファイルへのフルパスあるいは相対パス。
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>localName</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
ファイルをアーカイブ内に格納するときのパス。
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
戻り値はありません。失敗時には例外をスローします。
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>8.0.0</entry>
|
|
<entry>
|
|
<parameter>localName</parameter> は、nullable になりました。
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>Phar::addFile</function> の例</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
try {
|
|
$a = new Phar('/path/to/phar.phar');
|
|
|
|
$a->addFile('/full/path/to/file');
|
|
// 格納したファイルを確認します
|
|
$b = $a['full/path/to/file']->getContent();
|
|
|
|
$a->addFile('/full/path/to/file', 'my/file.txt');
|
|
$c = $a['my/file.txt']->getContent();
|
|
|
|
// URL の使用例
|
|
$a->addFile('http://www.example.com', 'example.html');
|
|
} catch (Exception $e) {
|
|
// ここでエラー処理をします
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
&phar.note.performance;
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>Phar::offsetSet</function></member>
|
|
<member><function>PharData::addFile</function></member>
|
|
<member><function>Phar::addFromString</function></member>
|
|
<member><function>Phar::addEmptyDir</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
|
|
-->
|