document new PHP 5.1 function: fputcsv

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@169352 c90b9560-bf6c-de11-be94-00142212c4b1

reference/filesystem/functions/fgetcsv.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.15 $ -->
+<!-- $Revision: 1.16 $ -->
 <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
   <refentry id="function.fgetcsv">
    <refnamediv>
@@ -100,7 +100,7 @@ fclose($handle);
     &note.line-endings;
     <para>
      See also <function>explode</function>, <function>file</function>, 
-     and <function>pack</function>
+     <function>pack</function> and <function>fputcsv</function>.
     </para>
    </refsect1>
   </refentry>

reference/filesystem/functions/fputcsv.xml

@@ -0,0 +1,84 @@
+<?xml version='1.0' encoding='iso-8859-1'?>
+<!-- $Revision: 1.1 $ -->
+  <refentry id="function.fputcsv">
+   <refnamediv>
+    <refname>fputcsv</refname>
+    <refpurpose>
+     Format line as CSV and write to file pointer
+    </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <methodsynopsis>
+     <type>int</type><methodname>fputcsv</methodname>
+     <methodparam><type>resource</type><parameter>handle</parameter></methodparam>
+     <methodparam><type>array</type><parameter>fields</parameter></methodparam>
+     <methodparam choice="opt"><type>string</type><parameter>delimiter</parameter></methodparam>
+     <methodparam choice="opt"><type>string</type><parameter>enclosure</parameter></methodparam>
+    </methodsynopsis>
+    <para>
+     <function>fputcsv</function> formats a line (passed as a
+     <parameter>fields</parameter> array) as CSV and write it to the
+     specified file <parameter>handle</parameter>. Returns the legth of the
+     written string, or &false; on failure.
+    </para>
+    <para>
+     The optional <parameter>delimiter</parameter> parameter sets the field
+     delimiter (one character only). Defaults as a comma.
+    </para>
+    <para>
+     The <parameter>enclosure</parameter> parameter sets the field enclosure
+     (one character only) and defaults to a double quotation mark (").
+    </para>
+    <para>
+     <example>
+      <title><function>fputcsv</function> example</title>
+      <programlisting role="php">
+<![CDATA[
+<?php
+
+$list = array (
+    'aaa,bbb,ccc,dddd',
+    '123,456,789',
+    '"aaa","bbb"'
+);
+
+$fp = fopen('file.csv', 'w');
+
+foreach ($list as $line) {
+    fputcsv($fp, split(',', $line));
+}
+
+fclose($fp);
+?>
+]]>
+      </programlisting>
+     </example>
+    </para>
+    &note.line-endings;
+    <para>
+     See also <function>fgetcsv</function>.
+    </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:"../../../../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
+-->