php-doc-en/reference/filesystem/functions/fputcsv.xml

86 lines
2.3 KiB
XML
Raw Normal View History

<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.3 $ -->
<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 choice="opt"><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 length 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: <literal>,</literal>.
</para>
<para>
The optional <parameter>enclosure</parameter> parameter sets the field
enclosure (one character only) and defaults to a double quotation mark:
<literal>"</literal>.
</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
-->