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/PharData/addFromString.xml
2023-05-11 19:14:09 +09:00

123 lines
3.4 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 88773698060b9bb3e9900bbd7cb8a3da588f1288 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="phardata.addfromstring" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>PharData::addFromString</refname>
<refpurpose>内容を文字列で指定したファイルを、tar/zip アーカイブに追加する</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="PharData">
<modifier>public</modifier> <type>void</type><methodname>PharData::addFromString</methodname>
<methodparam><type>string</type><parameter>localName</parameter></methodparam>
<methodparam><type>string</type><parameter>contents</parameter></methodparam>
</methodsynopsis>
<para>
このメソッドを使用すると、任意の文字列を tar/zip アーカイブに追加することができます。
アーカイブ内のファイル名は <literal>localname</literal> で指定したものとなります。
このメソッドは <function>ZipArchive::addFromString</function> と同じようなものです。
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>localName</parameter></term>
<listitem>
<para>
ファイルをアーカイブ内に格納するときのパス。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>contents</parameter></term>
<listitem>
<para>
ファイルに保存する内容。
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
戻り値はありません。失敗時には例外をスローします。
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>PharData::addFromString</function> の例</title>
<programlisting role="php">
<![CDATA[
<?php
try {
$a = new PharData('/path/to/my.tar');
$a->addFromString('path/to/file.txt', 'my simple file');
$b = $a['path/to/file.txt']->getContent();
// 大きなファイル用にストリームハンドルから追加するには offsetSet() を使用します
$c = fopen('/path/to/hugefile.bin');
$a['largefile.bin'] = $c;
fclose($c);
} catch (Exception $e) {
// ここでエラー処理をします
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&phardata.note.performance;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>PharData::offsetSet</function></member>
<member><function>Phar::addFromString</function></member>
<member><function>PharData::addFile</function></member>
<member><function>PharData::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
-->