File: fputcsv.xml

package info (click to toggle)
php-doc 20061001-1
  • links: PTS
  • area: non-free
  • in suites: etch, etch-m68k
  • size: 45,764 kB
  • ctags: 1,611
  • sloc: xml: 502,485; php: 7,645; cpp: 500; makefile: 297; perl: 161; sh: 141; awk: 28
file content (85 lines) | stat: -rwxr-xr-x 2,385 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
<?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
-->