archived-doc-ja/reference/spl/splfileobject/fputcsv.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 18b8af40b812d9328d4e99309f3134bee0852b05 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="splfileobject.fputcsv" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>SplFileObject::fputcsv</refname>
  <refpurpose>フィールドの配列を CSV の行として書き出す</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type class="union"><type>int</type><type>false</type></type><methodname>SplFileObject::fputcsv</methodname>
   <methodparam><type>array</type><parameter>fields</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>separator</parameter><initializer>","</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>enclosure</parameter><initializer>"\""</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>escape</parameter><initializer>"\\"</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>eol</parameter><initializer>"\n"</initializer></methodparam>
  </methodsynopsis>
  <para>
   <parameter>fields</parameter> の配列を、CSV の行としてファイルに書き出します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>fields</parameter></term>
    <listitem>
     <para>
      値の配列。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>separator</parameter></term>
    <listitem>
     <para>
      オプションで指定する、フィールドの区切り文字
      (シングルバイト文字 一文字のみ)。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>enclosure</parameter></term>
    <listitem>
     <para>
      オプションで指定する。フィールドの囲み文字
      (シングルバイト文字 一文字のみ)。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>escape</parameter></term>
    <listitem>
     <para>
      オプションの <parameter>escape</parameter> は、エスケープ文字
      (シングルバイト文字 最大で一文字) を指定します。
      空文字列 (<literal>""</literal>) を与えると、(RFC 4180 に準拠していない) 独自仕様のエスケープ機構を無効にします。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>eol</parameter></term>
    <listitem>
     <para>
      <parameter>eol</parameter> は、
      カスタムの行末シーケンスを設定するオプションの引数です。
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
  <note>
   <para>
    <parameter>enclosure</parameter> がフィールド内に含まれる場合は、同じ文字を二度続けることでエスケープします。
    ただし、その直前に <parameter>escape</parameter> がある場合は別です。
   </para>
  </note> 
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   書き出した文字列の長さを返します。&return.falseforfailure;。
  </para>
  <para>
   <parameter>separator</parameter> や <parameter>enclosure</parameter>
   が一文字でない場合は &false; を返し、何もファイルに書き出しません。
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   <parameter>separator</parameter> や <parameter>enclosure</parameter>
   が一文字でない場合は <constant>E_WARNING</constant> レベルのエラーが発生します。
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.1.0</entry>
       <entry>
        オプションの引数 <parameter>eol</parameter> が追加されました。
       </entry>
      </row>
      <row>
       <entry>7.4.0</entry>
       <entry>
        <parameter>escape</parameter> パラメータは空文字列を受け入れるようになりました。
        この場合、(RFC 4180 に準拠していない) 独自仕様のエスケープ機構が無効になります。
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example xml:id="splfileobject.fputcsv.examples.basic">
    <title><methodname>SplFileObject::fputcsv</methodname> の例</title>
    <programlisting role="php">
<![CDATA[
<?php

$list = array (
    array('aaa', 'bbb', 'ccc', 'dddd'),
    array('123', '456', '789'),
    array('"aaa"', '"bbb"')
);

$file = new SplFileObject('file.csv', 'w');

foreach ($list as $fields) {
    $file->fputcsv($fields);
}

?>
]]>
    </programlisting>
    <para>上の例は、次の内容をファイル <literal>file.csv</literal> に書き出します。</para>
    <screen>
<![CDATA[
aaa,bbb,ccc,dddd
123,456,789
"""aaa""","""bbb"""

]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>fputcsv</function></member>
    <member><methodname>SplFileObject::fgetcsv</methodname></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
-->